source4/ntvfs/posix/vfs_posix.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    POSIX NTVFS backend - structure definitions
   5
   6    Copyright (C) Andrew Tridgell 2004
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 #ifndef _VFS_POSIX_H_
  24 #define _VFS_POSIX_H_
  25
  26 #include "librpc/gen_ndr/xattr.h"
  27 #include "system/filesys.h"
  28 #include "smb_server/smb_server.h"
  29 #include "ntvfs/ntvfs.h"
  30
  31 /* this is the private structure for the posix vfs backend. It is used
  32    to hold per-connection (per tree connect) state information */
  33 struct pvfs_state {
  34         struct ntvfs_module_context *ntvfs;
  35         const char *base_directory;
  36         struct GUID *base_fs_uuid;
  37
  38         const char *share_name;
  39         uint_t flags;
  40
  41         struct pvfs_mangle_context *mangle_ctx;
  42
  43         struct brl_context *brl_context;
  44         struct odb_context *odb_context;
  45         struct sidmap_context *sidmap;
  46
  47         /* a list of pending async requests. Needed to support
  48            ntcancel */
  49         struct pvfs_wait *wait_list;
  50
  51         /* the sharing violation timeout */
  52         uint_t sharing_violation_delay;
  53
  54         /* filesystem attributes (see FS_ATTR_*) */
  55         uint32_t fs_attribs;
  56
  57         /* if posix:eadb is set, then this gets setup */
  58         struct tdb_wrap *ea_db;
  59
  60         /* the allocation size rounding */
  61         uint32_t alloc_size_rounding;
  62
  63         struct {
  64                 /* an id tree mapping open file handle -> struct pvfs_file */
  65                 struct idr_context *idtree;
  66
  67                 /* the open files as DLINKLIST */
  68                 struct pvfs_file *list;
  69         } files;
  70
  71         struct {
  72                 /* an id tree mapping open search ID to a pvfs_search_state structure */
  73                 struct idr_context *idtree;
  74
  75                 /* the open searches as DLINKLIST */
  76                 struct pvfs_search_state *list;
  77
  78                 /* how long to keep inactive searches around for */
  79                 uint_t inactivity_time;
  80         } search;
  81
  82         /* used to accelerate acl mapping */
  83         struct {
  84                 const struct dom_sid *creator_owner;
  85                 const struct dom_sid *creator_group;
  86         } sid_cache;
  87 };
  88
  89 /* this is the basic information needed about a file from the filesystem */
  90 struct pvfs_dos_fileinfo {
  91         NTTIME create_time;
  92         NTTIME access_time;
  93         NTTIME write_time;
  94         NTTIME change_time;
  95         uint32_t attrib;
  96         uint64_t alloc_size;
  97         uint32_t nlink;
  98         uint32_t ea_size;
  99         uint64_t file_id;
 100         uint32_t flags;
 101 };
 102
 103 /*
 104   this is the structure returned by pvfs_resolve_name(). It holds the posix details of
 105   a filename passed by the client to any function
 106 */
 107 struct pvfs_filename {
 108         const char *original_name;
 109         char *full_name;
 110         const char *stream_name; /* does not include :$DATA suffix */
 111         uint32_t stream_id;      /* this uses a hash, so is probabilistic */
 112         BOOL has_wildcard;
 113         BOOL exists;          /* true if the base filename exists */
 114         BOOL stream_exists;   /* true if the stream exists */
 115         struct stat st;
 116         struct pvfs_dos_fileinfo dos;
 117 };
 118
 119
 120 /* open file handle state - encapsulates the posix fd
 121
 122    Note that this is separated from the pvfs_file structure in order
 123    to cope with the openx DENY_DOS semantics where a 2nd DENY_DOS open
 124    on the same connection gets the same low level filesystem handle,
 125    rather than a new handle
 126 */
 127 struct pvfs_file_handle {
 128         int fd;
 129
 130         struct pvfs_filename *name;
 131
 132         /* a unique file key to be used for open file locking */
 133         DATA_BLOB odb_locking_key;
 134
 135         /* a unique file key to be used for byte range locking */
 136         DATA_BLOB brl_locking_key;
 137
 138         uint32_t create_options;
 139
 140         /* this is set by the mode_information level. What does it do? */
 141         uint32_t mode;
 142
 143         /* yes, we need 2 independent positions ... */
 144         uint64_t seek_offset;
 145         uint64_t position;
 146
 147         BOOL have_opendb_entry;
 148
 149         /* we need this hook back to our parent for lock destruction */
 150         struct pvfs_state *pvfs;
 151
 152         /* have we set a sticky write time that we should remove on close */
 153         BOOL sticky_write_time;
 154 };
 155
 156 /* open file state */
 157 struct pvfs_file {
 158         struct pvfs_file *next, *prev;
 159         struct pvfs_file_handle *handle;
 160         uint16_t fnum;
 161
 162         struct pvfs_state *pvfs;
 163
 164         uint32_t impersonation;
 165         uint32_t share_access;
 166         uint32_t access_mask;
 167
 168         /* we need to remember the session it was opened on,
 169            as it is illegal to operate on someone elses fnum */
 170         struct auth_session_info *session_info;
 171
 172         /* we need to remember the client pid that
 173            opened the file so SMBexit works */
 174         uint16_t smbpid;
 175
 176         /* a list of pending locks - used for locking cancel operations */
 177         struct pvfs_pending_lock *pending_list;
 178
 179         /* a count of active locks - used to avoid calling brl_close on
 180            file close */
 181         uint64_t lock_count;
 182 };
 183
 184 /* the state of a search started with pvfs_search_first() */
 185 struct pvfs_search_state {
 186         struct pvfs_search_state *prev, *next;
 187         struct pvfs_state *pvfs;
 188         uint16_t handle;
 189         uint_t current_index;
 190         uint16_t search_attrib;
 191         uint16_t must_attrib;
 192         struct pvfs_dir *dir;
 193         time_t last_used;
 194         uint_t num_ea_names;
 195         struct ea_name *ea_names;
 196         struct timed_event *te;
 197 };
 198
 199 /* flags to pvfs_resolve_name() */
 200 #define PVFS_RESOLVE_WILDCARD    (1<<0)
 201 #define PVFS_RESOLVE_STREAMS     (1<<1)
 202
 203 /* flags in pvfs->flags */
 204 #define PVFS_FLAG_CI_FILESYSTEM  (1<<0) /* the filesystem is case insensitive */
 205 #define PVFS_FLAG_MAP_ARCHIVE    (1<<1)
 206 #define PVFS_FLAG_MAP_SYSTEM     (1<<2)
 207 #define PVFS_FLAG_MAP_HIDDEN     (1<<3)
 208 #define PVFS_FLAG_READONLY       (1<<4)
 209 #define PVFS_FLAG_STRICT_SYNC    (1<<5)
 210 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
 211 #define PVFS_FLAG_XATTR_ENABLE   (1<<7)
 212 #define PVFS_FLAG_FAKE_OPLOCKS   (1<<8)
 213
 214 /* forward declare some anonymous structures */
 215 struct pvfs_dir;
 216
 217 /* types of notification for pvfs wait events */
 218 enum pvfs_wait_notice {PVFS_WAIT_EVENT, PVFS_WAIT_TIMEOUT, PVFS_WAIT_CANCEL};
 219
 220 #include "ntvfs/posix/vfs_posix_proto.h"
 221
 222 #endif /* _VFS_POSIX_H_ */