xref: /openbmc/linux/net/sched/Kconfig (revision 565d76cb)
1#
2# Traffic control configuration.
3#
4
5menuconfig 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.
14
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.
23
24	  To administer these schedulers, you'll need the user-level utilities
25	  from the package iproute2+tc at <ftp://ftp.tux.org/pub/net/ip-routing/>.
26	  That package also contains some documentation; for more, check out
27	  <http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2>.
28
29	  This Quality of Service (QoS) support will enable you to use
30	  Differentiated Services (diffserv) and Resource Reservation Protocol
31	  (RSVP) on your Linux router if you also say Y to the corresponding
32	  classifiers below.  Documentation and software is at
33	  <http://diffserv.sourceforge.net/>.
34
35	  If you say Y here and to "/proc file system" below, you will be able
36	  to read status information about packet schedulers from the file
37	  /proc/net/psched.
38
39	  The available schedulers are listed in the following questions; you
40	  can say Y to as many as you like. If unsure, say N now.
41
42if NET_SCHED
43
44comment "Queueing/Scheduling"
45
46config NET_SCH_CBQ
47	tristate "Class Based Queueing (CBQ)"
48	---help---
49	  Say Y here if you want to use the Class-Based Queueing (CBQ) packet
50	  scheduling algorithm. This algorithm classifies the waiting packets
51	  into a tree-like hierarchy of classes; the leaves of this tree are
52	  in turn scheduled by separate algorithms.
53
54	  See the top of <file:net/sched/sch_cbq.c> for more details.
55
56	  CBQ is a commonly used scheduler, so if you're unsure, you should
57	  say Y here. Then say Y to all the queueing algorithms below that you
58	  want to use as leaf disciplines.
59
60	  To compile this code as a module, choose M here: the
61	  module will be called sch_cbq.
62
63config NET_SCH_HTB
64	tristate "Hierarchical Token Bucket (HTB)"
65	---help---
66	  Say Y here if you want to use the Hierarchical Token Buckets (HTB)
67	  packet scheduling algorithm. See
68	  <http://luxik.cdi.cz/~devik/qos/htb/> for complete manual and
69	  in-depth articles.
70
71	  HTB is very similar to CBQ regarding its goals however is has
72	  different properties and different algorithm.
73
74	  To compile this code as a module, choose M here: the
75	  module will be called sch_htb.
76
77config NET_SCH_HFSC
78	tristate "Hierarchical Fair Service Curve (HFSC)"
79	---help---
80	  Say Y here if you want to use the Hierarchical Fair Service Curve
81	  (HFSC) packet scheduling algorithm.
82
83	  To compile this code as a module, choose M here: the
84	  module will be called sch_hfsc.
85
86config NET_SCH_ATM
87	tristate "ATM Virtual Circuits (ATM)"
88	depends on ATM
89	---help---
90	  Say Y here if you want to use the ATM pseudo-scheduler.  This
91	  provides a framework for invoking classifiers, which in turn
92	  select classes of this queuing discipline.  Each class maps
93	  the flow(s) it is handling to a given virtual circuit.
94
95	  See the top of <file:net/sched/sch_atm.c> for more details.
96
97	  To compile this code as a module, choose M here: the
98	  module will be called sch_atm.
99
100config NET_SCH_PRIO
101	tristate "Multi Band Priority Queueing (PRIO)"
102	---help---
103	  Say Y here if you want to use an n-band priority queue packet
104	  scheduler.
105
106	  To compile this code as a module, choose M here: the
107	  module will be called sch_prio.
108
109config NET_SCH_MULTIQ
110	tristate "Hardware Multiqueue-aware Multi Band Queuing (MULTIQ)"
111	---help---
112	  Say Y here if you want to use an n-band queue packet scheduler
113	  to support devices that have multiple hardware transmit queues.
114
115	  To compile this code as a module, choose M here: the
116	  module will be called sch_multiq.
117
118config NET_SCH_RED
119	tristate "Random Early Detection (RED)"
120	---help---
121	  Say Y here if you want to use the Random Early Detection (RED)
122	  packet scheduling algorithm.
123
124	  See the top of <file:net/sched/sch_red.c> for more details.
125
126	  To compile this code as a module, choose M here: the
127	  module will be called sch_red.
128
129config NET_SCH_SFB
130	tristate "Stochastic Fair Blue (SFB)"
131	---help---
132	  Say Y here if you want to use the Stochastic Fair Blue (SFB)
133	  packet scheduling algorithm.
134
135	  See the top of <file:net/sched/sch_sfb.c> for more details.
136
137	  To compile this code as a module, choose M here: the
138	  module will be called sch_sfb.
139
140config NET_SCH_SFQ
141	tristate "Stochastic Fairness Queueing (SFQ)"
142	---help---
143	  Say Y here if you want to use the Stochastic Fairness Queueing (SFQ)
144	  packet scheduling algorithm.
145
146	  See the top of <file:net/sched/sch_sfq.c> for more details.
147
148	  To compile this code as a module, choose M here: the
149	  module will be called sch_sfq.
150
151config NET_SCH_TEQL
152	tristate "True Link Equalizer (TEQL)"
153	---help---
154	  Say Y here if you want to use the True Link Equalizer (TLE) packet
155	  scheduling algorithm. This queueing discipline allows the combination
156	  of several physical devices into one virtual device.
157
158	  See the top of <file:net/sched/sch_teql.c> for more details.
159
160	  To compile this code as a module, choose M here: the
161	  module will be called sch_teql.
162
163config NET_SCH_TBF
164	tristate "Token Bucket Filter (TBF)"
165	---help---
166	  Say Y here if you want to use the Token Bucket Filter (TBF) packet
167	  scheduling algorithm.
168
169	  See the top of <file:net/sched/sch_tbf.c> for more details.
170
171	  To compile this code as a module, choose M here: the
172	  module will be called sch_tbf.
173
174config NET_SCH_GRED
175	tristate "Generic Random Early Detection (GRED)"
176	---help---
177	  Say Y here if you want to use the Generic Random Early Detection
178	  (GRED) packet scheduling algorithm for some of your network devices
179	  (see the top of <file:net/sched/sch_red.c> for details and
180	  references about the algorithm).
181
182	  To compile this code as a module, choose M here: the
183	  module will be called sch_gred.
184
185config NET_SCH_DSMARK
186	tristate "Differentiated Services marker (DSMARK)"
187	---help---
188	  Say Y if you want to schedule packets according to the
189	  Differentiated Services architecture proposed in RFC 2475.
190	  Technical information on this method, with pointers to associated
191	  RFCs, is available at <http://www.gta.ufrj.br/diffserv/>.
192
193	  To compile this code as a module, choose M here: the
194	  module will be called sch_dsmark.
195
196config NET_SCH_NETEM
197	tristate "Network emulator (NETEM)"
198	---help---
199	  Say Y if you want to emulate network delay, loss, and packet
200	  re-ordering. This is often useful to simulate networks when
201	  testing applications or protocols.
202
203	  To compile this driver as a module, choose M here: the module
204	  will be called sch_netem.
205
206	  If unsure, say N.
207
208config NET_SCH_DRR
209	tristate "Deficit Round Robin scheduler (DRR)"
210	help
211	  Say Y here if you want to use the Deficit Round Robin (DRR) packet
212	  scheduling algorithm.
213
214	  To compile this driver as a module, choose M here: the module
215	  will be called sch_drr.
216
217	  If unsure, say N.
218
219config NET_SCH_MQPRIO
220	tristate "Multi-queue priority scheduler (MQPRIO)"
221	help
222	  Say Y here if you want to use the Multi-queue Priority scheduler.
223	  This scheduler allows QOS to be offloaded on NICs that have support
224	  for offloading QOS schedulers.
225
226	  To compile this driver as a module, choose M here: the module will
227	  be called sch_mqprio.
228
229	  If unsure, say N.
230
231config NET_SCH_CHOKE
232	tristate "CHOose and Keep responsive flow scheduler (CHOKE)"
233	help
234	  Say Y here if you want to use the CHOKe packet scheduler (CHOose
235	  and Keep for responsive flows, CHOose and Kill for unresponsive
236	  flows). This is a variation of RED which trys to penalize flows
237	  that monopolize the queue.
238
239	  To compile this code as a module, choose M here: the
240	  module will be called sch_choke.
241
242config NET_SCH_INGRESS
243	tristate "Ingress Qdisc"
244	depends on NET_CLS_ACT
245	---help---
246	  Say Y here if you want to use classifiers for incoming packets.
247	  If unsure, say Y.
248
249	  To compile this code as a module, choose M here: the
250	  module will be called sch_ingress.
251
252comment "Classification"
253
254config NET_CLS
255	boolean
256
257config NET_CLS_BASIC
258	tristate "Elementary classification (BASIC)"
259	select NET_CLS
260	---help---
261	  Say Y here if you want to be able to classify packets using
262	  only extended matches and actions.
263
264	  To compile this code as a module, choose M here: the
265	  module will be called cls_basic.
266
267config NET_CLS_TCINDEX
268	tristate "Traffic-Control Index (TCINDEX)"
269	select NET_CLS
270	---help---
271	  Say Y here if you want to be able to classify packets based on
272	  traffic control indices. You will want this feature if you want
273	  to implement Differentiated Services together with DSMARK.
274
275	  To compile this code as a module, choose M here: the
276	  module will be called cls_tcindex.
277
278config NET_CLS_ROUTE4
279	tristate "Routing decision (ROUTE)"
280	select IP_ROUTE_CLASSID
281	select NET_CLS
282	---help---
283	  If you say Y here, you will be able to classify packets
284	  according to the route table entry they matched.
285
286	  To compile this code as a module, choose M here: the
287	  module will be called cls_route.
288
289config NET_CLS_FW
290	tristate "Netfilter mark (FW)"
291	select NET_CLS
292	---help---
293	  If you say Y here, you will be able to classify packets
294	  according to netfilter/firewall marks.
295
296	  To compile this code as a module, choose M here: the
297	  module will be called cls_fw.
298
299config NET_CLS_U32
300	tristate "Universal 32bit comparisons w/ hashing (U32)"
301	select NET_CLS
302	---help---
303	  Say Y here to be able to classify packets using a universal
304	  32bit pieces based comparison scheme.
305
306	  To compile this code as a module, choose M here: the
307	  module will be called cls_u32.
308
309config CLS_U32_PERF
310	bool "Performance counters support"
311	depends on NET_CLS_U32
312	---help---
313	  Say Y here to make u32 gather additional statistics useful for
314	  fine tuning u32 classifiers.
315
316config CLS_U32_MARK
317	bool "Netfilter marks support"
318	depends on NET_CLS_U32
319	---help---
320	  Say Y here to be able to use netfilter marks as u32 key.
321
322config NET_CLS_RSVP
323	tristate "IPv4 Resource Reservation Protocol (RSVP)"
324	select NET_CLS
325	---help---
326	  The Resource Reservation Protocol (RSVP) permits end systems to
327	  request a minimum and maximum data flow rate for a connection; this
328	  is important for real time data such as streaming sound or video.
329
330	  Say Y here if you want to be able to classify outgoing packets based
331	  on their RSVP requests.
332
333	  To compile this code as a module, choose M here: the
334	  module will be called cls_rsvp.
335
336config NET_CLS_RSVP6
337	tristate "IPv6 Resource Reservation Protocol (RSVP6)"
338	select NET_CLS
339	---help---
340	  The Resource Reservation Protocol (RSVP) permits end systems to
341	  request a minimum and maximum data flow rate for a connection; this
342	  is important for real time data such as streaming sound or video.
343
344	  Say Y here if you want to be able to classify outgoing packets based
345	  on their RSVP requests and you are using the IPv6 protocol.
346
347	  To compile this code as a module, choose M here: the
348	  module will be called cls_rsvp6.
349
350config NET_CLS_FLOW
351	tristate "Flow classifier"
352	select NET_CLS
353	---help---
354	  If you say Y here, you will be able to classify packets based on
355	  a configurable combination of packet keys. This is mostly useful
356	  in combination with SFQ.
357
358	  To compile this code as a module, choose M here: the
359	  module will be called cls_flow.
360
361config NET_CLS_CGROUP
362	tristate "Control Group Classifier"
363	select NET_CLS
364	depends on CGROUPS
365	---help---
366	  Say Y here if you want to classify packets based on the control
367	  cgroup of their process.
368
369	  To compile this code as a module, choose M here: the
370	  module will be called cls_cgroup.
371
372config NET_EMATCH
373	bool "Extended Matches"
374	select NET_CLS
375	---help---
376	  Say Y here if you want to use extended matches on top of classifiers
377	  and select the extended matches below.
378
379	  Extended matches are small classification helpers not worth writing
380	  a separate classifier for.
381
382	  A recent version of the iproute2 package is required to use
383	  extended matches.
384
385config NET_EMATCH_STACK
386	int "Stack size"
387	depends on NET_EMATCH
388	default "32"
389	---help---
390	  Size of the local stack variable used while evaluating the tree of
391	  ematches. Limits the depth of the tree, i.e. the number of
392	  encapsulated precedences. Every level requires 4 bytes of additional
393	  stack space.
394
395config NET_EMATCH_CMP
396	tristate "Simple packet data comparison"
397	depends on NET_EMATCH
398	---help---
399	  Say Y here if you want to be able to classify packets based on
400	  simple packet data comparisons for 8, 16, and 32bit values.
401
402	  To compile this code as a module, choose M here: the
403	  module will be called em_cmp.
404
405config NET_EMATCH_NBYTE
406	tristate "Multi byte comparison"
407	depends on NET_EMATCH
408	---help---
409	  Say Y here if you want to be able to classify packets based on
410	  multiple byte comparisons mainly useful for IPv6 address comparisons.
411
412	  To compile this code as a module, choose M here: the
413	  module will be called em_nbyte.
414
415config NET_EMATCH_U32
416	tristate "U32 key"
417	depends on NET_EMATCH
418	---help---
419	  Say Y here if you want to be able to classify packets using
420	  the famous u32 key in combination with logic relations.
421
422	  To compile this code as a module, choose M here: the
423	  module will be called em_u32.
424
425config NET_EMATCH_META
426	tristate "Metadata"
427	depends on NET_EMATCH
428	---help---
429	  Say Y here if you want to be able to classify packets based on
430	  metadata such as load average, netfilter attributes, socket
431	  attributes and routing decisions.
432
433	  To compile this code as a module, choose M here: the
434	  module will be called em_meta.
435
436config NET_EMATCH_TEXT
437	tristate "Textsearch"
438	depends on NET_EMATCH
439	select TEXTSEARCH
440	select TEXTSEARCH_KMP
441	select TEXTSEARCH_BM
442	select TEXTSEARCH_FSM
443	---help---
444	  Say Y here if you want to be able to classify packets based on
445	  textsearch comparisons.
446
447	  To compile this code as a module, choose M here: the
448	  module will be called em_text.
449
450config NET_CLS_ACT
451	bool "Actions"
452	---help---
453	  Say Y here if you want to use traffic control actions. Actions
454	  get attached to classifiers and are invoked after a successful
455	  classification. They are used to overwrite the classification
456	  result, instantly drop or redirect packets, etc.
457
458	  A recent version of the iproute2 package is required to use
459	  extended matches.
460
461config NET_ACT_POLICE
462	tristate "Traffic Policing"
463        depends on NET_CLS_ACT
464        ---help---
465	  Say Y here if you want to do traffic policing, i.e. strict
466	  bandwidth limiting. This action replaces the existing policing
467	  module.
468
469	  To compile this code as a module, choose M here: the
470	  module will be called act_police.
471
472config NET_ACT_GACT
473        tristate "Generic actions"
474        depends on NET_CLS_ACT
475        ---help---
476	  Say Y here to take generic actions such as dropping and
477	  accepting packets.
478
479	  To compile this code as a module, choose M here: the
480	  module will be called act_gact.
481
482config GACT_PROB
483        bool "Probability support"
484        depends on NET_ACT_GACT
485        ---help---
486	  Say Y here to use the generic action randomly or deterministically.
487
488config NET_ACT_MIRRED
489        tristate "Redirecting and Mirroring"
490        depends on NET_CLS_ACT
491        ---help---
492	  Say Y here to allow packets to be mirrored or redirected to
493	  other devices.
494
495	  To compile this code as a module, choose M here: the
496	  module will be called act_mirred.
497
498config NET_ACT_IPT
499        tristate "IPtables targets"
500        depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
501        ---help---
502	  Say Y here to be able to invoke iptables targets after successful
503	  classification.
504
505	  To compile this code as a module, choose M here: the
506	  module will be called act_ipt.
507
508config NET_ACT_NAT
509        tristate "Stateless NAT"
510        depends on NET_CLS_ACT
511        ---help---
512	  Say Y here to do stateless NAT on IPv4 packets.  You should use
513	  netfilter for NAT unless you know what you are doing.
514
515	  To compile this code as a module, choose M here: the
516	  module will be called act_nat.
517
518config NET_ACT_PEDIT
519        tristate "Packet Editing"
520        depends on NET_CLS_ACT
521        ---help---
522	  Say Y here if you want to mangle the content of packets.
523
524	  To compile this code as a module, choose M here: the
525	  module will be called act_pedit.
526
527config NET_ACT_SIMP
528        tristate "Simple Example (Debug)"
529        depends on NET_CLS_ACT
530        ---help---
531	  Say Y here to add a simple action for demonstration purposes.
532	  It is meant as an example and for debugging purposes. It will
533	  print a configured policy string followed by the packet count
534	  to the console for every packet that passes by.
535
536	  If unsure, say N.
537
538	  To compile this code as a module, choose M here: the
539	  module will be called act_simple.
540
541config NET_ACT_SKBEDIT
542        tristate "SKB Editing"
543        depends on NET_CLS_ACT
544        ---help---
545	  Say Y here to change skb priority or queue_mapping settings.
546
547	  If unsure, say N.
548
549	  To compile this code as a module, choose M here: the
550	  module will be called act_skbedit.
551
552config NET_ACT_CSUM
553        tristate "Checksum Updating"
554        depends on NET_CLS_ACT && INET
555        ---help---
556	  Say Y here to update some common checksum after some direct
557	  packet alterations.
558
559	  To compile this code as a module, choose M here: the
560	  module will be called act_csum.
561
562config NET_CLS_IND
563	bool "Incoming device classification"
564	depends on NET_CLS_U32 || NET_CLS_FW
565	---help---
566	  Say Y here to extend the u32 and fw classifier to support
567	  classification based on the incoming device. This option is
568	  likely to disappear in favour of the metadata ematch.
569
570endif # NET_SCHED
571
572config NET_SCH_FIFO
573	bool
574