4 * Allow an NFS filesystem to be mounted as root. The way this works is:
5 * (1) Use the IP autoconfig mechanism to set local IP addresses and routes.
6 * (2) Construct the device string and the options string using DHCP
7 * option 17 and/or kernel command line options.
8 * (3) When mount_root() sets up the root file system, pass these strings
9 * to the NFS client's regular mount interface via sys_mount().
14 * Alan Cox : Removed get_address name clash with FPU.
15 * Alan Cox : Reformatted a bit.
16 * Gero Kuhlmann : Code cleanup
17 * Michael Rausch : Fixed recognition of an incoming RARP answer.
18 * Martin Mares : (2.0) Auto-configuration via BOOTP supported.
19 * Martin Mares : Manual selection of interface & BOOTP/RARP.
20 * Martin Mares : Using network routes instead of host routes,
21 * allowing the default configuration to be used
22 * for normal operation of the host.
23 * Martin Mares : Randomized timer with exponential backoff
24 * installed to minimize network congestion.
25 * Martin Mares : Code cleanup.
26 * Martin Mares : (2.1) BOOTP and RARP made configuration options.
27 * Martin Mares : Server hostname generation fixed.
28 * Gerd Knorr : Fixed wired inode handling
29 * Martin Mares : (2.2) "0.0.0.0" addresses from command line ignored.
30 * Martin Mares : RARP replies not tested for server address.
31 * Gero Kuhlmann : (2.3) Some bug fixes and code cleanup again (please
32 * send me your new patches _before_ bothering
33 * Linus so that I don' always have to cleanup
34 * _afterwards_ - thanks)
35 * Gero Kuhlmann : Last changes of Martin Mares undone.
36 * Gero Kuhlmann : RARP replies are tested for specified server
37 * again. However, it's now possible to have
38 * different RARP and NFS servers.
39 * Gero Kuhlmann : "0.0.0.0" addresses from command line are
40 * now mapped to INADDR_NONE.
41 * Gero Kuhlmann : Fixed a bug which prevented BOOTP path name
42 * from being used (thanks to Leo Spiekman)
43 * Andy Walker : Allow to specify the NFS server in nfs_root
44 * without giving a path name
45 * Swen Thümmler : Allow to specify the NFS options in nfs_root
46 * without giving a path name. Fix BOOTP request
47 * for domainname (domainname is NIS domain, not
48 * DNS domain!). Skip dummy devices for BOOTP.
49 * Jacek Zapala : Fixed a bug which prevented server-ip address
50 * from nfsroot parameter from being used.
51 * Olaf Kirch : Adapted to new NFS code.
52 * Jakub Jelinek : Free used code segment.
53 * Marko Kohtala : Fixed some bugs.
54 * Martin Mares : Debug message cleanup
55 * Martin Mares : Changed to use the new generic IP layer autoconfig
56 * code. BOOTP and RARP moved there.
57 * Martin Mares : Default path now contains host name instead of
58 * host IP address (but host name defaults to IP
60 * Martin Mares : Use root_server_addr appropriately during setup.
61 * Martin Mares : Rewrote parameter parsing, now hopefully giving
63 * Trond Myklebust : Add in preliminary support for NFSv3 and TCP.
64 * Fix bug in root_nfs_addr(). nfs_data.namlen
65 * is NOT for the length of the hostname.
66 * Hua Qin : Support for mounting root file system via
68 * Fabian Frederick: Option parser rebuilt (using parser lib)
69 * Chuck Lever : Use super.c's text-based mount option parsing
72 #include <linux/types.h>
73 #include <linux/string.h>
74 #include <linux/kernel.h>
75 #include <linux/time.h>
77 #include <linux/init.h>
78 #include <linux/sunrpc/clnt.h>
79 #include <linux/sunrpc/xprtsock.h>
80 #include <linux/nfs.h>
81 #include <linux/nfs_fs.h>
82 #include <linux/nfs_mount.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>
93 /* Define this to allow debugging output */
95 #define NFSDBG_FACILITY NFSDBG_ROOT
97 /* Default port to use if server is not running a portmapper */
98 #define NFS_MNT_PORT 627
100 /* Default path we try to mount. "%s" gets replaced by our IP address */
101 #define NFS_ROOT "/tftpboot/%s"
103 /* Parameters passed from the kernel command line */
104 static char nfs_root_parms[256] __initdata = "";
106 /* Text-based mount options passed to super.c */
107 static char nfs_root_options[256] __initdata = "";
109 /* Address of NFS server */
110 static __be32 servaddr __initdata = 0;
112 /* Name of directory to mount */
113 static char nfs_export_path[NFS_MAXPATHLEN + 1] __initdata = "";
115 /* server:export path string passed to super.c */
116 static char nfs_root_device[NFS_MAXPATHLEN + 1] __initdata = "";
118 /* NFS-related data */
119 static struct nfs_mount_data nfs_data __initdata = { 0, };/* NFS mount info */
120 static int nfs_port __initdata = 0; /* Port to connect to for NFS */
121 static int mount_port __initdata = 0; /* Mount daemon port number */
124 /***************************************************************************
128 ***************************************************************************/
131 /* Options that take integer arguments */
132 Opt_port, Opt_rsize, Opt_wsize, Opt_timeo, Opt_retrans, Opt_acregmin,
133 Opt_acregmax, Opt_acdirmin, Opt_acdirmax,
134 /* Options that take no arguments */
135 Opt_soft, Opt_hard, Opt_intr,
136 Opt_nointr, Opt_posix, Opt_noposix, Opt_cto, Opt_nocto, Opt_ac,
137 Opt_noac, Opt_lock, Opt_nolock, Opt_v2, Opt_v3, Opt_udp, Opt_tcp,
143 static const match_table_t tokens __initconst = {
144 {Opt_port, "port=%u"},
145 {Opt_rsize, "rsize=%u"},
146 {Opt_wsize, "wsize=%u"},
147 {Opt_timeo, "timeo=%u"},
148 {Opt_retrans, "retrans=%u"},
149 {Opt_acregmin, "acregmin=%u"},
150 {Opt_acregmax, "acregmax=%u"},
151 {Opt_acdirmin, "acdirmin=%u"},
152 {Opt_acdirmax, "acdirmax=%u"},
156 {Opt_nointr, "nointr"},
157 {Opt_posix, "posix"},
158 {Opt_noposix, "noposix"},
160 {Opt_nocto, "nocto"},
164 {Opt_nolock, "nolock"},
165 {Opt_v2, "nfsvers=2"},
167 {Opt_v3, "nfsvers=3"},
169 {Opt_udp, "proto=udp"},
171 {Opt_tcp, "proto=tcp"},
174 {Opt_noacl, "noacl"},
180 * Parse option string.
183 static int __init root_nfs_parse(char *name, char *buf)
187 substring_t args[MAX_OPT_ARGS];
193 /* Set the NFS remote path */
194 p = strsep(&name, ",");
195 if (p[0] != '\0' && strcmp(p, "default") != 0)
196 strlcpy(buf, p, NFS_MAXPATHLEN);
198 while ((p = strsep (&name, ",")) != NULL) {
202 token = match_token(p, tokens, args);
204 /* %u tokens only. Beware if you add new tokens! */
205 if (token < Opt_soft && match_int(&args[0], &option))
212 nfs_data.rsize = option;
215 nfs_data.wsize = option;
218 nfs_data.timeo = option;
221 nfs_data.retrans = option;
224 nfs_data.acregmin = option;
227 nfs_data.acregmax = option;
230 nfs_data.acdirmin = option;
233 nfs_data.acdirmax = option;
236 nfs_data.flags |= NFS_MOUNT_SOFT;
239 nfs_data.flags &= ~NFS_MOUNT_SOFT;
245 nfs_data.flags |= NFS_MOUNT_POSIX;
248 nfs_data.flags &= ~NFS_MOUNT_POSIX;
251 nfs_data.flags &= ~NFS_MOUNT_NOCTO;
254 nfs_data.flags |= NFS_MOUNT_NOCTO;
257 nfs_data.flags &= ~NFS_MOUNT_NOAC;
260 nfs_data.flags |= NFS_MOUNT_NOAC;
263 nfs_data.flags &= ~NFS_MOUNT_NONLM;
266 nfs_data.flags |= NFS_MOUNT_NONLM;
269 nfs_data.flags &= ~NFS_MOUNT_VER3;
272 nfs_data.flags |= NFS_MOUNT_VER3;
275 nfs_data.flags &= ~NFS_MOUNT_TCP;
278 nfs_data.flags |= NFS_MOUNT_TCP;
281 nfs_data.flags &= ~NFS_MOUNT_NOACL;
284 nfs_data.flags |= NFS_MOUNT_NOACL;
287 printk(KERN_WARNING "Root-NFS: unknown "
297 * Prepare the NFS data structure and parse all options.
299 static int __init root_nfs_name(char *name)
301 static char buf[NFS_MAXPATHLEN] __initdata;
304 /* Set some default values */
305 memset(&nfs_data, 0, sizeof(nfs_data));
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 = NFS_DEF_ACREGMIN;
312 nfs_data.acregmax = NFS_DEF_ACREGMAX;
313 nfs_data.acdirmin = NFS_DEF_ACDIRMIN;
314 nfs_data.acdirmax = NFS_DEF_ACDIRMAX;
315 strcpy(buf, NFS_ROOT);
317 /* Process options received from the remote server */
318 root_nfs_parse(root_server_path, buf);
320 /* Override them by options set on kernel command-line */
321 root_nfs_parse(name, buf);
323 cp = utsname()->nodename;
324 if (strlen(buf) + strlen(cp) > NFS_MAXPATHLEN) {
325 printk(KERN_ERR "Root-NFS: Pathname for remote directory too long.\n");
328 sprintf(nfs_export_path, buf, cp);
335 * Get NFS server address.
337 static int __init root_nfs_addr(void)
339 if ((servaddr = root_server_addr) == htonl(INADDR_NONE)) {
340 printk(KERN_ERR "Root-NFS: No NFS server available, giving up.\n");
344 snprintf(nfs_data.hostname, sizeof(nfs_data.hostname),
350 * Tell the user what's going on.
353 static void __init root_nfs_print(void)
355 printk(KERN_NOTICE "Root-NFS: Mounting %s on server %s as root\n",
356 nfs_export_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);
368 static int __init root_nfs_init(void)
371 nfs_debug |= NFSDBG_ROOT;
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).
380 if (root_nfs_name(nfs_root_parms) < 0 ||
392 * Parse NFS server and directory information passed on the kernel
395 * nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
397 * If there is a "%s" token in the <root-dir> string, it is replaced
398 * by the ASCII-representation of the client's IP address.
400 static int __init nfs_root_setup(char *line)
404 if (line[0] == '/' || line[0] == ',' || (line[0] >= '0' && line[0] <= '9')) {
405 strlcpy(nfs_root_parms, line, sizeof(nfs_root_parms));
407 size_t n = strlen(line) + sizeof(NFS_ROOT) - 1;
408 if (n >= sizeof(nfs_root_parms))
409 line[sizeof(nfs_root_parms) - sizeof(NFS_ROOT) - 2] = '\0';
410 sprintf(nfs_root_parms, NFS_ROOT, line);
414 * Extract the IP address of the NFS server containing our
415 * root file system, if one was specified.
417 * Note: root_nfs_parse_addr() removes the server-ip from
418 * nfs_root_parms, if it exists.
420 root_server_addr = root_nfs_parse_addr(nfs_root_parms);
425 __setup("nfsroot=", nfs_root_setup);
427 /***************************************************************************
429 Routines to actually mount the root directory
431 ***************************************************************************/
434 * Construct sockaddr_in from address and port number.
437 set_sockaddr(struct sockaddr_in *sin, __be32 addr, __be16 port)
439 sin->sin_family = AF_INET;
440 sin->sin_addr.s_addr = addr;
441 sin->sin_port = port;
445 * Query server portmapper for the port of a daemon program.
447 static int __init root_nfs_getport(int program, int version, int proto)
449 struct sockaddr_in sin;
451 printk(KERN_NOTICE "Looking up port of RPC %d/%d on %pI4\n",
452 program, version, &servaddr);
453 set_sockaddr(&sin, servaddr, 0);
454 return rpcb_getport_sync(&sin, program, version, proto);
459 * Use portmapper to find mountd and nfsd port numbers if not overriden
460 * by the user. Use defaults if portmapper is not available.
461 * XXX: Is there any nfs server with no portmapper?
463 static int __init root_nfs_ports(void)
466 int nfsd_ver, mountd_ver;
467 int nfsd_port, mountd_port;
470 if (nfs_data.flags & NFS_MOUNT_VER3) {
471 nfsd_ver = NFS3_VERSION;
472 mountd_ver = NFS_MNT3_VERSION;
473 nfsd_port = NFS_PORT;
474 mountd_port = NFS_MNT_PORT;
476 nfsd_ver = NFS2_VERSION;
477 mountd_ver = NFS_MNT_VERSION;
478 nfsd_port = NFS_PORT;
479 mountd_port = NFS_MNT_PORT;
482 proto = (nfs_data.flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
485 if ((port = root_nfs_getport(NFS_PROGRAM, nfsd_ver, proto)) < 0) {
486 printk(KERN_ERR "Root-NFS: Unable to get nfsd port "
487 "number from server, using default\n");
491 dprintk("Root-NFS: Portmapper on server returned %d "
492 "as nfsd port\n", port);
495 if ((port = root_nfs_getport(NFS_MNT_PROGRAM, mountd_ver, proto)) < 0) {
496 printk(KERN_ERR "Root-NFS: Unable to get mountd port "
497 "number from server, using default\n");
501 dprintk("Root-NFS: mountd port is %d\n", port);
508 * Get a file handle from the server for the directory which is to be
511 static int __init root_nfs_get_handle(void)
513 struct sockaddr_in sin;
514 unsigned int auth_flav_len = 0;
515 struct nfs_mount_request request = {
516 .sap = (struct sockaddr *)&sin,
517 .salen = sizeof(sin),
518 .dirpath = nfs_export_path,
519 .version = (nfs_data.flags & NFS_MOUNT_VER3) ?
520 NFS_MNT3_VERSION : NFS_MNT_VERSION,
521 .protocol = (nfs_data.flags & NFS_MOUNT_TCP) ?
522 XPRT_TRANSPORT_TCP : XPRT_TRANSPORT_UDP,
523 .auth_flav_len = &auth_flav_len,
525 int status = -ENOMEM;
527 request.fh = nfs_alloc_fhandle();
530 set_sockaddr(&sin, servaddr, htons(mount_port));
531 status = nfs_mount(&request);
533 printk(KERN_ERR "Root-NFS: Server returned error %d "
534 "while mounting %s\n", status, nfs_export_path);
536 nfs_data.root.size = request.fh->size;
537 memcpy(&nfs_data.root.data, request.fh->data, request.fh->size);
539 nfs_free_fhandle(request.fh);
545 * Get the NFS port numbers and file handle, and return the prepared 'data'
546 * argument for mount() if everything went OK. Return NULL otherwise.
548 void * __init old_nfs_root_data(void)
550 if (root_nfs_init() < 0
551 || root_nfs_ports() < 0
552 || root_nfs_get_handle() < 0)
554 set_sockaddr((struct sockaddr_in *) &nfs_data.addr, servaddr, htons(nfs_port));
555 return (void*)&nfs_data;
558 static int __init root_nfs_copy(char *dest, const char *src,
559 const size_t destlen)
561 if (strlcpy(dest, src, destlen) > destlen)
566 static int __init root_nfs_cat(char *dest, const char *src,
567 const size_t destlen)
569 if (strlcat(dest, src, destlen) > destlen)
575 * Parse out root export path and mount options from
576 * passed-in string @incoming.
578 * Copy the export path into @exppath.
580 static int __init root_nfs_parse_options(char *incoming, char *exppath,
581 const size_t exppathlen)
586 * Set the NFS remote path
588 p = strsep(&incoming, ",");
589 if (*p != '\0' && strcmp(p, "default") != 0)
590 if (root_nfs_copy(exppath, p, exppathlen))
594 * @incoming now points to the rest of the string; if it
595 * contains something, append it to our root options buffer
597 if (incoming != NULL && *incoming != '\0')
598 if (root_nfs_cat(nfs_root_options, incoming,
599 sizeof(nfs_root_options)))
603 * Possibly prepare for more options to be appended
605 if (nfs_root_options[0] != '\0' &&
606 nfs_root_options[strlen(nfs_root_options)] != ',')
607 if (root_nfs_cat(nfs_root_options, ",",
608 sizeof(nfs_root_options)))
615 * Decode the export directory path name and NFS options from
616 * the kernel command line. This has to be done late in order to
617 * use a dynamically acquired client IP address for the remote
618 * root directory path.
620 * Returns zero if successful; otherwise -1 is returned.
622 static int __init root_nfs_data(char *cmdline)
624 char addr_option[sizeof("nolock,addr=") + INET_ADDRSTRLEN + 1];
625 int len, retval = -1;
627 const size_t tmplen = sizeof(nfs_export_path);
629 tmp = kzalloc(tmplen, GFP_KERNEL);
632 strcpy(tmp, NFS_ROOT);
634 if (root_server_path[0] != '\0') {
635 dprintk("Root-NFS: DHCPv4 option 17: %s\n",
637 if (root_nfs_parse_options(root_server_path, tmp, tmplen))
638 goto out_optionstoolong;
641 if (cmdline[0] != '\0') {
642 dprintk("Root-NFS: nfsroot=%s\n", cmdline);
643 if (root_nfs_parse_options(cmdline, tmp, tmplen))
644 goto out_optionstoolong;
648 * Append mandatory options for nfsroot so they override
649 * what has come before
651 snprintf(addr_option, sizeof(addr_option), "nolock,addr=%pI4",
653 if (root_nfs_cat(nfs_root_options, addr_option,
654 sizeof(nfs_root_options)))
655 goto out_optionstoolong;
658 * Set up nfs_root_device. For NFS mounts, this looks like
662 * At this point, utsname()->nodename contains our local
663 * IP address or hostname, set by ipconfig. If "%s" exists
664 * in tmp, substitute the nodename, then shovel the whole
665 * mess into nfs_root_device.
667 len = snprintf(nfs_export_path, sizeof(nfs_export_path),
668 tmp, utsname()->nodename);
669 if (len > (int)sizeof(nfs_export_path))
670 goto out_devnametoolong;
671 len = snprintf(nfs_root_device, sizeof(nfs_root_device),
672 "%pI4:%s", &servaddr, nfs_export_path);
673 if (len > (int)sizeof(nfs_root_device))
674 goto out_devnametoolong;
682 printk(KERN_ERR "Root-NFS: could not allocate memory\n");
685 printk(KERN_ERR "Root-NFS: mount options string too long\n");
688 printk(KERN_ERR "Root-NFS: root device name too long.\n");
693 * nfs_root_data - Return prepared 'data' for NFSROOT mount
694 * @root_device: OUT: address of string containing NFSROOT device
695 * @root_data: OUT: address of string containing NFSROOT mount options
697 * Returns zero and sets @root_device and @root_data if successful,
698 * otherwise -1 is returned.
700 int __init nfs_root_data(char **root_device, char **root_data)
703 nfs_debug |= NFSDBG_ROOT | NFSDBG_MOUNT;
704 #endif /* NFSROOT_DEBUG */
706 servaddr = root_server_addr;
707 if (servaddr == htonl(INADDR_NONE)) {
708 printk(KERN_ERR "Root-NFS: no NFS server address\n");
712 if (root_nfs_data(nfs_root_parms) < 0)
715 *root_device = nfs_root_device;
716 *root_data = nfs_root_options;