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