All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 ARCH_VIRTUALMEMORY_H
25 #define ARCH_VIRTUALMEMORY_H
26 
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/arch/api.h"
33 
34 #include <cstddef>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
41 ARCH_API void *
42 ArchReserveVirtualMemory(size_t numBytes);
43 
49 ARCH_API bool
50 ArchCommitVirtualMemoryRange(void *start, size_t numBytes);
51 
57 ARCH_API bool
58 ArchFreeVirtualMemory(void *start, size_t numBytes);
59 
60 PXR_NAMESPACE_CLOSE_SCOPE
61 
62 #endif // ARCH_VIRTUALMEMORY_H
ARCH_API bool ArchCommitVirtualMemoryRange(void *start, size_t numBytes)
Make the range of numBytes bytes starting at start available for reading and writing.
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.