diff options
Diffstat (limited to 'lib/libpmc/pmc_get_msr.3')
-rw-r--r-- | lib/libpmc/pmc_get_msr.3 | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/libpmc/pmc_get_msr.3 b/lib/libpmc/pmc_get_msr.3 new file mode 100644 index 0000000..6361d3a --- /dev/null +++ b/lib/libpmc/pmc_get_msr.3 @@ -0,0 +1,76 @@ +.\" Copyright (c) 2007 Joseph Koshy. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" This software is provided by Joseph Koshy ``as is'' and +.\" any express or implied warranties, including, but not limited to, the +.\" implied warranties of merchantability and fitness for a particular purpose +.\" are disclaimed. in no event shall Joseph Koshy be liable +.\" for any direct, indirect, incidental, special, exemplary, or consequential +.\" damages (including, but not limited to, procurement of substitute goods +.\" or services; loss of use, data, or profits; or business interruption) +.\" however caused and on any theory of liability, whether in contract, strict +.\" liability, or tort (including negligence or otherwise) arising in any way +.\" out of the use of this software, even if advised of the possibility of +.\" such damage. +.\" +.\" $FreeBSD$ +.\" +.Dd November 25, 2007 +.Dt PMC_GET_MSR 3 +.Os +.Sh NAME +.Nm pmc_get_msr +.Nd x86 architecture-specific PMC operations +.Sh LIBRARY +.Lb libpmc +.Sh SYNOPSIS +.In pmc.h +.Ft int +.Fn pmc_get_msr "pmc_id_t pmc" "uint32_t *msr" +.Sh DESCRIPTION +The function +.Fn pmc_get_msr +returns the processor model specific register number associated with +a PMC for subsequent use with RDPMC instructions. +Argument +.Fa pmc +specifies a process scope counting PMC. +The function will write the model specific register number associated +with the PMC to the location pointed to by argument +.Fa msr . +.Pp +After successful completion of this function, applications +can directly read the contents of PMC hardware using +RDPMC instructions. +.Sh RETURN VALUES +.Rv -std pmc_get_msr +.Sh ERRORS +A call to +.Fn pmc_get_msr +may fail with the following errors: +.Bl -tag -width Er +.It Bq Er EINVAL +The PMC handle specified was invalid. +.It Bq Er EINVAL +The PMC specified did not have process scope or counting mode. +.It Bq Er EINVAL +The PMC specified was allocated with the +.Dv PMC_F_DESCENDANTS +flag. +.It Bq Er EINVAL +The specified PMC is already attached to target processes other +than the owner. +.It Bq Er ENOSYS +The underlying hardware does not support an RDPMC instruction. +.El +.Sh SEE ALSO +.Xr pmc 3 , +.Xr hwpmc 4 |