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