xref: /freebsd/lib/libpmc/pmc_start.3 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
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 Joseph Koshy ``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 Joseph Koshy 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.Os
28.Dt PMC_START 3
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.
73.El
74.Sh SEE ALSO
75.Xr pmc 3 ,
76.Xr hwpmc 4
77