nfsdiskless.h revision 330897
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1991, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Rick Macklem at The University of Guelph.
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 * 4. 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 *	@(#)nfsdiskless.h	8.2 (Berkeley) 3/30/95
35 * $FreeBSD: stable/11/sys/nfs/nfsdiskless.h 330897 2018-03-14 03:19:51Z eadler $
36 */
37
38#ifndef _NFSCLIENT_NFSDISKLESS_H_
39#define _NFSCLIENT_NFSDISKLESS_H_
40
41/*
42 * Structure that must be initialized for a diskless nfs client.
43 * This structure is used by nfs_mountroot() to set up the root vnode,
44 * and to do a partial ifconfig(8) and route(8) so that the critical net
45 * interface can communicate with the server.
46 * The primary bootstrap is expected to fill in the appropriate fields before
47 * starting the kernel.
48 * Currently only works for AF_INET protocols.
49 * NB: All fields are stored in net byte order to avoid hassles with
50 * client/server byte ordering differences.
51 */
52
53/*
54 * I have defined a new structure that can handle an NFS Version 3 file handle
55 * but the kernel still expects the old Version 2 one to be provided. The
56 * changes required in nfs_vfsops.c for using the new are documented there in
57 * comments. (I felt that breaking network booting code by changing this
58 * structure would not be prudent at this time, since almost all servers are
59 * still Version 2 anyhow.)
60 */
61struct nfsv3_diskless {
62	struct ifaliasreq myif;			/* Default interface */
63	struct sockaddr_in mygateway;		/* Default gateway */
64	struct nfs_args	root_args;		/* Mount args for root fs */
65	int		root_fhsize;		/* Size of root file handle */
66	u_char		root_fh[NFSX_V3FHMAX];	/* File handle of root dir */
67	struct sockaddr_in root_saddr;		/* Address of root server */
68	char		root_hostnam[MNAMELEN];	/* Host name for mount pt */
69	long		root_time;		/* Timestamp of root fs */
70	char		my_hostnam[MAXHOSTNAMELEN]; /* Client host name */
71};
72
73/*
74 * Old arguments to mount NFS
75 */
76struct onfs_args {
77	struct sockaddr	*addr;		/* file server address */
78	int		addrlen;	/* length of address */
79	int		sotype;		/* Socket type */
80	int		proto;		/* and Protocol */
81	u_char		*fh;		/* File handle to be mounted */
82	int		fhsize;		/* Size, in bytes, of fh */
83	int		flags;		/* flags */
84	int		wsize;		/* write size in bytes */
85	int		rsize;		/* read size in bytes */
86	int		readdirsize;	/* readdir size in bytes */
87	int		timeo;		/* initial timeout in .1 secs */
88	int		retrans;	/* times to retry send */
89	int		maxgrouplist;	/* Max. size of group list */
90	int		readahead;	/* # of blocks to readahead */
91	int		leaseterm;	/* Term (sec) of lease */
92	int		deadthresh;	/* Retrans threshold */
93	char		*hostname;	/* server's name */
94};
95
96struct nfs_diskless {
97	struct ifaliasreq myif;			/* Default interface */
98	struct sockaddr_in mygateway;		/* Default gateway */
99	struct onfs_args root_args;		/* Mount args for root fs */
100	u_char		root_fh[NFSX_V2FH];	/* File handle of root dir */
101	struct sockaddr_in root_saddr;		/* Address of root server */
102	char		root_hostnam[MNAMELEN];	/* Host name for mount pt */
103	long		root_time;		/* Timestamp of root fs */
104	char		my_hostnam[MAXHOSTNAMELEN]; /* Client host name */
105};
106
107#ifdef _KERNEL
108extern struct nfsv3_diskless nfsv3_diskless;
109extern struct nfs_diskless nfs_diskless;
110extern int	nfs_diskless_valid;
111void bootpc_init(void);
112void nfs_setup_diskless(void);
113void nfs_parse_options(const char *, struct nfs_args *);
114#endif
115
116#endif
117