xref: /xnu-8020.121.3/osfmk/man/receive_samples.html (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions<h2>receive_samples</h2>
2*fdd8201dSApple OSS Distributions<p>
3*fdd8201dSApple OSS DistributionsServer Interface - Handles the occurrence of a PC sampling message
4*fdd8201dSApple OSS Distributions
5*fdd8201dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*fdd8201dSApple OSS Distributions<pre>
7*fdd8201dSApple OSS Distributions<strong>kern_return_t   receive_samples</strong>
8*fdd8201dSApple OSS Distributions                <strong>(mach_port_t</strong>                     <var>sample_port</var>,
9*fdd8201dSApple OSS Distributions                 <strong>sample_array_t</strong>                      <var>samples</var>,
10*fdd8201dSApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>         <var>sample_count</var><strong>);</strong>
11*fdd8201dSApple OSS Distributions</pre>
12*fdd8201dSApple OSS Distributions<h3>PARAMETERS</h3>
13*fdd8201dSApple OSS Distributions<dl>
14*fdd8201dSApple OSS Distributions<dt> <var>sample_port</var>
15*fdd8201dSApple OSS Distributions<dd>
16*fdd8201dSApple OSS Distributions[in sample (receive) right] The port to which the sample message was
17*fdd8201dSApple OSS Distributionssent.
18*fdd8201dSApple OSS Distributions
19*fdd8201dSApple OSS Distributions<dt> <var>samples</var>
20*fdd8201dSApple OSS Distributions<dd>
21*fdd8201dSApple OSS Distributions[pointer to in array of vm_address_t] An array of PC sample values.
22*fdd8201dSApple OSS Distributions
23*fdd8201dSApple OSS Distributions<dt> <var>sample_count</var>
24*fdd8201dSApple OSS Distributions<dd>
25*fdd8201dSApple OSS Distributions[in scalar] The number of values in samples.
26*fdd8201dSApple OSS Distributions</dl>
27*fdd8201dSApple OSS Distributions
28*fdd8201dSApple OSS Distributions<h3>DESCRIPTION</h3>
29*fdd8201dSApple OSS Distributions<p>
30*fdd8201dSApple OSS DistributionsA <strong>receive_samples</strong> function is called by
31*fdd8201dSApple OSS Distributions<strong>prof_server</strong> as the result of a kernel
32*fdd8201dSApple OSS Distributionsmessage indicating that a set of program counter samples has been gathered.
33*fdd8201dSApple OSS DistributionsThe parameter <var>sample_port</var> specifies the port named via
34*fdd8201dSApple OSS Distributionsa previous call to <strong>task_sample</strong>
35*fdd8201dSApple OSS Distributionsor <strong>thread_sample</strong>.
36*fdd8201dSApple OSS Distributions
37*fdd8201dSApple OSS Distributions<h3>NOTES</h3>
38*fdd8201dSApple OSS Distributions<p>
39*fdd8201dSApple OSS DistributionsThis interface is machine word length specific because of the virtual addresses
40*fdd8201dSApple OSS Distributionsin the <var>samples</var> parameter.
41*fdd8201dSApple OSS Distributions
42*fdd8201dSApple OSS Distributions<h3>RETURN VALUE</h3>
43*fdd8201dSApple OSS Distributions<p>
44*fdd8201dSApple OSS DistributionsIrrelevant.
45*fdd8201dSApple OSS Distributions
46*fdd8201dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*fdd8201dSApple OSS Distributions<p>
48*fdd8201dSApple OSS DistributionsFunctions:
49*fdd8201dSApple OSS Distributions<a href="task_sample.html"><strong>task_sample</strong></a>,
50*fdd8201dSApple OSS Distributions<a href="thread_sample.html"><strong>thread_sample</strong></a>,
51*fdd8201dSApple OSS Distributions<a href="prof_server.html"><strong>prof_server</strong></a>.
52