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