xref: /freebsd/sys/nfs/nfs_diskless.c (revision 9f27341c336aa12f6c7163c17e646e76c813b689)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * William Jolitz.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	from: @(#)autoconf.c	7.1 (Berkeley) 5/9/91
35  */
36 
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39 
40 #include "opt_bootp.h"
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/jail.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
47 #include <sys/mount.h>
48 #include <sys/socket.h>
49 
50 #include <net/if.h>
51 #include <net/if_dl.h>
52 #include <net/if_types.h>
53 #include <net/if_var.h>
54 #include <net/ethernet.h>
55 #include <net/vnet.h>
56 
57 #include <netinet/in.h>
58 #include <nfs/nfsproto.h>
59 #include <nfsclient/nfs.h>
60 #include <nfs/nfsdiskless.h>
61 
62 #define	NFS_IFACE_TIMEOUT_SECS	10 /* Timeout for interface to appear. */
63 
64 static int inaddr_to_sockaddr(char *ev, struct sockaddr_in *sa);
65 static int hwaddr_to_sockaddr(char *ev, struct sockaddr_dl *sa);
66 static int decode_nfshandle(char *ev, u_char *fh, int maxfh);
67 
68 /*
69  * This structure must be filled in by a primary bootstrap or bootstrap
70  * server for a diskless/dataless machine. It is initialized below just
71  * to ensure that it is allocated to initialized data (.data not .bss).
72  */
73 struct nfs_diskless	nfs_diskless = { { { 0 } } };
74 struct nfsv3_diskless	nfsv3_diskless = { { { 0 } } };
75 int			nfs_diskless_valid = 0;
76 
77 /*
78  * Validate/sanity check a rsize/wsize parameter.
79  */
80 static int
81 checkrwsize(unsigned long v, const char *name)
82 {
83 	/*
84 	 * 32K is used as an upper bound because most servers
85 	 * limit block size to satisfy IPv4's limit of
86 	 * 64K/reassembled packet.  The lower bound is pretty
87 	 * much arbitrary.
88 	 */
89 	if (!(4 <= v && v <= 32*1024)) {
90 		printf("nfs_parse_options: invalid %s %lu ignored\n", name, v);
91 		return 0;
92 	} else
93 		return 1;
94 }
95 
96 /*
97  * Parse mount options and apply them to the supplied
98  * nfs_diskless state.  Used also by bootp/dhcp support.
99  */
100 void
101 nfs_parse_options(const char *envopts, struct nfs_args *nd)
102 {
103 	char *opts, *o, *otmp;
104 	unsigned long v;
105 
106 	opts = strdup(envopts, M_TEMP);
107 	otmp = opts;
108 	while ((o = strsep(&otmp, ":;, ")) != NULL) {
109 		if (*o == '\0')
110 			; /* Skip empty options. */
111 		else if (strcmp(o, "soft") == 0)
112 			nd->flags |= NFSMNT_SOFT;
113 		else if (strcmp(o, "intr") == 0)
114 			nd->flags |= NFSMNT_INT;
115 		else if (strcmp(o, "conn") == 0)
116 			nd->flags |= NFSMNT_NOCONN;
117 		else if (strcmp(o, "nolockd") == 0)
118 			nd->flags |= NFSMNT_NOLOCKD;
119 		else if (strcmp(o, "nocto") == 0)
120 			nd->flags |= NFSMNT_NOCTO;
121 		else if (strcmp(o, "nfsv2") == 0)
122 			nd->flags &= ~(NFSMNT_NFSV3 | NFSMNT_NFSV4);
123 		else if (strcmp(o, "nfsv3") == 0) {
124 			nd->flags &= ~NFSMNT_NFSV4;
125 			nd->flags |= NFSMNT_NFSV3;
126 		} else if (strcmp(o, "tcp") == 0)
127 			nd->sotype = SOCK_STREAM;
128 		else if (strcmp(o, "udp") == 0)
129 			nd->sotype = SOCK_DGRAM;
130 		else if (strncmp(o, "rsize=", 6) == 0) {
131 			v = strtoul(o+6, NULL, 10);
132 			if (checkrwsize(v, "rsize")) {
133 				nd->rsize = (int) v;
134 				nd->flags |= NFSMNT_RSIZE;
135 			}
136 		} else if (strncmp(o, "wsize=", 6) == 0) {
137 			v = strtoul(o+6, NULL, 10);
138 			if (checkrwsize(v, "wsize")) {
139 				nd->wsize = (int) v;
140 				nd->flags |= NFSMNT_WSIZE;
141 			}
142 		} else
143 			printf("%s: skipping unknown option \"%s\"\n",
144 			    __func__, o);
145 	}
146 	free(opts, M_TEMP);
147 }
148 
149 static u_int
150 nfs_setup_diskless_ifa_cb(void *arg, struct sockaddr_dl *sdl, u_int count)
151 {
152 	struct sockaddr_dl *ourdl = arg;
153 
154 	if ((sdl->sdl_type == ourdl->sdl_type) &&
155 	    (sdl->sdl_alen == ourdl->sdl_alen) &&
156 	    !bcmp(LLADDR(sdl), LLADDR(ourdl), sdl->sdl_alen))
157 		return (1);
158 
159 	return (0);
160 }
161 
162 /*
163  * Populate the essential fields in the nfsv3_diskless structure.
164  *
165  * The loader is expected to export the following environment variables:
166  *
167  * boot.netif.name		name of boot interface
168  * boot.netif.ip		IP address on boot interface
169  * boot.netif.netmask		netmask on boot interface
170  * boot.netif.gateway		default gateway (optional)
171  * boot.netif.hwaddr		hardware address of boot interface
172  * boot.netif.mtu		interface mtu from bootp/dhcp (optional)
173  * boot.nfsroot.server		IP address of root filesystem server
174  * boot.nfsroot.path		path of the root filesystem on server
175  * boot.nfsroot.nfshandle	NFS handle for root filesystem on server
176  * boot.nfsroot.nfshandlelen	and length of this handle (for NFSv3 only)
177  * boot.nfsroot.options		NFS options for the root filesystem
178  */
179 void
180 nfs_setup_diskless(void)
181 {
182 	struct epoch_tracker et;
183 	struct if_iter iter;
184 	struct nfs_diskless *nd = &nfs_diskless;
185 	struct nfsv3_diskless *nd3 = &nfsv3_diskless;
186 	if_t ifp;
187 	struct sockaddr_dl ourdl;
188 	struct sockaddr_in myaddr, netmask;
189 	char *cp;
190 	int cnt, fhlen, is_nfsv3;
191 	uint32_t len;
192 	time_t timeout_at;
193 	u_int count;
194 
195 	if (nfs_diskless_valid != 0)
196 		return;
197 
198 	/* get handle size. If this succeeds, it's an NFSv3 setup. */
199 	if ((cp = kern_getenv("boot.nfsroot.nfshandlelen")) != NULL) {
200 		cnt = sscanf(cp, "%d", &len);
201 		freeenv(cp);
202 		if (cnt != 1 || len == 0 || len > NFSX_V3FHMAX) {
203 			printf("nfs_diskless: bad NFS handle len\n");
204 			return;
205 		}
206 		nd3->root_fhsize = len;
207 		is_nfsv3 = 1;
208 	} else
209 		is_nfsv3 = 0;
210 	/* set up interface */
211 	if (inaddr_to_sockaddr("boot.netif.ip", &myaddr))
212 		return;
213 	if (inaddr_to_sockaddr("boot.netif.netmask", &netmask)) {
214 		printf("nfs_diskless: no netmask\n");
215 		return;
216 	}
217 	if (is_nfsv3 != 0) {
218 		bcopy(&myaddr, &nd3->myif.ifra_addr, sizeof(myaddr));
219 		bcopy(&myaddr, &nd3->myif.ifra_broadaddr, sizeof(myaddr));
220 		((struct sockaddr_in *)
221 		   &nd3->myif.ifra_broadaddr)->sin_addr.s_addr =
222 		    myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
223 		bcopy(&netmask, &nd3->myif.ifra_mask, sizeof(netmask));
224 	} else {
225 		bcopy(&myaddr, &nd->myif.ifra_addr, sizeof(myaddr));
226 		bcopy(&myaddr, &nd->myif.ifra_broadaddr, sizeof(myaddr));
227 		((struct sockaddr_in *)
228 		   &nd->myif.ifra_broadaddr)->sin_addr.s_addr =
229 		    myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
230 		bcopy(&netmask, &nd->myif.ifra_mask, sizeof(netmask));
231 	}
232 
233 	if (hwaddr_to_sockaddr("boot.netif.hwaddr", &ourdl)) {
234 		printf("nfs_diskless: no hardware address\n");
235 		return;
236 	}
237 	timeout_at = time_uptime + NFS_IFACE_TIMEOUT_SECS;
238 retry:
239 	CURVNET_SET(TD_TO_VNET(curthread));
240 	NET_EPOCH_ENTER(et);
241 
242 	for (ifp = if_iter_start(&iter); ifp != NULL; ifp = if_iter_next(&iter)) {
243 		count = if_foreach_lladdr(ifp, nfs_setup_diskless_ifa_cb, &ourdl);
244 
245 		if (count > 0)
246 			break;
247 
248 	}
249 	if_iter_finish(&iter);
250 	NET_EPOCH_EXIT(et);
251 	CURVNET_RESTORE();
252 	if (cnt > 0) {
253 		goto match_done;
254 	}
255 
256 	if (time_uptime < timeout_at) {
257 		pause("nfssdl", hz / 5);
258 		goto retry;
259 	}
260 	printf("nfs_diskless: no interface\n");
261 	return;	/* no matching interface */
262 match_done:
263 	kern_setenv("boot.netif.name", if_name(ifp));
264 	if (is_nfsv3 != 0) {
265 		strlcpy(nd3->myif.ifra_name, if_name(ifp),
266 		    sizeof(nd3->myif.ifra_name));
267 
268 		/* set up gateway */
269 		inaddr_to_sockaddr("boot.netif.gateway", &nd3->mygateway);
270 
271 		/* set up root mount */
272 		nd3->root_args.rsize = 32768;		/* XXX tunable? */
273 		nd3->root_args.wsize = 32768;
274 		nd3->root_args.sotype = SOCK_STREAM;
275 		nd3->root_args.flags = (NFSMNT_NFSV3 | NFSMNT_WSIZE |
276 		    NFSMNT_RSIZE | NFSMNT_RESVPORT);
277 		if (inaddr_to_sockaddr("boot.nfsroot.server",
278 		    &nd3->root_saddr)) {
279 			printf("nfs_diskless: no server\n");
280 			return;
281 		}
282 		nd3->root_saddr.sin_port = htons(NFS_PORT);
283 		fhlen = decode_nfshandle("boot.nfsroot.nfshandle",
284 		    &nd3->root_fh[0], NFSX_V3FHMAX);
285 		if (fhlen == 0) {
286 			printf("nfs_diskless: no NFS handle\n");
287 			return;
288 		}
289 		if (fhlen != nd3->root_fhsize) {
290 			printf("nfs_diskless: bad NFS handle len=%d\n", fhlen);
291 			return;
292 		}
293 		if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
294 			strncpy(nd3->root_hostnam, cp, MNAMELEN - 1);
295 			freeenv(cp);
296 		}
297 		if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
298 			nfs_parse_options(cp, &nd3->root_args);
299 			freeenv(cp);
300 		}
301 
302 		nfs_diskless_valid = 3;
303 	} else {
304 		strlcpy(nd->myif.ifra_name, if_name(ifp),
305 		    sizeof(nd->myif.ifra_name));
306 
307 		/* set up gateway */
308 		inaddr_to_sockaddr("boot.netif.gateway", &nd->mygateway);
309 
310 		/* set up root mount */
311 		nd->root_args.rsize = 8192;		/* XXX tunable? */
312 		nd->root_args.wsize = 8192;
313 		nd->root_args.sotype = SOCK_STREAM;
314 		nd->root_args.flags = (NFSMNT_WSIZE |
315 		    NFSMNT_RSIZE | NFSMNT_RESVPORT);
316 		if (inaddr_to_sockaddr("boot.nfsroot.server",
317 		    &nd->root_saddr)) {
318 			printf("nfs_diskless: no server\n");
319 			return;
320 		}
321 		nd->root_saddr.sin_port = htons(NFS_PORT);
322 		if (decode_nfshandle("boot.nfsroot.nfshandle",
323 		    &nd->root_fh[0], NFSX_V2FH) == 0) {
324 			printf("nfs_diskless: no NFS handle\n");
325 			return;
326 		}
327 		if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
328 			strncpy(nd->root_hostnam, cp, MNAMELEN - 1);
329 			freeenv(cp);
330 		}
331 		if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
332 			struct nfs_args args;
333 
334 			/*
335 			 * XXX yech, convert between old and current
336 			 * arg format
337 			 */
338 			args.flags = nd->root_args.flags;
339 			args.sotype = nd->root_args.sotype;
340 			args.rsize = nd->root_args.rsize;
341 			args.wsize = nd->root_args.wsize;
342 			nfs_parse_options(cp, &args);
343 			nd->root_args.flags = args.flags;
344 			nd->root_args.sotype = args.sotype;
345 			nd->root_args.rsize = args.rsize;
346 			nd->root_args.wsize = args.wsize;
347 			freeenv(cp);
348 		}
349 
350 		nfs_diskless_valid = 1;
351 	}
352 }
353 
354 static int
355 inaddr_to_sockaddr(char *ev, struct sockaddr_in *sa)
356 {
357 	u_int32_t a[4];
358 	char *cp;
359 	int count;
360 
361 	bzero(sa, sizeof(*sa));
362 	sa->sin_len = sizeof(*sa);
363 	sa->sin_family = AF_INET;
364 
365 	if ((cp = kern_getenv(ev)) == NULL)
366 		return (1);
367 	count = sscanf(cp, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]);
368 	freeenv(cp);
369 	if (count != 4)
370 		return (1);
371 	sa->sin_addr.s_addr =
372 	    htonl((a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3]);
373 	return (0);
374 }
375 
376 static int
377 hwaddr_to_sockaddr(char *ev, struct sockaddr_dl *sa)
378 {
379 	char *cp;
380 	u_int32_t a[6];
381 	int count;
382 
383 	bzero(sa, sizeof(*sa));
384 	sa->sdl_len = sizeof(*sa);
385 	sa->sdl_family = AF_LINK;
386 	sa->sdl_type = IFT_ETHER;
387 	sa->sdl_alen = ETHER_ADDR_LEN;
388 	if ((cp = kern_getenv(ev)) == NULL)
389 		return (1);
390 	count = sscanf(cp, "%x:%x:%x:%x:%x:%x",
391 	    &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]);
392 	freeenv(cp);
393 	if (count != 6)
394 		return (1);
395 	sa->sdl_data[0] = a[0];
396 	sa->sdl_data[1] = a[1];
397 	sa->sdl_data[2] = a[2];
398 	sa->sdl_data[3] = a[3];
399 	sa->sdl_data[4] = a[4];
400 	sa->sdl_data[5] = a[5];
401 	return (0);
402 }
403 
404 static int
405 decode_nfshandle(char *ev, u_char *fh, int maxfh)
406 {
407 	u_char *cp, *ep;
408 	int len, val;
409 
410 	ep = cp = kern_getenv(ev);
411 	if (cp == NULL)
412 		return (0);
413 	if ((strlen(cp) < 2) || (*cp != 'X')) {
414 		freeenv(ep);
415 		return (0);
416 	}
417 	len = 0;
418 	cp++;
419 	for (;;) {
420 		if (*cp == 'X') {
421 			freeenv(ep);
422 			return (len);
423 		}
424 		if ((sscanf(cp, "%2x", &val) != 1) || (val > 0xff)) {
425 			freeenv(ep);
426 			return (0);
427 		}
428 		*(fh++) = val;
429 		len++;
430 		cp += 2;
431 		if (len > maxfh) {
432 		    freeenv(ep);
433 		    return (0);
434 		}
435 	}
436 }
437 
438 #if !defined(BOOTP_NFSROOT)
439 static void
440 nfs_rootconf(void)
441 {
442 
443 	nfs_setup_diskless();
444 	if (nfs_diskless_valid)
445 		rootdevnames[0] = "nfs:";
446 }
447 
448 SYSINIT(cpu_rootconf, SI_SUB_ROOT_CONF, SI_ORDER_FIRST, nfs_rootconf, NULL);
449 #endif
450