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

<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