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