2 * netsniff-ng - the packet sniffing beast
3 * By Daniel Borkmann <daniel@netsniff-ng.org>
4 * Copyright 2011 Daniel Borkmann <dborkma@tik.ee.ethz.ch>,
5 * Swiss federal institute of technology (ETH Zurich)
6 * Subject to the GPL, version 2.
8 * A high-performance network traffic generator that uses the zero-copy
9 * kernelspace TX_RING for network I/O. On comodity Gigabit hardware up
10 * to 1,488,095 pps 64 Byte pps have been achieved with 2 trafgen instances
11 * bound to different CPUs from the userspace and turned off pause frames,
12 * ask Ronald from NST (Network Security Toolkit) for more details. ;-)
13 * So, this line-rate result is the very same as pktgen from kernelspace!
15 * Who can now hold the fords when the King of the Nine Riders comes? And
16 * other armies will come. I am too late. All is lost. I tarried on the
17 * way. All is lost. Even if my errand is performed, no one will ever
18 * know. There will be no one I can tell. It will be in vain.
20 * -- The Lord of the Rings, Frodo thinking,
21 * Chapter 'The Stairs of Cirith Ungol'.
28 trafgen - a high-performance zero-copy network packet generator
32 trafgen [-d|--dev <netdev>][-c|--conf <file>][-J|--jumbo-support]
33 [-x|--interactive][-n|--num <uint>][-r|--rand][-t|--gap <usec>]
34 [-S|--ring-size <size>][-k|--kernel-pull <usec>][-b|--bind-cpu <cpu>]
35 [-B|--unbind-cpu <cpu>][-H|--prio-high][-Q|--notouch-irq][-v|--version]
40 A high-performance network traffic generator that uses the zero-copy TX_RING
41 for network I/O. For instance, on comodity Gigabit hardware up to 1,488,095 pps
42 64 Byte pps have been achieved with trafgen.
48 =item trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0
50 Use packet configuration trafgen.txf, eth0 as transmission device and CPU0
51 for binding the process.
61 Print help text and lists all options.
67 =item -d|--dev <netdev>
69 Device for transmission i.e., eth0.
71 =item -c|--conf <conf>
73 Path to packet configuration file.
75 =item -x|--interactive
77 Start trafgen in interactive mode.
79 =item -J|--jumbo-support
81 Support for 64KB Super Jumbo Frames
85 Number of packets to generate before exiting.
86 0 means forever until SIGINT.
90 Randomize packet selection process instead of round-robin.
94 Interpacket gap in microseconds.
96 =item -S|--ring-size <size>
98 Manually set ring size to <size>: mmap space in KB/MB/GB.
100 =item -k|--kernel-pull <uint>
102 Kernel pull from user interval in microseconds.
103 Default value is 10 microseconds.
105 =item -b|--bind-cpu <cpu>
107 Bind to specific CPU (or CPU-range).
109 =item -B|--unbind-cpu <cpu>
111 Forbid to use specific CPU (or CPU-range).
115 Make this high priority process.
117 =item -Q|--notouch-irq
119 Do not touch IRQ CPU affinity of NIC.
127 =item Generate traffic defined in trafgen.txf on eth0 using CPU 0
129 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0
131 =item Generate traffic on eth0 using CPU 0, wait 100 us between packets
133 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0 --gap 100
135 =item Generate 100,000 packet on eth0 using CPU 0
137 trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0 --num 100000
143 Written by Daniel Borkmann <daniel@netsniff-ng.org>
147 Documentation by Emmanuel Roullit <emmanuel@netsniff-ng.org>
151 Please report bugs to <bugs@netsniff-ng.org>
162 #include <sys/socket.h>
163 #include <sys/types.h>
164 #include <sys/stat.h>
165 #include <sys/time.h>
171 #include <net/ethernet.h>
176 #include "mac80211.h"
179 #include "trafgen_conf.h"
185 unsigned long tx_bytes
;
186 unsigned long tx_packets
;
190 #define CPU_UNKNOWN -1
191 #define CPU_NOTOUCH -2
199 /* 0 for automatic, > 0 for manual */
200 unsigned int reserve_size
;
208 static struct itimerval itimer
;
209 static unsigned long interval
= TX_KERNEL_PULL_INT
;
211 sig_atomic_t sigint
= 0;
213 struct packet
*packets
= NULL
;
214 unsigned int packets_len
= 0;
216 struct packet_dynamics
*packet_dyns
= NULL
;
217 unsigned int packet_dyn_len
= 0;
219 static const char *short_options
= "d:c:n:t:vJhS:HQb:B:rk:xi:o:VR";
221 static struct option long_options
[] = {
222 {"dev", required_argument
, 0, 'd'},
223 {"out", required_argument
, 0, 'o'},
224 {"in", required_argument
, 0, 'i'},
225 {"conf", required_argument
, 0, 'c'},
226 {"num", required_argument
, 0, 'n'},
227 {"gap", required_argument
, 0, 't'},
228 {"ring-size", required_argument
, 0, 'S'},
229 {"bind-cpu", required_argument
, 0, 'b'},
230 {"unbind-cpu", required_argument
, 0, 'B'},
231 {"kernel-pull", required_argument
, 0, 'k'},
232 {"jumbo-support", no_argument
, 0, 'J'},
233 {"rfraw", no_argument
, 0, 'R'},
234 {"interactive", no_argument
, 0, 'x'},
235 {"rand", no_argument
, 0, 'r'},
236 {"prio-high", no_argument
, 0, 'H'},
237 {"notouch-irq", no_argument
, 0, 'Q'},
238 {"verbose", no_argument
, 0, 'V'},
239 {"version", no_argument
, 0, 'v'},
240 {"help", no_argument
, 0, 'h'},
244 static void signal_handler(int number
)
256 static void timer_elapsed(int number
)
258 itimer
.it_interval
.tv_sec
= 0;
259 itimer
.it_interval
.tv_usec
= interval
;
260 itimer
.it_value
.tv_sec
= 0;
261 itimer
.it_value
.tv_usec
= interval
;
263 pull_and_flush_tx_ring(sock
);
264 setitimer(ITIMER_REAL
, &itimer
, NULL
);
267 static void header(void)
269 printf("%s%s%s\n", colorize_start(bold
), "trafgen "
270 VERSION_STRING
, colorize_end());
273 static void help(void)
275 printf("\ntrafgen %s, high-perf zero-copy network packet generator\n",
277 printf("http://www.netsniff-ng.org\n\n");
278 printf("Usage: trafgen [options]\n");
279 printf("Options:\n");
280 printf(" -o|-d|--out|--dev <netdev|pcap> Networking Device i.e., eth0 or pcap\n");
281 printf(" -i|-c|--in|--conf <cfg-file> Packet configuration file\n");
282 printf(" -x|--interactive Start trafgen in interactive server mode\n");
283 printf(" -J|--jumbo-support Support for 64KB Super Jumbo Frames\n");
284 printf(" Default TX slot: 2048Byte\n");
285 printf(" -R|--rfraw Inject raw 802.11 frames\n");
286 printf(" -n|--num <uint> Number of packets until exit\n");
287 printf(" `-- 0 Loop until interrupt (default)\n");
288 printf(" `- n Send n packets and done\n");
289 printf(" -r|--rand Randomize packet selection process\n");
290 printf(" Instead of a round robin selection\n");
291 printf(" -t|--gap <uint> Interpacket gap in us (approx)\n");
292 printf(" -S|--ring-size <size> Manually set ring size to <size>:\n");
293 printf(" mmap space in KB/MB/GB, e.g. \'10MB\'\n");
294 printf(" -k|--kernel-pull <uint> Kernel pull from user interval in us\n");
295 printf(" Default is 10us where the TX_RING\n");
296 printf(" is populated with payload from uspace\n");
297 printf(" -b|--bind-cpu <cpu> Bind to specific CPU (or CPU-range)\n");
298 printf(" -B|--unbind-cpu <cpu> Forbid to use specific CPU (or CPU-range)\n");
299 printf(" -H|--prio-high Make this high priority process\n");
300 printf(" -Q|--notouch-irq Do not touch IRQ CPU affinity of NIC\n");
301 printf(" -v|--version Show version\n");
302 printf(" -h|--help Guess what?!\n");
304 printf("Examples:\n");
305 printf(" See trafgen.txf for configuration file examples.\n");
306 printf(" trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0\n");
307 printf(" trafgen --dev wlan0 --rfraw --conf beacon-test.txf --bind-cpu 0\n");
308 printf(" trafgen --out eth0 --in trafgen.txf --bind-cpu 0\n");
309 printf(" trafgen --out test.pcap --in trafgen.txf --bind-cpu 0\n");
310 printf(" trafgen --dev eth0 --conf trafgen.txf --rand --gap 1000\n");
311 printf(" trafgen --dev eth0 --conf trafgen.txf --bind-cpu 0 --num 10 --rand\n");
312 printf(" trafgen --interactive\n");
313 printf(" trafgen --interactive --dev mgmt0 (only start server on mgmt0)\n");
314 printf(" trafgen --interactive --conf trafgen-cli.batch\n");
317 printf(" This tool is targeted for network developers! You should\n");
318 printf(" be aware of what you are doing and what these options above\n");
319 printf(" mean! Only use this tool in an isolated LAN that you own!\n");
321 printf("Please report bugs to <bugs@netsniff-ng.org>\n");
322 printf("Copyright (C) 2011-2012 Daniel Borkmann <dborkma@tik.ee.ethz.ch>,\n");
323 printf("Swiss federal institute of technology (ETH Zurich)\n");
324 printf("License: GNU GPL version 2\n");
325 printf("This is free software: you are free to change and redistribute it.\n");
326 printf("There is NO WARRANTY, to the extent permitted by law.\n\n");
330 static void version(void)
332 printf("\ntrafgen %s, high-perf zero-copy network packet generator\n",
334 printf("http://www.netsniff-ng.org\n\n");
335 printf("Please report bugs to <bugs@netsniff-ng.org>\n");
336 printf("Copyright (C) 2011-2012 Daniel Borkmann <dborkma@tik.ee.ethz.ch>,\n");
337 printf("Swiss federal institute of technology (ETH Zurich)\n");
338 printf("License: GNU GPL version 2\n");
339 printf("This is free software: you are free to change and redistribute it.\n");
340 printf("There is NO WARRANTY, to the extent permitted by law.\n\n");
344 static inline void apply_counter(int i
)
348 for (j
= 0; j
< packet_dyns
[i
].counter_len
; ++j
) {
350 struct counter
*counter
= &packet_dyns
[i
].counter
[j
];
355 if (counter
->type
== TYPE_INC
)
356 val
= (val
+ counter
->inc
) %
357 (counter
->max
- counter
->min
+ 1);
359 val
= (val
- counter
->inc
) %
360 (counter
->min
- counter
->max
+ 1);
365 packets
[i
].payload
[counter
->off
] = val
;
369 static inline void apply_randomizer(int i
)
373 for (j
= 0; j
< packet_dyns
[i
].randomizer_len
; ++j
) {
374 uint8_t val
= (uint8_t) mt_rand_int32();
375 struct randomizer
*randomizer
= &packet_dyns
[i
].randomizer
[j
];
377 randomizer
->val
= val
;
378 packets
[i
].payload
[randomizer
->off
] = val
;
382 static void tx_precheck(struct mode
*mode
)
387 panic("Panic over invalid args for TX trigger!\n");
388 if (packets_len
== 0 || packets_len
!= packet_dyn_len
)
389 panic("Panic over invalid args for TX trigger!\n");
390 if (!device_up_and_running(mode
->device
))
391 panic("Device not up and running!\n");
393 mtu
= device_mtu(mode
->device
);
395 for (i
= 0; i
< packets_len
; ++i
) {
396 if (packets
[i
].len
> mtu
+ 14)
397 panic("Device MTU < than your packet size!\n");
398 if (packets
[i
].len
<= 14)
399 panic("Device packet size too short!\n");
403 static void tx_slowpath_or_die(struct mode
*mode
)
407 struct sockaddr_ll s_addr
;
408 unsigned long num
= 1;
415 mode
->device_trans
= xstrdup(mode
->device
);
418 enter_rfmon_mac80211(mode
->device_trans
, &mode
->device
);
421 ifindex
= device_ifindex(mode
->device
);
426 printf("Note: randomizes output makes trafgen slower!\n");
428 printf("MD: TX slowpath %s %luus", mode
->rand
? "RND" : "RR", mode
->gap
);
430 printf(" 802.11 raw via %s", mode
->device
);
432 printf("Running! Hang up with ^C!\n\n");
434 fmemset(&s_addr
, 0, sizeof(s_addr
));
435 s_addr
.sll_family
= PF_PACKET
;
436 s_addr
.sll_halen
= ETH_ALEN
;
437 s_addr
.sll_ifindex
= ifindex
;
441 while (likely(sigint
== 0) && likely(num
> 0)) {
445 ret
= sendto(sock
, packets
[i
].payload
, packets
[i
].len
, 0,
446 (struct sockaddr
*) &s_addr
, sizeof(s_addr
));
448 whine("sendto error!\n");
450 mode
->stats
.tx_bytes
+= packets
[i
].len
;
451 mode
->stats
.tx_packets
++;
454 i
= mt_rand_int32() % packets_len
;
457 atomic_cmp_swp(&i
, packets_len
, 0);
467 leave_rfmon_mac80211(mode
->device_trans
, mode
->device
);
473 printf("\r%12lu frames outgoing\n", mode
->stats
.tx_packets
);
474 printf("\r%12lu bytes outgoing\n", mode
->stats
.tx_bytes
);
477 static void tx_fastpath_or_die(struct mode
*mode
)
480 unsigned int i
, size
, it
= 0;
481 unsigned long num
= 1;
484 struct frame_map
*hdr
;
490 fmemset(&tx_ring
, 0, sizeof(tx_ring
));
493 mode
->device_trans
= xstrdup(mode
->device
);
496 enter_rfmon_mac80211(mode
->device_trans
, &mode
->device
);
499 ifindex
= device_ifindex(mode
->device
);
500 size
= ring_size(mode
->device
, mode
->reserve_size
);
502 set_packet_loss_discard(sock
);
503 setup_tx_ring_layout(sock
, &tx_ring
, size
, mode
->jumbo_support
);
504 create_tx_ring(sock
, &tx_ring
);
505 mmap_tx_ring(sock
, &tx_ring
);
506 alloc_tx_ring_frames(&tx_ring
);
507 bind_tx_ring(sock
, &tx_ring
, ifindex
);
509 if (mode
->cpu
>= 0 && ifindex
> 0) {
510 irq
= device_irq_number(mode
->device
);
511 device_bind_irq_to_cpu(mode
->cpu
, irq
);
512 printf("IRQ: %s:%d > CPU%d\n", mode
->device
, irq
,
517 interval
= mode
->kpull
;
521 printf("Note: randomizes output makes trafgen slower!\n");
523 printf("MD: TX fastpath %s %luus", mode
->rand
? "RND" : "RR", interval
);
525 printf(" 802.11 raw via %s", mode
->device
);
527 printf("Running! Hang up with ^C!\n\n");
529 itimer
.it_interval
.tv_sec
= 0;
530 itimer
.it_interval
.tv_usec
= interval
;
531 itimer
.it_value
.tv_sec
= 0;
532 itimer
.it_value
.tv_usec
= interval
;
533 setitimer(ITIMER_REAL
, &itimer
, NULL
);
537 while (likely(sigint
== 0) && likely(num
> 0)) {
538 while (user_may_pull_from_tx(tx_ring
.frames
[it
].iov_base
) &&
540 hdr
= tx_ring
.frames
[it
].iov_base
;
542 /* Kernel assumes: data = ph.raw + po->tp_hdrlen -
543 * sizeof(struct sockaddr_ll); */
544 out
= ((uint8_t *) hdr
) + TPACKET_HDRLEN
-
545 sizeof(struct sockaddr_ll
);
547 hdr
->tp_h
.tp_snaplen
= packets
[i
].len
;
548 hdr
->tp_h
.tp_len
= packets
[i
].len
;
553 fmemcpy(out
, packets
[i
].payload
, packets
[i
].len
);
555 mode
->stats
.tx_bytes
+= packets
[i
].len
;
556 mode
->stats
.tx_packets
++;
559 i
= mt_rand_int32() % packets_len
;
562 atomic_cmp_swp(&i
, packets_len
, 0);
565 kernel_may_pull_from_tx(&hdr
->tp_h
);
566 next_slot_prewr(&it
, &tx_ring
);
570 if (unlikely(sigint
== 1))
575 destroy_tx_ring(sock
, &tx_ring
);
578 leave_rfmon_mac80211(mode
->device_trans
, mode
->device
);
584 printf("\r%12lu frames outgoing\n", mode
->stats
.tx_packets
);
585 printf("\r%12lu bytes outgoing\n", mode
->stats
.tx_bytes
);
588 static void main_loop(struct mode
*mode
, char *confname
)
590 compile_packets(confname
, mode
->verbose
);
593 tx_slowpath_or_die(mode
);
595 tx_fastpath_or_die(mode
);
600 int main(int argc
, char **argv
)
602 int c
, opt_index
, i
, j
, interactive
= 0;
603 char *confname
= NULL
, *ptr
;
604 bool prio_high
= false;
607 check_for_root_maybe_die();
609 fmemset(&mode
, 0, sizeof(mode
));
610 mode
.cpu
= CPU_UNKNOWN
;
614 while ((c
= getopt_long(argc
, argv
, short_options
, long_options
,
615 &opt_index
)) != EOF
) {
628 mode
.device
= xstrndup(optarg
, IFNAMSIZ
);
640 mode
.jumbo_support
= 1;
644 confname
= xstrdup(optarg
);
647 mode
.kpull
= atol(optarg
);
650 mode
.num
= atol(optarg
);
653 mode
.gap
= atol(optarg
);
657 mode
.reserve_size
= 0;
659 for (j
= i
= strlen(optarg
); i
> 0; --i
) {
660 if (!isdigit(optarg
[j
- i
]))
665 if (!strncmp(ptr
, "KB", strlen("KB")))
666 mode
.reserve_size
= 1 << 10;
667 else if (!strncmp(ptr
, "MB", strlen("MB")))
668 mode
.reserve_size
= 1 << 20;
669 else if (!strncmp(ptr
, "GB", strlen("GB")))
670 mode
.reserve_size
= 1 << 30;
672 panic("Syntax error in ring size param!\n");
675 mode
.reserve_size
*= atoi(optarg
);
678 set_cpu_affinity(optarg
, 0);
679 /* Take the first CPU for rebinding the IRQ */
680 if (mode
.cpu
!= CPU_NOTOUCH
)
681 mode
.cpu
= atoi(optarg
);
684 set_cpu_affinity(optarg
, 1);
690 mode
.cpu
= CPU_NOTOUCH
;
704 panic("Option -%c requires an argument!\n",
708 whine("Unknown option character "
709 "`0x%X\'!\n", optopt
);
717 if (!interactive
&& argc
< 5)
719 if (interactive
&& argc
< 2)
721 if (!interactive
&& mode
.device
== NULL
)
722 panic("No networking device given!\n");
723 if (!interactive
&& confname
== NULL
)
724 panic("No configuration file given!\n");
725 if (!interactive
&& device_mtu(mode
.device
) == 0)
726 panic("This is no networking device!\n");
727 if (!interactive
&& device_up_and_running(mode
.device
) == 0)
728 panic("Networking device not running!\n");
730 register_signal(SIGINT
, signal_handler
);
731 register_signal(SIGHUP
, signal_handler
);
732 register_signal_f(SIGALRM
, timer_elapsed
, SA_SIGINFO
);
736 if (prio_high
== true) {
737 set_proc_prio(get_default_proc_prio());
738 set_sched_status(get_default_sched_policy(),
739 get_default_sched_prio());
743 main_loop_interactive(&mode
, confname
);
745 main_loop(&mode
, confname
);
749 if (mode
.device_trans
)
750 xfree(mode
.device_trans
);