xref: /xnu-8019.80.24/osfmk/man/prof_server.html (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions<h2>prof_server</h2>
2*a325d9c4SApple OSS Distributions<hr>
3*a325d9c4SApple OSS Distributions<p>
4*a325d9c4SApple OSS Distributions<strong>Function</strong> - Handle the next kernel-generated PC sample message.
5*a325d9c4SApple OSS Distributions<h3>SYNOPSIS</h3>
6*a325d9c4SApple OSS Distributions<pre>
7*a325d9c4SApple OSS Distributions<strong>boolean_t	prof_server</strong>
8*a325d9c4SApple OSS Distributions		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,
9*a325d9c4SApple OSS Distributions		<strong>mach_msg_header_t</strong>	<var>reply_ms</var><strong>);</strong>
10*a325d9c4SApple OSS Distributions</pre>
11*a325d9c4SApple OSS Distributions<h3>PARAMETERS</h3>
12*a325d9c4SApple OSS Distributions<dl>
13*a325d9c4SApple OSS Distributions<p>
14*a325d9c4SApple OSS Distributions<dt> <var>in_msg</var>
15*a325d9c4SApple OSS Distributions<dd>
16*a325d9c4SApple OSS Distributions[pointer to in structure]
17*a325d9c4SApple OSS DistributionsThe sample message received from the kernel.
18*a325d9c4SApple OSS Distributions<p>
19*a325d9c4SApple OSS Distributions<dt> <var>out_msg</var>
20*a325d9c4SApple OSS Distributions<dd>
21*a325d9c4SApple OSS Distributions[out structure]
22*a325d9c4SApple OSS DistributionsNot used.
23*a325d9c4SApple OSS Distributions</dl>
24*a325d9c4SApple OSS Distributions<h3>DESCRIPTION</h3>
25*a325d9c4SApple OSS Distributions<p>
26*a325d9c4SApple OSS DistributionsThe <strong>prof_server</strong> function is the MIG generated server
27*a325d9c4SApple OSS Distributionshandling function to
28*a325d9c4SApple OSS Distributionshandle messages from the kernel corresponding to program counter (profiling)
29*a325d9c4SApple OSS Distributionssamples.  Such messages are delivered to the task or thread sample port set by
30*a325d9c4SApple OSS Distributions<strong>task_sample</strong> or <strong>thread_sample</strong>.  The <strong>prof_server</strong>
31*a325d9c4SApple OSS Distributionsfunction performs all
32*a325d9c4SApple OSS Distributionsnecessary argument handling for this kernel message and calls the appropriate
33*a325d9c4SApple OSS Distributionshandling function.  These functions must be supplied by the caller.
34*a325d9c4SApple OSS Distributions<h3>RETURN VALUES</h3>
35*a325d9c4SApple OSS Distributions<dl>
36*a325d9c4SApple OSS Distributions<p>
37*a325d9c4SApple OSS Distributions<dt> <strong>TRUE</strong>
38*a325d9c4SApple OSS Distributions<dd>
39*a325d9c4SApple OSS DistributionsThe message was handled and the appropriate function was called.
40*a325d9c4SApple OSS Distributions<p>
41*a325d9c4SApple OSS Distributions<dt> <strong>FALSE</strong>
42*a325d9c4SApple OSS Distributions<dd>
43*a325d9c4SApple OSS DistributionsThe message did not apply to the sample mechanism and no other
44*a325d9c4SApple OSS Distributionsaction was taken.
45*a325d9c4SApple OSS Distributions</dl>
46*a325d9c4SApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*a325d9c4SApple OSS Distributions<p>
48*a325d9c4SApple OSS DistributionsFunctions:
49*a325d9c4SApple OSS Distributions<a href="receive_samples.html"><strong>receive_samples<strong></a>.
50