lib/libpmc/pmc_get_msr.3

   1 .\" Copyright (c) 2007 Joseph Koshy.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd November 25, 2007
  27 .Dt PMC_GET_MSR 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc_get_msr
  31 .Nd x86 architecture-specific PMC operations
  32 .Sh LIBRARY
  33 .Lb libpmc
  34 .Sh SYNOPSIS
  35 .In pmc.h
  36 .Ft int
  37 .Fn pmc_get_msr "pmc_id_t pmc" "uint32_t *msr"
  38 .Sh DESCRIPTION
  39 The function
  40 .Fn pmc_get_msr
  41 returns the processor model specific register number associated with
  42 a PMC for subsequent use with RDPMC instructions.
  43 Argument
  44 .Fa pmc
  45 specifies a process scope counting PMC.
  46 The function will write the model specific register number associated
  47 with the PMC to the location pointed to by argument
  48 .Fa msr .
  49 .Pp
  50 After successful completion of this function, applications
  51 can directly read the contents of PMC hardware using
  52 RDPMC instructions.
  53 .Sh RETURN VALUES
  54 .Rv -std pmc_get_msr
  55 .Sh ERRORS
  56 A call to
  57 .Fn pmc_get_msr
  58 may fail with the following errors:
  59 .Bl -tag -width Er
  60 .It Bq Er EINVAL
  61 The PMC handle specified was invalid.
  62 .It Bq Er EINVAL
  63 The PMC specified did not have process scope or counting mode.
  64 .It Bq Er EINVAL
  65 The PMC specified was allocated with the
  66 .Dv PMC_F_DESCENDANTS
  67 flag.
  68 .It Bq Er EINVAL
  69 The specified PMC is already attached to target processes other
  70 than the owner.
  71 .It Bq Er ENOSYS
  72 The underlying hardware does not support an RDPMC instruction.
  73 .El
  74 .Sh SEE ALSO
  75 .Xr pmc 3 ,
  76 .Xr hwpmc 4