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