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         __u32                           order;
  27         struct tcf_idrinfo              *idrinfo;
  28
  29         u32                             tcfa_index;
  30         refcount_t                      tcfa_refcnt;
  31         atomic_t                        tcfa_bindcnt;
  32         int                             tcfa_action;
  33         struct tcf_t                    tcfa_tm;
  34         struct gnet_stats_basic_packed  tcfa_bstats;
  35         struct gnet_stats_basic_packed  tcfa_bstats_hw;
  36         struct gnet_stats_queue         tcfa_qstats;
  37         struct net_rate_estimator __rcu *tcfa_rate_est;
  38         spinlock_t                      tcfa_lock;
  39         struct gnet_stats_basic_cpu __percpu *cpu_bstats;
  40         struct gnet_stats_basic_cpu __percpu *cpu_bstats_hw;
  41         struct gnet_stats_queue __percpu *cpu_qstats;
  42         struct tc_cookie        __rcu *act_cookie;
  43         struct tcf_chain        __rcu *goto_chain;
  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 = stm->firstuse ?
  73                 jiffies_to_clock_t(jiffies - stm->firstuse) : 0;
  74         dtm->expires = jiffies_to_clock_t(stm->expires);
  75 }
  76
  77 #ifdef CONFIG_NET_CLS_ACT
  78
  79 #define ACT_P_CREATED 1
  80 #define ACT_P_DELETED 1
  81
  82 typedef void (*tc_action_priv_destructor)(void *priv);
  83
  84 struct tc_action_ops {
  85         struct list_head head;
  86         char    kind[IFNAMSIZ];
  87         enum tca_id  id; /* identifier should match kind */
  88         size_t  size;
  89         struct module           *owner;
  90         int     (*act)(struct sk_buff *, const struct tc_action *,
  91                        struct tcf_result *); /* called under RCU BH lock*/
  92         int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
  93         void    (*cleanup)(struct tc_action *);
  94         int     (*lookup)(struct net *net, struct tc_action **a, u32 index);
  95         int     (*init)(struct net *net, struct nlattr *nla,
  96                         struct nlattr *est, struct tc_action **act, int ovr,
  97                         int bind, bool rtnl_held, struct tcf_proto *tp,
  98                         struct netlink_ext_ack *extack);
  99         int     (*walk)(struct net *, struct sk_buff *,
 100                         struct netlink_callback *, int,
 101                         const struct tc_action_ops *,
 102                         struct netlink_ext_ack *);
 103         void    (*stats_update)(struct tc_action *, u64, u32, u64, bool);
 104         size_t  (*get_fill_size)(const struct tc_action *act);
 105         struct net_device *(*get_dev)(const struct tc_action *a,
 106                                       tc_action_priv_destructor *destructor);
 107         struct psample_group *
 108         (*get_psample_group)(const struct tc_action *a,
 109                              tc_action_priv_destructor *destructor);
 110 };
 111
 112 struct tc_action_net {
 113         struct tcf_idrinfo *idrinfo;
 114         const struct tc_action_ops *ops;
 115 };
 116
 117 static inline
 118 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
 119                        const struct tc_action_ops *ops)
 120 {
 121         int err = 0;
 122
 123         tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
 124         if (!tn->idrinfo)
 125                 return -ENOMEM;
 126         tn->ops = ops;
 127         tn->idrinfo->net = net;
 128         mutex_init(&tn->idrinfo->lock);
 129         idr_init(&tn->idrinfo->action_idr);
 130         return err;
 131 }
 132
 133 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
 134                          struct tcf_idrinfo *idrinfo);
 135
 136 static inline void tc_action_net_exit(struct list_head *net_list,
 137                                       unsigned int id)
 138 {
 139         struct net *net;
 140
 141         rtnl_lock();
 142         list_for_each_entry(net, net_list, exit_list) {
 143                 struct tc_action_net *tn = net_generic(net, id);
 144
 145                 tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
 146                 kfree(tn->idrinfo);
 147         }
 148         rtnl_unlock();
 149 }
 150
 151 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
 152                        struct netlink_callback *cb, int type,
 153                        const struct tc_action_ops *ops,
 154                        struct netlink_ext_ack *extack);
 155 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
 156 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
 157                    struct tc_action **a, const struct tc_action_ops *ops,
 158                    int bind, bool cpustats);
 159 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
 160
 161 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
 162 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
 163                         struct tc_action **a, int bind);
 164 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
 165
 166 static inline int tcf_idr_release(struct tc_action *a, bool bind)
 167 {
 168         return __tcf_idr_release(a, bind, false);
 169 }
 170
 171 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
 172 int tcf_unregister_action(struct tc_action_ops *a,
 173                           struct pernet_operations *ops);
 174 int tcf_action_destroy(struct tc_action *actions[], int bind);
 175 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
 176                     int nr_actions, struct tcf_result *res);
 177 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
 178                     struct nlattr *est, char *name, int ovr, int bind,
 179                     struct tc_action *actions[], size_t *attr_size,
 180                     bool rtnl_held, struct netlink_ext_ack *extack);
 181 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
 182                                     struct nlattr *nla, struct nlattr *est,
 183                                     char *name, int ovr, int bind,
 184                                     bool rtnl_held,
 185                                     struct netlink_ext_ack *extack);
 186 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
 187                     int ref);
 188 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
 189 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
 190 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
 191
 192 int tcf_action_check_ctrlact(int action, struct tcf_proto *tp,
 193                              struct tcf_chain **handle,
 194                              struct netlink_ext_ack *newchain);
 195 struct tcf_chain *tcf_action_set_ctrlact(struct tc_action *a, int action,
 196                                          struct tcf_chain *newchain);
 197 #endif /* CONFIG_NET_CLS_ACT */
 198
 199 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
 200                                            u64 packets, u64 lastuse, bool hw)
 201 {
 202 #ifdef CONFIG_NET_CLS_ACT
 203         if (!a->ops->stats_update)
 204                 return;
 205
 206         a->ops->stats_update(a, bytes, packets, lastuse, hw);
 207 #endif
 208 }
 209
 210
 211 #endif