xref: /linux/net/sched/Kconfig (revision 0dd9ac63ce26ec87b080ca9c3e6efed33c23ace6)
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://linux-net.osdl.org/index.php/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_SFQ
130	tristate "Stochastic Fairness Queueing (SFQ)"
131	---help---
132	  Say Y here if you want to use the Stochastic Fairness Queueing (SFQ)
133	  packet scheduling algorithm.
134
135	  See the top of <file:net/sched/sch_sfq.c> for more details.
136
137	  To compile this code as a module, choose M here: the
138	  module will be called sch_sfq.
139
140config NET_SCH_TEQL
141	tristate "True Link Equalizer (TEQL)"
142	---help---
143	  Say Y here if you want to use the True Link Equalizer (TLE) packet
144	  scheduling algorithm. This queueing discipline allows the combination
145	  of several physical devices into one virtual device.
146
147	  See the top of <file:net/sched/sch_teql.c> for more details.
148
149	  To compile this code as a module, choose M here: the
150	  module will be called sch_teql.
151
152config NET_SCH_TBF
153	tristate "Token Bucket Filter (TBF)"
154	---help---
155	  Say Y here if you want to use the Token Bucket Filter (TBF) packet
156	  scheduling algorithm.
157
158	  See the top of <file:net/sched/sch_tbf.c> for more details.
159
160	  To compile this code as a module, choose M here: the
161	  module will be called sch_tbf.
162
163config NET_SCH_GRED
164	tristate "Generic Random Early Detection (GRED)"
165	---help---
166	  Say Y here if you want to use the Generic Random Early Detection
167	  (GRED) packet scheduling algorithm for some of your network devices
168	  (see the top of <file:net/sched/sch_red.c> for details and
169	  references about the algorithm).
170
171	  To compile this code as a module, choose M here: the
172	  module will be called sch_gred.
173
174config NET_SCH_DSMARK
175	tristate "Differentiated Services marker (DSMARK)"
176	---help---
177	  Say Y if you want to schedule packets according to the
178	  Differentiated Services architecture proposed in RFC 2475.
179	  Technical information on this method, with pointers to associated
180	  RFCs, is available at <http://www.gta.ufrj.br/diffserv/>.
181
182	  To compile this code as a module, choose M here: the
183	  module will be called sch_dsmark.
184
185config NET_SCH_NETEM
186	tristate "Network emulator (NETEM)"
187	---help---
188	  Say Y if you want to emulate network delay, loss, and packet
189	  re-ordering. This is often useful to simulate networks when
190	  testing applications or protocols.
191
192	  To compile this driver as a module, choose M here: the module
193	  will be called sch_netem.
194
195	  If unsure, say N.
196
197config NET_SCH_DRR
198	tristate "Deficit Round Robin scheduler (DRR)"
199	help
200	  Say Y here if you want to use the Deficit Round Robin (DRR) packet
201	  scheduling algorithm.
202
203	  To compile this driver as a module, choose M here: the module
204	  will be called sch_drr.
205
206	  If unsure, say N.
207
208config NET_SCH_INGRESS
209	tristate "Ingress Qdisc"
210	depends on NET_CLS_ACT
211	---help---
212	  Say Y here if you want to use classifiers for incoming packets.
213	  If unsure, say Y.
214
215	  To compile this code as a module, choose M here: the
216	  module will be called sch_ingress.
217
218comment "Classification"
219
220config NET_CLS
221	boolean
222
223config NET_CLS_BASIC
224	tristate "Elementary classification (BASIC)"
225	select NET_CLS
226	---help---
227	  Say Y here if you want to be able to classify packets using
228	  only extended matches and actions.
229
230	  To compile this code as a module, choose M here: the
231	  module will be called cls_basic.
232
233config NET_CLS_TCINDEX
234	tristate "Traffic-Control Index (TCINDEX)"
235	select NET_CLS
236	---help---
237	  Say Y here if you want to be able to classify packets based on
238	  traffic control indices. You will want this feature if you want
239	  to implement Differentiated Services together with DSMARK.
240
241	  To compile this code as a module, choose M here: the
242	  module will be called cls_tcindex.
243
244config NET_CLS_ROUTE4
245	tristate "Routing decision (ROUTE)"
246	select NET_CLS_ROUTE
247	select NET_CLS
248	---help---
249	  If you say Y here, you will be able to classify packets
250	  according to the route table entry they matched.
251
252	  To compile this code as a module, choose M here: the
253	  module will be called cls_route.
254
255config NET_CLS_ROUTE
256	bool
257
258config NET_CLS_FW
259	tristate "Netfilter mark (FW)"
260	select NET_CLS
261	---help---
262	  If you say Y here, you will be able to classify packets
263	  according to netfilter/firewall marks.
264
265	  To compile this code as a module, choose M here: the
266	  module will be called cls_fw.
267
268config NET_CLS_U32
269	tristate "Universal 32bit comparisons w/ hashing (U32)"
270	select NET_CLS
271	---help---
272	  Say Y here to be able to classify packets using a universal
273	  32bit pieces based comparison scheme.
274
275	  To compile this code as a module, choose M here: the
276	  module will be called cls_u32.
277
278config CLS_U32_PERF
279	bool "Performance counters support"
280	depends on NET_CLS_U32
281	---help---
282	  Say Y here to make u32 gather additional statistics useful for
283	  fine tuning u32 classifiers.
284
285config CLS_U32_MARK
286	bool "Netfilter marks support"
287	depends on NET_CLS_U32
288	---help---
289	  Say Y here to be able to use netfilter marks as u32 key.
290
291config NET_CLS_RSVP
292	tristate "IPv4 Resource Reservation Protocol (RSVP)"
293	select NET_CLS
294	---help---
295	  The Resource Reservation Protocol (RSVP) permits end systems to
296	  request a minimum and maximum data flow rate for a connection; this
297	  is important for real time data such as streaming sound or video.
298
299	  Say Y here if you want to be able to classify outgoing packets based
300	  on their RSVP requests.
301
302	  To compile this code as a module, choose M here: the
303	  module will be called cls_rsvp.
304
305config NET_CLS_RSVP6
306	tristate "IPv6 Resource Reservation Protocol (RSVP6)"
307	select NET_CLS
308	---help---
309	  The Resource Reservation Protocol (RSVP) permits end systems to
310	  request a minimum and maximum data flow rate for a connection; this
311	  is important for real time data such as streaming sound or video.
312
313	  Say Y here if you want to be able to classify outgoing packets based
314	  on their RSVP requests and you are using the IPv6 protocol.
315
316	  To compile this code as a module, choose M here: the
317	  module will be called cls_rsvp6.
318
319config NET_CLS_FLOW
320	tristate "Flow classifier"
321	select NET_CLS
322	---help---
323	  If you say Y here, you will be able to classify packets based on
324	  a configurable combination of packet keys. This is mostly useful
325	  in combination with SFQ.
326
327	  To compile this code as a module, choose M here: the
328	  module will be called cls_flow.
329
330config NET_CLS_CGROUP
331	tristate "Control Group Classifier"
332	select NET_CLS
333	depends on CGROUPS
334	---help---
335	  Say Y here if you want to classify packets based on the control
336	  cgroup of their process.
337
338	  To compile this code as a module, choose M here: the
339	  module will be called cls_cgroup.
340
341config NET_EMATCH
342	bool "Extended Matches"
343	select NET_CLS
344	---help---
345	  Say Y here if you want to use extended matches on top of classifiers
346	  and select the extended matches below.
347
348	  Extended matches are small classification helpers not worth writing
349	  a separate classifier for.
350
351	  A recent version of the iproute2 package is required to use
352	  extended matches.
353
354config NET_EMATCH_STACK
355	int "Stack size"
356	depends on NET_EMATCH
357	default "32"
358	---help---
359	  Size of the local stack variable used while evaluating the tree of
360	  ematches. Limits the depth of the tree, i.e. the number of
361	  encapsulated precedences. Every level requires 4 bytes of additional
362	  stack space.
363
364config NET_EMATCH_CMP
365	tristate "Simple packet data comparison"
366	depends on NET_EMATCH
367	---help---
368	  Say Y here if you want to be able to classify packets based on
369	  simple packet data comparisons for 8, 16, and 32bit values.
370
371	  To compile this code as a module, choose M here: the
372	  module will be called em_cmp.
373
374config NET_EMATCH_NBYTE
375	tristate "Multi byte comparison"
376	depends on NET_EMATCH
377	---help---
378	  Say Y here if you want to be able to classify packets based on
379	  multiple byte comparisons mainly useful for IPv6 address comparisons.
380
381	  To compile this code as a module, choose M here: the
382	  module will be called em_nbyte.
383
384config NET_EMATCH_U32
385	tristate "U32 key"
386	depends on NET_EMATCH
387	---help---
388	  Say Y here if you want to be able to classify packets using
389	  the famous u32 key in combination with logic relations.
390
391	  To compile this code as a module, choose M here: the
392	  module will be called em_u32.
393
394config NET_EMATCH_META
395	tristate "Metadata"
396	depends on NET_EMATCH
397	---help---
398	  Say Y here if you want to be able to classify packets based on
399	  metadata such as load average, netfilter attributes, socket
400	  attributes and routing decisions.
401
402	  To compile this code as a module, choose M here: the
403	  module will be called em_meta.
404
405config NET_EMATCH_TEXT
406	tristate "Textsearch"
407	depends on NET_EMATCH
408	select TEXTSEARCH
409	select TEXTSEARCH_KMP
410	select TEXTSEARCH_BM
411	select TEXTSEARCH_FSM
412	---help---
413	  Say Y here if you want to be able to classify packets based on
414	  textsearch comparisons.
415
416	  To compile this code as a module, choose M here: the
417	  module will be called em_text.
418
419config NET_CLS_ACT
420	bool "Actions"
421	---help---
422	  Say Y here if you want to use traffic control actions. Actions
423	  get attached to classifiers and are invoked after a successful
424	  classification. They are used to overwrite the classification
425	  result, instantly drop or redirect packets, etc.
426
427	  A recent version of the iproute2 package is required to use
428	  extended matches.
429
430config NET_ACT_POLICE
431	tristate "Traffic Policing"
432        depends on NET_CLS_ACT
433        ---help---
434	  Say Y here if you want to do traffic policing, i.e. strict
435	  bandwidth limiting. This action replaces the existing policing
436	  module.
437
438	  To compile this code as a module, choose M here: the
439	  module will be called act_police.
440
441config NET_ACT_GACT
442        tristate "Generic actions"
443        depends on NET_CLS_ACT
444        ---help---
445	  Say Y here to take generic actions such as dropping and
446	  accepting packets.
447
448	  To compile this code as a module, choose M here: the
449	  module will be called act_gact.
450
451config GACT_PROB
452        bool "Probability support"
453        depends on NET_ACT_GACT
454        ---help---
455	  Say Y here to use the generic action randomly or deterministically.
456
457config NET_ACT_MIRRED
458        tristate "Redirecting and Mirroring"
459        depends on NET_CLS_ACT
460        ---help---
461	  Say Y here to allow packets to be mirrored or redirected to
462	  other devices.
463
464	  To compile this code as a module, choose M here: the
465	  module will be called act_mirred.
466
467config NET_ACT_IPT
468        tristate "IPtables targets"
469        depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
470        ---help---
471	  Say Y here to be able to invoke iptables targets after successful
472	  classification.
473
474	  To compile this code as a module, choose M here: the
475	  module will be called act_ipt.
476
477config NET_ACT_NAT
478        tristate "Stateless NAT"
479        depends on NET_CLS_ACT
480        ---help---
481	  Say Y here to do stateless NAT on IPv4 packets.  You should use
482	  netfilter for NAT unless you know what you are doing.
483
484	  To compile this code as a module, choose M here: the
485	  module will be called act_nat.
486
487config NET_ACT_PEDIT
488        tristate "Packet Editing"
489        depends on NET_CLS_ACT
490        ---help---
491	  Say Y here if you want to mangle the content of packets.
492
493	  To compile this code as a module, choose M here: the
494	  module will be called act_pedit.
495
496config NET_ACT_SIMP
497        tristate "Simple Example (Debug)"
498        depends on NET_CLS_ACT
499        ---help---
500	  Say Y here to add a simple action for demonstration purposes.
501	  It is meant as an example and for debugging purposes. It will
502	  print a configured policy string followed by the packet count
503	  to the console for every packet that passes by.
504
505	  If unsure, say N.
506
507	  To compile this code as a module, choose M here: the
508	  module will be called act_simple.
509
510config NET_ACT_SKBEDIT
511        tristate "SKB Editing"
512        depends on NET_CLS_ACT
513        ---help---
514	  Say Y here to change skb priority or queue_mapping settings.
515
516	  If unsure, say N.
517
518	  To compile this code as a module, choose M here: the
519	  module will be called act_skbedit.
520
521config NET_CLS_IND
522	bool "Incoming device classification"
523	depends on NET_CLS_U32 || NET_CLS_FW
524	---help---
525	  Say Y here to extend the u32 and fw classifier to support
526	  classification based on the incoming device. This option is
527	  likely to disappear in favour of the metadata ematch.
528
529endif # NET_SCHED
530
531config NET_SCH_FIFO
532	bool
533