sys/sys/vnioctl.h

   1 /*
   2  * Copyright (c) 1988 University of Utah.
   3  * Copyright (c) 1990, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * the Systems Programming Group of the University of Utah Computer
   8  * Science Department.
   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. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  * from: Utah $Hdr: fdioctl.h 1.1 90/07/09$
  39  *
  40  *      @(#)vnioctl.h   8.1 (Berkeley) 6/10/93
  41  *
  42  * $FreeBSD: src/sys/sys/vnioctl.h,v 1.4 1999/09/17 05:33:58 dillon Exp $
  43  */
  44
  45 #ifndef _SYS_VNIOCTL_H_
  46 #define _SYS_VNIOCTL_H_
  47
  48 #ifndef _SYS_IOCCOM_H_
  49 #include <sys/ioccom.h>
  50 #endif
  51 #ifndef _SYS_PARAM_H_
  52 #include <sys/param.h>          /* PATH_MAX */
  53 #endif
  54
  55 /*
  56  * Ioctl definitions for file (vnode) disk pseudo-device.
  57  */
  58
  59 #define _PATH_VNTAB     "/etc/vntab"    /* default config file */
  60
  61 struct vn_ioctl {
  62         char    *vn_file;       /* pathname of file to mount */
  63         int64_t vn_size;        /* (returned) size of disk */
  64 };
  65
  66 /*
  67  * Structure used by userland to query vn devices.
  68  *
  69  * In file-backed configurations, vnu_file will contain the full path to
  70  * the backing file, with vnu_dev and vnu_ino pointing to the appropriate
  71  * filesystem entries for that file.
  72  *
  73  * In swap-backed configurations, vnu_file will contain the token "swap",
  74  * with vnu_size and vnu_secsize indicating the portion of virtual memory
  75  * in use by the vnode disk.
  76  *
  77  * Todo: verify vnu_file within a jail - path disclosure problem ?
  78  */
  79
  80
  81 struct vn_user {
  82         int             vnu_unit;               /* vn unit */
  83         char            vnu_file[PATH_MAX];     /* vn description */
  84 #define _VN_USER_SWAP   "swap"                  /* indicates swap-backed vn */
  85         union {
  86                 dev_t           dev;            /* vn device */
  87                 u_int64_t       size;           /* size per vnu_secsize */
  88         } data1;
  89         union {
  90                 ino_t           ino;            /* vn inode */
  91                 int             secsize;        /* sector size */
  92         } data2;
  93 };
  94 #define vnu_dev         data1.dev
  95 #define vnu_size        data1.size
  96 #define vnu_ino         data2.ino
  97 #define vnu_secsize     data2.secsize
  98
  99 /*
 100  * Before you can use a unit, it must be configured with VNIOCSET.
 101  * The configuration persists across opens and closes of the device;
 102  * an VNIOCCLR must be used to reset a configuration.  An attempt to
 103  * VNIOCSET an already active unit will return EBUSY.
 104  */
 105 #define VNIOCATTACH     _IOWR('F', 0, struct vn_ioctl)  /* attach file */
 106 #define VNIOCDETACH     _IOWR('F', 1, struct vn_ioctl)  /* detach disk */
 107 #define VNIOCGSET       _IOWR('F', 2, u_long )          /* set global option */
 108 #define VNIOCGCLEAR     _IOWR('F', 3, u_long )          /* reset --//-- */
 109 #define VNIOCUSET       _IOWR('F', 4, u_long )          /* set unit option */
 110 #define VNIOCUCLEAR     _IOWR('F', 5, u_long )          /* reset --//-- */
 111 #define VNIOCGET        _IOWR('F', 6, struct vn_user)   /* get disk info */
 112
 113 #define VN_FOLLOW       0x2     /* Debug flow in vn driver */
 114 #define VN_DEBUG        0x4     /* Debug data in vn driver */
 115 #define VN_IO           0x8     /* Debug I/O in vn driver */
 116 #define VN_DONTCLUSTER  0x10    /* Don't cluster */
 117 #define VN_RESERVE      0x20    /* Pre-reserve swap */
 118
 119 #endif  /* _SYS_VNIOCTL_H_*/