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 /* NOINLINEs are placed where it results in smaller code (gcc 4.3.1) */
 137
 138 static void strncpy_IFNAMSIZ(char *dst, const char *src)
 139 {
 140         strncpy(dst, src, IFNAMSIZ);
 141 }
 142
 143 static int ioctl_on_skfd(unsigned request, struct ifreq *ifr)
 144 {
 145         return ioctl(skfd, request, ifr);
 146 }
 147
 148 static int set_ifrname_and_do_ioctl(unsigned request, struct ifreq *ifr, const char *ifname)
 149 {
 150         strncpy_IFNAMSIZ(ifr->ifr_name, ifname);
 151         return ioctl_on_skfd(request, ifr);
 152 }
 153
 154 static int get_if_settings(char *ifname, struct dev_data *dd)
 155 {
 156         int res;
 157
 158         res = set_ifrname_and_do_ioctl(SIOCGIFMTU, &dd->mtu, ifname);
 159         res |= set_ifrname_and_do_ioctl(SIOCGIFFLAGS, &dd->flags, ifname);
 160         res |= set_ifrname_and_do_ioctl(SIOCGIFHWADDR, &dd->hwaddr, ifname);
 161
 162         return res;
 163 }
 164
 165 static int get_slave_flags(char *slave_ifname)
 166 {
 167         return set_ifrname_and_do_ioctl(SIOCGIFFLAGS, &slave.flags, slave_ifname);
 168 }
 169
 170 static int set_hwaddr(char *ifname, struct sockaddr *hwaddr)
 171 {
 172         struct ifreq ifr;
 173
 174         memcpy(&(ifr.ifr_hwaddr), hwaddr, sizeof(*hwaddr));
 175         return set_ifrname_and_do_ioctl(SIOCSIFHWADDR, &ifr, ifname);
 176 }
 177
 178 static int set_mtu(char *ifname, int mtu)
 179 {
 180         struct ifreq ifr;
 181
 182         ifr.ifr_mtu = mtu;
 183         return set_ifrname_and_do_ioctl(SIOCSIFMTU, &ifr, ifname);
 184 }
 185
 186 static int set_if_flags(char *ifname, int flags)
 187 {
 188         struct ifreq ifr;
 189
 190         ifr.ifr_flags = flags;
 191         return set_ifrname_and_do_ioctl(SIOCSIFFLAGS, &ifr, ifname);
 192 }
 193
 194 static int set_if_up(char *ifname, int flags)
 195 {
 196         int res = set_if_flags(ifname, flags | IFF_UP);
 197         if (res)
 198                 bb_perror_msg("%s: can't up", ifname);
 199         return res;
 200 }
 201
 202 static int set_if_down(char *ifname, int flags)
 203 {
 204         int res = set_if_flags(ifname, flags & ~IFF_UP);
 205         if (res)
 206                 bb_perror_msg("%s: can't down", ifname);
 207         return res;
 208 }
 209
 210 static int clear_if_addr(char *ifname)
 211 {
 212         struct ifreq ifr;
 213
 214         ifr.ifr_addr.sa_family = AF_INET;
 215         memset(ifr.ifr_addr.sa_data, 0, sizeof(ifr.ifr_addr.sa_data));
 216         return set_ifrname_and_do_ioctl(SIOCSIFADDR, &ifr, ifname);
 217 }
 218
 219 static int set_if_addr(char *master_ifname, char *slave_ifname)
 220 {
 221 #if (SIOCGIFADDR | SIOCSIFADDR \
 222   | SIOCGIFDSTADDR | SIOCSIFDSTADDR \
 223   | SIOCGIFBRDADDR | SIOCSIFBRDADDR \
 224   | SIOCGIFNETMASK | SIOCSIFNETMASK) <= 0xffff
 225 #define INT uint16_t
 226 #else
 227 #define INT int
 228 #endif
 229         static const struct {
 230                 INT g_ioctl;
 231                 INT s_ioctl;
 232         } ifra[] = {
 233                 { SIOCGIFADDR,    SIOCSIFADDR    },
 234                 { SIOCGIFDSTADDR, SIOCSIFDSTADDR },
 235                 { SIOCGIFBRDADDR, SIOCSIFBRDADDR },
 236                 { SIOCGIFNETMASK, SIOCSIFNETMASK },
 237         };
 238
 239         struct ifreq ifr;
 240         int res;
 241         unsigned i;
 242
 243         for (i = 0; i < ARRAY_SIZE(ifra); i++) {
 244                 res = set_ifrname_and_do_ioctl(ifra[i].g_ioctl, &ifr, master_ifname);
 245                 if (res < 0) {
 246                         ifr.ifr_addr.sa_family = AF_INET;
 247                         memset(ifr.ifr_addr.sa_data, 0,
 248                                sizeof(ifr.ifr_addr.sa_data));
 249                 }
 250
 251                 res = set_ifrname_and_do_ioctl(ifra[i].s_ioctl, &ifr, slave_ifname);
 252                 if (res < 0)
 253                         return res;
 254         }
 255
 256         return 0;
 257 }
 258
 259 static void change_active(char *master_ifname, char *slave_ifname)
 260 {
 261         struct ifreq ifr;
 262
 263         if (!(slave.flags.ifr_flags & IFF_SLAVE)) {
 264                 bb_error_msg_and_die(
 265                         "%s is not a slave",
 266                         slave_ifname);
 267         }
 268
 269         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
 270         if (set_ifrname_and_do_ioctl(SIOCBONDCHANGEACTIVE, &ifr, master_ifname)
 271          && ioctl_on_skfd(BOND_CHANGE_ACTIVE_OLD, &ifr)
 272         ) {
 273                 bb_perror_msg_and_die(
 274                         "master %s, slave %s: can't "
 275                         "change active",
 276                         master_ifname, slave_ifname);
 277         }
 278 }
 279
 280 static NOINLINE int enslave(char *master_ifname, char *slave_ifname)
 281 {
 282         struct ifreq ifr;
 283         int res;
 284
 285         if (slave.flags.ifr_flags & IFF_SLAVE) {
 286                 bb_error_msg(
 287                         "%s is already a slave",
 288                         slave_ifname);
 289                 return 1;
 290         }
 291
 292         res = set_if_down(slave_ifname, slave.flags.ifr_flags);
 293         if (res)
 294                 return res;
 295
 296         if (abi_ver < 2) {
 297                 /* Older bonding versions would panic if the slave has no IP
 298                  * address, so get the IP setting from the master.
 299                  */
 300                 res = set_if_addr(master_ifname, slave_ifname);
 301                 if (res) {
 302                         bb_perror_msg("%s: can't set address", slave_ifname);
 303                         return res;
 304                 }
 305         } else {
 306                 res = clear_if_addr(slave_ifname);
 307                 if (res) {
 308                         bb_perror_msg("%s: can't clear address", slave_ifname);
 309                         return res;
 310                 }
 311         }
 312
 313         if (master.mtu.ifr_mtu != slave.mtu.ifr_mtu) {
 314                 res = set_mtu(slave_ifname, master.mtu.ifr_mtu);
 315                 if (res) {
 316                         bb_perror_msg("%s: can't set MTU", slave_ifname);
 317                         return res;
 318                 }
 319         }
 320
 321         if (hwaddr_set) {
 322                 /* Master already has an hwaddr
 323                  * so set it's hwaddr to the slave
 324                  */
 325                 if (abi_ver < 1) {
 326                         /* The driver is using an old ABI, so
 327                          * the application sets the slave's
 328                          * hwaddr
 329                          */
 330                         if (set_hwaddr(slave_ifname, &(master.hwaddr.ifr_hwaddr))) {
 331                                 bb_perror_msg("%s: can't set hw address",
 332                                                 slave_ifname);
 333                                 goto undo_mtu;
 334                         }
 335
 336                         /* For old ABI the application needs to bring the
 337                          * slave back up
 338                          */
 339                         if (set_if_up(slave_ifname, slave.flags.ifr_flags))
 340                                 goto undo_slave_mac;
 341                 }
 342                 /* The driver is using a new ABI,
 343                  * so the driver takes care of setting
 344                  * the slave's hwaddr and bringing
 345                  * it up again
 346                  */
 347         } else {
 348                 /* No hwaddr for master yet, so
 349                  * set the slave's hwaddr to it
 350                  */
 351                 if (abi_ver < 1) {
 352                         /* For old ABI, the master needs to be
 353                          * down before setting it's hwaddr
 354                          */
 355                         if (set_if_down(master_ifname, master.flags.ifr_flags))
 356                                 goto undo_mtu;
 357                 }
 358
 359                 if (set_hwaddr(master_ifname, &(slave.hwaddr.ifr_hwaddr))) {
 360                         bb_error_msg("%s: can't set hw address",
 361                                 master_ifname);
 362                         goto undo_mtu;
 363                 }
 364
 365                 if (abi_ver < 1) {
 366                         /* For old ABI, bring the master
 367                          * back up
 368                          */
 369                         if (set_if_up(master_ifname, master.flags.ifr_flags))
 370                                 goto undo_master_mac;
 371                 }
 372
 373                 hwaddr_set = 1;
 374         }
 375
 376         /* Do the real thing */
 377         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
 378         if (set_ifrname_and_do_ioctl(SIOCBONDENSLAVE, &ifr, master_ifname)
 379          && ioctl_on_skfd(BOND_ENSLAVE_OLD, &ifr)
 380         ) {
 381                 goto undo_master_mac;
 382         }
 383
 384         return 0;
 385
 386 /* rollback (best effort) */
 387  undo_master_mac:
 388         set_hwaddr(master_ifname, &(master.hwaddr.ifr_hwaddr));
 389         hwaddr_set = 0;
 390         goto undo_mtu;
 391
 392  undo_slave_mac:
 393         set_hwaddr(slave_ifname, &(slave.hwaddr.ifr_hwaddr));
 394  undo_mtu:
 395         set_mtu(slave_ifname, slave.mtu.ifr_mtu);
 396         return 1;
 397 }
 398
 399 static int release(char *master_ifname, char *slave_ifname)
 400 {
 401         struct ifreq ifr;
 402         int res = 0;
 403
 404         if (!(slave.flags.ifr_flags & IFF_SLAVE)) {
 405                 bb_error_msg("%s is not a slave",
 406                         slave_ifname);
 407                 return 1;
 408         }
 409
 410         strncpy_IFNAMSIZ(ifr.ifr_slave, slave_ifname);
 411         if (set_ifrname_and_do_ioctl(SIOCBONDRELEASE, &ifr, master_ifname) < 0
 412          && ioctl_on_skfd(BOND_RELEASE_OLD, &ifr) < 0
 413         ) {
 414                 return 1;
 415         }
 416         if (abi_ver < 1) {
 417                 /* The driver is using an old ABI, so we'll set the interface
 418                  * down to avoid any conflicts due to same MAC/IP
 419                  */
 420                 res = set_if_down(slave_ifname, slave.flags.ifr_flags);
 421         }
 422
 423         /* set to default mtu */
 424         set_mtu(slave_ifname, 1500);
 425
 426         return res;
 427 }
 428
 429 static NOINLINE void get_drv_info(char *master_ifname)
 430 {
 431         struct ifreq ifr;
 432         struct ethtool_drvinfo info;
 433
 434         memset(&ifr, 0, sizeof(ifr));
 435         ifr.ifr_data = (caddr_t)&info;
 436         info.cmd = ETHTOOL_GDRVINFO;
 437         /* both fields are 32 bytes long (long enough) */
 438         strcpy(info.driver, "ifenslave");
 439         strcpy(info.fw_version, utoa(BOND_ABI_VERSION));
 440         if (set_ifrname_and_do_ioctl(SIOCETHTOOL, &ifr, master_ifname) < 0) {
 441                 if (errno == EOPNOTSUPP)
 442                         return;
 443                 bb_perror_msg_and_die("%s: SIOCETHTOOL error", master_ifname);
 444         }
 445
 446         abi_ver = bb_strtou(info.fw_version, NULL, 0);
 447         if (errno)
 448                 bb_error_msg_and_die("%s: SIOCETHTOOL error", master_ifname);
 449 }
 450
 451 int ifenslave_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 452 int ifenslave_main(int argc ATTRIBUTE_UNUSED, char **argv)
 453 {
 454         char *master_ifname, *slave_ifname;
 455         int rv;
 456         int res;
 457         unsigned opt;
 458         enum {
 459                 OPT_c = (1 << 0),
 460                 OPT_d = (1 << 1),
 461                 OPT_f = (1 << 2),
 462         };
 463 #if ENABLE_GETOPT_LONG
 464         static const char ifenslave_longopts[] ALIGN1 =
 465                 "change-active\0" No_argument "c"
 466                 "detach\0"        No_argument "d"
 467                 "force\0"         No_argument "f"
 468                 ;
 469
 470         applet_long_options = ifenslave_longopts;
 471 #endif
 472         INIT_G();
 473
 474         opt = getopt32(argv, "cdf");
 475         argv += optind;
 476         if (opt & (opt-1)) /* options check */
 477                 bb_show_usage();
 478
 479         master_ifname = *argv++;
 480
 481         /* No interface names - show all interfaces. */
 482         if (!master_ifname) {
 483                 display_interfaces(NULL);
 484                 return EXIT_SUCCESS;
 485         }
 486
 487         /* Open a basic socket */
 488         xmove_fd(xsocket(AF_INET, SOCK_DGRAM, 0), skfd);
 489
 490         /* Exchange abi version with bonding module */
 491         get_drv_info(master_ifname);
 492
 493         slave_ifname = *argv++;
 494         if (!slave_ifname) {
 495                 if (opt & (OPT_d|OPT_c)) {
 496                         /* --change or --detach, and no slaves given -
 497                          * show all interfaces. */
 498                         display_interfaces(slave_ifname /* == NULL */);
 499                         return 2; /* why 2? */
 500                 }
 501                 /* A single arg means show the
 502                  * configuration for this interface
 503                  */
 504                 display_interfaces(master_ifname);
 505                 return EXIT_SUCCESS;
 506         }
 507
 508         res = get_if_settings(master_ifname, &master);
 509         if (res) {
 510                 /* Probably a good reason not to go on */
 511                 bb_perror_msg_and_die("%s: can't get settings", master_ifname);
 512         }
 513
 514         /* check if master is indeed a master;
 515          * if not then fail any operation
 516          */
 517         if (!(master.flags.ifr_flags & IFF_MASTER))
 518                 bb_error_msg_and_die("%s is not a master", master_ifname);
 519
 520         /* check if master is up; if not then fail any operation */
 521         if (!(master.flags.ifr_flags & IFF_UP))
 522                 bb_error_msg_and_die("%s is not up", master_ifname);
 523
 524         /* No opts: neither -c[hange] nor -d[etach] -> it's "enslave" then;
 525          * and -f[orce] is not there too */
 526         if (!opt) {
 527                 /* The family '1' is ARPHRD_ETHER for ethernet. */
 528                 if (master.hwaddr.ifr_hwaddr.sa_family != 1) {
 529                         bb_error_msg_and_die(
 530                                 "%s is not ethernet-like (-f overrides)",
 531                                 master_ifname);
 532                 }
 533         }
 534
 535         /* Accepts only one slave */
 536         if (opt & OPT_c) {
 537                 /* change active slave */
 538                 if (get_slave_flags(slave_ifname)) {
 539                         bb_perror_msg_and_die(
 540                                 "%s: can't get flags", slave_ifname);
 541                 }
 542                 change_active(master_ifname, slave_ifname);
 543                 return EXIT_SUCCESS;
 544         }
 545
 546         /* Accept multiple slaves */
 547         res = 0;
 548         do {
 549                 if (opt & OPT_d) {
 550                         /* detach a slave interface from the master */
 551                         rv = get_slave_flags(slave_ifname);
 552                         if (rv) {
 553                                 /* Can't work with this slave, */
 554                                 /* remember the error and skip it */
 555                                 bb_perror_msg(
 556                                         "skipping %s: can't get flags",
 557                                         slave_ifname);
 558                                 res = rv;
 559                                 continue;
 560                         }
 561                         rv = release(master_ifname, slave_ifname);
 562                         if (rv) {
 563                                 bb_perror_msg(
 564                                         "master %s, slave %s: "
 565                                         "can't release",
 566                                         master_ifname, slave_ifname);
 567                                 res = rv;
 568                         }
 569                 } else {
 570                         /* attach a slave interface to the master */
 571                         rv = get_if_settings(slave_ifname, &slave);
 572                         if (rv) {
 573                                 /* Can't work with this slave, */
 574                                 /* remember the error and skip it */
 575                                 bb_perror_msg(
 576                                         "skipping %s: can't get settings",
 577                                         slave_ifname);
 578                                 res = rv;
 579                                 continue;
 580                         }
 581                         rv = enslave(master_ifname, slave_ifname);
 582                         if (rv) {
 583                                 bb_perror_msg(
 584                                         "master %s, slave %s: "
 585                                         "can't enslave",
 586                                         master_ifname, slave_ifname);
 587                                 res = rv;
 588                         }
 589                 }
 590         } while ((slave_ifname = *argv++) != NULL);
 591
 592         if (ENABLE_FEATURE_CLEAN_UP) {
 593                 close(skfd);
 594         }
 595
 596         return res;
 597 }