bsd/nfs/nfsdiskless.h

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