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