net/sched/Kconfig

   1 #
   2 # Traffic control configuration.
   3 #
   4
   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.
  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
  42 if NET_SCHED
  43
  44 comment "Queueing/Scheduling"
  45
  46 config 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
  63 config 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
  77 config 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
  86 config 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
 100 config 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
 109 config 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
 118 config 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
 129 config 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
 140 config 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
 151 config 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
 163 config 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
 174 config 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
 185 config 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
 196 config 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
 208 config 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
 219 config 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
 231 config 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
 242 config 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
 253 config 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
 263 comment "Classification"
 264
 265 config NET_CLS
 266         boolean
 267
 268 config NET_CLS_BASIC
 269         tristate "Elementary classification (BASIC)"
 270         select NET_CLS
 271         ---help---
 272           Say Y here if you want to be able to classify packets using
 273           only extended matches and actions.
 274
 275           To compile this code as a module, choose M here: the
 276           module will be called cls_basic.
 277
 278 config NET_CLS_TCINDEX
 279         tristate "Traffic-Control Index (TCINDEX)"
 280         select NET_CLS
 281         ---help---
 282           Say Y here if you want to be able to classify packets based on
 283           traffic control indices. You will want this feature if you want
 284           to implement Differentiated Services together with DSMARK.
 285
 286           To compile this code as a module, choose M here: the
 287           module will be called cls_tcindex.
 288
 289 config NET_CLS_ROUTE4
 290         tristate "Routing decision (ROUTE)"
 291         depends on INET
 292         select IP_ROUTE_CLASSID
 293         select NET_CLS
 294         ---help---
 295           If you say Y here, you will be able to classify packets
 296           according to the route table entry they matched.
 297
 298           To compile this code as a module, choose M here: the
 299           module will be called cls_route.
 300
 301 config NET_CLS_FW
 302         tristate "Netfilter mark (FW)"
 303         select NET_CLS
 304         ---help---
 305           If you say Y here, you will be able to classify packets
 306           according to netfilter/firewall marks.
 307
 308           To compile this code as a module, choose M here: the
 309           module will be called cls_fw.
 310
 311 config NET_CLS_U32
 312         tristate "Universal 32bit comparisons w/ hashing (U32)"
 313         select NET_CLS
 314         ---help---
 315           Say Y here to be able to classify packets using a universal
 316           32bit pieces based comparison scheme.
 317
 318           To compile this code as a module, choose M here: the
 319           module will be called cls_u32.
 320
 321 config CLS_U32_PERF
 322         bool "Performance counters support"
 323         depends on NET_CLS_U32
 324         ---help---
 325           Say Y here to make u32 gather additional statistics useful for
 326           fine tuning u32 classifiers.
 327
 328 config CLS_U32_MARK
 329         bool "Netfilter marks support"
 330         depends on NET_CLS_U32
 331         ---help---
 332           Say Y here to be able to use netfilter marks as u32 key.
 333
 334 config NET_CLS_RSVP
 335         tristate "IPv4 Resource Reservation Protocol (RSVP)"
 336         select NET_CLS
 337         ---help---
 338           The Resource Reservation Protocol (RSVP) permits end systems to
 339           request a minimum and maximum data flow rate for a connection; this
 340           is important for real time data such as streaming sound or video.
 341
 342           Say Y here if you want to be able to classify outgoing packets based
 343           on their RSVP requests.
 344
 345           To compile this code as a module, choose M here: the
 346           module will be called cls_rsvp.
 347
 348 config NET_CLS_RSVP6
 349         tristate "IPv6 Resource Reservation Protocol (RSVP6)"
 350         select NET_CLS
 351         ---help---
 352           The Resource Reservation Protocol (RSVP) permits end systems to
 353           request a minimum and maximum data flow rate for a connection; this
 354           is important for real time data such as streaming sound or video.
 355
 356           Say Y here if you want to be able to classify outgoing packets based
 357           on their RSVP requests and you are using the IPv6 protocol.
 358
 359           To compile this code as a module, choose M here: the
 360           module will be called cls_rsvp6.
 361
 362 config NET_CLS_FLOW
 363         tristate "Flow classifier"
 364         select NET_CLS
 365         ---help---
 366           If you say Y here, you will be able to classify packets based on
 367           a configurable combination of packet keys. This is mostly useful
 368           in combination with SFQ.
 369
 370           To compile this code as a module, choose M here: the
 371           module will be called cls_flow.
 372
 373 config NET_CLS_CGROUP
 374         tristate "Control Group Classifier"
 375         select NET_CLS
 376         depends on CGROUPS
 377         ---help---
 378           Say Y here if you want to classify packets based on the control
 379           cgroup of their process.
 380
 381           To compile this code as a module, choose M here: the
 382           module will be called cls_cgroup.
 383
 384 config NET_EMATCH
 385         bool "Extended Matches"
 386         select NET_CLS
 387         ---help---
 388           Say Y here if you want to use extended matches on top of classifiers
 389           and select the extended matches below.
 390
 391           Extended matches are small classification helpers not worth writing
 392           a separate classifier for.
 393
 394           A recent version of the iproute2 package is required to use
 395           extended matches.
 396
 397 config NET_EMATCH_STACK
 398         int "Stack size"
 399         depends on NET_EMATCH
 400         default "32"
 401         ---help---
 402           Size of the local stack variable used while evaluating the tree of
 403           ematches. Limits the depth of the tree, i.e. the number of
 404           encapsulated precedences. Every level requires 4 bytes of additional
 405           stack space.
 406
 407 config NET_EMATCH_CMP
 408         tristate "Simple packet data comparison"
 409         depends on NET_EMATCH
 410         ---help---
 411           Say Y here if you want to be able to classify packets based on
 412           simple packet data comparisons for 8, 16, and 32bit values.
 413
 414           To compile this code as a module, choose M here: the
 415           module will be called em_cmp.
 416
 417 config NET_EMATCH_NBYTE
 418         tristate "Multi byte comparison"
 419         depends on NET_EMATCH
 420         ---help---
 421           Say Y here if you want to be able to classify packets based on
 422           multiple byte comparisons mainly useful for IPv6 address comparisons.
 423
 424           To compile this code as a module, choose M here: the
 425           module will be called em_nbyte.
 426
 427 config NET_EMATCH_U32
 428         tristate "U32 key"
 429         depends on NET_EMATCH
 430         ---help---
 431           Say Y here if you want to be able to classify packets using
 432           the famous u32 key in combination with logic relations.
 433
 434           To compile this code as a module, choose M here: the
 435           module will be called em_u32.
 436
 437 config NET_EMATCH_META
 438         tristate "Metadata"
 439         depends on NET_EMATCH
 440         ---help---
 441           Say Y here if you want to be able to classify packets based on
 442           metadata such as load average, netfilter attributes, socket
 443           attributes and routing decisions.
 444
 445           To compile this code as a module, choose M here: the
 446           module will be called em_meta.
 447
 448 config NET_EMATCH_TEXT
 449         tristate "Textsearch"
 450         depends on NET_EMATCH
 451         select TEXTSEARCH
 452         select TEXTSEARCH_KMP
 453         select TEXTSEARCH_BM
 454         select TEXTSEARCH_FSM
 455         ---help---
 456           Say Y here if you want to be able to classify packets based on
 457           textsearch comparisons.
 458
 459           To compile this code as a module, choose M here: the
 460           module will be called em_text.
 461
 462 config NET_CLS_ACT
 463         bool "Actions"
 464         ---help---
 465           Say Y here if you want to use traffic control actions. Actions
 466           get attached to classifiers and are invoked after a successful
 467           classification. They are used to overwrite the classification
 468           result, instantly drop or redirect packets, etc.
 469
 470           A recent version of the iproute2 package is required to use
 471           extended matches.
 472
 473 config NET_ACT_POLICE
 474         tristate "Traffic Policing"
 475         depends on NET_CLS_ACT
 476         ---help---
 477           Say Y here if you want to do traffic policing, i.e. strict
 478           bandwidth limiting. This action replaces the existing policing
 479           module.
 480
 481           To compile this code as a module, choose M here: the
 482           module will be called act_police.
 483
 484 config NET_ACT_GACT
 485         tristate "Generic actions"
 486         depends on NET_CLS_ACT
 487         ---help---
 488           Say Y here to take generic actions such as dropping and
 489           accepting packets.
 490
 491           To compile this code as a module, choose M here: the
 492           module will be called act_gact.
 493
 494 config GACT_PROB
 495         bool "Probability support"
 496         depends on NET_ACT_GACT
 497         ---help---
 498           Say Y here to use the generic action randomly or deterministically.
 499
 500 config NET_ACT_MIRRED
 501         tristate "Redirecting and Mirroring"
 502         depends on NET_CLS_ACT
 503         ---help---
 504           Say Y here to allow packets to be mirrored or redirected to
 505           other devices.
 506
 507           To compile this code as a module, choose M here: the
 508           module will be called act_mirred.
 509
 510 config NET_ACT_IPT
 511         tristate "IPtables targets"
 512         depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
 513         ---help---
 514           Say Y here to be able to invoke iptables targets after successful
 515           classification.
 516
 517           To compile this code as a module, choose M here: the
 518           module will be called act_ipt.
 519
 520 config NET_ACT_NAT
 521         tristate "Stateless NAT"
 522         depends on NET_CLS_ACT
 523         ---help---
 524           Say Y here to do stateless NAT on IPv4 packets.  You should use
 525           netfilter for NAT unless you know what you are doing.
 526
 527           To compile this code as a module, choose M here: the
 528           module will be called act_nat.
 529
 530 config NET_ACT_PEDIT
 531         tristate "Packet Editing"
 532         depends on NET_CLS_ACT
 533         ---help---
 534           Say Y here if you want to mangle the content of packets.
 535
 536           To compile this code as a module, choose M here: the
 537           module will be called act_pedit.
 538
 539 config NET_ACT_SIMP
 540         tristate "Simple Example (Debug)"
 541         depends on NET_CLS_ACT
 542         ---help---
 543           Say Y here to add a simple action for demonstration purposes.
 544           It is meant as an example and for debugging purposes. It will
 545           print a configured policy string followed by the packet count
 546           to the console for every packet that passes by.
 547
 548           If unsure, say N.
 549
 550           To compile this code as a module, choose M here: the
 551           module will be called act_simple.
 552
 553 config NET_ACT_SKBEDIT
 554         tristate "SKB Editing"
 555         depends on NET_CLS_ACT
 556         ---help---
 557           Say Y here to change skb priority or queue_mapping settings.
 558
 559           If unsure, say N.
 560
 561           To compile this code as a module, choose M here: the
 562           module will be called act_skbedit.
 563
 564 config NET_ACT_CSUM
 565         tristate "Checksum Updating"
 566         depends on NET_CLS_ACT && INET
 567         ---help---
 568           Say Y here to update some common checksum after some direct
 569           packet alterations.
 570
 571           To compile this code as a module, choose M here: the
 572           module will be called act_csum.
 573
 574 config NET_CLS_IND
 575         bool "Incoming device classification"
 576         depends on NET_CLS_U32 || NET_CLS_FW
 577         ---help---
 578           Say Y here to extend the u32 and fw classifier to support
 579           classification based on the incoming device. This option is
 580           likely to disappear in favour of the metadata ematch.
 581
 582 endif # NET_SCHED
 583
 584 config NET_SCH_FIFO
 585         bool