dev_net.c revision 346042
1/*	$NetBSD: dev_net.c,v 1.23 2008/04/28 20:24:06 martin Exp $	*/
2
3/*-
4 * Copyright (c) 1997 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Gordon W. Ross.
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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#include <sys/cdefs.h>
33__FBSDID("$FreeBSD: stable/11/stand/common/dev_net.c 346042 2019-04-08 18:38:18Z kevans $");
34
35/*-
36 * This module implements a "raw device" interface suitable for
37 * use by the stand-alone I/O library NFS code.  This interface
38 * does not support any "block" access, and exists only for the
39 * purpose of initializing the network interface, getting boot
40 * parameters, and performing the NFS mount.
41 *
42 * At open time, this does:
43 *
44 * find interface      - netif_open()
45 * RARP for IP address - rarp_getipaddress()
46 * RPC/bootparams      - callrpc(d, RPC_BOOTPARAMS, ...)
47 * RPC/mountd          - nfs_mount(sock, ip, path)
48 *
49 * the root file handle from mountd is saved in a global
50 * for use by the NFS open code (NFS/lookup).
51 */
52
53#include <machine/stdarg.h>
54#include <sys/param.h>
55#include <sys/socket.h>
56#include <net/if.h>
57#include <netinet/in.h>
58#include <netinet/in_systm.h>
59
60#include <stand.h>
61#include <stddef.h>
62#include <string.h>
63#include <net.h>
64#include <netif.h>
65#include <bootp.h>
66#include <bootparam.h>
67
68#include "dev_net.h"
69#include "bootstrap.h"
70
71#ifdef	NETIF_DEBUG
72int debug = 0;
73#endif
74
75static char *netdev_name;
76static int netdev_sock = -1;
77static int netdev_opens;
78
79static int	net_init(void);
80static int	net_open(struct open_file *, ...);
81static int	net_close(struct open_file *);
82static void	net_cleanup(void);
83static int	net_strategy(void *, int, daddr_t, size_t, char *, size_t *);
84static int	net_print(int);
85
86static int net_getparams(int sock);
87
88struct devsw netdev = {
89	"net",
90	DEVT_NET,
91	net_init,
92	net_strategy,
93	net_open,
94	net_close,
95	noioctl,
96	net_print,
97	net_cleanup
98};
99
100static struct uri_scheme {
101	const char *scheme;
102	int proto;
103} uri_schemes[] = {
104	{ "tftp:/", NET_TFTP },
105	{ "nfs:/", NET_NFS },
106};
107
108static int
109net_init(void)
110{
111
112	return (0);
113}
114
115/*
116 * Called by devopen after it sets f->f_dev to our devsw entry.
117 * This opens the low-level device and sets f->f_devdata.
118 * This is declared with variable arguments...
119 */
120static int
121net_open(struct open_file *f, ...)
122{
123	struct iodesc *d;
124	va_list args;
125	struct devdesc *dev;
126	const char *devname;	/* Device part of file name (or NULL). */
127	int error = 0;
128
129	va_start(args, f);
130	dev = va_arg(args, struct devdesc *);
131	va_end(args);
132
133	devname = dev->d_dev->dv_name;
134	/* Before opening another interface, close the previous one first. */
135	if (netdev_sock >= 0 && strcmp(devname, netdev_name) != 0)
136		net_cleanup();
137
138	/* On first open, do netif open, mount, etc. */
139	if (netdev_opens == 0) {
140		/* Find network interface. */
141		if (netdev_sock < 0) {
142			netdev_sock = netif_open(dev);
143			if (netdev_sock < 0) {
144				printf("net_open: netif_open() failed\n");
145				return (ENXIO);
146			}
147			netdev_name = strdup(devname);
148#ifdef	NETIF_DEBUG
149			if (debug)
150				printf("net_open: netif_open() succeeded\n");
151#endif
152		}
153		/*
154		 * If network params were not set by netif_open(), try to get
155		 * them via bootp, rarp, etc.
156		 */
157		if (rootip.s_addr == 0) {
158			/* Get root IP address, and path, etc. */
159			error = net_getparams(netdev_sock);
160			if (error) {
161				/* getparams makes its own noise */
162				free(netdev_name);
163				netif_close(netdev_sock);
164				netdev_sock = -1;
165				return (error);
166			}
167		}
168		/*
169		 * Set the variables required by the kernel's nfs_diskless
170		 * mechanism.  This is the minimum set of variables required to
171		 * mount a root filesystem without needing to obtain additional
172		 * info from bootp or other sources.
173		 */
174		d = socktodesc(netdev_sock);
175		setenv("boot.netif.hwaddr", ether_sprintf(d->myea), 1);
176		setenv("boot.netif.ip", inet_ntoa(myip), 1);
177		setenv("boot.netif.netmask", intoa(netmask), 1);
178		setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
179		setenv("boot.netif.server", inet_ntoa(rootip), 1);
180		if (netproto == NET_TFTP) {
181			setenv("boot.tftproot.server", inet_ntoa(rootip), 1);
182			setenv("boot.tftproot.path", rootpath, 1);
183		} else if (netproto == NET_NFS) {
184			setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
185			setenv("boot.nfsroot.path", rootpath, 1);
186		}
187		if (intf_mtu != 0) {
188			char mtu[16];
189			snprintf(mtu, sizeof(mtu), "%u", intf_mtu);
190			setenv("boot.netif.mtu", mtu, 1);
191		}
192
193	}
194	netdev_opens++;
195	f->f_devdata = &netdev_sock;
196	return (error);
197}
198
199static int
200net_close(struct open_file *f)
201{
202
203#ifdef	NETIF_DEBUG
204	if (debug)
205		printf("net_close: opens=%d\n", netdev_opens);
206#endif
207
208	f->f_devdata = NULL;
209
210	return (0);
211}
212
213static void
214net_cleanup(void)
215{
216
217	if (netdev_sock >= 0) {
218#ifdef	NETIF_DEBUG
219		if (debug)
220			printf("net_cleanup: calling netif_close()\n");
221#endif
222		rootip.s_addr = 0;
223		free(netdev_name);
224		netif_close(netdev_sock);
225		netdev_sock = -1;
226	}
227}
228
229static int
230net_strategy(void *devdata, int rw, daddr_t blk, size_t size, char *buf,
231    size_t *rsize)
232{
233
234	return (EIO);
235}
236
237#define SUPPORT_BOOTP
238
239/*
240 * Get info for NFS boot: our IP address, our hostname,
241 * server IP address, and our root path on the server.
242 * There are two ways to do this:  The old, Sun way,
243 * and the more modern, BOOTP way. (RFC951, RFC1048)
244 *
245 * The default is to use the Sun bootparams RPC
246 * (because that is what the kernel will do).
247 * MD code can make try_bootp initialied data,
248 * which will override this common definition.
249 */
250#ifdef	SUPPORT_BOOTP
251int try_bootp = 1;
252#endif
253
254extern n_long ip_convertaddr(char *p);
255
256static int
257net_getparams(int sock)
258{
259	char buf[MAXHOSTNAMELEN];
260	n_long rootaddr, smask;
261
262#ifdef	SUPPORT_BOOTP
263	/*
264	 * Try to get boot info using BOOTP.  If we succeed, then
265	 * the server IP address, gateway, and root path will all
266	 * be initialized.  If any remain uninitialized, we will
267	 * use RARP and RPC/bootparam (the Sun way) to get them.
268	 */
269	if (try_bootp)
270		bootp(sock);
271	if (myip.s_addr != 0)
272		goto exit;
273#ifdef	NETIF_DEBUG
274	if (debug)
275		printf("net_open: BOOTP failed, trying RARP/RPC...\n");
276#endif
277#endif
278
279	/*
280	 * Use RARP to get our IP address.  This also sets our
281	 * netmask to the "natural" default for our address.
282	 */
283	if (rarp_getipaddress(sock)) {
284		printf("net_open: RARP failed\n");
285		return (EIO);
286	}
287	printf("net_open: client addr: %s\n", inet_ntoa(myip));
288
289	/* Get our hostname, server IP address, gateway. */
290	if (bp_whoami(sock)) {
291		printf("net_open: bootparam/whoami RPC failed\n");
292		return (EIO);
293	}
294#ifdef	NETIF_DEBUG
295	if (debug)
296		printf("net_open: client name: %s\n", hostname);
297#endif
298
299	/*
300	 * Ignore the gateway from whoami (unreliable).
301	 * Use the "gateway" parameter instead.
302	 */
303	smask = 0;
304	gateip.s_addr = 0;
305	if (bp_getfile(sock, "gateway", &gateip, buf) == 0) {
306		/* Got it!  Parse the netmask. */
307		smask = ip_convertaddr(buf);
308	}
309	if (smask) {
310		netmask = smask;
311#ifdef	NETIF_DEBUG
312		if (debug)
313			printf("net_open: subnet mask: %s\n", intoa(netmask));
314#endif
315	}
316#ifdef	NETIF_DEBUG
317	if (gateip.s_addr && debug)
318		printf("net_open: net gateway: %s\n", inet_ntoa(gateip));
319#endif
320
321	/* Get the root server and pathname. */
322	if (bp_getfile(sock, "root", &rootip, rootpath)) {
323		printf("net_open: bootparam/getfile RPC failed\n");
324		return (EIO);
325	}
326exit:
327	if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
328		rootip.s_addr = rootaddr;
329
330#ifdef	NETIF_DEBUG
331	if (debug) {
332		printf("net_open: server addr: %s\n", inet_ntoa(rootip));
333		printf("net_open: server path: %s\n", rootpath);
334	}
335#endif
336
337	return (0);
338}
339
340static int
341net_print(int verbose)
342{
343	struct netif_driver *drv;
344	int i, d, cnt;
345	int ret = 0;
346
347	if (netif_drivers[0] == NULL)
348		return (ret);
349
350	printf("%s devices:", netdev.dv_name);
351	if ((ret = pager_output("\n")) != 0)
352		return (ret);
353
354	cnt = 0;
355	for (d = 0; netif_drivers[d]; d++) {
356		drv = netif_drivers[d];
357		for (i = 0; i < drv->netif_nifs; i++) {
358			printf("\t%s%d:", netdev.dv_name, cnt++);
359			if (verbose) {
360				printf(" (%s%d)", drv->netif_bname,
361				    drv->netif_ifs[i].dif_unit);
362			}
363			if ((ret = pager_output("\n")) != 0)
364				return (ret);
365		}
366	}
367	return (ret);
368}
369
370/*
371 * Parses the rootpath if present
372 *
373 * The rootpath format can be in the form
374 * <scheme>://ip/path
375 * <scheme>:/path
376 *
377 * For compatibility with previous behaviour it also accepts as an NFS scheme
378 * ip:/path
379 * /path
380 *
381 * If an ip is set it returns it in network byte order.
382 * The default scheme defined in the global netproto, if not set it defaults to
383 * NFS.
384 * It leaves just the pathname in the global rootpath.
385 */
386uint32_t
387net_parse_rootpath(void)
388{
389	n_long addr = htonl(INADDR_NONE);
390	size_t i;
391	char ip[FNAME_SIZE];
392	char *ptr, *val;
393
394	netproto = NET_NONE;
395
396	for (i = 0; i < nitems(uri_schemes); i++) {
397		if (strncmp(rootpath, uri_schemes[i].scheme,
398		    strlen(uri_schemes[i].scheme)) != 0)
399			continue;
400
401		netproto = uri_schemes[i].proto;
402		break;
403	}
404	ptr = rootpath;
405	/* Fallback for compatibility mode */
406	if (netproto == NET_NONE) {
407		netproto = NET_NFS;
408		(void)strsep(&ptr, ":");
409		if (ptr != NULL) {
410			addr = inet_addr(rootpath);
411			bcopy(ptr, rootpath, strlen(ptr) + 1);
412		}
413	} else {
414		ptr += strlen(uri_schemes[i].scheme);
415		if (*ptr == '/') {
416			/* we are in the form <scheme>://, we do expect an ip */
417			ptr++;
418			/*
419			 * XXX when http will be there we will need to check for
420			 * a port, but right now we do not need it yet
421			 */
422			val = strchr(ptr, '/');
423			if (val != NULL) {
424				snprintf(ip, sizeof(ip), "%.*s",
425				    (int)((uintptr_t)val - (uintptr_t)ptr),
426				    ptr);
427				addr = inet_addr(ip);
428				bcopy(val, rootpath, strlen(val) + 1);
429			}
430		} else {
431			ptr--;
432			bcopy(ptr, rootpath, strlen(ptr) + 1);
433		}
434	}
435
436	return (addr);
437}
438