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