blob: 3705081129adf5e2baf62a3cb64f62d57f230b88 [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001#
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_QFQ
243 tristate "Quick Fair Queueing scheduler (QFQ)"
244 help
245 Say Y here if you want to use the Quick Fair Queueing Scheduler (QFQ)
246 packet scheduling algorithm.
247
248 To compile this driver as a module, choose M here: the module
249 will be called sch_qfq.
250
251 If unsure, say N.
252
253config NET_SCH_INGRESS
254 tristate "Ingress Qdisc"
255 depends on NET_CLS_ACT
256 ---help---
257 Say Y here if you want to use classifiers for incoming packets.
258 If unsure, say Y.
259
260 To compile this code as a module, choose M here: the
261 module will be called sch_ingress.
262
263config NET_SCH_PLUG
264 tristate "Plug network traffic until release (PLUG)"
265 ---help---
266
267 This queuing discipline allows userspace to plug/unplug a network
268 output queue, using the netlink interface. When it receives an
269 enqueue command it inserts a plug into the outbound queue that
270 causes following packets to enqueue until a dequeue command arrives
271 over netlink, causing the plug to be removed and resuming the normal
272 packet flow.
273
274 This module also provides a generic "network output buffering"
275 functionality (aka output commit), wherein upon arrival of a dequeue
276 command, only packets up to the first plug are released for delivery.
277 The Remus HA project uses this module to enable speculative execution
278 of virtual machines by allowing the generated network output to be rolled
279 back if needed.
280
281 For more information, please refer to http://wiki.xensource.com/xenwiki/Remus
282
283 Say Y here if you are using this kernel for Xen dom0 and
284 want to protect Xen guests with Remus.
285
286 To compile this code as a module, choose M here: the
287 module will be called sch_plug.
288
289comment "Classification"
290
291config NET_CLS
292 boolean
293
294config NET_CLS_BASIC
295 tristate "Elementary classification (BASIC)"
296 select NET_CLS
297 ---help---
298 Say Y here if you want to be able to classify packets using
299 only extended matches and actions.
300
301 To compile this code as a module, choose M here: the
302 module will be called cls_basic.
303
lh9ed821d2023-04-07 01:36:19 -0700304config NET_CLS_ROUTE4
305 tristate "Routing decision (ROUTE)"
306 depends on INET
307 select IP_ROUTE_CLASSID
308 select NET_CLS
309 ---help---
310 If you say Y here, you will be able to classify packets
311 according to the route table entry they matched.
312
313 To compile this code as a module, choose M here: the
314 module will be called cls_route.
315
316config NET_CLS_FW
317 tristate "Netfilter mark (FW)"
318 select NET_CLS
319 ---help---
320 If you say Y here, you will be able to classify packets
321 according to netfilter/firewall marks.
322
323 To compile this code as a module, choose M here: the
324 module will be called cls_fw.
325
326config NET_CLS_U32
327 tristate "Universal 32bit comparisons w/ hashing (U32)"
328 select NET_CLS
329 ---help---
330 Say Y here to be able to classify packets using a universal
331 32bit pieces based comparison scheme.
332
333 To compile this code as a module, choose M here: the
334 module will be called cls_u32.
335
336config CLS_U32_PERF
337 bool "Performance counters support"
338 depends on NET_CLS_U32
339 ---help---
340 Say Y here to make u32 gather additional statistics useful for
341 fine tuning u32 classifiers.
342
343config CLS_U32_MARK
344 bool "Netfilter marks support"
345 depends on NET_CLS_U32
346 ---help---
347 Say Y here to be able to use netfilter marks as u32 key.
348
349config NET_CLS_RSVP
350 tristate "IPv4 Resource Reservation Protocol (RSVP)"
351 select NET_CLS
352 ---help---
353 The Resource Reservation Protocol (RSVP) permits end systems to
354 request a minimum and maximum data flow rate for a connection; this
355 is important for real time data such as streaming sound or video.
356
357 Say Y here if you want to be able to classify outgoing packets based
358 on their RSVP requests.
359
360 To compile this code as a module, choose M here: the
361 module will be called cls_rsvp.
362
363config NET_CLS_RSVP6
364 tristate "IPv6 Resource Reservation Protocol (RSVP6)"
365 select NET_CLS
366 ---help---
367 The Resource Reservation Protocol (RSVP) permits end systems to
368 request a minimum and maximum data flow rate for a connection; this
369 is important for real time data such as streaming sound or video.
370
371 Say Y here if you want to be able to classify outgoing packets based
372 on their RSVP requests and you are using the IPv6 protocol.
373
374 To compile this code as a module, choose M here: the
375 module will be called cls_rsvp6.
376
377config NET_CLS_FLOW
378 tristate "Flow classifier"
379 select NET_CLS
380 ---help---
381 If you say Y here, you will be able to classify packets based on
382 a configurable combination of packet keys. This is mostly useful
383 in combination with SFQ.
384
385 To compile this code as a module, choose M here: the
386 module will be called cls_flow.
387
388config NET_CLS_CGROUP
389 tristate "Control Group Classifier"
390 select NET_CLS
391 depends on CGROUPS
392 ---help---
393 Say Y here if you want to classify packets based on the control
394 cgroup of their process.
395
396 To compile this code as a module, choose M here: the
397 module will be called cls_cgroup.
398
399config NET_EMATCH
400 bool "Extended Matches"
401 select NET_CLS
402 ---help---
403 Say Y here if you want to use extended matches on top of classifiers
404 and select the extended matches below.
405
406 Extended matches are small classification helpers not worth writing
407 a separate classifier for.
408
409 A recent version of the iproute2 package is required to use
410 extended matches.
411
412config NET_EMATCH_STACK
413 int "Stack size"
414 depends on NET_EMATCH
415 default "32"
416 ---help---
417 Size of the local stack variable used while evaluating the tree of
418 ematches. Limits the depth of the tree, i.e. the number of
419 encapsulated precedences. Every level requires 4 bytes of additional
420 stack space.
421
422config NET_EMATCH_CMP
423 tristate "Simple packet data comparison"
424 depends on NET_EMATCH
425 ---help---
426 Say Y here if you want to be able to classify packets based on
427 simple packet data comparisons for 8, 16, and 32bit values.
428
429 To compile this code as a module, choose M here: the
430 module will be called em_cmp.
431
432config NET_EMATCH_NBYTE
433 tristate "Multi byte comparison"
434 depends on NET_EMATCH
435 ---help---
436 Say Y here if you want to be able to classify packets based on
437 multiple byte comparisons mainly useful for IPv6 address comparisons.
438
439 To compile this code as a module, choose M here: the
440 module will be called em_nbyte.
441
442config NET_EMATCH_U32
443 tristate "U32 key"
444 depends on NET_EMATCH
445 ---help---
446 Say Y here if you want to be able to classify packets using
447 the famous u32 key in combination with logic relations.
448
449 To compile this code as a module, choose M here: the
450 module will be called em_u32.
451
452config NET_EMATCH_META
453 tristate "Metadata"
454 depends on NET_EMATCH
455 ---help---
456 Say Y here if you want to be able to classify packets based on
457 metadata such as load average, netfilter attributes, socket
458 attributes and routing decisions.
459
460 To compile this code as a module, choose M here: the
461 module will be called em_meta.
462
463config NET_EMATCH_TEXT
464 tristate "Textsearch"
465 depends on NET_EMATCH
466 select TEXTSEARCH
467 select TEXTSEARCH_KMP
468 select TEXTSEARCH_BM
469 select TEXTSEARCH_FSM
470 ---help---
471 Say Y here if you want to be able to classify packets based on
472 textsearch comparisons.
473
474 To compile this code as a module, choose M here: the
475 module will be called em_text.
476
477config NET_CLS_ACT
478 bool "Actions"
479 ---help---
480 Say Y here if you want to use traffic control actions. Actions
481 get attached to classifiers and are invoked after a successful
482 classification. They are used to overwrite the classification
483 result, instantly drop or redirect packets, etc.
484
485 A recent version of the iproute2 package is required to use
486 extended matches.
487
488config NET_ACT_POLICE
489 tristate "Traffic Policing"
490 depends on NET_CLS_ACT
491 ---help---
492 Say Y here if you want to do traffic policing, i.e. strict
493 bandwidth limiting. This action replaces the existing policing
494 module.
495
496 To compile this code as a module, choose M here: the
497 module will be called act_police.
498
499config NET_ACT_GACT
500 tristate "Generic actions"
501 depends on NET_CLS_ACT
502 ---help---
503 Say Y here to take generic actions such as dropping and
504 accepting packets.
505
506 To compile this code as a module, choose M here: the
507 module will be called act_gact.
508
509config GACT_PROB
510 bool "Probability support"
511 depends on NET_ACT_GACT
512 ---help---
513 Say Y here to use the generic action randomly or deterministically.
514
515config NET_ACT_MIRRED
516 tristate "Redirecting and Mirroring"
517 depends on NET_CLS_ACT
518 ---help---
519 Say Y here to allow packets to be mirrored or redirected to
520 other devices.
521
522 To compile this code as a module, choose M here: the
523 module will be called act_mirred.
524
525config NET_ACT_IPT
526 tristate "IPtables targets"
527 depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
528 ---help---
529 Say Y here to be able to invoke iptables targets after successful
530 classification.
531
532 To compile this code as a module, choose M here: the
533 module will be called act_ipt.
534
535config NET_ACT_NAT
536 tristate "Stateless NAT"
537 depends on NET_CLS_ACT
538 ---help---
539 Say Y here to do stateless NAT on IPv4 packets. You should use
540 netfilter for NAT unless you know what you are doing.
541
542 To compile this code as a module, choose M here: the
543 module will be called act_nat.
544
545config NET_ACT_PEDIT
546 tristate "Packet Editing"
547 depends on NET_CLS_ACT
548 ---help---
549 Say Y here if you want to mangle the content of packets.
550
551 To compile this code as a module, choose M here: the
552 module will be called act_pedit.
553
554config NET_ACT_SIMP
555 tristate "Simple Example (Debug)"
556 depends on NET_CLS_ACT
557 ---help---
558 Say Y here to add a simple action for demonstration purposes.
559 It is meant as an example and for debugging purposes. It will
560 print a configured policy string followed by the packet count
561 to the console for every packet that passes by.
562
563 If unsure, say N.
564
565 To compile this code as a module, choose M here: the
566 module will be called act_simple.
567
568config NET_ACT_SKBEDIT
569 tristate "SKB Editing"
570 depends on NET_CLS_ACT
571 ---help---
572 Say Y here to change skb priority or queue_mapping settings.
573
574 If unsure, say N.
575
576 To compile this code as a module, choose M here: the
577 module will be called act_skbedit.
578
579config NET_ACT_CSUM
580 tristate "Checksum Updating"
581 depends on NET_CLS_ACT && INET
582 ---help---
583 Say Y here to update some common checksum after some direct
584 packet alterations.
585
586 To compile this code as a module, choose M here: the
587 module will be called act_csum.
588
589config NET_CLS_IND
590 bool "Incoming device classification"
591 depends on NET_CLS_U32 || NET_CLS_FW
592 ---help---
593 Say Y here to extend the u32 and fw classifier to support
594 classification based on the incoming device. This option is
595 likely to disappear in favour of the metadata ematch.
596
597endif # NET_SCHED
598
599config NET_SCH_FIFO
600 bool