path: root/cvmx-malloc/README-malloc
diff options
Diffstat (limited to 'cvmx-malloc/README-malloc')
1 files changed, 12 insertions, 0 deletions
diff --git a/cvmx-malloc/README-malloc b/cvmx-malloc/README-malloc
new file mode 100644
index 000000000000..922a713410a9
--- /dev/null
+++ b/cvmx-malloc/README-malloc
@@ -0,0 +1,12 @@
+Readme for Octeon shared memory malloc
+This malloc is based on ptmalloc2, which is the malloc
+implementation of glibc. Source code and more information
+on this can be found at http://www.malloc.de/en/index.html.
+Please see the individual files for licensing terms.
+The main change to the code modifies the way the malloc
+gets memory from the system. Under Linux/Unix, malloc
+uses the brk or memmap sytem calls to request more memory.
+In this implementation, memory regions must be explicitly
+given to malloc by the application.