]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/net/switchdev.h
net: switchdev: abstract object in add/del ops
[mirror_ubuntu-jammy-kernel.git] / include / net / switchdev.h
1 /*
2 * include/net/switchdev.h - Switch device API
3 * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
4 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 */
11 #ifndef _LINUX_SWITCHDEV_H_
12 #define _LINUX_SWITCHDEV_H_
13
14 #include <linux/netdevice.h>
15 #include <linux/notifier.h>
16 #include <linux/list.h>
17
18 #define SWITCHDEV_F_NO_RECURSE BIT(0)
19
20 struct switchdev_trans_item {
21 struct list_head list;
22 void *data;
23 void (*destructor)(const void *data);
24 };
25
26 struct switchdev_trans {
27 struct list_head item_list;
28 bool ph_prepare;
29 };
30
31 static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
32 {
33 return trans && trans->ph_prepare;
34 }
35
36 static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
37 {
38 return trans && !trans->ph_prepare;
39 }
40
41 enum switchdev_attr_id {
42 SWITCHDEV_ATTR_UNDEFINED,
43 SWITCHDEV_ATTR_PORT_PARENT_ID,
44 SWITCHDEV_ATTR_PORT_STP_STATE,
45 SWITCHDEV_ATTR_PORT_BRIDGE_FLAGS,
46 };
47
48 struct switchdev_attr {
49 enum switchdev_attr_id id;
50 u32 flags;
51 union {
52 struct netdev_phys_item_id ppid; /* PORT_PARENT_ID */
53 u8 stp_state; /* PORT_STP_STATE */
54 unsigned long brport_flags; /* PORT_BRIDGE_FLAGS */
55 } u;
56 };
57
58 struct fib_info;
59
60 enum switchdev_obj_id {
61 SWITCHDEV_OBJ_UNDEFINED,
62 SWITCHDEV_OBJ_PORT_VLAN,
63 SWITCHDEV_OBJ_IPV4_FIB,
64 SWITCHDEV_OBJ_PORT_FDB,
65 };
66
67 struct switchdev_obj {
68 enum switchdev_obj_id id;
69 int (*cb)(struct switchdev_obj *obj);
70 union {
71 struct switchdev_obj_vlan { /* PORT_VLAN */
72 u16 flags;
73 u16 vid_begin;
74 u16 vid_end;
75 } vlan;
76 struct switchdev_obj_ipv4_fib { /* IPV4_FIB */
77 u32 dst;
78 int dst_len;
79 struct fib_info *fi;
80 u8 tos;
81 u8 type;
82 u32 nlflags;
83 u32 tb_id;
84 } ipv4_fib;
85 struct switchdev_obj_fdb { /* PORT_FDB */
86 const unsigned char *addr;
87 u16 vid;
88 u16 ndm_state;
89 } fdb;
90 } u;
91 };
92
93 void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
94 void *data, void (*destructor)(void const *),
95 struct switchdev_trans_item *tritem);
96 void *switchdev_trans_item_dequeue(struct switchdev_trans *trans);
97
98 /**
99 * struct switchdev_ops - switchdev operations
100 *
101 * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
102 *
103 * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
104 *
105 * @switchdev_port_obj_add: Add an object to port (see switchdev_obj).
106 *
107 * @switchdev_port_obj_del: Delete an object from port (see switchdev_obj).
108 *
109 * @switchdev_port_obj_dump: Dump port objects (see switchdev_obj).
110 */
111 struct switchdev_ops {
112 int (*switchdev_port_attr_get)(struct net_device *dev,
113 struct switchdev_attr *attr);
114 int (*switchdev_port_attr_set)(struct net_device *dev,
115 struct switchdev_attr *attr,
116 struct switchdev_trans *trans);
117 int (*switchdev_port_obj_add)(struct net_device *dev,
118 enum switchdev_obj_id id,
119 const void *obj,
120 struct switchdev_trans *trans);
121 int (*switchdev_port_obj_del)(struct net_device *dev,
122 enum switchdev_obj_id id,
123 const void *obj);
124 int (*switchdev_port_obj_dump)(struct net_device *dev,
125 enum switchdev_obj_id id, void *obj,
126 int (*cb)(void *obj));
127 };
128
129 enum switchdev_notifier_type {
130 SWITCHDEV_FDB_ADD = 1,
131 SWITCHDEV_FDB_DEL,
132 };
133
134 struct switchdev_notifier_info {
135 struct net_device *dev;
136 };
137
138 struct switchdev_notifier_fdb_info {
139 struct switchdev_notifier_info info; /* must be first */
140 const unsigned char *addr;
141 u16 vid;
142 };
143
144 static inline struct net_device *
145 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
146 {
147 return info->dev;
148 }
149
150 #ifdef CONFIG_NET_SWITCHDEV
151
152 int switchdev_port_attr_get(struct net_device *dev,
153 struct switchdev_attr *attr);
154 int switchdev_port_attr_set(struct net_device *dev,
155 struct switchdev_attr *attr);
156 int switchdev_port_obj_add(struct net_device *dev, enum switchdev_obj_id id,
157 const void *obj);
158 int switchdev_port_obj_del(struct net_device *dev, enum switchdev_obj_id id,
159 const void *obj);
160 int switchdev_port_obj_dump(struct net_device *dev, enum switchdev_obj_id id,
161 void *obj, int (*cb)(void *obj));
162 int register_switchdev_notifier(struct notifier_block *nb);
163 int unregister_switchdev_notifier(struct notifier_block *nb);
164 int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
165 struct switchdev_notifier_info *info);
166 int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
167 struct net_device *dev, u32 filter_mask,
168 int nlflags);
169 int switchdev_port_bridge_setlink(struct net_device *dev,
170 struct nlmsghdr *nlh, u16 flags);
171 int switchdev_port_bridge_dellink(struct net_device *dev,
172 struct nlmsghdr *nlh, u16 flags);
173 int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
174 u8 tos, u8 type, u32 nlflags, u32 tb_id);
175 int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
176 u8 tos, u8 type, u32 tb_id);
177 void switchdev_fib_ipv4_abort(struct fib_info *fi);
178 int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
179 struct net_device *dev, const unsigned char *addr,
180 u16 vid, u16 nlm_flags);
181 int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
182 struct net_device *dev, const unsigned char *addr,
183 u16 vid);
184 int switchdev_port_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
185 struct net_device *dev,
186 struct net_device *filter_dev, int idx);
187 void switchdev_port_fwd_mark_set(struct net_device *dev,
188 struct net_device *group_dev,
189 bool joining);
190
191 #else
192
193 static inline int switchdev_port_attr_get(struct net_device *dev,
194 struct switchdev_attr *attr)
195 {
196 return -EOPNOTSUPP;
197 }
198
199 static inline int switchdev_port_attr_set(struct net_device *dev,
200 struct switchdev_attr *attr)
201 {
202 return -EOPNOTSUPP;
203 }
204
205 static inline int switchdev_port_obj_add(struct net_device *dev,
206 enum switchdev_obj_id id,
207 const void *obj)
208 {
209 return -EOPNOTSUPP;
210 }
211
212 static inline int switchdev_port_obj_del(struct net_device *dev,
213 enum switchdev_obj_id id,
214 const void *obj)
215 {
216 return -EOPNOTSUPP;
217 }
218
219 static inline int switchdev_port_obj_dump(struct net_device *dev,
220 enum switchdev_obj_id id, void *obj,
221 int (*cb)(void *obj))
222 {
223 return -EOPNOTSUPP;
224 }
225
226 static inline int register_switchdev_notifier(struct notifier_block *nb)
227 {
228 return 0;
229 }
230
231 static inline int unregister_switchdev_notifier(struct notifier_block *nb)
232 {
233 return 0;
234 }
235
236 static inline int call_switchdev_notifiers(unsigned long val,
237 struct net_device *dev,
238 struct switchdev_notifier_info *info)
239 {
240 return NOTIFY_DONE;
241 }
242
243 static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
244 u32 seq, struct net_device *dev,
245 u32 filter_mask, int nlflags)
246 {
247 return -EOPNOTSUPP;
248 }
249
250 static inline int switchdev_port_bridge_setlink(struct net_device *dev,
251 struct nlmsghdr *nlh,
252 u16 flags)
253 {
254 return -EOPNOTSUPP;
255 }
256
257 static inline int switchdev_port_bridge_dellink(struct net_device *dev,
258 struct nlmsghdr *nlh,
259 u16 flags)
260 {
261 return -EOPNOTSUPP;
262 }
263
264 static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
265 struct fib_info *fi,
266 u8 tos, u8 type,
267 u32 nlflags, u32 tb_id)
268 {
269 return 0;
270 }
271
272 static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
273 struct fib_info *fi,
274 u8 tos, u8 type, u32 tb_id)
275 {
276 return 0;
277 }
278
279 static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
280 {
281 }
282
283 static inline int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
284 struct net_device *dev,
285 const unsigned char *addr,
286 u16 vid, u16 nlm_flags)
287 {
288 return -EOPNOTSUPP;
289 }
290
291 static inline int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
292 struct net_device *dev,
293 const unsigned char *addr, u16 vid)
294 {
295 return -EOPNOTSUPP;
296 }
297
298 static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
299 struct netlink_callback *cb,
300 struct net_device *dev,
301 struct net_device *filter_dev,
302 int idx)
303 {
304 return -EOPNOTSUPP;
305 }
306
307 static inline void switchdev_port_fwd_mark_set(struct net_device *dev,
308 struct net_device *group_dev,
309 bool joining)
310 {
311 }
312
313 #endif
314
315 #endif /* _LINUX_SWITCHDEV_H_ */