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