2 Unix SMB/CIFS implementation.
4 POSIX NTVFS backend - structure definitions
6 Copyright (C) Andrew Tridgell 2004
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.
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.
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/>.
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"
35 /* this is the private structure for the posix vfs backend. It is used
36 to hold per-connection (per tree connect) state information */
38 struct ntvfs_module_context
*ntvfs
;
39 const char *base_directory
;
40 struct GUID
*base_fs_uuid
;
42 const char *share_name
;
45 struct pvfs_mangle_context
*mangle_ctx
;
47 struct brl_context
*brl_context
;
48 struct odb_context
*odb_context
;
49 struct notify_context
*notify_context
;
50 struct wbc_context
*wbc_ctx
;
52 /* a list of pending async requests. Needed to support
54 struct pvfs_wait
*wait_list
;
56 /* the sharing violation timeout (nsecs) */
57 unsigned int sharing_violation_delay
;
59 /* the oplock break timeout (secs) */
60 unsigned int oplock_break_timeout
;
62 /* the write time update delay (nsecs) */
63 unsigned int writetime_delay
;
65 /* filesystem attributes (see FS_ATTR_*) */
68 /* if posix:eadb is set, then this gets setup */
69 struct tdb_wrap
*ea_db
;
71 /* the allocation size rounding */
72 uint32_t alloc_size_rounding
;
75 /* the open files as DLINKLIST */
76 struct pvfs_file
*list
;
80 /* an id tree mapping open search ID to a pvfs_search_state structure */
81 struct idr_context
*idtree
;
83 /* the open searches as DLINKLIST */
84 struct pvfs_search_state
*list
;
86 /* how long to keep inactive searches around for */
87 unsigned int inactivity_time
;
90 /* used to accelerate acl mapping */
92 const struct dom_sid
*creator_owner
;
93 const struct dom_sid
*creator_group
;
97 const struct pvfs_acl_ops
*acl_ops
;
99 /* non-flag share options */
102 mode_t force_dir_mode
;
104 mode_t force_create_mode
;
108 /* this is the basic information needed about a file from the filesystem */
109 struct pvfs_dos_fileinfo
{
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
126 struct pvfs_filename
{
129 char *stream_name
; /* does not include :$DATA suffix */
130 uint32_t stream_id
; /* this uses a hash, so is probabilistic */
132 bool exists
; /* true if the base filename exists */
133 bool stream_exists
; /* true if the stream exists */
135 struct pvfs_dos_fileinfo dos
;
139 /* open file handle state - encapsulates the posix fd
141 Note that this is separated from the pvfs_file structure in order
142 to cope with the openx DENY_DOS semantics where a 2nd DENY_DOS open
143 on the same connection gets the same low level filesystem handle,
144 rather than a new handle
146 struct pvfs_file_handle
{
149 struct pvfs_filename
*name
;
151 /* a unique file key to be used for open file locking */
152 DATA_BLOB odb_locking_key
;
154 uint32_t create_options
;
156 /* this is set by the mode_information level. What does it do? */
159 /* yes, we need 2 independent positions ... */
160 uint64_t seek_offset
;
163 bool have_opendb_entry
;
166 * we need to wait for oplock break requests from other processes,
167 * and we need to remember the pvfs_file so we can correctly
168 * forward the oplock break to the client
170 struct pvfs_oplock
*oplock
;
172 /* we need this hook back to our parent for lock destruction */
173 struct pvfs_state
*pvfs
;
176 bool update_triggered
;
177 struct tevent_timer
*update_event
;
178 bool update_on_close
;
183 /* the open went through to completion */
186 uint8_t private_flags
;
189 /* open file state */
191 struct pvfs_file
*next
, *prev
;
192 struct pvfs_file_handle
*handle
;
193 struct ntvfs_handle
*ntvfs
;
195 struct pvfs_state
*pvfs
;
197 uint32_t impersonation
;
198 uint32_t share_access
;
199 uint32_t access_mask
;
201 /* a list of pending locks - used for locking cancel operations */
202 struct pvfs_pending_lock
*pending_list
;
204 /* a file handle to be used for byte range locking */
205 struct brl_handle
*brl_handle
;
207 /* a count of active locks - used to avoid calling brl_close on
211 /* for directories, a buffer of pending notify events */
212 struct pvfs_notify_buffer
*notify_buffer
;
214 /* for directories, the state of an incomplete SMB2 Find */
215 struct pvfs_search_state
*search
;
218 /* the state of a search started with pvfs_search_first() */
219 struct pvfs_search_state
{
220 struct pvfs_search_state
*prev
, *next
;
221 struct pvfs_state
*pvfs
;
224 uint16_t search_attrib
;
225 uint16_t must_attrib
;
226 struct pvfs_dir
*dir
;
228 unsigned int num_ea_names
;
229 struct ea_name
*ea_names
;
230 struct tevent_timer
*te
;
233 /* flags to pvfs_resolve_name() */
234 #define PVFS_RESOLVE_WILDCARD (1<<0)
235 #define PVFS_RESOLVE_STREAMS (1<<1)
236 #define PVFS_RESOLVE_NO_OPENDB (1<<2)
238 /* flags in pvfs->flags */
239 #define PVFS_FLAG_CI_FILESYSTEM (1<<0) /* the filesystem is case insensitive */
240 #define PVFS_FLAG_MAP_ARCHIVE (1<<1)
241 #define PVFS_FLAG_MAP_SYSTEM (1<<2)
242 #define PVFS_FLAG_MAP_HIDDEN (1<<3)
243 #define PVFS_FLAG_READONLY (1<<4)
244 #define PVFS_FLAG_STRICT_SYNC (1<<5)
245 #define PVFS_FLAG_STRICT_LOCKING (1<<6)
246 #define PVFS_FLAG_XATTR_ENABLE (1<<7)
247 #define PVFS_FLAG_FAKE_OPLOCKS (1<<8)
248 #define PVFS_FLAG_LINUX_AIO (1<<9)
249 #define PVFS_FLAG_PERM_OVERRIDE (1<<10)
251 /* forward declare some anonymous structures */
254 /* types of notification for pvfs wait events */
255 enum pvfs_wait_notice
{PVFS_WAIT_EVENT
, PVFS_WAIT_TIMEOUT
, PVFS_WAIT_CANCEL
};
258 state of a pending retry
260 struct pvfs_odb_retry
;
262 #define PVFS_EADB "posix:eadb"
263 #define PVFS_XATTR "posix:xattr"
264 #define PVFS_FAKE_OPLOCKS "posix:fakeoplocks"
265 #define PVFS_SHARE_DELAY "posix:sharedelay"
266 #define PVFS_OPLOCK_TIMEOUT "posix:oplocktimeout"
267 #define PVFS_WRITETIME_DELAY "posix:writetimeupdatedelay"
268 #define PVFS_ALLOCATION_ROUNDING "posix:allocationrounding"
269 #define PVFS_SEARCH_INACTIVITY "posix:searchinactivity"
270 #define PVFS_ACL "posix:acl"
271 #define PVFS_AIO "posix:aio"
272 #define PVFS_PERM_OVERRIDE "posix:permission override"
274 #define PVFS_XATTR_DEFAULT true
275 #define PVFS_FAKE_OPLOCKS_DEFAULT false
276 #define PVFS_SHARE_DELAY_DEFAULT 1000000 /* nsecs */
277 #define PVFS_OPLOCK_TIMEOUT_DEFAULT 30 /* secs */
278 #define PVFS_WRITETIME_DELAY_DEFAULT 2000000 /* nsecs */
279 #define PVFS_ALLOCATION_ROUNDING_DEFAULT 512
280 #define PVFS_SEARCH_INACTIVITY_DEFAULT 300
282 struct pvfs_acl_ops
{
284 NTSTATUS (*acl_load
)(struct pvfs_state
*, struct pvfs_filename
*, int , TALLOC_CTX
*,
285 struct security_descriptor
**);
286 NTSTATUS (*acl_save
)(struct pvfs_state
*, struct pvfs_filename
*, int , struct security_descriptor
*);
289 #include "ntvfs/posix/vfs_posix_proto.h"
290 #include "ntvfs/posix/vfs_acl_proto.h"
292 NTSTATUS
pvfs_aio_pread(struct ntvfs_request
*req
, union smb_read
*rd
,
293 struct pvfs_file
*f
, uint32_t maxcnt
);
294 NTSTATUS
pvfs_aio_pwrite(struct ntvfs_request
*req
, union smb_write
*wr
,
295 struct pvfs_file
*f
);
297 #endif /* _VFS_POSIX_H_ */