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         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
  75 struct tc_ratespec
  76 {
  77         unsigned char   cell_log;
  78         unsigned char   __reserved;
  79         unsigned short  feature;
  80         short           addend;
  81         unsigned short  mpu;
  82         __u32           rate;
  83 };
  84
  85 /* FIFO section */
  86
  87 struct tc_fifo_qopt
  88 {
  89         __u32   limit;  /* Queue length: bytes for bfifo, packets for pfifo */
  90 };
  91
  92 /* PRIO section */
  93
  94 #define TCQ_PRIO_BANDS  16
  95
  96 struct tc_prio_qopt
  97 {
  98         int     bands;                  /* Number of bands */
  99         __u8    priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> PRIO band */
 100 };
 101
 102 /* CSZ section */
 103
 104 struct tc_csz_qopt
 105 {
 106         int             flows;          /* Maximal number of guaranteed flows */
 107         unsigned char   R_log;          /* Fixed point position for round number */
 108         unsigned char   delta_log;      /* Log of maximal managed time interval */
 109         __u8            priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> CSZ band */
 110 };
 111
 112 struct tc_csz_copt
 113 {
 114         struct tc_ratespec slice;
 115         struct tc_ratespec rate;
 116         struct tc_ratespec peakrate;
 117         __u32           limit;
 118         __u32           buffer;
 119         __u32           mtu;
 120 };
 121
 122 enum
 123 {
 124         TCA_CSZ_UNSPEC,
 125         TCA_CSZ_PARMS,
 126         TCA_CSZ_RTAB,
 127         TCA_CSZ_PTAB,
 128 };
 129
 130 /* TBF section */
 131
 132 struct tc_tbf_qopt
 133 {
 134         struct tc_ratespec rate;
 135         struct tc_ratespec peakrate;
 136         __u32           limit;
 137         __u32           buffer;
 138         __u32           mtu;
 139 };
 140
 141 enum
 142 {
 143         TCA_TBF_UNSPEC,
 144         TCA_TBF_PARMS,
 145         TCA_TBF_RTAB,
 146         TCA_TBF_PTAB,
 147 };
 148
 149
 150 /* TEQL section */
 151
 152 /* TEQL does not require any parameters */
 153
 154 /* SFQ section */
 155
 156 struct tc_sfq_qopt
 157 {
 158         unsigned        quantum;        /* Bytes per round allocated to flow */
 159         int             perturb_period; /* Period of hash perturbation */
 160         __u32           limit;          /* Maximal packets in queue */
 161         unsigned        divisor;        /* Hash divisor  */
 162         unsigned        flows;          /* Maximal number of flows  */
 163 };
 164
 165 /*
 166  *  NOTE: limit, divisor and flows are hardwired to code at the moment.
 167  *
 168  *      limit=flows=128, divisor=1024;
 169  *
 170  *      The only reason for this is efficiency, it is possible
 171  *      to change these parameters in compile time.
 172  */
 173
 174 /* RED section */
 175
 176 enum
 177 {
 178         TCA_RED_UNSPEC,
 179         TCA_RED_PARMS,
 180         TCA_RED_STAB,
 181 };
 182
 183 struct tc_red_qopt
 184 {
 185         __u32           limit;          /* HARD maximal queue length (bytes)    */
 186         __u32           qth_min;        /* Min average length threshold (bytes) */
 187         __u32           qth_max;        /* Max average length threshold (bytes) */
 188         unsigned char   Wlog;           /* log(W)               */
 189         unsigned char   Plog;           /* log(P_max/(qth_max-qth_min)) */
 190         unsigned char   Scell_log;      /* cell size for idle damping */
 191 };
 192
 193 /* CBQ section */
 194
 195 #define TC_CBQ_MAXPRIO          8
 196 #define TC_CBQ_MAXLEVEL         8
 197 #define TC_CBQ_DEF_EWMA         5
 198
 199 struct tc_cbq_lssopt
 200 {
 201         unsigned char   change;
 202         unsigned char   flags;
 203 #define TCF_CBQ_LSS_BOUNDED     1
 204 #define TCF_CBQ_LSS_ISOLATED    2
 205         unsigned char   ewma_log;
 206         unsigned char   level;
 207 #define TCF_CBQ_LSS_FLAGS       1
 208 #define TCF_CBQ_LSS_EWMA        2
 209 #define TCF_CBQ_LSS_MAXIDLE     4
 210 #define TCF_CBQ_LSS_MINIDLE     8
 211 #define TCF_CBQ_LSS_OFFTIME     0x10
 212 #define TCF_CBQ_LSS_AVPKT       0x20
 213         __u32           maxidle;
 214         __u32           minidle;
 215         __u32           offtime;
 216         __u32           avpkt;
 217 };
 218
 219 struct tc_cbq_wrropt
 220 {
 221         unsigned char   flags;
 222         unsigned char   priority;
 223         unsigned char   cpriority;
 224         unsigned char   __reserved;
 225         __u32           allot;
 226         __u32           weight;
 227 };
 228
 229 struct tc_cbq_ovl
 230 {
 231         unsigned char   strategy;
 232 #define TC_CBQ_OVL_CLASSIC      0
 233 #define TC_CBQ_OVL_DELAY        1
 234 #define TC_CBQ_OVL_LOWPRIO      2
 235 #define TC_CBQ_OVL_DROP         3
 236 #define TC_CBQ_OVL_RCLASSIC     4
 237         unsigned char   priority2;
 238         __u32           penalty;
 239 };
 240
 241 struct tc_cbq_police
 242 {
 243         unsigned char   police;
 244         unsigned char   __res1;
 245         unsigned short  __res2;
 246 };
 247
 248 struct tc_cbq_fopt
 249 {
 250         __u32           split;
 251         __u32           defmap;
 252         __u32           defchange;
 253 };
 254
 255 struct tc_cbq_xstats
 256 {
 257         __u32           borrows;
 258         __u32           overactions;
 259         __s32           avgidle;
 260         __s32           undertime;
 261 };
 262
 263 enum
 264 {
 265         TCA_CBQ_UNSPEC,
 266         TCA_CBQ_LSSOPT,
 267         TCA_CBQ_WRROPT,
 268         TCA_CBQ_FOPT,
 269         TCA_CBQ_OVL_STRATEGY,
 270         TCA_CBQ_RATE,
 271         TCA_CBQ_RTAB,
 272         TCA_CBQ_POLICE,
 273 };
 274
 275 #define TCA_CBQ_MAX     TCA_CBQ_POLICE
 276
 277 #endif