sys/fs/ptyfs/ptyfs.h

   1 /*      $NetBSD: ptyfs.h,v 1.7 2008/06/28 01:34:05 rumble Exp $ */
   2
   3 /*
   4  * Copyright (c) 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Jan-Simon Pendry.
   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. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
  35  */
  36
  37 /*
  38  * Copyright (c) 1993 Jan-Simon Pendry
  39  *
  40  * This code is derived from software contributed to Berkeley by
  41  * Jan-Simon Pendry.
  42  *
  43  * Redistribution and use in source and binary forms, with or without
  44  * modification, are permitted provided that the following conditions
  45  * are met:
  46  * 1. Redistributions of source code must retain the above copyright
  47  *    notice, this list of conditions and the following disclaimer.
  48  * 2. Redistributions in binary form must reproduce the above copyright
  49  *    notice, this list of conditions and the following disclaimer in the
  50  *    documentation and/or other materials provided with the distribution.
  51  * 3. All advertising materials mentioning features or use of this software
  52  *    must display the following acknowledgement:
  53  *      This product includes software developed by the University of
  54  *      California, Berkeley and its contributors.
  55  * 4. Neither the name of the University nor the names of its contributors
  56  *    may be used to endorse or promote products derived from this software
  57  *    without specific prior written permission.
  58  *
  59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  69  * SUCH DAMAGE.
  70  *
  71  *      @(#)procfs.h    8.9 (Berkeley) 5/14/95
  72  */
  73
  74 #ifndef _FS_PTYFS_PTYFS_H_
  75 #define _FS_PTYFS_PTYFS_H_
  76
  77 #ifdef _KERNEL
  78 /*
  79  * The different types of node in a ptyfs filesystem
  80  */
  81 typedef enum {
  82         PTYFSpts,       /* The slave side of a pty */
  83         PTYFSptc,       /* The controlling side of a pty */
  84         PTYFSroot,      /* the filesystem root */
  85 } ptyfstype;
  86
  87 /*
  88  * control data for the proc file system.
  89  */
  90 struct ptyfsnode {
  91         LIST_ENTRY(ptyfsnode) ptyfs_hash;       /* hash chain */
  92         struct vnode    *ptyfs_vnode;   /* vnode associated with this ptyfsnode */
  93         ptyfstype       ptyfs_type;     /* type of ptyfs node */
  94         int             ptyfs_pty;      /* the pty index */
  95         u_long          ptyfs_fileno;   /* unique file id */
  96         int             ptyfs_flag;     /* status flag for times */
  97 #define PTYFS_ACCESS    1
  98 #define PTYFS_MODIFY    2
  99 #define PTYFS_CHANGE    4
 100         /* Attribute information */
 101         uid_t           ptyfs_uid;
 102         gid_t           ptyfs_gid;
 103         mode_t          ptyfs_mode;
 104         int             ptyfs_flags;
 105         struct timespec ptyfs_ctime, ptyfs_mtime, ptyfs_atime, ptyfs_birthtime;
 106 };
 107
 108 struct ptyfsmount {
 109         gid_t pmnt_gid;
 110         mode_t pmnt_mode;
 111         int pmnt_flags;
 112 };
 113
 114 #define VFSTOPTY(mp)    ((struct ptyfsmount *)(mp)->mnt_data)
 115
 116 #endif /* _KERNEL */
 117
 118 struct ptyfs_args {
 119         int version;
 120         gid_t gid;
 121         mode_t mode;
 122         int flags;
 123 };
 124
 125 #define PTYFS_ARGSVERSION       2
 126
 127 #define PTYFSMNT_CHROOT         0x01
 128
 129 #define PTYFSMNT_BITS "\177\20" \
 130     "b\00chroot\0"
 131
 132 /*
 133  * Kernel stuff follows
 134  */
 135 #ifdef _KERNEL
 136
 137 #define UIO_MX 32
 138
 139 #define PTYFS_FILENO(pty, type) \
 140     ((type == PTYFSroot) ? 2 : \
 141      ((((pty) + 1) * 2 + (((type) == PTYFSpts) ? 1 : 2))))
 142
 143 #define PTYFS_MAKEDEV(ptyfs) \
 144     pty_makedev((ptyfs)->ptyfs_type == PTYFSpts ? 't' : 'p', (ptyfs)->ptyfs_pty)
 145
 146 #define PTYFS_ITIMES(ptyfs, acc, mod, cre) \
 147    while ((ptyfs)->ptyfs_flag & (PTYFS_ACCESS|PTYFS_CHANGE|PTYFS_MODIFY)) \
 148         ptyfs_itimes(ptyfs, acc, mod, cre)
 149 /*
 150  * Convert between ptyfsnode vnode
 151  */
 152 #define VTOPTYFS(vp)    ((struct ptyfsnode *)(vp)->v_data)
 153 #define PTYFSTOV(ptyfs) ((ptyfs)->ptyfs_vnode)
 154
 155 int ptyfs_freevp(struct vnode *);
 156 int ptyfs_allocvp(struct mount *, struct vnode **, ptyfstype, int,
 157     struct lwp *);
 158 void ptyfs_hashinit(void);
 159 void ptyfs_hashreinit(void);
 160 void ptyfs_hashdone(void);
 161 void ptyfs_itimes(struct ptyfsnode *, const struct timespec *,
 162     const struct timespec *, const struct timespec *);
 163
 164 extern int (**ptyfs_vnodeop_p)(void *);
 165 extern struct vfsops ptyfs_vfsops;
 166
 167 int     ptyfs_root(struct mount *, struct vnode **);
 168
 169 #endif /* _KERNEL */
 170 #endif /* _FS_PTYFS_PTYFS_H_ */