1 #ifndef __LINUX_PKT_SCHED_H
2 #define __LINUX_PKT_SCHED_H
4 #include <linux/types.h>
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.
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.
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
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
26 #define TC_PRIO_MAX 15
28 /* Generic queue statistics, available for all the elements.
29 Particular schedulers may have also their private records.
33 __u64 bytes; /* Number of enqueued 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 */
46 unsigned char ewma_log;
52 All the traffic control objects have 32bit identifiers, or "handles".
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.
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.
63 Macros to manipulate handles:
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))
72 #define TC_H_UNSPEC (0U)
73 #define TC_H_ROOT (0xFFFFFFFFU)
74 #define TC_H_INGRESS (0xFFFFFFF1U)
76 /* Need to corrospond to iproute2 tc/tc_core.h "enum link_layer" */
78 TC_LINKLAYER_UNAWARE, /* Indicate unaware old iproute2 util */
79 TC_LINKLAYER_ETHERNET,
82 #define TC_LINKLAYER_MASK 0x0F /* limit use to lower 4 bits */
85 unsigned char cell_log;
86 __u8 linklayer; /* lower 4 bits */
87 unsigned short overhead;
93 #define TC_RTAB_SIZE 1024
96 unsigned char cell_log;
97 unsigned char size_log;
100 unsigned int linklayer;
113 #define TCA_STAB_MAX (__TCA_STAB_MAX - 1)
117 struct tc_fifo_qopt {
118 __u32 limit; /* Queue length: bytes for bfifo, packets for pfifo */
123 #define TCQ_PRIO_BANDS 16
124 #define TCQ_MIN_PRIO_BANDS 2
126 struct tc_prio_qopt {
127 int bands; /* Number of bands */
128 __u8 priomap[TC_PRIO_MAX+1]; /* Map: logical priority -> PRIO band */
133 struct tc_multiq_qopt {
134 __u16 bands; /* Number of bands */
135 __u16 max_bands; /* Maximum number of queues */
140 #define TCQ_PLUG_BUFFER 0
141 #define TCQ_PLUG_RELEASE_ONE 1
142 #define TCQ_PLUG_RELEASE_INDEFINITE 2
143 #define TCQ_PLUG_LIMIT 3
145 struct tc_plug_qopt {
146 /* TCQ_PLUG_BUFFER: Inset a plug into the queue and
147 * buffer any incoming packets
148 * TCQ_PLUG_RELEASE_ONE: Dequeue packets from queue head
149 * to beginning of the next plug.
150 * TCQ_PLUG_RELEASE_INDEFINITE: Dequeue all packets from queue.
151 * Stop buffering packets until the next TCQ_PLUG_BUFFER
152 * command is received (just act as a pass-thru queue).
153 * TCQ_PLUG_LIMIT: Increase/decrease queue size
162 struct tc_ratespec rate;
163 struct tc_ratespec peakrate;
181 #define TCA_TBF_MAX (__TCA_TBF_MAX - 1)
186 /* TEQL does not require any parameters */
191 unsigned quantum; /* Bytes per round allocated to flow */
192 int perturb_period; /* Period of hash perturbation */
193 __u32 limit; /* Maximal packets in queue */
194 unsigned divisor; /* Hash divisor */
195 unsigned flows; /* Maximal number of flows */
198 struct tc_sfqred_stats {
199 __u32 prob_drop; /* Early drops, below max threshold */
200 __u32 forced_drop; /* Early drops, after max threshold */
201 __u32 prob_mark; /* Marked packets, below max threshold */
202 __u32 forced_mark; /* Marked packets, after max threshold */
203 __u32 prob_mark_head; /* Marked packets, below max threshold */
204 __u32 forced_mark_head;/* Marked packets, after max threshold */
207 struct tc_sfq_qopt_v1 {
208 struct tc_sfq_qopt v0;
209 unsigned int depth; /* max number of packets per flow */
210 unsigned int headdrop;
211 /* SFQRED parameters */
212 __u32 limit; /* HARD maximal flow queue length (bytes) */
213 __u32 qth_min; /* Min average length threshold (bytes) */
214 __u32 qth_max; /* Max average length threshold (bytes) */
215 unsigned char Wlog; /* log(W) */
216 unsigned char Plog; /* log(P_max/(qth_max-qth_min)) */
217 unsigned char Scell_log; /* cell size for idle damping */
219 __u32 max_P; /* probability, high resolution */
221 struct tc_sfqred_stats stats;
225 struct tc_sfq_xstats {
239 #define TCA_RED_MAX (__TCA_RED_MAX - 1)
242 __u32 limit; /* HARD maximal queue length (bytes) */
243 __u32 qth_min; /* Min average length threshold (bytes) */
244 __u32 qth_max; /* Max average length threshold (bytes) */
245 unsigned char Wlog; /* log(W) */
246 unsigned char Plog; /* log(P_max/(qth_max-qth_min)) */
247 unsigned char Scell_log; /* cell size for idle damping */
250 #define TC_RED_HARDDROP 2
251 #define TC_RED_ADAPTATIVE 4
254 struct tc_red_xstats {
255 __u32 early; /* Early drops */
256 __u32 pdrop; /* Drops due to queue limits */
257 __u32 other; /* Drops due to drop() calls */
258 __u32 marked; /* Marked packets */
275 #define TCA_GRED_MAX (__TCA_GRED_MAX - 1)
277 struct tc_gred_qopt {
278 __u32 limit; /* HARD maximal queue length (bytes) */
279 __u32 qth_min; /* Min average length threshold (bytes) */
280 __u32 qth_max; /* Max average length threshold (bytes) */
281 __u32 DP; /* up to 2^32 DPs */
288 __u8 Wlog; /* log(W) */
289 __u8 Plog; /* log(P_max/(qth_max-qth_min)) */
290 __u8 Scell_log; /* cell size for idle damping */
291 __u8 prio; /* prio of this VQ */
297 struct tc_gred_sopt {
315 #define TCA_CHOKE_MAX (__TCA_CHOKE_MAX - 1)
317 struct tc_choke_qopt {
318 __u32 limit; /* Hard queue length (packets) */
319 __u32 qth_min; /* Min average threshold (packets) */
320 __u32 qth_max; /* Max average threshold (packets) */
321 unsigned char Wlog; /* log(W) */
322 unsigned char Plog; /* log(P_max/(qth_max-qth_min)) */
323 unsigned char Scell_log; /* cell size for idle damping */
324 unsigned char flags; /* see RED flags */
327 struct tc_choke_xstats {
328 __u32 early; /* Early drops */
329 __u32 pdrop; /* Drops due to queue limits */
330 __u32 other; /* Drops due to drop() calls */
331 __u32 marked; /* Marked packets */
332 __u32 matched; /* Drops due to flow match */
336 #define TC_HTB_NUMPRIO 8
337 #define TC_HTB_MAXDEPTH 8
338 #define TC_HTB_PROTOVER 3 /* the same as HTB and TC's major */
341 struct tc_ratespec rate;
342 struct tc_ratespec ceil;
346 __u32 level; /* out only */
350 __u32 version; /* to match HTB/TC */
351 __u32 rate2quantum; /* bps->quantum divisor */
352 __u32 defcls; /* default class number */
353 __u32 debug; /* debug flags */
356 __u32 direct_pkts; /* count of non shaped packets */
370 #define TCA_HTB_MAX (__TCA_HTB_MAX - 1)
372 struct tc_htb_xstats {
375 __u32 giants; /* too big packets (rate will not be accurate) */
382 struct tc_hfsc_qopt {
383 __u16 defcls; /* default class */
386 struct tc_service_curve {
387 __u32 m1; /* slope of the first segment in bps */
388 __u32 d; /* x-projection of the first segment in us */
389 __u32 m2; /* slope of the second segment in bps */
392 struct tc_hfsc_stats {
393 __u64 work; /* total work done */
394 __u64 rtwork; /* work done by real-time criteria */
395 __u32 period; /* current period */
396 __u32 level; /* class level in hierarchy */
407 #define TCA_HFSC_MAX (__TCA_HFSC_MAX - 1)
412 #define TC_CBQ_MAXPRIO 8
413 #define TC_CBQ_MAXLEVEL 8
414 #define TC_CBQ_DEF_EWMA 5
416 struct tc_cbq_lssopt {
417 unsigned char change;
419 #define TCF_CBQ_LSS_BOUNDED 1
420 #define TCF_CBQ_LSS_ISOLATED 2
421 unsigned char ewma_log;
423 #define TCF_CBQ_LSS_FLAGS 1
424 #define TCF_CBQ_LSS_EWMA 2
425 #define TCF_CBQ_LSS_MAXIDLE 4
426 #define TCF_CBQ_LSS_MINIDLE 8
427 #define TCF_CBQ_LSS_OFFTIME 0x10
428 #define TCF_CBQ_LSS_AVPKT 0x20
435 struct tc_cbq_wrropt {
437 unsigned char priority;
438 unsigned char cpriority;
439 unsigned char __reserved;
445 unsigned char strategy;
446 #define TC_CBQ_OVL_CLASSIC 0
447 #define TC_CBQ_OVL_DELAY 1
448 #define TC_CBQ_OVL_LOWPRIO 2
449 #define TC_CBQ_OVL_DROP 3
450 #define TC_CBQ_OVL_RCLASSIC 4
451 unsigned char priority2;
456 struct tc_cbq_police {
457 unsigned char police;
458 unsigned char __res1;
459 unsigned short __res2;
468 struct tc_cbq_xstats {
480 TCA_CBQ_OVL_STRATEGY,
487 #define TCA_CBQ_MAX (__TCA_CBQ_MAX - 1)
494 TCA_DSMARK_DEFAULT_INDEX,
495 TCA_DSMARK_SET_TC_INDEX,
501 #define TCA_DSMARK_MAX (__TCA_DSMARK_MAX - 1)
507 TCA_ATM_FD, /* file/socket descriptor */
508 TCA_ATM_PTR, /* pointer to descriptor - later */
509 TCA_ATM_HDR, /* LL header */
510 TCA_ATM_EXCESS, /* excess traffic class (0 for CLP) */
511 TCA_ATM_ADDR, /* PVC address (for output only) */
512 TCA_ATM_STATE, /* VC state (ATM_VS_*; for output only) */
516 #define TCA_ATM_MAX (__TCA_ATM_MAX - 1)
518 /* Network emulator */
523 TCA_NETEM_DELAY_DIST,
533 #define TCA_NETEM_MAX (__TCA_NETEM_MAX - 1)
535 struct tc_netem_qopt {
536 __u32 latency; /* added delay (us) */
537 __u32 limit; /* fifo limit (packets) */
538 __u32 loss; /* random packet loss (0=none ~0=100%) */
539 __u32 gap; /* re-ordering gap (0 for none) */
540 __u32 duplicate; /* random packet dup (0=none ~0=100%) */
541 __u32 jitter; /* random jitter in latency (us) */
544 struct tc_netem_corr {
545 __u32 delay_corr; /* delay correlation */
546 __u32 loss_corr; /* packet loss correlation */
547 __u32 dup_corr; /* duplicate correlation */
550 struct tc_netem_reorder {
555 struct tc_netem_corrupt {
560 struct tc_netem_rate {
561 __u32 rate; /* byte/s */
562 __s32 packet_overhead;
569 NETEM_LOSS_GI, /* General Intuitive - 4 state model */
570 NETEM_LOSS_GE, /* Gilbert Elliot models */
573 #define NETEM_LOSS_MAX (__NETEM_LOSS_MAX - 1)
575 /* State transition probabilities for 4 state model */
576 struct tc_netem_gimodel {
584 /* Gilbert-Elliot models */
585 struct tc_netem_gemodel {
592 #define NETEM_DIST_SCALE 8192
593 #define NETEM_DIST_MAX 16384
603 #define TCA_DRR_MAX (__TCA_DRR_MAX - 1)
605 struct tc_drr_stats {
610 #define TC_QOPT_BITMASK 15
611 #define TC_QOPT_MAX_QUEUE 16
613 struct tc_mqprio_qopt {
615 __u8 prio_tc_map[TC_QOPT_BITMASK + 1];
617 __u16 count[TC_QOPT_MAX_QUEUE];
618 __u16 offset[TC_QOPT_MAX_QUEUE];
629 #define TCA_SFB_MAX (__TCA_SFB_MAX - 1)
632 * Note: increment, decrement are Q0.16 fixed-point values.
635 __u32 rehash_interval; /* delay between hash move, in ms */
636 __u32 warmup_time; /* double buffering warmup time in ms (warmup_time < rehash_interval) */
637 __u32 max; /* max len of qlen_min */
638 __u32 bin_size; /* maximum queue length per bin */
639 __u32 increment; /* probability increment, (d1 in Blue) */
640 __u32 decrement; /* probability decrement, (d2 in Blue) */
641 __u32 limit; /* max SFB queue length */
642 __u32 penalty_rate; /* inelastic flows are rate limited to 'rate' pps */
646 struct tc_sfb_xstats {
651 __u32 childdrop; /* drops in child qdisc */
658 #define SFB_MAX_PROB 0xFFFF
668 #define TCA_QFQ_MAX (__TCA_QFQ_MAX - 1)
670 struct tc_qfq_stats {
683 TCA_CODEL_CE_THRESHOLD,
687 #define TCA_CODEL_MAX (__TCA_CODEL_MAX - 1)
689 struct tc_codel_xstats {
690 __u32 maxpacket; /* largest packet we've seen so far */
691 __u32 count; /* how many drops we've done since the last time we
692 * entered dropping state
694 __u32 lastcount; /* count at entry to dropping state */
695 __u32 ldelay; /* in-queue delay seen by most recently dequeued packet */
696 __s32 drop_next; /* time to drop next packet */
697 __u32 drop_overlimit; /* number of time max qdisc packet limit was hit */
698 __u32 ecn_mark; /* number of packets we ECN marked instead of dropped */
699 __u32 dropping; /* are we in dropping state ? */
700 __u32 ce_mark; /* number of CE marked packets because of ce_threshold */
709 TCA_FQ_CODEL_INTERVAL,
712 TCA_FQ_CODEL_QUANTUM,
713 TCA_FQ_CODEL_CE_THRESHOLD,
717 #define TCA_FQ_CODEL_MAX (__TCA_FQ_CODEL_MAX - 1)
720 TCA_FQ_CODEL_XSTATS_QDISC,
721 TCA_FQ_CODEL_XSTATS_CLASS,
724 struct tc_fq_codel_qd_stats {
725 __u32 maxpacket; /* largest packet we've seen so far */
726 __u32 drop_overlimit; /* number of time max qdisc
727 * packet limit was hit
729 __u32 ecn_mark; /* number of packets we ECN marked
730 * instead of being dropped
732 __u32 new_flow_count; /* number of time packets
733 * created a 'new flow'
735 __u32 new_flows_len; /* count of flows in new list */
736 __u32 old_flows_len; /* count of flows in old list */
737 __u32 ce_mark; /* packets above ce_threshold */
740 struct tc_fq_codel_cl_stats {
742 __u32 ldelay; /* in-queue delay seen by most recently
751 struct tc_fq_codel_xstats {
754 struct tc_fq_codel_qd_stats qdisc_stats;
755 struct tc_fq_codel_cl_stats class_stats;
764 TCA_FQ_PLIMIT, /* limit of total number of packets in queue */
766 TCA_FQ_FLOW_PLIMIT, /* limit of packets per flow */
768 TCA_FQ_QUANTUM, /* RR quantum */
770 TCA_FQ_INITIAL_QUANTUM, /* RR quantum for new flow */
772 TCA_FQ_RATE_ENABLE, /* enable/disable rate limiting */
774 TCA_FQ_FLOW_DEFAULT_RATE,/* obsolete, do not use */
776 TCA_FQ_FLOW_MAX_RATE, /* per flow max rate */
778 TCA_FQ_BUCKETS_LOG, /* log2(number of buckets) */
780 TCA_FQ_FLOW_REFILL_DELAY, /* flow credit refill delay in usec */
782 TCA_FQ_ORPHAN_MASK, /* mask applied to orphaned skb hashes */
787 #define TCA_FQ_MAX (__TCA_FQ_MAX - 1)
789 struct tc_fq_qd_stats {
791 __u64 highprio_packets;
796 __u64 allocation_errors;
797 __s64 time_next_delayed_flow;
799 __u32 inactive_flows;
800 __u32 throttled_flows;
804 /* Heavy-Hitter Filter */
808 TCA_HHF_BACKLOG_LIMIT,
810 TCA_HHF_HH_FLOWS_LIMIT,
811 TCA_HHF_RESET_TIMEOUT,
813 TCA_HHF_EVICT_TIMEOUT,
814 TCA_HHF_NON_HH_WEIGHT,
818 #define TCA_HHF_MAX (__TCA_HHF_MAX - 1)
820 struct tc_hhf_xstats {
821 __u32 drop_overlimit; /* number of times max qdisc packet limit
824 __u32 hh_overlimit; /* number of times max heavy-hitters was hit */
825 __u32 hh_tot_count; /* number of captured heavy-hitters so far */
826 __u32 hh_cur_count; /* number of current heavy-hitters */
841 #define TCA_PIE_MAX (__TCA_PIE_MAX - 1)
843 struct tc_pie_xstats {
844 __u32 prob; /* current probability */
845 __u32 delay; /* current delay in ms */
846 __u32 avg_dq_rate; /* current average dq_rate in bits/pie_time */
847 __u32 packets_in; /* total number of packets enqueued */
848 __u32 dropped; /* packets dropped due to pie_action */
849 __u32 overlimit; /* dropped due to lack of space in queue */
850 __u32 maxq; /* maximum queue size */
851 __u32 ecn_mark; /* packets marked with ecn*/