Skip to content

Commit d53f123

Browse files
committed
Add documentation for the proxy library
Signed-off-by: Lukasz Dorau <[email protected]>
1 parent 0bf7876 commit d53f123

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,26 @@ using umfMemspaceHostAllGet.
199199
Memspace backed by all available NUMA nodes discovered on the platform sorted by capacity.
200200
Can be retrieved using umfMemspaceHighestCapacityGet.
201201

202+
### Proxy library
203+
204+
UMF provides the UMF proxy library (`umf_proxy`) that makes it possible
205+
to override the default allocator in other programs in both Linux and Windows.
206+
207+
#### Linux
208+
209+
In case of Linux it can be done without any code changes using the `LD_PRELOAD` environment variable:
210+
211+
```sh
212+
$ LD_PRELOAD=/usr/lib/libumf_proxy.so myprogram
213+
```
214+
215+
#### Windows
216+
217+
In case of Windows it requires:
218+
1) explicitly linking your program dynamically with the `umf_proxy.dll` library
219+
2) (C++ code only) including `proxy_lib_new_delete.h` in a single(!) source file in your project
220+
to override also the `new`/`delete` operations.
221+
202222
## Contributions
203223

204224
All contributions to the UMF project are most welcome! Before submitting

0 commit comments

Comments
 (0)