[linux.git] / net / bridge / br_sysfs_if.c

/*
 *	Sysfs attributes of bridge ports
 *	Linux ethernet bridge
 *
 *	Authors:
 *	Stephen Hemminger		<[email protected]>
 *
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License
 *	as published by the Free Software Foundation; either version
 *	2 of the License, or (at your option) any later version.
 */

#include <linux/capability.h>
#include <linux/kernel.h>
#include <linux/netdevice.h>
#include <linux/if_bridge.h>
#include <linux/rtnetlink.h>
#include <linux/spinlock.h>

#include "br_private.h"

struct brport_attribute {
	struct attribute	attr;
	ssize_t (*show)(struct net_bridge_port *, char *);
	int (*store)(struct net_bridge_port *, unsigned long);
};

#define BRPORT_ATTR(_name,_mode,_show,_store)		        \
const struct brport_attribute brport_attr_##_name = { 	        \
	.attr = {.name = __stringify(_name), 			\
		 .mode = _mode },				\
	.show	= _show,					\
	.store	= _store,					\
};

#define BRPORT_ATTR_FLAG(_name, _mask)				\
static ssize_t show_##_name(struct net_bridge_port *p, char *buf) \
{								\
	return sprintf(buf, "%d\n", !!(p->flags & _mask));	\
}								\
static int store_##_name(struct net_bridge_port *p, unsigned long v) \
{								\
	unsigned long flags = p->flags;				\
	if (v)							\
		flags |= _mask;					\
	else							\
		flags &= ~_mask;				\
	if (flags != p->flags) {				\
		p->flags = flags;				\
		br_ifinfo_notify(RTM_NEWLINK, p);		\
	}							\
	return 0;						\
}								\
static BRPORT_ATTR(_name, S_IRUGO | S_IWUSR,			\
		   show_##_name, store_##_name)


static ssize_t show_path_cost(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->path_cost);
}

static BRPORT_ATTR(path_cost, S_IRUGO | S_IWUSR,
		   show_path_cost, br_stp_set_path_cost);

static ssize_t show_priority(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->priority);
}

static BRPORT_ATTR(priority, S_IRUGO | S_IWUSR,
			 show_priority, br_stp_set_port_priority);

static ssize_t show_designated_root(struct net_bridge_port *p, char *buf)
{
	return br_show_bridge_id(buf, &p->designated_root);
}
static BRPORT_ATTR(designated_root, S_IRUGO, show_designated_root, NULL);

static ssize_t show_designated_bridge(struct net_bridge_port *p, char *buf)
{
	return br_show_bridge_id(buf, &p->designated_bridge);
}
static BRPORT_ATTR(designated_bridge, S_IRUGO, show_designated_bridge, NULL);

static ssize_t show_designated_port(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->designated_port);
}
static BRPORT_ATTR(designated_port, S_IRUGO, show_designated_port, NULL);

static ssize_t show_designated_cost(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->designated_cost);
}
static BRPORT_ATTR(designated_cost, S_IRUGO, show_designated_cost, NULL);

static ssize_t show_port_id(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "0x%x\n", p->port_id);
}
static BRPORT_ATTR(port_id, S_IRUGO, show_port_id, NULL);

static ssize_t show_port_no(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "0x%x\n", p->port_no);
}

static BRPORT_ATTR(port_no, S_IRUGO, show_port_no, NULL);

static ssize_t show_change_ack(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->topology_change_ack);
}
static BRPORT_ATTR(change_ack, S_IRUGO, show_change_ack, NULL);

static ssize_t show_config_pending(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->config_pending);
}
static BRPORT_ATTR(config_pending, S_IRUGO, show_config_pending, NULL);

static ssize_t show_port_state(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->state);
}
static BRPORT_ATTR(state, S_IRUGO, show_port_state, NULL);

static ssize_t show_message_age_timer(struct net_bridge_port *p,
					    char *buf)
{
	return sprintf(buf, "%ld\n", br_timer_value(&p->message_age_timer));
}
static BRPORT_ATTR(message_age_timer, S_IRUGO, show_message_age_timer, NULL);

static ssize_t show_forward_delay_timer(struct net_bridge_port *p,
					    char *buf)
{
	return sprintf(buf, "%ld\n", br_timer_value(&p->forward_delay_timer));
}
static BRPORT_ATTR(forward_delay_timer, S_IRUGO, show_forward_delay_timer, NULL);

static ssize_t show_hold_timer(struct net_bridge_port *p,
					    char *buf)
{
	return sprintf(buf, "%ld\n", br_timer_value(&p->hold_timer));
}
static BRPORT_ATTR(hold_timer, S_IRUGO, show_hold_timer, NULL);

static int store_flush(struct net_bridge_port *p, unsigned long v)
{
	br_fdb_delete_by_port(p->br, p, 0); // Don't delete local entry
	return 0;
}
static BRPORT_ATTR(flush, S_IWUSR, NULL, store_flush);

BRPORT_ATTR_FLAG(hairpin_mode, BR_HAIRPIN_MODE);
BRPORT_ATTR_FLAG(bpdu_guard, BR_BPDU_GUARD);
BRPORT_ATTR_FLAG(root_block, BR_ROOT_BLOCK);
BRPORT_ATTR_FLAG(learning, BR_LEARNING);
BRPORT_ATTR_FLAG(unicast_flood, BR_FLOOD);

#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
static ssize_t show_multicast_router(struct net_bridge_port *p, char *buf)
{
	return sprintf(buf, "%d\n", p->multicast_router);
}

static int store_multicast_router(struct net_bridge_port *p,
				      unsigned long v)
{
	return br_multicast_set_port_router(p, v);
}
static BRPORT_ATTR(multicast_router, S_IRUGO | S_IWUSR, show_multicast_router,
		   store_multicast_router);

BRPORT_ATTR_FLAG(multicast_fast_leave, BR_MULTICAST_FAST_LEAVE);
#endif

static const struct brport_attribute *brport_attrs[] = {
	&brport_attr_path_cost,
	&brport_attr_priority,
	&brport_attr_port_id,
	&brport_attr_port_no,
	&brport_attr_designated_root,
	&brport_attr_designated_bridge,
	&brport_attr_designated_port,
	&brport_attr_designated_cost,
	&brport_attr_state,
	&brport_attr_change_ack,
	&brport_attr_config_pending,
	&brport_attr_message_age_timer,
	&brport_attr_forward_delay_timer,
	&brport_attr_hold_timer,
	&brport_attr_flush,
	&brport_attr_hairpin_mode,
	&brport_attr_bpdu_guard,
	&brport_attr_root_block,
	&brport_attr_learning,
	&brport_attr_unicast_flood,
#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
	&brport_attr_multicast_router,
	&brport_attr_multicast_fast_leave,
#endif
	NULL
};

#define to_brport_attr(_at) container_of(_at, struct brport_attribute, attr)
#define to_brport(obj)	container_of(obj, struct net_bridge_port, kobj)

static ssize_t brport_show(struct kobject * kobj,
			   struct attribute * attr, char * buf)
{
	struct brport_attribute * brport_attr = to_brport_attr(attr);
	struct net_bridge_port * p = to_brport(kobj);

	return brport_attr->show(p, buf);
}

static ssize_t brport_store(struct kobject * kobj,
			    struct attribute * attr,
			    const char * buf, size_t count)
{
	struct brport_attribute * brport_attr = to_brport_attr(attr);
	struct net_bridge_port * p = to_brport(kobj);
	ssize_t ret = -EINVAL;
	char *endp;
	unsigned long val;

	if (!ns_capable(dev_net(p->dev)->user_ns, CAP_NET_ADMIN))
		return -EPERM;

	val = simple_strtoul(buf, &endp, 0);
	if (endp != buf) {
		if (!rtnl_trylock())
			return restart_syscall();
		if (p->dev && p->br && brport_attr->store) {
			spin_lock_bh(&p->br->lock);
			ret = brport_attr->store(p, val);
			spin_unlock_bh(&p->br->lock);
			if (ret == 0)
				ret = count;
		}
		rtnl_unlock();
	}
	return ret;
}

const struct sysfs_ops brport_sysfs_ops = {
	.show = brport_show,
	.store = brport_store,
};

/*
 * Add sysfs entries to ethernet device added to a bridge.
 * Creates a brport subdirectory with bridge attributes.
 * Puts symlink in bridge's brif subdirectory
 */
int br_sysfs_addif(struct net_bridge_port *p)
{
	struct net_bridge *br = p->br;
	const struct brport_attribute **a;
	int err;

	err = sysfs_create_link(&p->kobj, &br->dev->dev.kobj,
				SYSFS_BRIDGE_PORT_LINK);
	if (err)
		return err;

	for (a = brport_attrs; *a; ++a) {
		err = sysfs_create_file(&p->kobj, &((*a)->attr));
		if (err)
			return err;
	}

	strlcpy(p->sysfs_name, p->dev->name, IFNAMSIZ);
	return sysfs_create_link(br->ifobj, &p->kobj, p->sysfs_name);
}

/* Rename bridge's brif symlink */
int br_sysfs_renameif(struct net_bridge_port *p)
{
	struct net_bridge *br = p->br;
	int err;

	/* If a rename fails, the rollback will cause another
	 * rename call with the existing name.
	 */
	if (!strncmp(p->sysfs_name, p->dev->name, IFNAMSIZ))
		return 0;

	err = sysfs_rename_link(br->ifobj, &p->kobj,
				p->sysfs_name, p->dev->name);
	if (err)
		netdev_notice(br->dev, "unable to rename link %s to %s",
			      p->sysfs_name, p->dev->name);
	else
		strlcpy(p->sysfs_name, p->dev->name, IFNAMSIZ);

	return err;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Sysfs attributes of bridge ports
	3	* Linux ethernet bridge
	4	*
	5	* Authors:
	6	* Stephen Hemminger <[email protected]>
	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
4fc268d2	14	#include <linux/capability.h>
1da177e4 LT	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 *);
14f98f25	26	int (store)(struct net_bridge_port , unsigned long);
1da177e4 LT	27	};
	28
	29	#define BRPORT_ATTR(_name,_mode,_show,_store) \
5a0d513b	30	const struct brport_attribute brport_attr_##_name = { \
1da177e4	31	.attr = {.name = __stringify(_name), \
7b595756	32	.mode = _mode }, \
1da177e4 LT	33	.show = _show, \
	34	.store = _store, \
	35	};
	36
cd753732	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
1da177e4 LT	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	}
14f98f25	63
1da177e4	64	static BRPORT_ATTR(path_cost, S_IRUGO \| S_IWUSR,
14f98f25	65	show_path_cost, br_stp_set_path_cost);
1da177e4 LT	66
	67	static ssize_t show_priority(struct net_bridge_port p, char buf)
	68	{
	69	return sprintf(buf, "%d\n", p->priority);
	70	}
14f98f25	71
1da177e4	72	static BRPORT_ATTR(priority, S_IRUGO \| S_IWUSR,
14f98f25	73	show_priority, br_stp_set_port_priority);
1da177e4 LT	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
14f98f25	151	static int store_flush(struct net_bridge_port *p, unsigned long v)
9cf63747 SH	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
cd753732	158	BRPORT_ATTR_FLAG(hairpin_mode, BR_HAIRPIN_MODE);
a2e01a65	159	BRPORT_ATTR_FLAG(bpdu_guard, BR_BPDU_GUARD);
1007dd1a	160	BRPORT_ATTR_FLAG(root_block, BR_ROOT_BLOCK);
9ba18891	161	BRPORT_ATTR_FLAG(learning, BR_LEARNING);
867a5943	162	BRPORT_ATTR_FLAG(unicast_flood, BR_FLOOD);
3982d3d2	163
0909e117 HX	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
14f98f25	170	static int store_multicast_router(struct net_bridge_port *p,
0909e117 HX	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);
50426b59	177
c2d3babf	178	BRPORT_ATTR_FLAG(multicast_fast_leave, BR_MULTICAST_FAST_LEAVE);
0909e117 HX	179	#endif
0909e117 HX	180
5a0d513b	181	static const struct brport_attribute *brport_attrs[] = {
1da177e4 LT	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,
9cf63747	196	&brport_attr_flush,
3982d3d2	197	&brport_attr_hairpin_mode,
a2e01a65	198	&brport_attr_bpdu_guard,
1007dd1a	199	&brport_attr_root_block,
9ba18891	200	&brport_attr_learning,
867a5943	201	&brport_attr_unicast_flood,
0909e117 HX	202	#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
0909e117 HX	203	&brport_attr_multicast_router,
50426b59	204	&brport_attr_multicast_fast_leave,
0909e117	205	#endif
1da177e4 LT	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
cb990503	231	if (!ns_capable(dev_net(p->dev)->user_ns, CAP_NET_ADMIN))
1da177e4 LT	232	return -EPERM;
	233
	234	val = simple_strtoul(buf, &endp, 0);
	235	if (endp != buf) {
af38f298 EB	236	if (!rtnl_trylock())
af38f298 EB	237	return restart_syscall();
1da177e4 LT	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
52cf25d0	250	const struct sysfs_ops brport_sysfs_ops = {
1da177e4 LT	251	.show = brport_show,
	252	.store = brport_store,
	253	};
	254
1da177e4 LT	255	/*
	256	* Add sysfs entries to ethernet device added to a bridge.
	257	* Creates a brport subdirectory with bridge attributes.
e0f43752	258	* Puts symlink in bridge's brif subdirectory
1da177e4 LT	259	*/
	260	int br_sysfs_addif(struct net_bridge_port *p)
	261	{
	262	struct net_bridge *br = p->br;
5a0d513b	263	const struct brport_attribute **a;
1da177e4 LT	264	int err;
1da177e4 LT	265
43cb76d9	266	err = sysfs_create_link(&p->kobj, &br->dev->dev.kobj,
1da177e4 LT	267	SYSFS_BRIDGE_PORT_LINK);
1da177e4 LT	268	if (err)
e0f43752	269	return err;
1da177e4 LT	270
	271	for (a = brport_attrs; *a; ++a) {
	272	err = sysfs_create_file(&p->kobj, &((*a)->attr));
	273	if (err)
e0f43752	274	return err;
1da177e4 LT	275	}
1da177e4 LT	276
e0f43752 SA	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
1da177e4 LT	301	return err;
1da177e4 LT	302	}