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