HDK
 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 PXR_BASE_ARCH_VIRTUAL_MEMORY_H
25 #define PXR_BASE_ARCH_VIRTUAL_MEMORY_H
26 
27 /// \file arch/virtualMemory.h
28 /// \ingroup group_arch_SystemFunctions
29 /// Architecture dependent routines for virtual memory.
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/arch/api.h"
33 
34 #include <cstddef>
35 
37 
38 /// Reserve \p numBytes bytes of virtual memory. Call ArchCommitVirtualMemory()
39 /// on subranges to write to and read from the memory. Return nullptr in case
40 /// of an error; check errno.
41 ARCH_API void *
42 ArchReserveVirtualMemory(size_t numBytes);
43 
44 /// Make the range of \p numBytes bytes starting at \p start available for
45 /// reading and writing. The range must be within one previously reserved by
46 /// ArchReserveVirtualMemory(). It is not an error to commit a range that was
47 /// previously partly or fully committed. Return false in case of an error;
48 /// check errno.
49 ARCH_API bool
50 ArchCommitVirtualMemoryRange(void *start, size_t numBytes);
51 
52 /// Return memory obtained with ArchReserveVirtualMemory() to the system. The
53 /// \p start argument must be the value returned from a previous call to
54 /// ArchReserveVirtualMemory, and \p numBytes must match the argument from that
55 /// call. Memory within the range may not be accessed after this call. Return
56 /// false in case of an error; check errno.
57 ARCH_API bool
58 ArchFreeVirtualMemory(void *start, size_t numBytes);
59 
61 
62 #endif // PXR_BASE_ARCH_VIRTUAL_MEMORY_H
ARCH_API bool ArchCommitVirtualMemoryRange(void *start, size_t numBytes)
GLuint start
Definition: glew.h:1253
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
PXR_NAMESPACE_OPEN_SCOPE ARCH_API void * ArchReserveVirtualMemory(size_t numBytes)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
ARCH_API bool ArchFreeVirtualMemory(void *start, size_t numBytes)
#define ARCH_API
Definition: api.h:40