bsd/sys/vnioctl.h

   1 /*
   2  * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1988 University of Utah.
  24  * Copyright (c) 1990, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * This code is derived from software contributed to Berkeley by
  28  * the Systems Programming Group of the University of Utah Computer
  29  * Science Department.
  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  * from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
  60  *
  61  *      @(#)vnioctl.h   8.1 (Berkeley) 6/10/93
  62  *
  63  * $FreeBSD: src/sys/sys/vnioctl.h,v 1.4 1999/09/17 05:33:58 dillon Exp $
  64  */
  65
  66 #ifndef _SYS_VNIOCTL_H_
  67 #define _SYS_VNIOCTL_H_
  68
  69 #include <sys/appleapiopts.h>
  70 #include <sys/cdefs.h>
  71
  72
  73 /*
  74  * Ioctl definitions for file (vnode) disk pseudo-device.
  75  */
  76
  77 #define _PATH_VNTAB     "/etc/vntab"    /* default config file */
  78
  79 typedef enum {
  80         vncontrol_readwrite_io_e = 0
  81 } vncontrol_t;
  82
  83 struct vn_ioctl {
  84         char *          vn_file;        /* pathname of file to mount */
  85         int                     vn_size;        /* (returned) size of disk */
  86         vncontrol_t     vn_control;
  87 };
  88
  89 #ifdef KERNEL_PRIVATE
  90
  91 #if __DARWIN_ALIGN_NATURAL
  92 #pragma options align=natural
  93 #endif
  94
  95 struct user_vn_ioctl {
  96         u_int64_t       vn_file;        /* pathname of file to mount */
  97         int                     vn_size;        /* (returned) size of disk */
  98         vncontrol_t     vn_control;
  99 };
 100
 101 #if __DARWIN_ALIGN_NATURAL
 102 #pragma options align=reset
 103 #endif
 104
 105 #endif /* KERNEL_PRIVATE */
 106
 107 /*
 108  * Before you can use a unit, it must be configured with VNIOCSET.
 109  * The configuration persists across opens and closes of the device;
 110  * an VNIOCCLR must be used to reset a configuration.  An attempt to
 111  * VNIOCSET an already active unit will return EBUSY.
 112  */
 113 #define VNIOCATTACH     _IOWR('F', 0, struct vn_ioctl)  /* attach file */
 114 #define VNIOCDETACH     _IOWR('F', 1, struct vn_ioctl)  /* detach disk */
 115 #define VNIOCGSET       _IOWR('F', 2, u_int32_t )               /* set global option */
 116 #define VNIOCGCLEAR     _IOWR('F', 3, u_int32_t )               /* reset --//-- */
 117 #define VNIOCUSET       _IOWR('F', 4, u_int32_t )               /* set unit option */
 118 #define VNIOCUCLEAR     _IOWR('F', 5, u_int32_t )               /* reset --//-- */
 119 #define VNIOCSHADOW     _IOWR('F', 6, struct vn_ioctl)  /* attach shadow */
 120 #ifdef KERNEL_PRIVATE
 121 #define VNIOCATTACH64   _IOWR('F', 0, struct user_vn_ioctl)     /* attach file - LP64 */
 122 #define VNIOCDETACH64   _IOWR('F', 1, struct user_vn_ioctl)     /* detach disk - LP64 */
 123 #define VNIOCSHADOW64   _IOWR('F', 6, struct user_vn_ioctl)     /* attach shadow - LP64 */
 124 #endif /* KERNEL_PRIVATE */
 125
 126 #define VN_LABELS       0x1     /* Use disk(/slice) labels */
 127 #define VN_FOLLOW       0x2     /* Debug flow in vn driver */
 128 #define VN_DEBUG        0x4     /* Debug data in vn driver */
 129 #define VN_IO           0x8     /* Debug I/O in vn driver */
 130 #define VN_DONTCLUSTER  0x10    /* Don't cluster */
 131 #define VN_RESERVE      0x20    /* Pre-reserve swap */
 132
 133
 134 #endif  /* _SYS_VNIOCTL_H_*/