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 static inline void *qdisc_priv(struct Qdisc *q)
  24 {
  25         return &q->privdata;
  26 }
  27
  28 static inline struct Qdisc *qdisc_from_priv(void *priv)
  29 {
  30         return container_of(priv, struct Qdisc, privdata);
  31 }
  32
  33 /*
  34    Timer resolution MUST BE < 10% of min_schedulable_packet_size/bandwidth
  35
  36    Normal IP packet size ~ 512byte, hence:
  37
  38    0.5Kbyte/1Mbyte/sec = 0.5msec, so that we need 50usec timer for
  39    10Mbit ethernet.
  40
  41    10msec resolution -> <50Kbit/sec.
  42
  43    The result: [34]86 is not good choice for QoS router :-(
  44
  45    The things are not so bad, because we may use artificial
  46    clock evaluated by integration of network data flow
  47    in the most critical places.
  48  */
  49
  50 typedef u64     psched_time_t;
  51 typedef long    psched_tdiff_t;
  52
  53 /* Avoid doing 64 bit divide */
  54 #define PSCHED_SHIFT                    6
  55 #define PSCHED_TICKS2NS(x)              ((s64)(x) << PSCHED_SHIFT)
  56 #define PSCHED_NS2TICKS(x)              ((x) >> PSCHED_SHIFT)
  57
  58 #define PSCHED_TICKS_PER_SEC            PSCHED_NS2TICKS(NSEC_PER_SEC)
  59 #define PSCHED_PASTPERFECT              0
  60
  61 static inline psched_time_t psched_get_time(void)
  62 {
  63         return PSCHED_NS2TICKS(ktime_get_ns());
  64 }
  65
  66 static inline psched_tdiff_t
  67 psched_tdiff_bounded(psched_time_t tv1, psched_time_t tv2, psched_time_t bound)
  68 {
  69         return min(tv1 - tv2, bound);
  70 }
  71
  72 struct qdisc_watchdog {
  73         u64             last_expires;
  74         struct hrtimer  timer;
  75         struct Qdisc    *qdisc;
  76 };
  77
  78 void qdisc_watchdog_init_clockid(struct qdisc_watchdog *wd, struct Qdisc *qdisc,
  79                                  clockid_t clockid);
  80 void qdisc_watchdog_init(struct qdisc_watchdog *wd, struct Qdisc *qdisc);
  81
  82 void qdisc_watchdog_schedule_range_ns(struct qdisc_watchdog *wd, u64 expires,
  83                                       u64 delta_ns);
  84
  85 static inline void qdisc_watchdog_schedule_ns(struct qdisc_watchdog *wd,
  86                                               u64 expires)
  87 {
  88         return qdisc_watchdog_schedule_range_ns(wd, expires, 0ULL);
  89 }
  90
  91 static inline void qdisc_watchdog_schedule(struct qdisc_watchdog *wd,
  92                                            psched_time_t expires)
  93 {
  94         qdisc_watchdog_schedule_ns(wd, PSCHED_TICKS2NS(expires));
  95 }
  96
  97 void qdisc_watchdog_cancel(struct qdisc_watchdog *wd);
  98
  99 extern struct Qdisc_ops pfifo_qdisc_ops;
 100 extern struct Qdisc_ops bfifo_qdisc_ops;
 101 extern struct Qdisc_ops pfifo_head_drop_qdisc_ops;
 102
 103 int fifo_set_limit(struct Qdisc *q, unsigned int limit);
 104 struct Qdisc *fifo_create_dflt(struct Qdisc *sch, struct Qdisc_ops *ops,
 105                                unsigned int limit,
 106                                struct netlink_ext_ack *extack);
 107
 108 int register_qdisc(struct Qdisc_ops *qops);
 109 int unregister_qdisc(struct Qdisc_ops *qops);
 110 void qdisc_get_default(char *id, size_t len);
 111 int qdisc_set_default(const char *id);
 112
 113 void qdisc_hash_add(struct Qdisc *q, bool invisible);
 114 void qdisc_hash_del(struct Qdisc *q);
 115 struct Qdisc *qdisc_lookup(struct net_device *dev, u32 handle);
 116 struct Qdisc *qdisc_lookup_rcu(struct net_device *dev, u32 handle);
 117 struct qdisc_rate_table *qdisc_get_rtab(struct tc_ratespec *r,
 118                                         struct nlattr *tab,
 119                                         struct netlink_ext_ack *extack);
 120 void qdisc_put_rtab(struct qdisc_rate_table *tab);
 121 void qdisc_put_stab(struct qdisc_size_table *tab);
 122 void qdisc_warn_nonwc(const char *txt, struct Qdisc *qdisc);
 123 bool sch_direct_xmit(struct sk_buff *skb, struct Qdisc *q,
 124                      struct net_device *dev, struct netdev_queue *txq,
 125                      spinlock_t *root_lock, bool validate);
 126
 127 void __qdisc_run(struct Qdisc *q);
 128
 129 static inline void qdisc_run(struct Qdisc *q)
 130 {
 131         if (qdisc_run_begin(q)) {
 132                 __qdisc_run(q);
 133                 qdisc_run_end(q);
 134         }
 135 }
 136
 137 /* Calculate maximal size of packet seen by hard_start_xmit
 138    routine of this device.
 139  */
 140 static inline unsigned int psched_mtu(const struct net_device *dev)
 141 {
 142         return dev->mtu + dev->hard_header_len;
 143 }
 144
 145 static inline struct net *qdisc_net(struct Qdisc *q)
 146 {
 147         return dev_net(q->dev_queue->dev);
 148 }
 149
 150 struct tc_cbs_qopt_offload {
 151         u8 enable;
 152         s32 queue;
 153         s32 hicredit;
 154         s32 locredit;
 155         s32 idleslope;
 156         s32 sendslope;
 157 };
 158
 159 struct tc_etf_qopt_offload {
 160         u8 enable;
 161         s32 queue;
 162 };
 163
 164 struct tc_taprio_sched_entry {
 165         u8 command; /* TC_TAPRIO_CMD_* */
 166
 167         /* The gate_mask in the offloading side refers to traffic classes */
 168         u32 gate_mask;
 169         u32 interval;
 170 };
 171
 172 struct tc_taprio_qopt_offload {
 173         u8 enable;
 174         ktime_t base_time;
 175         u64 cycle_time;
 176         u64 cycle_time_extension;
 177
 178         size_t num_entries;
 179         struct tc_taprio_sched_entry entries[];
 180 };
 181
 182 /* Reference counting */
 183 struct tc_taprio_qopt_offload *taprio_offload_get(struct tc_taprio_qopt_offload
 184                                                   *offload);
 185 void taprio_offload_free(struct tc_taprio_qopt_offload *offload);
 186
 187 /* Ensure skb_mstamp_ns, which might have been populated with the txtime, is
 188  * not mistaken for a software timestamp, because this will otherwise prevent
 189  * the dispatch of hardware timestamps to the socket.
 190  */
 191 static inline void skb_txtime_consumed(struct sk_buff *skb)
 192 {
 193         skb->tstamp = ktime_set(0, 0);
 194 }
 195
 196 #endif