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