aboutsummaryrefslogtreecommitdiff
path: root/doc/Allocators.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Allocators.md')
-rw-r--r--doc/Allocators.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/Allocators.md b/doc/Allocators.md
index 2fce8d8..0ce5d77 100644
--- a/doc/Allocators.md
+++ b/doc/Allocators.md
@@ -1,26 +1,26 @@
# Allocators
allocbench supports three mechanisms to change the used allocator for program
-run with exec. The easiest is using ```LD_PRELOAD``` to overwrite ```malloc/free```
+run with exec. The easiest is using `LD_PRELOAD` to overwrite `malloc/free`
with the functions of a shared library like libtcmalloc.so. If LD_PRELOAD
can't be used you can specify a command prefix to somehow load and use your allocator.
This command prefix is used for different versions of glibc. The command is
prefixed with the loader of the glibc version to test. *Note that the whole glibc
is changed maybe tampering with the results*. Additionally binary suffixes are
-supported. This could be used to use with ```patchelf``` patched binaries to
-use different ```rpath``` or ```linker```.
+supported. This could be used to use with `patchelf` patched binaries to
+use different `rpath` or `linker`.
The used allocators are stored in a global python dictionary associating
-their names with the fields: ```cmd_prefix, binary_suffix, LD_PRELOAD``` and ```color```.
+their names with the fields: `cmd_prefix, binary_suffix, LD_PRELOAD` and `color`.
-By default this dictionary is build from locally installed allocators found by ```whereis```.
+By default this dictionary is build from locally installed allocators found by `whereis`.
-You can overwrite the default allocators with the ```-a | --allocators``` option
-and a python script exporting a global dictionary with the name ```allocators```.
+You can overwrite the default allocators with the `-a | --allocators` option
+and a python script exporting a global dictionary with the name `allocators`.
## Building Allocators
To reproducible build allocators and patched version you can use the
-classes ```Allocator{_Sources,_Patched}``` provided in ```src/allocator.py```.
+classes `Allocator{_Sources,_Patched}``` provided in ```src/allocator.py`.
-See allocators/no_falsesharing.py or allocators/BA_allocators.py for examples.
+See [](allocators/no_falsesharing.py) or [](allocators/BA_allocators.py) for examples.