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 3 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, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef _VFS_POSIX_H_
  23 #define _VFS_POSIX_H_
  24
  25 #include "librpc/gen_ndr/xattr.h"
  26 #include "system/filesys.h"
  27 #include "ntvfs/ntvfs.h"
  28 #include "ntvfs/common/ntvfs_common.h"
  29 #include "libcli/wbclient/wbclient.h"
  30 #include "lib/events/events.h"
  31
  32 struct pvfs_wait;
  33 struct pvfs_oplock;
  34
  35 /* this is the private structure for the posix vfs backend. It is used
  36    to hold per-connection (per tree connect) state information */
  37 struct pvfs_state {
  38         struct ntvfs_module_context *ntvfs;
  39         const char *base_directory;
  40         struct GUID *base_fs_uuid;
  41
  42         const char *share_name;
  43         unsigned int flags;
  44
  45         struct pvfs_mangle_context *mangle_ctx;
  46
  47         struct brl_context *brl_context;
  48         struct odb_context *odb_context;
  49         struct notify_context *notify_context;
  50         struct wbc_context *wbc_ctx;
  51
  52         /* a list of pending async requests. Needed to support
  53            ntcancel */
  54         struct pvfs_wait *wait_list;
  55
  56         /* the sharing violation timeout (nsecs) */
  57         unsigned int sharing_violation_delay;
  58
  59         /* the oplock break timeout (secs) */
  60         unsigned int oplock_break_timeout;
  61
  62         /* the write time update delay (nsecs) */
  63         unsigned int writetime_delay;
  64
  65         /* filesystem attributes (see FS_ATTR_*) */
  66         uint32_t fs_attribs;
  67
  68         /* if posix:eadb is set, then this gets setup */
  69         struct tdb_wrap *ea_db;
  70
  71         /* the allocation size rounding */
  72         uint32_t alloc_size_rounding;
  73
  74         struct {
  75                 /* the open files as DLINKLIST */
  76                 struct pvfs_file *list;
  77         } files;
  78
  79         struct {
  80                 /* an id tree mapping open search ID to a pvfs_search_state structure */
  81                 struct idr_context *idtree;
  82
  83                 /* the open searches as DLINKLIST */
  84                 struct pvfs_search_state *list;
  85
  86                 /* how long to keep inactive searches around for */
  87                 unsigned int inactivity_time;
  88         } search;
  89
  90         /* used to accelerate acl mapping */
  91         struct {
  92                 const struct dom_sid *creator_owner;
  93                 const struct dom_sid *creator_group;
  94         } sid_cache;
  95
  96         /* the acl backend */
  97         const struct pvfs_acl_ops *acl_ops;
  98
  99         /* non-flag share options */
 100         struct {
 101                 mode_t dir_mask;
 102                 mode_t force_dir_mode;
 103                 mode_t create_mask;
 104                 mode_t force_create_mode;
 105         } options;
 106 };
 107
 108 /* this is the basic information needed about a file from the filesystem */
 109 struct pvfs_dos_fileinfo {
 110         NTTIME create_time;
 111         NTTIME access_time;
 112         NTTIME write_time;
 113         NTTIME change_time;
 114         uint32_t attrib;
 115         uint64_t alloc_size;
 116         uint32_t nlink;
 117         uint32_t ea_size;
 118         uint64_t file_id;
 119         uint32_t flags;
 120 };
 121
 122 /*
 123   this is the structure returned by pvfs_resolve_name(). It holds the posix details of
 124   a filename passed by the client to any function
 125 */
 126 struct pvfs_filename {
 127         char *original_name;
 128         char *full_name;
 129         char *stream_name; /* does not include :$DATA suffix */
 130         uint32_t stream_id;      /* this uses a hash, so is probabilistic */
 131         bool has_wildcard;
 132         bool exists;          /* true if the base filename exists */
 133         bool stream_exists;   /* true if the stream exists */
 134         bool allow_override;
 135         struct stat st;
 136         struct pvfs_dos_fileinfo dos;
 137 };
 138
 139
 140 /* open file handle state - encapsulates the posix fd
 141
 142    Note that this is separated from the pvfs_file structure in order
 143    to cope with the openx DENY_DOS semantics where a 2nd DENY_DOS open
 144    on the same connection gets the same low level filesystem handle,
 145    rather than a new handle
 146 */
 147 struct pvfs_file_handle {
 148         int fd;
 149
 150         struct pvfs_filename *name;
 151
 152         /* a unique file key to be used for open file locking */
 153         DATA_BLOB odb_locking_key;
 154
 155         uint32_t create_options;
 156
 157         /* this is set by the mode_information level. What does it do? */
 158         uint32_t mode;
 159
 160         /* yes, we need 2 independent positions ... */
 161         uint64_t seek_offset;
 162         uint64_t position;
 163
 164         bool have_opendb_entry;
 165
 166         /*
 167          * we need to wait for oplock break requests from other processes,
 168          * and we need to remember the pvfs_file so we can correctly
 169          * forward the oplock break to the client
 170          */
 171         struct pvfs_oplock *oplock;
 172
 173         /* we need this hook back to our parent for lock destruction */
 174         struct pvfs_state *pvfs;
 175
 176         struct {
 177                 bool update_triggered;
 178                 struct tevent_timer *update_event;
 179                 bool update_on_close;
 180                 NTTIME close_time;
 181                 bool update_forced;
 182         } write_time;
 183
 184         /* the open went through to completion */
 185         bool open_completed;
 186
 187         uint8_t private_flags;
 188 };
 189
 190 /* open file state */
 191 struct pvfs_file {
 192         struct pvfs_file *next, *prev;
 193         struct pvfs_file_handle *handle;
 194         struct ntvfs_handle *ntvfs;
 195
 196         struct pvfs_state *pvfs;
 197
 198         uint32_t impersonation;
 199         uint32_t share_access;
 200         uint32_t access_mask;
 201
 202         /* a list of pending locks - used for locking cancel operations */
 203         struct pvfs_pending_lock *pending_list;
 204
 205         /* a file handle to be used for byte range locking */
 206         struct brl_handle *brl_handle;
 207
 208         /* a count of active locks - used to avoid calling brlock_close on
 209            file close */
 210         uint64_t lock_count;
 211
 212         /* for directories, a buffer of pending notify events */
 213         struct pvfs_notify_buffer *notify_buffer;
 214
 215         /* for directories, the state of an incomplete SMB2 Find */
 216         struct pvfs_search_state *search;
 217 };
 218
 219 /* the state of a search started with pvfs_search_first() */
 220 struct pvfs_search_state {
 221         struct pvfs_search_state *prev, *next;
 222         struct pvfs_state *pvfs;
 223         uint16_t handle;
 224         off_t current_index;
 225         uint16_t search_attrib;
 226         uint16_t must_attrib;
 227         struct pvfs_dir *dir;
 228         time_t last_used; /* monotonic clock time */
 229         unsigned int num_ea_names;
 230         struct ea_name *ea_names;
 231         struct tevent_timer *te;
 232 };
 233
 234 /* flags to pvfs_resolve_name() */
 235 #define PVFS_RESOLVE_WILDCARD    (1<<0)
 236 #define PVFS_RESOLVE_STREAMS     (1<<1)
 237 #define PVFS_RESOLVE_NO_OPENDB   (1<<2)
 238
 239 /* flags in pvfs->flags */
 240 #define PVFS_FLAG_CI_FILESYSTEM  (1<<0) /* the filesystem is case insensitive */
 241 #define PVFS_FLAG_MAP_ARCHIVE    (1<<1)
 242 #define PVFS_FLAG_MAP_SYSTEM     (1<<2)
 243 #define PVFS_FLAG_MAP_HIDDEN     (1<<3)
 244 #define PVFS_FLAG_READONLY       (1<<4)
 245 #define PVFS_FLAG_STRICT_SYNC    (1<<5)
 246 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
 247 #define PVFS_FLAG_XATTR_ENABLE   (1<<7)
 248 #define PVFS_FLAG_FAKE_OPLOCKS   (1<<8)
 249 #define PVFS_FLAG_LINUX_AIO      (1<<9)
 250 #define PVFS_FLAG_PERM_OVERRIDE  (1<<10)
 251
 252 /* forward declare some anonymous structures */
 253 struct pvfs_dir;
 254
 255 /* types of notification for pvfs wait events */
 256 enum pvfs_wait_notice {PVFS_WAIT_EVENT, PVFS_WAIT_TIMEOUT, PVFS_WAIT_CANCEL};
 257
 258 /*
 259   state of a pending retry
 260 */
 261 struct pvfs_odb_retry;
 262
 263 #define PVFS_EADB                       "posix:eadb"
 264 #define PVFS_XATTR                      "posix:xattr"
 265 #define PVFS_FAKE_OPLOCKS               "posix:fakeoplocks"
 266 #define PVFS_SHARE_DELAY                "posix:sharedelay"
 267 #define PVFS_OPLOCK_TIMEOUT             "posix:oplocktimeout"
 268 #define PVFS_WRITETIME_DELAY            "posix:writetimeupdatedelay"
 269 #define PVFS_ALLOCATION_ROUNDING        "posix:allocationrounding"
 270 #define PVFS_SEARCH_INACTIVITY          "posix:searchinactivity"
 271 #define PVFS_ACL                        "posix:acl"
 272 #define PVFS_AIO                        "posix:aio"
 273 #define PVFS_PERM_OVERRIDE              "posix:permission override"
 274
 275 #define PVFS_XATTR_DEFAULT                      true
 276 #define PVFS_FAKE_OPLOCKS_DEFAULT               false
 277 #define PVFS_SHARE_DELAY_DEFAULT                1000000 /* nsecs */
 278 #define PVFS_OPLOCK_TIMEOUT_DEFAULT             30 /* secs */
 279 #define PVFS_WRITETIME_DELAY_DEFAULT            2000000 /* nsecs */
 280 #define PVFS_ALLOCATION_ROUNDING_DEFAULT        512
 281 #define PVFS_SEARCH_INACTIVITY_DEFAULT          300
 282
 283 struct pvfs_acl_ops {
 284         const char *name;
 285         NTSTATUS (*acl_load)(struct pvfs_state *, struct pvfs_filename *, int , TALLOC_CTX *,
 286                              struct security_descriptor **);
 287         NTSTATUS (*acl_save)(struct pvfs_state *, struct pvfs_filename *, int , struct security_descriptor *);
 288 };
 289
 290 #include "ntvfs/posix/vfs_posix_proto.h"
 291 #include "ntvfs/posix/vfs_acl_proto.h"
 292
 293 NTSTATUS pvfs_aio_pread(struct ntvfs_request *req, union smb_read *rd,
 294                         struct pvfs_file *f, uint32_t maxcnt);
 295 NTSTATUS pvfs_aio_pwrite(struct ntvfs_request *req, union smb_write *wr,
 296                          struct pvfs_file *f);
 297
 298 #endif /* _VFS_POSIX_H_ */