r4464: added pvfs backend support for the special CREATOR_OWNER and CREATOR_GROUP...
[samba.git] / 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 "smb_server/smb_server.h"
27
28 /* this is the private structure for the posix vfs backend. It is used
29    to hold per-connection (per tree connect) state information */
30 struct pvfs_state {
31         struct smbsrv_tcon *tcon;
32         const char *base_directory;
33
34         const char *share_name;
35         uint_t flags;
36
37         struct pvfs_file *open_files;
38
39         struct pvfs_mangle_context *mangle_ctx;
40
41         struct brl_context *brl_context;
42         struct odb_context *odb_context;
43         struct sidmap_context *sidmap;
44
45         /* an id tree mapping open search ID to a pvfs_search_state structure */
46         struct idr_context *idtree_search;
47
48         /* an id tree mapping open file handle -> struct pvfs_file */
49         struct idr_context *idtree_fnum;
50
51         /* a list of pending async requests. Needed to support
52            ntcancel */
53         struct pvfs_wait *wait_list;
54
55         /* the sharing violation timeout */
56         uint_t sharing_violation_delay;
57
58         /* filesystem attributes (see FS_ATTR_*) */
59         uint32_t fs_attribs;
60
61         /* if posix:eadb is set, then this gets setup */
62         struct tdb_wrap *ea_db;
63
64         /* used to accelerate acl mapping */
65         struct {
66                 const struct dom_sid *creator_owner;
67                 const struct dom_sid *creator_group;            
68         } sid_cache;
69 };
70
71 /* this is the basic information needed about a file from the filesystem */
72 struct pvfs_dos_fileinfo {
73         NTTIME create_time;
74         NTTIME access_time;
75         NTTIME write_time;
76         NTTIME change_time;
77         uint32_t attrib;
78         uint64_t alloc_size;
79         uint32_t nlink;
80         uint32_t ea_size;
81         uint64_t file_id;
82         uint32_t flags;
83 };
84
85 /*
86   this is the structure returned by pvfs_resolve_name(). It holds the posix details of
87   a filename passed by the client to any function
88 */
89 struct pvfs_filename {
90         const char *original_name;
91         char *full_name;
92         const char *stream_name; /* does not include :$DATA suffix */
93         uint32_t stream_id;      /* this uses a hash, so is probabilistic */
94         BOOL has_wildcard;
95         BOOL exists;          /* true if the base filename exists */
96         BOOL stream_exists;   /* true if the stream exists */
97         struct stat st;
98         struct pvfs_dos_fileinfo dos;
99 };
100
101
102 /* open file handle state - encapsulates the posix fd
103
104    Note that this is separated from the pvfs_file structure in order
105    to cope with the openx DENY_DOS semantics where a 2nd DENY_DOS open
106    on the same connection gets the same low level filesystem handle,
107    rather than a new handle
108 */
109 struct pvfs_file_handle {
110         int fd;
111
112         struct pvfs_filename *name;
113
114         /* a unique file key to be used for open file locking */
115         DATA_BLOB odb_locking_key;
116
117         /* a unique file key to be used for byte range locking */
118         DATA_BLOB brl_locking_key;
119
120         uint32_t create_options;
121
122         /* this is set by the mode_information level. What does it do? */
123         uint32_t mode;
124
125         /* yes, we need 2 independent positions ... */
126         uint64_t seek_offset;
127         uint64_t position;
128
129         BOOL have_opendb_entry;
130
131         /* we need this hook back to our parent for lock destruction */
132         struct pvfs_state *pvfs;
133
134         /* have we set a sticky write time that we should remove on close */
135         BOOL sticky_write_time;
136 };
137
138 /* open file state */
139 struct pvfs_file {
140         struct pvfs_file *next, *prev;
141         struct pvfs_file_handle *handle;
142         uint16_t fnum;
143
144         struct pvfs_state *pvfs;
145
146         uint32_t impersonation;
147         uint32_t share_access;
148         uint32_t access_mask;
149
150         /* we need to remember the session it was opened on,
151            as it is illegal to operate on someone elses fnum */
152         struct smbsrv_session *session;
153
154         /* we need to remember the client pid that 
155            opened the file so SMBexit works */
156         uint16_t smbpid;
157
158         /* a list of pending locks - used for locking cancel operations */
159         struct pvfs_pending_lock *pending_list;
160
161         /* a count of active locks - used to avoid calling brl_close on
162            file close */
163         uint64_t lock_count;
164 };
165
166
167 struct pvfs_mangle_context {
168         uint8_t char_flags[256];
169         /*
170           this determines how many characters are used from the original
171           filename in the 8.3 mangled name. A larger value leads to a weaker
172           hash and more collisions.  The largest possible value is 6.
173         */
174         int mangle_prefix;
175         uint32_t mangle_modulus;
176
177         /* we will use a very simple direct mapped prefix cache. The big
178            advantage of this cache structure is speed and low memory usage 
179
180            The cache is indexed by the low-order bits of the hash, and confirmed by
181            hashing the resulting cache entry to match the known hash
182         */
183         char **prefix_cache;
184         uint32_t *prefix_cache_hashes;
185
186         /* this is used to reverse the base 36 mapping */
187         unsigned char base_reverse[256];
188 };
189
190
191
192 /* flags to pvfs_resolve_name() */
193 #define PVFS_RESOLVE_WILDCARD    (1<<0)
194 #define PVFS_RESOLVE_STREAMS     (1<<1)
195
196 /* flags in pvfs->flags */
197 #define PVFS_FLAG_CI_FILESYSTEM  (1<<0) /* the filesystem is case insensitive */
198 #define PVFS_FLAG_MAP_ARCHIVE    (1<<1)
199 #define PVFS_FLAG_MAP_SYSTEM     (1<<2)
200 #define PVFS_FLAG_MAP_HIDDEN     (1<<3)
201 #define PVFS_FLAG_READONLY       (1<<4)
202 #define PVFS_FLAG_STRICT_SYNC    (1<<5)
203 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
204 #define PVFS_FLAG_XATTR_ENABLE   (1<<7)
205 #define PVFS_FLAG_FAKE_OPLOCKS   (1<<8)
206
207 /* forward declare some anonymous structures */
208 struct pvfs_dir;
209
210 /* types of notification for pvfs wait events */
211 enum pvfs_wait_notice {PVFS_WAIT_EVENT, PVFS_WAIT_TIMEOUT, PVFS_WAIT_CANCEL};
212
213
214 /* putting this prototype here avoids us having to expose this whole header in the
215    rest of Samba */
216 void *pvfs_wait_message(struct pvfs_state *pvfs, 
217                          struct smbsrv_request *req, 
218                          int msg_type, 
219                          struct timeval end_time,
220                          void (*fn)(void *, enum pvfs_wait_notice),
221                          void *private);
222
223 #endif /* _VFS_POSIX_H_ */