1.\" Copyright (c) 2007-2008 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 September 22, 2008 27.Dt PMC_START 3 28.Os 29.Sh NAME 30.Nm pmc_start , 31.Nm pmc_stop 32.Nd start and stop a PMC 33.Sh LIBRARY 34.Lb libpmc 35.Sh SYNOPSIS 36.In pmc.h 37.Ft int 38.Fn pmc_start "pmc_id_t pmc" 39.Ft int 40.Fn pmc_stop "pmc_id_t pmc" 41.Sh DESCRIPTION 42These functions are used to start and stop a PMC. 43.Pp 44Function 45.Fn pmc_start 46starts the PMC specified by argument 47.Fa pmc . 48If the specified PMC has process scope and has not been attached 49to any targets, it will be attached to the current process. 50.Pp 51Function 52.Fn pmc_stop 53stops the PMC specified by argument 54.Fa pmc . 55.Sh RETURN VALUES 56.Rv -std 57.Sh ERRORS 58A call to these functions may fail with the following errors: 59.Bl -tag -width Er 60.It Bq Er EDOOFUS 61Function 62.Fn pmc_start 63specified a PMC that requires a log file and no log file was 64configured. 65.It Bq Er EINVAL 66The specified PMC is in the process of being deleted. 67.It Bq Er EINVAL 68Function 69.Fn pmc_stop 70specified a PMC that was never started. 71.It Bq Er ENXIO 72The specified PMC had system scope and its associated CPU was disabled or 73absent. 74.El 75.Sh SEE ALSO 76.Xr pmc 3 , 77.Xr hwpmc 4 78