lib/libpmc/pmc_get_driver_stats.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_DRIVER_STATS 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc_get_driver_stats
  31 .Nd retrieve driver statistics
  32 .Sh LIBRARY
  33 .Lb libpmc
  34 .Sh SYNOPSIS
  35 .In pmc.h
  36 .Ft int
  37 .Fn pmc_get_driver_stats "struct pmc_driverstats *gms"
  38 .Sh DESCRIPTION
  39 The function
  40 .Fn pmc_get_driver_statistics
  41 retrieves a snapshot of the usage statistics maintained by
  42 .Xr hwpmc 4
  43 into the memory area pointed to by argument
  44 .Fa gms .
  45 .Pp
  46 The returned structure includes the following fields:
  47 .Bl -tag -width pmc_intr_bufferfull -offset indent -compact
  48 .It pm_intr_ignored
  49 The number of sampling interrupts ignored.
  50 .It pm_intr_processed
  51 The number of sampling interrupts processed.
  52 .It pm_intr_bufferfull
  53 The number of sampling interrupts dropped due to lack of space
  54 in the sample buffer.
  55 .It pm_syscalls
  56 The number of system calls into
  57 .Xr hwpmc 4 .
  58 .It pm_syscalls_errors
  59 The number of system calls into
  60 .Xr hwpmc 4
  61 that failed.
  62 .It pm_buffer_requests
  63 The number of log buffer requests so far.
  64 .It pm_buffer_requests_failed
  65 The number of log buffer requests that failed due to lack of buffers.
  66 .It pm_log_sweeps
  67 The number of sample buffer processing sweeps.
  68 .El
  69 .Sh RETURN VALUES
  70 .Rv -std
  71 .Sh SEE ALSO
  72 .Xr pmc 3 ,
  73 .Xr hwpmc 4