2 # Traffic control configuration.
6 bool "QoS and/or fair queueing"
9 When the kernel has several packets to send out over a network
10 device, it has to decide which ones to send first, which ones to
11 delay, and which ones to drop. This is the job of the queueing
12 disciplines, several different algorithms for how to do this
13 "fairly" have been proposed.
15 If you say N here, you will get the standard packet scheduler, which
16 is a FIFO (first come, first served). If you say Y here, you will be
17 able to choose from among several alternative algorithms which can
18 then be attached to different network devices. This is useful for
19 example if some of your network devices are real time devices that
20 need a certain minimum data flow rate, or if you need to limit the
21 maximum data flow rate for traffic which matches specified criteria.
22 This code is considered to be experimental.
24 To administer these schedulers, you'll need the user-level utilities
25 from the package iproute2+tc at
26 <https://www.kernel.org/pub/linux/utils/net/iproute2/>. That package
27 also contains some documentation; for more, check out
28 <http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2>.
30 This Quality of Service (QoS) support will enable you to use
31 Differentiated Services (diffserv) and Resource Reservation Protocol
32 (RSVP) on your Linux router if you also say Y to the corresponding
33 classifiers below. Documentation and software is at
34 <http://diffserv.sourceforge.net/>.
36 If you say Y here and to "/proc file system" below, you will be able
37 to read status information about packet schedulers from the file
40 The available schedulers are listed in the following questions; you
41 can say Y to as many as you like. If unsure, say N now.
45 comment "Queueing/Scheduling"
48 tristate "Class Based Queueing (CBQ)"
50 Say Y here if you want to use the Class-Based Queueing (CBQ) packet
51 scheduling algorithm. This algorithm classifies the waiting packets
52 into a tree-like hierarchy of classes; the leaves of this tree are
53 in turn scheduled by separate algorithms.
55 See the top of <file:net/sched/sch_cbq.c> for more details.
57 CBQ is a commonly used scheduler, so if you're unsure, you should
58 say Y here. Then say Y to all the queueing algorithms below that you
59 want to use as leaf disciplines.
61 To compile this code as a module, choose M here: the
62 module will be called sch_cbq.
65 tristate "Hierarchical Token Bucket (HTB)"
67 Say Y here if you want to use the Hierarchical Token Buckets (HTB)
68 packet scheduling algorithm. See
69 <http://luxik.cdi.cz/~devik/qos/htb/> for complete manual and
72 HTB is very similar to CBQ regarding its goals however is has
73 different properties and different algorithm.
75 To compile this code as a module, choose M here: the
76 module will be called sch_htb.
79 tristate "Hierarchical Fair Service Curve (HFSC)"
81 Say Y here if you want to use the Hierarchical Fair Service Curve
82 (HFSC) packet scheduling algorithm.
84 To compile this code as a module, choose M here: the
85 module will be called sch_hfsc.
88 tristate "ATM Virtual Circuits (ATM)"
91 Say Y here if you want to use the ATM pseudo-scheduler. This
92 provides a framework for invoking classifiers, which in turn
93 select classes of this queuing discipline. Each class maps
94 the flow(s) it is handling to a given virtual circuit.
96 See the top of <file:net/sched/sch_atm.c> for more details.
98 To compile this code as a module, choose M here: the
99 module will be called sch_atm.
102 tristate "Multi Band Priority Queueing (PRIO)"
104 Say Y here if you want to use an n-band priority queue packet
107 To compile this code as a module, choose M here: the
108 module will be called sch_prio.
110 config NET_SCH_MULTIQ
111 tristate "Hardware Multiqueue-aware Multi Band Queuing (MULTIQ)"
113 Say Y here if you want to use an n-band queue packet scheduler
114 to support devices that have multiple hardware transmit queues.
116 To compile this code as a module, choose M here: the
117 module will be called sch_multiq.
120 tristate "Random Early Detection (RED)"
122 Say Y here if you want to use the Random Early Detection (RED)
123 packet scheduling algorithm.
125 See the top of <file:net/sched/sch_red.c> for more details.
127 To compile this code as a module, choose M here: the
128 module will be called sch_red.
131 tristate "Stochastic Fair Blue (SFB)"
133 Say Y here if you want to use the Stochastic Fair Blue (SFB)
134 packet scheduling algorithm.
136 See the top of <file:net/sched/sch_sfb.c> for more details.
138 To compile this code as a module, choose M here: the
139 module will be called sch_sfb.
142 tristate "Stochastic Fairness Queueing (SFQ)"
144 Say Y here if you want to use the Stochastic Fairness Queueing (SFQ)
145 packet scheduling algorithm.
147 See the top of <file:net/sched/sch_sfq.c> for more details.
149 To compile this code as a module, choose M here: the
150 module will be called sch_sfq.
153 tristate "True Link Equalizer (TEQL)"
155 Say Y here if you want to use the True Link Equalizer (TLE) packet
156 scheduling algorithm. This queueing discipline allows the combination
157 of several physical devices into one virtual device.
159 See the top of <file:net/sched/sch_teql.c> for more details.
161 To compile this code as a module, choose M here: the
162 module will be called sch_teql.
165 tristate "Token Bucket Filter (TBF)"
167 Say Y here if you want to use the Token Bucket Filter (TBF) packet
168 scheduling algorithm.
170 See the top of <file:net/sched/sch_tbf.c> for more details.
172 To compile this code as a module, choose M here: the
173 module will be called sch_tbf.
176 tristate "Generic Random Early Detection (GRED)"
178 Say Y here if you want to use the Generic Random Early Detection
179 (GRED) packet scheduling algorithm for some of your network devices
180 (see the top of <file:net/sched/sch_red.c> for details and
181 references about the algorithm).
183 To compile this code as a module, choose M here: the
184 module will be called sch_gred.
186 config NET_SCH_DSMARK
187 tristate "Differentiated Services marker (DSMARK)"
189 Say Y if you want to schedule packets according to the
190 Differentiated Services architecture proposed in RFC 2475.
191 Technical information on this method, with pointers to associated
192 RFCs, is available at <http://www.gta.ufrj.br/diffserv/>.
194 To compile this code as a module, choose M here: the
195 module will be called sch_dsmark.
198 tristate "Network emulator (NETEM)"
200 Say Y if you want to emulate network delay, loss, and packet
201 re-ordering. This is often useful to simulate networks when
202 testing applications or protocols.
204 To compile this driver as a module, choose M here: the module
205 will be called sch_netem.
210 tristate "Deficit Round Robin scheduler (DRR)"
212 Say Y here if you want to use the Deficit Round Robin (DRR) packet
213 scheduling algorithm.
215 To compile this driver as a module, choose M here: the module
216 will be called sch_drr.
220 config NET_SCH_MQPRIO
221 tristate "Multi-queue priority scheduler (MQPRIO)"
223 Say Y here if you want to use the Multi-queue Priority scheduler.
224 This scheduler allows QOS to be offloaded on NICs that have support
225 for offloading QOS schedulers.
227 To compile this driver as a module, choose M here: the module will
228 be called sch_mqprio.
233 tristate "CHOose and Keep responsive flow scheduler (CHOKE)"
235 Say Y here if you want to use the CHOKe packet scheduler (CHOose
236 and Keep for responsive flows, CHOose and Kill for unresponsive
237 flows). This is a variation of RED which trys to penalize flows
238 that monopolize the queue.
240 To compile this code as a module, choose M here: the
241 module will be called sch_choke.
244 tristate "Quick Fair Queueing scheduler (QFQ)"
246 Say Y here if you want to use the Quick Fair Queueing Scheduler (QFQ)
247 packet scheduling algorithm.
249 To compile this driver as a module, choose M here: the module
250 will be called sch_qfq.
255 tristate "Controlled Delay AQM (CODEL)"
257 Say Y here if you want to use the Controlled Delay (CODEL)
258 packet scheduling algorithm.
260 To compile this driver as a module, choose M here: the module
261 will be called sch_codel.
265 config NET_SCH_FQ_CODEL
266 tristate "Fair Queue Controlled Delay AQM (FQ_CODEL)"
268 Say Y here if you want to use the FQ Controlled Delay (FQ_CODEL)
269 packet scheduling algorithm.
271 To compile this driver as a module, choose M here: the module
272 will be called sch_fq_codel.
277 tristate "Fair Queue"
279 Say Y here if you want to use the FQ packet scheduling algorithm.
281 FQ does flow separation, and is able to respect pacing requirements
282 set by TCP stack into sk->sk_pacing_rate (for localy generated
285 To compile this driver as a module, choose M here: the module
286 will be called sch_fq.
291 tristate "Heavy-Hitter Filter (HHF)"
293 Say Y here if you want to use the Heavy-Hitter Filter (HHF)
294 packet scheduling algorithm.
296 To compile this driver as a module, choose M here: the module
297 will be called sch_hhf.
300 tristate "Proportional Integral controller Enhanced (PIE) scheduler"
302 Say Y here if you want to use the Proportional Integral controller
303 Enhanced scheduler packet scheduling algorithm.
304 For more information, please see
305 http://tools.ietf.org/html/draft-pan-tsvwg-pie-00
307 To compile this driver as a module, choose M here: the module
308 will be called sch_pie.
312 config NET_SCH_INGRESS
313 tristate "Ingress/classifier-action Qdisc"
314 depends on NET_CLS_ACT
318 Say Y here if you want to use classifiers for incoming and/or outgoing
319 packets. This qdisc doesn't do anything else besides running classifiers,
320 which can also have actions attached to them. In case of outgoing packets,
321 classifiers that this qdisc holds are executed in the transmit path
322 before real enqueuing to an egress qdisc happens.
326 To compile this code as a module, choose M here: the module will be
327 called sch_ingress with alias of sch_clsact.
330 tristate "Plug network traffic until release (PLUG)"
333 This queuing discipline allows userspace to plug/unplug a network
334 output queue, using the netlink interface. When it receives an
335 enqueue command it inserts a plug into the outbound queue that
336 causes following packets to enqueue until a dequeue command arrives
337 over netlink, causing the plug to be removed and resuming the normal
340 This module also provides a generic "network output buffering"
341 functionality (aka output commit), wherein upon arrival of a dequeue
342 command, only packets up to the first plug are released for delivery.
343 The Remus HA project uses this module to enable speculative execution
344 of virtual machines by allowing the generated network output to be rolled
347 For more information, please refer to <http://wiki.xenproject.org/wiki/Remus>
349 Say Y here if you are using this kernel for Xen dom0 and
350 want to protect Xen guests with Remus.
352 To compile this code as a module, choose M here: the
353 module will be called sch_plug.
355 comment "Classification"
361 tristate "Elementary classification (BASIC)"
364 Say Y here if you want to be able to classify packets using
365 only extended matches and actions.
367 To compile this code as a module, choose M here: the
368 module will be called cls_basic.
370 config NET_CLS_TCINDEX
371 tristate "Traffic-Control Index (TCINDEX)"
374 Say Y here if you want to be able to classify packets based on
375 traffic control indices. You will want this feature if you want
376 to implement Differentiated Services together with DSMARK.
378 To compile this code as a module, choose M here: the
379 module will be called cls_tcindex.
381 config NET_CLS_ROUTE4
382 tristate "Routing decision (ROUTE)"
384 select IP_ROUTE_CLASSID
387 If you say Y here, you will be able to classify packets
388 according to the route table entry they matched.
390 To compile this code as a module, choose M here: the
391 module will be called cls_route.
394 tristate "Netfilter mark (FW)"
397 If you say Y here, you will be able to classify packets
398 according to netfilter/firewall marks.
400 To compile this code as a module, choose M here: the
401 module will be called cls_fw.
404 tristate "Universal 32bit comparisons w/ hashing (U32)"
407 Say Y here to be able to classify packets using a universal
408 32bit pieces based comparison scheme.
410 To compile this code as a module, choose M here: the
411 module will be called cls_u32.
414 bool "Performance counters support"
415 depends on NET_CLS_U32
417 Say Y here to make u32 gather additional statistics useful for
418 fine tuning u32 classifiers.
421 bool "Netfilter marks support"
422 depends on NET_CLS_U32
424 Say Y here to be able to use netfilter marks as u32 key.
427 tristate "IPv4 Resource Reservation Protocol (RSVP)"
430 The Resource Reservation Protocol (RSVP) permits end systems to
431 request a minimum and maximum data flow rate for a connection; this
432 is important for real time data such as streaming sound or video.
434 Say Y here if you want to be able to classify outgoing packets based
435 on their RSVP requests.
437 To compile this code as a module, choose M here: the
438 module will be called cls_rsvp.
441 tristate "IPv6 Resource Reservation Protocol (RSVP6)"
444 The Resource Reservation Protocol (RSVP) permits end systems to
445 request a minimum and maximum data flow rate for a connection; this
446 is important for real time data such as streaming sound or video.
448 Say Y here if you want to be able to classify outgoing packets based
449 on their RSVP requests and you are using the IPv6 protocol.
451 To compile this code as a module, choose M here: the
452 module will be called cls_rsvp6.
455 tristate "Flow classifier"
458 If you say Y here, you will be able to classify packets based on
459 a configurable combination of packet keys. This is mostly useful
460 in combination with SFQ.
462 To compile this code as a module, choose M here: the
463 module will be called cls_flow.
465 config NET_CLS_CGROUP
466 tristate "Control Group Classifier"
468 select CGROUP_NET_CLASSID
471 Say Y here if you want to classify packets based on the control
472 cgroup of their process.
474 To compile this code as a module, choose M here: the
475 module will be called cls_cgroup.
478 tristate "BPF-based classifier"
481 If you say Y here, you will be able to classify packets based on
482 programmable BPF (JIT'ed) filters as an alternative to ematches.
484 To compile this code as a module, choose M here: the module will
487 config NET_CLS_FLOWER
488 tristate "Flower classifier"
491 If you say Y here, you will be able to classify packets based on
492 a configurable combination of packet keys and masks.
494 To compile this code as a module, choose M here: the module will
495 be called cls_flower.
497 config NET_CLS_MATCHALL
498 tristate "Match-all classifier"
501 If you say Y here, you will be able to classify packets based on
502 nothing. Every packet will match.
504 To compile this code as a module, choose M here: the module will
505 be called cls_matchall.
508 bool "Extended Matches"
511 Say Y here if you want to use extended matches on top of classifiers
512 and select the extended matches below.
514 Extended matches are small classification helpers not worth writing
515 a separate classifier for.
517 A recent version of the iproute2 package is required to use
520 config NET_EMATCH_STACK
522 depends on NET_EMATCH
525 Size of the local stack variable used while evaluating the tree of
526 ematches. Limits the depth of the tree, i.e. the number of
527 encapsulated precedences. Every level requires 4 bytes of additional
530 config NET_EMATCH_CMP
531 tristate "Simple packet data comparison"
532 depends on NET_EMATCH
534 Say Y here if you want to be able to classify packets based on
535 simple packet data comparisons for 8, 16, and 32bit values.
537 To compile this code as a module, choose M here: the
538 module will be called em_cmp.
540 config NET_EMATCH_NBYTE
541 tristate "Multi byte comparison"
542 depends on NET_EMATCH
544 Say Y here if you want to be able to classify packets based on
545 multiple byte comparisons mainly useful for IPv6 address comparisons.
547 To compile this code as a module, choose M here: the
548 module will be called em_nbyte.
550 config NET_EMATCH_U32
552 depends on NET_EMATCH
554 Say Y here if you want to be able to classify packets using
555 the famous u32 key in combination with logic relations.
557 To compile this code as a module, choose M here: the
558 module will be called em_u32.
560 config NET_EMATCH_META
562 depends on NET_EMATCH
564 Say Y here if you want to be able to classify packets based on
565 metadata such as load average, netfilter attributes, socket
566 attributes and routing decisions.
568 To compile this code as a module, choose M here: the
569 module will be called em_meta.
571 config NET_EMATCH_TEXT
572 tristate "Textsearch"
573 depends on NET_EMATCH
575 select TEXTSEARCH_KMP
577 select TEXTSEARCH_FSM
579 Say Y here if you want to be able to classify packets based on
580 textsearch comparisons.
582 To compile this code as a module, choose M here: the
583 module will be called em_text.
585 config NET_EMATCH_CANID
586 tristate "CAN Identifier"
587 depends on NET_EMATCH && (CAN=y || CAN=m)
589 Say Y here if you want to be able to classify CAN frames based
592 To compile this code as a module, choose M here: the
593 module will be called em_canid.
595 config NET_EMATCH_IPSET
597 depends on NET_EMATCH && IP_SET
599 Say Y here if you want to be able to classify packets based on
602 To compile this code as a module, choose M here: the
603 module will be called em_ipset.
608 Say Y here if you want to use traffic control actions. Actions
609 get attached to classifiers and are invoked after a successful
610 classification. They are used to overwrite the classification
611 result, instantly drop or redirect packets, etc.
613 A recent version of the iproute2 package is required to use
616 config NET_ACT_POLICE
617 tristate "Traffic Policing"
618 depends on NET_CLS_ACT
620 Say Y here if you want to do traffic policing, i.e. strict
621 bandwidth limiting. This action replaces the existing policing
624 To compile this code as a module, choose M here: the
625 module will be called act_police.
628 tristate "Generic actions"
629 depends on NET_CLS_ACT
631 Say Y here to take generic actions such as dropping and
634 To compile this code as a module, choose M here: the
635 module will be called act_gact.
638 bool "Probability support"
639 depends on NET_ACT_GACT
641 Say Y here to use the generic action randomly or deterministically.
643 config NET_ACT_MIRRED
644 tristate "Redirecting and Mirroring"
645 depends on NET_CLS_ACT
647 Say Y here to allow packets to be mirrored or redirected to
650 To compile this code as a module, choose M here: the
651 module will be called act_mirred.
654 tristate "IPtables targets"
655 depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
657 Say Y here to be able to invoke iptables targets after successful
660 To compile this code as a module, choose M here: the
661 module will be called act_ipt.
664 tristate "Stateless NAT"
665 depends on NET_CLS_ACT
667 Say Y here to do stateless NAT on IPv4 packets. You should use
668 netfilter for NAT unless you know what you are doing.
670 To compile this code as a module, choose M here: the
671 module will be called act_nat.
674 tristate "Packet Editing"
675 depends on NET_CLS_ACT
677 Say Y here if you want to mangle the content of packets.
679 To compile this code as a module, choose M here: the
680 module will be called act_pedit.
683 tristate "Simple Example (Debug)"
684 depends on NET_CLS_ACT
686 Say Y here to add a simple action for demonstration purposes.
687 It is meant as an example and for debugging purposes. It will
688 print a configured policy string followed by the packet count
689 to the console for every packet that passes by.
693 To compile this code as a module, choose M here: the
694 module will be called act_simple.
696 config NET_ACT_SKBEDIT
697 tristate "SKB Editing"
698 depends on NET_CLS_ACT
700 Say Y here to change skb priority or queue_mapping settings.
704 To compile this code as a module, choose M here: the
705 module will be called act_skbedit.
708 tristate "Checksum Updating"
709 depends on NET_CLS_ACT && INET
711 Say Y here to update some common checksum after some direct
714 To compile this code as a module, choose M here: the
715 module will be called act_csum.
718 tristate "Vlan manipulation"
719 depends on NET_CLS_ACT
721 Say Y here to push or pop vlan headers.
725 To compile this code as a module, choose M here: the
726 module will be called act_vlan.
729 tristate "BPF based action"
730 depends on NET_CLS_ACT
732 Say Y here to execute BPF code on packets. The BPF code will decide
733 if the packet should be dropped or not.
737 To compile this code as a module, choose M here: the
738 module will be called act_bpf.
740 config NET_ACT_CONNMARK
741 tristate "Netfilter Connection Mark Retriever"
742 depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
743 depends on NF_CONNTRACK && NF_CONNTRACK_MARK
745 Say Y here to allow retrieving of conn mark
749 To compile this code as a module, choose M here: the
750 module will be called act_connmark.
752 config NET_ACT_SKBMOD
753 tristate "skb data modification action"
754 depends on NET_CLS_ACT
756 Say Y here to allow modification of skb data
760 To compile this code as a module, choose M here: the
761 module will be called act_skbmod.
764 tristate "Inter-FE action based on IETF ForCES InterFE LFB"
765 depends on NET_CLS_ACT
767 Say Y here to allow for sourcing and terminating metadata
768 For details refer to netdev01 paper:
769 "Distributing Linux Traffic Control Classifier-Action Subsystem"
770 Authors: Jamal Hadi Salim and Damascene M. Joachimpillai
772 To compile this code as a module, choose M here: the
773 module will be called act_ife.
775 config NET_ACT_TUNNEL_KEY
776 tristate "IP tunnel metadata manipulation"
777 depends on NET_CLS_ACT
779 Say Y here to set/release ip tunnel metadata.
783 To compile this code as a module, choose M here: the
784 module will be called act_tunnel_key.
786 config NET_IFE_SKBMARK
787 tristate "Support to encoding decoding skb mark on IFE action"
788 depends on NET_ACT_IFE
791 config NET_IFE_SKBPRIO
792 tristate "Support to encoding decoding skb prio on IFE action"
793 depends on NET_ACT_IFE
796 config NET_IFE_SKBTCINDEX
797 tristate "Support to encoding decoding skb tcindex on IFE action"
798 depends on NET_ACT_IFE
802 bool "Incoming device classification"
803 depends on NET_CLS_U32 || NET_CLS_FW
805 Say Y here to extend the u32 and fw classifier to support
806 classification based on the incoming device. This option is
807 likely to disappear in favour of the metadata ematch.