Loading...
Searching...
No Matches
virtualMemory.h
Go to the documentation of this file.
1//
2// Copyright 2019 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_BASE_ARCH_VIRTUAL_MEMORY_H
25#define PXR_BASE_ARCH_VIRTUAL_MEMORY_H
26
30
31#include "pxr/pxr.h"
32#include "pxr/base/arch/api.h"
33
34#include <cstddef>
35
36PXR_NAMESPACE_OPEN_SCOPE
37
41ARCH_API void *
42ArchReserveVirtualMemory(size_t numBytes);
43
49ARCH_API bool
50ArchCommitVirtualMemoryRange(void *start, size_t numBytes);
51
57ARCH_API bool
58ArchFreeVirtualMemory(void *start, size_t numBytes);
59
62 ArchProtectNoAccess,
63 ArchProtectReadOnly,
64 ArchProtectReadWrite,
65 ArchProtectReadWriteCopy
66};
67
75ARCH_API bool
76ArchSetMemoryProtection(void const *start, size_t numBytes,
77 ArchMemoryProtection protection);
78
79PXR_NAMESPACE_CLOSE_SCOPE
80
81#endif // PXR_BASE_ARCH_VIRTUAL_MEMORY_H
ARCH_API bool ArchCommitVirtualMemoryRange(void *start, size_t numBytes)
Make the range of numBytes bytes starting at start available for reading and writing.
ArchMemoryProtection
Memory protection options, see ArchSetMemoryProtection().
Definition: virtualMemory.h:61
ARCH_API bool ArchFreeVirtualMemory(void *start, size_t numBytes)
Return memory obtained with ArchReserveVirtualMemory() to the system.
ARCH_API void * ArchReserveVirtualMemory(size_t numBytes)
Reserve numBytes bytes of virtual memory.
ARCH_API bool ArchSetMemoryProtection(void const *start, size_t numBytes, ArchMemoryProtection protection)
Change the memory protection on the pages containing start and start + numBytes to protection.