2 * $Id: nfsroot.c,v 1.45 1998/03/07 10:44:46 mj Exp $
4 * Copyright (C) 1995, 1996 Gero Kuhlmann <gero@gkminix.han.de>
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.
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
61 * Martin Mares : Use root_server_addr appropriately during setup.
62 * Martin Mares : Rewrote parameter parsing, now hopefully giving
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
69 * Fabian Frederick: Option parser rebuilt (using parser lib)
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/nfs.h>
80 #include <linux/nfs_fs.h>
81 #include <linux/nfs_mount.h>
83 #include <linux/major.h>
84 #include <linux/utsname.h>
85 #include <linux/inet.h>
86 #include <linux/root_dev.h>
87 #include <net/ipconfig.h>
88 #include <linux/parser.h>
89 #include <linux/vs_cvirt.h>
91 /* Define this to allow debugging output */
93 #define NFSDBG_FACILITY NFSDBG_ROOT
95 /* Default path we try to mount. "%s" gets replaced by our IP address */
96 #define NFS_ROOT "/tftpboot/%s"
98 /* Parameters passed from the kernel command line */
99 static char nfs_root_name[256] __initdata = "";
101 /* Address of NFS server */
102 static __u32 servaddr __initdata = 0;
104 /* Name of directory to mount */
105 static char nfs_path[NFS_MAXPATHLEN] __initdata = { 0, };
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 */
113 /***************************************************************************
117 ***************************************************************************/
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_acl, Opt_noacl, Opt_tagxid,
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"},
145 {Opt_nointr, "nointr"},
146 {Opt_posix, "posix"},
147 {Opt_noposix, "noposix"},
149 {Opt_nocto, "nocto"},
153 {Opt_nolock, "nolock"},
154 {Opt_v2, "nfsvers=2"},
156 {Opt_v3, "nfsvers=3"},
158 {Opt_udp, "proto=udp"},
160 {Opt_tcp, "proto=tcp"},
163 {Opt_noacl, "noacl"},
164 {Opt_tagxid, "tagxid"},
170 * Parse option string.
173 static int __init root_nfs_parse(char *name, char *buf)
177 substring_t args[MAX_OPT_ARGS];
183 /* Set the NFS remote path */
184 p = strsep(&name, ",");
185 if (p[0] != '\0' && strcmp(p, "default") != 0)
186 strlcpy(buf, p, NFS_MAXPATHLEN);
188 while ((p = strsep (&name, ",")) != NULL) {
192 token = match_token(p, tokens, args);
194 /* %u tokens only. Beware if you add new tokens! */
195 if (token < Opt_soft && match_int(&args[0], &option))
202 nfs_data.rsize = option;
205 nfs_data.wsize = option;
208 nfs_data.timeo = option;
211 nfs_data.retrans = option;
214 nfs_data.acregmin = option;
217 nfs_data.acregmax = option;
220 nfs_data.acdirmin = option;
223 nfs_data.acdirmax = option;
226 nfs_data.flags |= NFS_MOUNT_SOFT;
229 nfs_data.flags &= ~NFS_MOUNT_SOFT;
232 nfs_data.flags |= NFS_MOUNT_INTR;
235 nfs_data.flags &= ~NFS_MOUNT_INTR;
238 nfs_data.flags |= NFS_MOUNT_POSIX;
241 nfs_data.flags &= ~NFS_MOUNT_POSIX;
244 nfs_data.flags &= ~NFS_MOUNT_NOCTO;
247 nfs_data.flags |= NFS_MOUNT_NOCTO;
250 nfs_data.flags &= ~NFS_MOUNT_NOAC;
253 nfs_data.flags |= NFS_MOUNT_NOAC;
256 nfs_data.flags &= ~NFS_MOUNT_NONLM;
259 nfs_data.flags |= NFS_MOUNT_NONLM;
262 nfs_data.flags &= ~NFS_MOUNT_VER3;
265 nfs_data.flags |= NFS_MOUNT_VER3;
268 nfs_data.flags &= ~NFS_MOUNT_TCP;
271 nfs_data.flags |= NFS_MOUNT_TCP;
274 nfs_data.flags &= ~NFS_MOUNT_NOACL;
277 nfs_data.flags |= NFS_MOUNT_NOACL;
279 #ifndef CONFIG_INOXID_NONE
281 nfs_data.flags |= NFS_MOUNT_TAGXID;
285 printk(KERN_WARNING "Root-NFS: unknown "
295 * Prepare the NFS data structure and parse all options.
297 static int __init root_nfs_name(char *name)
299 static char buf[NFS_MAXPATHLEN] __initdata;
302 /* Set some default values */
303 memset(&nfs_data, 0, sizeof(nfs_data));
305 nfs_data.version = NFS_MOUNT_VERSION;
306 nfs_data.flags = NFS_MOUNT_NONLM; /* No lockd in nfs root yet */
307 nfs_data.rsize = NFS_DEF_FILE_IO_SIZE;
308 nfs_data.wsize = NFS_DEF_FILE_IO_SIZE;
309 nfs_data.acregmin = 3;
310 nfs_data.acregmax = 60;
311 nfs_data.acdirmin = 30;
312 nfs_data.acdirmax = 60;
313 strcpy(buf, NFS_ROOT);
315 /* Process options received from the remote server */
316 root_nfs_parse(root_server_path, buf);
318 /* Override them by options set on kernel command-line */
319 root_nfs_parse(name, buf);
321 cp = vx_new_uts(nodename);
322 if (strlen(buf) + strlen(cp) > NFS_MAXPATHLEN) {
323 printk(KERN_ERR "Root-NFS: Pathname for remote directory too long.\n");
326 sprintf(nfs_path, buf, cp);
333 * Get NFS server address.
335 static int __init root_nfs_addr(void)
337 if ((servaddr = root_server_addr) == INADDR_NONE) {
338 printk(KERN_ERR "Root-NFS: No NFS server available, giving up.\n");
342 snprintf(nfs_data.hostname, sizeof(nfs_data.hostname),
343 "%u.%u.%u.%u", NIPQUAD(servaddr));
348 * Tell the user what's going on.
351 static void __init root_nfs_print(void)
353 printk(KERN_NOTICE "Root-NFS: Mounting %s on server %s as root\n",
354 nfs_path, nfs_data.hostname);
355 printk(KERN_NOTICE "Root-NFS: rsize = %d, wsize = %d, timeo = %d, retrans = %d\n",
356 nfs_data.rsize, nfs_data.wsize, nfs_data.timeo, nfs_data.retrans);
357 printk(KERN_NOTICE "Root-NFS: acreg (min,max) = (%d,%d), acdir (min,max) = (%d,%d)\n",
358 nfs_data.acregmin, nfs_data.acregmax,
359 nfs_data.acdirmin, nfs_data.acdirmax);
360 printk(KERN_NOTICE "Root-NFS: nfsd port = %d, mountd port = %d, flags = %08x\n",
361 nfs_port, mount_port, nfs_data.flags);
366 static int __init root_nfs_init(void)
369 nfs_debug |= NFSDBG_ROOT;
373 * Decode the root directory path name and NFS options from
374 * the kernel command line. This has to go here in order to
375 * be able to use the client IP address for the remote root
376 * directory (necessary for pure RARP booting).
378 if (root_nfs_name(nfs_root_name) < 0 ||
391 * Parse NFS server and directory information passed on the kernel
394 static int __init nfs_root_setup(char *line)
397 if (line[0] == '/' || line[0] == ',' || (line[0] >= '0' && line[0] <= '9')) {
398 strlcpy(nfs_root_name, line, sizeof(nfs_root_name));
400 int n = strlen(line) + sizeof(NFS_ROOT) - 1;
401 if (n >= sizeof(nfs_root_name))
402 line[sizeof(nfs_root_name) - sizeof(NFS_ROOT) - 2] = '\0';
403 sprintf(nfs_root_name, NFS_ROOT, line);
405 root_server_addr = root_nfs_parse_addr(nfs_root_name);
409 __setup("nfsroot=", nfs_root_setup);
411 /***************************************************************************
413 Routines to actually mount the root directory
415 ***************************************************************************/
418 * Construct sockaddr_in from address and port number.
421 set_sockaddr(struct sockaddr_in *sin, __u32 addr, __u16 port)
423 sin->sin_family = AF_INET;
424 sin->sin_addr.s_addr = addr;
425 sin->sin_port = port;
429 * Query server portmapper for the port of a daemon program.
431 static int __init root_nfs_getport(int program, int version, int proto)
433 struct sockaddr_in sin;
435 printk(KERN_NOTICE "Looking up port of RPC %d/%d on %u.%u.%u.%u\n",
436 program, version, NIPQUAD(servaddr));
437 set_sockaddr(&sin, servaddr, 0);
438 return rpc_getport_external(&sin, program, version, proto);
443 * Use portmapper to find mountd and nfsd port numbers if not overriden
444 * by the user. Use defaults if portmapper is not available.
445 * XXX: Is there any nfs server with no portmapper?
447 static int __init root_nfs_ports(void)
450 int nfsd_ver, mountd_ver;
451 int nfsd_port, mountd_port;
454 if (nfs_data.flags & NFS_MOUNT_VER3) {
455 nfsd_ver = NFS3_VERSION;
456 mountd_ver = NFS_MNT3_VERSION;
457 nfsd_port = NFS_PORT;
458 mountd_port = NFS_MNT_PORT;
460 nfsd_ver = NFS2_VERSION;
461 mountd_ver = NFS_MNT_VERSION;
462 nfsd_port = NFS_PORT;
463 mountd_port = NFS_MNT_PORT;
466 proto = (nfs_data.flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
469 if ((port = root_nfs_getport(NFS_PROGRAM, nfsd_ver, proto)) < 0) {
470 printk(KERN_ERR "Root-NFS: Unable to get nfsd port "
471 "number from server, using default\n");
475 dprintk("Root-NFS: Portmapper on server returned %d "
476 "as nfsd port\n", port);
478 nfs_port = htons(nfs_port);
480 if ((port = root_nfs_getport(NFS_MNT_PROGRAM, mountd_ver, proto)) < 0) {
481 printk(KERN_ERR "Root-NFS: Unable to get mountd port "
482 "number from server, using default\n");
485 mount_port = htons(port);
486 dprintk("Root-NFS: mountd port is %d\n", port);
493 * Get a file handle from the server for the directory which is to be
496 static int __init root_nfs_get_handle(void)
499 struct sockaddr_in sin;
501 int protocol = (nfs_data.flags & NFS_MOUNT_TCP) ?
502 IPPROTO_TCP : IPPROTO_UDP;
503 int version = (nfs_data.flags & NFS_MOUNT_VER3) ?
504 NFS_MNT3_VERSION : NFS_MNT_VERSION;
506 set_sockaddr(&sin, servaddr, mount_port);
507 status = nfsroot_mount(&sin, nfs_path, &fh, version, protocol);
509 printk(KERN_ERR "Root-NFS: Server returned error %d "
510 "while mounting %s\n", status, nfs_path);
512 nfs_data.root.size = fh.size;
513 memcpy(nfs_data.root.data, fh.data, fh.size);
520 * Get the NFS port numbers and file handle, and return the prepared 'data'
521 * argument for mount() if everything went OK. Return NULL otherwise.
523 void * __init nfs_root_data(void)
525 if (root_nfs_init() < 0
526 || root_nfs_ports() < 0
527 || root_nfs_get_handle() < 0)
529 set_sockaddr((struct sockaddr_in *) &nfs_data.addr, servaddr, nfs_port);
530 return (void*)&nfs_data;