GNU Linux-libre 4.14.294-gnu1
[releases.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         struct net      *net;
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 list_head                list;
27         struct tcf_idrinfo              *idrinfo;
28
29         u32                             tcfa_index;
30         int                             tcfa_refcnt;
31         int                             tcfa_bindcnt;
32         u32                             tcfa_capab;
33         int                             tcfa_action;
34         struct tcf_t                    tcfa_tm;
35         struct gnet_stats_basic_packed  tcfa_bstats;
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_queue __percpu *cpu_qstats;
41         struct tc_cookie        *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_capab       common.tcfa_capab
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 struct tc_action_ops {
83         struct list_head head;
84         char    kind[IFNAMSIZ];
85         __u32   type; /* TBD to match kind */
86         size_t  size;
87         struct module           *owner;
88         int     (*act)(struct sk_buff *, const struct tc_action *,
89                        struct tcf_result *);
90         int     (*dump)(struct sk_buff *, struct tc_action *, int, int);
91         void    (*cleanup)(struct tc_action *, int bind);
92         int     (*lookup)(struct net *, struct tc_action **, u32);
93         int     (*init)(struct net *net, struct nlattr *nla,
94                         struct nlattr *est, struct tc_action **act, int ovr,
95                         int bind);
96         int     (*walk)(struct net *, struct sk_buff *,
97                         struct netlink_callback *, int, const struct tc_action_ops *);
98         void    (*stats_update)(struct tc_action *, u64, u32, u64);
99         int     (*get_dev)(const struct tc_action *a, struct net *net,
100                            struct net_device **mirred_dev);
101 };
102
103 struct tc_action_net {
104         struct tcf_idrinfo *idrinfo;
105         const struct tc_action_ops *ops;
106 };
107
108 static inline
109 int tc_action_net_init(struct net *net, struct tc_action_net *tn,
110                        const struct tc_action_ops *ops)
111 {
112         int err = 0;
113
114         tn->idrinfo = kmalloc(sizeof(*tn->idrinfo), GFP_KERNEL);
115         if (!tn->idrinfo)
116                 return -ENOMEM;
117         tn->ops = ops;
118         tn->idrinfo->net = net;
119         spin_lock_init(&tn->idrinfo->lock);
120         idr_init(&tn->idrinfo->action_idr);
121         return err;
122 }
123
124 void tcf_idrinfo_destroy(const struct tc_action_ops *ops,
125                          struct tcf_idrinfo *idrinfo);
126
127 static inline void tc_action_net_exit(struct tc_action_net *tn)
128 {
129         rtnl_lock();
130         tcf_idrinfo_destroy(tn->ops, tn->idrinfo);
131         rtnl_unlock();
132         kfree(tn->idrinfo);
133 }
134
135 int tcf_generic_walker(struct tc_action_net *tn, struct sk_buff *skb,
136                        struct netlink_callback *cb, int type,
137                        const struct tc_action_ops *ops);
138 int tcf_idr_search(struct tc_action_net *tn, struct tc_action **a, u32 index);
139 bool tcf_idr_check(struct tc_action_net *tn, u32 index, struct tc_action **a,
140                     int bind);
141 int tcf_idr_create(struct tc_action_net *tn, u32 index, struct nlattr *est,
142                    struct tc_action **a, const struct tc_action_ops *ops,
143                    int bind, bool cpustats);
144 void tcf_idr_cleanup(struct tc_action *a, struct nlattr *est);
145 void tcf_idr_insert(struct tc_action_net *tn, struct tc_action *a);
146
147 int __tcf_idr_release(struct tc_action *a, bool bind, bool strict);
148
149 static inline int tcf_idr_release(struct tc_action *a, bool bind)
150 {
151         return __tcf_idr_release(a, bind, false);
152 }
153
154 int tcf_register_action(struct tc_action_ops *a, struct pernet_operations *ops);
155 int tcf_unregister_action(struct tc_action_ops *a,
156                           struct pernet_operations *ops);
157 int tcf_action_destroy(struct list_head *actions, int bind);
158 int tcf_action_exec(struct sk_buff *skb, struct tc_action **actions,
159                     int nr_actions, struct tcf_result *res);
160 int tcf_action_init(struct net *net, struct tcf_proto *tp, struct nlattr *nla,
161                     struct nlattr *est, char *name, int ovr, int bind,
162                     struct list_head *actions);
163 struct tc_action *tcf_action_init_1(struct net *net, struct tcf_proto *tp,
164                                     struct nlattr *nla, struct nlattr *est,
165                                     char *name, int ovr, int bind);
166 int tcf_action_dump(struct sk_buff *skb, struct list_head *, int, int);
167 int tcf_action_dump_old(struct sk_buff *skb, struct tc_action *a, int, int);
168 int tcf_action_dump_1(struct sk_buff *skb, struct tc_action *a, int, int);
169 int tcf_action_copy_stats(struct sk_buff *, struct tc_action *, int);
170
171 #endif /* CONFIG_NET_CLS_ACT */
172
173 static inline void tcf_action_stats_update(struct tc_action *a, u64 bytes,
174                                            u64 packets, u64 lastuse)
175 {
176 #ifdef CONFIG_NET_CLS_ACT
177         if (!a->ops->stats_update)
178                 return;
179
180         a->ops->stats_update(a, bytes, packets, lastuse);
181 #endif
182 }
183
184 #endif