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