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