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