trafgen: check offsets for all kind of csums
[netsniff-ng.git] / ifpps.8
blob72b747799076836450193232a1c33d225ea89281
1 .\" netsniff-ng - the packet sniffing beast
2 .\" Copyright 2013 Daniel Borkmann.
3 .\" Subject to the GPL, version 2.
4 .PP
5 .TH IFPPS 8 "03 March 2013" "Linux" "netsniff-ng toolkit"
6 .SH NAME
7 ifpps \- top-like networking and system statistics
8 .PP
9 .SH SYNOPSIS
10 .PP
11 \fB ifpps\fR { [\fIoptions\fR] | [\fIdevice\fR] }
12 .PP
13 .SH DESCRIPTION
14 .PP
15 ifpps is a small utility which periodically provides top-like networking
16 and system statistics from the kernel. ifpps gathers its data directly
17 from procfs files and does not make use of any user space monitoring
18 libraries which would falsify statistics under high load.
19 .PP
20 For instance, consider the following scenario: two directly connected
21 Linux machines with Intel Core 2 Quad Q6600 2.40GHz CPUs, 4 GB RAM, and
22 an Intel 82566DC-2 Gigabit Ethernet NIC are used for performance evaluation.
23 One machine generates 64 byte network packets by using the kernel space
24 packet generator pktgen with a maximum possible packet rate. The other
25 machine displays statistics about incoming network packets by using i)
26 iptraf(8) and ii) ifpps.
27 .PP
28 iptraf which incorporates pcap(3) shows an average packet rate of
29 246,000 pps while on the other hand ifpps shows an average packet rate
30 of 1,378,000 pps. Hence, due to packet copies and deferring statistics
31 creation into user space, a measurement error of approximately 460 percent
32 occurs. Tools like iptraf might display much more information such as
33 TCP per flow statistics (hence the use of the pcap library). This is not
34 possible with ifpps, because overall networking statistics are its focus;
35 statistics, which are also fairly reliable under high packet load.
36 .PP
37 ifpps also periodically displays CPU load, interrupt, software interrupt
38 data per sample interval as well as total interrupts, all per CPU. In case
39 the number of CPUs exceeds 10 or the number specified by the user with the
40 \[lq]\-n\[rq] command line option, ifpps will only display this number top
41 heavy hitters. The topmost heavy hitter CPU will be marked with \[lq]+\[rq].
42 The least heavy hitter will always be displayed and is marked with
43 \[lq]-\[rq].
44 .PP
45 .SH OPTIONS
46 .PP
47 .SS -d <netdev>, --dev <netdev>
48 Networking device to fetch statistics from, for example eth0, wlan0.
49 .PP
50 .SS -t <time>, --interval <time>
51 Statistics refresh interval in milliseconds, default is 1000ms.
52 .PP
53 .SS -n, --num-cpus
54 Set maximum number of top hitter CPUs (in terms of time spent in system/user
55 mode) to display in ncurses mode, default is 10.
56 .PP
57 .SS -p, --promisc
58 Turn on promiscuous mode for the given networking device.
59 .PP
60 .SS -c, --csv
61 Output (once) the ncurses data to the terminal as gnuplot(1)-ready data.
62 .PP
63 .SS -l, --loop
64 Continuously output the terminal data after a refresh interval. This option
65 is only available, if option \[lq]\-c\[rq] is given. For \[lq]\-l\[rq] it is
66 usually recommended to redirect the output into a file that is to be be
67 processed later with gnuplot(1).
68 .PP
69 .SS -v, --version
70 Show version information.
71 .PP
72 .SS -h, --help
73 Show user help.
74 .PP
75 .SH USAGE EXAMPLE
76 .PP
77 .SS ifpps eth0
78 Default ncurses output for the eth0 device.
79 .PP
80 .SS ifpps -pd eth0
81 Ncurses output for the eth0 device in promiscuous mode.
82 .PP
83 .SS ifpps -lpcd wlan0 > plot.dat
84 Continuous terminal output for the wlan0 device in promiscuous mode.
85 .PP
86 .SH NOTE
87 On 10Gbit/s cards or higher, receive and transmit statistics are usually
88 accumulated at a higher duration interval than 1 second. Thus, it might
89 be advisable to alter the timing to a higher accumulation interval for such cards.
90 .PP
91 .SH LEGAL
92 ifpps is licensed under the GNU GPL version 2.0.
93 .PP
94 .SH HISTORY
95 .B ifpps
96 was originally written for the netsniff-ng toolkit by Daniel Borkmann. It
97 is currently maintained by Tobias Klauser <tklauser@distanz.ch> and Daniel
98 Borkmann <dborkma@tik.ee.ethz.ch>.
99 .PP
100 .SH SEE ALSO
101 .BR netsniff-ng (8),
102 .BR trafgen (8),
103 .BR mausezahn (8),
104 .BR bpfc (8),
105 .BR flowtop (8),
106 .BR astraceroute (8),
107 .BR curvetun (8)
109 .SH AUTHOR
110 Manpage was written by Daniel Borkmann.