lib/libpmc/pmc_read.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_READ 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc_read ,
  31 .Nm pmc_rw ,
  32 .Nm pmc_write ,
  33 .Nd read and write hardware performance counters
  34 .Sh LIBRARY
  35 .Lb libpmc
  36 .Sh SYNOPSIS
  37 .In pmc.h
  38 .Ft int
  39 .Fn pmc_read "pmc_id_t pmc" "pmc_value_t *value"
  40 .Ft int
  41 .Fn pmc_rw "pmc_id_t pmc" "pmc_value_t newvalue" "pmc_value_t *oldvaluep"
  42 .Ft int
  43 .Fn pmc_write "pmc_id_t pmc" "pmc_value_t value"
  44 .Sh DESCRIPTION
  45 These functions read and write the current value of a PMC.
  46 .Pp
  47 Function
  48 .Fn pmc_read
  49 will read the current value of the PMC specified by argument
  50 .Fa pmc
  51 and write it to the location specified by argument
  52 .Fa value .
  53 .Pp
  54 Function
  55 .Fn pmc_write
  56 will set the current value of the PMC specified by argument
  57 .Fa pmc
  58 to the value specified by argument
  59 .Fa value .
  60 .Pp
  61 Function
  62 .Fn pmc_rw
  63 combines a read and a write into a single atomic operation.
  64 .Pp
  65 For write operations the PMC should be a quiescent state.
  66 .Sh RETURN VALUES
  67 .Rv -std
  68 .Sh ERRORS
  69 A call to these functions may fail with the following errors:
  70 .Bl -tag -width Er
  71 .It Bq Er EBUSY
  72 A write operation specified a currently running PMC.
  73 .It Bq Er EINVAL
  74 Argument
  75 .Fa pmc
  76 specified a PMC not in a readable state.
  77 .It Bq Er EINVAL
  78 The PMC specified by argument
  79 .Fa pmc
  80 was not owned by the current process.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr pmc 3 ,
  84 .Xr hwpmc 4