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_SFQ
 130         tristate "Stochastic Fairness Queueing (SFQ)"
 131         ---help---
 132           Say Y here if you want to use the Stochastic Fairness Queueing (SFQ)
 133           packet scheduling algorithm.
 134
 135           See the top of <file:net/sched/sch_sfq.c> for more details.
 136
 137           To compile this code as a module, choose M here: the
 138           module will be called sch_sfq.
 139
 140 config NET_SCH_TEQL
 141         tristate "True Link Equalizer (TEQL)"
 142         ---help---
 143           Say Y here if you want to use the True Link Equalizer (TLE) packet
 144           scheduling algorithm. This queueing discipline allows the combination
 145           of several physical devices into one virtual device.
 146
 147           See the top of <file:net/sched/sch_teql.c> for more details.
 148
 149           To compile this code as a module, choose M here: the
 150           module will be called sch_teql.
 151
 152 config NET_SCH_TBF
 153         tristate "Token Bucket Filter (TBF)"
 154         ---help---
 155           Say Y here if you want to use the Token Bucket Filter (TBF) packet
 156           scheduling algorithm.
 157
 158           See the top of <file:net/sched/sch_tbf.c> for more details.
 159
 160           To compile this code as a module, choose M here: the
 161           module will be called sch_tbf.
 162
 163 config NET_SCH_GRED
 164         tristate "Generic Random Early Detection (GRED)"
 165         ---help---
 166           Say Y here if you want to use the Generic Random Early Detection
 167           (GRED) packet scheduling algorithm for some of your network devices
 168           (see the top of <file:net/sched/sch_red.c> for details and
 169           references about the algorithm).
 170
 171           To compile this code as a module, choose M here: the
 172           module will be called sch_gred.
 173
 174 config NET_SCH_DSMARK
 175         tristate "Differentiated Services marker (DSMARK)"
 176         ---help---
 177           Say Y if you want to schedule packets according to the
 178           Differentiated Services architecture proposed in RFC 2475.
 179           Technical information on this method, with pointers to associated
 180           RFCs, is available at <http://www.gta.ufrj.br/diffserv/>.
 181
 182           To compile this code as a module, choose M here: the
 183           module will be called sch_dsmark.
 184
 185 config NET_SCH_NETEM
 186         tristate "Network emulator (NETEM)"
 187         ---help---
 188           Say Y if you want to emulate network delay, loss, and packet
 189           re-ordering. This is often useful to simulate networks when
 190           testing applications or protocols.
 191
 192           To compile this driver as a module, choose M here: the module
 193           will be called sch_netem.
 194
 195           If unsure, say N.
 196
 197 config NET_SCH_DRR
 198         tristate "Deficit Round Robin scheduler (DRR)"
 199         help
 200           Say Y here if you want to use the Deficit Round Robin (DRR) packet
 201           scheduling algorithm.
 202
 203           To compile this driver as a module, choose M here: the module
 204           will be called sch_drr.
 205
 206           If unsure, say N.
 207
 208 config NET_SCH_MQPRIO
 209         tristate "Multi-queue priority scheduler (MQPRIO)"
 210         help
 211           Say Y here if you want to use the Multi-queue Priority scheduler.
 212           This scheduler allows QOS to be offloaded on NICs that have support
 213           for offloading QOS schedulers.
 214
 215           To compile this driver as a module, choose M here: the module will
 216           be called sch_mqprio.
 217
 218           If unsure, say N.
 219
 220 config NET_SCH_CHOKE
 221         tristate "CHOose and Keep responsive flow scheduler (CHOKE)"
 222         help
 223           Say Y here if you want to use the CHOKe packet scheduler (CHOose
 224           and Keep for responsive flows, CHOose and Kill for unresponsive
 225           flows). This is a variation of RED which trys to penalize flows
 226           that monopolize the queue.
 227
 228           To compile this code as a module, choose M here: the
 229           module will be called sch_choke.
 230
 231 config NET_SCH_INGRESS
 232         tristate "Ingress Qdisc"
 233         depends on NET_CLS_ACT
 234         ---help---
 235           Say Y here if you want to use classifiers for incoming packets.
 236           If unsure, say Y.
 237
 238           To compile this code as a module, choose M here: the
 239           module will be called sch_ingress.
 240
 241 comment "Classification"
 242
 243 config NET_CLS
 244         boolean
 245
 246 config NET_CLS_BASIC
 247         tristate "Elementary classification (BASIC)"
 248         select NET_CLS
 249         ---help---
 250           Say Y here if you want to be able to classify packets using
 251           only extended matches and actions.
 252
 253           To compile this code as a module, choose M here: the
 254           module will be called cls_basic.
 255
 256 config NET_CLS_TCINDEX
 257         tristate "Traffic-Control Index (TCINDEX)"
 258         select NET_CLS
 259         ---help---
 260           Say Y here if you want to be able to classify packets based on
 261           traffic control indices. You will want this feature if you want
 262           to implement Differentiated Services together with DSMARK.
 263
 264           To compile this code as a module, choose M here: the
 265           module will be called cls_tcindex.
 266
 267 config NET_CLS_ROUTE4
 268         tristate "Routing decision (ROUTE)"
 269         select IP_ROUTE_CLASSID
 270         select NET_CLS
 271         ---help---
 272           If you say Y here, you will be able to classify packets
 273           according to the route table entry they matched.
 274
 275           To compile this code as a module, choose M here: the
 276           module will be called cls_route.
 277
 278 config NET_CLS_FW
 279         tristate "Netfilter mark (FW)"
 280         select NET_CLS
 281         ---help---
 282           If you say Y here, you will be able to classify packets
 283           according to netfilter/firewall marks.
 284
 285           To compile this code as a module, choose M here: the
 286           module will be called cls_fw.
 287
 288 config NET_CLS_U32
 289         tristate "Universal 32bit comparisons w/ hashing (U32)"
 290         select NET_CLS
 291         ---help---
 292           Say Y here to be able to classify packets using a universal
 293           32bit pieces based comparison scheme.
 294
 295           To compile this code as a module, choose M here: the
 296           module will be called cls_u32.
 297
 298 config CLS_U32_PERF
 299         bool "Performance counters support"
 300         depends on NET_CLS_U32
 301         ---help---
 302           Say Y here to make u32 gather additional statistics useful for
 303           fine tuning u32 classifiers.
 304
 305 config CLS_U32_MARK
 306         bool "Netfilter marks support"
 307         depends on NET_CLS_U32
 308         ---help---
 309           Say Y here to be able to use netfilter marks as u32 key.
 310
 311 config NET_CLS_RSVP
 312         tristate "IPv4 Resource Reservation Protocol (RSVP)"
 313         select NET_CLS
 314         ---help---
 315           The Resource Reservation Protocol (RSVP) permits end systems to
 316           request a minimum and maximum data flow rate for a connection; this
 317           is important for real time data such as streaming sound or video.
 318
 319           Say Y here if you want to be able to classify outgoing packets based
 320           on their RSVP requests.
 321
 322           To compile this code as a module, choose M here: the
 323           module will be called cls_rsvp.
 324
 325 config NET_CLS_RSVP6
 326         tristate "IPv6 Resource Reservation Protocol (RSVP6)"
 327         select NET_CLS
 328         ---help---
 329           The Resource Reservation Protocol (RSVP) permits end systems to
 330           request a minimum and maximum data flow rate for a connection; this
 331           is important for real time data such as streaming sound or video.
 332
 333           Say Y here if you want to be able to classify outgoing packets based
 334           on their RSVP requests and you are using the IPv6 protocol.
 335
 336           To compile this code as a module, choose M here: the
 337           module will be called cls_rsvp6.
 338
 339 config NET_CLS_FLOW
 340         tristate "Flow classifier"
 341         select NET_CLS
 342         ---help---
 343           If you say Y here, you will be able to classify packets based on
 344           a configurable combination of packet keys. This is mostly useful
 345           in combination with SFQ.
 346
 347           To compile this code as a module, choose M here: the
 348           module will be called cls_flow.
 349
 350 config NET_CLS_CGROUP
 351         tristate "Control Group Classifier"
 352         select NET_CLS
 353         depends on CGROUPS
 354         ---help---
 355           Say Y here if you want to classify packets based on the control
 356           cgroup of their process.
 357
 358           To compile this code as a module, choose M here: the
 359           module will be called cls_cgroup.
 360
 361 config NET_EMATCH
 362         bool "Extended Matches"
 363         select NET_CLS
 364         ---help---
 365           Say Y here if you want to use extended matches on top of classifiers
 366           and select the extended matches below.
 367
 368           Extended matches are small classification helpers not worth writing
 369           a separate classifier for.
 370
 371           A recent version of the iproute2 package is required to use
 372           extended matches.
 373
 374 config NET_EMATCH_STACK
 375         int "Stack size"
 376         depends on NET_EMATCH
 377         default "32"
 378         ---help---
 379           Size of the local stack variable used while evaluating the tree of
 380           ematches. Limits the depth of the tree, i.e. the number of
 381           encapsulated precedences. Every level requires 4 bytes of additional
 382           stack space.
 383
 384 config NET_EMATCH_CMP
 385         tristate "Simple packet data comparison"
 386         depends on NET_EMATCH
 387         ---help---
 388           Say Y here if you want to be able to classify packets based on
 389           simple packet data comparisons for 8, 16, and 32bit values.
 390
 391           To compile this code as a module, choose M here: the
 392           module will be called em_cmp.
 393
 394 config NET_EMATCH_NBYTE
 395         tristate "Multi byte comparison"
 396         depends on NET_EMATCH
 397         ---help---
 398           Say Y here if you want to be able to classify packets based on
 399           multiple byte comparisons mainly useful for IPv6 address comparisons.
 400
 401           To compile this code as a module, choose M here: the
 402           module will be called em_nbyte.
 403
 404 config NET_EMATCH_U32
 405         tristate "U32 key"
 406         depends on NET_EMATCH
 407         ---help---
 408           Say Y here if you want to be able to classify packets using
 409           the famous u32 key in combination with logic relations.
 410
 411           To compile this code as a module, choose M here: the
 412           module will be called em_u32.
 413
 414 config NET_EMATCH_META
 415         tristate "Metadata"
 416         depends on NET_EMATCH
 417         ---help---
 418           Say Y here if you want to be able to classify packets based on
 419           metadata such as load average, netfilter attributes, socket
 420           attributes and routing decisions.
 421
 422           To compile this code as a module, choose M here: the
 423           module will be called em_meta.
 424
 425 config NET_EMATCH_TEXT
 426         tristate "Textsearch"
 427         depends on NET_EMATCH
 428         select TEXTSEARCH
 429         select TEXTSEARCH_KMP
 430         select TEXTSEARCH_BM
 431         select TEXTSEARCH_FSM
 432         ---help---
 433           Say Y here if you want to be able to classify packets based on
 434           textsearch comparisons.
 435
 436           To compile this code as a module, choose M here: the
 437           module will be called em_text.
 438
 439 config NET_CLS_ACT
 440         bool "Actions"
 441         ---help---
 442           Say Y here if you want to use traffic control actions. Actions
 443           get attached to classifiers and are invoked after a successful
 444           classification. They are used to overwrite the classification
 445           result, instantly drop or redirect packets, etc.
 446
 447           A recent version of the iproute2 package is required to use
 448           extended matches.
 449
 450 config NET_ACT_POLICE
 451         tristate "Traffic Policing"
 452         depends on NET_CLS_ACT
 453         ---help---
 454           Say Y here if you want to do traffic policing, i.e. strict
 455           bandwidth limiting. This action replaces the existing policing
 456           module.
 457
 458           To compile this code as a module, choose M here: the
 459           module will be called act_police.
 460
 461 config NET_ACT_GACT
 462         tristate "Generic actions"
 463         depends on NET_CLS_ACT
 464         ---help---
 465           Say Y here to take generic actions such as dropping and
 466           accepting packets.
 467
 468           To compile this code as a module, choose M here: the
 469           module will be called act_gact.
 470
 471 config GACT_PROB
 472         bool "Probability support"
 473         depends on NET_ACT_GACT
 474         ---help---
 475           Say Y here to use the generic action randomly or deterministically.
 476
 477 config NET_ACT_MIRRED
 478         tristate "Redirecting and Mirroring"
 479         depends on NET_CLS_ACT
 480         ---help---
 481           Say Y here to allow packets to be mirrored or redirected to
 482           other devices.
 483
 484           To compile this code as a module, choose M here: the
 485           module will be called act_mirred.
 486
 487 config NET_ACT_IPT
 488         tristate "IPtables targets"
 489         depends on NET_CLS_ACT && NETFILTER && IP_NF_IPTABLES
 490         ---help---
 491           Say Y here to be able to invoke iptables targets after successful
 492           classification.
 493
 494           To compile this code as a module, choose M here: the
 495           module will be called act_ipt.
 496
 497 config NET_ACT_NAT
 498         tristate "Stateless NAT"
 499         depends on NET_CLS_ACT
 500         ---help---
 501           Say Y here to do stateless NAT on IPv4 packets.  You should use
 502           netfilter for NAT unless you know what you are doing.
 503
 504           To compile this code as a module, choose M here: the
 505           module will be called act_nat.
 506
 507 config NET_ACT_PEDIT
 508         tristate "Packet Editing"
 509         depends on NET_CLS_ACT
 510         ---help---
 511           Say Y here if you want to mangle the content of packets.
 512
 513           To compile this code as a module, choose M here: the
 514           module will be called act_pedit.
 515
 516 config NET_ACT_SIMP
 517         tristate "Simple Example (Debug)"
 518         depends on NET_CLS_ACT
 519         ---help---
 520           Say Y here to add a simple action for demonstration purposes.
 521           It is meant as an example and for debugging purposes. It will
 522           print a configured policy string followed by the packet count
 523           to the console for every packet that passes by.
 524
 525           If unsure, say N.
 526
 527           To compile this code as a module, choose M here: the
 528           module will be called act_simple.
 529
 530 config NET_ACT_SKBEDIT
 531         tristate "SKB Editing"
 532         depends on NET_CLS_ACT
 533         ---help---
 534           Say Y here to change skb priority or queue_mapping settings.
 535
 536           If unsure, say N.
 537
 538           To compile this code as a module, choose M here: the
 539           module will be called act_skbedit.
 540
 541 config NET_ACT_CSUM
 542         tristate "Checksum Updating"
 543         depends on NET_CLS_ACT && INET
 544         ---help---
 545           Say Y here to update some common checksum after some direct
 546           packet alterations.
 547
 548           To compile this code as a module, choose M here: the
 549           module will be called act_csum.
 550
 551 config NET_CLS_IND
 552         bool "Incoming device classification"
 553         depends on NET_CLS_U32 || NET_CLS_FW
 554         ---help---
 555           Say Y here to extend the u32 and fw classifier to support
 556           classification based on the incoming device. This option is
 557           likely to disappear in favour of the metadata ematch.
 558
 559 endif # NET_SCHED
 560
 561 config NET_SCH_FIFO
 562         bool