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 /* this is the private structure for the posix vfs backend. It is used
  27    to hold per-connection (per tree connect) state information */
  28 struct pvfs_state {
  29         struct smbsrv_tcon *tcon;
  30         const char *base_directory;
  31
  32         const char *share_name;
  33         uint_t flags;
  34
  35         struct pvfs_file *open_files;
  36
  37         struct pvfs_mangle_context *mangle_ctx;
  38
  39         struct brl_context *brl_context;
  40         struct odb_context *odb_context;
  41
  42         /* an id tree mapping open search ID to a pvfs_search_state structure */
  43         struct idr_context *idtree_search;
  44
  45         /* an id tree mapping open file handle -> struct pvfs_file */
  46         struct idr_context *idtree_fnum;
  47 };
  48
  49
  50 /* this is the basic information needed about a file from the filesystem */
  51 struct pvfs_dos_fileinfo {
  52         NTTIME create_time;
  53         NTTIME access_time;
  54         NTTIME write_time;
  55         NTTIME change_time;
  56         uint32_t attrib;
  57         uint64_t alloc_size;
  58         uint32_t nlink;
  59         uint32_t ea_size;
  60         uint64_t file_id;
  61 };
  62
  63 /*
  64   this is the structure returned by pvfs_resolve_name(). It holds the posix details of
  65   a filename passed by the client to any function
  66 */
  67 struct pvfs_filename {
  68         const char *original_name;
  69         char *full_name;
  70         const char *stream_name;
  71         BOOL has_wildcard;
  72         BOOL exists;
  73         struct stat st;
  74         struct pvfs_dos_fileinfo dos;
  75 };
  76
  77
  78 /* the state of a search started with pvfs_search_first() */
  79 struct pvfs_search_state {
  80         struct pvfs_state *pvfs;
  81         uint16_t handle;
  82         uint_t current_index;
  83         uint16_t search_attrib;
  84         uint16_t must_attrib;
  85         struct pvfs_dir *dir;
  86 };
  87
  88 /* open file state */
  89 struct pvfs_file {
  90         struct pvfs_file *next, *prev;
  91         int fd;
  92         uint16_t fnum;
  93         struct pvfs_filename *name;
  94
  95         /* we need to remember the session it was opened on,
  96            as it is illegal to operate on someone elses fnum */
  97         struct smbsrv_session *session;
  98
  99         /* we need to remember the client pid that
 100            opened the file so SMBexit works */
 101         uint16_t smbpid;
 102
 103         /* a unique file key to be used for file locking */
 104         DATA_BLOB locking_key;
 105
 106         /* we need this hook back to our parent for lock destruction */
 107         struct pvfs_state *pvfs;
 108
 109         /* a list of pending locks - used for locking cancel operations */
 110         struct pvfs_pending_lock *pending_list;
 111
 112         /* a count of active locks - used to avoid calling brl_close on
 113            file close */
 114         uint64_t lock_count;
 115
 116         uint32_t create_options;
 117         uint32_t share_access;
 118         uint32_t access_mask;
 119
 120         /* yes, we need 2 independent positions ... */
 121         uint64_t seek_offset;
 122         uint64_t position;
 123 };
 124
 125
 126 struct pvfs_mangle_context {
 127         uint8_t char_flags[256];
 128         /*
 129           this determines how many characters are used from the original
 130           filename in the 8.3 mangled name. A larger value leads to a weaker
 131           hash and more collisions.  The largest possible value is 6.
 132         */
 133         int mangle_prefix;
 134         uint32_t mangle_modulus;
 135
 136         /* we will use a very simple direct mapped prefix cache. The big
 137            advantage of this cache structure is speed and low memory usage
 138
 139            The cache is indexed by the low-order bits of the hash, and confirmed by
 140            hashing the resulting cache entry to match the known hash
 141         */
 142         char **prefix_cache;
 143         uint32_t *prefix_cache_hashes;
 144
 145         /* this is used to reverse the base 36 mapping */
 146         unsigned char base_reverse[256];
 147 };
 148
 149
 150
 151 /* flags to pvfs_resolve_name() */
 152 #define PVFS_RESOLVE_NO_WILDCARD (1<<0)
 153 #define PVFS_RESOLVE_STREAMS     (1<<1)
 154
 155 /* flags in pvfs->flags */
 156 #define PVFS_FLAG_CI_FILESYSTEM  (1<<0) /* the filesystem is case insensitive */
 157 #define PVFS_FLAG_MAP_ARCHIVE    (1<<1)
 158 #define PVFS_FLAG_MAP_SYSTEM     (1<<2)
 159 #define PVFS_FLAG_MAP_HIDDEN     (1<<3)
 160 #define PVFS_FLAG_READONLY       (1<<4)
 161 #define PVFS_FLAG_STRICT_SYNC    (1<<5)
 162 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
 163
 164 #endif /* _VFS_POSIX_H_ */