net/bridge/br_sysfs_if.c

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