net/bridge/br_sysfs_br.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/times.h>
  21
  22 #include "br_private.h"
  23
  24 #define to_dev(obj)     container_of(obj, struct device, kobj)
  25 #define to_bridge(cd)   ((struct net_bridge *)(to_net_dev(cd)->priv))
  26
  27 /*
  28  * Common code for storing bridge parameters.
  29  */
  30 static ssize_t store_bridge_parm(struct device *d,
  31                                  const char *buf, size_t len,
  32                                  void (*set)(struct net_bridge *, unsigned long))
  33 {
  34         struct net_bridge *br = to_bridge(d);
  35         char *endp;
  36         unsigned long val;
  37
  38         if (!capable(CAP_NET_ADMIN))
  39                 return -EPERM;
  40
  41         val = simple_strtoul(buf, &endp, 0);
  42         if (endp == buf)
  43                 return -EINVAL;
  44
  45         spin_lock_bh(&br->lock);
  46         (*set)(br, val);
  47         spin_unlock_bh(&br->lock);
  48         return len;
  49 }
  50
  51
  52 static ssize_t show_forward_delay(struct device *d,
  53                                   struct device_attribute *attr, char *buf)
  54 {
  55         struct net_bridge *br = to_bridge(d);
  56         return sprintf(buf, "%lu\n", jiffies_to_clock_t(br->forward_delay));
  57 }
  58
  59 static void set_forward_delay(struct net_bridge *br, unsigned long val)
  60 {
  61         unsigned long delay = clock_t_to_jiffies(val);
  62         br->forward_delay = delay;
  63         if (br_is_root_bridge(br))
  64                 br->bridge_forward_delay = delay;
  65 }
  66
  67 static ssize_t store_forward_delay(struct device *d,
  68                                    struct device_attribute *attr,
  69                                    const char *buf, size_t len)
  70 {
  71         return store_bridge_parm(d, buf, len, set_forward_delay);
  72 }
  73 static DEVICE_ATTR(forward_delay, S_IRUGO | S_IWUSR,
  74                    show_forward_delay, store_forward_delay);
  75
  76 static ssize_t show_hello_time(struct device *d, struct device_attribute *attr,
  77                                char *buf)
  78 {
  79         return sprintf(buf, "%lu\n",
  80                        jiffies_to_clock_t(to_bridge(d)->hello_time));
  81 }
  82
  83 static void set_hello_time(struct net_bridge *br, unsigned long val)
  84 {
  85         unsigned long t = clock_t_to_jiffies(val);
  86         br->hello_time = t;
  87         if (br_is_root_bridge(br))
  88                 br->bridge_hello_time = t;
  89 }
  90
  91 static ssize_t store_hello_time(struct device *d,
  92                                 struct device_attribute *attr, const char *buf,
  93                                 size_t len)
  94 {
  95         return store_bridge_parm(d, buf, len, set_hello_time);
  96 }
  97 static DEVICE_ATTR(hello_time, S_IRUGO | S_IWUSR, show_hello_time,
  98                    store_hello_time);
  99
 100 static ssize_t show_max_age(struct device *d, struct device_attribute *attr,
 101                             char *buf)
 102 {
 103         return sprintf(buf, "%lu\n",
 104                        jiffies_to_clock_t(to_bridge(d)->max_age));
 105 }
 106
 107 static void set_max_age(struct net_bridge *br, unsigned long val)
 108 {
 109         unsigned long t = clock_t_to_jiffies(val);
 110         br->max_age = t;
 111         if (br_is_root_bridge(br))
 112                 br->bridge_max_age = t;
 113 }
 114
 115 static ssize_t store_max_age(struct device *d, struct device_attribute *attr,
 116                              const char *buf, size_t len)
 117 {
 118         return store_bridge_parm(d, buf, len, set_max_age);
 119 }
 120 static DEVICE_ATTR(max_age, S_IRUGO | S_IWUSR, show_max_age, store_max_age);
 121
 122 static ssize_t show_ageing_time(struct device *d,
 123                                 struct device_attribute *attr, char *buf)
 124 {
 125         struct net_bridge *br = to_bridge(d);
 126         return sprintf(buf, "%lu\n", jiffies_to_clock_t(br->ageing_time));
 127 }
 128
 129 static void set_ageing_time(struct net_bridge *br, unsigned long val)
 130 {
 131         br->ageing_time = clock_t_to_jiffies(val);
 132 }
 133
 134 static ssize_t store_ageing_time(struct device *d,
 135                                  struct device_attribute *attr,
 136                                  const char *buf, size_t len)
 137 {
 138         return store_bridge_parm(d, buf, len, set_ageing_time);
 139 }
 140 static DEVICE_ATTR(ageing_time, S_IRUGO | S_IWUSR, show_ageing_time,
 141                    store_ageing_time);
 142
 143 static ssize_t show_stp_state(struct device *d,
 144                               struct device_attribute *attr, char *buf)
 145 {
 146         struct net_bridge *br = to_bridge(d);
 147         return sprintf(buf, "%d\n", br->stp_enabled);
 148 }
 149
 150 static void set_stp_state(struct net_bridge *br, unsigned long val)
 151 {
 152         br->stp_enabled = val;
 153 }
 154
 155 static ssize_t store_stp_state(struct device *d,
 156                                struct device_attribute *attr, const char *buf,
 157                                size_t len)
 158 {
 159         return store_bridge_parm(d, buf, len, set_stp_state);
 160 }
 161 static DEVICE_ATTR(stp_state, S_IRUGO | S_IWUSR, show_stp_state,
 162                    store_stp_state);
 163
 164 static ssize_t show_priority(struct device *d, struct device_attribute *attr,
 165                              char *buf)
 166 {
 167         struct net_bridge *br = to_bridge(d);
 168         return sprintf(buf, "%d\n",
 169                        (br->bridge_id.prio[0] << 8) | br->bridge_id.prio[1]);
 170 }
 171
 172 static void set_priority(struct net_bridge *br, unsigned long val)
 173 {
 174         br_stp_set_bridge_priority(br, (u16) val);
 175 }
 176
 177 static ssize_t store_priority(struct device *d, struct device_attribute *attr,
 178                                const char *buf, size_t len)
 179 {
 180         return store_bridge_parm(d, buf, len, set_priority);
 181 }
 182 static DEVICE_ATTR(priority, S_IRUGO | S_IWUSR, show_priority, store_priority);
 183
 184 static ssize_t show_root_id(struct device *d, struct device_attribute *attr,
 185                             char *buf)
 186 {
 187         return br_show_bridge_id(buf, &to_bridge(d)->designated_root);
 188 }
 189 static DEVICE_ATTR(root_id, S_IRUGO, show_root_id, NULL);
 190
 191 static ssize_t show_bridge_id(struct device *d, struct device_attribute *attr,
 192                               char *buf)
 193 {
 194         return br_show_bridge_id(buf, &to_bridge(d)->bridge_id);
 195 }
 196 static DEVICE_ATTR(bridge_id, S_IRUGO, show_bridge_id, NULL);
 197
 198 static ssize_t show_root_port(struct device *d, struct device_attribute *attr,
 199                               char *buf)
 200 {
 201         return sprintf(buf, "%d\n", to_bridge(d)->root_port);
 202 }
 203 static DEVICE_ATTR(root_port, S_IRUGO, show_root_port, NULL);
 204
 205 static ssize_t show_root_path_cost(struct device *d,
 206                                    struct device_attribute *attr, char *buf)
 207 {
 208         return sprintf(buf, "%d\n", to_bridge(d)->root_path_cost);
 209 }
 210 static DEVICE_ATTR(root_path_cost, S_IRUGO, show_root_path_cost, NULL);
 211
 212 static ssize_t show_topology_change(struct device *d,
 213                                     struct device_attribute *attr, char *buf)
 214 {
 215         return sprintf(buf, "%d\n", to_bridge(d)->topology_change);
 216 }
 217 static DEVICE_ATTR(topology_change, S_IRUGO, show_topology_change, NULL);
 218
 219 static ssize_t show_topology_change_detected(struct device *d,
 220                                              struct device_attribute *attr,
 221                                              char *buf)
 222 {
 223         struct net_bridge *br = to_bridge(d);
 224         return sprintf(buf, "%d\n", br->topology_change_detected);
 225 }
 226 static DEVICE_ATTR(topology_change_detected, S_IRUGO,
 227                    show_topology_change_detected, NULL);
 228
 229 static ssize_t show_hello_timer(struct device *d,
 230                                 struct device_attribute *attr, char *buf)
 231 {
 232         struct net_bridge *br = to_bridge(d);
 233         return sprintf(buf, "%ld\n", br_timer_value(&br->hello_timer));
 234 }
 235 static DEVICE_ATTR(hello_timer, S_IRUGO, show_hello_timer, NULL);
 236
 237 static ssize_t show_tcn_timer(struct device *d, struct device_attribute *attr,
 238                               char *buf)
 239 {
 240         struct net_bridge *br = to_bridge(d);
 241         return sprintf(buf, "%ld\n", br_timer_value(&br->tcn_timer));
 242 }
 243 static DEVICE_ATTR(tcn_timer, S_IRUGO, show_tcn_timer, NULL);
 244
 245 static ssize_t show_topology_change_timer(struct device *d,
 246                                           struct device_attribute *attr,
 247                                           char *buf)
 248 {
 249         struct net_bridge *br = to_bridge(d);
 250         return sprintf(buf, "%ld\n", br_timer_value(&br->topology_change_timer));
 251 }
 252 static DEVICE_ATTR(topology_change_timer, S_IRUGO, show_topology_change_timer,
 253                    NULL);
 254
 255 static ssize_t show_gc_timer(struct device *d, struct device_attribute *attr,
 256                              char *buf)
 257 {
 258         struct net_bridge *br = to_bridge(d);
 259         return sprintf(buf, "%ld\n", br_timer_value(&br->gc_timer));
 260 }
 261 static DEVICE_ATTR(gc_timer, S_IRUGO, show_gc_timer, NULL);
 262
 263 static ssize_t show_group_addr(struct device *d,
 264                                struct device_attribute *attr, char *buf)
 265 {
 266         struct net_bridge *br = to_bridge(d);
 267         return sprintf(buf, "%x:%x:%x:%x:%x:%x\n",
 268                        br->group_addr[0], br->group_addr[1],
 269                        br->group_addr[2], br->group_addr[3],
 270                        br->group_addr[4], br->group_addr[5]);
 271 }
 272
 273 static ssize_t store_group_addr(struct device *d,
 274                                 struct device_attribute *attr,
 275                                 const char *buf, size_t len)
 276 {
 277         struct net_bridge *br = to_bridge(d);
 278         unsigned new_addr[6];
 279         int i;
 280
 281         if (!capable(CAP_NET_ADMIN))
 282                 return -EPERM;
 283
 284         if (sscanf(buf, "%x:%x:%x:%x:%x:%x",
 285                    &new_addr[0], &new_addr[1], &new_addr[2],
 286                    &new_addr[3], &new_addr[4], &new_addr[5]) != 6)
 287                 return -EINVAL;
 288
 289         /* Must be 01:80:c2:00:00:0X */
 290         for (i = 0; i < 5; i++)
 291                 if (new_addr[i] != br_group_address[i])
 292                         return -EINVAL;
 293
 294         if (new_addr[5] & ~0xf)
 295                 return -EINVAL;
 296
 297         if (new_addr[5] == 1    /* 802.3x Pause address */
 298             || new_addr[5] == 2 /* 802.3ad Slow protocols */
 299             || new_addr[5] == 3) /* 802.1X PAE address */
 300                 return -EINVAL;
 301
 302         spin_lock_bh(&br->lock);
 303         for (i = 0; i < 6; i++)
 304                 br->group_addr[i] = new_addr[i];
 305         spin_unlock_bh(&br->lock);
 306         return len;
 307 }
 308
 309 static DEVICE_ATTR(group_addr, S_IRUGO | S_IWUSR,
 310                    show_group_addr, store_group_addr);
 311
 312
 313 static struct attribute *bridge_attrs[] = {
 314         &dev_attr_forward_delay.attr,
 315         &dev_attr_hello_time.attr,
 316         &dev_attr_max_age.attr,
 317         &dev_attr_ageing_time.attr,
 318         &dev_attr_stp_state.attr,
 319         &dev_attr_priority.attr,
 320         &dev_attr_bridge_id.attr,
 321         &dev_attr_root_id.attr,
 322         &dev_attr_root_path_cost.attr,
 323         &dev_attr_root_port.attr,
 324         &dev_attr_topology_change.attr,
 325         &dev_attr_topology_change_detected.attr,
 326         &dev_attr_hello_timer.attr,
 327         &dev_attr_tcn_timer.attr,
 328         &dev_attr_topology_change_timer.attr,
 329         &dev_attr_gc_timer.attr,
 330         &dev_attr_group_addr.attr,
 331         NULL
 332 };
 333
 334 static struct attribute_group bridge_group = {
 335         .name = SYSFS_BRIDGE_ATTR,
 336         .attrs = bridge_attrs,
 337 };
 338
 339 /*
 340  * Export the forwarding information table as a binary file
 341  * The records are struct __fdb_entry.
 342  *
 343  * Returns the number of bytes read.
 344  */
 345 static ssize_t brforward_read(struct kobject *kobj, char *buf,
 346                            loff_t off, size_t count)
 347 {
 348         struct device *dev = to_dev(kobj);
 349         struct net_bridge *br = to_bridge(dev);
 350         int n;
 351
 352         /* must read whole records */
 353         if (off % sizeof(struct __fdb_entry) != 0)
 354                 return -EINVAL;
 355
 356         n =  br_fdb_fillbuf(br, buf,
 357                             count / sizeof(struct __fdb_entry),
 358                             off / sizeof(struct __fdb_entry));
 359
 360         if (n > 0)
 361                 n *= sizeof(struct __fdb_entry);
 362
 363         return n;
 364 }
 365
 366 static struct bin_attribute bridge_forward = {
 367         .attr = { .name = SYSFS_BRIDGE_FDB,
 368                   .mode = S_IRUGO,
 369                   .owner = THIS_MODULE, },
 370         .read = brforward_read,
 371 };
 372
 373 /*
 374  * Add entries in sysfs onto the existing network class device
 375  * for the bridge.
 376  *   Adds a attribute group "bridge" containing tuning parameters.
 377  *   Binary attribute containing the forward table
 378  *   Sub directory to hold links to interfaces.
 379  *
 380  * Note: the ifobj exists only to be a subdirectory
 381  *   to hold links.  The ifobj exists in same data structure
 382  *   as it's parent the bridge so reference counting works.
 383  */
 384 int br_sysfs_addbr(struct net_device *dev)
 385 {
 386         struct kobject *brobj = &dev->dev.kobj;
 387         struct net_bridge *br = netdev_priv(dev);
 388         int err;
 389
 390         err = sysfs_create_group(brobj, &bridge_group);
 391         if (err) {
 392                 pr_info("%s: can't create group %s/%s\n",
 393                         __FUNCTION__, dev->name, bridge_group.name);
 394                 goto out1;
 395         }
 396
 397         err = sysfs_create_bin_file(brobj, &bridge_forward);
 398         if (err) {
 399                 pr_info("%s: can't create attribute file %s/%s\n",
 400                         __FUNCTION__, dev->name, bridge_forward.attr.name);
 401                 goto out2;
 402         }
 403
 404
 405         kobject_set_name(&br->ifobj, SYSFS_BRIDGE_PORT_SUBDIR);
 406         br->ifobj.ktype = NULL;
 407         br->ifobj.kset = NULL;
 408         br->ifobj.parent = brobj;
 409
 410         err = kobject_register(&br->ifobj);
 411         if (err) {
 412                 pr_info("%s: can't add kobject (directory) %s/%s\n",
 413                         __FUNCTION__, dev->name, br->ifobj.name);
 414                 goto out3;
 415         }
 416         return 0;
 417  out3:
 418         sysfs_remove_bin_file(&dev->dev.kobj, &bridge_forward);
 419  out2:
 420         sysfs_remove_group(&dev->dev.kobj, &bridge_group);
 421  out1:
 422         return err;
 423
 424 }
 425
 426 void br_sysfs_delbr(struct net_device *dev)
 427 {
 428         struct kobject *kobj = &dev->dev.kobj;
 429         struct net_bridge *br = netdev_priv(dev);
 430
 431         kobject_unregister(&br->ifobj);
 432         sysfs_remove_bin_file(kobj, &bridge_forward);
 433         sysfs_remove_group(kobj, &bridge_group);
 434 }