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