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