osfmk/man/receive_samples.html

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