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

<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>.