xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / prof_server.html

diff --git a/osfmk/man/prof_server.html b/osfmk/man/prof_server.html
old mode 100755 (executable)
new mode 100644 (file)
index 44d09f1..009d68c
--- a/osfmk/man/prof_server.html
+++ b/osfmk/man/prof_server.html
@@ -1 +1,49 @@
-<h2>prof_server</h2>\r<hr>\r<p>\r<strong>Function</strong> - Handle the next kernel-generated PC sample message.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>boolean_t        prof_server</strong>\r           <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,\r                <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>in_msg</var> \r<dd>\r[pointer to in structure]\rThe sample message received from the kernel.\r<p>\r<dt> <var>out_msg</var> \r<dd>\r[out structure]\rNot used.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>prof_server</strong> function is the MIG generated server\rhandling function to\rhandle messages from the kernel corresponding to program counter (profiling)\rsamples.  Such messages are delivered to the task or thread sample port set by \r<strong>task_sample</strong> or <strong>thread_sample</strong>.  The <strong>prof_server</strong>\rfunction performs all\rnecessary argument handling for this kernel message and calls the appropriate\rhandling function.  These functions must be supplied by the caller.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>TRUE</strong>\r<dd>\rThe message was handled and the appropriate function was called.\r<p>\r<dt> <strong>FALSE</strong>\r<dd>\rThe message did not apply to the sample mechanism and no other\raction was taken.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="receive_samples.html"><strong>receive_samples<strong></a>.\r
\ No newline at end of file
+<h2>prof_server</h2>
+<hr>
+<p>
+<strong>Function</strong> - Handle the next kernel-generated PC sample message.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>boolean_t      prof_server</strong>
+               <strong>(mach_msg_header_t</strong>     <var>request_msg</var>,
+               <strong>mach_msg_header_t</strong>      <var>reply_ms</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>in_msg</var> 
+<dd>
+[pointer to in structure]
+The sample message received from the kernel.
+<p>
+<dt> <var>out_msg</var> 
+<dd>
+[out structure]
+Not used.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>prof_server</strong> function is the MIG generated server
+handling function to
+handle messages from the kernel corresponding to program counter (profiling)
+samples.  Such messages are delivered to the task or thread sample port set by 
+<strong>task_sample</strong> or <strong>thread_sample</strong>.  The <strong>prof_server</strong>
+function performs all
+necessary argument handling for this kernel message and calls the appropriate
+handling function.  These functions must be supplied by the caller.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>TRUE</strong>
+<dd>
+The message was handled and the appropriate function was called.
+<p>
+<dt> <strong>FALSE</strong>
+<dd>
+The message did not apply to the sample mechanism and no other
+action was taken.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="receive_samples.html"><strong>receive_samples<strong></a>.