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)
75 #define TC_H_CLSACT TC_H_INGRESS
77 #define TC_H_MIN_INGRESS 0xFFF2U
78 #define TC_H_MIN_EGRESS 0xFFF3U
80 /* Need to corrospond to iproute2 tc/tc_core.h "enum link_layer" */
82 TC_LINKLAYER_UNAWARE
, /* Indicate unaware old iproute2 util */
83 TC_LINKLAYER_ETHERNET
,
86 #define TC_LINKLAYER_MASK 0x0F /* limit use to lower 4 bits */
89 unsigned char cell_log
;
90 __u8 linklayer
; /* lower 4 bits */
91 unsigned short overhead
;
97 #define TC_RTAB_SIZE 1024
100 unsigned char cell_log
;
101 unsigned char size_log
;
104 unsigned int linklayer
;
117 #define TCA_STAB_MAX (__TCA_STAB_MAX - 1)
121 struct tc_fifo_qopt
{
122 __u32 limit
; /* Queue length: bytes for bfifo, packets for pfifo */
127 #define TCQ_PRIO_BANDS 16
128 #define TCQ_MIN_PRIO_BANDS 2
130 struct tc_prio_qopt
{
131 int bands
; /* Number of bands */
132 __u8 priomap
[TC_PRIO_MAX
+1]; /* Map: logical priority -> PRIO band */
137 struct tc_multiq_qopt
{
138 __u16 bands
; /* Number of bands */
139 __u16 max_bands
; /* Maximum number of queues */
144 #define TCQ_PLUG_BUFFER 0
145 #define TCQ_PLUG_RELEASE_ONE 1
146 #define TCQ_PLUG_RELEASE_INDEFINITE 2
147 #define TCQ_PLUG_LIMIT 3
149 struct tc_plug_qopt
{
150 /* TCQ_PLUG_BUFFER: Inset a plug into the queue and
151 * buffer any incoming packets
152 * TCQ_PLUG_RELEASE_ONE: Dequeue packets from queue head
153 * to beginning of the next plug.
154 * TCQ_PLUG_RELEASE_INDEFINITE: Dequeue all packets from queue.
155 * Stop buffering packets until the next TCQ_PLUG_BUFFER
156 * command is received (just act as a pass-thru queue).
157 * TCQ_PLUG_LIMIT: Increase/decrease queue size
166 struct tc_ratespec rate
;
167 struct tc_ratespec peakrate
;
186 #define TCA_TBF_MAX (__TCA_TBF_MAX - 1)
191 /* TEQL does not require any parameters */
196 unsigned quantum
; /* Bytes per round allocated to flow */
197 int perturb_period
; /* Period of hash perturbation */
198 __u32 limit
; /* Maximal packets in queue */
199 unsigned divisor
; /* Hash divisor */
200 unsigned flows
; /* Maximal number of flows */
203 struct tc_sfqred_stats
{
204 __u32 prob_drop
; /* Early drops, below max threshold */
205 __u32 forced_drop
; /* Early drops, after max threshold */
206 __u32 prob_mark
; /* Marked packets, below max threshold */
207 __u32 forced_mark
; /* Marked packets, after max threshold */
208 __u32 prob_mark_head
; /* Marked packets, below max threshold */
209 __u32 forced_mark_head
;/* Marked packets, after max threshold */
212 struct tc_sfq_qopt_v1
{
213 struct tc_sfq_qopt v0
;
214 unsigned int depth
; /* max number of packets per flow */
215 unsigned int headdrop
;
216 /* SFQRED parameters */
217 __u32 limit
; /* HARD maximal flow queue length (bytes) */
218 __u32 qth_min
; /* Min average length threshold (bytes) */
219 __u32 qth_max
; /* Max average length threshold (bytes) */
220 unsigned char Wlog
; /* log(W) */
221 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
222 unsigned char Scell_log
; /* cell size for idle damping */
224 __u32 max_P
; /* probability, high resolution */
226 struct tc_sfqred_stats stats
;
230 struct tc_sfq_xstats
{
244 #define TCA_RED_MAX (__TCA_RED_MAX - 1)
247 __u32 limit
; /* HARD maximal queue length (bytes) */
248 __u32 qth_min
; /* Min average length threshold (bytes) */
249 __u32 qth_max
; /* Max average length threshold (bytes) */
250 unsigned char Wlog
; /* log(W) */
251 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
252 unsigned char Scell_log
; /* cell size for idle damping */
255 #define TC_RED_HARDDROP 2
256 #define TC_RED_ADAPTATIVE 4
259 struct tc_red_xstats
{
260 __u32 early
; /* Early drops */
261 __u32 pdrop
; /* Drops due to queue limits */
262 __u32 other
; /* Drops due to drop() calls */
263 __u32 marked
; /* Marked packets */
280 #define TCA_GRED_MAX (__TCA_GRED_MAX - 1)
282 struct tc_gred_qopt
{
283 __u32 limit
; /* HARD maximal queue length (bytes) */
284 __u32 qth_min
; /* Min average length threshold (bytes) */
285 __u32 qth_max
; /* Max average length threshold (bytes) */
286 __u32 DP
; /* up to 2^32 DPs */
293 __u8 Wlog
; /* log(W) */
294 __u8 Plog
; /* log(P_max/(qth_max-qth_min)) */
295 __u8 Scell_log
; /* cell size for idle damping */
296 __u8 prio
; /* prio of this VQ */
302 struct tc_gred_sopt
{
320 #define TCA_CHOKE_MAX (__TCA_CHOKE_MAX - 1)
322 struct tc_choke_qopt
{
323 __u32 limit
; /* Hard queue length (packets) */
324 __u32 qth_min
; /* Min average threshold (packets) */
325 __u32 qth_max
; /* Max average threshold (packets) */
326 unsigned char Wlog
; /* log(W) */
327 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
328 unsigned char Scell_log
; /* cell size for idle damping */
329 unsigned char flags
; /* see RED flags */
332 struct tc_choke_xstats
{
333 __u32 early
; /* Early drops */
334 __u32 pdrop
; /* Drops due to queue limits */
335 __u32 other
; /* Drops due to drop() calls */
336 __u32 marked
; /* Marked packets */
337 __u32 matched
; /* Drops due to flow match */
341 #define TC_HTB_NUMPRIO 8
342 #define TC_HTB_MAXDEPTH 8
343 #define TC_HTB_PROTOVER 3 /* the same as HTB and TC's major */
346 struct tc_ratespec rate
;
347 struct tc_ratespec ceil
;
351 __u32 level
; /* out only */
355 __u32 version
; /* to match HTB/TC */
356 __u32 rate2quantum
; /* bps->quantum divisor */
357 __u32 defcls
; /* default class number */
358 __u32 debug
; /* debug flags */
361 __u32 direct_pkts
; /* count of non shaped packets */
376 #define TCA_HTB_MAX (__TCA_HTB_MAX - 1)
378 struct tc_htb_xstats
{
381 __u32 giants
; /* too big packets (rate will not be accurate) */
388 struct tc_hfsc_qopt
{
389 __u16 defcls
; /* default class */
392 struct tc_service_curve
{
393 __u32 m1
; /* slope of the first segment in bps */
394 __u32 d
; /* x-projection of the first segment in us */
395 __u32 m2
; /* slope of the second segment in bps */
398 struct tc_hfsc_stats
{
399 __u64 work
; /* total work done */
400 __u64 rtwork
; /* work done by real-time criteria */
401 __u32 period
; /* current period */
402 __u32 level
; /* class level in hierarchy */
413 #define TCA_HFSC_MAX (__TCA_HFSC_MAX - 1)
418 #define TC_CBQ_MAXPRIO 8
419 #define TC_CBQ_MAXLEVEL 8
420 #define TC_CBQ_DEF_EWMA 5
422 struct tc_cbq_lssopt
{
423 unsigned char change
;
425 #define TCF_CBQ_LSS_BOUNDED 1
426 #define TCF_CBQ_LSS_ISOLATED 2
427 unsigned char ewma_log
;
429 #define TCF_CBQ_LSS_FLAGS 1
430 #define TCF_CBQ_LSS_EWMA 2
431 #define TCF_CBQ_LSS_MAXIDLE 4
432 #define TCF_CBQ_LSS_MINIDLE 8
433 #define TCF_CBQ_LSS_OFFTIME 0x10
434 #define TCF_CBQ_LSS_AVPKT 0x20
441 struct tc_cbq_wrropt
{
443 unsigned char priority
;
444 unsigned char cpriority
;
445 unsigned char __reserved
;
451 unsigned char strategy
;
452 #define TC_CBQ_OVL_CLASSIC 0
453 #define TC_CBQ_OVL_DELAY 1
454 #define TC_CBQ_OVL_LOWPRIO 2
455 #define TC_CBQ_OVL_DROP 3
456 #define TC_CBQ_OVL_RCLASSIC 4
457 unsigned char priority2
;
462 struct tc_cbq_police
{
463 unsigned char police
;
464 unsigned char __res1
;
465 unsigned short __res2
;
474 struct tc_cbq_xstats
{
486 TCA_CBQ_OVL_STRATEGY
,
493 #define TCA_CBQ_MAX (__TCA_CBQ_MAX - 1)
500 TCA_DSMARK_DEFAULT_INDEX
,
501 TCA_DSMARK_SET_TC_INDEX
,
507 #define TCA_DSMARK_MAX (__TCA_DSMARK_MAX - 1)
513 TCA_ATM_FD
, /* file/socket descriptor */
514 TCA_ATM_PTR
, /* pointer to descriptor - later */
515 TCA_ATM_HDR
, /* LL header */
516 TCA_ATM_EXCESS
, /* excess traffic class (0 for CLP) */
517 TCA_ATM_ADDR
, /* PVC address (for output only) */
518 TCA_ATM_STATE
, /* VC state (ATM_VS_*; for output only) */
522 #define TCA_ATM_MAX (__TCA_ATM_MAX - 1)
524 /* Network emulator */
529 TCA_NETEM_DELAY_DIST
,
540 #define TCA_NETEM_MAX (__TCA_NETEM_MAX - 1)
542 struct tc_netem_qopt
{
543 __u32 latency
; /* added delay (us) */
544 __u32 limit
; /* fifo limit (packets) */
545 __u32 loss
; /* random packet loss (0=none ~0=100%) */
546 __u32 gap
; /* re-ordering gap (0 for none) */
547 __u32 duplicate
; /* random packet dup (0=none ~0=100%) */
548 __u32 jitter
; /* random jitter in latency (us) */
551 struct tc_netem_corr
{
552 __u32 delay_corr
; /* delay correlation */
553 __u32 loss_corr
; /* packet loss correlation */
554 __u32 dup_corr
; /* duplicate correlation */
557 struct tc_netem_reorder
{
562 struct tc_netem_corrupt
{
567 struct tc_netem_rate
{
568 __u32 rate
; /* byte/s */
569 __s32 packet_overhead
;
576 NETEM_LOSS_GI
, /* General Intuitive - 4 state model */
577 NETEM_LOSS_GE
, /* Gilbert Elliot models */
580 #define NETEM_LOSS_MAX (__NETEM_LOSS_MAX - 1)
582 /* State transition probabilities for 4 state model */
583 struct tc_netem_gimodel
{
591 /* Gilbert-Elliot models */
592 struct tc_netem_gemodel
{
599 #define NETEM_DIST_SCALE 8192
600 #define NETEM_DIST_MAX 16384
610 #define TCA_DRR_MAX (__TCA_DRR_MAX - 1)
612 struct tc_drr_stats
{
617 #define TC_QOPT_BITMASK 15
618 #define TC_QOPT_MAX_QUEUE 16
620 struct tc_mqprio_qopt
{
622 __u8 prio_tc_map
[TC_QOPT_BITMASK
+ 1];
624 __u16 count
[TC_QOPT_MAX_QUEUE
];
625 __u16 offset
[TC_QOPT_MAX_QUEUE
];
636 #define TCA_SFB_MAX (__TCA_SFB_MAX - 1)
639 * Note: increment, decrement are Q0.16 fixed-point values.
642 __u32 rehash_interval
; /* delay between hash move, in ms */
643 __u32 warmup_time
; /* double buffering warmup time in ms (warmup_time < rehash_interval) */
644 __u32 max
; /* max len of qlen_min */
645 __u32 bin_size
; /* maximum queue length per bin */
646 __u32 increment
; /* probability increment, (d1 in Blue) */
647 __u32 decrement
; /* probability decrement, (d2 in Blue) */
648 __u32 limit
; /* max SFB queue length */
649 __u32 penalty_rate
; /* inelastic flows are rate limited to 'rate' pps */
653 struct tc_sfb_xstats
{
658 __u32 childdrop
; /* drops in child qdisc */
665 #define SFB_MAX_PROB 0xFFFF
675 #define TCA_QFQ_MAX (__TCA_QFQ_MAX - 1)
677 struct tc_qfq_stats
{
690 TCA_CODEL_CE_THRESHOLD
,
694 #define TCA_CODEL_MAX (__TCA_CODEL_MAX - 1)
696 struct tc_codel_xstats
{
697 __u32 maxpacket
; /* largest packet we've seen so far */
698 __u32 count
; /* how many drops we've done since the last time we
699 * entered dropping state
701 __u32 lastcount
; /* count at entry to dropping state */
702 __u32 ldelay
; /* in-queue delay seen by most recently dequeued packet */
703 __s32 drop_next
; /* time to drop next packet */
704 __u32 drop_overlimit
; /* number of time max qdisc packet limit was hit */
705 __u32 ecn_mark
; /* number of packets we ECN marked instead of dropped */
706 __u32 dropping
; /* are we in dropping state ? */
707 __u32 ce_mark
; /* number of CE marked packets because of ce_threshold */
716 TCA_FQ_CODEL_INTERVAL
,
719 TCA_FQ_CODEL_QUANTUM
,
720 TCA_FQ_CODEL_CE_THRESHOLD
,
721 TCA_FQ_CODEL_DROP_BATCH_SIZE
,
722 TCA_FQ_CODEL_MEMORY_LIMIT
,
726 #define TCA_FQ_CODEL_MAX (__TCA_FQ_CODEL_MAX - 1)
729 TCA_FQ_CODEL_XSTATS_QDISC
,
730 TCA_FQ_CODEL_XSTATS_CLASS
,
733 struct tc_fq_codel_qd_stats
{
734 __u32 maxpacket
; /* largest packet we've seen so far */
735 __u32 drop_overlimit
; /* number of time max qdisc
736 * packet limit was hit
738 __u32 ecn_mark
; /* number of packets we ECN marked
739 * instead of being dropped
741 __u32 new_flow_count
; /* number of time packets
742 * created a 'new flow'
744 __u32 new_flows_len
; /* count of flows in new list */
745 __u32 old_flows_len
; /* count of flows in old list */
746 __u32 ce_mark
; /* packets above ce_threshold */
747 __u32 memory_usage
; /* in bytes */
748 __u32 drop_overmemory
;
751 struct tc_fq_codel_cl_stats
{
753 __u32 ldelay
; /* in-queue delay seen by most recently
762 struct tc_fq_codel_xstats
{
765 struct tc_fq_codel_qd_stats qdisc_stats
;
766 struct tc_fq_codel_cl_stats class_stats
;
775 TCA_FQ_PLIMIT
, /* limit of total number of packets in queue */
777 TCA_FQ_FLOW_PLIMIT
, /* limit of packets per flow */
779 TCA_FQ_QUANTUM
, /* RR quantum */
781 TCA_FQ_INITIAL_QUANTUM
, /* RR quantum for new flow */
783 TCA_FQ_RATE_ENABLE
, /* enable/disable rate limiting */
785 TCA_FQ_FLOW_DEFAULT_RATE
,/* obsolete, do not use */
787 TCA_FQ_FLOW_MAX_RATE
, /* per flow max rate */
789 TCA_FQ_BUCKETS_LOG
, /* log2(number of buckets) */
791 TCA_FQ_FLOW_REFILL_DELAY
, /* flow credit refill delay in usec */
793 TCA_FQ_ORPHAN_MASK
, /* mask applied to orphaned skb hashes */
798 #define TCA_FQ_MAX (__TCA_FQ_MAX - 1)
800 struct tc_fq_qd_stats
{
802 __u64 highprio_packets
;
807 __u64 allocation_errors
;
808 __s64 time_next_delayed_flow
;
810 __u32 inactive_flows
;
811 __u32 throttled_flows
;
815 /* Heavy-Hitter Filter */
819 TCA_HHF_BACKLOG_LIMIT
,
821 TCA_HHF_HH_FLOWS_LIMIT
,
822 TCA_HHF_RESET_TIMEOUT
,
824 TCA_HHF_EVICT_TIMEOUT
,
825 TCA_HHF_NON_HH_WEIGHT
,
829 #define TCA_HHF_MAX (__TCA_HHF_MAX - 1)
831 struct tc_hhf_xstats
{
832 __u32 drop_overlimit
; /* number of times max qdisc packet limit
835 __u32 hh_overlimit
; /* number of times max heavy-hitters was hit */
836 __u32 hh_tot_count
; /* number of captured heavy-hitters so far */
837 __u32 hh_cur_count
; /* number of current heavy-hitters */
852 #define TCA_PIE_MAX (__TCA_PIE_MAX - 1)
854 struct tc_pie_xstats
{
855 __u32 prob
; /* current probability */
856 __u32 delay
; /* current delay in ms */
857 __u32 avg_dq_rate
; /* current average dq_rate in bits/pie_time */
858 __u32 packets_in
; /* total number of packets enqueued */
859 __u32 dropped
; /* packets dropped due to pie_action */
860 __u32 overlimit
; /* dropped due to lack of space in queue */
861 __u32 maxq
; /* maximum queue size */
862 __u32 ecn_mark
; /* packets marked with ecn*/