Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef __LINUX_PKT_SCHED_H |
2 | #define __LINUX_PKT_SCHED_H | |
3 | ||
b8adfd3c JSR |
4 | #include <linux/types.h> |
5 | ||
1da177e4 LT |
6 | /* Logical priority bands not depending on specific packet scheduler. |
7 | Every scheduler will map them to real traffic classes, if it has | |
8 | no more precise mechanism to classify packets. | |
9 | ||
10 | These numbers have no special meaning, though their coincidence | |
11 | with obsolete IPv6 values is not occasional :-). New IPv6 drafts | |
12 | preferred full anarchy inspired by diffserv group. | |
13 | ||
14 | Note: TC_PRIO_BESTEFFORT does not mean that it is the most unhappy | |
15 | class, actually, as rule it will be handled with more care than | |
16 | filler or even bulk. | |
17 | */ | |
18 | ||
19 | #define TC_PRIO_BESTEFFORT 0 | |
20 | #define TC_PRIO_FILLER 1 | |
21 | #define TC_PRIO_BULK 2 | |
22 | #define TC_PRIO_INTERACTIVE_BULK 4 | |
23 | #define TC_PRIO_INTERACTIVE 6 | |
24 | #define TC_PRIO_CONTROL 7 | |
25 | ||
26 | #define TC_PRIO_MAX 15 | |
27 | ||
28 | /* Generic queue statistics, available for all the elements. | |
29 | Particular schedulers may have also their private records. | |
30 | */ | |
31 | ||
d94d9fee | 32 | struct tc_stats { |
1da177e4 LT |
33 | __u64 bytes; /* NUmber of enqueues bytes */ |
34 | __u32 packets; /* Number of enqueued packets */ | |
35 | __u32 drops; /* Packets dropped because of lack of resources */ | |
36 | __u32 overlimits; /* Number of throttle events when this | |
37 | * flow goes out of allocated bandwidth */ | |
38 | __u32 bps; /* Current flow byte rate */ | |
39 | __u32 pps; /* Current flow packet rate */ | |
40 | __u32 qlen; | |
41 | __u32 backlog; | |
42 | }; | |
43 | ||
d94d9fee | 44 | struct tc_estimator { |
1da177e4 LT |
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 | ||
d94d9fee | 76 | struct tc_ratespec { |
1da177e4 LT |
77 | unsigned char cell_log; |
78 | unsigned char __reserved; | |
e08b0998 JDB |
79 | unsigned short overhead; |
80 | short cell_align; | |
1da177e4 LT |
81 | unsigned short mpu; |
82 | __u32 rate; | |
83 | }; | |
84 | ||
5feb5e1a PM |
85 | #define TC_RTAB_SIZE 1024 |
86 | ||
175f9c1b JK |
87 | struct tc_sizespec { |
88 | unsigned char cell_log; | |
89 | unsigned char size_log; | |
90 | short cell_align; | |
91 | int overhead; | |
92 | unsigned int linklayer; | |
93 | unsigned int mpu; | |
94 | unsigned int mtu; | |
95 | unsigned int tsize; | |
96 | }; | |
97 | ||
98 | enum { | |
99 | TCA_STAB_UNSPEC, | |
100 | TCA_STAB_BASE, | |
101 | TCA_STAB_DATA, | |
102 | __TCA_STAB_MAX | |
103 | }; | |
104 | ||
105 | #define TCA_STAB_MAX (__TCA_STAB_MAX - 1) | |
106 | ||
1da177e4 LT |
107 | /* FIFO section */ |
108 | ||
d94d9fee | 109 | struct tc_fifo_qopt { |
1da177e4 LT |
110 | __u32 limit; /* Queue length: bytes for bfifo, packets for pfifo */ |
111 | }; | |
112 | ||
113 | /* PRIO section */ | |
114 | ||
115 | #define TCQ_PRIO_BANDS 16 | |
bdc450a0 | 116 | #define TCQ_MIN_PRIO_BANDS 2 |
1da177e4 | 117 | |
d94d9fee | 118 | struct tc_prio_qopt { |
1da177e4 LT |
119 | int bands; /* Number of bands */ |
120 | __u8 priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> PRIO band */ | |
121 | }; | |
122 | ||
92651940 AD |
123 | /* MULTIQ section */ |
124 | ||
125 | struct tc_multiq_qopt { | |
126 | __u16 bands; /* Number of bands */ | |
127 | __u16 max_bands; /* Maximum number of queues */ | |
128 | }; | |
129 | ||
1da177e4 LT |
130 | /* TBF section */ |
131 | ||
d94d9fee | 132 | struct tc_tbf_qopt { |
1da177e4 LT |
133 | struct tc_ratespec rate; |
134 | struct tc_ratespec peakrate; | |
135 | __u32 limit; | |
136 | __u32 buffer; | |
137 | __u32 mtu; | |
138 | }; | |
139 | ||
d94d9fee | 140 | enum { |
1da177e4 LT |
141 | TCA_TBF_UNSPEC, |
142 | TCA_TBF_PARMS, | |
143 | TCA_TBF_RTAB, | |
144 | TCA_TBF_PTAB, | |
145 | __TCA_TBF_MAX, | |
146 | }; | |
147 | ||
148 | #define TCA_TBF_MAX (__TCA_TBF_MAX - 1) | |
149 | ||
150 | ||
151 | /* TEQL section */ | |
152 | ||
153 | /* TEQL does not require any parameters */ | |
154 | ||
155 | /* SFQ section */ | |
156 | ||
d94d9fee | 157 | struct tc_sfq_qopt { |
1da177e4 LT |
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 | ||
d94d9fee | 165 | struct tc_sfq_xstats { |
94de78d1 PM |
166 | __s32 allot; |
167 | }; | |
168 | ||
1da177e4 LT |
169 | /* |
170 | * NOTE: limit, divisor and flows are hardwired to code at the moment. | |
171 | * | |
172 | * limit=flows=128, divisor=1024; | |
173 | * | |
174 | * The only reason for this is efficiency, it is possible | |
175 | * to change these parameters in compile time. | |
176 | */ | |
177 | ||
178 | /* RED section */ | |
179 | ||
d94d9fee | 180 | enum { |
1da177e4 LT |
181 | TCA_RED_UNSPEC, |
182 | TCA_RED_PARMS, | |
183 | TCA_RED_STAB, | |
184 | __TCA_RED_MAX, | |
185 | }; | |
186 | ||
187 | #define TCA_RED_MAX (__TCA_RED_MAX - 1) | |
188 | ||
d94d9fee | 189 | struct tc_red_qopt { |
1da177e4 LT |
190 | __u32 limit; /* HARD maximal queue length (bytes) */ |
191 | __u32 qth_min; /* Min average length threshold (bytes) */ | |
192 | __u32 qth_max; /* Max average length threshold (bytes) */ | |
193 | unsigned char Wlog; /* log(W) */ | |
194 | unsigned char Plog; /* log(P_max/(qth_max-qth_min)) */ | |
195 | unsigned char Scell_log; /* cell size for idle damping */ | |
196 | unsigned char flags; | |
197 | #define TC_RED_ECN 1 | |
bdc450a0 | 198 | #define TC_RED_HARDDROP 2 |
1da177e4 LT |
199 | }; |
200 | ||
d94d9fee | 201 | struct tc_red_xstats { |
1da177e4 LT |
202 | __u32 early; /* Early drops */ |
203 | __u32 pdrop; /* Drops due to queue limits */ | |
204 | __u32 other; /* Drops due to drop() calls */ | |
205 | __u32 marked; /* Marked packets */ | |
206 | }; | |
207 | ||
208 | /* GRED section */ | |
209 | ||
210 | #define MAX_DPs 16 | |
211 | ||
d94d9fee | 212 | enum { |
1da177e4 LT |
213 | TCA_GRED_UNSPEC, |
214 | TCA_GRED_PARMS, | |
215 | TCA_GRED_STAB, | |
216 | TCA_GRED_DPS, | |
217 | __TCA_GRED_MAX, | |
218 | }; | |
219 | ||
220 | #define TCA_GRED_MAX (__TCA_GRED_MAX - 1) | |
221 | ||
d94d9fee | 222 | struct tc_gred_qopt { |
1e4dfaf9 TG |
223 | __u32 limit; /* HARD maximal queue length (bytes) */ |
224 | __u32 qth_min; /* Min average length threshold (bytes) */ | |
225 | __u32 qth_max; /* Max average length threshold (bytes) */ | |
226 | __u32 DP; /* upto 2^32 DPs */ | |
227 | __u32 backlog; | |
228 | __u32 qave; | |
229 | __u32 forced; | |
230 | __u32 early; | |
231 | __u32 other; | |
232 | __u32 pdrop; | |
233 | __u8 Wlog; /* log(W) */ | |
234 | __u8 Plog; /* log(P_max/(qth_max-qth_min)) */ | |
235 | __u8 Scell_log; /* cell size for idle damping */ | |
236 | __u8 prio; /* prio of this VQ */ | |
237 | __u32 packets; | |
238 | __u32 bytesin; | |
1da177e4 | 239 | }; |
1e4dfaf9 | 240 | |
1da177e4 | 241 | /* gred setup */ |
d94d9fee | 242 | struct tc_gred_sopt { |
1e4dfaf9 TG |
243 | __u32 DPs; |
244 | __u32 def_DP; | |
245 | __u8 grio; | |
b38c7eef TG |
246 | __u8 flags; |
247 | __u16 pad1; | |
1da177e4 LT |
248 | }; |
249 | ||
45e14433 | 250 | /* CHOKe section */ |
251 | ||
252 | enum { | |
253 | TCA_CHOKE_UNSPEC, | |
254 | TCA_CHOKE_PARMS, | |
255 | TCA_CHOKE_STAB, | |
256 | __TCA_CHOKE_MAX, | |
257 | }; | |
258 | ||
259 | #define TCA_CHOKE_MAX (__TCA_CHOKE_MAX - 1) | |
260 | ||
261 | struct tc_choke_qopt { | |
262 | __u32 limit; /* Hard queue length (packets) */ | |
263 | __u32 qth_min; /* Min average threshold (packets) */ | |
264 | __u32 qth_max; /* Max average threshold (packets) */ | |
265 | unsigned char Wlog; /* log(W) */ | |
266 | unsigned char Plog; /* log(P_max/(qth_max-qth_min)) */ | |
267 | unsigned char Scell_log; /* cell size for idle damping */ | |
268 | unsigned char flags; /* see RED flags */ | |
269 | }; | |
270 | ||
271 | struct tc_choke_xstats { | |
272 | __u32 early; /* Early drops */ | |
273 | __u32 pdrop; /* Drops due to queue limits */ | |
274 | __u32 other; /* Drops due to drop() calls */ | |
275 | __u32 marked; /* Marked packets */ | |
276 | __u32 matched; /* Drops due to flow match */ | |
277 | }; | |
278 | ||
1da177e4 LT |
279 | /* HTB section */ |
280 | #define TC_HTB_NUMPRIO 8 | |
281 | #define TC_HTB_MAXDEPTH 8 | |
282 | #define TC_HTB_PROTOVER 3 /* the same as HTB and TC's major */ | |
283 | ||
d94d9fee | 284 | struct tc_htb_opt { |
1da177e4 LT |
285 | struct tc_ratespec rate; |
286 | struct tc_ratespec ceil; | |
287 | __u32 buffer; | |
288 | __u32 cbuffer; | |
289 | __u32 quantum; | |
290 | __u32 level; /* out only */ | |
291 | __u32 prio; | |
292 | }; | |
d94d9fee | 293 | struct tc_htb_glob { |
1da177e4 LT |
294 | __u32 version; /* to match HTB/TC */ |
295 | __u32 rate2quantum; /* bps->quantum divisor */ | |
296 | __u32 defcls; /* default class number */ | |
297 | __u32 debug; /* debug flags */ | |
298 | ||
299 | /* stats */ | |
300 | __u32 direct_pkts; /* count of non shapped packets */ | |
301 | }; | |
d94d9fee | 302 | enum { |
1da177e4 LT |
303 | TCA_HTB_UNSPEC, |
304 | TCA_HTB_PARMS, | |
305 | TCA_HTB_INIT, | |
306 | TCA_HTB_CTAB, | |
307 | TCA_HTB_RTAB, | |
308 | __TCA_HTB_MAX, | |
309 | }; | |
310 | ||
311 | #define TCA_HTB_MAX (__TCA_HTB_MAX - 1) | |
312 | ||
d94d9fee | 313 | struct tc_htb_xstats { |
1da177e4 LT |
314 | __u32 lends; |
315 | __u32 borrows; | |
316 | __u32 giants; /* too big packets (rate will not be accurate) */ | |
317 | __u32 tokens; | |
318 | __u32 ctokens; | |
319 | }; | |
320 | ||
321 | /* HFSC section */ | |
322 | ||
d94d9fee | 323 | struct tc_hfsc_qopt { |
1da177e4 LT |
324 | __u16 defcls; /* default class */ |
325 | }; | |
326 | ||
d94d9fee | 327 | struct tc_service_curve { |
1da177e4 LT |
328 | __u32 m1; /* slope of the first segment in bps */ |
329 | __u32 d; /* x-projection of the first segment in us */ | |
330 | __u32 m2; /* slope of the second segment in bps */ | |
331 | }; | |
332 | ||
d94d9fee | 333 | struct tc_hfsc_stats { |
1da177e4 LT |
334 | __u64 work; /* total work done */ |
335 | __u64 rtwork; /* work done by real-time criteria */ | |
336 | __u32 period; /* current period */ | |
337 | __u32 level; /* class level in hierarchy */ | |
338 | }; | |
339 | ||
d94d9fee | 340 | enum { |
1da177e4 LT |
341 | TCA_HFSC_UNSPEC, |
342 | TCA_HFSC_RSC, | |
343 | TCA_HFSC_FSC, | |
344 | TCA_HFSC_USC, | |
345 | __TCA_HFSC_MAX, | |
346 | }; | |
347 | ||
348 | #define TCA_HFSC_MAX (__TCA_HFSC_MAX - 1) | |
349 | ||
350 | ||
351 | /* CBQ section */ | |
352 | ||
353 | #define TC_CBQ_MAXPRIO 8 | |
354 | #define TC_CBQ_MAXLEVEL 8 | |
355 | #define TC_CBQ_DEF_EWMA 5 | |
356 | ||
d94d9fee | 357 | struct tc_cbq_lssopt { |
1da177e4 LT |
358 | unsigned char change; |
359 | unsigned char flags; | |
360 | #define TCF_CBQ_LSS_BOUNDED 1 | |
361 | #define TCF_CBQ_LSS_ISOLATED 2 | |
362 | unsigned char ewma_log; | |
363 | unsigned char level; | |
364 | #define TCF_CBQ_LSS_FLAGS 1 | |
365 | #define TCF_CBQ_LSS_EWMA 2 | |
366 | #define TCF_CBQ_LSS_MAXIDLE 4 | |
367 | #define TCF_CBQ_LSS_MINIDLE 8 | |
368 | #define TCF_CBQ_LSS_OFFTIME 0x10 | |
369 | #define TCF_CBQ_LSS_AVPKT 0x20 | |
370 | __u32 maxidle; | |
371 | __u32 minidle; | |
372 | __u32 offtime; | |
373 | __u32 avpkt; | |
374 | }; | |
375 | ||
d94d9fee | 376 | struct tc_cbq_wrropt { |
1da177e4 LT |
377 | unsigned char flags; |
378 | unsigned char priority; | |
379 | unsigned char cpriority; | |
380 | unsigned char __reserved; | |
381 | __u32 allot; | |
382 | __u32 weight; | |
383 | }; | |
384 | ||
d94d9fee | 385 | struct tc_cbq_ovl { |
1da177e4 LT |
386 | unsigned char strategy; |
387 | #define TC_CBQ_OVL_CLASSIC 0 | |
388 | #define TC_CBQ_OVL_DELAY 1 | |
389 | #define TC_CBQ_OVL_LOWPRIO 2 | |
390 | #define TC_CBQ_OVL_DROP 3 | |
391 | #define TC_CBQ_OVL_RCLASSIC 4 | |
392 | unsigned char priority2; | |
8a47077a | 393 | __u16 pad; |
1da177e4 LT |
394 | __u32 penalty; |
395 | }; | |
396 | ||
d94d9fee | 397 | struct tc_cbq_police { |
1da177e4 LT |
398 | unsigned char police; |
399 | unsigned char __res1; | |
400 | unsigned short __res2; | |
401 | }; | |
402 | ||
d94d9fee | 403 | struct tc_cbq_fopt { |
1da177e4 LT |
404 | __u32 split; |
405 | __u32 defmap; | |
406 | __u32 defchange; | |
407 | }; | |
408 | ||
d94d9fee | 409 | struct tc_cbq_xstats { |
1da177e4 LT |
410 | __u32 borrows; |
411 | __u32 overactions; | |
412 | __s32 avgidle; | |
413 | __s32 undertime; | |
414 | }; | |
415 | ||
d94d9fee | 416 | enum { |
1da177e4 LT |
417 | TCA_CBQ_UNSPEC, |
418 | TCA_CBQ_LSSOPT, | |
419 | TCA_CBQ_WRROPT, | |
420 | TCA_CBQ_FOPT, | |
421 | TCA_CBQ_OVL_STRATEGY, | |
422 | TCA_CBQ_RATE, | |
423 | TCA_CBQ_RTAB, | |
424 | TCA_CBQ_POLICE, | |
425 | __TCA_CBQ_MAX, | |
426 | }; | |
427 | ||
428 | #define TCA_CBQ_MAX (__TCA_CBQ_MAX - 1) | |
429 | ||
430 | /* dsmark section */ | |
431 | ||
432 | enum { | |
433 | TCA_DSMARK_UNSPEC, | |
434 | TCA_DSMARK_INDICES, | |
435 | TCA_DSMARK_DEFAULT_INDEX, | |
436 | TCA_DSMARK_SET_TC_INDEX, | |
437 | TCA_DSMARK_MASK, | |
438 | TCA_DSMARK_VALUE, | |
439 | __TCA_DSMARK_MAX, | |
440 | }; | |
441 | ||
442 | #define TCA_DSMARK_MAX (__TCA_DSMARK_MAX - 1) | |
443 | ||
444 | /* ATM section */ | |
445 | ||
446 | enum { | |
447 | TCA_ATM_UNSPEC, | |
448 | TCA_ATM_FD, /* file/socket descriptor */ | |
449 | TCA_ATM_PTR, /* pointer to descriptor - later */ | |
450 | TCA_ATM_HDR, /* LL header */ | |
451 | TCA_ATM_EXCESS, /* excess traffic class (0 for CLP) */ | |
452 | TCA_ATM_ADDR, /* PVC address (for output only) */ | |
453 | TCA_ATM_STATE, /* VC state (ATM_VS_*; for output only) */ | |
454 | __TCA_ATM_MAX, | |
455 | }; | |
456 | ||
457 | #define TCA_ATM_MAX (__TCA_ATM_MAX - 1) | |
458 | ||
459 | /* Network emulator */ | |
460 | ||
d94d9fee | 461 | enum { |
1da177e4 LT |
462 | TCA_NETEM_UNSPEC, |
463 | TCA_NETEM_CORR, | |
464 | TCA_NETEM_DELAY_DIST, | |
0dca51d3 | 465 | TCA_NETEM_REORDER, |
c865e5d9 | 466 | TCA_NETEM_CORRUPT, |
1da177e4 LT |
467 | __TCA_NETEM_MAX, |
468 | }; | |
469 | ||
470 | #define TCA_NETEM_MAX (__TCA_NETEM_MAX - 1) | |
471 | ||
d94d9fee | 472 | struct tc_netem_qopt { |
1da177e4 LT |
473 | __u32 latency; /* added delay (us) */ |
474 | __u32 limit; /* fifo limit (packets) */ | |
475 | __u32 loss; /* random packet loss (0=none ~0=100%) */ | |
0dca51d3 | 476 | __u32 gap; /* re-ordering gap (0 for none) */ |
1da177e4 LT |
477 | __u32 duplicate; /* random packet dup (0=none ~0=100%) */ |
478 | __u32 jitter; /* random jitter in latency (us) */ | |
479 | }; | |
480 | ||
d94d9fee | 481 | struct tc_netem_corr { |
1da177e4 LT |
482 | __u32 delay_corr; /* delay correlation */ |
483 | __u32 loss_corr; /* packet loss correlation */ | |
484 | __u32 dup_corr; /* duplicate correlation */ | |
485 | }; | |
486 | ||
d94d9fee | 487 | struct tc_netem_reorder { |
0dca51d3 SH |
488 | __u32 probability; |
489 | __u32 correlation; | |
490 | }; | |
491 | ||
d94d9fee | 492 | struct tc_netem_corrupt { |
c865e5d9 SH |
493 | __u32 probability; |
494 | __u32 correlation; | |
495 | }; | |
496 | ||
1da177e4 LT |
497 | #define NETEM_DIST_SCALE 8192 |
498 | ||
13d2a1d2 PM |
499 | /* DRR */ |
500 | ||
d94d9fee | 501 | enum { |
13d2a1d2 PM |
502 | TCA_DRR_UNSPEC, |
503 | TCA_DRR_QUANTUM, | |
504 | __TCA_DRR_MAX | |
505 | }; | |
506 | ||
507 | #define TCA_DRR_MAX (__TCA_DRR_MAX - 1) | |
508 | ||
d94d9fee | 509 | struct tc_drr_stats { |
e672f7db | 510 | __u32 deficit; |
13d2a1d2 PM |
511 | }; |
512 | ||
b8970f0b JF |
513 | /* MQPRIO */ |
514 | #define TC_QOPT_BITMASK 15 | |
515 | #define TC_QOPT_MAX_QUEUE 16 | |
516 | ||
517 | struct tc_mqprio_qopt { | |
518 | __u8 num_tc; | |
519 | __u8 prio_tc_map[TC_QOPT_BITMASK + 1]; | |
520 | __u8 hw; | |
521 | __u16 count[TC_QOPT_MAX_QUEUE]; | |
522 | __u16 offset[TC_QOPT_MAX_QUEUE]; | |
523 | }; | |
524 | ||
1da177e4 | 525 | #endif |