Fix up the libnet tests.
[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 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 "dsdb/samdb/samdb.h"
30
31 struct pvfs_wait;
32
33 /* this is the private structure for the posix vfs backend. It is used
34    to hold per-connection (per tree connect) state information */
35 struct pvfs_state {
36         struct ntvfs_module_context *ntvfs;
37         const char *base_directory;
38         struct GUID *base_fs_uuid;
39
40         const char *share_name;
41         uint_t flags;
42
43         struct pvfs_mangle_context *mangle_ctx;
44
45         struct brl_context *brl_context;
46         struct odb_context *odb_context;
47         struct notify_context *notify_context;
48         struct sidmap_context *sidmap;
49
50         /* a list of pending async requests. Needed to support
51            ntcancel */
52         struct pvfs_wait *wait_list;
53
54         /* the sharing violation timeout */
55         uint_t sharing_violation_delay;
56
57         /* filesystem attributes (see FS_ATTR_*) */
58         uint32_t fs_attribs;
59
60         /* if posix:eadb is set, then this gets setup */
61         struct tdb_wrap *ea_db;
62
63         /* the allocation size rounding */
64         uint32_t alloc_size_rounding;
65
66         struct {
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         /* the acl backend */
89         const struct pvfs_acl_ops *acl_ops;
90
91         /* non-flag share options */
92         struct {
93                 mode_t dir_mask;
94                 mode_t force_dir_mode;
95                 mode_t create_mask;
96                 mode_t force_create_mode;
97         } options;
98 };
99
100 /* this is the basic information needed about a file from the filesystem */
101 struct pvfs_dos_fileinfo {
102         NTTIME create_time;
103         NTTIME access_time;
104         NTTIME write_time;
105         NTTIME change_time;
106         uint32_t attrib;
107         uint64_t alloc_size;
108         uint32_t nlink;
109         uint32_t ea_size;
110         uint64_t file_id;
111         uint32_t flags;
112 };
113
114 /*
115   this is the structure returned by pvfs_resolve_name(). It holds the posix details of
116   a filename passed by the client to any function
117 */
118 struct pvfs_filename {
119         const char *original_name;
120         char *full_name;
121         const char *stream_name; /* does not include :$DATA suffix */
122         uint32_t stream_id;      /* this uses a hash, so is probabilistic */
123         bool has_wildcard;
124         bool exists;          /* true if the base filename exists */
125         bool stream_exists;   /* true if the stream exists */
126         struct stat st;
127         struct pvfs_dos_fileinfo dos;
128 };
129
130
131 /* open file handle state - encapsulates the posix fd
132
133    Note that this is separated from the pvfs_file structure in order
134    to cope with the openx DENY_DOS semantics where a 2nd DENY_DOS open
135    on the same connection gets the same low level filesystem handle,
136    rather than a new handle
137 */
138 struct pvfs_file_handle {
139         int fd;
140
141         struct pvfs_filename *name;
142
143         /* a unique file key to be used for open file locking */
144         DATA_BLOB odb_locking_key;
145
146         uint32_t create_options;
147
148         /* this is set by the mode_information level. What does it do? */
149         uint32_t mode;
150
151         /* yes, we need 2 independent positions ... */
152         uint64_t seek_offset;
153         uint64_t position;
154
155         bool have_opendb_entry;
156
157         /* we need this hook back to our parent for lock destruction */
158         struct pvfs_state *pvfs;
159
160         /* have we set a sticky write time that we should remove on close */
161         bool sticky_write_time;
162
163         /* the open went through to completion */
164         bool open_completed;
165 };
166
167 /* open file state */
168 struct pvfs_file {
169         struct pvfs_file *next, *prev;
170         struct pvfs_file_handle *handle;
171         struct ntvfs_handle *ntvfs;
172
173         struct pvfs_state *pvfs;
174
175         uint32_t impersonation;
176         uint32_t share_access;
177         uint32_t access_mask;
178
179         /* a list of pending locks - used for locking cancel operations */
180         struct pvfs_pending_lock *pending_list;
181
182         /* a file handle to be used for byte range locking */
183         struct brl_handle *brl_handle;
184
185         /* a count of active locks - used to avoid calling brl_close on
186            file close */
187         uint64_t lock_count;
188
189         /* for directories, a buffer of pending notify events */
190         struct pvfs_notify_buffer *notify_buffer;
191
192         /* for directories, the state of an incomplete SMB2 Find */
193         struct pvfs_search_state *search;
194 };
195
196 /* the state of a search started with pvfs_search_first() */
197 struct pvfs_search_state {
198         struct pvfs_search_state *prev, *next;
199         struct pvfs_state *pvfs;
200         uint16_t handle;
201         off_t current_index;
202         uint16_t search_attrib;
203         uint16_t must_attrib;
204         struct pvfs_dir *dir;
205         time_t last_used;
206         uint_t num_ea_names;
207         struct ea_name *ea_names;
208         struct timed_event *te;
209 };
210
211 /* flags to pvfs_resolve_name() */
212 #define PVFS_RESOLVE_WILDCARD    (1<<0)
213 #define PVFS_RESOLVE_STREAMS     (1<<1)
214
215 /* flags in pvfs->flags */
216 #define PVFS_FLAG_CI_FILESYSTEM  (1<<0) /* the filesystem is case insensitive */
217 #define PVFS_FLAG_MAP_ARCHIVE    (1<<1)
218 #define PVFS_FLAG_MAP_SYSTEM     (1<<2)
219 #define PVFS_FLAG_MAP_HIDDEN     (1<<3)
220 #define PVFS_FLAG_READONLY       (1<<4)
221 #define PVFS_FLAG_STRICT_SYNC    (1<<5)
222 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
223 #define PVFS_FLAG_XATTR_ENABLE   (1<<7)
224 #define PVFS_FLAG_FAKE_OPLOCKS   (1<<8)
225 #define PVFS_FLAG_LINUX_AIO      (1<<9)
226
227 /* forward declare some anonymous structures */
228 struct pvfs_dir;
229
230 /* types of notification for pvfs wait events */
231 enum pvfs_wait_notice {PVFS_WAIT_EVENT, PVFS_WAIT_TIMEOUT, PVFS_WAIT_CANCEL};
232
233 #define PVFS_EADB                       "posix:eadb"
234 #define PVFS_XATTR                      "posix:xattr"
235 #define PVFS_FAKE_OPLOCKS               "posix:fakeoplocks"
236 #define PVFS_SHARE_DELAY                "posix:sharedelay"
237 #define PVFS_ALLOCATION_ROUNDING        "posix:allocationrounding"
238 #define PVFS_SEARCH_INACTIVITY          "posix:searchinactivity"
239 #define PVFS_ACL                        "posix:acl"
240 #define PVFS_AIO                        "posix:aio"
241
242 #define PVFS_XATTR_DEFAULT                      true
243 #define PVFS_FAKE_OPLOCKS_DEFAULT               false
244 #define PVFS_SHARE_DELAY_DEFAULT                1000000
245 #define PVFS_ALLOCATION_ROUNDING_DEFAULT        512
246 #define PVFS_SEARCH_INACTIVITY_DEFAULT          300
247
248 struct pvfs_acl_ops {
249         const char *name;
250         NTSTATUS (*acl_load)(struct pvfs_state *, struct pvfs_filename *, int , TALLOC_CTX *, 
251                              struct security_descriptor **);
252         NTSTATUS (*acl_save)(struct pvfs_state *, struct pvfs_filename *, int , struct security_descriptor *);
253 };
254
255 #include "ntvfs/posix/vfs_posix_proto.h"
256
257 NTSTATUS pvfs_aio_pread(struct ntvfs_request *req, union smb_read *rd,
258                         struct pvfs_file *f, uint32_t maxcnt);
259 NTSTATUS pvfs_aio_pwrite(struct ntvfs_request *req, union smb_write *wr,
260                          struct pvfs_file *f);
261
262 #endif /* _VFS_POSIX_H_ */