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
  91 /* Define this to allow debugging output */
  92 #undef NFSROOT_DEBUG
  93 #define NFSDBG_FACILITY NFSDBG_ROOT
  94
  95 /* Default path we try to mount. "%s" gets replaced by our IP address */
  96 #define NFS_ROOT                "/tftpboot/%s"
  97
  98 /* Parameters passed from the kernel command line */
  99 static char nfs_root_name[256] __initdata = "";
 100
 101 /* Address of NFS server */
 102 static __u32 servaddr __initdata = 0;
 103
 104 /* Name of directory to mount */
 105 static char nfs_path[NFS_MAXPATHLEN] __initdata = { 0, };
 106
 107 /* NFS-related data */
 108 static struct nfs_mount_data nfs_data __initdata = { 0, };/* NFS mount info */
 109 static int nfs_port __initdata = 0;             /* Port to connect to for NFS */
 110 static int mount_port __initdata = 0;           /* Mount daemon port number */
 111
 112
 113 /***************************************************************************
 114
 115                              Parsing of options
 116
 117  ***************************************************************************/
 118
 119 enum {
 120         /* Options that take integer arguments */
 121         Opt_port, Opt_rsize, Opt_wsize, Opt_timeo, Opt_retrans, Opt_acregmin,
 122         Opt_acregmax, Opt_acdirmin, Opt_acdirmax,
 123         /* Options that take no arguments */
 124         Opt_soft, Opt_hard, Opt_intr,
 125         Opt_nointr, Opt_posix, Opt_noposix, Opt_cto, Opt_nocto, Opt_ac,
 126         Opt_noac, Opt_lock, Opt_nolock, Opt_v2, Opt_v3, Opt_udp, Opt_tcp,
 127         Opt_broken_suid,
 128         /* Error token */
 129         Opt_err
 130 };
 131
 132 static match_table_t __initdata tokens = {
 133         {Opt_port, "port=%u"},
 134         {Opt_rsize, "rsize=%u"},
 135         {Opt_wsize, "wsize=%u"},
 136         {Opt_timeo, "timeo=%u"},
 137         {Opt_retrans, "retrans=%u"},
 138         {Opt_acregmin, "acregmin=%u"},
 139         {Opt_acregmax, "acregmax=%u"},
 140         {Opt_acdirmin, "acdirmin=%u"},
 141         {Opt_acdirmax, "acdirmax=%u"},
 142         {Opt_soft, "soft"},
 143         {Opt_hard, "hard"},
 144         {Opt_intr, "intr"},
 145         {Opt_nointr, "nointr"},
 146         {Opt_posix, "posix"},
 147         {Opt_noposix, "noposix"},
 148         {Opt_cto, "cto"},
 149         {Opt_nocto, "nocto"},
 150         {Opt_ac, "ac"},
 151         {Opt_noac, "noac"},
 152         {Opt_lock, "lock"},
 153         {Opt_nolock, "nolock"},
 154         {Opt_v2, "nfsvers=2"},
 155         {Opt_v2, "v2"},
 156         {Opt_v3, "nfsvers=3"},
 157         {Opt_v3, "v3"},
 158         {Opt_udp, "proto=udp"},
 159         {Opt_udp, "udp"},
 160         {Opt_tcp, "proto=tcp"},
 161         {Opt_tcp, "tcp"},
 162         {Opt_broken_suid, "broken_suid"},
 163         {Opt_err, NULL}
 164
 165 };
 166
 167 /*
 168  *  Parse option string.
 169  */
 170
 171 static int __init root_nfs_parse(char *name, char *buf)
 172 {
 173
 174         char *p;
 175         substring_t args[MAX_OPT_ARGS];
 176         int option;
 177
 178         if (!name)
 179                 return 1;
 180
 181         /* Set the NFS remote path */
 182         p = strsep(&name, ",");
 183         if (p[0] != '\0' && strcmp(p, "default") != 0)
 184                 strlcpy(buf, p, NFS_MAXPATHLEN);
 185
 186         while ((p = strsep (&name, ",")) != NULL) {
 187                 int token;
 188                 if (!*p)
 189                         continue;
 190                 token = match_token(p, tokens, args);
 191
 192                 /* %u tokens only. Beware if you add new tokens! */
 193                 if (token < Opt_soft && match_int(&args[0], &option))
 194                         return 0;
 195                 switch (token) {
 196                         case Opt_port:
 197                                 nfs_port = option;
 198                                 break;
 199                         case Opt_rsize:
 200                                 nfs_data.rsize = option;
 201                                 break;
 202                         case Opt_wsize:
 203                                 nfs_data.wsize = option;
 204                                 break;
 205                         case Opt_timeo:
 206                                 nfs_data.timeo = option;
 207                                 break;
 208                         case Opt_retrans:
 209                                 nfs_data.retrans = option;
 210                                 break;
 211                         case Opt_acregmin:
 212                                 nfs_data.acregmin = option;
 213                                 break;
 214                         case Opt_acregmax:
 215                                 nfs_data.acregmax = option;
 216                                 break;
 217                         case Opt_acdirmin:
 218                                 nfs_data.acdirmin = option;
 219                                 break;
 220                         case Opt_acdirmax:
 221                                 nfs_data.acdirmax = option;
 222                                 break;
 223                         case Opt_soft:
 224                                 nfs_data.flags |= NFS_MOUNT_SOFT;
 225                                 break;
 226                         case Opt_hard:
 227                                 nfs_data.flags &= ~NFS_MOUNT_SOFT;
 228                                 break;
 229                         case Opt_intr:
 230                                 nfs_data.flags |= NFS_MOUNT_INTR;
 231                                 break;
 232                         case Opt_nointr:
 233                                 nfs_data.flags &= ~NFS_MOUNT_INTR;
 234                                 break;
 235                         case Opt_posix:
 236                                 nfs_data.flags |= NFS_MOUNT_POSIX;
 237                                 break;
 238                         case Opt_noposix:
 239                                 nfs_data.flags &= ~NFS_MOUNT_POSIX;
 240                                 break;
 241                         case Opt_cto:
 242                                 nfs_data.flags &= ~NFS_MOUNT_NOCTO;
 243                                 break;
 244                         case Opt_nocto:
 245                                 nfs_data.flags |= NFS_MOUNT_NOCTO;
 246                                 break;
 247                         case Opt_ac:
 248                                 nfs_data.flags &= ~NFS_MOUNT_NOAC;
 249                                 break;
 250                         case Opt_noac:
 251                                 nfs_data.flags |= NFS_MOUNT_NOAC;
 252                                 break;
 253                         case Opt_lock:
 254                                 nfs_data.flags &= ~NFS_MOUNT_NONLM;
 255                                 break;
 256                         case Opt_nolock:
 257                                 nfs_data.flags |= NFS_MOUNT_NONLM;
 258                                 break;
 259                         case Opt_v2:
 260                                 nfs_data.flags &= ~NFS_MOUNT_VER3;
 261                                 break;
 262                         case Opt_v3:
 263                                 nfs_data.flags |= NFS_MOUNT_VER3;
 264                                 break;
 265                         case Opt_udp:
 266                                 nfs_data.flags &= ~NFS_MOUNT_TCP;
 267                                 break;
 268                         case Opt_tcp:
 269                                 nfs_data.flags |= NFS_MOUNT_TCP;
 270                                 break;
 271                         case Opt_broken_suid:
 272                                 nfs_data.flags |= NFS_MOUNT_BROKEN_SUID;
 273                                 break;
 274                         default :
 275                                 return 0;
 276                 }
 277         }
 278
 279         return 1;
 280 }
 281
 282 /*
 283  *  Prepare the NFS data structure and parse all options.
 284  */
 285 static int __init root_nfs_name(char *name)
 286 {
 287         static char buf[NFS_MAXPATHLEN] __initdata;
 288         char *cp;
 289
 290         /* Set some default values */
 291         memset(&nfs_data, 0, sizeof(nfs_data));
 292         nfs_port          = -1;
 293         nfs_data.version  = NFS_MOUNT_VERSION;
 294         nfs_data.flags    = NFS_MOUNT_NONLM;    /* No lockd in nfs root yet */
 295         nfs_data.rsize    = NFS_DEF_FILE_IO_BUFFER_SIZE;
 296         nfs_data.wsize    = NFS_DEF_FILE_IO_BUFFER_SIZE;
 297         nfs_data.acregmin = 3;
 298         nfs_data.acregmax = 60;
 299         nfs_data.acdirmin = 30;
 300         nfs_data.acdirmax = 60;
 301         strcpy(buf, NFS_ROOT);
 302
 303         /* Process options received from the remote server */
 304         root_nfs_parse(root_server_path, buf);
 305
 306         /* Override them by options set on kernel command-line */
 307         root_nfs_parse(name, buf);
 308
 309         cp = vx_new_uts(nodename);
 310         if (strlen(buf) + strlen(cp) > NFS_MAXPATHLEN) {
 311                 printk(KERN_ERR "Root-NFS: Pathname for remote directory too long.\n");
 312                 return -1;
 313         }
 314         sprintf(nfs_path, buf, cp);
 315
 316         return 1;
 317 }
 318
 319
 320 /*
 321  *  Get NFS server address.
 322  */
 323 static int __init root_nfs_addr(void)
 324 {
 325         if ((servaddr = root_server_addr) == INADDR_NONE) {
 326                 printk(KERN_ERR "Root-NFS: No NFS server available, giving up.\n");
 327                 return -1;
 328         }
 329
 330         snprintf(nfs_data.hostname, sizeof(nfs_data.hostname),
 331                  "%u.%u.%u.%u", NIPQUAD(servaddr));
 332         return 0;
 333 }
 334
 335 /*
 336  *  Tell the user what's going on.
 337  */
 338 #ifdef NFSROOT_DEBUG
 339 static void __init root_nfs_print(void)
 340 {
 341         printk(KERN_NOTICE "Root-NFS: Mounting %s on server %s as root\n",
 342                 nfs_path, nfs_data.hostname);
 343         printk(KERN_NOTICE "Root-NFS:     rsize = %d, wsize = %d, timeo = %d, retrans = %d\n",
 344                 nfs_data.rsize, nfs_data.wsize, nfs_data.timeo, nfs_data.retrans);
 345         printk(KERN_NOTICE "Root-NFS:     acreg (min,max) = (%d,%d), acdir (min,max) = (%d,%d)\n",
 346                 nfs_data.acregmin, nfs_data.acregmax,
 347                 nfs_data.acdirmin, nfs_data.acdirmax);
 348         printk(KERN_NOTICE "Root-NFS:     nfsd port = %d, mountd port = %d, flags = %08x\n",
 349                 nfs_port, mount_port, nfs_data.flags);
 350 }
 351 #endif
 352
 353
 354 int __init root_nfs_init(void)
 355 {
 356 #ifdef NFSROOT_DEBUG
 357         nfs_debug |= NFSDBG_ROOT;
 358 #endif
 359
 360         /*
 361          * Decode the root directory path name and NFS options from
 362          * the kernel command line. This has to go here in order to
 363          * be able to use the client IP address for the remote root
 364          * directory (necessary for pure RARP booting).
 365          */
 366         if (root_nfs_name(nfs_root_name) < 0 ||
 367             root_nfs_addr() < 0)
 368                 return -1;
 369
 370 #ifdef NFSROOT_DEBUG
 371         root_nfs_print();
 372 #endif
 373
 374         return 0;
 375 }
 376
 377
 378 /*
 379  *  Parse NFS server and directory information passed on the kernel
 380  *  command line.
 381  */
 382 int __init nfs_root_setup(char *line)
 383 {
 384         ROOT_DEV = Root_NFS;
 385         if (line[0] == '/' || line[0] == ',' || (line[0] >= '0' && line[0] <= '9')) {
 386                 strlcpy(nfs_root_name, line, sizeof(nfs_root_name));
 387         } else {
 388                 int n = strlen(line) + strlen(NFS_ROOT);
 389                 if (n >= sizeof(nfs_root_name))
 390                         line[sizeof(nfs_root_name) - strlen(NFS_ROOT) - 1] = '\0';
 391                 sprintf(nfs_root_name, NFS_ROOT, line);
 392         }
 393         root_server_addr = root_nfs_parse_addr(nfs_root_name);
 394         return 1;
 395 }
 396
 397 __setup("nfsroot=", nfs_root_setup);
 398
 399 /***************************************************************************
 400
 401                Routines to actually mount the root directory
 402
 403  ***************************************************************************/
 404
 405 /*
 406  *  Construct sockaddr_in from address and port number.
 407  */
 408 static inline void
 409 set_sockaddr(struct sockaddr_in *sin, __u32 addr, __u16 port)
 410 {
 411         sin->sin_family = AF_INET;
 412         sin->sin_addr.s_addr = addr;
 413         sin->sin_port = port;
 414 }
 415
 416 /*
 417  *  Query server portmapper for the port of a daemon program.
 418  */
 419 static int __init root_nfs_getport(int program, int version, int proto)
 420 {
 421         struct sockaddr_in sin;
 422
 423         printk(KERN_NOTICE "Looking up port of RPC %d/%d on %u.%u.%u.%u\n",
 424                 program, version, NIPQUAD(servaddr));
 425         set_sockaddr(&sin, servaddr, 0);
 426         return rpc_getport_external(&sin, program, version, proto);
 427 }
 428
 429
 430 /*
 431  *  Use portmapper to find mountd and nfsd port numbers if not overriden
 432  *  by the user. Use defaults if portmapper is not available.
 433  *  XXX: Is there any nfs server with no portmapper?
 434  */
 435 static int __init root_nfs_ports(void)
 436 {
 437         int port;
 438         int nfsd_ver, mountd_ver;
 439         int nfsd_port, mountd_port;
 440         int proto;
 441
 442         if (nfs_data.flags & NFS_MOUNT_VER3) {
 443                 nfsd_ver = NFS3_VERSION;
 444                 mountd_ver = NFS_MNT3_VERSION;
 445                 nfsd_port = NFS_PORT;
 446                 mountd_port = NFS_MNT_PORT;
 447         } else {
 448                 nfsd_ver = NFS2_VERSION;
 449                 mountd_ver = NFS_MNT_VERSION;
 450                 nfsd_port = NFS_PORT;
 451                 mountd_port = NFS_MNT_PORT;
 452         }
 453
 454         proto = (nfs_data.flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
 455
 456         if (nfs_port < 0) {
 457                 if ((port = root_nfs_getport(NFS_PROGRAM, nfsd_ver, proto)) < 0) {
 458                         printk(KERN_ERR "Root-NFS: Unable to get nfsd port "
 459                                         "number from server, using default\n");
 460                         port = nfsd_port;
 461                 }
 462                 nfs_port = htons(port);
 463                 dprintk("Root-NFS: Portmapper on server returned %d "
 464                         "as nfsd port\n", port);
 465         }
 466
 467         if ((port = root_nfs_getport(NFS_MNT_PROGRAM, mountd_ver, proto)) < 0) {
 468                 printk(KERN_ERR "Root-NFS: Unable to get mountd port "
 469                                 "number from server, using default\n");
 470                 port = mountd_port;
 471         }
 472         mount_port = htons(port);
 473         dprintk("Root-NFS: mountd port is %d\n", port);
 474
 475         return 0;
 476 }
 477
 478
 479 /*
 480  *  Get a file handle from the server for the directory which is to be
 481  *  mounted.
 482  */
 483 static int __init root_nfs_get_handle(void)
 484 {
 485         struct nfs_fh fh;
 486         struct sockaddr_in sin;
 487         int status;
 488         int protocol = (nfs_data.flags & NFS_MOUNT_TCP) ?
 489                                         IPPROTO_TCP : IPPROTO_UDP;
 490         int version = (nfs_data.flags & NFS_MOUNT_VER3) ?
 491                                         NFS_MNT3_VERSION : NFS_MNT_VERSION;
 492
 493         set_sockaddr(&sin, servaddr, mount_port);
 494         status = nfsroot_mount(&sin, nfs_path, &fh, version, protocol);
 495         if (status < 0)
 496                 printk(KERN_ERR "Root-NFS: Server returned error %d "
 497                                 "while mounting %s\n", status, nfs_path);
 498         else {
 499                 nfs_data.root.size = fh.size;
 500                 memcpy(nfs_data.root.data, fh.data, fh.size);
 501         }
 502
 503         return status;
 504 }
 505
 506 /*
 507  *  Get the NFS port numbers and file handle, and return the prepared 'data'
 508  *  argument for mount() if everything went OK. Return NULL otherwise.
 509  */
 510 void * __init nfs_root_data(void)
 511 {
 512         if (root_nfs_init() < 0
 513          || root_nfs_ports() < 0
 514          || root_nfs_get_handle() < 0)
 515                 return NULL;
 516         set_sockaddr((struct sockaddr_in *) &nfs_data.addr, servaddr, nfs_port);
 517         return (void*)&nfs_data;
 518 }