X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/743b15655a24ee3fe9f458f383003e011db0558f..13fec9890cf095cc781fdf7b8917cb03bf32dd4c:/osfmk/man/memory_object_attr_info.html diff --git a/osfmk/man/memory_object_attr_info.html b/osfmk/man/memory_object_attr_info.html index dcd0d42c0..7f94e44f1 100755 --- a/osfmk/man/memory_object_attr_info.html +++ b/osfmk/man/memory_object_attr_info.html @@ -1 +1,84 @@ -

memory_object_attr_info


Structure - Specifies memory object's behavior attributes.

SYNOPSIS

struct  memory_object_attr_info
{
        memory_object_copy_strategy_t    copy_strategy;
        vm_offset_t                       cluster_size;
        boolean_t                            may_cache;
        boolean_t                            temporary;
};

typedef struct memory_object_attr_info* memory_object_attr_info_t;

FIELDS

copy_strategy
How the kernel should handle copying of regions associated with the memory object. The copy strategy cannot be changed once an object is initialized. Valid values are:

MEMORY_OBJECT_COPY_NONE
Use normal procedure when copying the memory object's data. Normally, the kernel requests each page with read access, copies the data, and then (optionally) flushes the data.

MEMORY_OBJECT_COPY_CALL
Call the memory manager when a copy operation is necessary.

MEMORY_OBJECT_COPY_DELAY
Use copy-on-write technique. This strategy allows the kernel to efficiently copy large amounts of data and guarantees that the memory manager will not externally modify the data. It is the most commonly used copy strategy.

MEMORY_OBJECT_COPY_TEMPORARY
All changes are made in memory and the memory manager does not need to see them.

MEMORY_OBJECT_COPY_SYMMETRIC
The memory manager does not change the data, does not need to see any changes to the data, and will prevent the object from being mapped more than once. Currently, this strategy should be restricted to use by the kernel.

cluster_size
The memory object's perferred cluster size (in bytes). This value may affect the number of pages transferred in a given paging operation.

may_cache
Cache indicator. If true, the kernel can cache data associated with the memory object (keep the memory object active) even if no virtual memory references to it remain.

temporary
If TRUE, when the last mapping to the object is released, the kernel destroys the object without returning any resident pages.

DESCRIPTION

The memory_object_attr_info structure defines behavior and performance relevant memory object attributes.

RELATED INFORMATION

Functions: memory_object_get_attributes, memory_object_change_attributes, vm_region, memory_object_synchronize, vm_set_default_memory_manager, vm_msync. \ No newline at end of file +

memory_object_attr_info

+
+

+Structure - Specifies memory object's behavior attributes. +

SYNOPSIS

+
+struct  memory_object_attr_info
+{
+        memory_object_copy_strategy_t    copy_strategy;
+        vm_offset_t                       cluster_size;
+        boolean_t                            may_cache;
+        boolean_t                            temporary;
+};
+
+typedef struct memory_object_attr_info* memory_object_attr_info_t;
+
+

FIELDS

+
+
copy_strategy +
+How the kernel should handle copying of regions associated with the +memory object. The copy strategy cannot be changed once an object is +initialized. Valid values are: +
+

+

MEMORY_OBJECT_COPY_NONE +
+Use normal procedure when copying the memory object's +data. Normally, the kernel requests each page with read +access, copies the data, and then (optionally) flushes the data. +

+

MEMORY_OBJECT_COPY_CALL +
+Call the memory manager when a copy operation is necessary. +

+

MEMORY_OBJECT_COPY_DELAY +
+Use copy-on-write technique. This strategy allows the kernel +to efficiently copy large amounts of data and guarantees that +the memory manager will not externally modify the data. It is +the most commonly used copy strategy. +

+

MEMORY_OBJECT_COPY_TEMPORARY +
+All changes are made in memory and the memory manager does not need +to see them. +

+

MEMORY_OBJECT_COPY_SYMMETRIC +
+The memory manager does not change the data, does not need to see +any changes to the data, and will prevent the object from being +mapped more than once. Currently, this strategy should be restricted +to use by the kernel. +
+

+

cluster_size +
+The memory object's perferred cluster size (in bytes). This value may affect +the number of pages transferred in a given paging operation. +

+

may_cache +
+Cache indicator. If true, the kernel can cache data associated with the +memory object (keep the memory object active) even if no virtual +memory references to it remain. +

+

temporary +
+If TRUE, when the last mapping to the object is released, +the kernel destroys the object without returning any resident pages. +
+

DESCRIPTION

+

+The memory_object_attr_info structure defines behavior and +performance relevant memory object attributes. +

RELATED INFORMATION

+

+Functions: +memory_object_get_attributes, +memory_object_change_attributes, +vm_region, +memory_object_synchronize, +vm_set_default_memory_manager, +vm_msync.