fs/nfs/nfsroot.c

   1 /*
   2  *  $Id: nfsroot.c,v 1.45 1998/03/07 10:44:46 mj Exp $
   3  *
   4  *  Copyright (C) 1995, 1996  Gero Kuhlmann <gero@gkminix.han.de>
   5  *
   6  *  Allow an NFS filesystem to be mounted as root. The way this works is:
   7  *     (1) Use the IP autoconfig mechanism to set local IP addresses and routes.
   8  *     (2) Handle RPC negotiation with the system which replied to RARP or
   9  *         was reported as a boot server by BOOTP or manually.
  10  *     (3) The actual mounting is done later, when init() is running.
  11  *
  12  *
  13  *      Changes:
  14  *
  15  *      Alan Cox        :       Removed get_address name clash with FPU.
  16  *      Alan Cox        :       Reformatted a bit.
  17  *      Gero Kuhlmann   :       Code cleanup
  18  *      Michael Rausch  :       Fixed recognition of an incoming RARP answer.
  19  *      Martin Mares    : (2.0) Auto-configuration via BOOTP supported.
  20  *      Martin Mares    :       Manual selection of interface & BOOTP/RARP.
  21  *      Martin Mares    :       Using network routes instead of host routes,
  22  *                              allowing the default configuration to be used
  23  *                              for normal operation of the host.
  24  *      Martin Mares    :       Randomized timer with exponential backoff
  25  *                              installed to minimize network congestion.
  26  *      Martin Mares    :       Code cleanup.
  27  *      Martin Mares    : (2.1) BOOTP and RARP made configuration options.
  28  *      Martin Mares    :       Server hostname generation fixed.
  29  *      Gerd Knorr      :       Fixed wired inode handling
  30  *      Martin Mares    : (2.2) "0.0.0.0" addresses from command line ignored.
  31  *      Martin Mares    :       RARP replies not tested for server address.
  32  *      Gero Kuhlmann   : (2.3) Some bug fixes and code cleanup again (please
  33  *                              send me your new patches _before_ bothering
  34  *                              Linus so that I don' always have to cleanup
  35  *                              _afterwards_ - thanks)
  36  *      Gero Kuhlmann   :       Last changes of Martin Mares undone.
  37  *      Gero Kuhlmann   :       RARP replies are tested for specified server
  38  *                              again. However, it's now possible to have
  39  *                              different RARP and NFS servers.
  40  *      Gero Kuhlmann   :       "0.0.0.0" addresses from command line are
  41  *                              now mapped to INADDR_NONE.
  42  *      Gero Kuhlmann   :       Fixed a bug which prevented BOOTP path name
  43  *                              from being used (thanks to Leo Spiekman)
  44  *      Andy Walker     :       Allow to specify the NFS server in nfs_root
  45  *                              without giving a path name
  46  *      Swen Thümmler   :       Allow to specify the NFS options in nfs_root
  47  *                              without giving a path name. Fix BOOTP request
  48  *                              for domainname (domainname is NIS domain, not
  49  *                              DNS domain!). Skip dummy devices for BOOTP.
  50  *      Jacek Zapala    :       Fixed a bug which prevented server-ip address
  51  *                              from nfsroot parameter from being used.
  52  *      Olaf Kirch      :       Adapted to new NFS code.
  53  *      Jakub Jelinek   :       Free used code segment.
  54  *      Marko Kohtala   :       Fixed some bugs.
  55  *      Martin Mares    :       Debug message cleanup
  56  *      Martin Mares    :       Changed to use the new generic IP layer autoconfig
  57  *                              code. BOOTP and RARP moved there.
  58  *      Martin Mares    :       Default path now contains host name instead of
  59  *                              host IP address (but host name defaults to IP
  60  *                              address anyway).
  61  *      Martin Mares    :       Use root_server_addr appropriately during setup.
  62  *      Martin Mares    :       Rewrote parameter parsing, now hopefully giving
  63  *                              correct overriding.
  64  *      Trond Myklebust :       Add in preliminary support for NFSv3 and TCP.
  65  *                              Fix bug in root_nfs_addr(). nfs_data.namlen
  66  *                              is NOT for the length of the hostname.
  67  *      Hua Qin         :       Support for mounting root file system via
  68  *                              NFS over TCP.
  69  *      Fabian Frederick:       Option parser rebuilt (using parser lib)
  70 */
  71
  72 #include <linux/config.h>
  73 #include <linux/types.h>
  74 #include <linux/string.h>
  75 #include <linux/kernel.h>
  76 #include <linux/time.h>
  77 #include <linux/fs.h>
  78 #include <linux/init.h>
  79 #include <linux/sunrpc/clnt.h>
  80 #include <linux/nfs.h>
  81 #include <linux/nfs_fs.h>
  82 #include <linux/nfs_mount.h>
  83 #include <linux/in.h>
  84 #include <linux/major.h>
  85 #include <linux/utsname.h>
  86 #include <linux/inet.h>
  87 #include <linux/root_dev.h>
  88 #include <net/ipconfig.h>
  89 #include <linux/parser.h>
  90 #include <linux/vs_base.h>
  91 #include <linux/vs_cvirt.h>
  92
  93 /* Define this to allow debugging output */
  94 #undef NFSROOT_DEBUG
  95 #define NFSDBG_FACILITY NFSDBG_ROOT
  96
  97 /* Default path we try to mount. "%s" gets replaced by our IP address */
  98 #define NFS_ROOT                "/tftpboot/%s"
  99
 100 /* Parameters passed from the kernel command line */
 101 static char nfs_root_name[256] __initdata = "";
 102
 103 /* Address of NFS server */
 104 static __u32 servaddr __initdata = 0;
 105
 106 /* Name of directory to mount */
 107 static char nfs_path[NFS_MAXPATHLEN] __initdata = { 0, };
 108
 109 /* NFS-related data */
 110 static struct nfs_mount_data nfs_data __initdata = { 0, };/* NFS mount info */
 111 static int nfs_port __initdata = 0;             /* Port to connect to for NFS */
 112 static int mount_port __initdata = 0;           /* Mount daemon port number */
 113
 114
 115 /***************************************************************************
 116
 117                              Parsing of options
 118
 119  ***************************************************************************/
 120
 121 enum {
 122         /* Options that take integer arguments */
 123         Opt_port, Opt_rsize, Opt_wsize, Opt_timeo, Opt_retrans, Opt_acregmin,
 124         Opt_acregmax, Opt_acdirmin, Opt_acdirmax,
 125         /* Options that take no arguments */
 126         Opt_soft, Opt_hard, Opt_intr,
 127         Opt_nointr, Opt_posix, Opt_noposix, Opt_cto, Opt_nocto, Opt_ac,
 128         Opt_noac, Opt_lock, Opt_nolock, Opt_v2, Opt_v3, Opt_udp, Opt_tcp,
 129         Opt_acl, Opt_noacl, Opt_tagxid,
 130         /* Error token */
 131         Opt_err
 132 };
 133
 134 static match_table_t __initdata tokens = {
 135         {Opt_port, "port=%u"},
 136         {Opt_rsize, "rsize=%u"},
 137         {Opt_wsize, "wsize=%u"},
 138         {Opt_timeo, "timeo=%u"},
 139         {Opt_retrans, "retrans=%u"},
 140         {Opt_acregmin, "acregmin=%u"},
 141         {Opt_acregmax, "acregmax=%u"},
 142         {Opt_acdirmin, "acdirmin=%u"},
 143         {Opt_acdirmax, "acdirmax=%u"},
 144         {Opt_soft, "soft"},
 145         {Opt_hard, "hard"},
 146         {Opt_intr, "intr"},
 147         {Opt_nointr, "nointr"},
 148         {Opt_posix, "posix"},
 149         {Opt_noposix, "noposix"},
 150         {Opt_cto, "cto"},
 151         {Opt_nocto, "nocto"},
 152         {Opt_ac, "ac"},
 153         {Opt_noac, "noac"},
 154         {Opt_lock, "lock"},
 155         {Opt_nolock, "nolock"},
 156         {Opt_v2, "nfsvers=2"},
 157         {Opt_v2, "v2"},
 158         {Opt_v3, "nfsvers=3"},
 159         {Opt_v3, "v3"},
 160         {Opt_udp, "proto=udp"},
 161         {Opt_udp, "udp"},
 162         {Opt_tcp, "proto=tcp"},
 163         {Opt_tcp, "tcp"},
 164         {Opt_acl, "acl"},
 165         {Opt_noacl, "noacl"},
 166         {Opt_tagxid, "tagxid"},
 167         {Opt_err, NULL}
 168
 169 };
 170
 171 /*
 172  *  Parse option string.
 173  */
 174
 175 static int __init root_nfs_parse(char *name, char *buf)
 176 {
 177
 178         char *p;
 179         substring_t args[MAX_OPT_ARGS];
 180         int option;
 181
 182         if (!name)
 183                 return 1;
 184
 185         /* Set the NFS remote path */
 186         p = strsep(&name, ",");
 187         if (p[0] != '\0' && strcmp(p, "default") != 0)
 188                 strlcpy(buf, p, NFS_MAXPATHLEN);
 189
 190         while ((p = strsep (&name, ",")) != NULL) {
 191                 int token;
 192                 if (!*p)
 193                         continue;
 194                 token = match_token(p, tokens, args);
 195
 196                 /* %u tokens only. Beware if you add new tokens! */
 197                 if (token < Opt_soft && match_int(&args[0], &option))
 198                         return 0;
 199                 switch (token) {
 200                         case Opt_port:
 201                                 nfs_port = option;
 202                                 break;
 203                         case Opt_rsize:
 204                                 nfs_data.rsize = option;
 205                                 break;
 206                         case Opt_wsize:
 207                                 nfs_data.wsize = option;
 208                                 break;
 209                         case Opt_timeo:
 210                                 nfs_data.timeo = option;
 211                                 break;
 212                         case Opt_retrans:
 213                                 nfs_data.retrans = option;
 214                                 break;
 215                         case Opt_acregmin:
 216                                 nfs_data.acregmin = option;
 217                                 break;
 218                         case Opt_acregmax:
 219                                 nfs_data.acregmax = option;
 220                                 break;
 221                         case Opt_acdirmin:
 222                                 nfs_data.acdirmin = option;
 223                                 break;
 224                         case Opt_acdirmax:
 225                                 nfs_data.acdirmax = option;
 226                                 break;
 227                         case Opt_soft:
 228                                 nfs_data.flags |= NFS_MOUNT_SOFT;
 229                                 break;
 230                         case Opt_hard:
 231                                 nfs_data.flags &= ~NFS_MOUNT_SOFT;
 232                                 break;
 233                         case Opt_intr:
 234                                 nfs_data.flags |= NFS_MOUNT_INTR;
 235                                 break;
 236                         case Opt_nointr:
 237                                 nfs_data.flags &= ~NFS_MOUNT_INTR;
 238                                 break;
 239                         case Opt_posix:
 240                                 nfs_data.flags |= NFS_MOUNT_POSIX;
 241                                 break;
 242                         case Opt_noposix:
 243                                 nfs_data.flags &= ~NFS_MOUNT_POSIX;
 244                                 break;
 245                         case Opt_cto:
 246                                 nfs_data.flags &= ~NFS_MOUNT_NOCTO;
 247                                 break;
 248                         case Opt_nocto:
 249                                 nfs_data.flags |= NFS_MOUNT_NOCTO;
 250                                 break;
 251                         case Opt_ac:
 252                                 nfs_data.flags &= ~NFS_MOUNT_NOAC;
 253                                 break;
 254                         case Opt_noac:
 255                                 nfs_data.flags |= NFS_MOUNT_NOAC;
 256                                 break;
 257                         case Opt_lock:
 258                                 nfs_data.flags &= ~NFS_MOUNT_NONLM;
 259                                 break;
 260                         case Opt_nolock:
 261                                 nfs_data.flags |= NFS_MOUNT_NONLM;
 262                                 break;
 263                         case Opt_v2:
 264                                 nfs_data.flags &= ~NFS_MOUNT_VER3;
 265                                 break;
 266                         case Opt_v3:
 267                                 nfs_data.flags |= NFS_MOUNT_VER3;
 268                                 break;
 269                         case Opt_udp:
 270                                 nfs_data.flags &= ~NFS_MOUNT_TCP;
 271                                 break;
 272                         case Opt_tcp:
 273                                 nfs_data.flags |= NFS_MOUNT_TCP;
 274                                 break;
 275                         case Opt_acl:
 276                                 nfs_data.flags &= ~NFS_MOUNT_NOACL;
 277                                 break;
 278                         case Opt_noacl:
 279                                 nfs_data.flags |= NFS_MOUNT_NOACL;
 280                                 break;
 281 #ifndef CONFIG_INOXID_NONE
 282                         case Opt_tagxid:
 283                                 nfs_data.flags |= NFS_MOUNT_TAGXID;
 284                                 break;
 285 #endif
 286                         default:
 287                                 printk(KERN_WARNING "Root-NFS: unknown "
 288                                         "option: %s\n", p);
 289                                 return 0;
 290                 }
 291         }
 292
 293         return 1;
 294 }
 295
 296 /*
 297  *  Prepare the NFS data structure and parse all options.
 298  */
 299 static int __init root_nfs_name(char *name)
 300 {
 301         static char buf[NFS_MAXPATHLEN] __initdata;
 302         char *cp;
 303
 304         /* Set some default values */
 305         memset(&nfs_data, 0, sizeof(nfs_data));
 306         nfs_port          = -1;
 307         nfs_data.version  = NFS_MOUNT_VERSION;
 308         nfs_data.flags    = NFS_MOUNT_NONLM;    /* No lockd in nfs root yet */
 309         nfs_data.rsize    = NFS_DEF_FILE_IO_SIZE;
 310         nfs_data.wsize    = NFS_DEF_FILE_IO_SIZE;
 311         nfs_data.acregmin = 3;
 312         nfs_data.acregmax = 60;
 313         nfs_data.acdirmin = 30;
 314         nfs_data.acdirmax = 60;
 315         strcpy(buf, NFS_ROOT);
 316
 317         /* Process options received from the remote server */
 318         root_nfs_parse(root_server_path, buf);
 319
 320         /* Override them by options set on kernel command-line */
 321         root_nfs_parse(name, buf);
 322
 323         cp = vx_new_uts(nodename);
 324         if (strlen(buf) + strlen(cp) > NFS_MAXPATHLEN) {
 325                 printk(KERN_ERR "Root-NFS: Pathname for remote directory too long.\n");
 326                 return -1;
 327         }
 328         sprintf(nfs_path, buf, cp);
 329
 330         return 1;
 331 }
 332
 333
 334 /*
 335  *  Get NFS server address.
 336  */
 337 static int __init root_nfs_addr(void)
 338 {
 339         if ((servaddr = root_server_addr) == INADDR_NONE) {
 340                 printk(KERN_ERR "Root-NFS: No NFS server available, giving up.\n");
 341                 return -1;
 342         }
 343
 344         snprintf(nfs_data.hostname, sizeof(nfs_data.hostname),
 345                  "%u.%u.%u.%u", NIPQUAD(servaddr));
 346         return 0;
 347 }
 348
 349 /*
 350  *  Tell the user what's going on.
 351  */
 352 #ifdef NFSROOT_DEBUG
 353 static void __init root_nfs_print(void)
 354 {
 355         printk(KERN_NOTICE "Root-NFS: Mounting %s on server %s as root\n",
 356                 nfs_path, nfs_data.hostname);
 357         printk(KERN_NOTICE "Root-NFS:     rsize = %d, wsize = %d, timeo = %d, retrans = %d\n",
 358                 nfs_data.rsize, nfs_data.wsize, nfs_data.timeo, nfs_data.retrans);
 359         printk(KERN_NOTICE "Root-NFS:     acreg (min,max) = (%d,%d), acdir (min,max) = (%d,%d)\n",
 360                 nfs_data.acregmin, nfs_data.acregmax,
 361                 nfs_data.acdirmin, nfs_data.acdirmax);
 362         printk(KERN_NOTICE "Root-NFS:     nfsd port = %d, mountd port = %d, flags = %08x\n",
 363                 nfs_port, mount_port, nfs_data.flags);
 364 }
 365 #endif
 366
 367
 368 static int __init root_nfs_init(void)
 369 {
 370 #ifdef NFSROOT_DEBUG
 371         nfs_debug |= NFSDBG_ROOT;
 372 #endif
 373
 374         /*
 375          * Decode the root directory path name and NFS options from
 376          * the kernel command line. This has to go here in order to
 377          * be able to use the client IP address for the remote root
 378          * directory (necessary for pure RARP booting).
 379          */
 380         if (root_nfs_name(nfs_root_name) < 0 ||
 381             root_nfs_addr() < 0)
 382                 return -1;
 383
 384 #ifdef NFSROOT_DEBUG
 385         root_nfs_print();
 386 #endif
 387
 388         return 0;
 389 }
 390
 391
 392 /*
 393  *  Parse NFS server and directory information passed on the kernel
 394  *  command line.
 395  */
 396 static int __init nfs_root_setup(char *line)
 397 {
 398         ROOT_DEV = Root_NFS;
 399         if (line[0] == '/' || line[0] == ',' || (line[0] >= '0' && line[0] <= '9')) {
 400                 strlcpy(nfs_root_name, line, sizeof(nfs_root_name));
 401         } else {
 402                 int n = strlen(line) + sizeof(NFS_ROOT) - 1;
 403                 if (n >= sizeof(nfs_root_name))
 404                         line[sizeof(nfs_root_name) - sizeof(NFS_ROOT) - 2] = '\0';
 405                 sprintf(nfs_root_name, NFS_ROOT, line);
 406         }
 407         root_server_addr = root_nfs_parse_addr(nfs_root_name);
 408         return 1;
 409 }
 410
 411 __setup("nfsroot=", nfs_root_setup);
 412
 413 /***************************************************************************
 414
 415                Routines to actually mount the root directory
 416
 417  ***************************************************************************/
 418
 419 /*
 420  *  Construct sockaddr_in from address and port number.
 421  */
 422 static inline void
 423 set_sockaddr(struct sockaddr_in *sin, __u32 addr, __u16 port)
 424 {
 425         sin->sin_family = AF_INET;
 426         sin->sin_addr.s_addr = addr;
 427         sin->sin_port = port;
 428 }
 429
 430 /*
 431  *  Query server portmapper for the port of a daemon program.
 432  */
 433 static int __init root_nfs_getport(int program, int version, int proto)
 434 {
 435         struct sockaddr_in sin;
 436
 437         printk(KERN_NOTICE "Looking up port of RPC %d/%d on %u.%u.%u.%u\n",
 438                 program, version, NIPQUAD(servaddr));
 439         set_sockaddr(&sin, servaddr, 0);
 440         return rpc_getport_external(&sin, program, version, proto);
 441 }
 442
 443
 444 /*
 445  *  Use portmapper to find mountd and nfsd port numbers if not overriden
 446  *  by the user. Use defaults if portmapper is not available.
 447  *  XXX: Is there any nfs server with no portmapper?
 448  */
 449 static int __init root_nfs_ports(void)
 450 {
 451         int port;
 452         int nfsd_ver, mountd_ver;
 453         int nfsd_port, mountd_port;
 454         int proto;
 455
 456         if (nfs_data.flags & NFS_MOUNT_VER3) {
 457                 nfsd_ver = NFS3_VERSION;
 458                 mountd_ver = NFS_MNT3_VERSION;
 459                 nfsd_port = NFS_PORT;
 460                 mountd_port = NFS_MNT_PORT;
 461         } else {
 462                 nfsd_ver = NFS2_VERSION;
 463                 mountd_ver = NFS_MNT_VERSION;
 464                 nfsd_port = NFS_PORT;
 465                 mountd_port = NFS_MNT_PORT;
 466         }
 467
 468         proto = (nfs_data.flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
 469
 470         if (nfs_port < 0) {
 471                 if ((port = root_nfs_getport(NFS_PROGRAM, nfsd_ver, proto)) < 0) {
 472                         printk(KERN_ERR "Root-NFS: Unable to get nfsd port "
 473                                         "number from server, using default\n");
 474                         port = nfsd_port;
 475                 }
 476                 nfs_port = port;
 477                 dprintk("Root-NFS: Portmapper on server returned %d "
 478                         "as nfsd port\n", port);
 479         }
 480         nfs_port = htons(nfs_port);
 481
 482         if ((port = root_nfs_getport(NFS_MNT_PROGRAM, mountd_ver, proto)) < 0) {
 483                 printk(KERN_ERR "Root-NFS: Unable to get mountd port "
 484                                 "number from server, using default\n");
 485                 port = mountd_port;
 486         }
 487         mount_port = htons(port);
 488         dprintk("Root-NFS: mountd port is %d\n", port);
 489
 490         return 0;
 491 }
 492
 493
 494 /*
 495  *  Get a file handle from the server for the directory which is to be
 496  *  mounted.
 497  */
 498 static int __init root_nfs_get_handle(void)
 499 {
 500         struct nfs_fh fh;
 501         struct sockaddr_in sin;
 502         int status;
 503         int protocol = (nfs_data.flags & NFS_MOUNT_TCP) ?
 504                                         IPPROTO_TCP : IPPROTO_UDP;
 505         int version = (nfs_data.flags & NFS_MOUNT_VER3) ?
 506                                         NFS_MNT3_VERSION : NFS_MNT_VERSION;
 507
 508         set_sockaddr(&sin, servaddr, mount_port);
 509         status = nfsroot_mount(&sin, nfs_path, &fh, version, protocol);
 510         if (status < 0)
 511                 printk(KERN_ERR "Root-NFS: Server returned error %d "
 512                                 "while mounting %s\n", status, nfs_path);
 513         else {
 514                 nfs_data.root.size = fh.size;
 515                 memcpy(nfs_data.root.data, fh.data, fh.size);
 516         }
 517
 518         return status;
 519 }
 520
 521 /*
 522  *  Get the NFS port numbers and file handle, and return the prepared 'data'
 523  *  argument for mount() if everything went OK. Return NULL otherwise.
 524  */
 525 void * __init nfs_root_data(void)
 526 {
 527         if (root_nfs_init() < 0
 528          || root_nfs_ports() < 0
 529          || root_nfs_get_handle() < 0)
 530                 return NULL;
 531         set_sockaddr((struct sockaddr_in *) &nfs_data.addr, servaddr, nfs_port);
 532         return (void*)&nfs_data;
 533 }