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 "Credit Based Shaper (CBS)"
178 Say Y here if you want to use the Credit Based Shaper (CBS) packet
179 scheduling algorithm.
181 See the top of <file:net/sched/sch_cbs.c> for more details.
183 To compile this code as a module, choose M here: the
184 module will be called sch_cbs.
187 tristate "Earliest TxTime First (ETF)"
189 Say Y here if you want to use the Earliest TxTime First (ETF) packet
190 scheduling algorithm.
192 See the top of <file:net/sched/sch_etf.c> for more details.
194 To compile this code as a module, choose M here: the
195 module will be called sch_etf.
198 tristate "Generic Random Early Detection (GRED)"
200 Say Y here if you want to use the Generic Random Early Detection
201 (GRED) packet scheduling algorithm for some of your network devices
202 (see the top of <file:net/sched/sch_red.c> for details and
203 references about the algorithm).
205 To compile this code as a module, choose M here: the
206 module will be called sch_gred.
208 config NET_SCH_DSMARK
209 tristate "Differentiated Services marker (DSMARK)"
211 Say Y if you want to schedule packets according to the
212 Differentiated Services architecture proposed in RFC 2475.
213 Technical information on this method, with pointers to associated
214 RFCs, is available at <http://www.gta.ufrj.br/diffserv/>.
216 To compile this code as a module, choose M here: the
217 module will be called sch_dsmark.
220 tristate "Network emulator (NETEM)"
222 Say Y if you want to emulate network delay, loss, and packet
223 re-ordering. This is often useful to simulate networks when
224 testing applications or protocols.
226 To compile this driver as a module, choose M here: the module
227 will be called sch_netem.
232 tristate "Deficit Round Robin scheduler (DRR)"
234 Say Y here if you want to use the Deficit Round Robin (DRR) packet
235 scheduling algorithm.
237 To compile this driver as a module, choose M here: the module
238 will be called sch_drr.
242 config NET_SCH_MQPRIO
243 tristate "Multi-queue priority scheduler (MQPRIO)"
245 Say Y here if you want to use the Multi-queue Priority scheduler.
246 This scheduler allows QOS to be offloaded on NICs that have support
247 for offloading QOS schedulers.
249 To compile this driver as a module, choose M here: the module will
250 be called sch_mqprio.
255 tristate "CHOose and Keep responsive flow scheduler (CHOKE)"
257 Say Y here if you want to use the CHOKe packet scheduler (CHOose
258 and Keep for responsive flows, CHOose and Kill for unresponsive
259 flows). This is a variation of RED which trys to penalize flows
260 that monopolize the queue.
262 To compile this code as a module, choose M here: the
263 module will be called sch_choke.
266 tristate "Quick Fair Queueing scheduler (QFQ)"
268 Say Y here if you want to use the Quick Fair Queueing Scheduler (QFQ)
269 packet scheduling algorithm.
271 To compile this driver as a module, choose M here: the module
272 will be called sch_qfq.
277 tristate "Controlled Delay AQM (CODEL)"
279 Say Y here if you want to use the Controlled Delay (CODEL)
280 packet scheduling algorithm.
282 To compile this driver as a module, choose M here: the module
283 will be called sch_codel.
287 config NET_SCH_FQ_CODEL
288 tristate "Fair Queue Controlled Delay AQM (FQ_CODEL)"
290 Say Y here if you want to use the FQ Controlled Delay (FQ_CODEL)
291 packet scheduling algorithm.
293 To compile this driver as a module, choose M here: the module
294 will be called sch_fq_codel.
299 tristate "Fair Queue"
301 Say Y here if you want to use the FQ packet scheduling algorithm.
303 FQ does flow separation, and is able to respect pacing requirements
304 set by TCP stack into sk->sk_pacing_rate (for localy generated
307 To compile this driver as a module, choose M here: the module
308 will be called sch_fq.
313 tristate "Heavy-Hitter Filter (HHF)"
315 Say Y here if you want to use the Heavy-Hitter Filter (HHF)
316 packet scheduling algorithm.
318 To compile this driver as a module, choose M here: the module
319 will be called sch_hhf.
322 tristate "Proportional Integral controller Enhanced (PIE) scheduler"
324 Say Y here if you want to use the Proportional Integral controller
325 Enhanced scheduler packet scheduling algorithm.
326 For more information, please see
327 http://tools.ietf.org/html/draft-pan-tsvwg-pie-00
329 To compile this driver as a module, choose M here: the module
330 will be called sch_pie.
334 config NET_SCH_INGRESS
335 tristate "Ingress/classifier-action Qdisc"
336 depends on NET_CLS_ACT
340 Say Y here if you want to use classifiers for incoming and/or outgoing
341 packets. This qdisc doesn't do anything else besides running classifiers,
342 which can also have actions attached to them. In case of outgoing packets,
343 classifiers that this qdisc holds are executed in the transmit path
344 before real enqueuing to an egress qdisc happens.
348 To compile this code as a module, choose M here: the module will be
349 called sch_ingress with alias of sch_clsact.
352 tristate "Plug network traffic until release (PLUG)"
355 This queuing discipline allows userspace to plug/unplug a network
356 output queue, using the netlink interface. When it receives an
357 enqueue command it inserts a plug into the outbound queue that
358 causes following packets to enqueue until a dequeue command arrives
359 over netlink, causing the plug to be removed and resuming the normal
362 This module also provides a generic "network output buffering"
363 functionality (aka output commit), wherein upon arrival of a dequeue
364 command, only packets up to the first plug are released for delivery.
365 The Remus HA project uses this module to enable speculative execution
366 of virtual machines by allowing the generated network output to be rolled
369 For more information, please refer to <http://wiki.xenproject.org/wiki/Remus>
371 Say Y here if you are using this kernel for Xen dom0 and
372 want to protect Xen guests with Remus.
374 To compile this code as a module, choose M here: the
375 module will be called sch_plug.
377 menuconfig NET_SCH_DEFAULT
378 bool "Allow override default queue discipline"
380 Support for selection of default queuing discipline.
382 Nearly all users can safely say no here, and the default
383 of pfifo_fast will be used. Many distributions already set
384 the default value via /proc/sys/net/core/default_qdisc.
391 prompt "Default queuing discipline"
392 default DEFAULT_PFIFO_FAST
394 Select the queueing discipline that will be used by default
395 for all network devices.
398 bool "Fair Queue" if NET_SCH_FQ
401 bool "Controlled Delay" if NET_SCH_CODEL
403 config DEFAULT_FQ_CODEL
404 bool "Fair Queue Controlled Delay" if NET_SCH_FQ_CODEL
407 bool "Stochastic Fair Queue" if NET_SCH_SFQ
409 config DEFAULT_PFIFO_FAST
410 bool "Priority FIFO Fast"
413 config DEFAULT_NET_SCH
415 default "pfifo_fast" if DEFAULT_PFIFO_FAST
416 default "fq" if DEFAULT_FQ
417 default "fq_codel" if DEFAULT_FQ_CODEL
418 default "sfq" if DEFAULT_SFQ
422 comment "Classification"
428 tristate "Elementary classification (BASIC)"
431 Say Y here if you want to be able to classify packets using
432 only extended matches and actions.
434 To compile this code as a module, choose M here: the
435 module will be called cls_basic.
437 config NET_CLS_TCINDEX
438 tristate "Traffic-Control Index (TCINDEX)"
441 Say Y here if you want to be able to classify packets based on
442 traffic control indices. You will want this feature if you want
443 to implement Differentiated Services together with DSMARK.
445 To compile this code as a module, choose M here: the
446 module will be called cls_tcindex.
448 config NET_CLS_ROUTE4
449 tristate "Routing decision (ROUTE)"
451 select IP_ROUTE_CLASSID
454 If you say Y here, you will be able to classify packets
455 according to the route table entry they matched.
457 To compile this code as a module, choose M here: the
458 module will be called cls_route.
461 tristate "Netfilter mark (FW)"
464 If you say Y here, you will be able to classify packets
465 according to netfilter/firewall marks.
467 To compile this code as a module, choose M here: the
468 module will be called cls_fw.
471 tristate "Universal 32bit comparisons w/ hashing (U32)"
474 Say Y here to be able to classify packets using a universal
475 32bit pieces based comparison scheme.
477 To compile this code as a module, choose M here: the
478 module will be called cls_u32.
481 bool "Performance counters support"
482 depends on NET_CLS_U32
484 Say Y here to make u32 gather additional statistics useful for
485 fine tuning u32 classifiers.
488 bool "Netfilter marks support"
489 depends on NET_CLS_U32
491 Say Y here to be able to use netfilter marks as u32 key.
494 tristate "IPv4 Resource Reservation Protocol (RSVP)"
497 The Resource Reservation Protocol (RSVP) permits end systems to
498 request a minimum and maximum data flow rate for a connection; this
499 is important for real time data such as streaming sound or video.
501 Say Y here if you want to be able to classify outgoing packets based
502 on their RSVP requests.
504 To compile this code as a module, choose M here: the
505 module will be called cls_rsvp.
508 tristate "IPv6 Resource Reservation Protocol (RSVP6)"
511 The Resource Reservation Protocol (RSVP) permits end systems to
512 request a minimum and maximum data flow rate for a connection; this
513 is important for real time data such as streaming sound or video.
515 Say Y here if you want to be able to classify outgoing packets based
516 on their RSVP requests and you are using the IPv6 protocol.
518 To compile this code as a module, choose M here: the
519 module will be called cls_rsvp6.
522 tristate "Flow classifier"
525 If you say Y here, you will be able to classify packets based on
526 a configurable combination of packet keys. This is mostly useful
527 in combination with SFQ.
529 To compile this code as a module, choose M here: the
530 module will be called cls_flow.
532 config NET_CLS_CGROUP
533 tristate "Control Group Classifier"
535 select CGROUP_NET_CLASSID
538 Say Y here if you want to classify packets based on the control
539 cgroup of their process.
541 To compile this code as a module, choose M here: the
542 module will be called cls_cgroup.
545 tristate "BPF-based classifier"
548 If you say Y here, you will be able to classify packets based on
549 programmable BPF (JIT'ed) filters as an alternative to ematches.
551 To compile this code as a module, choose M here: the module will
554 config NET_CLS_FLOWER
555 tristate "Flower classifier"
558 If you say Y here, you will be able to classify packets based on
559 a configurable combination of packet keys and masks.
561 To compile this code as a module, choose M here: the module will
562 be called cls_flower.
564 config NET_CLS_MATCHALL
565 tristate "Match-all classifier"
568 If you say Y here, you will be able to classify packets based on
569 nothing. Every packet will match.
571 To compile this code as a module, choose M here: the module will
572 be called cls_matchall.
575 bool "Extended Matches"
578 Say Y here if you want to use extended matches on top of classifiers
579 and select the extended matches below.
581 Extended matches are small classification helpers not worth writing
582 a separate classifier for.
584 A recent version of the iproute2 package is required to use
587 config NET_EMATCH_STACK
589 depends on NET_EMATCH
592 Size of the local stack variable used while evaluating the tree of
593 ematches. Limits the depth of the tree, i.e. the number of
594 encapsulated precedences. Every level requires 4 bytes of additional
597 config NET_EMATCH_CMP
598 tristate "Simple packet data comparison"
599 depends on NET_EMATCH
601 Say Y here if you want to be able to classify packets based on
602 simple packet data comparisons for 8, 16, and 32bit values.
604 To compile this code as a module, choose M here: the
605 module will be called em_cmp.
607 config NET_EMATCH_NBYTE
608 tristate "Multi byte comparison"
609 depends on NET_EMATCH
611 Say Y here if you want to be able to classify packets based on
612 multiple byte comparisons mainly useful for IPv6 address comparisons.
614 To compile this code as a module, choose M here: the
615 module will be called em_nbyte.
617 config NET_EMATCH_U32
619 depends on NET_EMATCH
621 Say Y here if you want to be able to classify packets using
622 the famous u32 key in combination with logic relations.
624 To compile this code as a module, choose M here: the
625 module will be called em_u32.
627 config NET_EMATCH_META
629 depends on NET_EMATCH
631 Say Y here if you want to be able to classify packets based on
632 metadata such as load average, netfilter attributes, socket
633 attributes and routing decisions.
635 To compile this code as a module, choose M here: the
636 module will be called em_meta.
638 config NET_EMATCH_TEXT
639 tristate "Textsearch"
640 depends on NET_EMATCH
642 select TEXTSEARCH_KMP
644 select TEXTSEARCH_FSM
646 Say Y here if you want to be able to classify packets based on
647 textsearch comparisons.
649 To compile this code as a module, choose M here: the
650 module will be called em_text.
652 config NET_EMATCH_CANID
653 tristate "CAN Identifier"
654 depends on NET_EMATCH && (CAN=y || CAN=m)
656 Say Y here if you want to be able to classify CAN frames based
659 To compile this code as a module, choose M here: the
660 module will be called em_canid.
662 config NET_EMATCH_IPSET
664 depends on NET_EMATCH && IP_SET
666 Say Y here if you want to be able to classify packets based on
669 To compile this code as a module, choose M here: the
670 module will be called em_ipset.
672 config NET_EMATCH_IPT
673 tristate "IPtables Matches"
674 depends on NET_EMATCH && NETFILTER && NETFILTER_XTABLES
676 Say Y here to be able to classify packets based on iptables
678 Current supported match is "policy" which allows packet classification
679 based on IPsec policy that was used during decapsulation
681 To compile this code as a module, choose M here: the
682 module will be called em_ipt.
688 Say Y here if you want to use traffic control actions. Actions
689 get attached to classifiers and are invoked after a successful
690 classification. They are used to overwrite the classification
691 result, instantly drop or redirect packets, etc.
693 A recent version of the iproute2 package is required to use
696 config NET_ACT_POLICE
697 tristate "Traffic Policing"
698 depends on NET_CLS_ACT
700 Say Y here if you want to do traffic policing, i.e. strict
701 bandwidth limiting. This action replaces the existing policing
704 To compile this code as a module, choose M here: the
705 module will be called act_police.
708 tristate "Generic actions"
709 depends on NET_CLS_ACT
711 Say Y here to take generic actions such as dropping and
714 To compile this code as a module, choose M here: the
715 module will be called act_gact.
718 bool "Probability support"
719 depends on NET_ACT_GACT
721 Say Y here to use the generic action randomly or deterministically.
723 config NET_ACT_MIRRED
724 tristate "Redirecting and Mirroring"
725 depends on NET_CLS_ACT
727 Say Y here to allow packets to be mirrored or redirected to
730 To compile this code as a module, choose M here: the
731 module will be called act_mirred.
733 config NET_ACT_SAMPLE
734 tristate "Traffic Sampling"
735 depends on NET_CLS_ACT
738 Say Y here to allow packet sampling tc action. The packet sample
739 action consists of statistically choosing packets and sampling
740 them using the psample module.
742 To compile this code as a module, choose M here: the
743 module will be called act_sample.
746 tristate "IPtables targets"
747 depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
749 Say Y here to be able to invoke iptables targets after successful
752 To compile this code as a module, choose M here: the
753 module will be called act_ipt.
756 tristate "Stateless NAT"
757 depends on NET_CLS_ACT
759 Say Y here to do stateless NAT on IPv4 packets. You should use
760 netfilter for NAT unless you know what you are doing.
762 To compile this code as a module, choose M here: the
763 module will be called act_nat.
766 tristate "Packet Editing"
767 depends on NET_CLS_ACT
769 Say Y here if you want to mangle the content of packets.
771 To compile this code as a module, choose M here: the
772 module will be called act_pedit.
775 tristate "Simple Example (Debug)"
776 depends on NET_CLS_ACT
778 Say Y here to add a simple action for demonstration purposes.
779 It is meant as an example and for debugging purposes. It will
780 print a configured policy string followed by the packet count
781 to the console for every packet that passes by.
785 To compile this code as a module, choose M here: the
786 module will be called act_simple.
788 config NET_ACT_SKBEDIT
789 tristate "SKB Editing"
790 depends on NET_CLS_ACT
792 Say Y here to change skb priority or queue_mapping settings.
796 To compile this code as a module, choose M here: the
797 module will be called act_skbedit.
800 tristate "Checksum Updating"
801 depends on NET_CLS_ACT && INET
804 Say Y here to update some common checksum after some direct
807 To compile this code as a module, choose M here: the
808 module will be called act_csum.
811 tristate "Vlan manipulation"
812 depends on NET_CLS_ACT
814 Say Y here to push or pop vlan headers.
818 To compile this code as a module, choose M here: the
819 module will be called act_vlan.
822 tristate "BPF based action"
823 depends on NET_CLS_ACT
825 Say Y here to execute BPF code on packets. The BPF code will decide
826 if the packet should be dropped or not.
830 To compile this code as a module, choose M here: the
831 module will be called act_bpf.
833 config NET_ACT_CONNMARK
834 tristate "Netfilter Connection Mark Retriever"
835 depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
836 depends on NF_CONNTRACK && NF_CONNTRACK_MARK
838 Say Y here to allow retrieving of conn mark
842 To compile this code as a module, choose M here: the
843 module will be called act_connmark.
845 config NET_ACT_SKBMOD
846 tristate "skb data modification action"
847 depends on NET_CLS_ACT
849 Say Y here to allow modification of skb data
853 To compile this code as a module, choose M here: the
854 module will be called act_skbmod.
857 tristate "Inter-FE action based on IETF ForCES InterFE LFB"
858 depends on NET_CLS_ACT
861 Say Y here to allow for sourcing and terminating metadata
862 For details refer to netdev01 paper:
863 "Distributing Linux Traffic Control Classifier-Action Subsystem"
864 Authors: Jamal Hadi Salim and Damascene M. Joachimpillai
866 To compile this code as a module, choose M here: the
867 module will be called act_ife.
869 config NET_ACT_TUNNEL_KEY
870 tristate "IP tunnel metadata manipulation"
871 depends on NET_CLS_ACT
873 Say Y here to set/release ip tunnel metadata.
877 To compile this code as a module, choose M here: the
878 module will be called act_tunnel_key.
880 config NET_IFE_SKBMARK
881 tristate "Support to encoding decoding skb mark on IFE action"
882 depends on NET_ACT_IFE
884 config NET_IFE_SKBPRIO
885 tristate "Support to encoding decoding skb prio on IFE action"
886 depends on NET_ACT_IFE
888 config NET_IFE_SKBTCINDEX
889 tristate "Support to encoding decoding skb tcindex on IFE action"
890 depends on NET_ACT_IFE
893 bool "Incoming device classification"
894 depends on NET_CLS_U32 || NET_CLS_FW
896 Say Y here to extend the u32 and fw classifier to support
897 classification based on the incoming device. This option is
898 likely to disappear in favour of the metadata ematch.