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