1 .\" Copyright (c) 2007 Joseph Koshy. All rights reserved.
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
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.
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
27 .Dt PMC_CONFIGURE_LOGFILE 3
30 .Nm pmc_configure_logfile ,
31 .Nm pmc_flush_logfile ,
34 .Nd log file management
40 .Fn pmc_configure_logfile "int fd"
42 .Fn pmc_flush_logfile void
44 .Fn pmc_writelog "uint32_t userdata"
46 .Fn pmc_close_logfile void
48 The functions manage logging of
53 .Fn pmc_configure_logfile
54 is used to turn on and turn off logging.
57 is a valid file handle returned by a prior call to
61 then performance events will be logged to the file corresponding
62 to the specified handle.
63 If the value of argument
65 is -1 then logging will be stopped after any pending data is flushed.
69 will force all log data queued inside the
71 driver to be written out.
75 will append a log entry containing the value of argument
81 will flush all pending log data and close
88 .Fn pmc_configure_logfile
89 may fail with the following errors:
94 driver was not able to create a helper process due to system limits
98 .Fn pmc_configure_logfile
99 was called with a log file already configured.
102 .Fn pmc_configure_logfile
103 was called with an argument of -1 without a log file being previously
106 The system encountered a memory shortage when servicing this request.
110 .Fn pmc_flush_logfile
111 may fail with the following errors:
115 .Fn pmc_flush_logfile
116 was called without a log file being previously configured.
121 may fail with the following errors:
126 was called without a log file being previously configured.
128 The system encountered a memory shortage when servicing this