1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * drivers/net/bond/bond_options.c - bonding options
4 * Copyright (c) 2013 Jiri Pirko <jiri@resnulli.us>
5 * Copyright (c) 2013 Scott Feldman <sfeldma@cumulusnetworks.com>
8 #include <linux/errno.h>
10 #include <linux/netdevice.h>
11 #include <linux/spinlock.h>
12 #include <linux/rcupdate.h>
13 #include <linux/ctype.h>
14 #include <linux/inet.h>
15 #include <linux/sched/signal.h>
17 #include <net/bonding.h>
19 static int bond_option_active_slave_set(struct bonding *bond,
20 const struct bond_opt_value *newval);
21 static int bond_option_miimon_set(struct bonding *bond,
22 const struct bond_opt_value *newval);
23 static int bond_option_updelay_set(struct bonding *bond,
24 const struct bond_opt_value *newval);
25 static int bond_option_downdelay_set(struct bonding *bond,
26 const struct bond_opt_value *newval);
27 static int bond_option_peer_notif_delay_set(struct bonding *bond,
28 const struct bond_opt_value *newval);
29 static int bond_option_use_carrier_set(struct bonding *bond,
30 const struct bond_opt_value *newval);
31 static int bond_option_arp_interval_set(struct bonding *bond,
32 const struct bond_opt_value *newval);
33 static int bond_option_arp_ip_target_add(struct bonding *bond, __be32 target);
34 static int bond_option_arp_ip_target_rem(struct bonding *bond, __be32 target);
35 static int bond_option_arp_ip_targets_set(struct bonding *bond,
36 const struct bond_opt_value *newval);
37 static int bond_option_arp_validate_set(struct bonding *bond,
38 const struct bond_opt_value *newval);
39 static int bond_option_arp_all_targets_set(struct bonding *bond,
40 const struct bond_opt_value *newval);
41 static int bond_option_primary_set(struct bonding *bond,
42 const struct bond_opt_value *newval);
43 static int bond_option_primary_reselect_set(struct bonding *bond,
44 const struct bond_opt_value *newval);
45 static int bond_option_fail_over_mac_set(struct bonding *bond,
46 const struct bond_opt_value *newval);
47 static int bond_option_xmit_hash_policy_set(struct bonding *bond,
48 const struct bond_opt_value *newval);
49 static int bond_option_resend_igmp_set(struct bonding *bond,
50 const struct bond_opt_value *newval);
51 static int bond_option_num_peer_notif_set(struct bonding *bond,
52 const struct bond_opt_value *newval);
53 static int bond_option_all_slaves_active_set(struct bonding *bond,
54 const struct bond_opt_value *newval);
55 static int bond_option_min_links_set(struct bonding *bond,
56 const struct bond_opt_value *newval);
57 static int bond_option_lp_interval_set(struct bonding *bond,
58 const struct bond_opt_value *newval);
59 static int bond_option_pps_set(struct bonding *bond,
60 const struct bond_opt_value *newval);
61 static int bond_option_lacp_rate_set(struct bonding *bond,
62 const struct bond_opt_value *newval);
63 static int bond_option_ad_select_set(struct bonding *bond,
64 const struct bond_opt_value *newval);
65 static int bond_option_queue_id_set(struct bonding *bond,
66 const struct bond_opt_value *newval);
67 static int bond_option_mode_set(struct bonding *bond,
68 const struct bond_opt_value *newval);
69 static int bond_option_slaves_set(struct bonding *bond,
70 const struct bond_opt_value *newval);
71 static int bond_option_tlb_dynamic_lb_set(struct bonding *bond,
72 const struct bond_opt_value *newval);
73 static int bond_option_ad_actor_sys_prio_set(struct bonding *bond,
74 const struct bond_opt_value *newval);
75 static int bond_option_ad_actor_system_set(struct bonding *bond,
76 const struct bond_opt_value *newval);
77 static int bond_option_ad_user_port_key_set(struct bonding *bond,
78 const struct bond_opt_value *newval);
81 static const struct bond_opt_value bond_mode_tbl[] = {
82 { "balance-rr", BOND_MODE_ROUNDROBIN, BOND_VALFLAG_DEFAULT},
83 { "active-backup", BOND_MODE_ACTIVEBACKUP, 0},
84 { "balance-xor", BOND_MODE_XOR, 0},
85 { "broadcast", BOND_MODE_BROADCAST, 0},
86 { "802.3ad", BOND_MODE_8023AD, 0},
87 { "balance-tlb", BOND_MODE_TLB, 0},
88 { "balance-alb", BOND_MODE_ALB, 0},
92 static const struct bond_opt_value bond_pps_tbl[] = {
93 { "default", 1, BOND_VALFLAG_DEFAULT},
94 { "maxval", USHRT_MAX, BOND_VALFLAG_MAX},
98 static const struct bond_opt_value bond_xmit_hashtype_tbl[] = {
99 { "layer2", BOND_XMIT_POLICY_LAYER2, BOND_VALFLAG_DEFAULT},
100 { "layer3+4", BOND_XMIT_POLICY_LAYER34, 0},
101 { "layer2+3", BOND_XMIT_POLICY_LAYER23, 0},
102 { "encap2+3", BOND_XMIT_POLICY_ENCAP23, 0},
103 { "encap3+4", BOND_XMIT_POLICY_ENCAP34, 0},
104 { "vlan+srcmac", BOND_XMIT_POLICY_VLAN_SRCMAC, 0},
108 static const struct bond_opt_value bond_arp_validate_tbl[] = {
109 { "none", BOND_ARP_VALIDATE_NONE, BOND_VALFLAG_DEFAULT},
110 { "active", BOND_ARP_VALIDATE_ACTIVE, 0},
111 { "backup", BOND_ARP_VALIDATE_BACKUP, 0},
112 { "all", BOND_ARP_VALIDATE_ALL, 0},
113 { "filter", BOND_ARP_FILTER, 0},
114 { "filter_active", BOND_ARP_FILTER_ACTIVE, 0},
115 { "filter_backup", BOND_ARP_FILTER_BACKUP, 0},
119 static const struct bond_opt_value bond_arp_all_targets_tbl[] = {
120 { "any", BOND_ARP_TARGETS_ANY, BOND_VALFLAG_DEFAULT},
121 { "all", BOND_ARP_TARGETS_ALL, 0},
125 static const struct bond_opt_value bond_fail_over_mac_tbl[] = {
126 { "none", BOND_FOM_NONE, BOND_VALFLAG_DEFAULT},
127 { "active", BOND_FOM_ACTIVE, 0},
128 { "follow", BOND_FOM_FOLLOW, 0},
132 static const struct bond_opt_value bond_intmax_tbl[] = {
133 { "off", 0, BOND_VALFLAG_DEFAULT},
134 { "maxval", INT_MAX, BOND_VALFLAG_MAX},
138 static const struct bond_opt_value bond_lacp_rate_tbl[] = {
139 { "slow", AD_LACP_SLOW, 0},
140 { "fast", AD_LACP_FAST, 0},
144 static const struct bond_opt_value bond_ad_select_tbl[] = {
145 { "stable", BOND_AD_STABLE, BOND_VALFLAG_DEFAULT},
146 { "bandwidth", BOND_AD_BANDWIDTH, 0},
147 { "count", BOND_AD_COUNT, 0},
151 static const struct bond_opt_value bond_num_peer_notif_tbl[] = {
153 { "maxval", 255, BOND_VALFLAG_MAX},
154 { "default", 1, BOND_VALFLAG_DEFAULT},
158 static const struct bond_opt_value bond_primary_reselect_tbl[] = {
159 { "always", BOND_PRI_RESELECT_ALWAYS, BOND_VALFLAG_DEFAULT},
160 { "better", BOND_PRI_RESELECT_BETTER, 0},
161 { "failure", BOND_PRI_RESELECT_FAILURE, 0},
165 static const struct bond_opt_value bond_use_carrier_tbl[] = {
167 { "on", 1, BOND_VALFLAG_DEFAULT},
171 static const struct bond_opt_value bond_all_slaves_active_tbl[] = {
172 { "off", 0, BOND_VALFLAG_DEFAULT},
177 static const struct bond_opt_value bond_resend_igmp_tbl[] = {
179 { "maxval", 255, BOND_VALFLAG_MAX},
180 { "default", 1, BOND_VALFLAG_DEFAULT},
184 static const struct bond_opt_value bond_lp_interval_tbl[] = {
185 { "minval", 1, BOND_VALFLAG_MIN | BOND_VALFLAG_DEFAULT},
186 { "maxval", INT_MAX, BOND_VALFLAG_MAX},
190 static const struct bond_opt_value bond_tlb_dynamic_lb_tbl[] = {
192 { "on", 1, BOND_VALFLAG_DEFAULT},
196 static const struct bond_opt_value bond_ad_actor_sys_prio_tbl[] = {
197 { "minval", 1, BOND_VALFLAG_MIN},
198 { "maxval", 65535, BOND_VALFLAG_MAX | BOND_VALFLAG_DEFAULT},
202 static const struct bond_opt_value bond_ad_user_port_key_tbl[] = {
203 { "minval", 0, BOND_VALFLAG_MIN | BOND_VALFLAG_DEFAULT},
204 { "maxval", 1023, BOND_VALFLAG_MAX},
208 static const struct bond_option bond_opts[BOND_OPT_LAST] = {
212 .desc = "bond device mode",
213 .flags = BOND_OPTFLAG_NOSLAVES | BOND_OPTFLAG_IFDOWN,
214 .values = bond_mode_tbl,
215 .set = bond_option_mode_set
217 [BOND_OPT_PACKETS_PER_SLAVE] = {
218 .id = BOND_OPT_PACKETS_PER_SLAVE,
219 .name = "packets_per_slave",
220 .desc = "Packets to send per slave in RR mode",
221 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ROUNDROBIN)),
222 .values = bond_pps_tbl,
223 .set = bond_option_pps_set
225 [BOND_OPT_XMIT_HASH] = {
226 .id = BOND_OPT_XMIT_HASH,
227 .name = "xmit_hash_policy",
228 .desc = "balance-xor, 802.3ad, and tlb hashing method",
229 .values = bond_xmit_hashtype_tbl,
230 .set = bond_option_xmit_hash_policy_set
232 [BOND_OPT_ARP_VALIDATE] = {
233 .id = BOND_OPT_ARP_VALIDATE,
234 .name = "arp_validate",
235 .desc = "validate src/dst of ARP probes",
236 .unsuppmodes = BIT(BOND_MODE_8023AD) | BIT(BOND_MODE_TLB) |
238 .values = bond_arp_validate_tbl,
239 .set = bond_option_arp_validate_set
241 [BOND_OPT_ARP_ALL_TARGETS] = {
242 .id = BOND_OPT_ARP_ALL_TARGETS,
243 .name = "arp_all_targets",
244 .desc = "fail on any/all arp targets timeout",
245 .values = bond_arp_all_targets_tbl,
246 .set = bond_option_arp_all_targets_set
248 [BOND_OPT_FAIL_OVER_MAC] = {
249 .id = BOND_OPT_FAIL_OVER_MAC,
250 .name = "fail_over_mac",
251 .desc = "For active-backup, do not set all slaves to the same MAC",
252 .flags = BOND_OPTFLAG_NOSLAVES,
253 .values = bond_fail_over_mac_tbl,
254 .set = bond_option_fail_over_mac_set
256 [BOND_OPT_ARP_INTERVAL] = {
257 .id = BOND_OPT_ARP_INTERVAL,
258 .name = "arp_interval",
259 .desc = "arp interval in milliseconds",
260 .unsuppmodes = BIT(BOND_MODE_8023AD) | BIT(BOND_MODE_TLB) |
262 .values = bond_intmax_tbl,
263 .set = bond_option_arp_interval_set
265 [BOND_OPT_ARP_TARGETS] = {
266 .id = BOND_OPT_ARP_TARGETS,
267 .name = "arp_ip_target",
268 .desc = "arp targets in n.n.n.n form",
269 .flags = BOND_OPTFLAG_RAWVAL,
270 .set = bond_option_arp_ip_targets_set
272 [BOND_OPT_DOWNDELAY] = {
273 .id = BOND_OPT_DOWNDELAY,
275 .desc = "Delay before considering link down, in milliseconds",
276 .values = bond_intmax_tbl,
277 .set = bond_option_downdelay_set
279 [BOND_OPT_UPDELAY] = {
280 .id = BOND_OPT_UPDELAY,
282 .desc = "Delay before considering link up, in milliseconds",
283 .values = bond_intmax_tbl,
284 .set = bond_option_updelay_set
286 [BOND_OPT_LACP_RATE] = {
287 .id = BOND_OPT_LACP_RATE,
289 .desc = "LACPDU tx rate to request from 802.3ad partner",
290 .flags = BOND_OPTFLAG_IFDOWN,
291 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
292 .values = bond_lacp_rate_tbl,
293 .set = bond_option_lacp_rate_set
295 [BOND_OPT_MINLINKS] = {
296 .id = BOND_OPT_MINLINKS,
298 .desc = "Minimum number of available links before turning on carrier",
299 .values = bond_intmax_tbl,
300 .set = bond_option_min_links_set
302 [BOND_OPT_AD_SELECT] = {
303 .id = BOND_OPT_AD_SELECT,
305 .desc = "803.ad aggregation selection logic",
306 .flags = BOND_OPTFLAG_IFDOWN,
307 .values = bond_ad_select_tbl,
308 .set = bond_option_ad_select_set
310 [BOND_OPT_NUM_PEER_NOTIF] = {
311 .id = BOND_OPT_NUM_PEER_NOTIF,
312 .name = "num_unsol_na",
313 .desc = "Number of peer notifications to send on failover event",
314 .values = bond_num_peer_notif_tbl,
315 .set = bond_option_num_peer_notif_set
317 [BOND_OPT_MIIMON] = {
318 .id = BOND_OPT_MIIMON,
320 .desc = "Link check interval in milliseconds",
321 .values = bond_intmax_tbl,
322 .set = bond_option_miimon_set
324 [BOND_OPT_PRIMARY] = {
325 .id = BOND_OPT_PRIMARY,
327 .desc = "Primary network device to use",
328 .flags = BOND_OPTFLAG_RAWVAL,
329 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ACTIVEBACKUP) |
332 .set = bond_option_primary_set
334 [BOND_OPT_PRIMARY_RESELECT] = {
335 .id = BOND_OPT_PRIMARY_RESELECT,
336 .name = "primary_reselect",
337 .desc = "Reselect primary slave once it comes up",
338 .values = bond_primary_reselect_tbl,
339 .set = bond_option_primary_reselect_set
341 [BOND_OPT_USE_CARRIER] = {
342 .id = BOND_OPT_USE_CARRIER,
343 .name = "use_carrier",
344 .desc = "Use netif_carrier_ok (vs MII ioctls) in miimon",
345 .values = bond_use_carrier_tbl,
346 .set = bond_option_use_carrier_set
348 [BOND_OPT_ACTIVE_SLAVE] = {
349 .id = BOND_OPT_ACTIVE_SLAVE,
350 .name = "active_slave",
351 .desc = "Currently active slave",
352 .flags = BOND_OPTFLAG_RAWVAL,
353 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ACTIVEBACKUP) |
356 .set = bond_option_active_slave_set
358 [BOND_OPT_QUEUE_ID] = {
359 .id = BOND_OPT_QUEUE_ID,
361 .desc = "Set queue id of a slave",
362 .flags = BOND_OPTFLAG_RAWVAL,
363 .set = bond_option_queue_id_set
365 [BOND_OPT_ALL_SLAVES_ACTIVE] = {
366 .id = BOND_OPT_ALL_SLAVES_ACTIVE,
367 .name = "all_slaves_active",
368 .desc = "Keep all frames received on an interface by setting active flag for all slaves",
369 .values = bond_all_slaves_active_tbl,
370 .set = bond_option_all_slaves_active_set
372 [BOND_OPT_RESEND_IGMP] = {
373 .id = BOND_OPT_RESEND_IGMP,
374 .name = "resend_igmp",
375 .desc = "Number of IGMP membership reports to send on link failure",
376 .values = bond_resend_igmp_tbl,
377 .set = bond_option_resend_igmp_set
379 [BOND_OPT_LP_INTERVAL] = {
380 .id = BOND_OPT_LP_INTERVAL,
381 .name = "lp_interval",
382 .desc = "The number of seconds between instances where the bonding driver sends learning packets to each slave's peer switch",
383 .values = bond_lp_interval_tbl,
384 .set = bond_option_lp_interval_set
386 [BOND_OPT_SLAVES] = {
387 .id = BOND_OPT_SLAVES,
389 .desc = "Slave membership management",
390 .flags = BOND_OPTFLAG_RAWVAL,
391 .set = bond_option_slaves_set
393 [BOND_OPT_TLB_DYNAMIC_LB] = {
394 .id = BOND_OPT_TLB_DYNAMIC_LB,
395 .name = "tlb_dynamic_lb",
396 .desc = "Enable dynamic flow shuffling",
397 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_TLB) | BIT(BOND_MODE_ALB)),
398 .values = bond_tlb_dynamic_lb_tbl,
399 .flags = BOND_OPTFLAG_IFDOWN,
400 .set = bond_option_tlb_dynamic_lb_set,
402 [BOND_OPT_AD_ACTOR_SYS_PRIO] = {
403 .id = BOND_OPT_AD_ACTOR_SYS_PRIO,
404 .name = "ad_actor_sys_prio",
405 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
406 .values = bond_ad_actor_sys_prio_tbl,
407 .set = bond_option_ad_actor_sys_prio_set,
409 [BOND_OPT_AD_ACTOR_SYSTEM] = {
410 .id = BOND_OPT_AD_ACTOR_SYSTEM,
411 .name = "ad_actor_system",
412 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
413 .flags = BOND_OPTFLAG_RAWVAL,
414 .set = bond_option_ad_actor_system_set,
416 [BOND_OPT_AD_USER_PORT_KEY] = {
417 .id = BOND_OPT_AD_USER_PORT_KEY,
418 .name = "ad_user_port_key",
419 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
420 .flags = BOND_OPTFLAG_IFDOWN,
421 .values = bond_ad_user_port_key_tbl,
422 .set = bond_option_ad_user_port_key_set,
424 [BOND_OPT_NUM_PEER_NOTIF_ALIAS] = {
425 .id = BOND_OPT_NUM_PEER_NOTIF_ALIAS,
426 .name = "num_grat_arp",
427 .desc = "Number of peer notifications to send on failover event",
428 .values = bond_num_peer_notif_tbl,
429 .set = bond_option_num_peer_notif_set
431 [BOND_OPT_PEER_NOTIF_DELAY] = {
432 .id = BOND_OPT_PEER_NOTIF_DELAY,
433 .name = "peer_notif_delay",
434 .desc = "Delay between each peer notification on failover event, in milliseconds",
435 .values = bond_intmax_tbl,
436 .set = bond_option_peer_notif_delay_set
440 /* Searches for an option by name */
441 const struct bond_option *bond_opt_get_by_name(const char *name)
443 const struct bond_option *opt;
446 for (option = 0; option < BOND_OPT_LAST; option++) {
447 opt = bond_opt_get(option);
448 if (opt && !strcmp(opt->name, name))
455 /* Searches for a value in opt's values[] table */
456 const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val)
458 const struct bond_option *opt;
461 opt = bond_opt_get(option);
464 for (i = 0; opt->values && opt->values[i].string; i++)
465 if (opt->values[i].value == val)
466 return &opt->values[i];
471 /* Searches for a value in opt's values[] table which matches the flagmask */
472 static const struct bond_opt_value *bond_opt_get_flags(const struct bond_option *opt,
477 for (i = 0; opt->values && opt->values[i].string; i++)
478 if (opt->values[i].flags & flagmask)
479 return &opt->values[i];
484 /* If maxval is missing then there's no range to check. In case minval is
485 * missing then it's considered to be 0.
487 static bool bond_opt_check_range(const struct bond_option *opt, u64 val)
489 const struct bond_opt_value *minval, *maxval;
491 minval = bond_opt_get_flags(opt, BOND_VALFLAG_MIN);
492 maxval = bond_opt_get_flags(opt, BOND_VALFLAG_MAX);
493 if (!maxval || (minval && val < minval->value) || val > maxval->value)
500 * bond_opt_parse - parse option value
501 * @opt: the option to parse against
502 * @val: value to parse
504 * This function tries to extract the value from @val and check if it's
505 * a possible match for the option and returns NULL if a match isn't found,
506 * or the struct_opt_value that matched. It also strips the new line from
507 * @val->string if it's present.
509 const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
510 struct bond_opt_value *val)
512 char *p, valstr[BOND_OPT_MAX_NAMELEN + 1] = { 0, };
513 const struct bond_opt_value *tbl;
514 const struct bond_opt_value *ret = NULL;
518 /* No parsing if the option wants a raw val */
519 if (opt->flags & BOND_OPTFLAG_RAWVAL)
526 /* ULLONG_MAX is used to bypass string processing */
527 checkval = val->value != ULLONG_MAX;
531 p = strchr(val->string, '\n');
534 for (p = val->string; *p; p++)
535 if (!(isdigit(*p) || isspace(*p)))
537 /* The following code extracts the string to match or the value
538 * and sets checkval appropriately
541 rv = sscanf(val->string, "%32s", valstr);
543 rv = sscanf(val->string, "%llu", &val->value);
550 for (i = 0; tbl[i].string; i++) {
551 /* Check for exact match */
553 if (val->value == tbl[i].value)
556 if (!strcmp(valstr, "default") &&
557 (tbl[i].flags & BOND_VALFLAG_DEFAULT))
560 if (!strcmp(valstr, tbl[i].string))
563 /* Found an exact match */
567 /* Possible range match */
568 if (checkval && bond_opt_check_range(opt, val->value))
574 /* Check opt's dependencies against bond mode and currently set options */
575 static int bond_opt_check_deps(struct bonding *bond,
576 const struct bond_option *opt)
578 struct bond_params *params = &bond->params;
580 if (test_bit(params->mode, &opt->unsuppmodes))
582 if ((opt->flags & BOND_OPTFLAG_NOSLAVES) && bond_has_slaves(bond))
584 if ((opt->flags & BOND_OPTFLAG_IFDOWN) && (bond->dev->flags & IFF_UP))
590 static void bond_opt_dep_print(struct bonding *bond,
591 const struct bond_option *opt)
593 const struct bond_opt_value *modeval;
594 struct bond_params *params;
596 params = &bond->params;
597 modeval = bond_opt_get_val(BOND_OPT_MODE, params->mode);
598 if (test_bit(params->mode, &opt->unsuppmodes))
599 netdev_err(bond->dev, "option %s: mode dependency failed, not supported in mode %s(%llu)\n",
600 opt->name, modeval->string, modeval->value);
603 static void bond_opt_error_interpret(struct bonding *bond,
604 const struct bond_option *opt,
605 int error, const struct bond_opt_value *val)
607 const struct bond_opt_value *minval, *maxval;
614 /* sometimes RAWVAL opts may have new lines */
615 p = strchr(val->string, '\n');
618 netdev_err(bond->dev, "option %s: invalid value (%s)\n",
619 opt->name, val->string);
621 netdev_err(bond->dev, "option %s: invalid value (%llu)\n",
622 opt->name, val->value);
625 minval = bond_opt_get_flags(opt, BOND_VALFLAG_MIN);
626 maxval = bond_opt_get_flags(opt, BOND_VALFLAG_MAX);
629 netdev_err(bond->dev, "option %s: allowed values %llu - %llu\n",
630 opt->name, minval ? minval->value : 0, maxval->value);
633 bond_opt_dep_print(bond, opt);
636 netdev_err(bond->dev, "option %s: unable to set because the bond device has slaves\n",
640 netdev_err(bond->dev, "option %s: unable to set because the bond device is up\n",
644 if (val && val->string) {
645 p = strchr(val->string, '\n');
648 netdev_err(bond->dev, "option %s: interface %s does not exist!\n",
649 opt->name, val->string);
658 * __bond_opt_set - set a bonding option
659 * @bond: target bond device
660 * @option: option to set
661 * @val: value to set it to
663 * This function is used to change the bond's option value, it can be
664 * used for both enabling/changing an option and for disabling it. RTNL lock
665 * must be obtained before calling this function.
667 int __bond_opt_set(struct bonding *bond,
668 unsigned int option, struct bond_opt_value *val)
670 const struct bond_opt_value *retval = NULL;
671 const struct bond_option *opt;
676 opt = bond_opt_get(option);
677 if (WARN_ON(!val) || WARN_ON(!opt))
679 ret = bond_opt_check_deps(bond, opt);
682 retval = bond_opt_parse(opt, val);
687 ret = opt->set(bond, retval);
690 bond_opt_error_interpret(bond, opt, ret, val);
695 * __bond_opt_set_notify - set a bonding option
696 * @bond: target bond device
697 * @option: option to set
698 * @val: value to set it to
700 * This function is used to change the bond's option value and trigger
701 * a notification to user sapce. It can be used for both enabling/changing
702 * an option and for disabling it. RTNL lock must be obtained before calling
705 int __bond_opt_set_notify(struct bonding *bond,
706 unsigned int option, struct bond_opt_value *val)
712 ret = __bond_opt_set(bond, option, val);
714 if (!ret && (bond->dev->reg_state == NETREG_REGISTERED))
715 call_netdevice_notifiers(NETDEV_CHANGEINFODATA, bond->dev);
721 * bond_opt_tryset_rtnl - try to acquire rtnl and call __bond_opt_set
722 * @bond: target bond device
723 * @option: option to set
724 * @buf: value to set it to
726 * This function tries to acquire RTNL without blocking and if successful
727 * calls __bond_opt_set. It is mainly used for sysfs option manipulation.
729 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf)
731 struct bond_opt_value optval;
735 return restart_syscall();
736 bond_opt_initstr(&optval, buf);
737 ret = __bond_opt_set_notify(bond, option, &optval);
744 * bond_opt_get - get a pointer to an option
745 * @option: option for which to return a pointer
747 * This function checks if option is valid and if so returns a pointer
748 * to its entry in the bond_opts[] option array.
750 const struct bond_option *bond_opt_get(unsigned int option)
752 if (!BOND_OPT_VALID(option))
755 return &bond_opts[option];
758 static bool bond_set_xfrm_features(struct bonding *bond)
760 if (!IS_ENABLED(CONFIG_XFRM_OFFLOAD))
763 if (BOND_MODE(bond) == BOND_MODE_ACTIVEBACKUP)
764 bond->dev->wanted_features |= BOND_XFRM_FEATURES;
766 bond->dev->wanted_features &= ~BOND_XFRM_FEATURES;
771 static bool bond_set_tls_features(struct bonding *bond)
773 if (!IS_ENABLED(CONFIG_TLS_DEVICE))
776 if (bond_sk_check(bond))
777 bond->dev->wanted_features |= BOND_TLS_FEATURES;
779 bond->dev->wanted_features &= ~BOND_TLS_FEATURES;
784 static int bond_option_mode_set(struct bonding *bond,
785 const struct bond_opt_value *newval)
787 if (!bond_mode_uses_arp(newval->value)) {
788 if (bond->params.arp_interval) {
789 netdev_dbg(bond->dev, "%s mode is incompatible with arp monitoring, start mii monitoring\n",
791 /* disable arp monitoring */
792 bond->params.arp_interval = 0;
795 if (!bond->params.miimon) {
796 /* set miimon to default value */
797 bond->params.miimon = BOND_DEFAULT_MIIMON;
798 netdev_dbg(bond->dev, "Setting MII monitoring interval to %d\n",
799 bond->params.miimon);
803 if (newval->value == BOND_MODE_ALB)
804 bond->params.tlb_dynamic_lb = 1;
806 /* don't cache arp_validate between modes */
807 bond->params.arp_validate = BOND_ARP_VALIDATE_NONE;
808 bond->params.mode = newval->value;
810 if (bond->dev->reg_state == NETREG_REGISTERED) {
813 update |= bond_set_xfrm_features(bond);
814 update |= bond_set_tls_features(bond);
817 netdev_update_features(bond->dev);
823 static int bond_option_active_slave_set(struct bonding *bond,
824 const struct bond_opt_value *newval)
826 char ifname[IFNAMSIZ] = { 0, };
827 struct net_device *slave_dev;
830 sscanf(newval->string, "%15s", ifname); /* IFNAMSIZ */
831 if (!strlen(ifname) || newval->string[0] == '\n') {
834 slave_dev = __dev_get_by_name(dev_net(bond->dev), ifname);
840 if (!netif_is_bond_slave(slave_dev)) {
841 slave_err(bond->dev, slave_dev, "Device is not bonding slave\n");
845 if (bond->dev != netdev_master_upper_dev_get(slave_dev)) {
846 slave_err(bond->dev, slave_dev, "Device is not our slave\n");
852 /* check to see if we are clearing active */
854 netdev_dbg(bond->dev, "Clearing current active slave\n");
855 RCU_INIT_POINTER(bond->curr_active_slave, NULL);
856 bond_select_active_slave(bond);
858 struct slave *old_active = rtnl_dereference(bond->curr_active_slave);
859 struct slave *new_active = bond_slave_get_rtnl(slave_dev);
863 if (new_active == old_active) {
865 slave_dbg(bond->dev, new_active->dev, "is already the current active slave\n");
867 if (old_active && (new_active->link == BOND_LINK_UP) &&
868 bond_slave_is_up(new_active)) {
869 slave_dbg(bond->dev, new_active->dev, "Setting as active slave\n");
870 bond_change_active_slave(bond, new_active);
872 slave_err(bond->dev, new_active->dev, "Could not set as active slave; either %s is down or the link is down\n",
873 new_active->dev->name);
878 unblock_netpoll_tx();
883 /* There are two tricky bits here. First, if MII monitoring is activated, then
884 * we must disable ARP monitoring. Second, if the timer isn't running, we must
887 static int bond_option_miimon_set(struct bonding *bond,
888 const struct bond_opt_value *newval)
890 netdev_dbg(bond->dev, "Setting MII monitoring interval to %llu\n",
892 bond->params.miimon = newval->value;
893 if (bond->params.updelay)
894 netdev_dbg(bond->dev, "Note: Updating updelay (to %d) since it is a multiple of the miimon value\n",
895 bond->params.updelay * bond->params.miimon);
896 if (bond->params.downdelay)
897 netdev_dbg(bond->dev, "Note: Updating downdelay (to %d) since it is a multiple of the miimon value\n",
898 bond->params.downdelay * bond->params.miimon);
899 if (bond->params.peer_notif_delay)
900 netdev_dbg(bond->dev, "Note: Updating peer_notif_delay (to %d) since it is a multiple of the miimon value\n",
901 bond->params.peer_notif_delay * bond->params.miimon);
902 if (newval->value && bond->params.arp_interval) {
903 netdev_dbg(bond->dev, "MII monitoring cannot be used with ARP monitoring - disabling ARP monitoring...\n");
904 bond->params.arp_interval = 0;
905 if (bond->params.arp_validate)
906 bond->params.arp_validate = BOND_ARP_VALIDATE_NONE;
908 if (bond->dev->flags & IFF_UP) {
909 /* If the interface is up, we may need to fire off
910 * the MII timer. If the interface is down, the
911 * timer will get fired off when the open function
914 if (!newval->value) {
915 cancel_delayed_work_sync(&bond->mii_work);
917 cancel_delayed_work_sync(&bond->arp_work);
918 queue_delayed_work(bond->wq, &bond->mii_work, 0);
925 /* Set up, down and peer notification delays. These must be multiples
926 * of the MII monitoring value, and are stored internally as the
927 * multiplier. Thus, we must translate to MS for the real world.
929 static int _bond_option_delay_set(struct bonding *bond,
930 const struct bond_opt_value *newval,
934 int value = newval->value;
936 if (!bond->params.miimon) {
937 netdev_err(bond->dev, "Unable to set %s as MII monitoring is disabled\n",
941 if ((value % bond->params.miimon) != 0) {
942 netdev_warn(bond->dev,
943 "%s (%d) is not a multiple of miimon (%d), value rounded to %d ms\n",
945 value, bond->params.miimon,
946 (value / bond->params.miimon) *
947 bond->params.miimon);
949 *target = value / bond->params.miimon;
950 netdev_dbg(bond->dev, "Setting %s to %d\n",
952 *target * bond->params.miimon);
957 static int bond_option_updelay_set(struct bonding *bond,
958 const struct bond_opt_value *newval)
960 return _bond_option_delay_set(bond, newval, "up delay",
961 &bond->params.updelay);
964 static int bond_option_downdelay_set(struct bonding *bond,
965 const struct bond_opt_value *newval)
967 return _bond_option_delay_set(bond, newval, "down delay",
968 &bond->params.downdelay);
971 static int bond_option_peer_notif_delay_set(struct bonding *bond,
972 const struct bond_opt_value *newval)
974 int ret = _bond_option_delay_set(bond, newval,
975 "peer notification delay",
976 &bond->params.peer_notif_delay);
980 static int bond_option_use_carrier_set(struct bonding *bond,
981 const struct bond_opt_value *newval)
983 netdev_dbg(bond->dev, "Setting use_carrier to %llu\n",
985 bond->params.use_carrier = newval->value;
990 /* There are two tricky bits here. First, if ARP monitoring is activated, then
991 * we must disable MII monitoring. Second, if the ARP timer isn't running,
994 static int bond_option_arp_interval_set(struct bonding *bond,
995 const struct bond_opt_value *newval)
997 netdev_dbg(bond->dev, "Setting ARP monitoring interval to %llu\n",
999 bond->params.arp_interval = newval->value;
1000 if (newval->value) {
1001 if (bond->params.miimon) {
1002 netdev_dbg(bond->dev, "ARP monitoring cannot be used with MII monitoring. Disabling MII monitoring\n");
1003 bond->params.miimon = 0;
1005 if (!bond->params.arp_targets[0])
1006 netdev_dbg(bond->dev, "ARP monitoring has been set up, but no ARP targets have been specified\n");
1008 if (bond->dev->flags & IFF_UP) {
1009 /* If the interface is up, we may need to fire off
1010 * the ARP timer. If the interface is down, the
1011 * timer will get fired off when the open function
1014 if (!newval->value) {
1015 if (bond->params.arp_validate)
1016 bond->recv_probe = NULL;
1017 cancel_delayed_work_sync(&bond->arp_work);
1019 /* arp_validate can be set only in active-backup mode */
1020 bond->recv_probe = bond_arp_rcv;
1021 cancel_delayed_work_sync(&bond->mii_work);
1022 queue_delayed_work(bond->wq, &bond->arp_work, 0);
1029 static void _bond_options_arp_ip_target_set(struct bonding *bond, int slot,
1031 unsigned long last_rx)
1033 __be32 *targets = bond->params.arp_targets;
1034 struct list_head *iter;
1035 struct slave *slave;
1037 if (slot >= 0 && slot < BOND_MAX_ARP_TARGETS) {
1038 bond_for_each_slave(bond, slave, iter)
1039 slave->target_last_arp_rx[slot] = last_rx;
1040 targets[slot] = target;
1044 static int _bond_option_arp_ip_target_add(struct bonding *bond, __be32 target)
1046 __be32 *targets = bond->params.arp_targets;
1049 if (!bond_is_ip_target_ok(target)) {
1050 netdev_err(bond->dev, "invalid ARP target %pI4 specified for addition\n",
1055 if (bond_get_targets_ip(targets, target) != -1) { /* dup */
1056 netdev_err(bond->dev, "ARP target %pI4 is already present\n",
1061 ind = bond_get_targets_ip(targets, 0); /* first free slot */
1063 netdev_err(bond->dev, "ARP target table is full!\n");
1067 netdev_dbg(bond->dev, "Adding ARP target %pI4\n", &target);
1069 _bond_options_arp_ip_target_set(bond, ind, target, jiffies);
1074 static int bond_option_arp_ip_target_add(struct bonding *bond, __be32 target)
1076 return _bond_option_arp_ip_target_add(bond, target);
1079 static int bond_option_arp_ip_target_rem(struct bonding *bond, __be32 target)
1081 __be32 *targets = bond->params.arp_targets;
1082 struct list_head *iter;
1083 struct slave *slave;
1084 unsigned long *targets_rx;
1087 if (!bond_is_ip_target_ok(target)) {
1088 netdev_err(bond->dev, "invalid ARP target %pI4 specified for removal\n",
1093 ind = bond_get_targets_ip(targets, target);
1095 netdev_err(bond->dev, "unable to remove nonexistent ARP target %pI4\n",
1100 if (ind == 0 && !targets[1] && bond->params.arp_interval)
1101 netdev_warn(bond->dev, "Removing last arp target with arp_interval on\n");
1103 netdev_dbg(bond->dev, "Removing ARP target %pI4\n", &target);
1105 bond_for_each_slave(bond, slave, iter) {
1106 targets_rx = slave->target_last_arp_rx;
1107 for (i = ind; (i < BOND_MAX_ARP_TARGETS-1) && targets[i+1]; i++)
1108 targets_rx[i] = targets_rx[i+1];
1111 for (i = ind; (i < BOND_MAX_ARP_TARGETS-1) && targets[i+1]; i++)
1112 targets[i] = targets[i+1];
1118 void bond_option_arp_ip_targets_clear(struct bonding *bond)
1122 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
1123 _bond_options_arp_ip_target_set(bond, i, 0, 0);
1126 static int bond_option_arp_ip_targets_set(struct bonding *bond,
1127 const struct bond_opt_value *newval)
1132 if (newval->string) {
1133 if (!in4_pton(newval->string+1, -1, (u8 *)&target, -1, NULL)) {
1134 netdev_err(bond->dev, "invalid ARP target %pI4 specified\n",
1138 if (newval->string[0] == '+')
1139 ret = bond_option_arp_ip_target_add(bond, target);
1140 else if (newval->string[0] == '-')
1141 ret = bond_option_arp_ip_target_rem(bond, target);
1143 netdev_err(bond->dev, "no command found in arp_ip_targets file - use +<addr> or -<addr>\n");
1145 target = newval->value;
1146 ret = bond_option_arp_ip_target_add(bond, target);
1152 static int bond_option_arp_validate_set(struct bonding *bond,
1153 const struct bond_opt_value *newval)
1155 netdev_dbg(bond->dev, "Setting arp_validate to %s (%llu)\n",
1156 newval->string, newval->value);
1157 bond->params.arp_validate = newval->value;
1162 static int bond_option_arp_all_targets_set(struct bonding *bond,
1163 const struct bond_opt_value *newval)
1165 netdev_dbg(bond->dev, "Setting arp_all_targets to %s (%llu)\n",
1166 newval->string, newval->value);
1167 bond->params.arp_all_targets = newval->value;
1172 static int bond_option_primary_set(struct bonding *bond,
1173 const struct bond_opt_value *newval)
1175 char *p, *primary = newval->string;
1176 struct list_head *iter;
1177 struct slave *slave;
1181 p = strchr(primary, '\n');
1184 /* check to see if we are clearing primary */
1185 if (!strlen(primary)) {
1186 netdev_dbg(bond->dev, "Setting primary slave to None\n");
1187 RCU_INIT_POINTER(bond->primary_slave, NULL);
1188 memset(bond->params.primary, 0, sizeof(bond->params.primary));
1189 bond_select_active_slave(bond);
1193 bond_for_each_slave(bond, slave, iter) {
1194 if (strncmp(slave->dev->name, primary, IFNAMSIZ) == 0) {
1195 slave_dbg(bond->dev, slave->dev, "Setting as primary slave\n");
1196 rcu_assign_pointer(bond->primary_slave, slave);
1197 strcpy(bond->params.primary, slave->dev->name);
1198 bond->force_primary = true;
1199 bond_select_active_slave(bond);
1204 if (rtnl_dereference(bond->primary_slave)) {
1205 netdev_dbg(bond->dev, "Setting primary slave to None\n");
1206 RCU_INIT_POINTER(bond->primary_slave, NULL);
1207 bond_select_active_slave(bond);
1209 strscpy_pad(bond->params.primary, primary, IFNAMSIZ);
1211 netdev_dbg(bond->dev, "Recording %s as primary, but it has not been enslaved yet\n",
1215 unblock_netpoll_tx();
1220 static int bond_option_primary_reselect_set(struct bonding *bond,
1221 const struct bond_opt_value *newval)
1223 netdev_dbg(bond->dev, "Setting primary_reselect to %s (%llu)\n",
1224 newval->string, newval->value);
1225 bond->params.primary_reselect = newval->value;
1228 bond_select_active_slave(bond);
1229 unblock_netpoll_tx();
1234 static int bond_option_fail_over_mac_set(struct bonding *bond,
1235 const struct bond_opt_value *newval)
1237 netdev_dbg(bond->dev, "Setting fail_over_mac to %s (%llu)\n",
1238 newval->string, newval->value);
1239 bond->params.fail_over_mac = newval->value;
1244 static int bond_option_xmit_hash_policy_set(struct bonding *bond,
1245 const struct bond_opt_value *newval)
1247 netdev_dbg(bond->dev, "Setting xmit hash policy to %s (%llu)\n",
1248 newval->string, newval->value);
1249 bond->params.xmit_policy = newval->value;
1251 if (bond->dev->reg_state == NETREG_REGISTERED)
1252 if (bond_set_tls_features(bond))
1253 netdev_update_features(bond->dev);
1258 static int bond_option_resend_igmp_set(struct bonding *bond,
1259 const struct bond_opt_value *newval)
1261 netdev_dbg(bond->dev, "Setting resend_igmp to %llu\n",
1263 bond->params.resend_igmp = newval->value;
1268 static int bond_option_num_peer_notif_set(struct bonding *bond,
1269 const struct bond_opt_value *newval)
1271 bond->params.num_peer_notif = newval->value;
1276 static int bond_option_all_slaves_active_set(struct bonding *bond,
1277 const struct bond_opt_value *newval)
1279 struct list_head *iter;
1280 struct slave *slave;
1282 if (newval->value == bond->params.all_slaves_active)
1284 bond->params.all_slaves_active = newval->value;
1285 bond_for_each_slave(bond, slave, iter) {
1286 if (!bond_is_active_slave(slave)) {
1288 slave->inactive = 0;
1290 slave->inactive = 1;
1297 static int bond_option_min_links_set(struct bonding *bond,
1298 const struct bond_opt_value *newval)
1300 netdev_dbg(bond->dev, "Setting min links value to %llu\n",
1302 bond->params.min_links = newval->value;
1303 bond_set_carrier(bond);
1308 static int bond_option_lp_interval_set(struct bonding *bond,
1309 const struct bond_opt_value *newval)
1311 bond->params.lp_interval = newval->value;
1316 static int bond_option_pps_set(struct bonding *bond,
1317 const struct bond_opt_value *newval)
1319 netdev_dbg(bond->dev, "Setting packets per slave to %llu\n",
1321 bond->params.packets_per_slave = newval->value;
1322 if (newval->value > 0) {
1323 bond->params.reciprocal_packets_per_slave =
1324 reciprocal_value(newval->value);
1326 /* reciprocal_packets_per_slave is unused if
1327 * packets_per_slave is 0 or 1, just initialize it
1329 bond->params.reciprocal_packets_per_slave =
1330 (struct reciprocal_value) { 0 };
1336 static int bond_option_lacp_rate_set(struct bonding *bond,
1337 const struct bond_opt_value *newval)
1339 netdev_dbg(bond->dev, "Setting LACP rate to %s (%llu)\n",
1340 newval->string, newval->value);
1341 bond->params.lacp_fast = newval->value;
1342 bond_3ad_update_lacp_rate(bond);
1347 static int bond_option_ad_select_set(struct bonding *bond,
1348 const struct bond_opt_value *newval)
1350 netdev_dbg(bond->dev, "Setting ad_select to %s (%llu)\n",
1351 newval->string, newval->value);
1352 bond->params.ad_select = newval->value;
1357 static int bond_option_queue_id_set(struct bonding *bond,
1358 const struct bond_opt_value *newval)
1360 struct slave *slave, *update_slave;
1361 struct net_device *sdev;
1362 struct list_head *iter;
1367 /* delim will point to queue id if successful */
1368 delim = strchr(newval->string, ':');
1372 /* Terminate string that points to device name and bump it
1373 * up one, so we can read the queue id there.
1376 if (sscanf(++delim, "%hd\n", &qid) != 1)
1379 /* Check buffer length, valid ifname and queue id */
1380 if (!dev_valid_name(newval->string) ||
1381 qid > bond->dev->real_num_tx_queues)
1384 /* Get the pointer to that interface if it exists */
1385 sdev = __dev_get_by_name(dev_net(bond->dev), newval->string);
1389 /* Search for thes slave and check for duplicate qids */
1390 update_slave = NULL;
1391 bond_for_each_slave(bond, slave, iter) {
1392 if (sdev == slave->dev)
1393 /* We don't need to check the matching
1394 * slave for dups, since we're overwriting it
1396 update_slave = slave;
1397 else if (qid && qid == slave->queue_id) {
1405 /* Actually set the qids for the slave */
1406 update_slave->queue_id = qid;
1412 netdev_dbg(bond->dev, "invalid input for queue_id set\n");
1418 static int bond_option_slaves_set(struct bonding *bond,
1419 const struct bond_opt_value *newval)
1421 char command[IFNAMSIZ + 1] = { 0, };
1422 struct net_device *dev;
1426 sscanf(newval->string, "%16s", command); /* IFNAMSIZ*/
1427 ifname = command + 1;
1428 if ((strlen(command) <= 1) ||
1429 (command[0] != '+' && command[0] != '-') ||
1430 !dev_valid_name(ifname))
1433 dev = __dev_get_by_name(dev_net(bond->dev), ifname);
1435 netdev_dbg(bond->dev, "interface %s does not exist!\n",
1441 switch (command[0]) {
1443 slave_dbg(bond->dev, dev, "Enslaving interface\n");
1444 ret = bond_enslave(bond->dev, dev, NULL);
1448 slave_dbg(bond->dev, dev, "Releasing interface\n");
1449 ret = bond_release(bond->dev, dev);
1453 /* should not run here. */
1461 netdev_err(bond->dev, "no command found in slaves file - use +ifname or -ifname\n");
1466 static int bond_option_tlb_dynamic_lb_set(struct bonding *bond,
1467 const struct bond_opt_value *newval)
1469 netdev_dbg(bond->dev, "Setting dynamic-lb to %s (%llu)\n",
1470 newval->string, newval->value);
1471 bond->params.tlb_dynamic_lb = newval->value;
1476 static int bond_option_ad_actor_sys_prio_set(struct bonding *bond,
1477 const struct bond_opt_value *newval)
1479 netdev_dbg(bond->dev, "Setting ad_actor_sys_prio to %llu\n",
1482 bond->params.ad_actor_sys_prio = newval->value;
1483 bond_3ad_update_ad_actor_settings(bond);
1488 static int bond_option_ad_actor_system_set(struct bonding *bond,
1489 const struct bond_opt_value *newval)
1491 u8 macaddr[ETH_ALEN];
1494 if (newval->string) {
1495 if (!mac_pton(newval->string, macaddr))
1499 mac = (u8 *)&newval->value;
1502 if (!is_valid_ether_addr(mac))
1505 netdev_dbg(bond->dev, "Setting ad_actor_system to %pM\n", mac);
1506 ether_addr_copy(bond->params.ad_actor_system, mac);
1507 bond_3ad_update_ad_actor_settings(bond);
1512 netdev_err(bond->dev, "Invalid ad_actor_system MAC address.\n");
1516 static int bond_option_ad_user_port_key_set(struct bonding *bond,
1517 const struct bond_opt_value *newval)
1519 netdev_dbg(bond->dev, "Setting ad_user_port_key to %llu\n",
1522 bond->params.ad_user_port_key = newval->value;