blob: 1bfb7b843587fb20f965bee4fb9c2454e0be96af [file] [log] [blame]
Florian Westphal54fccb12013-07-12 23:14:27 +02001This target passes the packet to userspace using the
2\fBnfnetlink_queue\fP handler. The packet is put into the queue
3identified by its 16-bit queue number. Userspace can inspect
4and modify the packet if desired. Userspace must then drop or
5reinject the packet into the kernel. Please see libnetfilter_queue
6for details.
Harald Welte7bdfca42005-07-28 15:24:02 +00007.B
8nfnetlink_queue
Florian Westphal54fccb12013-07-12 23:14:27 +02009was added in Linux 2.6.14. The \fBqueue-balance\fP option was added in Linux 2.6.31,
Florian Westphal6924b492011-01-20 11:27:42 +010010\fBqueue-bypass\fP in 2.6.39.
Florian Westphal4282d892009-08-20 16:39:05 +020011.TP
12\fB\-\-queue\-num\fP \fIvalue\fP
13This specifies the QUEUE number to use. Valid queue numbers are 0 to 65535. The default value is 0.
14.PP
15.TP
16\fB\-\-queue\-balance\fP \fIvalue\fP\fB:\fP\fIvalue\fP
17This specifies a range of queues to use. Packets are then balanced across the given queues.
18This is useful for multicore systems: start multiple instances of the userspace program on
19queues x, x+1, .. x+n and use "\-\-queue\-balance \fIx\fP\fB:\fP\fIx+n\fP".
20Packets belonging to the same connection are put into the same nfqueue.
Florian Westphal6924b492011-01-20 11:27:42 +010021.PP
22.TP
23\fB\-\-queue\-bypass\fP
24By default, if no userspace program is listening on an NFQUEUE, then all packets that are to be queued
Florian Westphale816ac42013-04-13 11:52:22 +020025are dropped. When this option is used, the NFQUEUE rule behaves like ACCEPT instead, and the packet
26will move on to the next table.
holger@eitzenberger.orgce7d0612013-04-02 00:35:39 +000027.PP
28.TP
29\fB\-\-queue\-cpu-fanout\fP
30Available starting Linux kernel 3.10. When used together with
31\fB--queue-balance\fP this will use the CPU ID as an index to map packets to
32the queues. The idea is that you can improve performance if there's a queue
33per CPU. This requires \fB--queue-balance\fP to be specified.