release/src/linux/linux/include/linux/pkt_sched.h

   1 #ifndef __LINUX_PKT_SCHED_H
   2 #define __LINUX_PKT_SCHED_H
   3
   4 /* Logical priority bands not depending on specific packet scheduler.
   5    Every scheduler will map them to real traffic classes, if it has
   6    no more precise mechanism to classify packets.
   7
   8    These numbers have no special meaning, though their coincidence
   9    with obsolete IPv6 values is not occasional :-). New IPv6 drafts
  10    preferred full anarchy inspired by diffserv group.
  11
  12    Note: TC_PRIO_BESTEFFORT does not mean that it is the most unhappy
  13    class, actually, as rule it will be handled with more care than
  14    filler or even bulk.
  15  */
  16
  17 #define TC_PRIO_BESTEFFORT              0
  18 #define TC_PRIO_FILLER                  1
  19 #define TC_PRIO_BULK                    2
  20 #define TC_PRIO_INTERACTIVE_BULK        4
  21 #define TC_PRIO_INTERACTIVE             6
  22 #define TC_PRIO_CONTROL                 7
  23
  24 #define TC_PRIO_MAX                     15
  25
  26 /* Generic queue statistics, available for all the elements.
  27    Particular schedulers may have also their private records.
  28  */
  29
  30 struct tc_stats
  31 {
  32         __u64   bytes;                  /* NUmber of enqueues bytes */
  33         __u32   packets;                /* Number of enqueued packets   */
  34         __u32   drops;                  /* Packets dropped because of lack of resources */
  35         __u32   overlimits;             /* Number of throttle events when this
  36                                          * flow goes out of allocated bandwidth */
  37         __u32   bps;                    /* Current flow byte rate */
  38         __u32   pps;                    /* Current flow packet rate */
  39         __u32   qlen;
  40         __u32   backlog;
  41 #ifdef __KERNEL__
  42         spinlock_t *lock;
  43 #endif
  44 };
  45
  46 struct tc_estimator
  47 {
  48         signed char     interval;
  49         unsigned char   ewma_log;
  50 };
  51
  52 /* "Handles"
  53    ---------
  54
  55     All the traffic control objects have 32bit identifiers, or "handles".
  56
  57     They can be considered as opaque numbers from user API viewpoint,
  58     but actually they always consist of two fields: major and
  59     minor numbers, which are interpreted by kernel specially,
  60     that may be used by applications, though not recommended.
  61
  62     F.e. qdisc handles always have minor number equal to zero,
  63     classes (or flows) have major equal to parent qdisc major, and
  64     minor uniquely identifying class inside qdisc.
  65
  66     Macros to manipulate handles:
  67  */
  68
  69 #define TC_H_MAJ_MASK (0xFFFF0000U)
  70 #define TC_H_MIN_MASK (0x0000FFFFU)
  71 #define TC_H_MAJ(h) ((h)&TC_H_MAJ_MASK)
  72 #define TC_H_MIN(h) ((h)&TC_H_MIN_MASK)
  73 #define TC_H_MAKE(maj,min) (((maj)&TC_H_MAJ_MASK)|((min)&TC_H_MIN_MASK))
  74
  75 #define TC_H_UNSPEC     (0U)
  76 #define TC_H_ROOT       (0xFFFFFFFFU)
  77 #define TC_H_INGRESS    (0xFFFFFFF1U)
  78
  79 struct tc_ratespec
  80 {
  81         unsigned char   cell_log;
  82         unsigned char   __reserved;
  83         unsigned short  feature;    /* Always 0 in pre-atm patch kernels */
  84         char            cell_align; /* Always 0 in pre-atm patch kernels */
  85         unsigned char   __unused;
  86         unsigned short  mpu;
  87         __u32           rate;
  88 };
  89
  90 /* FIFO section */
  91
  92 struct tc_fifo_qopt
  93 {
  94         __u32   limit;  /* Queue length: bytes for bfifo, packets for pfifo */
  95 };
  96
  97 /* PRIO section */
  98
  99 #define TCQ_PRIO_BANDS  16
 100
 101 struct tc_prio_qopt
 102 {
 103         int     bands;                  /* Number of bands */
 104         __u8    priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> PRIO band */
 105 };
 106
 107 /* CSZ section */
 108
 109 struct tc_csz_qopt
 110 {
 111         int             flows;          /* Maximal number of guaranteed flows */
 112         unsigned char   R_log;          /* Fixed point position for round number */
 113         unsigned char   delta_log;      /* Log of maximal managed time interval */
 114         __u8            priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> CSZ band */
 115 };
 116
 117 struct tc_csz_copt
 118 {
 119         struct tc_ratespec slice;
 120         struct tc_ratespec rate;
 121         struct tc_ratespec peakrate;
 122         __u32           limit;
 123         __u32           buffer;
 124         __u32           mtu;
 125 };
 126
 127 enum
 128 {
 129         TCA_CSZ_UNSPEC,
 130         TCA_CSZ_PARMS,
 131         TCA_CSZ_RTAB,
 132         TCA_CSZ_PTAB,
 133 };
 134
 135 /* TBF section */
 136
 137 struct tc_tbf_qopt
 138 {
 139         struct tc_ratespec rate;
 140         struct tc_ratespec peakrate;
 141         __u32           limit;
 142         __u32           buffer;
 143         __u32           mtu;
 144 };
 145
 146 enum
 147 {
 148         TCA_TBF_UNSPEC,
 149         TCA_TBF_PARMS,
 150         TCA_TBF_RTAB,
 151         TCA_TBF_PTAB,
 152 };
 153
 154
 155 /* TEQL section */
 156
 157 /* TEQL does not require any parameters */
 158
 159 /* SFQ section */
 160
 161 struct tc_sfq_qopt
 162 {
 163         unsigned        quantum;        /* Bytes per round allocated to flow */
 164         int             perturb_period; /* Period of hash perturbation */
 165         __u32           limit;          /* Maximal packets in queue */
 166         unsigned        divisor;        /* Hash divisor  */
 167         unsigned        flows;          /* Maximal number of flows  */
 168 };
 169
 170 /*
 171  *  NOTE: limit, divisor and flows are hardwired to code at the moment.
 172  *
 173  *      limit=flows=128, divisor=1024;
 174  *
 175  *      The only reason for this is efficiency, it is possible
 176  *      to change these parameters in compile time.
 177  *
 178  *      If you need to play with these values use esfq instead.
 179  */
 180
 181 /* ESFQ section */
 182
 183 enum
 184 {
 185         /* traditional */
 186         TCA_SFQ_HASH_CLASSIC,
 187         TCA_SFQ_HASH_DST,
 188         TCA_SFQ_HASH_SRC,
 189         TCA_SFQ_HASH_FWMARK,
 190         /* conntrack */
 191         TCA_SFQ_HASH_CTORIGDST,
 192         TCA_SFQ_HASH_CTORIGSRC,
 193         TCA_SFQ_HASH_CTREPLDST,
 194         TCA_SFQ_HASH_CTREPLSRC,
 195         TCA_SFQ_HASH_CTNATCHG,
 196 };
 197
 198 struct tc_esfq_qopt
 199 {
 200         unsigned        quantum;        /* Bytes per round allocated to flow */
 201         int             perturb_period; /* Period of hash perturbation */
 202         __u32           limit;          /* Maximal packets in queue */
 203         unsigned        divisor;        /* Hash divisor  */
 204         unsigned        flows;          /* Maximal number of flows  */
 205         unsigned        hash_kind;      /* Hash function to use for flow identification */
 206 };
 207
 208 /* RED section */
 209
 210 enum
 211 {
 212         TCA_RED_UNSPEC,
 213         TCA_RED_PARMS,
 214         TCA_RED_STAB,
 215 };
 216
 217 struct tc_red_qopt
 218 {
 219         __u32           limit;          /* HARD maximal queue length (bytes)    */
 220         __u32           qth_min;        /* Min average length threshold (bytes) */
 221         __u32           qth_max;        /* Max average length threshold (bytes) */
 222         unsigned char   Wlog;           /* log(W)               */
 223         unsigned char   Plog;           /* log(P_max/(qth_max-qth_min)) */
 224         unsigned char   Scell_log;      /* cell size for idle damping */
 225         unsigned char   flags;
 226 #define TC_RED_ECN      1
 227 };
 228
 229 struct tc_red_xstats
 230 {
 231         __u32           early;          /* Early drops */
 232         __u32           pdrop;          /* Drops due to queue limits */
 233         __u32           other;          /* Drops due to drop() calls */
 234         __u32           marked;         /* Marked packets */
 235 };
 236
 237 /* GRED section */
 238
 239 #define MAX_DPs 16
 240
 241 enum
 242 {
 243        TCA_GRED_UNSPEC,
 244        TCA_GRED_PARMS,
 245        TCA_GRED_STAB,
 246        TCA_GRED_DPS,
 247 };
 248
 249 #define TCA_SET_OFF TCA_GRED_PARMS
 250 struct tc_gred_qopt
 251 {
 252        __u32           limit;          /* HARD maximal queue length (bytes)
 253 */
 254        __u32           qth_min;        /* Min average length threshold (bytes)
 255 */
 256        __u32           qth_max;        /* Max average length threshold (bytes)
 257 */
 258        __u32           DP;             /* upto 2^32 DPs */
 259        __u32           backlog;
 260        __u32           qave;
 261        __u32           forced;
 262        __u32           early;
 263        __u32           other;
 264        __u32           pdrop;
 265
 266        unsigned char   Wlog;           /* log(W)               */
 267        unsigned char   Plog;           /* log(P_max/(qth_max-qth_min)) */
 268        unsigned char   Scell_log;      /* cell size for idle damping */
 269        __u8            prio;            /* prio of this VQ */
 270        __u32    packets;
 271        __u32    bytesin;
 272 };
 273 /* gred setup */
 274 struct tc_gred_sopt
 275 {
 276        __u32            DPs;
 277        __u32            def_DP;
 278        __u8             grio;
 279        __u8             pad1;
 280        __u16            pad2;
 281 };
 282
 283 /* HTB section */
 284 #define TC_HTB_NUMPRIO          11      /* Toastman */
 285 #define TC_HTB_MAXDEPTH         8
 286 #define TC_HTB_PROTOVER         3       /* the same as HTB and TC's major */
 287
 288 struct tc_htb_opt
 289 {
 290         struct tc_ratespec      rate;
 291         struct tc_ratespec      ceil;
 292         __u32   buffer;
 293         __u32   cbuffer;
 294         __u32   quantum;
 295         __u32   level;          /* out only */
 296         __u32   prio;
 297 };
 298 struct tc_htb_glob
 299 {
 300         __u32 version;          /* to match HTB/TC */
 301         __u32 rate2quantum;     /* bps->quantum divisor */
 302         __u32 defcls;           /* default class number */
 303         __u32 debug;            /* debug flags */
 304
 305         /* stats */
 306         __u32 direct_pkts; /* count of non shapped packets */
 307 };
 308 enum
 309 {
 310         TCA_HTB_UNSPEC,
 311         TCA_HTB_PARMS,
 312         TCA_HTB_INIT,
 313         TCA_HTB_CTAB,
 314         TCA_HTB_RTAB,
 315 };
 316 struct tc_htb_xstats
 317 {
 318         __u32 lends;
 319         __u32 borrows;
 320         __u32 giants;   /* too big packets (rate will not be accurate) */
 321         __u32 tokens;
 322         __u32 ctokens;
 323 };
 324
 325 /* HFSC section */
 326
 327 struct tc_hfsc_qopt
 328 {
 329         __u16   defcls;         /* default class */
 330 };
 331
 332 struct tc_service_curve
 333 {
 334         __u32   m1;             /* slope of the first segment in bps */
 335         __u32   d;              /* x-projection of the first segment in us */
 336         __u32   m2;             /* slope of the second segment in bps */
 337 };
 338
 339 struct tc_hfsc_stats
 340 {
 341         __u64   work;           /* total work done */
 342         __u64   rtwork;         /* work done by real-time criteria */
 343         __u32   period;         /* current period */
 344         __u32   level;          /* class level in hierarchy */
 345 };
 346
 347 enum
 348 {
 349         TCA_HFSC_UNSPEC,
 350         TCA_HFSC_RSC,
 351         TCA_HFSC_FSC,
 352         TCA_HFSC_USC,
 353         TCA_HFSC_MAX = TCA_HFSC_USC
 354 };
 355
 356 /* CBQ section */
 357
 358 #define TC_CBQ_MAXPRIO          11      /* Toastman */
 359 #define TC_CBQ_MAXLEVEL         8
 360 #define TC_CBQ_DEF_EWMA         5
 361
 362 struct tc_cbq_lssopt
 363 {
 364         unsigned char   change;
 365         unsigned char   flags;
 366 #define TCF_CBQ_LSS_BOUNDED     1
 367 #define TCF_CBQ_LSS_ISOLATED    2
 368         unsigned char   ewma_log;
 369         unsigned char   level;
 370 #define TCF_CBQ_LSS_FLAGS       1
 371 #define TCF_CBQ_LSS_EWMA        2
 372 #define TCF_CBQ_LSS_MAXIDLE     4
 373 #define TCF_CBQ_LSS_MINIDLE     8
 374 #define TCF_CBQ_LSS_OFFTIME     0x10
 375 #define TCF_CBQ_LSS_AVPKT       0x20
 376         __u32           maxidle;
 377         __u32           minidle;
 378         __u32           offtime;
 379         __u32           avpkt;
 380 };
 381
 382 struct tc_cbq_wrropt
 383 {
 384         unsigned char   flags;
 385         unsigned char   priority;
 386         unsigned char   cpriority;
 387         unsigned char   __reserved;
 388         __u32           allot;
 389         __u32           weight;
 390 };
 391
 392 struct tc_cbq_ovl
 393 {
 394         unsigned char   strategy;
 395 #define TC_CBQ_OVL_CLASSIC      0
 396 #define TC_CBQ_OVL_DELAY        1
 397 #define TC_CBQ_OVL_LOWPRIO      2
 398 #define TC_CBQ_OVL_DROP         3
 399 #define TC_CBQ_OVL_RCLASSIC     4
 400         unsigned char   priority2;
 401         __u16           pad;
 402         __u32           penalty;
 403 };
 404
 405 struct tc_cbq_police
 406 {
 407         unsigned char   police;
 408         unsigned char   __res1;
 409         unsigned short  __res2;
 410 };
 411
 412 struct tc_cbq_fopt
 413 {
 414         __u32           split;
 415         __u32           defmap;
 416         __u32           defchange;
 417 };
 418
 419 struct tc_cbq_xstats
 420 {
 421         __u32           borrows;
 422         __u32           overactions;
 423         __s32           avgidle;
 424         __s32           undertime;
 425 };
 426
 427 enum
 428 {
 429         TCA_CBQ_UNSPEC,
 430         TCA_CBQ_LSSOPT,
 431         TCA_CBQ_WRROPT,
 432         TCA_CBQ_FOPT,
 433         TCA_CBQ_OVL_STRATEGY,
 434         TCA_CBQ_RATE,
 435         TCA_CBQ_RTAB,
 436         TCA_CBQ_POLICE,
 437 };
 438
 439 #define TCA_CBQ_MAX     TCA_CBQ_POLICE
 440
 441 /* dsmark section */
 442
 443 enum {
 444         TCA_DSMARK_UNSPEC,
 445         TCA_DSMARK_INDICES,
 446         TCA_DSMARK_DEFAULT_INDEX,
 447         TCA_DSMARK_SET_TC_INDEX,
 448         TCA_DSMARK_MASK,
 449         TCA_DSMARK_VALUE
 450 };
 451
 452 #define TCA_DSMARK_MAX TCA_DSMARK_VALUE
 453
 454 /* ATM  section */
 455
 456 enum {
 457         TCA_ATM_UNSPEC,
 458         TCA_ATM_FD,             /* file/socket descriptor */
 459         TCA_ATM_PTR,            /* pointer to descriptor - later */
 460         TCA_ATM_HDR,            /* LL header */
 461         TCA_ATM_EXCESS,         /* excess traffic class (0 for CLP)  */
 462         TCA_ATM_ADDR,           /* PVC address (for output only) */
 463         TCA_ATM_STATE           /* VC state (ATM_VS_*; for output only) */
 464 };
 465
 466 #define TCA_ATM_MAX     TCA_ATM_STATE
 467
 468 /* Network emulator */
 469
 470 enum
 471 {
 472         TCA_NETEM_UNSPEC,
 473         TCA_NETEM_CORR,
 474         TCA_NETEM_DELAY_DIST,
 475 };
 476
 477 #define TCA_NETEM_MAX   TCA_NETEM_DELAY_DIST
 478
 479 struct tc_netem_qopt
 480 {
 481         __u32   latency;        /* added delay (us) */
 482         __u32   limit;          /* fifo limit (packets) */
 483         __u32   loss;           /* random packet loss (0=none ~0=100%) */
 484         __u32   gap;            /* re-ordering gap (0 for delay all) */
 485         __u32   duplicate;      /* random packet dup  (0=none ~0=100%) */
 486         __u32   jitter;         /* random jitter in latency (us) */
 487 };
 488
 489 struct tc_netem_corr
 490 {
 491         __u32   delay_corr;     /* delay correlation */
 492         __u32   loss_corr;      /* packet loss correlation */
 493         __u32   dup_corr;       /* duplicate correlation  */
 494 };
 495
 496 #define NETEM_DIST_SCALE        8192
 497
 498 #endif