xref: /xnu-8792.81.2/osfmk/man/memory_object_terminate.html (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1*19c3b8c2SApple OSS Distributions<h2>memory_object_terminate</h2>
2*19c3b8c2SApple OSS Distributions<hr>
3*19c3b8c2SApple OSS Distributions<p>
4*19c3b8c2SApple OSS Distributions<strong>Server Interface</strong> - Relinquish access to a memory object.
5*19c3b8c2SApple OSS Distributions<h3>SYNOPSIS</h3>
6*19c3b8c2SApple OSS Distributions<pre>
7*19c3b8c2SApple OSS Distributions<strong>kern_return_t   memory_object_terminate</strong>
8*19c3b8c2SApple OSS Distributions                <strong>(memory_object_t</strong>                  <var>memory_object</var>,
9*19c3b8c2SApple OSS Distributions                 <strong>memory_object_control_t</strong>         <var>memory_control</var><strong>);</strong>
10*19c3b8c2SApple OSS Distributions
11*19c3b8c2SApple OSS Distributions
12*19c3b8c2SApple OSS Distributions
13*19c3b8c2SApple OSS Distributions<strong>kern_return_t   seqnos_memory_object_terminate</strong>
14*19c3b8c2SApple OSS Distributions                <strong>(memory_object_t</strong>                  <var>memory_object</var>,
15*19c3b8c2SApple OSS Distributions                 <strong>mach_port_seqno_t</strong>                        <var>seqno</var>,
16*19c3b8c2SApple OSS Distributions                 <strong>memory_object_control_t</strong>         <var>memory_control</var><strong>);</strong>
17*19c3b8c2SApple OSS Distributions</pre>
18*19c3b8c2SApple OSS Distributions<h3>PARAMETERS</h3>
19*19c3b8c2SApple OSS Distributions<dl>
20*19c3b8c2SApple OSS Distributions<p>
21*19c3b8c2SApple OSS Distributions<dt> <var>memory_object</var>
22*19c3b8c2SApple OSS Distributions<dd>
23*19c3b8c2SApple OSS Distributions[in abstract-memory-object (receive) right]
24*19c3b8c2SApple OSS DistributionsThe abstract memory
25*19c3b8c2SApple OSS Distributionsobject port that represents the memory object data.
26*19c3b8c2SApple OSS Distributions<p>
27*19c3b8c2SApple OSS Distributions<dt> <var>seqno</var>
28*19c3b8c2SApple OSS Distributions<dd>
29*19c3b8c2SApple OSS Distributions[in scalar]
30*19c3b8c2SApple OSS DistributionsThe sequence number of this message relative to the abstract
31*19c3b8c2SApple OSS Distributionsmemory object port.
32*19c3b8c2SApple OSS Distributions<p>
33*19c3b8c2SApple OSS Distributions<dt> <var>memory_control</var>
34*19c3b8c2SApple OSS Distributions<dd>
35*19c3b8c2SApple OSS Distributions[in memory-cache-control receive right]
36*19c3b8c2SApple OSS DistributionsThe memory cache control
37*19c3b8c2SApple OSS Distributionsport to be used for a response by the memory manager.  If the memory
38*19c3b8c2SApple OSS Distributionsobject has been supplied to more than one kernel, this parameter
39*19c3b8c2SApple OSS Distributionsidentifies the kernel that is making the call.
40*19c3b8c2SApple OSS Distributions</dl>
41*19c3b8c2SApple OSS Distributions<h3>DESCRIPTION</h3>
42*19c3b8c2SApple OSS Distributions<p>
43*19c3b8c2SApple OSS DistributionsA <strong>memory_object_terminate</strong> function is called as the
44*19c3b8c2SApple OSS Distributionsresult of a kernel
45*19c3b8c2SApple OSS Distributionsmessage notifying a memory manager that no mappings of the specified memory
46*19c3b8c2SApple OSS Distributionsobject remain.  The kernel makes this call to allow the memory
47*19c3b8c2SApple OSS Distributionsmanager to clean
48*19c3b8c2SApple OSS Distributionsup data structures associated with the deallocated mappings.
49*19c3b8c2SApple OSS DistributionsThe call provides
50*19c3b8c2SApple OSS Distributionsreceive rights to the memory cache control port so that the memory manager
51*19c3b8c2SApple OSS Distributionscan retrieve any messages it sent into this port before knowing the memory
52*19c3b8c2SApple OSS Distributionsobject was being terminated and then destroy the port.  The kernel also
53*19c3b8c2SApple OSS Distributionsrelinquishes its rights for all memory object ports.
54*19c3b8c2SApple OSS Distributions<p>
55*19c3b8c2SApple OSS DistributionsThe kernel terminates a memory object only after all address space mappings of
56*19c3b8c2SApple OSS Distributionsthe object have been deallocated, or upon explicit request by the memory
57*19c3b8c2SApple OSS Distributionsmanager.
58*19c3b8c2SApple OSS Distributions<h3>RETURN VALUES</h3>
59*19c3b8c2SApple OSS Distributions<p>
60*19c3b8c2SApple OSS DistributionsOnly generic errors apply.
61*19c3b8c2SApple OSS Distributions<h3>RELATED INFORMATION</h3>
62*19c3b8c2SApple OSS Distributions<p>
63*19c3b8c2SApple OSS DistributionsFunctions:
64*19c3b8c2SApple OSS Distributions<a href="memory_object_destroy.html"><strong>memory_object_destroy</strong></a>,
65*19c3b8c2SApple OSS Distributions<a href="mach_port_deallocate.html"><strong>mach_port_deallocate</strong></a>,
66*19c3b8c2SApple OSS Distributions<a href="memory_object_server.html"><strong>memory_object_server</strong></a>,
67*19c3b8c2SApple OSS Distributions<a href="SMO_server.html"><strong>seqnos_memory_object_server</strong></a>.
68