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