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.\" $FreeBSD$ 25.\" 26.Dd November 25, 2007 27.Dt PMC_SET 3 28.Os 29.Sh NAME 30.Nm pmc_set 31.Nd set the reload count of a sampling PMC 32.Sh LIBRARY 33.Lb libpmc 34.Sh SYNOPSIS 35.In pmc.h 36.Ft int 37.Fn pmc_set "pmc_id_t pmc" "pmc_value_t value" 38.Sh DESCRIPTION 39Function 40.Fn pmc_set 41is used to set the reload value of sampling PMCs. 42Argument 43.Fa pmc 44specified the handle a previously allocate sampling mode PMC. 45Argument 46.Fa value 47specifies the reload count. 48.Pp 49Sampling PMCs will interrupt the CPU after the number of 50hardware events specified by the reload count are seen. 51After the sampling interrupt is processed the underlying hardware will 52be reloaded with the specified count and the hardware 53automatically restarted by 54.Xr hwpmc 4 . 55.Pp 56Function 57.Fn pmc_set 58should be called on PMC in a quiescent state. 59.Sh RETURN VALUES 60.Rv -std pmc_set 61.Sh ERRORS 62A call to 63.Fn pmc_set 64may fail with the following errors: 65.Bl -tag -width Er 66.It Bq Er EINVAL 67The current process did not own a PMC with the specified handle. 68.It Bq Er EBUSY 69The specified PMC was already running. 70.El 71.Sh SEE ALSO 72.Xr pmc 3 , 73.Xr hwpmc 4 74