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