bsd/nfs/nfsdiskless.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  24 /*
  25  * Copyright (c) 1991, 1993
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * This code is derived from software contributed to Berkeley by
  29  * Rick Macklem at The University of Guelph.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  * 3. All advertising materials mentioning features or use of this software
  40  *    must display the following acknowledgement:
  41  *      This product includes software developed by the University of
  42  *      California, Berkeley and its contributors.
  43  * 4. Neither the name of the University nor the names of its contributors
  44  *    may be used to endorse or promote products derived from this software
  45  *    without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  51  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  *
  59  *      @(#)nfsdiskless.h       8.2 (Berkeley) 3/30/95
  60  * FreeBSD-Id: nfsdiskless.h,v 1.10 1997/09/07 12:56:46 bde Exp $
  61  */
  62
  63
  64 #ifndef _NFS_NFSDISKLESS_H_
  65 #define _NFS_NFSDISKLESS_H_
  66
  67 #include <sys/appleapiopts.h>
  68
  69 #ifdef __APPLE_API_PRIVATE
  70 /*
  71  * Structure that must be initialized for a diskless nfs client.
  72  * This structure is used by nfs_mountroot() to set up the root and swap
  73  * vnodes plus do a partial ifconfig(8) and route(8) so that the critical net
  74  * interface can communicate with the server.
  75  * The primary bootstrap is expected to fill in the appropriate fields before
  76  * starting the kernel. Whether or not the swap area is nfs mounted is
  77  * determined by the value in swdevt[0]. (equal to NODEV --> swap over nfs)
  78  * Currently only works for AF_INET protocols.
  79  * NB: All fields are stored in net byte order to avoid hassles with
  80  * client/server byte ordering differences.
  81  */
  82
  83 /*
  84  * I have defined a new structure that can handle an NFS Version 3 file handle
  85  * but the kernel still expects the old Version 2 one to be provided. The
  86  * changes required in nfs_vfsops.c for using the new are documented there in
  87  * comments. (I felt that breaking network booting code by changing this
  88  * structure would not be prudent at this time, since almost all servers are
  89  * still Version 2 anyhow.)
  90  */
  91 struct nfsv3_diskless {
  92         struct ifaliasreq myif;                 /* Default interface */
  93         struct sockaddr_in mygateway;           /* Default gateway */
  94         struct nfs_args swap_args;              /* Mount args for swap file */
  95         int             swap_fhsize;            /* Size of file handle */
  96         u_char          swap_fh[NFSX_V3FHMAX];  /* Swap file's file handle */
  97         struct sockaddr_in swap_saddr;          /* Address of swap server */
  98         char            swap_hostnam[MNAMELEN]; /* Host name for mount pt */
  99         int             swap_nblks;             /* Size of server swap file */
 100         struct ucred    swap_ucred;             /* Swap credentials */
 101         struct nfs_args root_args;              /* Mount args for root fs */
 102         int             root_fhsize;            /* Size of root file handle */
 103         u_char          root_fh[NFSX_V3FHMAX];  /* File handle of root dir */
 104         struct sockaddr_in root_saddr;          /* Address of root server */
 105         char            root_hostnam[MNAMELEN]; /* Host name for mount pt */
 106         long            root_time;              /* Timestamp of root fs */
 107         char            my_hostnam[MAXHOSTNAMELEN]; /* Client host name */
 108 };
 109
 110 struct nfs_dlmount {
 111         struct sockaddr_in ndm_saddr;           /* Address of file server */
 112         char            ndm_host[MNAMELEN];     /* Host name for mount pt */
 113         char            *ndm_path;              /* path name for mount pt */
 114         u_long          ndm_nfsv3;              /* NFSv3 or NFSv2? */
 115         u_long          ndm_sotype;             /* SOCK_STREAM or SOCK_DGRAM? */
 116         u_long          ndm_fhlen;              /* length of file handle */
 117         u_char          ndm_fh[NFSX_V3FHMAX];   /* The file's file handle */
 118 };
 119
 120 struct nfs_diskless {
 121         struct nfs_dlmount nd_root;     /* Mount info for root */
 122         struct nfs_dlmount nd_private;  /* Mount info for private */
 123 };
 124
 125 #endif /* __APPLE_API_PRIVATE */
 126 #endif /* _NFS_NFSDISKLESS_H_ */