udhcp: fix config help text
[oweals/busybox.git] / networking / ifenslave.c
1 /* Mode: C;
2  *
3  * Mini ifenslave implementation for busybox
4  * Copyright (C) 2005 by Marc Leeman <marc.leeman@barco.com>
5  *
6  * ifenslave.c: Configure network interfaces for parallel routing.
7  *
8  *      This program controls the Linux implementation of running multiple
9  *      network interfaces in parallel.
10  *
11  * Author:      Donald Becker <becker@cesdis.gsfc.nasa.gov>
12  *              Copyright 1994-1996 Donald Becker
13  *
14  *              This program is free software; you can redistribute it
15  *              and/or modify it under the terms of the GNU General Public
16  *              License as published by the Free Software Foundation.
17  *
18  *      The author may be reached as becker@CESDIS.gsfc.nasa.gov, or C/O
19  *      Center of Excellence in Space Data and Information Sciences
20  *         Code 930.5, Goddard Space Flight Center, Greenbelt MD 20771
21  *
22  *  Changes :
23  *    - 2000/10/02 Willy Tarreau <willy at meta-x.org> :
24  *       - few fixes. Master's MAC address is now correctly taken from
25  *         the first device when not previously set ;
26  *       - detach support : call BOND_RELEASE to detach an enslaved interface.
27  *       - give a mini-howto from command-line help : # ifenslave -h
28  *
29  *    - 2001/02/16 Chad N. Tindel <ctindel at ieee dot org> :
30  *       - Master is now brought down before setting the MAC address.  In
31  *         the 2.4 kernel you can't change the MAC address while the device is
32  *         up because you get EBUSY.
33  *
34  *    - 2001/09/13 Takao Indoh <indou dot takao at jp dot fujitsu dot com>
35  *       - Added the ability to change the active interface on a mode 1 bond
36  *         at runtime.
37  *
38  *    - 2001/10/23 Chad N. Tindel <ctindel at ieee dot org> :
39  *       - No longer set the MAC address of the master.  The bond device will
40  *         take care of this itself
41  *       - Try the SIOC*** versions of the bonding ioctls before using the
42  *         old versions
43  *    - 2002/02/18 Erik Habbinga <erik_habbinga @ hp dot com> :
44  *       - ifr2.ifr_flags was not initialized in the hwaddr_notset case,
45  *         SIOCGIFFLAGS now called before hwaddr_notset test
46  *
47  *    - 2002/10/31 Tony Cureington <tony.cureington * hp_com> :
48  *       - If the master does not have a hardware address when the first slave
49  *         is enslaved, the master is assigned the hardware address of that
50  *         slave - there is a comment in bonding.c stating "ifenslave takes
51  *         care of this now." This corrects the problem of slaves having
52  *         different hardware addresses in active-backup mode when
53  *         multiple interfaces are specified on a single ifenslave command
54  *         (ifenslave bond0 eth0 eth1).
55  *
56  *    - 2003/03/18 - Tsippy Mendelson <tsippy.mendelson at intel dot com> and
57  *                   Shmulik Hen <shmulik.hen at intel dot com>
58  *       - Moved setting the slave's mac address and openning it, from
59  *         the application to the driver. This enables support of modes
60  *         that need to use the unique mac address of each slave.
61  *         The driver also takes care of closing the slave and restoring its
62  *         original mac address upon release.
63  *         In addition, block possibility of enslaving before the master is up.
64  *         This prevents putting the system in an undefined state.
65  *
66  *    - 2003/05/01 - Amir Noam <amir.noam at intel dot com>
67  *       - Added ABI version control to restore compatibility between
68  *         new/old ifenslave and new/old bonding.
69  *       - Prevent adding an adapter that is already a slave.
70  *         Fixes the problem of stalling the transmission and leaving
71  *         the slave in a down state.
72  *
73  *    - 2003/05/01 - Shmulik Hen <shmulik.hen at intel dot com>
74  *       - Prevent enslaving if the bond device is down.
75  *         Fixes the problem of leaving the system in unstable state and
76  *         halting when trying to remove the module.
77  *       - Close socket on all abnormal exists.
78  *       - Add versioning scheme that follows that of the bonding driver.
79  *         current version is 1.0.0 as a base line.
80  *
81  *    - 2003/05/22 - Jay Vosburgh <fubar at us dot ibm dot com>
82  *       - ifenslave -c was broken; it's now fixed
83  *       - Fixed problem with routes vanishing from master during enslave
84  *         processing.
85  *
86  *    - 2003/05/27 - Amir Noam <amir.noam at intel dot com>
87  *       - Fix backward compatibility issues:
88  *         For drivers not using ABI versions, slave was set down while
89  *         it should be left up before enslaving.
90  *         Also, master was not set down and the default set_mac_address()
91  *         would fail and generate an error message in the system log.
92  *       - For opt_c: slave should not be set to the master's setting
93  *         while it is running. It was already set during enslave. To
94  *         simplify things, it is now handeled separately.
95  *
96  *    - 2003/12/01 - Shmulik Hen <shmulik.hen at intel dot com>
97  *       - Code cleanup and style changes
98  *         set version to 1.1.0
99  */
100
101 #include "libbb.h"
102
103 #include <net/if_arp.h>
104 #include <linux/if_bonding.h>
105 #include <linux/sockios.h>
106
107 typedef unsigned long long u64; /* hack, so we may include kernel's ethtool.h */
108 typedef uint32_t u32;           /* ditto */
109 typedef uint16_t u16;           /* ditto */
110 typedef uint8_t u8;             /* ditto */
111 #include <linux/ethtool.h>
112
113
114 struct dev_data {
115         struct ifreq mtu, flags, hwaddr;
116 };
117
118
119 enum { skfd = 3 };      /* AF_INET socket for ioctl() calls.*/
120 struct globals {
121         unsigned abi_ver;       /* userland - kernel ABI version */
122         smallint hwaddr_set;    /* Master's hwaddr is set */
123         struct dev_data master;
124         struct dev_data slave;
125 };
126 #define G (*ptr_to_globals)
127 #define abi_ver    (G.abi_ver   )
128 #define hwaddr_set (G.hwaddr_set)
129 #define master     (G.master    )
130 #define slave      (G.slave     )
131 #define INIT_G() do { \
132         SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
133 } while (0)
134
135
136 static void get_drv_info(char *master_ifname);
137 static int get_if_settings(char *ifname, struct dev_data *dd);
138 static int get_slave_flags(char *slave_ifname);
139 static int set_master_hwaddr(char *master_ifname, struct sockaddr *hwaddr);
140 static int set_slave_hwaddr(char *slave_ifname, struct sockaddr *hwaddr);
141 static int set_slave_mtu(char *slave_ifname, int mtu);
142 static int set_if_flags(char *ifname, short flags);
143 static int set_if_up(char *ifname, short flags);
144 static int set_if_down(char *ifname, short flags);
145 static int clear_if_addr(char *ifname);
146 static int set_if_addr(char *master_ifname, char *slave_ifname);
147 static void change_active(char *master_ifname, char *slave_ifname);
148 static int enslave(char *master_ifname, char *slave_ifname);
149 static int release(char *master_ifname, char *slave_ifname);
150
151 static void strncpy_IFNAMSIZ(char *dst, const char *src)
152 {
153         strncpy(dst, src, IFNAMSIZ);
154 }
155
156 int ifenslave_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
157 int ifenslave_main(int argc ATTRIBUTE_UNUSED, char **argv)
158 {
159         char *master_ifname, *slave_ifname;
160         int rv;
161         int res;
162         unsigned opt;
163         enum {
164                 OPT_c = (1 << 0),
165                 OPT_d = (1 << 1),
166                 OPT_f = (1 << 2),
167         };
168 #if ENABLE_GETOPT_LONG
169         static const char ifenslave_longopts[] ALIGN1 =
170                 "change-active" No_argument "c"
171                 "detach"        No_argument "d"
172                 "force"         No_argument "f"
173         ;
174
175         applet_long_options = ifenslave_longopts;
176 #endif
177         opt = getopt32(argv, "cdf");
178         argv += optind;
179         if (opt & (opt-1)) /* options check */
180                 bb_show_usage();
181
182         /* Copy the interface name */
183         master_ifname = *argv++;
184
185         /* No remaining args means show all interfaces. */
186         if (!master_ifname) {
187                 display_interfaces(NULL);
188                 return EXIT_SUCCESS;
189         }
190
191         /* Open a basic socket */
192         xmove_fd(xsocket(AF_INET, SOCK_DGRAM, 0), skfd);
193
194         /* exchange abi version with bonding module */
195         get_drv_info(master_ifname);
196
197         slave_ifname = *argv++;
198         if (!slave_ifname) {
199                 if (opt & (OPT_d|OPT_c)) {
200                         display_interfaces(slave_ifname);
201                         return 2; /* why? */
202                 }
203                 /* A single arg means show the
204                  * configuration for this interface
205                  */
206                 display_interfaces(master_ifname);
207                 return EXIT_SUCCESS;
208         }
209
210         res = get_if_settings(master_ifname, &master);
211         if (res) {
212                 /* Probably a good reason not to go on */
213                 bb_perror_msg_and_die("%s: can't get settings", master_ifname);
214         }
215
216         /* check if master is indeed a master;
217          * if not then fail any operation
218          */
219         if (!(master.flags.ifr_flags & IFF_MASTER))
220                 bb_error_msg_and_die("%s is not a master", master_ifname);
221
222         /* check if master is up; if not then fail any operation */
223         if (!(master.flags.ifr_flags & IFF_UP))
224                 bb_error_msg_and_die("%s is not up", master_ifname);
225
226         /* Only for enslaving */
227         if (!(opt & (OPT_c|OPT_d))) {
228                 sa_family_t master_family = master.hwaddr.ifr_hwaddr.sa_family;
229
230                 /* The family '1' is ARPHRD_ETHER for ethernet. */
231                 if (master_family != 1 && !(opt & OPT_f)) {
232                         bb_error_msg_and_die(
233                                 "%s is not ethernet-like (-f overrides)",
234                                 master_ifname);
235                 }
236         }
237
238         /* Accepts only one slave */
239         if (opt & OPT_c) {
240                 /* change active slave */
241                 res = get_slave_flags(slave_ifname);
242                 if (res) {
243                         bb_perror_msg_and_die(
244                                 "%s: can't get flags", slave_ifname);
245                 }
246                 change_active(master_ifname, slave_ifname);
247                 return EXIT_SUCCESS;
248         }
249
250         /* Accept multiple slaves */
251         res = 0;
252         do {
253                 if (opt & OPT_d) {
254                         /* detach a slave interface from the master */
255                         rv = get_slave_flags(slave_ifname);
256                         if (rv) {
257                                 /* Can't work with this slave. */
258                                 /* remember the error and skip it*/
259                                 bb_perror_msg(
260                                         "skipping %s: can't get flags",
261                                         slave_ifname);
262                                 res = rv;
263                                 continue;
264                         }
265                         rv = release(master_ifname, slave_ifname);
266                         if (rv) {
267                                 bb_perror_msg(
268                                         "master %s, slave %s: "
269                                         "can't release",
270                                         master_ifname, slave_ifname);
271                                 res = rv;
272                         }
273                 } else {
274                         /* attach a slave interface to the master */
275                         rv = get_if_settings(slave_ifname, &slave);
276                         if (rv) {
277                                 /* Can't work with this slave. */
278                                 /* remember the error and skip it*/
279                                 bb_perror_msg(
280                                         "skipping %s: can't get settings",
281                                         slave_ifname);
282                                 res = rv;
283                                 continue;
284                         }
285                         rv = enslave(master_ifname, slave_ifname);
286                         if (rv) {
287                                 bb_perror_msg(
288                                         "master %s, slave %s: "
289                                         "can't enslave",
290                                         master_ifname, slave_ifname);
291                                 res = rv;
292                         }
293                 }
294         } while ((slave_ifname = *argv++) != NULL);
295
296         if (ENABLE_FEATURE_CLEAN_UP) {
297                 close(skfd);
298         }
299
300         return res;
301 }
302
303 static void get_drv_info(char *master_ifname)
304 {
305         struct ifreq ifr;
306         struct ethtool_drvinfo info;
307
308         memset(&ifr, 0, sizeof(ifr));
309         strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
310         ifr.ifr_data = (caddr_t)&info;
311
312         info.cmd = ETHTOOL_GDRVINFO;
313         strncpy(info.driver, "ifenslave", 32);
314         snprintf(info.fw_version, 32, "%d", BOND_ABI_VERSION);
315
316         if (ioctl(skfd, SIOCETHTOOL, &ifr) < 0) {
317                 if (errno == EOPNOTSUPP)
318                         return;
319                 bb_perror_msg_and_die("%s: SIOCETHTOOL error", master_ifname);
320         }
321
322         abi_ver = bb_strtou(info.fw_version, NULL, 0);
323         if (errno)
324                 bb_error_msg_and_die("%s: SIOCETHTOOL error", master_ifname);
325
326         return;
327 }
328
329 static void change_active(char *master_ifname, char *slave_ifname)
330 {
331         struct ifreq ifr;
332
333         if (!(slave.flags.ifr_flags & IFF_SLAVE)) {
334                 bb_error_msg_and_die(
335                         "%s is not a slave",
336                         slave_ifname);
337         }
338
339         strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
340         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
341         if (ioctl(skfd, SIOCBONDCHANGEACTIVE, &ifr) < 0
342          && ioctl(skfd, BOND_CHANGE_ACTIVE_OLD, &ifr) < 0
343         ) {
344                 bb_perror_msg_and_die(
345                         "master %s, slave %s: can't "
346                         "change active",
347                         master_ifname, slave_ifname);
348         }
349 }
350
351 static int enslave(char *master_ifname, char *slave_ifname)
352 {
353         struct ifreq ifr;
354         int res;
355
356         if (slave.flags.ifr_flags & IFF_SLAVE) {
357                 bb_error_msg(
358                         "%s is already a slave",
359                         slave_ifname);
360                 return 1;
361         }
362
363         res = set_if_down(slave_ifname, slave.flags.ifr_flags);
364         if (res)
365                 return res;
366
367         if (abi_ver < 2) {
368                 /* Older bonding versions would panic if the slave has no IP
369                  * address, so get the IP setting from the master.
370                  */
371                 res = set_if_addr(master_ifname, slave_ifname);
372                 if (res) {
373                         bb_perror_msg("%s: can't set address", slave_ifname);
374                         return res;
375                 }
376         } else {
377                 res = clear_if_addr(slave_ifname);
378                 if (res) {
379                         bb_perror_msg("%s: can't clear address", slave_ifname);
380                         return res;
381                 }
382         }
383
384         if (master.mtu.ifr_mtu != slave.mtu.ifr_mtu) {
385                 res = set_slave_mtu(slave_ifname, master.mtu.ifr_mtu);
386                 if (res) {
387                         bb_perror_msg("%s: can't set MTU", slave_ifname);
388                         return res;
389                 }
390         }
391
392         if (hwaddr_set) {
393                 /* Master already has an hwaddr
394                  * so set it's hwaddr to the slave
395                  */
396                 if (abi_ver < 1) {
397                         /* The driver is using an old ABI, so
398                          * the application sets the slave's
399                          * hwaddr
400                          */
401                         res = set_slave_hwaddr(slave_ifname,
402                                                &(master.hwaddr.ifr_hwaddr));
403                         if (res) {
404                                 bb_perror_msg("%s: can't set hw address",
405                                                 slave_ifname);
406                                 goto undo_mtu;
407                         }
408
409                         /* For old ABI the application needs to bring the
410                          * slave back up
411                          */
412                         res = set_if_up(slave_ifname, slave.flags.ifr_flags);
413                         if (res)
414                                 goto undo_slave_mac;
415                 }
416                 /* The driver is using a new ABI,
417                  * so the driver takes care of setting
418                  * the slave's hwaddr and bringing
419                  * it up again
420                  */
421         } else {
422                 /* No hwaddr for master yet, so
423                  * set the slave's hwaddr to it
424                  */
425                 if (abi_ver < 1) {
426                         /* For old ABI, the master needs to be
427                          * down before setting it's hwaddr
428                          */
429                         res = set_if_down(master_ifname, master.flags.ifr_flags);
430                         if (res)
431                                 goto undo_mtu;
432                 }
433
434                 res = set_master_hwaddr(master_ifname,
435                                         &(slave.hwaddr.ifr_hwaddr));
436                 if (res) {
437                         bb_error_msg("%s: can't set hw address",
438                                 master_ifname);
439                         goto undo_mtu;
440                 }
441
442                 if (abi_ver < 1) {
443                         /* For old ABI, bring the master
444                          * back up
445                          */
446                         res = set_if_up(master_ifname, master.flags.ifr_flags);
447                         if (res)
448                                 goto undo_master_mac;
449                 }
450
451                 hwaddr_set = 1;
452         }
453
454         /* Do the real thing */
455         strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
456         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
457         if (ioctl(skfd, SIOCBONDENSLAVE, &ifr) < 0
458          && ioctl(skfd, BOND_ENSLAVE_OLD, &ifr) < 0
459         ) {
460                 res = 1;
461         }
462
463         if (res)
464                 goto undo_master_mac;
465
466         return 0;
467
468 /* rollback (best effort) */
469  undo_master_mac:
470         set_master_hwaddr(master_ifname, &(master.hwaddr.ifr_hwaddr));
471         hwaddr_set = 0;
472         goto undo_mtu;
473  undo_slave_mac:
474         set_slave_hwaddr(slave_ifname, &(slave.hwaddr.ifr_hwaddr));
475  undo_mtu:
476         set_slave_mtu(slave_ifname, slave.mtu.ifr_mtu);
477         return res;
478 }
479
480 static int release(char *master_ifname, char *slave_ifname)
481 {
482         struct ifreq ifr;
483         int res = 0;
484
485         if (!(slave.flags.ifr_flags & IFF_SLAVE)) {
486                 bb_error_msg("%s is not a slave",
487                         slave_ifname);
488                 return 1;
489         }
490
491         strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
492         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
493         if (ioctl(skfd, SIOCBONDRELEASE, &ifr) < 0
494          && ioctl(skfd, BOND_RELEASE_OLD, &ifr) < 0
495         ) {
496                 return 1;
497         }
498         if (abi_ver < 1) {
499                 /* The driver is using an old ABI, so we'll set the interface
500                  * down to avoid any conflicts due to same MAC/IP
501                  */
502                 res = set_if_down(slave_ifname, slave.flags.ifr_flags);
503         }
504
505         /* set to default mtu */
506         set_slave_mtu(slave_ifname, 1500);
507
508         return res;
509 }
510
511 static int get_if_settings(char *ifname, struct dev_data *dd)
512 {
513         int res;
514
515         strncpy_IFNAMSIZ(dd->mtu.ifr_name, ifname);
516         res = ioctl(skfd, SIOCGIFMTU, &dd->mtu);
517         strncpy_IFNAMSIZ(dd->flags.ifr_name, ifname);
518         res |= ioctl(skfd, SIOCGIFFLAGS, &dd->flags);
519         strncpy_IFNAMSIZ(dd->hwaddr.ifr_name, ifname);
520         res |= ioctl(skfd, SIOCGIFHWADDR, &dd->hwaddr);
521
522         return res;
523 }
524
525 static int get_slave_flags(char *slave_ifname)
526 {
527         strncpy_IFNAMSIZ(slave.flags.ifr_name, slave_ifname);
528         return ioctl(skfd, SIOCGIFFLAGS, &slave.flags);
529 }
530
531 static int set_master_hwaddr(char *master_ifname, struct sockaddr *hwaddr)
532 {
533         struct ifreq ifr;
534
535         strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
536         memcpy(&(ifr.ifr_hwaddr), hwaddr, sizeof(struct sockaddr));
537         return ioctl(skfd, SIOCSIFHWADDR, &ifr);
538 }
539
540 static int set_slave_hwaddr(char *slave_ifname, struct sockaddr *hwaddr)
541 {
542         struct ifreq ifr;
543
544         strncpy_IFNAMSIZ(ifr.ifr_name, slave_ifname);
545         memcpy(&(ifr.ifr_hwaddr), hwaddr, sizeof(struct sockaddr));
546         return ioctl(skfd, SIOCSIFHWADDR, &ifr);
547 }
548
549 static int set_slave_mtu(char *slave_ifname, int mtu)
550 {
551         struct ifreq ifr;
552
553         ifr.ifr_mtu = mtu;
554         strncpy_IFNAMSIZ(ifr.ifr_name, slave_ifname);
555         return ioctl(skfd, SIOCSIFMTU, &ifr);
556 }
557
558 static int set_if_flags(char *ifname, short flags)
559 {
560         struct ifreq ifr;
561
562         ifr.ifr_flags = flags;
563         strncpy_IFNAMSIZ(ifr.ifr_name, ifname);
564         return ioctl(skfd, SIOCSIFFLAGS, &ifr);
565 }
566
567 static int set_if_up(char *ifname, short flags)
568 {
569         int res = set_if_flags(ifname, flags | IFF_UP);
570         if (res)
571                 bb_perror_msg("%s: can't up", ifname);
572         return res;
573 }
574
575 static int set_if_down(char *ifname, short flags)
576 {
577         int res = set_if_flags(ifname, flags & ~IFF_UP);
578         if (res)
579                 bb_perror_msg("%s: can't down", ifname);
580         return res;
581 }
582
583 static int clear_if_addr(char *ifname)
584 {
585         struct ifreq ifr;
586
587         strncpy_IFNAMSIZ(ifr.ifr_name, ifname);
588         ifr.ifr_addr.sa_family = AF_INET;
589         memset(ifr.ifr_addr.sa_data, 0, sizeof(ifr.ifr_addr.sa_data));
590         return ioctl(skfd, SIOCSIFADDR, &ifr);
591 }
592
593 static int set_if_addr(char *master_ifname, char *slave_ifname)
594 {
595         static const struct {
596                 int g_ioctl;
597                 int s_ioctl;
598         } ifra[] = {
599                 { SIOCGIFADDR,    SIOCSIFADDR    },
600                 { SIOCGIFDSTADDR, SIOCSIFDSTADDR },
601                 { SIOCGIFBRDADDR, SIOCSIFBRDADDR },
602                 { SIOCGIFNETMASK, SIOCSIFNETMASK },
603         };
604
605         struct ifreq ifr;
606         int res;
607         int i;
608
609         for (i = 0; i < ARRAY_SIZE(ifra); i++) {
610                 strncpy_IFNAMSIZ(ifr.ifr_name, master_ifname);
611                 res = ioctl(skfd, ifra[i].g_ioctl, &ifr);
612                 if (res < 0) {
613                         ifr.ifr_addr.sa_family = AF_INET;
614                         memset(ifr.ifr_addr.sa_data, 0,
615                                sizeof(ifr.ifr_addr.sa_data));
616                 }
617
618                 strncpy_IFNAMSIZ(ifr.ifr_name, slave_ifname);
619                 res = ioctl(skfd, ifra[i].s_ioctl, &ifr);
620                 if (res < 0)
621                         return res;
622         }
623
624         return 0;
625 }