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