xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/receive_samples.html b/osfmk/man/receive_samples.html
index 9268ac6838451959473d03d0d1b9e5ba0870bb3c..fb61dfd9fe5696c1a32700ae0498ae3dc2f95dc9 100755 (executable)
--- a/osfmk/man/receive_samples.html
+++ b/osfmk/man/receive_samples.html
@@ -1 +1,51 @@
-<h2>receive_samples</h2>\r<p>\rServer Interface - Handles the occurrence of a PC sampling message\r\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   receive_samples</strong>\r                <strong>(mach_port_t</strong>                     <var>sample_port</var>,\r                 <strong>sample_array_t</strong>                      <var>samples</var>,\r                 <strong>mach_msg_type_number_t</strong>         <var>sample_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>sample_port</var>\r<dd>\r[in sample (receive) right] The port to which the sample message was \rsent.\r\r<dt> <var>samples</var>\r<dd>\r[pointer to in array of vm_address_t] An array of PC sample values.\r\r<dt> <var>sample_count</var>\r<dd>\r[in scalar] The number of values in samples.\r</dl>\r\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>receive_samples</strong> function is called by\r<strong>prof_server</strong> as the result of a kernel \rmessage indicating that a set of program counter samples has been gathered. \rThe parameter <var>sample_port</var> specifies the port named via\ra previous call to <strong>task_sample</strong>\ror <strong>thread_sample</strong>.\r\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the virtual addresses \rin the <var>samples</var> parameter.\r\r<h3>RETURN VALUE</h3>\r<p>\rIrrelevant.\r\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_sample.html"><strong>task_sample</strong></a>,\r<a href="thread_sample.html"><strong>thread_sample</strong></a>,\r<a href="prof_server.html"><strong>prof_server</strong></a>.\r
\ No newline at end of file
+<h2>receive_samples</h2>
+<p>
+Server Interface - Handles the occurrence of a PC sampling message
+
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   receive_samples</strong>
+                <strong>(mach_port_t</strong>                     <var>sample_port</var>,
+                 <strong>sample_array_t</strong>                      <var>samples</var>,
+                 <strong>mach_msg_type_number_t</strong>         <var>sample_count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>sample_port</var>
+<dd>
+[in sample (receive) right] The port to which the sample message was 
+sent.
+
+<dt> <var>samples</var>
+<dd>
+[pointer to in array of vm_address_t] An array of PC sample values.
+
+<dt> <var>sample_count</var>
+<dd>
+[in scalar] The number of values in samples.
+</dl>
+
+<h3>DESCRIPTION</h3>
+<p>
+A <strong>receive_samples</strong> function is called by
+<strong>prof_server</strong> as the result of a kernel 
+message indicating that a set of program counter samples has been gathered. 
+The parameter <var>sample_port</var> specifies the port named via
+a previous call to <strong>task_sample</strong>
+or <strong>thread_sample</strong>.
+
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the virtual addresses 
+in the <var>samples</var> parameter.
+
+<h3>RETURN VALUE</h3>
+<p>
+Irrelevant.
+
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="task_sample.html"><strong>task_sample</strong></a>,
+<a href="thread_sample.html"><strong>thread_sample</strong></a>,
+<a href="prof_server.html"><strong>prof_server</strong></a>.