doc: tcmalloc

diff --git a/doc/sphinx/performance/index.rst b/doc/sphinx/performance/index.rst
index d76b8082ccb319b075b954ce03136e265a4afe69..9fc1cd4af9ab931247dc7e8668e44cc38ad4b29b 100644 (file)
--- a/doc/sphinx/performance/index.rst
+++ b/doc/sphinx/performance/index.rst
@@ -9,3 +9,4 @@ Performance
    packet-profiling
    rule-profiling
    runmodes
+   tcmalloc

diff --git a/doc/sphinx/performance/tcmalloc.rst b/doc/sphinx/performance/tcmalloc.rst
new file mode 100644 (file)
index 0000000..3f3ea81
--- /dev/null
+++ b/doc/sphinx/performance/tcmalloc.rst
@@ -0,0 +1,39 @@
+Tcmalloc
+========
+
+‘tcmalloc’ is a library Google created as part of the google-perftools
+suite for improving memory handling in a threaded program. It’s very
+simple to use and does work fine with Suricata. It leads to minor
+speed ups and also reduces memory usage quite a bit.
+
+Installation
+~~~~~~~~~~~~
+
+On Ubuntu, install the libtcmalloc-minimal0 package:
+
+::
+
+  apt-get install libtcmalloc-minimal0
+
+On Fedora, install the gperftools-libs package:
+
+::
+
+  yum install gperftools-libs
+
+Usage
+~~~~~
+
+Use the tcmalloc by preloading it:
+
+Ubuntu:
+
+::
+
+  LD_PRELOAD=”/usr/lib/libtcmalloc_minimal.so.0" suricata -c suricata.yaml -i eth0
+
+Fedora:
+
+::
+
+  LD_PRELOAD="/usr/lib64/libtcmalloc_minimal.so.4" suricata -c suricata.yaml -i eth0