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