GNU Linux-libre 4.19.242-gnu1
[releases.git] / include / net / pkt_sched.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __NET_PKT_SCHED_H
3 #define __NET_PKT_SCHED_H
4
5 #include <linux/jiffies.h>
6 #include <linux/ktime.h>
7 #include <linux/if_vlan.h>
8 #include <linux/netdevice.h>
9 #include <net/sch_generic.h>
10 #include <net/net_namespace.h>
11 #include <uapi/linux/pkt_sched.h>
12
13 #define DEFAULT_TX_QUEUE_LEN    1000
14 #define STAB_SIZE_LOG_MAX       30
15
16 struct qdisc_walker {
17         int     stop;
18         int     skip;
19         int     count;
20         int     (*fn)(struct Qdisc *, unsigned long cl, struct qdisc_walker *);
21 };
22
23 #define QDISC_ALIGNTO           64
24 #define QDISC_ALIGN(len)        (((len) + QDISC_ALIGNTO-1) & ~(QDISC_ALIGNTO-1))
25
26 static inline void *qdisc_priv(struct Qdisc *q)
27 {
28         return (char *) q + QDISC_ALIGN(sizeof(struct Qdisc));
29 }
30
31 /* 
32    Timer resolution MUST BE < 10% of min_schedulable_packet_size/bandwidth
33    
34    Normal IP packet size ~ 512byte, hence:
35
36    0.5Kbyte/1Mbyte/sec = 0.5msec, so that we need 50usec timer for
37    10Mbit ethernet.
38
39    10msec resolution -> <50Kbit/sec.
40    
41    The result: [34]86 is not good choice for QoS router :-(
42
43    The things are not so bad, because we may use artificial
44    clock evaluated by integration of network data flow
45    in the most critical places.
46  */
47
48 typedef u64     psched_time_t;
49 typedef long    psched_tdiff_t;
50
51 /* Avoid doing 64 bit divide */
52 #define PSCHED_SHIFT                    6
53 #define PSCHED_TICKS2NS(x)              ((s64)(x) << PSCHED_SHIFT)
54 #define PSCHED_NS2TICKS(x)              ((x) >> PSCHED_SHIFT)
55
56 #define PSCHED_TICKS_PER_SEC            PSCHED_NS2TICKS(NSEC_PER_SEC)
57 #define PSCHED_PASTPERFECT              0
58
59 static inline psched_time_t psched_get_time(void)
60 {
61         return PSCHED_NS2TICKS(ktime_get_ns());
62 }
63
64 static inline psched_tdiff_t
65 psched_tdiff_bounded(psched_time_t tv1, psched_time_t tv2, psched_time_t bound)
66 {
67         return min(tv1 - tv2, bound);
68 }
69
70 struct qdisc_watchdog {
71         u64             last_expires;
72         struct hrtimer  timer;
73         struct Qdisc    *qdisc;
74 };
75
76 void qdisc_watchdog_init_clockid(struct qdisc_watchdog *wd, struct Qdisc *qdisc,
77                                  clockid_t clockid);
78 void qdisc_watchdog_init(struct qdisc_watchdog *wd, struct Qdisc *qdisc);
79 void qdisc_watchdog_schedule_ns(struct qdisc_watchdog *wd, u64 expires);
80
81 static inline void qdisc_watchdog_schedule(struct qdisc_watchdog *wd,
82                                            psched_time_t expires)
83 {
84         qdisc_watchdog_schedule_ns(wd, PSCHED_TICKS2NS(expires));
85 }
86
87 void qdisc_watchdog_cancel(struct qdisc_watchdog *wd);
88
89 extern struct Qdisc_ops pfifo_qdisc_ops;
90 extern struct Qdisc_ops bfifo_qdisc_ops;
91 extern struct Qdisc_ops pfifo_head_drop_qdisc_ops;
92
93 int fifo_set_limit(struct Qdisc *q, unsigned int limit);
94 struct Qdisc *fifo_create_dflt(struct Qdisc *sch, struct Qdisc_ops *ops,
95                                unsigned int limit,
96                                struct netlink_ext_ack *extack);
97
98 int register_qdisc(struct Qdisc_ops *qops);
99 int unregister_qdisc(struct Qdisc_ops *qops);
100 void qdisc_get_default(char *id, size_t len);
101 int qdisc_set_default(const char *id);
102
103 void qdisc_hash_add(struct Qdisc *q, bool invisible);
104 void qdisc_hash_del(struct Qdisc *q);
105 struct Qdisc *qdisc_lookup(struct net_device *dev, u32 handle);
106 struct Qdisc *qdisc_lookup_rcu(struct net_device *dev, u32 handle);
107 struct qdisc_rate_table *qdisc_get_rtab(struct tc_ratespec *r,
108                                         struct nlattr *tab,
109                                         struct netlink_ext_ack *extack);
110 void qdisc_put_rtab(struct qdisc_rate_table *tab);
111 void qdisc_put_stab(struct qdisc_size_table *tab);
112 void qdisc_warn_nonwc(const char *txt, struct Qdisc *qdisc);
113 bool sch_direct_xmit(struct sk_buff *skb, struct Qdisc *q,
114                      struct net_device *dev, struct netdev_queue *txq,
115                      spinlock_t *root_lock, bool validate);
116
117 void __qdisc_run(struct Qdisc *q);
118
119 static inline void qdisc_run(struct Qdisc *q)
120 {
121         if (qdisc_run_begin(q)) {
122                 __qdisc_run(q);
123                 qdisc_run_end(q);
124         }
125 }
126
127 /* Calculate maximal size of packet seen by hard_start_xmit
128    routine of this device.
129  */
130 static inline unsigned int psched_mtu(const struct net_device *dev)
131 {
132         return dev->mtu + dev->hard_header_len;
133 }
134
135 static inline struct net *qdisc_net(struct Qdisc *q)
136 {
137         return dev_net(q->dev_queue->dev);
138 }
139
140 struct tc_cbs_qopt_offload {
141         u8 enable;
142         s32 queue;
143         s32 hicredit;
144         s32 locredit;
145         s32 idleslope;
146         s32 sendslope;
147 };
148
149 struct tc_etf_qopt_offload {
150         u8 enable;
151         s32 queue;
152 };
153
154 #endif