xref: /xnu-8796.121.2/osfmk/man/memory_object_data_error.html (revision c54f35ca767986246321eb901baf8f5ff7923f6a)
1*c54f35caSApple OSS Distributions<h2>memory_object_data_error</h2>
2*c54f35caSApple OSS Distributions<hr>
3*c54f35caSApple OSS Distributions<p>
4*c54f35caSApple OSS Distributions<strong>Function</strong> - An error prevents the supply of previously requested data.
5*c54f35caSApple OSS Distributions<h3>SYNOPSIS</h3>
6*c54f35caSApple OSS Distributions<pre>
7*c54f35caSApple OSS Distributions<strong>kern_return_t   memory_object_data_error</strong>
8*c54f35caSApple OSS Distributions                <strong>(memory_object_control_t</strong>         <var>memory_control</var>,
9*c54f35caSApple OSS Distributions                 <strong>vm_offset_t</strong>                             <var>offset</var>,
10*c54f35caSApple OSS Distributions                 <strong>vm_size_t</strong>                                 <var>size</var>,
11*c54f35caSApple OSS Distributions                 <strong>kern_return_t</strong>                           <var>reason</var><strong>);</strong>
12*c54f35caSApple OSS Distributions</pre>
13*c54f35caSApple OSS Distributions<h3>PARAMETERS</h3>
14*c54f35caSApple OSS Distributions<dl>
15*c54f35caSApple OSS Distributions<p>
16*c54f35caSApple OSS Distributions<dt> <var>memory_control</var>
17*c54f35caSApple OSS Distributions<dd>
18*c54f35caSApple OSS Distributions[in memory-cache-control send right]
19*c54f35caSApple OSS DistributionsThe memory cache control port
20*c54f35caSApple OSS Distributionsto be used by the memory manager for cache management requests.
21*c54f35caSApple OSS DistributionsThis port is provided by the kernel in a <strong>memory_object_create</strong> call.
22*c54f35caSApple OSS Distributions<p>
23*c54f35caSApple OSS Distributions<dt> <var>offset</var>
24*c54f35caSApple OSS Distributions<dd>
25*c54f35caSApple OSS Distributions[in scalar]
26*c54f35caSApple OSS DistributionsThe offset within the memory object, in bytes.
27*c54f35caSApple OSS Distributions<p>
28*c54f35caSApple OSS Distributions<dt> <var>size</var>
29*c54f35caSApple OSS Distributions<dd>
30*c54f35caSApple OSS Distributions[in scalar]
31*c54f35caSApple OSS DistributionsThe number of bytes of data (starting at <var>offset</var>).  The number
32*c54f35caSApple OSS Distributionsmust convert to an integral number of memory object pages.
33*c54f35caSApple OSS Distributions<p>
34*c54f35caSApple OSS Distributions<dt> <var>reason</var>
35*c54f35caSApple OSS Distributions<dd>
36*c54f35caSApple OSS Distributions[in scalar]
37*c54f35caSApple OSS DistributionsReason for the error.
38*c54f35caSApple OSS Distributions</dl>
39*c54f35caSApple OSS Distributions<h3>DESCRIPTION</h3>
40*c54f35caSApple OSS Distributions<p>
41*c54f35caSApple OSS DistributionsThe <strong>memory_object_data_error</strong> function indicates that
42*c54f35caSApple OSS Distributionsthe memory manager
43*c54f35caSApple OSS Distributionscannot provide the kernel with the data requested for the given region,
44*c54f35caSApple OSS Distributionsspecifying a reason for the error.
45*c54f35caSApple OSS Distributions<p>
46*c54f35caSApple OSS DistributionsWhen the kernel issues a <strong>memory_object_data_request</strong> call, the memory
47*c54f35caSApple OSS Distributionsmanager can respond with a <strong>memory_object_data_error</strong>
48*c54f35caSApple OSS Distributionscall to indicate that the
49*c54f35caSApple OSS Distributionspage cannot be retrieved, and that a memory failure exception should be raised
50*c54f35caSApple OSS Distributionsin any client threads that are waiting for the page.  Clients
51*c54f35caSApple OSS Distributionsare permitted to catch
52*c54f35caSApple OSS Distributionsthese exceptions and retry their page faults.  As a result, this
53*c54f35caSApple OSS Distributionscall can be used to
54*c54f35caSApple OSS Distributionsreport transient errors as well as permanent ones.  A memory manager can use
55*c54f35caSApple OSS Distributionsthis call for both hardware errors (for example, disk failures) and software
56*c54f35caSApple OSS Distributionserrors (for example, accessing data that does not exist or is protected).
57*c54f35caSApple OSS Distributions<h3>NOTES</h3>
58*c54f35caSApple OSS Distributions<p>
59*c54f35caSApple OSS DistributionsIf reason has a system code of <var>err_kern</var>, the kernel will substitute
60*c54f35caSApple OSS Distributionsan error value
61*c54f35caSApple OSS Distributionsof <strong>KERN_MEMORY_ERROR</strong>.
62*c54f35caSApple OSS Distributions<h3>RETURN VALUES</h3>
63*c54f35caSApple OSS Distributions<p>
64*c54f35caSApple OSS DistributionsOnly generic errors apply.
65*c54f35caSApple OSS Distributions<h3>RELATED INFORMATION</h3>
66*c54f35caSApple OSS Distributions<p>
67*c54f35caSApple OSS DistributionsFunctions:
68*c54f35caSApple OSS Distributions<a href="memory_object_data_request.html"><strong>memory_object_data_request</strong></a>,
69*c54f35caSApple OSS Distributions<a href="memory_object_data_supply.html"><strong>memory_object_data_supply</strong></a>,
70*c54f35caSApple OSS Distributions<a href="MO_data_unavailable.html"><strong>memory_object_data_unavailable</strong></a>.
71