1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Sysfs attributes of bridge ports 4 * Linux ethernet bridge 5 * 6 * Authors: 7 * Stephen Hemminger <shemminger@osdl.org> 8 */ 9 10 #include <linux/capability.h> 11 #include <linux/kernel.h> 12 #include <linux/netdevice.h> 13 #include <linux/if_bridge.h> 14 #include <linux/rtnetlink.h> 15 #include <linux/spinlock.h> 16 #include <linux/sched/signal.h> 17 18 #include "br_private.h" 19 20 /* IMPORTANT: new bridge port options must be added with netlink support only 21 * please do not add new sysfs entries 22 */ 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 int (*store_raw)(struct net_bridge_port *, char *); 29 }; 30 31 #define BRPORT_ATTR_RAW(_name, _mode, _show, _store) \ 32 const struct brport_attribute brport_attr_##_name = { \ 33 .attr = {.name = __stringify(_name), \ 34 .mode = _mode }, \ 35 .show = _show, \ 36 .store_raw = _store, \ 37 }; 38 39 #define BRPORT_ATTR(_name, _mode, _show, _store) \ 40 const struct brport_attribute brport_attr_##_name = { \ 41 .attr = {.name = __stringify(_name), \ 42 .mode = _mode }, \ 43 .show = _show, \ 44 .store = _store, \ 45 }; 46 47 #define BRPORT_ATTR_FLAG(_name, _mask) \ 48 static ssize_t show_##_name(struct net_bridge_port *p, char *buf) \ 49 { \ 50 return sysfs_emit(buf, "%d\n", !!(p->flags & _mask)); \ 51 } \ 52 static int store_##_name(struct net_bridge_port *p, unsigned long v) \ 53 { \ 54 return store_flag(p, v, _mask); \ 55 } \ 56 static BRPORT_ATTR(_name, 0644, \ 57 show_##_name, store_##_name) 58 59 static int store_flag(struct net_bridge_port *p, unsigned long v, 60 unsigned long mask) 61 { 62 struct netlink_ext_ack extack = {0}; 63 unsigned long flags = p->flags; 64 int err; 65 66 if (v) 67 flags |= mask; 68 else 69 flags &= ~mask; 70 71 if (flags != p->flags) { 72 err = br_switchdev_set_port_flag(p, flags, mask, &extack); 73 if (err) { 74 netdev_err(p->dev, "%s\n", extack._msg); 75 return err; 76 } 77 78 p->flags = flags; 79 br_port_flags_change(p, mask); 80 } 81 return 0; 82 } 83 84 static ssize_t show_path_cost(struct net_bridge_port *p, char *buf) 85 { 86 return sysfs_emit(buf, "%d\n", p->path_cost); 87 } 88 89 static int store_path_cost(struct net_bridge_port *p, unsigned long v) 90 { 91 int ret; 92 93 spin_lock_bh(&p->br->lock); 94 ret = br_stp_set_path_cost(p, v); 95 spin_unlock_bh(&p->br->lock); 96 return ret; 97 } 98 99 static BRPORT_ATTR(path_cost, 0644, show_path_cost, store_path_cost); 100 101 static ssize_t show_priority(struct net_bridge_port *p, char *buf) 102 { 103 return sysfs_emit(buf, "%d\n", p->priority); 104 } 105 106 static int store_priority(struct net_bridge_port *p, unsigned long v) 107 { 108 int ret; 109 110 spin_lock_bh(&p->br->lock); 111 ret = br_stp_set_port_priority(p, v); 112 spin_unlock_bh(&p->br->lock); 113 return ret; 114 } 115 116 static BRPORT_ATTR(priority, 0644, show_priority, store_priority); 117 118 static ssize_t show_designated_root(struct net_bridge_port *p, char *buf) 119 { 120 return br_show_bridge_id(buf, &p->designated_root); 121 } 122 static BRPORT_ATTR(designated_root, 0444, show_designated_root, NULL); 123 124 static ssize_t show_designated_bridge(struct net_bridge_port *p, char *buf) 125 { 126 return br_show_bridge_id(buf, &p->designated_bridge); 127 } 128 static BRPORT_ATTR(designated_bridge, 0444, show_designated_bridge, NULL); 129 130 static ssize_t show_designated_port(struct net_bridge_port *p, char *buf) 131 { 132 return sysfs_emit(buf, "%d\n", p->designated_port); 133 } 134 static BRPORT_ATTR(designated_port, 0444, show_designated_port, NULL); 135 136 static ssize_t show_designated_cost(struct net_bridge_port *p, char *buf) 137 { 138 return sysfs_emit(buf, "%d\n", p->designated_cost); 139 } 140 static BRPORT_ATTR(designated_cost, 0444, show_designated_cost, NULL); 141 142 static ssize_t show_port_id(struct net_bridge_port *p, char *buf) 143 { 144 return sysfs_emit(buf, "0x%x\n", p->port_id); 145 } 146 static BRPORT_ATTR(port_id, 0444, show_port_id, NULL); 147 148 static ssize_t show_port_no(struct net_bridge_port *p, char *buf) 149 { 150 return sysfs_emit(buf, "0x%x\n", p->port_no); 151 } 152 153 static BRPORT_ATTR(port_no, 0444, show_port_no, NULL); 154 155 static ssize_t show_change_ack(struct net_bridge_port *p, char *buf) 156 { 157 return sysfs_emit(buf, "%d\n", p->topology_change_ack); 158 } 159 static BRPORT_ATTR(change_ack, 0444, show_change_ack, NULL); 160 161 static ssize_t show_config_pending(struct net_bridge_port *p, char *buf) 162 { 163 return sysfs_emit(buf, "%d\n", p->config_pending); 164 } 165 static BRPORT_ATTR(config_pending, 0444, show_config_pending, NULL); 166 167 static ssize_t show_port_state(struct net_bridge_port *p, char *buf) 168 { 169 return sysfs_emit(buf, "%d\n", p->state); 170 } 171 static BRPORT_ATTR(state, 0444, show_port_state, NULL); 172 173 static ssize_t show_message_age_timer(struct net_bridge_port *p, 174 char *buf) 175 { 176 return sysfs_emit(buf, "%ld\n", br_timer_value(&p->message_age_timer)); 177 } 178 static BRPORT_ATTR(message_age_timer, 0444, show_message_age_timer, NULL); 179 180 static ssize_t show_forward_delay_timer(struct net_bridge_port *p, 181 char *buf) 182 { 183 return sysfs_emit(buf, "%ld\n", br_timer_value(&p->forward_delay_timer)); 184 } 185 static BRPORT_ATTR(forward_delay_timer, 0444, show_forward_delay_timer, NULL); 186 187 static ssize_t show_hold_timer(struct net_bridge_port *p, 188 char *buf) 189 { 190 return sysfs_emit(buf, "%ld\n", br_timer_value(&p->hold_timer)); 191 } 192 static BRPORT_ATTR(hold_timer, 0444, show_hold_timer, NULL); 193 194 static int store_flush(struct net_bridge_port *p, unsigned long v) 195 { 196 br_fdb_delete_by_port(p->br, p, 0, 0); // Don't delete local entry 197 return 0; 198 } 199 static BRPORT_ATTR(flush, 0200, NULL, store_flush); 200 201 static ssize_t show_group_fwd_mask(struct net_bridge_port *p, char *buf) 202 { 203 return sysfs_emit(buf, "%#x\n", p->group_fwd_mask); 204 } 205 206 static int store_group_fwd_mask(struct net_bridge_port *p, 207 unsigned long v) 208 { 209 if (v & BR_GROUPFWD_MACPAUSE) 210 return -EINVAL; 211 p->group_fwd_mask = v; 212 213 return 0; 214 } 215 static BRPORT_ATTR(group_fwd_mask, 0644, show_group_fwd_mask, 216 store_group_fwd_mask); 217 218 static ssize_t show_backup_port(struct net_bridge_port *p, char *buf) 219 { 220 struct net_bridge_port *backup_p; 221 int ret = 0; 222 223 rcu_read_lock(); 224 backup_p = rcu_dereference(p->backup_port); 225 if (backup_p) 226 ret = sysfs_emit(buf, "%s\n", backup_p->dev->name); 227 rcu_read_unlock(); 228 229 return ret; 230 } 231 232 static int store_backup_port(struct net_bridge_port *p, char *buf) 233 { 234 struct net_device *backup_dev = NULL; 235 char *nl = strchr(buf, '\n'); 236 237 if (nl) 238 *nl = '\0'; 239 240 if (strlen(buf) > 0) { 241 backup_dev = __dev_get_by_name(dev_net(p->dev), buf); 242 if (!backup_dev) 243 return -ENOENT; 244 } 245 246 return nbp_backup_change(p, backup_dev); 247 } 248 static BRPORT_ATTR_RAW(backup_port, 0644, show_backup_port, store_backup_port); 249 250 BRPORT_ATTR_FLAG(hairpin_mode, BR_HAIRPIN_MODE); 251 BRPORT_ATTR_FLAG(bpdu_guard, BR_BPDU_GUARD); 252 BRPORT_ATTR_FLAG(root_block, BR_ROOT_BLOCK); 253 BRPORT_ATTR_FLAG(learning, BR_LEARNING); 254 BRPORT_ATTR_FLAG(unicast_flood, BR_FLOOD); 255 BRPORT_ATTR_FLAG(proxyarp, BR_PROXYARP); 256 BRPORT_ATTR_FLAG(proxyarp_wifi, BR_PROXYARP_WIFI); 257 BRPORT_ATTR_FLAG(multicast_flood, BR_MCAST_FLOOD); 258 BRPORT_ATTR_FLAG(broadcast_flood, BR_BCAST_FLOOD); 259 BRPORT_ATTR_FLAG(neigh_suppress, BR_NEIGH_SUPPRESS); 260 BRPORT_ATTR_FLAG(isolated, BR_ISOLATED); 261 262 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING 263 static ssize_t show_multicast_router(struct net_bridge_port *p, char *buf) 264 { 265 return sysfs_emit(buf, "%d\n", p->multicast_ctx.multicast_router); 266 } 267 268 static int store_multicast_router(struct net_bridge_port *p, 269 unsigned long v) 270 { 271 return br_multicast_set_port_router(&p->multicast_ctx, v); 272 } 273 static BRPORT_ATTR(multicast_router, 0644, show_multicast_router, 274 store_multicast_router); 275 276 BRPORT_ATTR_FLAG(multicast_fast_leave, BR_MULTICAST_FAST_LEAVE); 277 BRPORT_ATTR_FLAG(multicast_to_unicast, BR_MULTICAST_TO_UNICAST); 278 #endif 279 280 static const struct brport_attribute *brport_attrs[] = { 281 &brport_attr_path_cost, 282 &brport_attr_priority, 283 &brport_attr_port_id, 284 &brport_attr_port_no, 285 &brport_attr_designated_root, 286 &brport_attr_designated_bridge, 287 &brport_attr_designated_port, 288 &brport_attr_designated_cost, 289 &brport_attr_state, 290 &brport_attr_change_ack, 291 &brport_attr_config_pending, 292 &brport_attr_message_age_timer, 293 &brport_attr_forward_delay_timer, 294 &brport_attr_hold_timer, 295 &brport_attr_flush, 296 &brport_attr_hairpin_mode, 297 &brport_attr_bpdu_guard, 298 &brport_attr_root_block, 299 &brport_attr_learning, 300 &brport_attr_unicast_flood, 301 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING 302 &brport_attr_multicast_router, 303 &brport_attr_multicast_fast_leave, 304 &brport_attr_multicast_to_unicast, 305 #endif 306 &brport_attr_proxyarp, 307 &brport_attr_proxyarp_wifi, 308 &brport_attr_multicast_flood, 309 &brport_attr_broadcast_flood, 310 &brport_attr_group_fwd_mask, 311 &brport_attr_neigh_suppress, 312 &brport_attr_isolated, 313 &brport_attr_backup_port, 314 NULL 315 }; 316 317 #define to_brport_attr(_at) container_of(_at, struct brport_attribute, attr) 318 319 static ssize_t brport_show(struct kobject *kobj, 320 struct attribute *attr, char *buf) 321 { 322 struct brport_attribute *brport_attr = to_brport_attr(attr); 323 struct net_bridge_port *p = kobj_to_brport(kobj); 324 325 if (!brport_attr->show) 326 return -EINVAL; 327 328 return brport_attr->show(p, buf); 329 } 330 331 static ssize_t brport_store(struct kobject *kobj, 332 struct attribute *attr, 333 const char *buf, size_t count) 334 { 335 struct brport_attribute *brport_attr = to_brport_attr(attr); 336 struct net_bridge_port *p = kobj_to_brport(kobj); 337 ssize_t ret = -EINVAL; 338 unsigned long val; 339 char *endp; 340 341 if (!ns_capable(dev_net(p->dev)->user_ns, CAP_NET_ADMIN)) 342 return -EPERM; 343 344 if (!rtnl_trylock()) 345 return restart_syscall(); 346 347 if (brport_attr->store_raw) { 348 char *buf_copy; 349 350 buf_copy = kstrndup(buf, count, GFP_KERNEL); 351 if (!buf_copy) { 352 ret = -ENOMEM; 353 goto out_unlock; 354 } 355 ret = brport_attr->store_raw(p, buf_copy); 356 kfree(buf_copy); 357 } else if (brport_attr->store) { 358 val = simple_strtoul(buf, &endp, 0); 359 if (endp == buf) 360 goto out_unlock; 361 ret = brport_attr->store(p, val); 362 } 363 364 if (!ret) { 365 br_ifinfo_notify(RTM_NEWLINK, NULL, p); 366 ret = count; 367 } 368 out_unlock: 369 rtnl_unlock(); 370 371 return ret; 372 } 373 374 const struct sysfs_ops brport_sysfs_ops = { 375 .show = brport_show, 376 .store = brport_store, 377 }; 378 379 /* 380 * Add sysfs entries to ethernet device added to a bridge. 381 * Creates a brport subdirectory with bridge attributes. 382 * Puts symlink in bridge's brif subdirectory 383 */ 384 int br_sysfs_addif(struct net_bridge_port *p) 385 { 386 struct net_bridge *br = p->br; 387 const struct brport_attribute **a; 388 int err; 389 390 err = sysfs_create_link(&p->kobj, &br->dev->dev.kobj, 391 SYSFS_BRIDGE_PORT_LINK); 392 if (err) 393 return err; 394 395 for (a = brport_attrs; *a; ++a) { 396 err = sysfs_create_file(&p->kobj, &((*a)->attr)); 397 if (err) 398 return err; 399 } 400 401 strscpy(p->sysfs_name, p->dev->name, IFNAMSIZ); 402 return sysfs_create_link(br->ifobj, &p->kobj, p->sysfs_name); 403 } 404 405 /* Rename bridge's brif symlink */ 406 int br_sysfs_renameif(struct net_bridge_port *p) 407 { 408 struct net_bridge *br = p->br; 409 int err; 410 411 /* If a rename fails, the rollback will cause another 412 * rename call with the existing name. 413 */ 414 if (!strncmp(p->sysfs_name, p->dev->name, IFNAMSIZ)) 415 return 0; 416 417 err = sysfs_rename_link(br->ifobj, &p->kobj, 418 p->sysfs_name, p->dev->name); 419 if (err) 420 netdev_notice(br->dev, "unable to rename link %s to %s", 421 p->sysfs_name, p->dev->name); 422 else 423 strscpy(p->sysfs_name, p->dev->name, IFNAMSIZ); 424 425 return err; 426 } 427