xref: /freebsd/lib/libpmc/pmc_get_driver_stats.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1677d4530SJoseph Koshy.\" Copyright (c) 2007 Joseph Koshy.  All rights reserved.
2677d4530SJoseph Koshy.\"
3677d4530SJoseph Koshy.\" Redistribution and use in source and binary forms, with or without
4677d4530SJoseph Koshy.\" modification, are permitted provided that the following conditions
5677d4530SJoseph Koshy.\" are met:
6677d4530SJoseph Koshy.\" 1. Redistributions of source code must retain the above copyright
7677d4530SJoseph Koshy.\"    notice, this list of conditions and the following disclaimer.
8677d4530SJoseph Koshy.\" 2. Redistributions in binary form must reproduce the above copyright
9677d4530SJoseph Koshy.\"    notice, this list of conditions and the following disclaimer in the
10677d4530SJoseph Koshy.\"    documentation and/or other materials provided with the distribution.
11677d4530SJoseph Koshy.\"
12*026dbd29SChristian Brueffer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13*026dbd29SChristian Brueffer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14*026dbd29SChristian Brueffer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15*026dbd29SChristian Brueffer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16*026dbd29SChristian Brueffer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17*026dbd29SChristian Brueffer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18*026dbd29SChristian Brueffer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19*026dbd29SChristian Brueffer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20*026dbd29SChristian Brueffer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21*026dbd29SChristian Brueffer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22*026dbd29SChristian Brueffer.\" SUCH DAMAGE.
23677d4530SJoseph Koshy.\"
24677d4530SJoseph Koshy.Dd November 25, 2007
25677d4530SJoseph Koshy.Dt PMC_GET_DRIVER_STATS 3
26aa12cea2SUlrich Spörlein.Os
27677d4530SJoseph Koshy.Sh NAME
28677d4530SJoseph Koshy.Nm pmc_get_driver_stats
29677d4530SJoseph Koshy.Nd retrieve driver statistics
30677d4530SJoseph Koshy.Sh LIBRARY
31677d4530SJoseph Koshy.Lb libpmc
32677d4530SJoseph Koshy.Sh SYNOPSIS
33677d4530SJoseph Koshy.In pmc.h
34677d4530SJoseph Koshy.Ft int
35677d4530SJoseph Koshy.Fn pmc_get_driver_stats "struct pmc_driverstats *gms"
36677d4530SJoseph Koshy.Sh DESCRIPTION
37677d4530SJoseph KoshyThe function
38677d4530SJoseph Koshy.Fn pmc_get_driver_statistics
39677d4530SJoseph Koshyretrieves a snapshot of the usage statistics maintained by
40677d4530SJoseph Koshy.Xr hwpmc 4
41677d4530SJoseph Koshyinto the memory area pointed to by argument
42677d4530SJoseph Koshy.Fa gms .
43677d4530SJoseph Koshy.Pp
44677d4530SJoseph KoshyThe returned structure includes the following fields:
45677d4530SJoseph Koshy.Bl -tag -width pmc_intr_bufferfull -offset indent -compact
46677d4530SJoseph Koshy.It pm_intr_ignored
47677d4530SJoseph KoshyThe number of sampling interrupts ignored.
48677d4530SJoseph Koshy.It pm_intr_processed
49677d4530SJoseph KoshyThe number of sampling interrupts processed.
50677d4530SJoseph Koshy.It pm_intr_bufferfull
51677d4530SJoseph KoshyThe number of sampling interrupts dropped due to lack of space
52677d4530SJoseph Koshyin the sample buffer.
53677d4530SJoseph Koshy.It pm_syscalls
54677d4530SJoseph KoshyThe number of system calls into
55677d4530SJoseph Koshy.Xr hwpmc 4 .
56677d4530SJoseph Koshy.It pm_syscalls_errors
57677d4530SJoseph KoshyThe number of system calls into
58677d4530SJoseph Koshy.Xr hwpmc 4
59677d4530SJoseph Koshythat failed.
60677d4530SJoseph Koshy.It pm_buffer_requests
61677d4530SJoseph KoshyThe number of log buffer requests so far.
62677d4530SJoseph Koshy.It pm_buffer_requests_failed
63677d4530SJoseph KoshyThe number of log buffer requests that failed due to lack of buffers.
64677d4530SJoseph Koshy.It pm_log_sweeps
65677d4530SJoseph KoshyThe number of sample buffer processing sweeps.
66677d4530SJoseph Koshy.El
67677d4530SJoseph Koshy.Sh RETURN VALUES
68677d4530SJoseph Koshy.Rv -std
69677d4530SJoseph Koshy.Sh SEE ALSO
70677d4530SJoseph Koshy.Xr pmc 3 ,
71677d4530SJoseph Koshy.Xr hwpmc 4
72