xref: /xnu-10063.121.3/osfmk/man/memory_object_perf_info.html (revision 2c2f96dc2b9a4408a43d3150ae9c105355ca3daa)
1*2c2f96dcSApple OSS Distributions<h2>memory_object_perf_info</h2>
2*2c2f96dcSApple OSS Distributions<hr>
3*2c2f96dcSApple OSS Distributions<p>
4*2c2f96dcSApple OSS Distributions<strong>Structure</strong> - Specifies a memory object's attributes with respect to performance.
5*2c2f96dcSApple OSS Distributions<h3>SYNOPSIS</h3>
6*2c2f96dcSApple OSS Distributions<pre>
7*2c2f96dcSApple OSS Distributions<strong>struct  memory_object_perf_info</strong>
8*2c2f96dcSApple OSS Distributions<strong>{</strong>
9*2c2f96dcSApple OSS Distributions        <strong>vm_offset_t</strong>      <var>cluster_size</var><strong>;</strong>
10*2c2f96dcSApple OSS Distributions        <strong>boolean_t</strong>    <var>may_cache_object</var><strong>;</strong>
11*2c2f96dcSApple OSS Distributions<strong>};</strong>
12*2c2f96dcSApple OSS Distributions
13*2c2f96dcSApple OSS Distributions<strong>typedef struct memory_object_perf_info* memory_object_perf_info_t;</strong>
14*2c2f96dcSApple OSS Distributions</pre>
15*2c2f96dcSApple OSS Distributions<h3>FIELDS</h3>
16*2c2f96dcSApple OSS Distributions<dl>
17*2c2f96dcSApple OSS Distributions<dt> <var>cluster_size</var>
18*2c2f96dcSApple OSS Distributions<dd>
19*2c2f96dcSApple OSS DistributionsPreferred cluster size (in bytes) for the memory object.  This helps to
20*2c2f96dcSApple OSS Distributionsdetermine how many pages are transferred in individual data request
21*2c2f96dcSApple OSS Distributionsand return messages.
22*2c2f96dcSApple OSS Distributions<p>
23*2c2f96dcSApple OSS Distributions<dt> <var>may_cache_object</var>
24*2c2f96dcSApple OSS Distributions<dd>
25*2c2f96dcSApple OSS DistributionsCache indicator.  If true, the kernel can cache data associated with the
26*2c2f96dcSApple OSS Distributionsmemory object (keep the memory object active) even if no virtual
27*2c2f96dcSApple OSS Distributionsmemory references to it remain.
28*2c2f96dcSApple OSS Distributions</dl>
29*2c2f96dcSApple OSS Distributions<h3>DESCRIPTION</h3>
30*2c2f96dcSApple OSS Distributions<p>
31*2c2f96dcSApple OSS DistributionsThe <strong>memory_object_perf_info</strong> structure
32*2c2f96dcSApple OSS Distributionsdefines a memory object's character with respect to performance.
33*2c2f96dcSApple OSS Distributions<h3>NOTES</h3>
34*2c2f96dcSApple OSS Distributions<p>
35*2c2f96dcSApple OSS DistributionsSharing cached data among all the clients of a memory object can have a major
36*2c2f96dcSApple OSS Distributionsimpact on performance, especially if it can be extended across successive, as
37*2c2f96dcSApple OSS Distributionswell as concurrent, uses.  For example, the memory objects that represent
38*2c2f96dcSApple OSS Distributionsprogram images can be used regularly by different programs.
39*2c2f96dcSApple OSS DistributionsBy retaining the data
40*2c2f96dcSApple OSS Distributionsfor these memory objects in cache, the number of secondary storage accesses
41*2c2f96dcSApple OSS Distributionscan be reduced significantly.
42*2c2f96dcSApple OSS Distributions<h3>RELATED INFORMATION</h3>
43*2c2f96dcSApple OSS Distributions<p>
44*2c2f96dcSApple OSS DistributionsFunctions:
45*2c2f96dcSApple OSS Distributions<a href="MO_get_attributes.html"><strong>memory_object_get_attributes</strong></a>,
46*2c2f96dcSApple OSS Distributions<a href="MO_change_attributes.html"><strong>memory_object_change_attributes</strong></a>,
47*2c2f96dcSApple OSS Distributions<a href="vm_region.html"><strong>vm_region</strong></a>,
48*2c2f96dcSApple OSS Distributions<a href="memory_object_synchronize.html"><strong>memory_object_synchronize</strong></a>,
49*2c2f96dcSApple OSS Distributions<a href="VSD_memory_manager.html"><strong>vm_set_default_memory_manager</strong></a>,
50*2c2f96dcSApple OSS Distributions<a href="vm_msync.html"><strong>vm_msync</strong></a>.
51*2c2f96dcSApple OSS Distributions<p>
52*2c2f96dcSApple OSS DistributionsStructures:
53*2c2f96dcSApple OSS Distributions<a href="memory_object_attr_info.html"><strong>memory_object_attr_info</strong></a>.
54