From c6b9a7ad4ca9b6e96861074b7f7a6693d71164de Mon Sep 17 00:00:00 2001 From: Daniel Borkmann Date: Sun, 19 Feb 2012 14:18:07 +0100 Subject: [PATCH] docs: moved more detailed docs, misc things into Documentation folder --- CHANGELOG => Documentation/ChangeLog | 0 CODING => Documentation/CodingStyle | 0 HACKING => Documentation/Hacking | 0 Documentation/Performance | 17 +++++++++++++++++ README.curvetun => Documentation/curvetun.txt | 0 README | 20 +------------------- 6 files changed, 18 insertions(+), 19 deletions(-) rename CHANGELOG => Documentation/ChangeLog (100%) rename CODING => Documentation/CodingStyle (100%) rename HACKING => Documentation/Hacking (100%) create mode 100644 Documentation/Performance rename README.curvetun => Documentation/curvetun.txt (100%) diff --git a/CHANGELOG b/Documentation/ChangeLog similarity index 100% rename from CHANGELOG rename to Documentation/ChangeLog diff --git a/CODING b/Documentation/CodingStyle similarity index 100% rename from CODING rename to Documentation/CodingStyle diff --git a/HACKING b/Documentation/Hacking similarity index 100% rename from HACKING rename to Documentation/Hacking diff --git a/Documentation/Performance b/Documentation/Performance new file mode 100644 index 00000000..cfdca87c --- /dev/null +++ b/Documentation/Performance @@ -0,0 +1,17 @@ +By the way, some notes on zero-copy ... You might want to have NAPI drivers [1] +enabled in your kernel to reduce interrupt load and for high-speed (= relative +to the CPU speed) PCAP dumping and replay, a fast SSD isn't too bad either, +and make sure to use netsniff-ngs scatter/gather or mmap I/O options. Next to +this, (and this refers to packet generation as well), a 10-Gbit/s-Ethernet +NIC, an appropriate amount of RAM and a fast CPU is recommended. Furthermore, +you should bind the netsniff-ng tools to a specific CPU via commandline option +(i.e. --bind-cpu 0). Some further recommendations can be found in [2] [4]. Also, +Eric Dumazets BPF Just-in-Time compiler can speed up the critical path [3]. + +[1] http://www.linuxfoundation.org/collaborate/workgroups/networking/napi +[2] http://datatag.web.cern.ch/datatag/howto/tcp.html +[3] http://thread.gmane.org/gmane.linux.network/191115 + Kernel build option: + CONFIG_HAVE_BPF_JIT=y + CONFIG_BPF_JIT=y +[4] http://bit.ly/3XbBrM diff --git a/README.curvetun b/Documentation/curvetun.txt similarity index 100% rename from README.curvetun rename to Documentation/curvetun.txt diff --git a/README b/README index 0436c6a7..cb361a8f 100644 --- a/README +++ b/README @@ -52,30 +52,12 @@ described in REPORTING-BUGS. Also, have a look at our FAQ [2] for answering your questions. Furthermore, we have a development blog [3] where we sometimes drop some interesting things or news for the outside world! A public repository of the old stable releases -(which you probably do not want to have a look at), can be found here [4]. +can be found here [4]. -By the way, some notes on zero-copy ... You might want to have NAPI drivers [5] -enabled in your kernel to reduce interrupt load and for high-speed (= relative -to the CPU speed) PCAP dumping and replay, a fast SSD isn't too bad either, -and make sure to use netsniff-ngs scatter/gather or mmap I/O options. Next to -this, (and this refers to packet generation as well), a 10-Gbit/s-Ethernet -NIC, an appropriate amount of RAM and a fast CPU is recommended. Furthermore, -you should bind the netsniff-ng tools to a specific CPU via commandline option -(i.e. --bind-cpu 0). Some further recommendations can be found in [6] [8]. Also, -Eric Dumazets BPF Just-in-Time compiler can speed up the critical path [7]. - -You might want to have a look at INSTALL, HACKING, CODING and COPYING, too. Happy packet hacking! [1] http://netsniff-ng.org/ [2] http://netsniff-ng.org/faq.html [3] http://dev.netsniff-ng.org/ [4] http://pub.netsniff-ng.org/ -[5] http://www.linuxfoundation.org/collaborate/workgroups/networking/napi -[6] http://datatag.web.cern.ch/datatag/howto/tcp.html -[7] http://thread.gmane.org/gmane.linux.network/191115 - Kernel build option: - CONFIG_HAVE_BPF_JIT=y - CONFIG_BPF_JIT=y -[8] http://bit.ly/3XbBrM -- 2.11.4.GIT