osfmk/man/MO_get_attributes.html

   1 <h2>memory_object_get_attributes</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return current attributes for a memory object.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   memory_object_get_attributes</strong>
   8                 <strong>(memory_object_control_t</strong>         <var>memory_control</var>,
   9                  <strong>memory_object_flavor_t</strong>                  <var>flavor</var>,
  10                  <strong>memory_object_info_t</strong>                <var>attributes</var>,
  11                  <strong>mach_msg_type_number_t</strong>        <var>attributes_count</var><strong>);</strong>
  12 </pre>
  13 <h3>PARAMETERS</h3>
  14 <dl>
  15 <p>
  16 <dt> <var>memory_control</var>
  17 <dd>
  18 [in memory-cache-control send right]
  19 The memory cache control port
  20 to be used by the memory manager for cache management requests.
  21 This port is provided by the kernel in a <strong>memory_object_notify</strong> call.
  22 <p>
  23 <dt> <var>flavor</var>
  24 <dd>
  25 [in scalar]
  26 The type of information to be returned.  Valid values are:
  27 <dl>
  28 <p>
  29 <dt> <strong>MEMORY_OBJECT_PERFORMANCE_INFO</strong>
  30 <dd>
  31 Performance related attributes such as the cache indicator and
  32 the cluster size.  <var>attributes</var> should specify a structure of type
  33 <strong>memory_object_perf_info</strong>.
  34 <p>
  35 <dt> <strong>MEMORY_OBJECT_BEHAVIOR_INFO</strong>
  36 <dd>
  37 Behavior related attributes such as the copy strategy and sync
  38 invalidate flag.  <var>attributes</var> should specify a structure of type
  39 <strong>memory_object_behavior_info</strong>.
  40      <dt> <strong>MEMORY_OBJECT_ATTRIBUTES_INFO</strong>
  41 <dd>
  42 Behavior and performance related attributes such as the copy strategy,
  43 cache indicator, and cluster size.  <var>attributes</var> should specify a structure of type
  44 <strong>memory_object_attr_info</strong>.
  45 </dl>
  46 <p>
  47 <dt> <var>attributes</var>
  48 <dd>
  49 [out structure]
  50 Current attributes.
  51 <p>
  52 <dt> <var>attributes_count</var>
  53 <dd>
  54 [in/out scalar]
  55 On input, the maximum size of the buffer; on output, the
  56 size returned (in natural-sized units).
  57 </dl>
  58 <h3>DESCRIPTION</h3>
  59 <p>
  60 The <strong>memory_object_get_attributes</strong> function retrieves
  61 the current attributes for
  62 the specified memory object.
  63 <h3>RETURN VALUES</h3>
  64 <p>
  65 Only generic errors apply.
  66 <h3>RELATED INFORMATION</h3>
  67 <p>
  68 Functions:
  69 <a href="MO_change_attributes.html"><strong>memory_object_change_attributes</strong></a>.
  70 <p>
  71 Data Structures:
  72 <a href="memory_object_perf_info.html"><strong>memory_object_perf_info</strong></a>,
  73 <a href="memory_object_attr_info.html"><strong>memory_object_attr_info</strong></a>.