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
;
185 #define TCA_TBF_MAX (__TCA_TBF_MAX - 1)
190 /* TEQL does not require any parameters */
195 unsigned quantum
; /* Bytes per round allocated to flow */
196 int perturb_period
; /* Period of hash perturbation */
197 __u32 limit
; /* Maximal packets in queue */
198 unsigned divisor
; /* Hash divisor */
199 unsigned flows
; /* Maximal number of flows */
202 struct tc_sfqred_stats
{
203 __u32 prob_drop
; /* Early drops, below max threshold */
204 __u32 forced_drop
; /* Early drops, after max threshold */
205 __u32 prob_mark
; /* Marked packets, below max threshold */
206 __u32 forced_mark
; /* Marked packets, after max threshold */
207 __u32 prob_mark_head
; /* Marked packets, below max threshold */
208 __u32 forced_mark_head
;/* Marked packets, after max threshold */
211 struct tc_sfq_qopt_v1
{
212 struct tc_sfq_qopt v0
;
213 unsigned int depth
; /* max number of packets per flow */
214 unsigned int headdrop
;
215 /* SFQRED parameters */
216 __u32 limit
; /* HARD maximal flow queue length (bytes) */
217 __u32 qth_min
; /* Min average length threshold (bytes) */
218 __u32 qth_max
; /* Max average length threshold (bytes) */
219 unsigned char Wlog
; /* log(W) */
220 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
221 unsigned char Scell_log
; /* cell size for idle damping */
223 __u32 max_P
; /* probability, high resolution */
225 struct tc_sfqred_stats stats
;
229 struct tc_sfq_xstats
{
243 #define TCA_RED_MAX (__TCA_RED_MAX - 1)
246 __u32 limit
; /* HARD maximal queue length (bytes) */
247 __u32 qth_min
; /* Min average length threshold (bytes) */
248 __u32 qth_max
; /* Max average length threshold (bytes) */
249 unsigned char Wlog
; /* log(W) */
250 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
251 unsigned char Scell_log
; /* cell size for idle damping */
254 #define TC_RED_HARDDROP 2
255 #define TC_RED_ADAPTATIVE 4
258 struct tc_red_xstats
{
259 __u32 early
; /* Early drops */
260 __u32 pdrop
; /* Drops due to queue limits */
261 __u32 other
; /* Drops due to drop() calls */
262 __u32 marked
; /* Marked packets */
279 #define TCA_GRED_MAX (__TCA_GRED_MAX - 1)
281 struct tc_gred_qopt
{
282 __u32 limit
; /* HARD maximal queue length (bytes) */
283 __u32 qth_min
; /* Min average length threshold (bytes) */
284 __u32 qth_max
; /* Max average length threshold (bytes) */
285 __u32 DP
; /* up to 2^32 DPs */
292 __u8 Wlog
; /* log(W) */
293 __u8 Plog
; /* log(P_max/(qth_max-qth_min)) */
294 __u8 Scell_log
; /* cell size for idle damping */
295 __u8 prio
; /* prio of this VQ */
301 struct tc_gred_sopt
{
319 #define TCA_CHOKE_MAX (__TCA_CHOKE_MAX - 1)
321 struct tc_choke_qopt
{
322 __u32 limit
; /* Hard queue length (packets) */
323 __u32 qth_min
; /* Min average threshold (packets) */
324 __u32 qth_max
; /* Max average threshold (packets) */
325 unsigned char Wlog
; /* log(W) */
326 unsigned char Plog
; /* log(P_max/(qth_max-qth_min)) */
327 unsigned char Scell_log
; /* cell size for idle damping */
328 unsigned char flags
; /* see RED flags */
331 struct tc_choke_xstats
{
332 __u32 early
; /* Early drops */
333 __u32 pdrop
; /* Drops due to queue limits */
334 __u32 other
; /* Drops due to drop() calls */
335 __u32 marked
; /* Marked packets */
336 __u32 matched
; /* Drops due to flow match */
340 #define TC_HTB_NUMPRIO 8
341 #define TC_HTB_MAXDEPTH 8
342 #define TC_HTB_PROTOVER 3 /* the same as HTB and TC's major */
345 struct tc_ratespec rate
;
346 struct tc_ratespec ceil
;
350 __u32 level
; /* out only */
354 __u32 version
; /* to match HTB/TC */
355 __u32 rate2quantum
; /* bps->quantum divisor */
356 __u32 defcls
; /* default class number */
357 __u32 debug
; /* debug flags */
360 __u32 direct_pkts
; /* count of non shaped packets */
374 #define TCA_HTB_MAX (__TCA_HTB_MAX - 1)
376 struct tc_htb_xstats
{
379 __u32 giants
; /* too big packets (rate will not be accurate) */
386 struct tc_hfsc_qopt
{
387 __u16 defcls
; /* default class */
390 struct tc_service_curve
{
391 __u32 m1
; /* slope of the first segment in bps */
392 __u32 d
; /* x-projection of the first segment in us */
393 __u32 m2
; /* slope of the second segment in bps */
396 struct tc_hfsc_stats
{
397 __u64 work
; /* total work done */
398 __u64 rtwork
; /* work done by real-time criteria */
399 __u32 period
; /* current period */
400 __u32 level
; /* class level in hierarchy */
411 #define TCA_HFSC_MAX (__TCA_HFSC_MAX - 1)
416 #define TC_CBQ_MAXPRIO 8
417 #define TC_CBQ_MAXLEVEL 8
418 #define TC_CBQ_DEF_EWMA 5
420 struct tc_cbq_lssopt
{
421 unsigned char change
;
423 #define TCF_CBQ_LSS_BOUNDED 1
424 #define TCF_CBQ_LSS_ISOLATED 2
425 unsigned char ewma_log
;
427 #define TCF_CBQ_LSS_FLAGS 1
428 #define TCF_CBQ_LSS_EWMA 2
429 #define TCF_CBQ_LSS_MAXIDLE 4
430 #define TCF_CBQ_LSS_MINIDLE 8
431 #define TCF_CBQ_LSS_OFFTIME 0x10
432 #define TCF_CBQ_LSS_AVPKT 0x20
439 struct tc_cbq_wrropt
{
441 unsigned char priority
;
442 unsigned char cpriority
;
443 unsigned char __reserved
;
449 unsigned char strategy
;
450 #define TC_CBQ_OVL_CLASSIC 0
451 #define TC_CBQ_OVL_DELAY 1
452 #define TC_CBQ_OVL_LOWPRIO 2
453 #define TC_CBQ_OVL_DROP 3
454 #define TC_CBQ_OVL_RCLASSIC 4
455 unsigned char priority2
;
460 struct tc_cbq_police
{
461 unsigned char police
;
462 unsigned char __res1
;
463 unsigned short __res2
;
472 struct tc_cbq_xstats
{
484 TCA_CBQ_OVL_STRATEGY
,
491 #define TCA_CBQ_MAX (__TCA_CBQ_MAX - 1)
498 TCA_DSMARK_DEFAULT_INDEX
,
499 TCA_DSMARK_SET_TC_INDEX
,
505 #define TCA_DSMARK_MAX (__TCA_DSMARK_MAX - 1)
511 TCA_ATM_FD
, /* file/socket descriptor */
512 TCA_ATM_PTR
, /* pointer to descriptor - later */
513 TCA_ATM_HDR
, /* LL header */
514 TCA_ATM_EXCESS
, /* excess traffic class (0 for CLP) */
515 TCA_ATM_ADDR
, /* PVC address (for output only) */
516 TCA_ATM_STATE
, /* VC state (ATM_VS_*; for output only) */
520 #define TCA_ATM_MAX (__TCA_ATM_MAX - 1)
522 /* Network emulator */
527 TCA_NETEM_DELAY_DIST
,
537 #define TCA_NETEM_MAX (__TCA_NETEM_MAX - 1)
539 struct tc_netem_qopt
{
540 __u32 latency
; /* added delay (us) */
541 __u32 limit
; /* fifo limit (packets) */
542 __u32 loss
; /* random packet loss (0=none ~0=100%) */
543 __u32 gap
; /* re-ordering gap (0 for none) */
544 __u32 duplicate
; /* random packet dup (0=none ~0=100%) */
545 __u32 jitter
; /* random jitter in latency (us) */
548 struct tc_netem_corr
{
549 __u32 delay_corr
; /* delay correlation */
550 __u32 loss_corr
; /* packet loss correlation */
551 __u32 dup_corr
; /* duplicate correlation */
554 struct tc_netem_reorder
{
559 struct tc_netem_corrupt
{
564 struct tc_netem_rate
{
565 __u32 rate
; /* byte/s */
566 __s32 packet_overhead
;
573 NETEM_LOSS_GI
, /* General Intuitive - 4 state model */
574 NETEM_LOSS_GE
, /* Gilbert Elliot models */
577 #define NETEM_LOSS_MAX (__NETEM_LOSS_MAX - 1)
579 /* State transition probabilities for 4 state model */
580 struct tc_netem_gimodel
{
588 /* Gilbert-Elliot models */
589 struct tc_netem_gemodel
{
596 #define NETEM_DIST_SCALE 8192
597 #define NETEM_DIST_MAX 16384
607 #define TCA_DRR_MAX (__TCA_DRR_MAX - 1)
609 struct tc_drr_stats
{
614 #define TC_QOPT_BITMASK 15
615 #define TC_QOPT_MAX_QUEUE 16
617 struct tc_mqprio_qopt
{
619 __u8 prio_tc_map
[TC_QOPT_BITMASK
+ 1];
621 __u16 count
[TC_QOPT_MAX_QUEUE
];
622 __u16 offset
[TC_QOPT_MAX_QUEUE
];
633 #define TCA_SFB_MAX (__TCA_SFB_MAX - 1)
636 * Note: increment, decrement are Q0.16 fixed-point values.
639 __u32 rehash_interval
; /* delay between hash move, in ms */
640 __u32 warmup_time
; /* double buffering warmup time in ms (warmup_time < rehash_interval) */
641 __u32 max
; /* max len of qlen_min */
642 __u32 bin_size
; /* maximum queue length per bin */
643 __u32 increment
; /* probability increment, (d1 in Blue) */
644 __u32 decrement
; /* probability decrement, (d2 in Blue) */
645 __u32 limit
; /* max SFB queue length */
646 __u32 penalty_rate
; /* inelastic flows are rate limited to 'rate' pps */
650 struct tc_sfb_xstats
{
655 __u32 childdrop
; /* drops in child qdisc */
662 #define SFB_MAX_PROB 0xFFFF
672 #define TCA_QFQ_MAX (__TCA_QFQ_MAX - 1)
674 struct tc_qfq_stats
{
687 TCA_CODEL_CE_THRESHOLD
,
691 #define TCA_CODEL_MAX (__TCA_CODEL_MAX - 1)
693 struct tc_codel_xstats
{
694 __u32 maxpacket
; /* largest packet we've seen so far */
695 __u32 count
; /* how many drops we've done since the last time we
696 * entered dropping state
698 __u32 lastcount
; /* count at entry to dropping state */
699 __u32 ldelay
; /* in-queue delay seen by most recently dequeued packet */
700 __s32 drop_next
; /* time to drop next packet */
701 __u32 drop_overlimit
; /* number of time max qdisc packet limit was hit */
702 __u32 ecn_mark
; /* number of packets we ECN marked instead of dropped */
703 __u32 dropping
; /* are we in dropping state ? */
704 __u32 ce_mark
; /* number of CE marked packets because of ce_threshold */
713 TCA_FQ_CODEL_INTERVAL
,
716 TCA_FQ_CODEL_QUANTUM
,
717 TCA_FQ_CODEL_CE_THRESHOLD
,
721 #define TCA_FQ_CODEL_MAX (__TCA_FQ_CODEL_MAX - 1)
724 TCA_FQ_CODEL_XSTATS_QDISC
,
725 TCA_FQ_CODEL_XSTATS_CLASS
,
728 struct tc_fq_codel_qd_stats
{
729 __u32 maxpacket
; /* largest packet we've seen so far */
730 __u32 drop_overlimit
; /* number of time max qdisc
731 * packet limit was hit
733 __u32 ecn_mark
; /* number of packets we ECN marked
734 * instead of being dropped
736 __u32 new_flow_count
; /* number of time packets
737 * created a 'new flow'
739 __u32 new_flows_len
; /* count of flows in new list */
740 __u32 old_flows_len
; /* count of flows in old list */
741 __u32 ce_mark
; /* packets above ce_threshold */
744 struct tc_fq_codel_cl_stats
{
746 __u32 ldelay
; /* in-queue delay seen by most recently
755 struct tc_fq_codel_xstats
{
758 struct tc_fq_codel_qd_stats qdisc_stats
;
759 struct tc_fq_codel_cl_stats class_stats
;
768 TCA_FQ_PLIMIT
, /* limit of total number of packets in queue */
770 TCA_FQ_FLOW_PLIMIT
, /* limit of packets per flow */
772 TCA_FQ_QUANTUM
, /* RR quantum */
774 TCA_FQ_INITIAL_QUANTUM
, /* RR quantum for new flow */
776 TCA_FQ_RATE_ENABLE
, /* enable/disable rate limiting */
778 TCA_FQ_FLOW_DEFAULT_RATE
,/* obsolete, do not use */
780 TCA_FQ_FLOW_MAX_RATE
, /* per flow max rate */
782 TCA_FQ_BUCKETS_LOG
, /* log2(number of buckets) */
784 TCA_FQ_FLOW_REFILL_DELAY
, /* flow credit refill delay in usec */
786 TCA_FQ_ORPHAN_MASK
, /* mask applied to orphaned skb hashes */
791 #define TCA_FQ_MAX (__TCA_FQ_MAX - 1)
793 struct tc_fq_qd_stats
{
795 __u64 highprio_packets
;
800 __u64 allocation_errors
;
801 __s64 time_next_delayed_flow
;
803 __u32 inactive_flows
;
804 __u32 throttled_flows
;
808 /* Heavy-Hitter Filter */
812 TCA_HHF_BACKLOG_LIMIT
,
814 TCA_HHF_HH_FLOWS_LIMIT
,
815 TCA_HHF_RESET_TIMEOUT
,
817 TCA_HHF_EVICT_TIMEOUT
,
818 TCA_HHF_NON_HH_WEIGHT
,
822 #define TCA_HHF_MAX (__TCA_HHF_MAX - 1)
824 struct tc_hhf_xstats
{
825 __u32 drop_overlimit
; /* number of times max qdisc packet limit
828 __u32 hh_overlimit
; /* number of times max heavy-hitters was hit */
829 __u32 hh_tot_count
; /* number of captured heavy-hitters so far */
830 __u32 hh_cur_count
; /* number of current heavy-hitters */
845 #define TCA_PIE_MAX (__TCA_PIE_MAX - 1)
847 struct tc_pie_xstats
{
848 __u32 prob
; /* current probability */
849 __u32 delay
; /* current delay in ms */
850 __u32 avg_dq_rate
; /* current average dq_rate in bits/pie_time */
851 __u32 packets_in
; /* total number of packets enqueued */
852 __u32 dropped
; /* packets dropped due to pie_action */
853 __u32 overlimit
; /* dropped due to lack of space in queue */
854 __u32 maxq
; /* maximum queue size */
855 __u32 ecn_mark
; /* packets marked with ecn*/