xref: /freebsd/sys/nfs/nfsdiskless.h (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Rick Macklem at The University of Guelph.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)nfsdiskless.h	8.2 (Berkeley) 3/30/95
33  * $FreeBSD$
34  */
35 
36 #ifndef _NFSCLIENT_NFSDISKLESS_H_
37 #define _NFSCLIENT_NFSDISKLESS_H_
38 
39 /*
40  * Structure that must be initialized for a diskless nfs client.
41  * This structure is used by nfs_mountroot() to set up the root vnode,
42  * and to do a partial ifconfig(8) and route(8) so that the critical net
43  * interface can communicate with the server.
44  * The primary bootstrap is expected to fill in the appropriate fields before
45  * starting the kernel.
46  * Currently only works for AF_INET protocols.
47  * NB: All fields are stored in net byte order to avoid hassles with
48  * client/server byte ordering differences.
49  */
50 
51 /*
52  * I have defined a new structure that can handle an NFS Version 3 file handle
53  * but the kernel still expects the old Version 2 one to be provided. The
54  * changes required in nfs_vfsops.c for using the new are documented there in
55  * comments. (I felt that breaking network booting code by changing this
56  * structure would not be prudent at this time, since almost all servers are
57  * still Version 2 anyhow.)
58  */
59 struct nfsv3_diskless {
60 	struct ifaliasreq myif;			/* Default interface */
61 	struct sockaddr_in mygateway;		/* Default gateway */
62 	struct nfs_args	root_args;		/* Mount args for root fs */
63 	int		root_fhsize;		/* Size of root file handle */
64 	u_char		root_fh[NFSX_V3FHMAX];	/* File handle of root dir */
65 	struct sockaddr_in root_saddr;		/* Address of root server */
66 	char		root_hostnam[MNAMELEN];	/* Host name for mount pt */
67 	long		root_time;		/* Timestamp of root fs */
68 	char		my_hostnam[MAXHOSTNAMELEN]; /* Client host name */
69 };
70 
71 /*
72  * Old arguments to mount NFS
73  */
74 struct onfs_args {
75 	struct sockaddr	*addr;		/* file server address */
76 	int		addrlen;	/* length of address */
77 	int		sotype;		/* Socket type */
78 	int		proto;		/* and Protocol */
79 	u_char		*fh;		/* File handle to be mounted */
80 	int		fhsize;		/* Size, in bytes, of fh */
81 	int		flags;		/* flags */
82 	int		wsize;		/* write size in bytes */
83 	int		rsize;		/* read size in bytes */
84 	int		readdirsize;	/* readdir size in bytes */
85 	int		timeo;		/* initial timeout in .1 secs */
86 	int		retrans;	/* times to retry send */
87 	int		maxgrouplist;	/* Max. size of group list */
88 	int		readahead;	/* # of blocks to readahead */
89 	int		leaseterm;	/* Term (sec) of lease */
90 	int		deadthresh;	/* Retrans threshold */
91 	char		*hostname;	/* server's name */
92 };
93 
94 struct nfs_diskless {
95 	struct ifaliasreq myif;			/* Default interface */
96 	struct sockaddr_in mygateway;		/* Default gateway */
97 	struct onfs_args root_args;		/* Mount args for root fs */
98 	u_char		root_fh[NFSX_V2FH];	/* File handle of root dir */
99 	struct sockaddr_in root_saddr;		/* Address of root server */
100 	char		root_hostnam[MNAMELEN];	/* Host name for mount pt */
101 	long		root_time;		/* Timestamp of root fs */
102 	char		my_hostnam[MAXHOSTNAMELEN]; /* Client host name */
103 };
104 
105 #ifdef _KERNEL
106 extern struct nfsv3_diskless nfsv3_diskless;
107 extern struct nfs_diskless nfs_diskless;
108 extern int	nfs_diskless_valid;
109 void bootpc_init(void);
110 void nfs_setup_diskless(void);
111 void nfs_parse_options(const char *, struct nfs_args *);
112 #endif
113 
114 #endif
115