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