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