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