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 };
  19
  20 struct tc_action_ops;
  21
  22 struct tc_action {
  23         const struct tc_action_ops      *ops;
  24         __u32                           type; /* for backward compat(TCA_OLD_COMPAT) */
  25         __u32                           order;
  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        *goto_chain;
  43 };
  44 #define tcf_index       common.tcfa_index
  45 #define tcf_refcnt      common.tcfa_refcnt
  46 #define tcf_bindcnt     common.tcfa_bindcnt
  47 #define tcf_action      common.tcfa_action
  48 #define tcf_tm          common.tcfa_tm
  49 #define tcf_bstats      common.tcfa_bstats
  50 #define tcf_qstats      common.tcfa_qstats
  51 #define tcf_rate_est    common.tcfa_rate_est
  52 #define tcf_lock        common.tcfa_lock
  53
  54 /* Update lastuse only if needed, to avoid dirtying a cache line.
  55  * We use a temp variable to avoid fetching jiffies twice.
  56  */
  57 static inline void tcf_lastuse_update(struct tcf_t *tm)
  58 {
  59         unsigned long now = jiffies;
  60
  61         if (tm->lastuse != now)
  62                 tm->lastuse = now;
  63         if (unlikely(!tm->firstuse))
  64                 tm->firstuse = now;
  65 }
  66
  67 static inline void tcf_tm_dump(struct tcf_t *dtm, const struct tcf_t *stm)
  68 {
  69         dtm->install = jiffies_to_clock_t(jiffies - stm->install);
  70         dtm->lastuse = jiffies_to_clock_t(jiffies - stm->lastuse);
  71         dtm->firstuse = jiffies_to_clock_t(jiffies - stm->firstuse);
  72         dtm->expires = jiffies_to_clock_t(stm->expires);
  73 }
  74
  75 #ifdef CONFIG_NET_CLS_ACT
  76
  77 #define ACT_P_CREATED 1
  78 #define ACT_P_DELETED 1
  79
  80 struct tc_action_ops {
  81         struct list_head head;
  82         char    kind[IFNAMSIZ];
  83         enum tca_id  id; /* identifier should match kind */
  84         size_t  size;
  85         struct module           *owner;
  86         int     (*act)(struct sk_buff *, const struct tc_action *,
  87                        struct tcf_result *); /* called under RCU BH lock*/
  88         int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
  89         void    (*cleanup)(struct tc_action *);
  90         int     (*lookup)(struct net *net, struct tc_action **a, u32 index);
  91         int     (*init)(struct net *net, struct nlattr *nla,
  92                         struct nlattr *est, struct tc_action **act, int ovr,
  93                         int bind, bool rtnl_held,
  94                         struct netlink_ext_ack *extack);
  95         int     (*walk)(struct net *, struct sk_buff *,
  96                         struct netlink_callback *, int,
  97                         const struct tc_action_ops *,
  98                         struct netlink_ext_ack *);
  99         void    (*stats_update)(struct tc_action *, u64, u32, u64, bool);
 100         size_t  (*get_fill_size)(const struct tc_action *act);
 101         struct net_device *(*get_dev)(const struct tc_action *a);
 102         void    (*put_dev)(struct net_device *dev);
 103 };
 104
 105 struct tc_action_net {
 106         struct tcf_idrinfo *idrinfo;
 107         const struct tc_action_ops *ops;
 108 };
 109
 110 static inline
 111 int tc_action_net_init(struct tc_action_net *tn,
 112                        const struct tc_action_ops *ops)
 113 {
 114         int err = 0;
 115
 116         tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
 117         if (!tn->idrinfo)
 118                 return -ENOMEM;
 119         tn->ops = ops;
 120         mutex_init(&tn->idrinfo->lock);
 121         idr_init(&tn->idrinfo->action_idr);
 122         return err;
 123 }
 124
 125 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
 126                          struct tcf_idrinfo *idrinfo);
 127
 128 static inline void tc_action_net_exit(struct list_head *net_list,
 129                                       unsigned int id)
 130 {
 131         struct net *net;
 132
 133         rtnl_lock();
 134         list_for_each_entry(net, net_list, exit_list) {
 135                 struct tc_action_net *tn = net_generic(net, id);
 136
 137                 tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
 138                 kfree(tn->idrinfo);
 139         }
 140         rtnl_unlock();
 141 }
 142
 143 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
 144                        struct netlink_callback *cb, int type,
 145                        const struct tc_action_ops *ops,
 146                        struct netlink_ext_ack *extack);
 147 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
 148 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
 149                    struct tc_action **a, const struct tc_action_ops *ops,
 150                    int bind, bool cpustats);
 151 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
 152
 153 void tcf_idr_cleanup(struct tc_action_net *tn, u32 index);
 154 int tcf_idr_check_alloc(struct tc_action_net *tn, u32 *index,
 155                         struct tc_action **a, int bind);
 156 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
 157
 158 static inline int tcf_idr_release(struct tc_action *a, bool bind)
 159 {
 160         return __tcf_idr_release(a, bind, false);
 161 }
 162
 163 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
 164 int tcf_unregister_action(struct tc_action_ops *a,
 165                           struct pernet_operations *ops);
 166 int tcf_action_destroy(struct tc_action *actions[], int bind);
 167 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
 168                     int nr_actions, struct tcf_result *res);
 169 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
 170                     struct nlattr *est, char *name, int ovr, int bind,
 171                     struct tc_action *actions[], size_t *attr_size,
 172                     bool rtnl_held, struct netlink_ext_ack *extack);
 173 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
 174                                     struct nlattr *nla, struct nlattr *est,
 175                                     char *name, int ovr, int bind,
 176                                     bool rtnl_held,
 177                                     struct netlink_ext_ack *extack);
 178 int tcf_action_dump(struct sk_buff *skb, struct tc_action *actions[], int bind,
 179                     int ref);
 180 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
 181 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
 182 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
 183
 184 #endif /* CONFIG_NET_CLS_ACT */
 185
 186 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
 187                                            u64 packets, u64 lastuse, bool hw)
 188 {
 189 #ifdef CONFIG_NET_CLS_ACT
 190         if (!a->ops->stats_update)
 191                 return;
 192
 193         a->ops->stats_update(a, bytes, packets, lastuse, hw);
 194 #endif
 195 }
 196
 197
 198 #endif