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         rtnl_lock();
 153         spin_unlock_bh(&br->lock);
 154         br_stp_set_enabled(br, val);
 155         spin_lock_bh(&br->lock);
 156         rtnl_unlock();
 157 }
 158
 159 static ssize_t store_stp_state(struct device *d,
 160                                struct device_attribute *attr, const char *buf,
 161                                size_t len)
 162 {
 163         return store_bridge_parm(d, buf, len, set_stp_state);
 164 }
 165 static DEVICE_ATTR(stp_state, S_IRUGO | S_IWUSR, show_stp_state,
 166                    store_stp_state);
 167
 168 static ssize_t show_priority(struct device *d, struct device_attribute *attr,
 169                              char *buf)
 170 {
 171         struct net_bridge *br = to_bridge(d);
 172         return sprintf(buf, "%d\n",
 173                        (br->bridge_id.prio[0] << 8) | br->bridge_id.prio[1]);
 174 }
 175
 176 static void set_priority(struct net_bridge *br, unsigned long val)
 177 {
 178         br_stp_set_bridge_priority(br, (u16) val);
 179 }
 180
 181 static ssize_t store_priority(struct device *d, struct device_attribute *attr,
 182                                const char *buf, size_t len)
 183 {
 184         return store_bridge_parm(d, buf, len, set_priority);
 185 }
 186 static DEVICE_ATTR(priority, S_IRUGO | S_IWUSR, show_priority, store_priority);
 187
 188 static ssize_t show_root_id(struct device *d, struct device_attribute *attr,
 189                             char *buf)
 190 {
 191         return br_show_bridge_id(buf, &to_bridge(d)->designated_root);
 192 }
 193 static DEVICE_ATTR(root_id, S_IRUGO, show_root_id, NULL);
 194
 195 static ssize_t show_bridge_id(struct device *d, struct device_attribute *attr,
 196                               char *buf)
 197 {
 198         return br_show_bridge_id(buf, &to_bridge(d)->bridge_id);
 199 }
 200 static DEVICE_ATTR(bridge_id, S_IRUGO, show_bridge_id, NULL);
 201
 202 static ssize_t show_root_port(struct device *d, struct device_attribute *attr,
 203                               char *buf)
 204 {
 205         return sprintf(buf, "%d\n", to_bridge(d)->root_port);
 206 }
 207 static DEVICE_ATTR(root_port, S_IRUGO, show_root_port, NULL);
 208
 209 static ssize_t show_root_path_cost(struct device *d,
 210                                    struct device_attribute *attr, char *buf)
 211 {
 212         return sprintf(buf, "%d\n", to_bridge(d)->root_path_cost);
 213 }
 214 static DEVICE_ATTR(root_path_cost, S_IRUGO, show_root_path_cost, NULL);
 215
 216 static ssize_t show_topology_change(struct device *d,
 217                                     struct device_attribute *attr, char *buf)
 218 {
 219         return sprintf(buf, "%d\n", to_bridge(d)->topology_change);
 220 }
 221 static DEVICE_ATTR(topology_change, S_IRUGO, show_topology_change, NULL);
 222
 223 static ssize_t show_topology_change_detected(struct device *d,
 224                                              struct device_attribute *attr,
 225                                              char *buf)
 226 {
 227         struct net_bridge *br = to_bridge(d);
 228         return sprintf(buf, "%d\n", br->topology_change_detected);
 229 }
 230 static DEVICE_ATTR(topology_change_detected, S_IRUGO,
 231                    show_topology_change_detected, NULL);
 232
 233 static ssize_t show_hello_timer(struct device *d,
 234                                 struct device_attribute *attr, char *buf)
 235 {
 236         struct net_bridge *br = to_bridge(d);
 237         return sprintf(buf, "%ld\n", br_timer_value(&br->hello_timer));
 238 }
 239 static DEVICE_ATTR(hello_timer, S_IRUGO, show_hello_timer, NULL);
 240
 241 static ssize_t show_tcn_timer(struct device *d, struct device_attribute *attr,
 242                               char *buf)
 243 {
 244         struct net_bridge *br = to_bridge(d);
 245         return sprintf(buf, "%ld\n", br_timer_value(&br->tcn_timer));
 246 }
 247 static DEVICE_ATTR(tcn_timer, S_IRUGO, show_tcn_timer, NULL);
 248
 249 static ssize_t show_topology_change_timer(struct device *d,
 250                                           struct device_attribute *attr,
 251                                           char *buf)
 252 {
 253         struct net_bridge *br = to_bridge(d);
 254         return sprintf(buf, "%ld\n", br_timer_value(&br->topology_change_timer));
 255 }
 256 static DEVICE_ATTR(topology_change_timer, S_IRUGO, show_topology_change_timer,
 257                    NULL);
 258
 259 static ssize_t show_gc_timer(struct device *d, struct device_attribute *attr,
 260                              char *buf)
 261 {
 262         struct net_bridge *br = to_bridge(d);
 263         return sprintf(buf, "%ld\n", br_timer_value(&br->gc_timer));
 264 }
 265 static DEVICE_ATTR(gc_timer, S_IRUGO, show_gc_timer, NULL);
 266
 267 static ssize_t show_group_addr(struct device *d,
 268                                struct device_attribute *attr, char *buf)
 269 {
 270         struct net_bridge *br = to_bridge(d);
 271         return sprintf(buf, "%x:%x:%x:%x:%x:%x\n",
 272                        br->group_addr[0], br->group_addr[1],
 273                        br->group_addr[2], br->group_addr[3],
 274                        br->group_addr[4], br->group_addr[5]);
 275 }
 276
 277 static ssize_t store_group_addr(struct device *d,
 278                                 struct device_attribute *attr,
 279                                 const char *buf, size_t len)
 280 {
 281         struct net_bridge *br = to_bridge(d);
 282         unsigned new_addr[6];
 283         int i;
 284
 285         if (!capable(CAP_NET_ADMIN))
 286                 return -EPERM;
 287
 288         if (sscanf(buf, "%x:%x:%x:%x:%x:%x",
 289                    &new_addr[0], &new_addr[1], &new_addr[2],
 290                    &new_addr[3], &new_addr[4], &new_addr[5]) != 6)
 291                 return -EINVAL;
 292
 293         /* Must be 01:80:c2:00:00:0X */
 294         for (i = 0; i < 5; i++)
 295                 if (new_addr[i] != br_group_address[i])
 296                         return -EINVAL;
 297
 298         if (new_addr[5] & ~0xf)
 299                 return -EINVAL;
 300
 301         if (new_addr[5] == 1    /* 802.3x Pause address */
 302             || new_addr[5] == 2 /* 802.3ad Slow protocols */
 303             || new_addr[5] == 3) /* 802.1X PAE address */
 304                 return -EINVAL;
 305
 306         spin_lock_bh(&br->lock);
 307         for (i = 0; i < 6; i++)
 308                 br->group_addr[i] = new_addr[i];
 309         spin_unlock_bh(&br->lock);
 310         return len;
 311 }
 312
 313 static DEVICE_ATTR(group_addr, S_IRUGO | S_IWUSR,
 314                    show_group_addr, store_group_addr);
 315
 316 static ssize_t store_flush(struct device *d,
 317                            struct device_attribute *attr,
 318                            const char *buf, size_t len)
 319 {
 320         struct net_bridge *br = to_bridge(d);
 321
 322         if (!capable(CAP_NET_ADMIN))
 323                 return -EPERM;
 324
 325         br_fdb_flush(br);
 326         return len;
 327 }
 328 static DEVICE_ATTR(flush, S_IWUSR, NULL, store_flush);
 329
 330 static struct attribute *bridge_attrs[] = {
 331         &dev_attr_forward_delay.attr,
 332         &dev_attr_hello_time.attr,
 333         &dev_attr_max_age.attr,
 334         &dev_attr_ageing_time.attr,
 335         &dev_attr_stp_state.attr,
 336         &dev_attr_priority.attr,
 337         &dev_attr_bridge_id.attr,
 338         &dev_attr_root_id.attr,
 339         &dev_attr_root_path_cost.attr,
 340         &dev_attr_root_port.attr,
 341         &dev_attr_topology_change.attr,
 342         &dev_attr_topology_change_detected.attr,
 343         &dev_attr_hello_timer.attr,
 344         &dev_attr_tcn_timer.attr,
 345         &dev_attr_topology_change_timer.attr,
 346         &dev_attr_gc_timer.attr,
 347         &dev_attr_group_addr.attr,
 348         &dev_attr_flush.attr,
 349         NULL
 350 };
 351
 352 static struct attribute_group bridge_group = {
 353         .name = SYSFS_BRIDGE_ATTR,
 354         .attrs = bridge_attrs,
 355 };
 356
 357 /*
 358  * Export the forwarding information table as a binary file
 359  * The records are struct __fdb_entry.
 360  *
 361  * Returns the number of bytes read.
 362  */
 363 static ssize_t brforward_read(struct kobject *kobj, char *buf,
 364                            loff_t off, size_t count)
 365 {
 366         struct device *dev = to_dev(kobj);
 367         struct net_bridge *br = to_bridge(dev);
 368         int n;
 369
 370         /* must read whole records */
 371         if (off % sizeof(struct __fdb_entry) != 0)
 372                 return -EINVAL;
 373
 374         n =  br_fdb_fillbuf(br, buf,
 375                             count / sizeof(struct __fdb_entry),
 376                             off / sizeof(struct __fdb_entry));
 377
 378         if (n > 0)
 379                 n *= sizeof(struct __fdb_entry);
 380
 381         return n;
 382 }
 383
 384 static struct bin_attribute bridge_forward = {
 385         .attr = { .name = SYSFS_BRIDGE_FDB,
 386                   .mode = S_IRUGO,
 387                   .owner = THIS_MODULE, },
 388         .read = brforward_read,
 389 };
 390
 391 /*
 392  * Add entries in sysfs onto the existing network class device
 393  * for the bridge.
 394  *   Adds a attribute group "bridge" containing tuning parameters.
 395  *   Binary attribute containing the forward table
 396  *   Sub directory to hold links to interfaces.
 397  *
 398  * Note: the ifobj exists only to be a subdirectory
 399  *   to hold links.  The ifobj exists in same data structure
 400  *   as it's parent the bridge so reference counting works.
 401  */
 402 int br_sysfs_addbr(struct net_device *dev)
 403 {
 404         struct kobject *brobj = &dev->dev.kobj;
 405         struct net_bridge *br = netdev_priv(dev);
 406         int err;
 407
 408         err = sysfs_create_group(brobj, &bridge_group);
 409         if (err) {
 410                 pr_info("%s: can't create group %s/%s\n",
 411                         __FUNCTION__, dev->name, bridge_group.name);
 412                 goto out1;
 413         }
 414
 415         err = sysfs_create_bin_file(brobj, &bridge_forward);
 416         if (err) {
 417                 pr_info("%s: can't create attribute file %s/%s\n",
 418                         __FUNCTION__, dev->name, bridge_forward.attr.name);
 419                 goto out2;
 420         }
 421
 422
 423         kobject_set_name(&br->ifobj, SYSFS_BRIDGE_PORT_SUBDIR);
 424         br->ifobj.ktype = NULL;
 425         br->ifobj.kset = NULL;
 426         br->ifobj.parent = brobj;
 427
 428         err = kobject_register(&br->ifobj);
 429         if (err) {
 430                 pr_info("%s: can't add kobject (directory) %s/%s\n",
 431                         __FUNCTION__, dev->name, br->ifobj.name);
 432                 goto out3;
 433         }
 434         return 0;
 435  out3:
 436         sysfs_remove_bin_file(&dev->dev.kobj, &bridge_forward);
 437  out2:
 438         sysfs_remove_group(&dev->dev.kobj, &bridge_group);
 439  out1:
 440         return err;
 441
 442 }
 443
 444 void br_sysfs_delbr(struct net_device *dev)
 445 {
 446         struct kobject *kobj = &dev->dev.kobj;
 447         struct net_bridge *br = netdev_priv(dev);
 448
 449         kobject_unregister(&br->ifobj);
 450         sysfs_remove_bin_file(kobj, &bridge_forward);
 451         sysfs_remove_group(kobj, &bridge_group);
 452 }