xref: /xnu-10002.41.9/osfmk/man/memory_object_server.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>memory_object_server</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Handle kernel operation request aimed at a given memory manager.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>boolean_t	memory_object_server</strong>
8*699cd480SApple OSS Distributions		<strong>(mach_msg_header_t</strong>	<var>request_msg</var>,
9*699cd480SApple OSS Distributions		<strong>mach_msg_header_t</strong>	<var>reply_ms</var><strong>);</strong>
10*699cd480SApple OSS Distributions</pre>
11*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
12*699cd480SApple OSS Distributions<dl>
13*699cd480SApple OSS Distributions<p>
14*699cd480SApple OSS Distributions<dt> <var>in_msg</var>
15*699cd480SApple OSS Distributions<dd>
16*699cd480SApple OSS Distributions[pointer to in structure]
17*699cd480SApple OSS DistributionsThe memory manager message received from
18*699cd480SApple OSS Distributionsthe kernel.
19*699cd480SApple OSS Distributions<p>
20*699cd480SApple OSS Distributions<dt> <var>out_msg</var>
21*699cd480SApple OSS Distributions<dd>
22*699cd480SApple OSS Distributions[out structure]
23*699cd480SApple OSS DistributionsA reply message.  No messages to a memory manager
24*699cd480SApple OSS Distributionsexpect a direct reply, so this field is not used.
25*699cd480SApple OSS Distributions</dl>
26*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS DistributionsThe <strong>memory_object_server</strong> function is the MIG generated
29*699cd480SApple OSS Distributionsserver handling
30*699cd480SApple OSS Distributionsfunction to handle messages from the kernel targeted to a memory manager.
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS DistributionsA \*Vmemory manager\*O
33*699cd480SApple OSS Distributionsis a server task that responds to specific messages from the
34*699cd480SApple OSS Distributionskernel in order to handle memory management functions for the kernel.  The
35*699cd480SApple OSS Distributions<strong>memory_object_server</strong> function performs all necessary
36*699cd480SApple OSS Distributionsargument handling for
37*699cd480SApple OSS Distributionsa kernel message and calls one of the memory manager functions to interpret
38*699cd480SApple OSS Distributionsthe message.
39*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
40*699cd480SApple OSS Distributions<dl>
41*699cd480SApple OSS Distributions<p>
42*699cd480SApple OSS Distributions<dt> <strong>TRUE</strong>
43*699cd480SApple OSS Distributions<dd>
44*699cd480SApple OSS DistributionsThe message was handled and the appropriate function was called.
45*699cd480SApple OSS Distributions<p>
46*699cd480SApple OSS Distributions<dt> <strong>FALSE</strong>
47*699cd480SApple OSS Distributions<dd>
48*699cd480SApple OSS DistributionsThe message did not apply to this memory management interface and
49*699cd480SApple OSS Distributionsno other action was taken.
50*699cd480SApple OSS Distributions</dl>
51*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
52*699cd480SApple OSS Distributions<p>
53*699cd480SApple OSS DistributionsFunctions:
54*699cd480SApple OSS Distributions<a href="MO_default_server.html"><strong>memory_object_default_server<strong></a>,
55*699cd480SApple OSS Distributions<a href="memory_object_data_request.html"><strong>memory_object_data_request<strong></a>,
56*699cd480SApple OSS Distributions<a href="memory_object_data_return.html"><strong>memory_object_data_return<strong></a>,
57*699cd480SApple OSS Distributions<a href="memory_object_data_unlock.html"><strong>memory_object_data_unlock<strong></a>,
58*699cd480SApple OSS Distributions<a href="MO_lock_completed.html"><strong>memory_object_lock_completed<strong></a>,
59*699cd480SApple OSS Distributions<a href="MO_change_completed.html"><strong>memory_object_change_completed<strong></a>,
60*699cd480SApple OSS Distributions<a href="MO_supply_completed.html"><strong>memory_object_supply_completed<strong></a>,
61*699cd480SApple OSS Distributions<a href="memory_object_terminate.html"><strong>memory_object_terminate<strong></a>,
62*699cd480SApple OSS Distributions<a href="memory_object_synchronize.html"><strong>memory_object_synchronize<strong></a>,
63*699cd480SApple OSS Distributions<a href="SMO_server.html"><strong>seqnos_memory_object_server<strong></a>.
64