s390: add 'install' target to 'make help'
[linux/fpc-iii.git] / net / sched / Kconfig
blobdaa33432b7166e1c9af818835441be1b102d8d73
2 # Traffic control configuration.
3
5 menuconfig NET_SCHED
6         bool "QoS and/or fair queueing"
7         select NET_SCH_FIFO
8         ---help---
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
38           /proc/net/psched.
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.
43 if NET_SCHED
45 comment "Queueing/Scheduling"
47 config NET_SCH_CBQ
48         tristate "Class Based Queueing (CBQ)"
49         ---help---
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.
64 config NET_SCH_HTB
65         tristate "Hierarchical Token Bucket (HTB)"
66         ---help---
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
70           in-depth articles.
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.
78 config NET_SCH_HFSC
79         tristate "Hierarchical Fair Service Curve (HFSC)"
80         ---help---
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.
87 config NET_SCH_ATM
88         tristate "ATM Virtual Circuits (ATM)"
89         depends on ATM
90         ---help---
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.
101 config NET_SCH_PRIO
102         tristate "Multi Band Priority Queueing (PRIO)"
103         ---help---
104           Say Y here if you want to use an n-band priority queue packet
105           scheduler.
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)"
112         ---help---
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.
119 config NET_SCH_RED
120         tristate "Random Early Detection (RED)"
121         ---help---
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.
130 config NET_SCH_SFB
131         tristate "Stochastic Fair Blue (SFB)"
132         ---help---
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.
141 config NET_SCH_SFQ
142         tristate "Stochastic Fairness Queueing (SFQ)"
143         ---help---
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.
152 config NET_SCH_TEQL
153         tristate "True Link Equalizer (TEQL)"
154         ---help---
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.
164 config NET_SCH_TBF
165         tristate "Token Bucket Filter (TBF)"
166         ---help---
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.
175 config NET_SCH_GRED
176         tristate "Generic Random Early Detection (GRED)"
177         ---help---
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)"
188         ---help---
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.
197 config NET_SCH_NETEM
198         tristate "Network emulator (NETEM)"
199         ---help---
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.
207           If unsure, say N.
209 config NET_SCH_DRR
210         tristate "Deficit Round Robin scheduler (DRR)"
211         help
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.
218           If unsure, say N.
220 config NET_SCH_MQPRIO
221         tristate "Multi-queue priority scheduler (MQPRIO)"
222         help
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.
230           If unsure, say N.
232 config NET_SCH_CHOKE
233         tristate "CHOose and Keep responsive flow scheduler (CHOKE)"
234         help
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.
243 config NET_SCH_QFQ
244         tristate "Quick Fair Queueing scheduler (QFQ)"
245         help
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.
252           If unsure, say N.
254 config NET_SCH_CODEL
255         tristate "Controlled Delay AQM (CODEL)"
256         help
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.
263           If unsure, say N.
265 config NET_SCH_FQ_CODEL
266         tristate "Fair Queue Controlled Delay AQM (FQ_CODEL)"
267         help
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.
274           If unsure, say N.
276 config NET_SCH_FQ
277         tristate "Fair Queue"
278         help
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
283           traffic)
285           To compile this driver as a module, choose M here: the module
286           will be called sch_fq.
288           If unsure, say N.
290 config NET_SCH_HHF
291         tristate "Heavy-Hitter Filter (HHF)"
292         help
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.
299 config NET_SCH_PIE
300         tristate "Proportional Integral controller Enhanced (PIE) scheduler"
301         help
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.
310           If unsure, say N.
312 config NET_SCH_INGRESS
313         tristate "Ingress Qdisc"
314         depends on NET_CLS_ACT
315         select NET_INGRESS
316         ---help---
317           Say Y here if you want to use classifiers for incoming packets.
318           If unsure, say Y.
320           To compile this code as a module, choose M here: the
321           module will be called sch_ingress.
323 config NET_SCH_PLUG
324         tristate "Plug network traffic until release (PLUG)"
325         ---help---
327           This queuing discipline allows userspace to plug/unplug a network
328           output queue, using the netlink interface.  When it receives an
329           enqueue command it inserts a plug into the outbound queue that
330           causes following packets to enqueue until a dequeue command arrives
331           over netlink, causing the plug to be removed and resuming the normal
332           packet flow.
334           This module also provides a generic "network output buffering"
335           functionality (aka output commit), wherein upon arrival of a dequeue
336           command, only packets up to the first plug are released for delivery.
337           The Remus HA project uses this module to enable speculative execution
338           of virtual machines by allowing the generated network output to be rolled
339           back if needed.
341           For more information, please refer to <http://wiki.xenproject.org/wiki/Remus>
343           Say Y here if you are using this kernel for Xen dom0 and
344           want to protect Xen guests with Remus.
346           To compile this code as a module, choose M here: the
347           module will be called sch_plug.
349 comment "Classification"
351 config NET_CLS
352         bool
354 config NET_CLS_BASIC
355         tristate "Elementary classification (BASIC)"
356         select NET_CLS
357         ---help---
358           Say Y here if you want to be able to classify packets using
359           only extended matches and actions.
361           To compile this code as a module, choose M here: the
362           module will be called cls_basic.
364 config NET_CLS_TCINDEX
365         tristate "Traffic-Control Index (TCINDEX)"
366         select NET_CLS
367         ---help---
368           Say Y here if you want to be able to classify packets based on
369           traffic control indices. You will want this feature if you want
370           to implement Differentiated Services together with DSMARK.
372           To compile this code as a module, choose M here: the
373           module will be called cls_tcindex.
375 config NET_CLS_ROUTE4
376         tristate "Routing decision (ROUTE)"
377         depends on INET
378         select IP_ROUTE_CLASSID
379         select NET_CLS
380         ---help---
381           If you say Y here, you will be able to classify packets
382           according to the route table entry they matched.
384           To compile this code as a module, choose M here: the
385           module will be called cls_route.
387 config NET_CLS_FW
388         tristate "Netfilter mark (FW)"
389         select NET_CLS
390         ---help---
391           If you say Y here, you will be able to classify packets
392           according to netfilter/firewall marks.
394           To compile this code as a module, choose M here: the
395           module will be called cls_fw.
397 config NET_CLS_U32
398         tristate "Universal 32bit comparisons w/ hashing (U32)"
399         select NET_CLS
400         ---help---
401           Say Y here to be able to classify packets using a universal
402           32bit pieces based comparison scheme.
404           To compile this code as a module, choose M here: the
405           module will be called cls_u32.
407 config CLS_U32_PERF
408         bool "Performance counters support"
409         depends on NET_CLS_U32
410         ---help---
411           Say Y here to make u32 gather additional statistics useful for
412           fine tuning u32 classifiers.
414 config CLS_U32_MARK
415         bool "Netfilter marks support"
416         depends on NET_CLS_U32
417         ---help---
418           Say Y here to be able to use netfilter marks as u32 key.
420 config NET_CLS_RSVP
421         tristate "IPv4 Resource Reservation Protocol (RSVP)"
422         select NET_CLS
423         ---help---
424           The Resource Reservation Protocol (RSVP) permits end systems to
425           request a minimum and maximum data flow rate for a connection; this
426           is important for real time data such as streaming sound or video.
428           Say Y here if you want to be able to classify outgoing packets based
429           on their RSVP requests.
431           To compile this code as a module, choose M here: the
432           module will be called cls_rsvp.
434 config NET_CLS_RSVP6
435         tristate "IPv6 Resource Reservation Protocol (RSVP6)"
436         select NET_CLS
437         ---help---
438           The Resource Reservation Protocol (RSVP) permits end systems to
439           request a minimum and maximum data flow rate for a connection; this
440           is important for real time data such as streaming sound or video.
442           Say Y here if you want to be able to classify outgoing packets based
443           on their RSVP requests and you are using the IPv6 protocol.
445           To compile this code as a module, choose M here: the
446           module will be called cls_rsvp6.
448 config NET_CLS_FLOW
449         tristate "Flow classifier"
450         select NET_CLS
451         ---help---
452           If you say Y here, you will be able to classify packets based on
453           a configurable combination of packet keys. This is mostly useful
454           in combination with SFQ.
456           To compile this code as a module, choose M here: the
457           module will be called cls_flow.
459 config NET_CLS_CGROUP
460         tristate "Control Group Classifier"
461         select NET_CLS
462         select CGROUP_NET_CLASSID
463         depends on CGROUPS
464         ---help---
465           Say Y here if you want to classify packets based on the control
466           cgroup of their process.
468           To compile this code as a module, choose M here: the
469           module will be called cls_cgroup.
471 config NET_CLS_BPF
472         tristate "BPF-based classifier"
473         select NET_CLS
474         ---help---
475           If you say Y here, you will be able to classify packets based on
476           programmable BPF (JIT'ed) filters as an alternative to ematches.
478           To compile this code as a module, choose M here: the module will
479           be called cls_bpf.
481 config NET_CLS_FLOWER
482         tristate "Flower classifier"
483         select NET_CLS
484         ---help---
485           If you say Y here, you will be able to classify packets based on
486           a configurable combination of packet keys and masks.
488           To compile this code as a module, choose M here: the module will
489           be called cls_flower.
491 config NET_EMATCH
492         bool "Extended Matches"
493         select NET_CLS
494         ---help---
495           Say Y here if you want to use extended matches on top of classifiers
496           and select the extended matches below.
498           Extended matches are small classification helpers not worth writing
499           a separate classifier for.
501           A recent version of the iproute2 package is required to use
502           extended matches.
504 config NET_EMATCH_STACK
505         int "Stack size"
506         depends on NET_EMATCH
507         default "32"
508         ---help---
509           Size of the local stack variable used while evaluating the tree of
510           ematches. Limits the depth of the tree, i.e. the number of
511           encapsulated precedences. Every level requires 4 bytes of additional
512           stack space.
514 config NET_EMATCH_CMP
515         tristate "Simple packet data comparison"
516         depends on NET_EMATCH
517         ---help---
518           Say Y here if you want to be able to classify packets based on
519           simple packet data comparisons for 8, 16, and 32bit values.
521           To compile this code as a module, choose M here: the
522           module will be called em_cmp.
524 config NET_EMATCH_NBYTE
525         tristate "Multi byte comparison"
526         depends on NET_EMATCH
527         ---help---
528           Say Y here if you want to be able to classify packets based on
529           multiple byte comparisons mainly useful for IPv6 address comparisons.
531           To compile this code as a module, choose M here: the
532           module will be called em_nbyte.
534 config NET_EMATCH_U32
535         tristate "U32 key"
536         depends on NET_EMATCH
537         ---help---
538           Say Y here if you want to be able to classify packets using
539           the famous u32 key in combination with logic relations.
541           To compile this code as a module, choose M here: the
542           module will be called em_u32.
544 config NET_EMATCH_META
545         tristate "Metadata"
546         depends on NET_EMATCH
547         ---help---
548           Say Y here if you want to be able to classify packets based on
549           metadata such as load average, netfilter attributes, socket
550           attributes and routing decisions.
552           To compile this code as a module, choose M here: the
553           module will be called em_meta.
555 config NET_EMATCH_TEXT
556         tristate "Textsearch"
557         depends on NET_EMATCH
558         select TEXTSEARCH
559         select TEXTSEARCH_KMP
560         select TEXTSEARCH_BM
561         select TEXTSEARCH_FSM
562         ---help---
563           Say Y here if you want to be able to classify packets based on
564           textsearch comparisons.
566           To compile this code as a module, choose M here: the
567           module will be called em_text.
569 config NET_EMATCH_CANID
570         tristate "CAN Identifier"
571         depends on NET_EMATCH && (CAN=y || CAN=m)
572         ---help---
573           Say Y here if you want to be able to classify CAN frames based
574           on CAN Identifier.
576           To compile this code as a module, choose M here: the
577           module will be called em_canid.
579 config NET_EMATCH_IPSET
580         tristate "IPset"
581         depends on NET_EMATCH && IP_SET
582         ---help---
583           Say Y here if you want to be able to classify packets based on
584           ipset membership.
586           To compile this code as a module, choose M here: the
587           module will be called em_ipset.
589 config NET_CLS_ACT
590         bool "Actions"
591         ---help---
592           Say Y here if you want to use traffic control actions. Actions
593           get attached to classifiers and are invoked after a successful
594           classification. They are used to overwrite the classification
595           result, instantly drop or redirect packets, etc.
597           A recent version of the iproute2 package is required to use
598           extended matches.
600 config NET_ACT_POLICE
601         tristate "Traffic Policing"
602         depends on NET_CLS_ACT 
603         ---help---
604           Say Y here if you want to do traffic policing, i.e. strict
605           bandwidth limiting. This action replaces the existing policing
606           module.
608           To compile this code as a module, choose M here: the
609           module will be called act_police.
611 config NET_ACT_GACT
612         tristate "Generic actions"
613         depends on NET_CLS_ACT
614         ---help---
615           Say Y here to take generic actions such as dropping and
616           accepting packets.
618           To compile this code as a module, choose M here: the
619           module will be called act_gact.
621 config GACT_PROB
622         bool "Probability support"
623         depends on NET_ACT_GACT
624         ---help---
625           Say Y here to use the generic action randomly or deterministically.
627 config NET_ACT_MIRRED
628         tristate "Redirecting and Mirroring"
629         depends on NET_CLS_ACT
630         ---help---
631           Say Y here to allow packets to be mirrored or redirected to
632           other devices.
634           To compile this code as a module, choose M here: the
635           module will be called act_mirred.
637 config NET_ACT_IPT
638         tristate "IPtables targets"
639         depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
640         ---help---
641           Say Y here to be able to invoke iptables targets after successful
642           classification.
644           To compile this code as a module, choose M here: the
645           module will be called act_ipt.
647 config NET_ACT_NAT
648         tristate "Stateless NAT"
649         depends on NET_CLS_ACT
650         ---help---
651           Say Y here to do stateless NAT on IPv4 packets.  You should use
652           netfilter for NAT unless you know what you are doing.
654           To compile this code as a module, choose M here: the
655           module will be called act_nat.
657 config NET_ACT_PEDIT
658         tristate "Packet Editing"
659         depends on NET_CLS_ACT
660         ---help---
661           Say Y here if you want to mangle the content of packets.
663           To compile this code as a module, choose M here: the
664           module will be called act_pedit.
666 config NET_ACT_SIMP
667         tristate "Simple Example (Debug)"
668         depends on NET_CLS_ACT
669         ---help---
670           Say Y here to add a simple action for demonstration purposes.
671           It is meant as an example and for debugging purposes. It will
672           print a configured policy string followed by the packet count
673           to the console for every packet that passes by.
675           If unsure, say N.
677           To compile this code as a module, choose M here: the
678           module will be called act_simple.
680 config NET_ACT_SKBEDIT
681         tristate "SKB Editing"
682         depends on NET_CLS_ACT
683         ---help---
684           Say Y here to change skb priority or queue_mapping settings.
686           If unsure, say N.
688           To compile this code as a module, choose M here: the
689           module will be called act_skbedit.
691 config NET_ACT_CSUM
692         tristate "Checksum Updating"
693         depends on NET_CLS_ACT && INET
694         ---help---
695           Say Y here to update some common checksum after some direct
696           packet alterations.
698           To compile this code as a module, choose M here: the
699           module will be called act_csum.
701 config NET_ACT_VLAN
702         tristate "Vlan manipulation"
703         depends on NET_CLS_ACT
704         ---help---
705           Say Y here to push or pop vlan headers.
707           If unsure, say N.
709           To compile this code as a module, choose M here: the
710           module will be called act_vlan.
712 config NET_ACT_BPF
713         tristate "BPF based action"
714         depends on NET_CLS_ACT
715         ---help---
716           Say Y here to execute BPF code on packets. The BPF code will decide
717           if the packet should be dropped or not.
719           If unsure, say N.
721           To compile this code as a module, choose M here: the
722           module will be called act_bpf.
724 config NET_ACT_CONNMARK
725         tristate "Netfilter Connection Mark Retriever"
726         depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
727         depends on NF_CONNTRACK && NF_CONNTRACK_MARK
728         ---help---
729           Say Y here to allow retrieving of conn mark
731           If unsure, say N.
733           To compile this code as a module, choose M here: the
734           module will be called act_connmark.
736 config NET_CLS_IND
737         bool "Incoming device classification"
738         depends on NET_CLS_U32 || NET_CLS_FW
739         ---help---
740           Say Y here to extend the u32 and fw classifier to support
741           classification based on the incoming device. This option is
742           likely to disappear in favour of the metadata ematch.
744 endif # NET_SCHED
746 config NET_SCH_FIFO
747         bool