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