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 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
28 .Dt PMC_CONFIGURE_LOGFILE 3
30 .Nm pmc_configure_logfile ,
31 .Nm pmc_flush_logfile ,
33 .Nd log file management
39 .Fn pmc_configure_logfile "int fd"
41 .Fn pmc_flush_logfile void
43 .Fn pmc_writelog "uint32_t userdata"
45 The functions manage logging of
50 .Fn pmc_configure_logfile
51 is used to turn on and turn off logging.
54 is a valid file handle returned by a prior call to
58 then performance events will be logged to the file corresponding
59 to the specified handle.
60 If the value of argument
62 is -1 then logging will be stopped after any pending data is flushed.
66 will force all log data queued inside the
68 driver to be written out.
72 will append a log entry containing the value of argument
79 .Fn pmc_configure_logfile
80 may fail with the following errors:
85 driver was not able to create a helper process due to system limits
89 .Fn pmc_configure_logfile
90 was called with a log file already configured.
93 .Fn pmc_configure_logfile
94 was called with an argument of -1 without a log file being previously
97 The system encountered a memory shortage when servicing this request.
101 .Fn pmc_flush_logfile
102 may fail with the following errors:
106 .Fn pmc_flush_logfile
107 was called without a log file being previously configured.
112 may fail with the following errors:
117 was called without a log file being previously configured.
119 The system encountered a memory shortage when servicing this