include/sys/gfs.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  24  */
  25
  26 /*
  27  * These are Consolidation Private interfaces and are subject to change.
  28  */
  29
  30 #ifndef _SYS_GFS_H
  31 #define _SYS_GFS_H
  32
  33 #include <sys/types.h>
  34 #include <sys/vnode.h>
  35 #include <sys/vfs.h>
  36 #include <sys/mutex.h>
  37 #include <sys/dirent.h>
  38 #include <sys/extdirent.h>
  39 #include <sys/uio.h>
  40 #include <sys/list.h>
  41 #include <sys/pathname.h>
  42
  43 #ifdef  __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #define GFS_CACHE_VNODE         0x1
  48
  49 typedef struct gfs_dirent {
  50         char                    *gfse_name;     /* entry name */
  51         vnode_t *(*gfse_ctor)(vnode_t *);       /* constructor */
  52         int                     gfse_flags;     /* flags */
  53         list_node_t             gfse_link;      /* dynamic list */
  54         vnode_t                 *gfse_vnode;    /* cached vnode */
  55 } gfs_dirent_t;
  56
  57 typedef enum gfs_type {
  58         GFS_DIR,
  59         GFS_FILE
  60 } gfs_type_t;
  61
  62 typedef struct gfs_file {
  63         vnode_t         *gfs_vnode;     /* current vnode */
  64         vnode_t         *gfs_parent;    /* parent vnode */
  65         size_t          gfs_size;       /* size of private data structure */
  66         gfs_type_t      gfs_type;       /* type of vnode */
  67         int             gfs_index;      /* index in parent dir */
  68         ino64_t         gfs_ino;        /* inode for this vnode */
  69 } gfs_file_t;
  70
  71 typedef int (*gfs_readdir_cb)(vnode_t *, void *, int *, offset_t *,
  72     offset_t *, void *, int);
  73 typedef int (*gfs_lookup_cb)(vnode_t *, const char *, vnode_t **, ino64_t *,
  74     cred_t *, int, int *, pathname_t *);
  75 typedef ino64_t (*gfs_inode_cb)(vnode_t *, int);
  76
  77 typedef struct gfs_dir {
  78         gfs_file_t      gfsd_file;      /* generic file attributes */
  79         gfs_dirent_t    *gfsd_static;   /* statically defined entries */
  80         int             gfsd_nstatic;   /* # static entries */
  81         kmutex_t        gfsd_lock;      /* protects entries */
  82         int             gfsd_maxlen;    /* maximum name length */
  83         gfs_readdir_cb  gfsd_readdir;   /* readdir() callback */
  84         gfs_lookup_cb   gfsd_lookup;    /* lookup() callback */
  85         gfs_inode_cb    gfsd_inode;     /* get an inode number */
  86 } gfs_dir_t;
  87
  88 struct vfs;
  89
  90 extern struct vnode *gfs_file_create(size_t, struct vnode *,
  91     const struct vnodeops *);
  92 extern struct vnode *gfs_dir_create(size_t, struct vnode *,
  93     const struct vnodeops *,
  94     gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
  95 extern struct vnode *gfs_root_create(size_t, struct vfs *,
  96     const struct vnodeops *, ino64_t,
  97     gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
  98 extern struct vnode *gfs_root_create_file(size_t, struct vfs *,
  99     const struct vnodeops *, ino64_t);
 100
 101 extern void *gfs_file_inactive(vnode_t *);
 102 extern void *gfs_dir_inactive(vnode_t *);
 103
 104 extern int gfs_dir_case_lookup(vnode_t *, const char *, vnode_t **, cred_t *,
 105     int, int *, pathname_t *);
 106 extern int gfs_dir_lookup(vnode_t *, const char *, vnode_t **, cred_t *,
 107     int, int *, pathname_t *);
 108 extern int gfs_dir_readdir(vnode_t *, uio_t *, int *, void *, cred_t *,
 109     caller_context_t *, int flags);
 110
 111 #define gfs_dir_lock(gd)        mutex_enter(&(gd)->gfsd_lock)
 112 #define gfs_dir_unlock(gd)      mutex_exit(&(gd)->gfsd_lock)
 113 #define GFS_DIR_LOCKED(gd)      MUTEX_HELD(&(gd)->gfsd_lock)
 114
 115 #define gfs_file_parent(vp)     (((gfs_file_t *)(vp)->v_data)->gfs_parent)
 116
 117 #define gfs_file_index(vp)      (((gfs_file_t *)(vp)->v_data)->gfs_index)
 118 #define gfs_file_set_index(vp, idx)     \
 119         (((gfs_file_t *)(vp)->v_data)->gfs_index = (idx))
 120
 121 #define gfs_file_inode(vp)      (((gfs_file_t *)(vp)->v_data)->gfs_ino)
 122 #define gfs_file_set_inode(vp, ino)     \
 123         (((gfs_file_t *)(vp)->v_data)->gfs_ino = (ino))
 124
 125 typedef struct gfs_readdir_state {
 126         void            *grd_dirent;    /* directory entry buffer */
 127         size_t          grd_namlen;     /* max file name length */
 128         size_t          grd_ureclen;    /* exported record size */
 129         ssize_t         grd_oresid;     /* original uio_resid */
 130         ino64_t         grd_parent;     /* inode of parent */
 131         ino64_t         grd_self;       /* inode of self */
 132         int             grd_flags;      /* flags from fop_readdir */
 133 } gfs_readdir_state_t;
 134
 135 extern int gfs_readdir_init(gfs_readdir_state_t *, int, int, uio_t *, ino64_t,
 136     ino64_t, int);
 137 extern int gfs_readdir_emit(gfs_readdir_state_t *, uio_t *, offset_t, ino64_t,
 138     const char *, int);
 139 extern int gfs_readdir_emitn(gfs_readdir_state_t *, uio_t *, offset_t, ino64_t,
 140     unsigned long);
 141 extern int gfs_readdir_pred(gfs_readdir_state_t *, uio_t *, offset_t *);
 142 extern int gfs_readdir_fini(gfs_readdir_state_t *, int, int *, int);
 143 extern int gfs_get_parent_ino(vnode_t *, cred_t *, caller_context_t *,
 144     ino64_t *, ino64_t *);
 145
 146 /*
 147  * Objects with real extended attributes will get their . and ..
 148  * readdir entries from the real xattr directory. GFS_STATIC_ENTRY_OFFSET
 149  * lets us skip right to the static entries in the GFS directory.
 150  */
 151 #define GFS_STATIC_ENTRY_OFFSET ((offset_t)2)
 152
 153 extern int gfs_lookup_dot(vnode_t **, vnode_t *, vnode_t *, const char *);
 154
 155 extern int gfs_vop_lookup(vnode_t *, char *, vnode_t **, pathname_t *,
 156     int, vnode_t *, cred_t *, caller_context_t *, int *, pathname_t *);
 157 extern int gfs_vop_readdir(vnode_t *, uio_t *, cred_t *, int *,
 158     caller_context_t *, int);
 159 extern int gfs_vop_map(vnode_t *, offset_t, struct as *, caddr_t *,
 160     size_t, uchar_t, uchar_t, uint_t, cred_t *, caller_context_t *);
 161 extern void gfs_vop_inactive(vnode_t *, cred_t *, caller_context_t *);
 162
 163
 164 #ifdef  __cplusplus
 165 }
 166 #endif
 167
 168 #endif  /* _SYS_GFS_H */