License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[linux-block.git] / 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 <net/sch_generic.h>
10 #include <net/pkt_sched.h>
11 #include <net/net_namespace.h>
12 #include <net/netns/generic.h>
13
14 struct tcf_idrinfo {
15         spinlock_t      lock;
16         struct idr      action_idr;
17 };
18
19 struct tc_action_ops;
20
21 struct tc_action {
22         const struct tc_action_ops      *ops;
23         __u32                           type; /* for backward compat(TCA_OLD_COMPAT) */
24         __u32                           order;
25         struct list_head                list;
26         struct tcf_idrinfo              *idrinfo;
27
28         u32                             tcfa_index;
29         int                             tcfa_refcnt;
30         int                             tcfa_bindcnt;
31         u32                             tcfa_capab;
32         int                             tcfa_action;
33         struct tcf_t                    tcfa_tm;
34         struct gnet_stats_basic_packed  tcfa_bstats;
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_queue __percpu *cpu_qstats;
40         struct tc_cookie        *act_cookie;
41         struct tcf_chain        *goto_chain;
42 };
43 #define tcf_index       common.tcfa_index
44 #define tcf_refcnt      common.tcfa_refcnt
45 #define tcf_bindcnt     common.tcfa_bindcnt
46 #define tcf_capab       common.tcfa_capab
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         __u32   type; /* TBD to match kind */
84         size_t  size;
85         struct module           *owner;
86         int     (*act)(struct sk_buff *, const struct tc_action *,
87                        struct tcf_result *);
88         int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
89         void    (*cleanup)(struct tc_action *, int bind);
90         int     (*lookup)(struct net *, struct tc_action **, u32);
91         int     (*init)(struct net *net, struct nlattr *nla,
92                         struct nlattr *est, struct tc_action **act, int ovr,
93                         int bind);
94         int     (*walk)(struct net *, struct sk_buff *,
95                         struct netlink_callback *, int, const struct tc_action_ops *);
96         void    (*stats_update)(struct tc_action *, u64, u32, u64);
97         int     (*get_dev)(const struct tc_action *a, struct net *net,
98                            struct net_device **mirred_dev);
99 };
100
101 struct tc_action_net {
102         struct tcf_idrinfo *idrinfo;
103         const struct tc_action_ops *ops;
104 };
105
106 static inline
107 int tc_action_net_init(struct tc_action_net *tn,
108                        const struct tc_action_ops *ops)
109 {
110         int err = 0;
111
112         tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
113         if (!tn->idrinfo)
114                 return -ENOMEM;
115         tn->ops = ops;
116         spin_lock_init(&tn->idrinfo->lock);
117         idr_init(&tn->idrinfo->action_idr);
118         return err;
119 }
120
121 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
122                          struct tcf_idrinfo *idrinfo);
123
124 static inline void tc_action_net_exit(struct tc_action_net *tn)
125 {
126         tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
127         kfree(tn->idrinfo);
128 }
129
130 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
131                        struct netlink_callback *cb, int type,
132                        const struct tc_action_ops *ops);
133 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
134 bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
135                     int bind);
136 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
137                    struct tc_action **a, const struct tc_action_ops *ops,
138                    int bind, bool cpustats);
139 void tcf_idr_cleanup(struct tc_action *a, struct nlattr *est);
140 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
141
142 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
143
144 static inline int tcf_idr_release(struct tc_action *a, bool bind)
145 {
146         return __tcf_idr_release(a, bind, false);
147 }
148
149 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
150 int tcf_unregister_action(struct tc_action_ops *a,
151                           struct pernet_operations *ops);
152 int tcf_action_destroy(struct list_head *actions, int bind);
153 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
154                     int nr_actions, struct tcf_result *res);
155 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
156                     struct nlattr *est, char *name, int ovr, int bind,
157                     struct list_head *actions);
158 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
159                                     struct nlattr *nla, struct nlattr *est,
160                                     char *name, int ovr, int bind);
161 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
162 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
163 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
164 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
165
166 #endif /* CONFIG_NET_CLS_ACT */
167
168 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
169                                            u64 packets, u64 lastuse)
170 {
171 #ifdef CONFIG_NET_CLS_ACT
172         if (!a->ops->stats_update)
173                 return;
174
175         a->ops->stats_update(a, bytes, packets, lastuse);
176 #endif
177 }
178
179 #endif