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},
107 static const struct bond_opt_value bond_arp_validate_tbl[] = {
108 { "none", BOND_ARP_VALIDATE_NONE, BOND_VALFLAG_DEFAULT},
109 { "active", BOND_ARP_VALIDATE_ACTIVE, 0},
110 { "backup", BOND_ARP_VALIDATE_BACKUP, 0},
111 { "all", BOND_ARP_VALIDATE_ALL, 0},
112 { "filter", BOND_ARP_FILTER, 0},
113 { "filter_active", BOND_ARP_FILTER_ACTIVE, 0},
114 { "filter_backup", BOND_ARP_FILTER_BACKUP, 0},
118 static const struct bond_opt_value bond_arp_all_targets_tbl[] = {
119 { "any", BOND_ARP_TARGETS_ANY, BOND_VALFLAG_DEFAULT},
120 { "all", BOND_ARP_TARGETS_ALL, 0},
124 static const struct bond_opt_value bond_fail_over_mac_tbl[] = {
125 { "none", BOND_FOM_NONE, BOND_VALFLAG_DEFAULT},
126 { "active", BOND_FOM_ACTIVE, 0},
127 { "follow", BOND_FOM_FOLLOW, 0},
131 static const struct bond_opt_value bond_intmax_tbl[] = {
132 { "off", 0, BOND_VALFLAG_DEFAULT},
133 { "maxval", INT_MAX, BOND_VALFLAG_MAX},
137 static const struct bond_opt_value bond_lacp_rate_tbl[] = {
138 { "slow", AD_LACP_SLOW, 0},
139 { "fast", AD_LACP_FAST, 0},
143 static const struct bond_opt_value bond_ad_select_tbl[] = {
144 { "stable", BOND_AD_STABLE, BOND_VALFLAG_DEFAULT},
145 { "bandwidth", BOND_AD_BANDWIDTH, 0},
146 { "count", BOND_AD_COUNT, 0},
150 static const struct bond_opt_value bond_num_peer_notif_tbl[] = {
152 { "maxval", 255, BOND_VALFLAG_MAX},
153 { "default", 1, BOND_VALFLAG_DEFAULT},
157 static const struct bond_opt_value bond_primary_reselect_tbl[] = {
158 { "always", BOND_PRI_RESELECT_ALWAYS, BOND_VALFLAG_DEFAULT},
159 { "better", BOND_PRI_RESELECT_BETTER, 0},
160 { "failure", BOND_PRI_RESELECT_FAILURE, 0},
164 static const struct bond_opt_value bond_use_carrier_tbl[] = {
166 { "on", 1, BOND_VALFLAG_DEFAULT},
170 static const struct bond_opt_value bond_all_slaves_active_tbl[] = {
171 { "off", 0, BOND_VALFLAG_DEFAULT},
176 static const struct bond_opt_value bond_resend_igmp_tbl[] = {
178 { "maxval", 255, BOND_VALFLAG_MAX},
179 { "default", 1, BOND_VALFLAG_DEFAULT},
183 static const struct bond_opt_value bond_lp_interval_tbl[] = {
184 { "minval", 1, BOND_VALFLAG_MIN | BOND_VALFLAG_DEFAULT},
185 { "maxval", INT_MAX, BOND_VALFLAG_MAX},
189 static const struct bond_opt_value bond_tlb_dynamic_lb_tbl[] = {
191 { "on", 1, BOND_VALFLAG_DEFAULT},
195 static const struct bond_opt_value bond_ad_actor_sys_prio_tbl[] = {
196 { "minval", 1, BOND_VALFLAG_MIN},
197 { "maxval", 65535, BOND_VALFLAG_MAX | BOND_VALFLAG_DEFAULT},
201 static const struct bond_opt_value bond_ad_user_port_key_tbl[] = {
202 { "minval", 0, BOND_VALFLAG_MIN | BOND_VALFLAG_DEFAULT},
203 { "maxval", 1023, BOND_VALFLAG_MAX},
207 static const struct bond_option bond_opts[BOND_OPT_LAST] = {
211 .desc = "bond device mode",
212 .flags = BOND_OPTFLAG_NOSLAVES | BOND_OPTFLAG_IFDOWN,
213 .values = bond_mode_tbl,
214 .set = bond_option_mode_set
216 [BOND_OPT_PACKETS_PER_SLAVE] = {
217 .id = BOND_OPT_PACKETS_PER_SLAVE,
218 .name = "packets_per_slave",
219 .desc = "Packets to send per slave in RR mode",
220 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ROUNDROBIN)),
221 .values = bond_pps_tbl,
222 .set = bond_option_pps_set
224 [BOND_OPT_XMIT_HASH] = {
225 .id = BOND_OPT_XMIT_HASH,
226 .name = "xmit_hash_policy",
227 .desc = "balance-xor, 802.3ad, and tlb hashing method",
228 .values = bond_xmit_hashtype_tbl,
229 .set = bond_option_xmit_hash_policy_set
231 [BOND_OPT_ARP_VALIDATE] = {
232 .id = BOND_OPT_ARP_VALIDATE,
233 .name = "arp_validate",
234 .desc = "validate src/dst of ARP probes",
235 .unsuppmodes = BIT(BOND_MODE_8023AD) | BIT(BOND_MODE_TLB) |
237 .values = bond_arp_validate_tbl,
238 .set = bond_option_arp_validate_set
240 [BOND_OPT_ARP_ALL_TARGETS] = {
241 .id = BOND_OPT_ARP_ALL_TARGETS,
242 .name = "arp_all_targets",
243 .desc = "fail on any/all arp targets timeout",
244 .values = bond_arp_all_targets_tbl,
245 .set = bond_option_arp_all_targets_set
247 [BOND_OPT_FAIL_OVER_MAC] = {
248 .id = BOND_OPT_FAIL_OVER_MAC,
249 .name = "fail_over_mac",
250 .desc = "For active-backup, do not set all slaves to the same MAC",
251 .flags = BOND_OPTFLAG_NOSLAVES,
252 .values = bond_fail_over_mac_tbl,
253 .set = bond_option_fail_over_mac_set
255 [BOND_OPT_ARP_INTERVAL] = {
256 .id = BOND_OPT_ARP_INTERVAL,
257 .name = "arp_interval",
258 .desc = "arp interval in milliseconds",
259 .unsuppmodes = BIT(BOND_MODE_8023AD) | BIT(BOND_MODE_TLB) |
261 .values = bond_intmax_tbl,
262 .set = bond_option_arp_interval_set
264 [BOND_OPT_ARP_TARGETS] = {
265 .id = BOND_OPT_ARP_TARGETS,
266 .name = "arp_ip_target",
267 .desc = "arp targets in n.n.n.n form",
268 .flags = BOND_OPTFLAG_RAWVAL,
269 .set = bond_option_arp_ip_targets_set
271 [BOND_OPT_DOWNDELAY] = {
272 .id = BOND_OPT_DOWNDELAY,
274 .desc = "Delay before considering link down, in milliseconds",
275 .values = bond_intmax_tbl,
276 .set = bond_option_downdelay_set
278 [BOND_OPT_UPDELAY] = {
279 .id = BOND_OPT_UPDELAY,
281 .desc = "Delay before considering link up, in milliseconds",
282 .values = bond_intmax_tbl,
283 .set = bond_option_updelay_set
285 [BOND_OPT_LACP_RATE] = {
286 .id = BOND_OPT_LACP_RATE,
288 .desc = "LACPDU tx rate to request from 802.3ad partner",
289 .flags = BOND_OPTFLAG_IFDOWN,
290 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
291 .values = bond_lacp_rate_tbl,
292 .set = bond_option_lacp_rate_set
294 [BOND_OPT_MINLINKS] = {
295 .id = BOND_OPT_MINLINKS,
297 .desc = "Minimum number of available links before turning on carrier",
298 .values = bond_intmax_tbl,
299 .set = bond_option_min_links_set
301 [BOND_OPT_AD_SELECT] = {
302 .id = BOND_OPT_AD_SELECT,
304 .desc = "803.ad aggregation selection logic",
305 .flags = BOND_OPTFLAG_IFDOWN,
306 .values = bond_ad_select_tbl,
307 .set = bond_option_ad_select_set
309 [BOND_OPT_NUM_PEER_NOTIF] = {
310 .id = BOND_OPT_NUM_PEER_NOTIF,
311 .name = "num_unsol_na",
312 .desc = "Number of peer notifications to send on failover event",
313 .values = bond_num_peer_notif_tbl,
314 .set = bond_option_num_peer_notif_set
316 [BOND_OPT_MIIMON] = {
317 .id = BOND_OPT_MIIMON,
319 .desc = "Link check interval in milliseconds",
320 .values = bond_intmax_tbl,
321 .set = bond_option_miimon_set
323 [BOND_OPT_PRIMARY] = {
324 .id = BOND_OPT_PRIMARY,
326 .desc = "Primary network device to use",
327 .flags = BOND_OPTFLAG_RAWVAL,
328 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ACTIVEBACKUP) |
331 .set = bond_option_primary_set
333 [BOND_OPT_PRIMARY_RESELECT] = {
334 .id = BOND_OPT_PRIMARY_RESELECT,
335 .name = "primary_reselect",
336 .desc = "Reselect primary slave once it comes up",
337 .values = bond_primary_reselect_tbl,
338 .set = bond_option_primary_reselect_set
340 [BOND_OPT_USE_CARRIER] = {
341 .id = BOND_OPT_USE_CARRIER,
342 .name = "use_carrier",
343 .desc = "Use netif_carrier_ok (vs MII ioctls) in miimon",
344 .values = bond_use_carrier_tbl,
345 .set = bond_option_use_carrier_set
347 [BOND_OPT_ACTIVE_SLAVE] = {
348 .id = BOND_OPT_ACTIVE_SLAVE,
349 .name = "active_slave",
350 .desc = "Currently active slave",
351 .flags = BOND_OPTFLAG_RAWVAL,
352 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_ACTIVEBACKUP) |
355 .set = bond_option_active_slave_set
357 [BOND_OPT_QUEUE_ID] = {
358 .id = BOND_OPT_QUEUE_ID,
360 .desc = "Set queue id of a slave",
361 .flags = BOND_OPTFLAG_RAWVAL,
362 .set = bond_option_queue_id_set
364 [BOND_OPT_ALL_SLAVES_ACTIVE] = {
365 .id = BOND_OPT_ALL_SLAVES_ACTIVE,
366 .name = "all_slaves_active",
367 .desc = "Keep all frames received on an interface by setting active flag for all slaves",
368 .values = bond_all_slaves_active_tbl,
369 .set = bond_option_all_slaves_active_set
371 [BOND_OPT_RESEND_IGMP] = {
372 .id = BOND_OPT_RESEND_IGMP,
373 .name = "resend_igmp",
374 .desc = "Number of IGMP membership reports to send on link failure",
375 .values = bond_resend_igmp_tbl,
376 .set = bond_option_resend_igmp_set
378 [BOND_OPT_LP_INTERVAL] = {
379 .id = BOND_OPT_LP_INTERVAL,
380 .name = "lp_interval",
381 .desc = "The number of seconds between instances where the bonding driver sends learning packets to each slave's peer switch",
382 .values = bond_lp_interval_tbl,
383 .set = bond_option_lp_interval_set
385 [BOND_OPT_SLAVES] = {
386 .id = BOND_OPT_SLAVES,
388 .desc = "Slave membership management",
389 .flags = BOND_OPTFLAG_RAWVAL,
390 .set = bond_option_slaves_set
392 [BOND_OPT_TLB_DYNAMIC_LB] = {
393 .id = BOND_OPT_TLB_DYNAMIC_LB,
394 .name = "tlb_dynamic_lb",
395 .desc = "Enable dynamic flow shuffling",
396 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_TLB) | BIT(BOND_MODE_ALB)),
397 .values = bond_tlb_dynamic_lb_tbl,
398 .flags = BOND_OPTFLAG_IFDOWN,
399 .set = bond_option_tlb_dynamic_lb_set,
401 [BOND_OPT_AD_ACTOR_SYS_PRIO] = {
402 .id = BOND_OPT_AD_ACTOR_SYS_PRIO,
403 .name = "ad_actor_sys_prio",
404 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
405 .values = bond_ad_actor_sys_prio_tbl,
406 .set = bond_option_ad_actor_sys_prio_set,
408 [BOND_OPT_AD_ACTOR_SYSTEM] = {
409 .id = BOND_OPT_AD_ACTOR_SYSTEM,
410 .name = "ad_actor_system",
411 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
412 .flags = BOND_OPTFLAG_RAWVAL,
413 .set = bond_option_ad_actor_system_set,
415 [BOND_OPT_AD_USER_PORT_KEY] = {
416 .id = BOND_OPT_AD_USER_PORT_KEY,
417 .name = "ad_user_port_key",
418 .unsuppmodes = BOND_MODE_ALL_EX(BIT(BOND_MODE_8023AD)),
419 .flags = BOND_OPTFLAG_IFDOWN,
420 .values = bond_ad_user_port_key_tbl,
421 .set = bond_option_ad_user_port_key_set,
423 [BOND_OPT_NUM_PEER_NOTIF_ALIAS] = {
424 .id = BOND_OPT_NUM_PEER_NOTIF_ALIAS,
425 .name = "num_grat_arp",
426 .desc = "Number of peer notifications to send on failover event",
427 .values = bond_num_peer_notif_tbl,
428 .set = bond_option_num_peer_notif_set
430 [BOND_OPT_PEER_NOTIF_DELAY] = {
431 .id = BOND_OPT_PEER_NOTIF_DELAY,
432 .name = "peer_notif_delay",
433 .desc = "Delay between each peer notification on failover event, in milliseconds",
434 .values = bond_intmax_tbl,
435 .set = bond_option_peer_notif_delay_set
439 /* Searches for an option by name */
440 const struct bond_option *bond_opt_get_by_name(const char *name)
442 const struct bond_option *opt;
445 for (option = 0; option < BOND_OPT_LAST; option++) {
446 opt = bond_opt_get(option);
447 if (opt && !strcmp(opt->name, name))
454 /* Searches for a value in opt's values[] table */
455 const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val)
457 const struct bond_option *opt;
460 opt = bond_opt_get(option);
463 for (i = 0; opt->values && opt->values[i].string; i++)
464 if (opt->values[i].value == val)
465 return &opt->values[i];
470 /* Searches for a value in opt's values[] table which matches the flagmask */
471 static const struct bond_opt_value *bond_opt_get_flags(const struct bond_option *opt,
476 for (i = 0; opt->values && opt->values[i].string; i++)
477 if (opt->values[i].flags & flagmask)
478 return &opt->values[i];
483 /* If maxval is missing then there's no range to check. In case minval is
484 * missing then it's considered to be 0.
486 static bool bond_opt_check_range(const struct bond_option *opt, u64 val)
488 const struct bond_opt_value *minval, *maxval;
490 minval = bond_opt_get_flags(opt, BOND_VALFLAG_MIN);
491 maxval = bond_opt_get_flags(opt, BOND_VALFLAG_MAX);
492 if (!maxval || (minval && val < minval->value) || val > maxval->value)
499 * bond_opt_parse - parse option value
500 * @opt: the option to parse against
501 * @val: value to parse
503 * This function tries to extract the value from @val and check if it's
504 * a possible match for the option and returns NULL if a match isn't found,
505 * or the struct_opt_value that matched. It also strips the new line from
506 * @val->string if it's present.
508 const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
509 struct bond_opt_value *val)
511 char *p, valstr[BOND_OPT_MAX_NAMELEN + 1] = { 0, };
512 const struct bond_opt_value *tbl;
513 const struct bond_opt_value *ret = NULL;
517 /* No parsing if the option wants a raw val */
518 if (opt->flags & BOND_OPTFLAG_RAWVAL)
525 /* ULLONG_MAX is used to bypass string processing */
526 checkval = val->value != ULLONG_MAX;
530 p = strchr(val->string, '\n');
533 for (p = val->string; *p; p++)
534 if (!(isdigit(*p) || isspace(*p)))
536 /* The following code extracts the string to match or the value
537 * and sets checkval appropriately
540 rv = sscanf(val->string, "%32s", valstr);
542 rv = sscanf(val->string, "%llu", &val->value);
549 for (i = 0; tbl[i].string; i++) {
550 /* Check for exact match */
552 if (val->value == tbl[i].value)
555 if (!strcmp(valstr, "default") &&
556 (tbl[i].flags & BOND_VALFLAG_DEFAULT))
559 if (!strcmp(valstr, tbl[i].string))
562 /* Found an exact match */
566 /* Possible range match */
567 if (checkval && bond_opt_check_range(opt, val->value))
573 /* Check opt's dependencies against bond mode and currently set options */
574 static int bond_opt_check_deps(struct bonding *bond,
575 const struct bond_option *opt)
577 struct bond_params *params = &bond->params;
579 if (test_bit(params->mode, &opt->unsuppmodes))
581 if ((opt->flags & BOND_OPTFLAG_NOSLAVES) && bond_has_slaves(bond))
583 if ((opt->flags & BOND_OPTFLAG_IFDOWN) && (bond->dev->flags & IFF_UP))
589 static void bond_opt_dep_print(struct bonding *bond,
590 const struct bond_option *opt)
592 const struct bond_opt_value *modeval;
593 struct bond_params *params;
595 params = &bond->params;
596 modeval = bond_opt_get_val(BOND_OPT_MODE, params->mode);
597 if (test_bit(params->mode, &opt->unsuppmodes))
598 netdev_err(bond->dev, "option %s: mode dependency failed, not supported in mode %s(%llu)\n",
599 opt->name, modeval->string, modeval->value);
602 static void bond_opt_error_interpret(struct bonding *bond,
603 const struct bond_option *opt,
604 int error, const struct bond_opt_value *val)
606 const struct bond_opt_value *minval, *maxval;
613 /* sometimes RAWVAL opts may have new lines */
614 p = strchr(val->string, '\n');
617 netdev_err(bond->dev, "option %s: invalid value (%s)\n",
618 opt->name, val->string);
620 netdev_err(bond->dev, "option %s: invalid value (%llu)\n",
621 opt->name, val->value);
624 minval = bond_opt_get_flags(opt, BOND_VALFLAG_MIN);
625 maxval = bond_opt_get_flags(opt, BOND_VALFLAG_MAX);
628 netdev_err(bond->dev, "option %s: allowed values %llu - %llu\n",
629 opt->name, minval ? minval->value : 0, maxval->value);
632 bond_opt_dep_print(bond, opt);
635 netdev_err(bond->dev, "option %s: unable to set because the bond device has slaves\n",
639 netdev_err(bond->dev, "option %s: unable to set because the bond device is up\n",
648 * __bond_opt_set - set a bonding option
649 * @bond: target bond device
650 * @option: option to set
651 * @val: value to set it to
653 * This function is used to change the bond's option value, it can be
654 * used for both enabling/changing an option and for disabling it. RTNL lock
655 * must be obtained before calling this function.
657 int __bond_opt_set(struct bonding *bond,
658 unsigned int option, struct bond_opt_value *val)
660 const struct bond_opt_value *retval = NULL;
661 const struct bond_option *opt;
666 opt = bond_opt_get(option);
667 if (WARN_ON(!val) || WARN_ON(!opt))
669 ret = bond_opt_check_deps(bond, opt);
672 retval = bond_opt_parse(opt, val);
677 ret = opt->set(bond, retval);
680 bond_opt_error_interpret(bond, opt, ret, val);
685 * __bond_opt_set_notify - set a bonding option
686 * @bond: target bond device
687 * @option: option to set
688 * @val: value to set it to
690 * This function is used to change the bond's option value and trigger
691 * a notification to user sapce. It can be used for both enabling/changing
692 * an option and for disabling it. RTNL lock must be obtained before calling
695 int __bond_opt_set_notify(struct bonding *bond,
696 unsigned int option, struct bond_opt_value *val)
702 ret = __bond_opt_set(bond, option, val);
704 if (!ret && (bond->dev->reg_state == NETREG_REGISTERED))
705 call_netdevice_notifiers(NETDEV_CHANGEINFODATA, bond->dev);
711 * bond_opt_tryset_rtnl - try to acquire rtnl and call __bond_opt_set
712 * @bond: target bond device
713 * @option: option to set
714 * @buf: value to set it to
716 * This function tries to acquire RTNL without blocking and if successful
717 * calls __bond_opt_set. It is mainly used for sysfs option manipulation.
719 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf)
721 struct bond_opt_value optval;
725 return restart_syscall();
726 bond_opt_initstr(&optval, buf);
727 ret = __bond_opt_set_notify(bond, option, &optval);
734 * bond_opt_get - get a pointer to an option
735 * @option: option for which to return a pointer
737 * This function checks if option is valid and if so returns a pointer
738 * to its entry in the bond_opts[] option array.
740 const struct bond_option *bond_opt_get(unsigned int option)
742 if (!BOND_OPT_VALID(option))
745 return &bond_opts[option];
748 static void bond_set_xfrm_features(struct net_device *bond_dev, u64 mode)
750 if (!IS_ENABLED(CONFIG_XFRM_OFFLOAD))
753 if (mode == BOND_MODE_ACTIVEBACKUP)
754 bond_dev->wanted_features |= BOND_XFRM_FEATURES;
756 bond_dev->wanted_features &= ~BOND_XFRM_FEATURES;
758 netdev_update_features(bond_dev);
761 static int bond_option_mode_set(struct bonding *bond,
762 const struct bond_opt_value *newval)
764 if (!bond_mode_uses_arp(newval->value)) {
765 if (bond->params.arp_interval) {
766 netdev_dbg(bond->dev, "%s mode is incompatible with arp monitoring, start mii monitoring\n",
768 /* disable arp monitoring */
769 bond->params.arp_interval = 0;
772 if (!bond->params.miimon) {
773 /* set miimon to default value */
774 bond->params.miimon = BOND_DEFAULT_MIIMON;
775 netdev_dbg(bond->dev, "Setting MII monitoring interval to %d\n",
776 bond->params.miimon);
780 if (newval->value == BOND_MODE_ALB)
781 bond->params.tlb_dynamic_lb = 1;
783 if (bond->dev->reg_state == NETREG_REGISTERED)
784 bond_set_xfrm_features(bond->dev, newval->value);
786 /* don't cache arp_validate between modes */
787 bond->params.arp_validate = BOND_ARP_VALIDATE_NONE;
788 bond->params.mode = newval->value;
793 static int bond_option_active_slave_set(struct bonding *bond,
794 const struct bond_opt_value *newval)
796 char ifname[IFNAMSIZ] = { 0, };
797 struct net_device *slave_dev;
800 sscanf(newval->string, "%15s", ifname); /* IFNAMSIZ */
801 if (!strlen(ifname) || newval->string[0] == '\n') {
804 slave_dev = __dev_get_by_name(dev_net(bond->dev), ifname);
810 if (!netif_is_bond_slave(slave_dev)) {
811 slave_err(bond->dev, slave_dev, "Device is not bonding slave\n");
815 if (bond->dev != netdev_master_upper_dev_get(slave_dev)) {
816 slave_err(bond->dev, slave_dev, "Device is not our slave\n");
822 /* check to see if we are clearing active */
824 netdev_dbg(bond->dev, "Clearing current active slave\n");
825 RCU_INIT_POINTER(bond->curr_active_slave, NULL);
826 bond_select_active_slave(bond);
828 struct slave *old_active = rtnl_dereference(bond->curr_active_slave);
829 struct slave *new_active = bond_slave_get_rtnl(slave_dev);
833 if (new_active == old_active) {
835 slave_dbg(bond->dev, new_active->dev, "is already the current active slave\n");
837 if (old_active && (new_active->link == BOND_LINK_UP) &&
838 bond_slave_is_up(new_active)) {
839 slave_dbg(bond->dev, new_active->dev, "Setting as active slave\n");
840 bond_change_active_slave(bond, new_active);
842 slave_err(bond->dev, new_active->dev, "Could not set as active slave; either %s is down or the link is down\n",
843 new_active->dev->name);
848 unblock_netpoll_tx();
853 /* There are two tricky bits here. First, if MII monitoring is activated, then
854 * we must disable ARP monitoring. Second, if the timer isn't running, we must
857 static int bond_option_miimon_set(struct bonding *bond,
858 const struct bond_opt_value *newval)
860 netdev_dbg(bond->dev, "Setting MII monitoring interval to %llu\n",
862 bond->params.miimon = newval->value;
863 if (bond->params.updelay)
864 netdev_dbg(bond->dev, "Note: Updating updelay (to %d) since it is a multiple of the miimon value\n",
865 bond->params.updelay * bond->params.miimon);
866 if (bond->params.downdelay)
867 netdev_dbg(bond->dev, "Note: Updating downdelay (to %d) since it is a multiple of the miimon value\n",
868 bond->params.downdelay * bond->params.miimon);
869 if (bond->params.peer_notif_delay)
870 netdev_dbg(bond->dev, "Note: Updating peer_notif_delay (to %d) since it is a multiple of the miimon value\n",
871 bond->params.peer_notif_delay * bond->params.miimon);
872 if (newval->value && bond->params.arp_interval) {
873 netdev_dbg(bond->dev, "MII monitoring cannot be used with ARP monitoring - disabling ARP monitoring...\n");
874 bond->params.arp_interval = 0;
875 if (bond->params.arp_validate)
876 bond->params.arp_validate = BOND_ARP_VALIDATE_NONE;
878 if (bond->dev->flags & IFF_UP) {
879 /* If the interface is up, we may need to fire off
880 * the MII timer. If the interface is down, the
881 * timer will get fired off when the open function
884 if (!newval->value) {
885 cancel_delayed_work_sync(&bond->mii_work);
887 cancel_delayed_work_sync(&bond->arp_work);
888 queue_delayed_work(bond->wq, &bond->mii_work, 0);
895 /* Set up, down and peer notification delays. These must be multiples
896 * of the MII monitoring value, and are stored internally as the
897 * multiplier. Thus, we must translate to MS for the real world.
899 static int _bond_option_delay_set(struct bonding *bond,
900 const struct bond_opt_value *newval,
904 int value = newval->value;
906 if (!bond->params.miimon) {
907 netdev_err(bond->dev, "Unable to set %s as MII monitoring is disabled\n",
911 if ((value % bond->params.miimon) != 0) {
912 netdev_warn(bond->dev,
913 "%s (%d) is not a multiple of miimon (%d), value rounded to %d ms\n",
915 value, bond->params.miimon,
916 (value / bond->params.miimon) *
917 bond->params.miimon);
919 *target = value / bond->params.miimon;
920 netdev_dbg(bond->dev, "Setting %s to %d\n",
922 *target * bond->params.miimon);
927 static int bond_option_updelay_set(struct bonding *bond,
928 const struct bond_opt_value *newval)
930 return _bond_option_delay_set(bond, newval, "up delay",
931 &bond->params.updelay);
934 static int bond_option_downdelay_set(struct bonding *bond,
935 const struct bond_opt_value *newval)
937 return _bond_option_delay_set(bond, newval, "down delay",
938 &bond->params.downdelay);
941 static int bond_option_peer_notif_delay_set(struct bonding *bond,
942 const struct bond_opt_value *newval)
944 int ret = _bond_option_delay_set(bond, newval,
945 "peer notification delay",
946 &bond->params.peer_notif_delay);
950 static int bond_option_use_carrier_set(struct bonding *bond,
951 const struct bond_opt_value *newval)
953 netdev_dbg(bond->dev, "Setting use_carrier to %llu\n",
955 bond->params.use_carrier = newval->value;
960 /* There are two tricky bits here. First, if ARP monitoring is activated, then
961 * we must disable MII monitoring. Second, if the ARP timer isn't running,
964 static int bond_option_arp_interval_set(struct bonding *bond,
965 const struct bond_opt_value *newval)
967 netdev_dbg(bond->dev, "Setting ARP monitoring interval to %llu\n",
969 bond->params.arp_interval = newval->value;
971 if (bond->params.miimon) {
972 netdev_dbg(bond->dev, "ARP monitoring cannot be used with MII monitoring. Disabling MII monitoring\n");
973 bond->params.miimon = 0;
975 if (!bond->params.arp_targets[0])
976 netdev_dbg(bond->dev, "ARP monitoring has been set up, but no ARP targets have been specified\n");
978 if (bond->dev->flags & IFF_UP) {
979 /* If the interface is up, we may need to fire off
980 * the ARP timer. If the interface is down, the
981 * timer will get fired off when the open function
984 if (!newval->value) {
985 if (bond->params.arp_validate)
986 bond->recv_probe = NULL;
987 cancel_delayed_work_sync(&bond->arp_work);
989 /* arp_validate can be set only in active-backup mode */
990 bond->recv_probe = bond_arp_rcv;
991 cancel_delayed_work_sync(&bond->mii_work);
992 queue_delayed_work(bond->wq, &bond->arp_work, 0);
999 static void _bond_options_arp_ip_target_set(struct bonding *bond, int slot,
1001 unsigned long last_rx)
1003 __be32 *targets = bond->params.arp_targets;
1004 struct list_head *iter;
1005 struct slave *slave;
1007 if (slot >= 0 && slot < BOND_MAX_ARP_TARGETS) {
1008 bond_for_each_slave(bond, slave, iter)
1009 slave->target_last_arp_rx[slot] = last_rx;
1010 targets[slot] = target;
1014 static int _bond_option_arp_ip_target_add(struct bonding *bond, __be32 target)
1016 __be32 *targets = bond->params.arp_targets;
1019 if (!bond_is_ip_target_ok(target)) {
1020 netdev_err(bond->dev, "invalid ARP target %pI4 specified for addition\n",
1025 if (bond_get_targets_ip(targets, target) != -1) { /* dup */
1026 netdev_err(bond->dev, "ARP target %pI4 is already present\n",
1031 ind = bond_get_targets_ip(targets, 0); /* first free slot */
1033 netdev_err(bond->dev, "ARP target table is full!\n");
1037 netdev_dbg(bond->dev, "Adding ARP target %pI4\n", &target);
1039 _bond_options_arp_ip_target_set(bond, ind, target, jiffies);
1044 static int bond_option_arp_ip_target_add(struct bonding *bond, __be32 target)
1046 return _bond_option_arp_ip_target_add(bond, target);
1049 static int bond_option_arp_ip_target_rem(struct bonding *bond, __be32 target)
1051 __be32 *targets = bond->params.arp_targets;
1052 struct list_head *iter;
1053 struct slave *slave;
1054 unsigned long *targets_rx;
1057 if (!bond_is_ip_target_ok(target)) {
1058 netdev_err(bond->dev, "invalid ARP target %pI4 specified for removal\n",
1063 ind = bond_get_targets_ip(targets, target);
1065 netdev_err(bond->dev, "unable to remove nonexistent ARP target %pI4\n",
1070 if (ind == 0 && !targets[1] && bond->params.arp_interval)
1071 netdev_warn(bond->dev, "Removing last arp target with arp_interval on\n");
1073 netdev_dbg(bond->dev, "Removing ARP target %pI4\n", &target);
1075 bond_for_each_slave(bond, slave, iter) {
1076 targets_rx = slave->target_last_arp_rx;
1077 for (i = ind; (i < BOND_MAX_ARP_TARGETS-1) && targets[i+1]; i++)
1078 targets_rx[i] = targets_rx[i+1];
1081 for (i = ind; (i < BOND_MAX_ARP_TARGETS-1) && targets[i+1]; i++)
1082 targets[i] = targets[i+1];
1088 void bond_option_arp_ip_targets_clear(struct bonding *bond)
1092 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
1093 _bond_options_arp_ip_target_set(bond, i, 0, 0);
1096 static int bond_option_arp_ip_targets_set(struct bonding *bond,
1097 const struct bond_opt_value *newval)
1102 if (newval->string) {
1103 if (!in4_pton(newval->string+1, -1, (u8 *)&target, -1, NULL)) {
1104 netdev_err(bond->dev, "invalid ARP target %pI4 specified\n",
1108 if (newval->string[0] == '+')
1109 ret = bond_option_arp_ip_target_add(bond, target);
1110 else if (newval->string[0] == '-')
1111 ret = bond_option_arp_ip_target_rem(bond, target);
1113 netdev_err(bond->dev, "no command found in arp_ip_targets file - use +<addr> or -<addr>\n");
1115 target = newval->value;
1116 ret = bond_option_arp_ip_target_add(bond, target);
1122 static int bond_option_arp_validate_set(struct bonding *bond,
1123 const struct bond_opt_value *newval)
1125 netdev_dbg(bond->dev, "Setting arp_validate to %s (%llu)\n",
1126 newval->string, newval->value);
1127 bond->params.arp_validate = newval->value;
1132 static int bond_option_arp_all_targets_set(struct bonding *bond,
1133 const struct bond_opt_value *newval)
1135 netdev_dbg(bond->dev, "Setting arp_all_targets to %s (%llu)\n",
1136 newval->string, newval->value);
1137 bond->params.arp_all_targets = newval->value;
1142 static int bond_option_primary_set(struct bonding *bond,
1143 const struct bond_opt_value *newval)
1145 char *p, *primary = newval->string;
1146 struct list_head *iter;
1147 struct slave *slave;
1151 p = strchr(primary, '\n');
1154 /* check to see if we are clearing primary */
1155 if (!strlen(primary)) {
1156 netdev_dbg(bond->dev, "Setting primary slave to None\n");
1157 RCU_INIT_POINTER(bond->primary_slave, NULL);
1158 memset(bond->params.primary, 0, sizeof(bond->params.primary));
1159 bond_select_active_slave(bond);
1163 bond_for_each_slave(bond, slave, iter) {
1164 if (strncmp(slave->dev->name, primary, IFNAMSIZ) == 0) {
1165 slave_dbg(bond->dev, slave->dev, "Setting as primary slave\n");
1166 rcu_assign_pointer(bond->primary_slave, slave);
1167 strcpy(bond->params.primary, slave->dev->name);
1168 bond->force_primary = true;
1169 bond_select_active_slave(bond);
1174 if (rtnl_dereference(bond->primary_slave)) {
1175 netdev_dbg(bond->dev, "Setting primary slave to None\n");
1176 RCU_INIT_POINTER(bond->primary_slave, NULL);
1177 bond_select_active_slave(bond);
1179 strncpy(bond->params.primary, primary, IFNAMSIZ);
1180 bond->params.primary[IFNAMSIZ - 1] = 0;
1182 netdev_dbg(bond->dev, "Recording %s as primary, but it has not been enslaved yet\n",
1186 unblock_netpoll_tx();
1191 static int bond_option_primary_reselect_set(struct bonding *bond,
1192 const struct bond_opt_value *newval)
1194 netdev_dbg(bond->dev, "Setting primary_reselect to %s (%llu)\n",
1195 newval->string, newval->value);
1196 bond->params.primary_reselect = newval->value;
1199 bond_select_active_slave(bond);
1200 unblock_netpoll_tx();
1205 static int bond_option_fail_over_mac_set(struct bonding *bond,
1206 const struct bond_opt_value *newval)
1208 netdev_dbg(bond->dev, "Setting fail_over_mac to %s (%llu)\n",
1209 newval->string, newval->value);
1210 bond->params.fail_over_mac = newval->value;
1215 static int bond_option_xmit_hash_policy_set(struct bonding *bond,
1216 const struct bond_opt_value *newval)
1218 netdev_dbg(bond->dev, "Setting xmit hash policy to %s (%llu)\n",
1219 newval->string, newval->value);
1220 bond->params.xmit_policy = newval->value;
1225 static int bond_option_resend_igmp_set(struct bonding *bond,
1226 const struct bond_opt_value *newval)
1228 netdev_dbg(bond->dev, "Setting resend_igmp to %llu\n",
1230 bond->params.resend_igmp = newval->value;
1235 static int bond_option_num_peer_notif_set(struct bonding *bond,
1236 const struct bond_opt_value *newval)
1238 bond->params.num_peer_notif = newval->value;
1243 static int bond_option_all_slaves_active_set(struct bonding *bond,
1244 const struct bond_opt_value *newval)
1246 struct list_head *iter;
1247 struct slave *slave;
1249 if (newval->value == bond->params.all_slaves_active)
1251 bond->params.all_slaves_active = newval->value;
1252 bond_for_each_slave(bond, slave, iter) {
1253 if (!bond_is_active_slave(slave)) {
1255 slave->inactive = 0;
1257 slave->inactive = 1;
1264 static int bond_option_min_links_set(struct bonding *bond,
1265 const struct bond_opt_value *newval)
1267 netdev_dbg(bond->dev, "Setting min links value to %llu\n",
1269 bond->params.min_links = newval->value;
1270 bond_set_carrier(bond);
1275 static int bond_option_lp_interval_set(struct bonding *bond,
1276 const struct bond_opt_value *newval)
1278 bond->params.lp_interval = newval->value;
1283 static int bond_option_pps_set(struct bonding *bond,
1284 const struct bond_opt_value *newval)
1286 netdev_dbg(bond->dev, "Setting packets per slave to %llu\n",
1288 bond->params.packets_per_slave = newval->value;
1289 if (newval->value > 0) {
1290 bond->params.reciprocal_packets_per_slave =
1291 reciprocal_value(newval->value);
1293 /* reciprocal_packets_per_slave is unused if
1294 * packets_per_slave is 0 or 1, just initialize it
1296 bond->params.reciprocal_packets_per_slave =
1297 (struct reciprocal_value) { 0 };
1303 static int bond_option_lacp_rate_set(struct bonding *bond,
1304 const struct bond_opt_value *newval)
1306 netdev_dbg(bond->dev, "Setting LACP rate to %s (%llu)\n",
1307 newval->string, newval->value);
1308 bond->params.lacp_fast = newval->value;
1309 bond_3ad_update_lacp_rate(bond);
1314 static int bond_option_ad_select_set(struct bonding *bond,
1315 const struct bond_opt_value *newval)
1317 netdev_dbg(bond->dev, "Setting ad_select to %s (%llu)\n",
1318 newval->string, newval->value);
1319 bond->params.ad_select = newval->value;
1324 static int bond_option_queue_id_set(struct bonding *bond,
1325 const struct bond_opt_value *newval)
1327 struct slave *slave, *update_slave;
1328 struct net_device *sdev;
1329 struct list_head *iter;
1334 /* delim will point to queue id if successful */
1335 delim = strchr(newval->string, ':');
1339 /* Terminate string that points to device name and bump it
1340 * up one, so we can read the queue id there.
1343 if (sscanf(++delim, "%hd\n", &qid) != 1)
1346 /* Check buffer length, valid ifname and queue id */
1347 if (!dev_valid_name(newval->string) ||
1348 qid > bond->dev->real_num_tx_queues)
1351 /* Get the pointer to that interface if it exists */
1352 sdev = __dev_get_by_name(dev_net(bond->dev), newval->string);
1356 /* Search for thes slave and check for duplicate qids */
1357 update_slave = NULL;
1358 bond_for_each_slave(bond, slave, iter) {
1359 if (sdev == slave->dev)
1360 /* We don't need to check the matching
1361 * slave for dups, since we're overwriting it
1363 update_slave = slave;
1364 else if (qid && qid == slave->queue_id) {
1372 /* Actually set the qids for the slave */
1373 update_slave->queue_id = qid;
1379 netdev_dbg(bond->dev, "invalid input for queue_id set\n");
1385 static int bond_option_slaves_set(struct bonding *bond,
1386 const struct bond_opt_value *newval)
1388 char command[IFNAMSIZ + 1] = { 0, };
1389 struct net_device *dev;
1393 sscanf(newval->string, "%16s", command); /* IFNAMSIZ*/
1394 ifname = command + 1;
1395 if ((strlen(command) <= 1) ||
1396 (command[0] != '+' && command[0] != '-') ||
1397 !dev_valid_name(ifname))
1400 dev = __dev_get_by_name(dev_net(bond->dev), ifname);
1402 netdev_dbg(bond->dev, "interface %s does not exist!\n",
1408 switch (command[0]) {
1410 slave_dbg(bond->dev, dev, "Enslaving interface\n");
1411 ret = bond_enslave(bond->dev, dev, NULL);
1415 slave_dbg(bond->dev, dev, "Releasing interface\n");
1416 ret = bond_release(bond->dev, dev);
1420 /* should not run here. */
1428 netdev_err(bond->dev, "no command found in slaves file - use +ifname or -ifname\n");
1433 static int bond_option_tlb_dynamic_lb_set(struct bonding *bond,
1434 const struct bond_opt_value *newval)
1436 netdev_dbg(bond->dev, "Setting dynamic-lb to %s (%llu)\n",
1437 newval->string, newval->value);
1438 bond->params.tlb_dynamic_lb = newval->value;
1443 static int bond_option_ad_actor_sys_prio_set(struct bonding *bond,
1444 const struct bond_opt_value *newval)
1446 netdev_dbg(bond->dev, "Setting ad_actor_sys_prio to %llu\n",
1449 bond->params.ad_actor_sys_prio = newval->value;
1450 bond_3ad_update_ad_actor_settings(bond);
1455 static int bond_option_ad_actor_system_set(struct bonding *bond,
1456 const struct bond_opt_value *newval)
1458 u8 macaddr[ETH_ALEN];
1461 if (newval->string) {
1462 if (!mac_pton(newval->string, macaddr))
1466 mac = (u8 *)&newval->value;
1469 if (is_multicast_ether_addr(mac))
1472 netdev_dbg(bond->dev, "Setting ad_actor_system to %pM\n", mac);
1473 ether_addr_copy(bond->params.ad_actor_system, mac);
1474 bond_3ad_update_ad_actor_settings(bond);
1479 netdev_err(bond->dev, "Invalid ad_actor_system MAC address.\n");
1483 static int bond_option_ad_user_port_key_set(struct bonding *bond,
1484 const struct bond_opt_value *newval)
1486 netdev_dbg(bond->dev, "Setting ad_user_port_key to %llu\n",
1489 bond->params.ad_user_port_key = newval->value;