xref: /freebsd/lib/libpmc/pmc_get_driver_stats.3 (revision aa12cea2ccc6e686d6d31cf67d6bc69cbc1ba744)
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.\"
12677d4530SJoseph Koshy.\" This software is provided by Joseph Koshy ``as is'' and
13677d4530SJoseph Koshy.\" any express or implied warranties, including, but not limited to, the
14677d4530SJoseph Koshy.\" implied warranties of merchantability and fitness for a particular purpose
15677d4530SJoseph Koshy.\" are disclaimed.  in no event shall Joseph Koshy be liable
16677d4530SJoseph Koshy.\" for any direct, indirect, incidental, special, exemplary, or consequential
17677d4530SJoseph Koshy.\" damages (including, but not limited to, procurement of substitute goods
18677d4530SJoseph Koshy.\" or services; loss of use, data, or profits; or business interruption)
19677d4530SJoseph Koshy.\" however caused and on any theory of liability, whether in contract, strict
20677d4530SJoseph Koshy.\" liability, or tort (including negligence or otherwise) arising in any way
21677d4530SJoseph Koshy.\" out of the use of this software, even if advised of the possibility of
22677d4530SJoseph Koshy.\" such damage.
23677d4530SJoseph Koshy.\"
24677d4530SJoseph Koshy.\" $FreeBSD$
25677d4530SJoseph Koshy.\"
26677d4530SJoseph Koshy.Dd November 25, 2007
27677d4530SJoseph Koshy.Dt PMC_GET_DRIVER_STATS 3
28*aa12cea2SUlrich Spörlein.Os
29677d4530SJoseph Koshy.Sh NAME
30677d4530SJoseph Koshy.Nm pmc_get_driver_stats
31677d4530SJoseph Koshy.Nd retrieve driver statistics
32677d4530SJoseph Koshy.Sh LIBRARY
33677d4530SJoseph Koshy.Lb libpmc
34677d4530SJoseph Koshy.Sh SYNOPSIS
35677d4530SJoseph Koshy.In pmc.h
36677d4530SJoseph Koshy.Ft int
37677d4530SJoseph Koshy.Fn pmc_get_driver_stats "struct pmc_driverstats *gms"
38677d4530SJoseph Koshy.Sh DESCRIPTION
39677d4530SJoseph KoshyThe function
40677d4530SJoseph Koshy.Fn pmc_get_driver_statistics
41677d4530SJoseph Koshyretrieves a snapshot of the usage statistics maintained by
42677d4530SJoseph Koshy.Xr hwpmc 4
43677d4530SJoseph Koshyinto the memory area pointed to by argument
44677d4530SJoseph Koshy.Fa gms .
45677d4530SJoseph Koshy.Pp
46677d4530SJoseph KoshyThe returned structure includes the following fields:
47677d4530SJoseph Koshy.Bl -tag -width pmc_intr_bufferfull -offset indent -compact
48677d4530SJoseph Koshy.It pm_intr_ignored
49677d4530SJoseph KoshyThe number of sampling interrupts ignored.
50677d4530SJoseph Koshy.It pm_intr_processed
51677d4530SJoseph KoshyThe number of sampling interrupts processed.
52677d4530SJoseph Koshy.It pm_intr_bufferfull
53677d4530SJoseph KoshyThe number of sampling interrupts dropped due to lack of space
54677d4530SJoseph Koshyin the sample buffer.
55677d4530SJoseph Koshy.It pm_syscalls
56677d4530SJoseph KoshyThe number of system calls into
57677d4530SJoseph Koshy.Xr hwpmc 4 .
58677d4530SJoseph Koshy.It pm_syscalls_errors
59677d4530SJoseph KoshyThe number of system calls into
60677d4530SJoseph Koshy.Xr hwpmc 4
61677d4530SJoseph Koshythat failed.
62677d4530SJoseph Koshy.It pm_buffer_requests
63677d4530SJoseph KoshyThe number of log buffer requests so far.
64677d4530SJoseph Koshy.It pm_buffer_requests_failed
65677d4530SJoseph KoshyThe number of log buffer requests that failed due to lack of buffers.
66677d4530SJoseph Koshy.It pm_log_sweeps
67677d4530SJoseph KoshyThe number of sample buffer processing sweeps.
68677d4530SJoseph Koshy.El
69677d4530SJoseph Koshy.Sh RETURN VALUES
70677d4530SJoseph Koshy.Rv -std
71677d4530SJoseph Koshy.Sh SEE ALSO
72677d4530SJoseph Koshy.Xr pmc 3 ,
73677d4530SJoseph Koshy.Xr hwpmc 4
74