diff options
Diffstat (limited to 'lib/libpmc/pmc_get_driver_stats.3')
-rw-r--r-- | lib/libpmc/pmc_get_driver_stats.3 | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/lib/libpmc/pmc_get_driver_stats.3 b/lib/libpmc/pmc_get_driver_stats.3 new file mode 100644 index 0000000..fa214b3 --- /dev/null +++ b/lib/libpmc/pmc_get_driver_stats.3 @@ -0,0 +1,73 @@ +.\" Copyright (c) 2007 Joseph Koshy. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" This software is provided by Joseph Koshy ``as is'' and +.\" any express or implied warranties, including, but not limited to, the +.\" implied warranties of merchantability and fitness for a particular purpose +.\" are disclaimed. in no event shall Joseph Koshy be liable +.\" for any direct, indirect, incidental, special, exemplary, or consequential +.\" damages (including, but not limited to, procurement of substitute goods +.\" or services; loss of use, data, or profits; or business interruption) +.\" however caused and on any theory of liability, whether in contract, strict +.\" liability, or tort (including negligence or otherwise) arising in any way +.\" out of the use of this software, even if advised of the possibility of +.\" such damage. +.\" +.\" $FreeBSD$ +.\" +.Dd November 25, 2007 +.Dt PMC_GET_DRIVER_STATS 3 +.Os +.Sh NAME +.Nm pmc_get_driver_stats +.Nd retrieve driver statistics +.Sh LIBRARY +.Lb libpmc +.Sh SYNOPSIS +.In pmc.h +.Ft int +.Fn pmc_get_driver_stats "struct pmc_driverstats *gms" +.Sh DESCRIPTION +The function +.Fn pmc_get_driver_statistics +retrieves a snapshot of the usage statistics maintained by +.Xr hwpmc 4 +into the memory area pointed to by argument +.Fa gms . +.Pp +The returned structure includes the following fields: +.Bl -tag -width pmc_intr_bufferfull -offset indent -compact +.It pm_intr_ignored +The number of sampling interrupts ignored. +.It pm_intr_processed +The number of sampling interrupts processed. +.It pm_intr_bufferfull +The number of sampling interrupts dropped due to lack of space +in the sample buffer. +.It pm_syscalls +The number of system calls into +.Xr hwpmc 4 . +.It pm_syscalls_errors +The number of system calls into +.Xr hwpmc 4 +that failed. +.It pm_buffer_requests +The number of log buffer requests so far. +.It pm_buffer_requests_failed +The number of log buffer requests that failed due to lack of buffers. +.It pm_log_sweeps +The number of sample buffer processing sweeps. +.El +.Sh RETURN VALUES +.Rv -std +.Sh SEE ALSO +.Xr pmc 3 , +.Xr hwpmc 4 |