diff options
Diffstat (limited to 'lib/libpmc/pmc_set.3')
-rw-r--r-- | lib/libpmc/pmc_set.3 | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/lib/libpmc/pmc_set.3 b/lib/libpmc/pmc_set.3 new file mode 100644 index 0000000..a9e438a --- /dev/null +++ b/lib/libpmc/pmc_set.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 +.Os +.Dt PMC_SET 3 +.Sh NAME +.Nm pmc_set +.Nd set the reload count of a sampling PMC +.Sh LIBRARY +.Lb libpmc +.Sh SYNOPSIS +.In pmc.h +.Ft int +.Fn pmc_set "pmc_id_t pmc" "pmc_value_t value" +.Sh DESCRIPTION +Function +.Fn pmc_set +is used to set the reload value of sampling PMCs. +Argument +.Fa pmc +specified the handle a previously allocate sampling mode PMC. +Argument +.Fa value +specifies the reload count. +.Pp +Sampling PMCs will interrupt the CPU after the number of +hardware events specified by the reload count are seen. +After the sampling interrupt is processed the underlying hardware will +be reloaded with the specified count and the hardware +automatically restarted by +.Xr hwpmc 4 . +.Pp +Function +.Fn pmc_set +should be called on PMC in a quiescent state. +.Sh RETURN VALUES +.Rv -std pmc_set +.Sh ERRORS +A call to +.Fn pmc_set +may fail with the following errors: +.Bl -tag -width Er +.It Bq Er EINVAL +The current process did not own a PMC with the specified handle. +.It Bq Er EBUSY +The specified PMC was already running. +.El +.Sh SEE ALSO +.Xr pmc 3 , +.Xr hwpmc 4 |