ryujinx-mirror/Ryujinx.Memory/MemoryAllocationFlags.cs

using System;

namespace Ryujinx.Memory
{
    /// <summary>
    /// Flags that controls allocation and other properties of the memory block memory.
    /// </summary>
    [Flags]
    public enum MemoryAllocationFlags
    {
        /// <summary>
        /// No special allocation settings.
        /// </summary>
        None = 0,

        /// <summary>
        /// Reserve a region of memory on the process address space,
        /// without actually allocation any backing memory.
        /// </summary>
        Reserve = 1 << 0,

        /// <summary>
        /// Enables read and write tracking of the memory block.
        /// This currently does nothing and is reserved for future use.
        /// </summary>
        Tracked = 1 << 1,

        /// <summary>
        /// Enables mirroring of the memory block through aliasing of memory pages.
        /// When enabled, this allows creating more memory blocks sharing the same backing storage.
        /// </summary>
        Mirrorable = 1 << 2,

        /// <summary>
        /// Indicates that the memory block should support mapping views of a mirrorable memory block.
        /// The block that is to have their views mapped should be created with the <see cref="Mirrorable"/> flag.
        /// </summary>
        ViewCompatible = 1 << 3,

        /// <summary>
        /// If used with the <see cref="Mirrorable"/> flag, indicates that the memory block will only be used as
        /// backing storage and will never be accessed directly, so the memory for the block will not be mapped.
        /// </summary>
        NoMap = 1 << 4,

        /// <summary>
        /// Indicates that the memory will be used to store JIT generated code.
        /// On some platforms, this requires special flags to be passed that will allow the memory to be executable.
        /// </summary>
        Jit = 1 << 5
    }
}