You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-1Lines changed: 21 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The Unified Memory Framework (UMF) is a library for constructing allocators and
12
12
13
13
A UMF memory pool is a combination of a pool allocator and a memory provider. A memory provider is responsible for coarse-grained memory allocations and management of memory pages, while the pool allocator controls memory pooling and handles fine-grained memory allocations.
14
14
15
-
Pool allocator can leverage existing allocators (e.g. jemalloc or tbbmalloc) or be written from scratch.
15
+
Pool allocator can leverage existing allocators (e.g. jemalloc or tbbmalloc) or be written from scratch.
16
16
17
17
UMF comes with predefined pool allocators (see include/pool) and providers (see include/provider). UMF can also work with user-defined pools and providers that implement a specific interface (see include/umf/memory_pool_ops.h and include/umf/memory_provider_ops.h)
18
18
@@ -97,6 +97,22 @@ $ cd build
97
97
$ cmake {path_to_source_dir}
98
98
$ make
99
99
```
100
+
101
+
### Sanitizers
102
+
103
+
List of sanitizers available on Linux:
104
+
- AddressSanitizer
105
+
- UndefinedBehaviorSanitizer
106
+
- ThreadSanitizer
107
+
- Is mutually exclusive with other sanitizers.
108
+
- MemorySanitizer
109
+
- Requires linking against MSan-instrumented libraries to prevent false positive reports. More information [here](https://github.com/google/sanitizers/wiki/MemorySanitizerLibcxxHowTo).
110
+
111
+
List of sanitizers available on Windows:
112
+
- AddressSanitizer
113
+
114
+
Listed sanitizers can be enabled with appropriate [CMake options](#cmake-standard-options).
115
+
100
116
## Contributions
101
117
102
118
All code has to be formatted using clang-format. To check the formatting do:
@@ -130,3 +146,7 @@ List of options provided by CMake:
130
146
| UMF_ENABLE_POOL_TRACKING | Build UMF with pool tracking | ON/OFF | ON |
131
147
| UMF_DEVELOPER_MODE | Treat warnings as errors and enables additional checks | ON/OFF | OFF |
132
148
| UMF_FORMAT_CODE_STYLE | Add clang-format-check and clang-format-apply targets to make | ON/OFF | OFF |
0 commit comments