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