include/net/act_api.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __NET_ACT_API_H
   3 #define __NET_ACT_API_H
   4
   5 /*
   6  * Public action API for classifiers/qdiscs
   7 */
   8
   9 #include <linux/refcount.h>
  10 #include <net/sch_generic.h>
  11 #include <net/pkt_sched.h>
  12 #include <net/net_namespace.h>
  13 #include <net/netns/generic.h>
  14
  15 struct tcf_idrinfo {
  16         struct mutex    lock;
  17         struct idr      action_idr;
  18         struct net      *net;
  19 };
  20
  21 struct tc_action_ops;
  22
  23 struct tc_action {
  24         const struct tc_action_ops      *ops;
  25         __u32                           type; /* for backward compat(TCA_OLD_COMPAT) */
  26         struct tcf_idrinfo              *idrinfo;
  27
  28         u32                             tcfa_index;
  29         refcount_t                      tcfa_refcnt;
  30         atomic_t                        tcfa_bindcnt;
  31         int                             tcfa_action;
  32         struct tcf_t                    tcfa_tm;
  33         struct gnet_stats_basic_packed  tcfa_bstats;
  34         struct gnet_stats_basic_packed  tcfa_bstats_hw;
  35         struct gnet_stats_queue         tcfa_qstats;
  36         struct net_rate_estimator __rcu *tcfa_rate_est;
  37         spinlock_t                      tcfa_lock;
  38         struct gnet_stats_basic_cpu __percpu *cpu_bstats;
  39         struct gnet_stats_basic_cpu __percpu *cpu_bstats_hw;
  40         struct gnet_stats_queue __percpu *cpu_qstats;
  41         struct tc_cookie        __rcu *act_cookie;
  42         struct tcf_chain        __rcu *goto_chain;
  43         u32                     tcfa_flags;
  44         u8                      hw_stats;
  45         u8                      used_hw_stats;
  46         bool                    used_hw_stats_valid;
  47 };
  48 #define tcf_index       common.tcfa_index
  49 #define tcf_refcnt      common.tcfa_refcnt
  50 #define tcf_bindcnt     common.tcfa_bindcnt
  51 #define tcf_action      common.tcfa_action
  52 #define tcf_tm          common.tcfa_tm
  53 #define tcf_bstats      common.tcfa_bstats
  54 #define tcf_qstats      common.tcfa_qstats
  55 #define tcf_rate_est    common.tcfa_rate_est
  56 #define tcf_lock        common.tcfa_lock
  57
  58 #define TCA_ACT_HW_STATS_ANY (TCA_ACT_HW_STATS_IMMEDIATE | \
  59                               TCA_ACT_HW_STATS_DELAYED)
  60
  61 /* Update lastuse only if needed, to avoid dirtying a cache line.
  62  * We use a temp variable to avoid fetching jiffies twice.
  63  */
  64 static inline void tcf_lastuse_update(struct tcf_t *tm)
  65 {
  66         unsigned long now = jiffies;
  67
  68         if (tm->lastuse != now)
  69                 tm->lastuse = now;
  70         if (unlikely(!tm->firstuse))
  71                 tm->firstuse = now;
  72 }
  73
  74 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
  75 {
  76         dtm->install = jiffies_to_clock_t(jiffies - stm->install);
  77         dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
  78         dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
  79         dtm->expires = jiffies_to_clock_t(stm->expires);
  80 }
  81
  82 #ifdef CONFIG_NET_CLS_ACT
  83
  84 #define ACT_P_CREATED 1
  85 #define ACT_P_DELETED 1
  86
  87 typedef void (*tc_action_priv_destructor)(void *priv);
  88
  89 struct tc_action_ops {
  90         struct list_head head;
  91         char    kind[IFNAMSIZ];
  92         enum tca_id  id; /* identifier should match kind */
  93         size_t  size;
  94         struct module           *owner;
  95         int     (*act)(struct sk_buff *, const struct tc_action *,
  96                        struct tcf_result *); /* called under RCU BH lock*/
  97         int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
  98         void    (*cleanup)(struct tc_action *);
  99         int     (*lookup)(struct net *net, struct tc_action **a, u32 index);
 100         int     (*init)(struct net *net, struct nlattr *nla,
 101                         struct nlattr *est, struct tc_action **act, int ovr,
 102                         int bind, bool rtnl_held, struct tcf_proto *tp,
 103                         u32 flags, struct netlink_ext_ack *extack);
 104         int     (*walk)(struct net *, struct sk_buff *,
 105                         struct netlink_callback *, int,
 106                         const struct tc_action_ops *,
 107                         struct netlink_ext_ack *);
 108         void    (*stats_update)(struct tc_action *, u64, u32, u64, bool);
 109         size_t  (*get_fill_size)(const struct tc_action *act);
 110         struct net_device *(*get_dev)(const struct tc_action *a,
 111                                       tc_action_priv_destructor *destructor);
 112         struct psample_group *
 113         (*get_psample_group)(const struct tc_action *a,
 114                              tc_action_priv_destructor *destructor);
 115 };
 116
 117 struct tc_action_net {
 118         struct tcf_idrinfo *idrinfo;
 119         const struct tc_action_ops *ops;
 120 };
 121
 122 static inline
 123 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
 124                        const struct tc_action_ops *ops)
 125 {
 126         int err = 0;
 127
 128         tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
 129         if (!tn->idrinfo)
 130                 return -ENOMEM;
 131         tn->ops = ops;
 132         tn->idrinfo->net = net;
 133         mutex_init(&tn->idrinfo->lock);
 134         idr_init(&tn->idrinfo->action_idr);
 135         return err;
 136 }
 137
 138 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
 139                          struct tcf_idrinfo *idrinfo);
 140
 141 static inline void tc_action_net_exit(struct list_head *net_list,
 142                                       unsigned int id)
 143 {
 144         struct net *net;
 145
 146         rtnl_lock();
 147         list_for_each_entry(net, net_list, exit_list) {
 148                 struct tc_action_net *tn = net_generic(net, id);
 149
 150                 tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
 151                 kfree(tn->idrinfo);
 152         }
 153         rtnl_unlock();
 154 }
 155
 156 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
 157                        struct netlink_callback *cb, int type,
 158                        const struct tc_action_ops *ops,
 159                        struct netlink_ext_ack *extack);
 160 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
 161 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
 162                    struct tc_action **a, const struct tc_action_ops *ops,
 163                    int bind, bool cpustats, u32 flags);
 164 int tcf_idr_create_from_flags(struct tc_action_net *tn, u32 index,
 165                               struct nlattr *est, struct tc_action **a,
 166                               const struct tc_action_ops *ops, int bind,
 167                               u32 flags);
 168 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
 169
 170 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
 171 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
 172                         struct tc_action **a, int bind);
 173 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
 174
 175 static inline int tcf_idr_release(struct tc_action *a, bool bind)
 176 {
 177         return __tcf_idr_release(a, bind, false);
 178 }
 179
 180 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
 181 int tcf_unregister_action(struct tc_action_ops *a,
 182                           struct pernet_operations *ops);
 183 int tcf_action_destroy(struct tc_action *actions[], int bind);
 184 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
 185                     int nr_actions, struct tcf_result *res);
 186 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
 187                     struct nlattr *est, char *name, int ovr, int bind,
 188                     struct tc_action *actions[], size_t *attr_size,
 189                     bool rtnl_held, struct netlink_ext_ack *extack);
 190 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
 191                                     struct nlattr *nla, struct nlattr *est,
 192                                     char *name, int ovr, int bind,
 193                                     bool rtnl_held,
 194                                     struct netlink_ext_ack *extack);
 195 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
 196                     int ref);
 197 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
 198 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
 199
 200 static inline void tcf_action_update_bstats(struct tc_action *a,
 201                                             struct sk_buff *skb)
 202 {
 203         if (likely(a->cpu_bstats)) {
 204                 bstats_cpu_update(this_cpu_ptr(a->cpu_bstats), skb);
 205                 return;
 206         }
 207         spin_lock(&a->tcfa_lock);
 208         bstats_update(&a->tcfa_bstats, skb);
 209         spin_unlock(&a->tcfa_lock);
 210 }
 211
 212 static inline void tcf_action_inc_drop_qstats(struct tc_action *a)
 213 {
 214         if (likely(a->cpu_qstats)) {
 215                 qstats_drop_inc(this_cpu_ptr(a->cpu_qstats));
 216                 return;
 217         }
 218         spin_lock(&a->tcfa_lock);
 219         qstats_drop_inc(&a->tcfa_qstats);
 220         spin_unlock(&a->tcfa_lock);
 221 }
 222
 223 static inline void tcf_action_inc_overlimit_qstats(struct tc_action *a)
 224 {
 225         if (likely(a->cpu_qstats)) {
 226                 qstats_overlimit_inc(this_cpu_ptr(a->cpu_qstats));
 227                 return;
 228         }
 229         spin_lock(&a->tcfa_lock);
 230         qstats_overlimit_inc(&a->tcfa_qstats);
 231         spin_unlock(&a->tcfa_lock);
 232 }
 233
 234 void tcf_action_update_stats(struct tc_action *a, u64 bytes, u32 packets,
 235                              bool drop, bool hw);
 236 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
 237
 238 int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
 239                              struct tcf_chain **handle,
 240                              struct netlink_ext_ack *newchain);
 241 struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
 242                                          struct tcf_chain *newchain);
 243 #endif /* CONFIG_NET_CLS_ACT */
 244
 245 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
 246                                            u64 packets, u64 lastuse, bool hw)
 247 {
 248 #ifdef CONFIG_NET_CLS_ACT
 249         if (!a->ops->stats_update)
 250                 return;
 251
 252         a->ops->stats_update(a, bytes, packets, lastuse, hw);
 253 #endif
 254 }
 255
 256
 257 #endif