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