xref: /openbmc/linux/net/bridge/br_sysfs_if.c (revision b34e08d5)
1 /*
2  *	Sysfs attributes of bridge ports
3  *	Linux ethernet bridge
4  *
5  *	Authors:
6  *	Stephen Hemminger		<shemminger@osdl.org>
7  *
8  *	This program is free software; you can redistribute it and/or
9  *	modify it under the terms of the GNU General Public License
10  *	as published by the Free Software Foundation; either version
11  *	2 of the License, or (at your option) any later version.
12  */
13 
14 #include <linux/capability.h>
15 #include <linux/kernel.h>
16 #include <linux/netdevice.h>
17 #include <linux/if_bridge.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/spinlock.h>
20 
21 #include "br_private.h"
22 
23 struct brport_attribute {
24 	struct attribute	attr;
25 	ssize_t (*show)(struct net_bridge_port *, char *);
26 	int (*store)(struct net_bridge_port *, unsigned long);
27 };
28 
29 #define BRPORT_ATTR(_name, _mode, _show, _store)		\
30 const struct brport_attribute brport_attr_##_name = { 	        \
31 	.attr = {.name = __stringify(_name), 			\
32 		 .mode = _mode },				\
33 	.show	= _show,					\
34 	.store	= _store,					\
35 };
36 
37 #define BRPORT_ATTR_FLAG(_name, _mask)				\
38 static ssize_t show_##_name(struct net_bridge_port *p, char *buf) \
39 {								\
40 	return sprintf(buf, "%d\n", !!(p->flags & _mask));	\
41 }								\
42 static int store_##_name(struct net_bridge_port *p, unsigned long v) \
43 {								\
44 	unsigned long flags = p->flags;				\
45 	if (v)							\
46 		flags |= _mask;					\
47 	else							\
48 		flags &= ~_mask;				\
49 	if (flags != p->flags) {				\
50 		p->flags = flags;				\
51 		br_ifinfo_notify(RTM_NEWLINK, p);		\
52 	}							\
53 	return 0;						\
54 }								\
55 static BRPORT_ATTR(_name, S_IRUGO | S_IWUSR,			\
56 		   show_##_name, store_##_name)
57 
58 
59 static ssize_t show_path_cost(struct net_bridge_port *p, char *buf)
60 {
61 	return sprintf(buf, "%d\n", p->path_cost);
62 }
63 
64 static BRPORT_ATTR(path_cost, S_IRUGO | S_IWUSR,
65 		   show_path_cost, br_stp_set_path_cost);
66 
67 static ssize_t show_priority(struct net_bridge_port *p, char *buf)
68 {
69 	return sprintf(buf, "%d\n", p->priority);
70 }
71 
72 static BRPORT_ATTR(priority, S_IRUGO | S_IWUSR,
73 			 show_priority, br_stp_set_port_priority);
74 
75 static ssize_t show_designated_root(struct net_bridge_port *p, char *buf)
76 {
77 	return br_show_bridge_id(buf, &p->designated_root);
78 }
79 static BRPORT_ATTR(designated_root, S_IRUGO, show_designated_root, NULL);
80 
81 static ssize_t show_designated_bridge(struct net_bridge_port *p, char *buf)
82 {
83 	return br_show_bridge_id(buf, &p->designated_bridge);
84 }
85 static BRPORT_ATTR(designated_bridge, S_IRUGO, show_designated_bridge, NULL);
86 
87 static ssize_t show_designated_port(struct net_bridge_port *p, char *buf)
88 {
89 	return sprintf(buf, "%d\n", p->designated_port);
90 }
91 static BRPORT_ATTR(designated_port, S_IRUGO, show_designated_port, NULL);
92 
93 static ssize_t show_designated_cost(struct net_bridge_port *p, char *buf)
94 {
95 	return sprintf(buf, "%d\n", p->designated_cost);
96 }
97 static BRPORT_ATTR(designated_cost, S_IRUGO, show_designated_cost, NULL);
98 
99 static ssize_t show_port_id(struct net_bridge_port *p, char *buf)
100 {
101 	return sprintf(buf, "0x%x\n", p->port_id);
102 }
103 static BRPORT_ATTR(port_id, S_IRUGO, show_port_id, NULL);
104 
105 static ssize_t show_port_no(struct net_bridge_port *p, char *buf)
106 {
107 	return sprintf(buf, "0x%x\n", p->port_no);
108 }
109 
110 static BRPORT_ATTR(port_no, S_IRUGO, show_port_no, NULL);
111 
112 static ssize_t show_change_ack(struct net_bridge_port *p, char *buf)
113 {
114 	return sprintf(buf, "%d\n", p->topology_change_ack);
115 }
116 static BRPORT_ATTR(change_ack, S_IRUGO, show_change_ack, NULL);
117 
118 static ssize_t show_config_pending(struct net_bridge_port *p, char *buf)
119 {
120 	return sprintf(buf, "%d\n", p->config_pending);
121 }
122 static BRPORT_ATTR(config_pending, S_IRUGO, show_config_pending, NULL);
123 
124 static ssize_t show_port_state(struct net_bridge_port *p, char *buf)
125 {
126 	return sprintf(buf, "%d\n", p->state);
127 }
128 static BRPORT_ATTR(state, S_IRUGO, show_port_state, NULL);
129 
130 static ssize_t show_message_age_timer(struct net_bridge_port *p,
131 					    char *buf)
132 {
133 	return sprintf(buf, "%ld\n", br_timer_value(&p->message_age_timer));
134 }
135 static BRPORT_ATTR(message_age_timer, S_IRUGO, show_message_age_timer, NULL);
136 
137 static ssize_t show_forward_delay_timer(struct net_bridge_port *p,
138 					    char *buf)
139 {
140 	return sprintf(buf, "%ld\n", br_timer_value(&p->forward_delay_timer));
141 }
142 static BRPORT_ATTR(forward_delay_timer, S_IRUGO, show_forward_delay_timer, NULL);
143 
144 static ssize_t show_hold_timer(struct net_bridge_port *p,
145 					    char *buf)
146 {
147 	return sprintf(buf, "%ld\n", br_timer_value(&p->hold_timer));
148 }
149 static BRPORT_ATTR(hold_timer, S_IRUGO, show_hold_timer, NULL);
150 
151 static int store_flush(struct net_bridge_port *p, unsigned long v)
152 {
153 	br_fdb_delete_by_port(p->br, p, 0); // Don't delete local entry
154 	return 0;
155 }
156 static BRPORT_ATTR(flush, S_IWUSR, NULL, store_flush);
157 
158 BRPORT_ATTR_FLAG(hairpin_mode, BR_HAIRPIN_MODE);
159 BRPORT_ATTR_FLAG(bpdu_guard, BR_BPDU_GUARD);
160 BRPORT_ATTR_FLAG(root_block, BR_ROOT_BLOCK);
161 BRPORT_ATTR_FLAG(learning, BR_LEARNING);
162 BRPORT_ATTR_FLAG(unicast_flood, BR_FLOOD);
163 
164 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
165 static ssize_t show_multicast_router(struct net_bridge_port *p, char *buf)
166 {
167 	return sprintf(buf, "%d\n", p->multicast_router);
168 }
169 
170 static int store_multicast_router(struct net_bridge_port *p,
171 				      unsigned long v)
172 {
173 	return br_multicast_set_port_router(p, v);
174 }
175 static BRPORT_ATTR(multicast_router, S_IRUGO | S_IWUSR, show_multicast_router,
176 		   store_multicast_router);
177 
178 BRPORT_ATTR_FLAG(multicast_fast_leave, BR_MULTICAST_FAST_LEAVE);
179 #endif
180 
181 static const struct brport_attribute *brport_attrs[] = {
182 	&brport_attr_path_cost,
183 	&brport_attr_priority,
184 	&brport_attr_port_id,
185 	&brport_attr_port_no,
186 	&brport_attr_designated_root,
187 	&brport_attr_designated_bridge,
188 	&brport_attr_designated_port,
189 	&brport_attr_designated_cost,
190 	&brport_attr_state,
191 	&brport_attr_change_ack,
192 	&brport_attr_config_pending,
193 	&brport_attr_message_age_timer,
194 	&brport_attr_forward_delay_timer,
195 	&brport_attr_hold_timer,
196 	&brport_attr_flush,
197 	&brport_attr_hairpin_mode,
198 	&brport_attr_bpdu_guard,
199 	&brport_attr_root_block,
200 	&brport_attr_learning,
201 	&brport_attr_unicast_flood,
202 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
203 	&brport_attr_multicast_router,
204 	&brport_attr_multicast_fast_leave,
205 #endif
206 	NULL
207 };
208 
209 #define to_brport_attr(_at) container_of(_at, struct brport_attribute, attr)
210 #define to_brport(obj)	container_of(obj, struct net_bridge_port, kobj)
211 
212 static ssize_t brport_show(struct kobject *kobj,
213 			   struct attribute *attr, char *buf)
214 {
215 	struct brport_attribute *brport_attr = to_brport_attr(attr);
216 	struct net_bridge_port *p = to_brport(kobj);
217 
218 	return brport_attr->show(p, buf);
219 }
220 
221 static ssize_t brport_store(struct kobject *kobj,
222 			    struct attribute *attr,
223 			    const char *buf, size_t count)
224 {
225 	struct brport_attribute *brport_attr = to_brport_attr(attr);
226 	struct net_bridge_port *p = to_brport(kobj);
227 	ssize_t ret = -EINVAL;
228 	char *endp;
229 	unsigned long val;
230 
231 	if (!ns_capable(dev_net(p->dev)->user_ns, CAP_NET_ADMIN))
232 		return -EPERM;
233 
234 	val = simple_strtoul(buf, &endp, 0);
235 	if (endp != buf) {
236 		if (!rtnl_trylock())
237 			return restart_syscall();
238 		if (p->dev && p->br && brport_attr->store) {
239 			spin_lock_bh(&p->br->lock);
240 			ret = brport_attr->store(p, val);
241 			spin_unlock_bh(&p->br->lock);
242 			if (ret == 0)
243 				ret = count;
244 		}
245 		rtnl_unlock();
246 	}
247 	return ret;
248 }
249 
250 const struct sysfs_ops brport_sysfs_ops = {
251 	.show = brport_show,
252 	.store = brport_store,
253 };
254 
255 /*
256  * Add sysfs entries to ethernet device added to a bridge.
257  * Creates a brport subdirectory with bridge attributes.
258  * Puts symlink in bridge's brif subdirectory
259  */
260 int br_sysfs_addif(struct net_bridge_port *p)
261 {
262 	struct net_bridge *br = p->br;
263 	const struct brport_attribute **a;
264 	int err;
265 
266 	err = sysfs_create_link(&p->kobj, &br->dev->dev.kobj,
267 				SYSFS_BRIDGE_PORT_LINK);
268 	if (err)
269 		return err;
270 
271 	for (a = brport_attrs; *a; ++a) {
272 		err = sysfs_create_file(&p->kobj, &((*a)->attr));
273 		if (err)
274 			return err;
275 	}
276 
277 	strlcpy(p->sysfs_name, p->dev->name, IFNAMSIZ);
278 	return sysfs_create_link(br->ifobj, &p->kobj, p->sysfs_name);
279 }
280 
281 /* Rename bridge's brif symlink */
282 int br_sysfs_renameif(struct net_bridge_port *p)
283 {
284 	struct net_bridge *br = p->br;
285 	int err;
286 
287 	/* If a rename fails, the rollback will cause another
288 	 * rename call with the existing name.
289 	 */
290 	if (!strncmp(p->sysfs_name, p->dev->name, IFNAMSIZ))
291 		return 0;
292 
293 	err = sysfs_rename_link(br->ifobj, &p->kobj,
294 				p->sysfs_name, p->dev->name);
295 	if (err)
296 		netdev_notice(br->dev, "unable to rename link %s to %s",
297 			      p->sysfs_name, p->dev->name);
298 	else
299 		strlcpy(p->sysfs_name, p->dev->name, IFNAMSIZ);
300 
301 	return err;
302 }
303