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