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