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