2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
29 /* Avoid conflict with an AIX include file */
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
45 * If you change anything here, please also update modules/vfs_full_audit.c.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 #define SMB_VFS_INTERFACE_VERSION 28
138 /* to bug old modules which are trying to compile with the old functions */
139 #define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
140 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
141 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
142 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
143 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
146 All intercepted VFS operations must be declared as static functions inside module source
147 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
148 example VFS modules for more details.
151 /* VFS operations structure */
153 struct vfs_handle_struct;
154 struct connection_struct;
156 struct security_descriptor;
157 struct vfs_statvfs_struct;
160 struct smb_file_time;
161 struct blocking_lock_record;
164 #define VFS_FIND(__fn__) while (handle->fns->__fn__==NULL) { \
165 handle = handle->next; \
168 enum vfs_translate_direction {
169 vfs_translate_to_unix = 0,
170 vfs_translate_to_windows
173 enum vfs_fallocate_mode {
174 VFS_FALLOCATE_EXTEND_SIZE = 0,
175 VFS_FALLOCATE_KEEP_SIZE = 1
179 Available VFS operations. These values must be in sync with vfs_ops struct
180 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
181 In particular, if new operations are added to vfs_ops, appropriate constants
182 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
185 struct vfs_fn_pointers {
186 /* Disk operations */
188 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
189 void (*disconnect)(struct vfs_handle_struct *handle);
190 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
191 uint64_t *dfree, uint64_t *dsize);
192 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
193 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
194 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
195 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
196 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
198 /* Directory operations */
200 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
201 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle,
202 SMB_STRUCT_DIR *dirp,
203 SMB_STRUCT_STAT *sbuf);
204 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
205 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
206 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
207 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
208 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
209 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
210 void (*init_search_op)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
212 /* File operations */
214 int (*open)(struct vfs_handle_struct *handle,
215 struct smb_filename *smb_fname, files_struct *fsp,
216 int flags, mode_t mode);
217 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
218 struct smb_request *req,
219 uint16_t root_dir_fid,
220 struct smb_filename *smb_fname,
221 uint32_t access_mask,
222 uint32_t share_access,
223 uint32_t create_disposition,
224 uint32_t create_options,
225 uint32_t file_attributes,
226 uint32_t oplock_request,
227 uint64_t allocation_size,
228 uint32_t private_flags,
229 struct security_descriptor *sd,
230 struct ea_list *ea_list,
231 files_struct **result,
233 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
234 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
235 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
236 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
237 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
238 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
239 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
240 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
241 int (*rename)(struct vfs_handle_struct *handle,
242 const struct smb_filename *smb_fname_src,
243 const struct smb_filename *smb_fname_dst);
244 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
245 int (*stat)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
246 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
247 int (*lstat)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
248 uint64_t (*get_alloc_size)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
249 int (*unlink)(struct vfs_handle_struct *handle,
250 const struct smb_filename *smb_fname);
251 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
252 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
253 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
254 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
255 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
256 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
257 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
258 int (*ntimes)(struct vfs_handle_struct *handle,
259 const struct smb_filename *smb_fname,
260 struct smb_file_time *ft);
261 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
262 int (*fallocate)(struct vfs_handle_struct *handle,
263 struct files_struct *fsp,
264 enum vfs_fallocate_mode mode,
267 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
268 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp,
269 uint32 share_mode, uint32_t access_mask);
270 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
271 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
272 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
273 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
274 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
275 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
276 char *(*realpath)(struct vfs_handle_struct *handle, const char *path);
277 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
278 struct sys_notify_context *ctx,
279 struct notify_entry *e,
280 void (*callback)(struct sys_notify_context *ctx,
282 struct notify_event *ev),
283 void *private_data, void *handle_p);
284 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
285 struct file_id (*file_id_create)(struct vfs_handle_struct *handle,
286 const SMB_STRUCT_STAT *sbuf);
288 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
289 struct files_struct *fsp,
292 unsigned int *num_streams,
293 struct stream_struct **streams);
295 int (*get_real_filename)(struct vfs_handle_struct *handle,
301 const char *(*connectpath)(struct vfs_handle_struct *handle,
302 const char *filename);
304 NTSTATUS (*brl_lock_windows)(struct vfs_handle_struct *handle,
305 struct byte_range_lock *br_lck,
306 struct lock_struct *plock,
308 struct blocking_lock_record *blr);
310 bool (*brl_unlock_windows)(struct vfs_handle_struct *handle,
311 struct messaging_context *msg_ctx,
312 struct byte_range_lock *br_lck,
313 const struct lock_struct *plock);
315 bool (*brl_cancel_windows)(struct vfs_handle_struct *handle,
316 struct byte_range_lock *br_lck,
317 struct lock_struct *plock,
318 struct blocking_lock_record *blr);
320 bool (*strict_lock)(struct vfs_handle_struct *handle,
321 struct files_struct *fsp,
322 struct lock_struct *plock);
324 void (*strict_unlock)(struct vfs_handle_struct *handle,
325 struct files_struct *fsp,
326 struct lock_struct *plock);
328 NTSTATUS (*translate_name)(struct vfs_handle_struct *handle,
330 enum vfs_translate_direction direction,
334 /* NT ACL operations. */
336 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
337 struct files_struct *fsp,
338 uint32 security_info,
339 struct security_descriptor **ppdesc);
340 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
342 uint32 security_info,
343 struct security_descriptor **ppdesc);
344 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
345 struct files_struct *fsp,
346 uint32 security_info_sent,
347 const struct security_descriptor *psd);
349 /* POSIX ACL operations. */
351 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
352 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
354 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
355 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
356 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
357 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
358 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
359 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
360 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
361 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
362 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
363 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
364 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
365 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
366 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
367 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
368 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
369 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
370 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
371 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
372 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
373 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
374 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
375 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
378 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
379 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
380 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
381 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
382 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
383 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
384 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
385 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
386 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
387 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
388 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
389 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
392 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
393 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
394 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
395 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
396 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
397 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
398 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
399 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
401 /* offline operations */
402 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
403 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
407 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
408 which describes all operations this module is willing to intercept.
409 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
410 using this information.
413 typedef struct vfs_handle_struct {
414 struct vfs_handle_struct *next, *prev;
416 struct connection_struct *conn;
417 const struct vfs_fn_pointers *fns;
419 void (*free_data)(void **data);
423 typedef struct vfs_statvfs_struct {
424 /* For undefined recommended transfer size return -1 in that field */
425 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
429 The next three fields are in terms of the block size.
430 (above). If block size is unknown, 4096 would be a
431 reasonable block size for a server to report.
432 Note that returning the blocks/blocksavail removes need
433 to make a second call (to QFSInfo level 0x103 to get this info.
434 UserBlockAvail is typically less than or equal to BlocksAvail,
435 if no distinction is made return the same value in each.
438 uint64_t TotalBlocks;
439 uint64_t BlocksAvail; /* bfree */
440 uint64_t UserBlocksAvail; /* bavail */
442 /* For undefined Node fields or FSID return -1 */
443 uint64_t TotalFileNodes;
444 uint64_t FreeFileNodes;
445 uint64_t FsIdentifier; /* fsid */
446 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
447 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
450 } vfs_statvfs_struct;
452 /* Add a new FSP extension of the given type. Returns a pointer to the
455 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
456 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
458 /* Return a pointer to the existing FSP extension data. */
459 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
460 vfs_fetch_fsp_extension(handle, (fsp))
462 /* Return the talloc context associated with an FSP extension. */
463 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
464 vfs_memctx_fsp_extension(handle, (fsp))
466 /* Remove and destroy an FSP extension. */
467 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
468 vfs_remove_fsp_extension((handle), (fsp))
470 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
471 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
472 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
477 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
479 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
482 if ((handle)->free_data) { \
483 (handle)->free_data(&(handle)->data); \
485 (handle)->data = (void *)datap; \
486 (handle)->free_data = free_fn; \
490 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
491 if ((handle) && (handle)->free_data) { \
492 (handle)->free_data(&(handle)->data); \
496 /* Check whether module-specific data handle was already allocated or not */
497 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
499 #define SMB_VFS_OP(x) ((void *) x)
501 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
503 #include "vfs_macros.h"
505 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
506 const char *service, const char *user);
507 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
508 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
509 const char *path, bool small_query,
510 uint64_t *bsize, uint64_t *dfree,
512 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
513 enum SMB_QUOTA_TYPE qtype, unid_t id,
515 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
516 enum SMB_QUOTA_TYPE qtype, unid_t id,
518 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
519 struct files_struct *fsp,
520 SHADOW_COPY_DATA *shadow_copy_data,
522 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
523 struct vfs_statvfs_struct *statbuf);
524 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
525 enum timestamp_set_resolution *p_ts_res);
526 SMB_STRUCT_DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
527 const char *fname, const char *mask,
529 SMB_STRUCT_DIRENT *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
530 SMB_STRUCT_DIR *dirp,
531 SMB_STRUCT_STAT *sbuf);
532 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
533 SMB_STRUCT_DIR *dirp, long offset);
534 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
535 SMB_STRUCT_DIR *dirp);
536 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
537 SMB_STRUCT_DIR *dirp);
538 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
540 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
541 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
542 SMB_STRUCT_DIR *dir);
543 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
544 SMB_STRUCT_DIR *dirp);
545 int smb_vfs_call_open(struct vfs_handle_struct *handle,
546 struct smb_filename *smb_fname, struct files_struct *fsp,
547 int flags, mode_t mode);
548 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
549 struct smb_request *req,
550 uint16_t root_dir_fid,
551 struct smb_filename *smb_fname,
552 uint32_t access_mask,
553 uint32_t share_access,
554 uint32_t create_disposition,
555 uint32_t create_options,
556 uint32_t file_attributes,
557 uint32_t oplock_request,
558 uint64_t allocation_size,
559 uint32_t private_flags,
560 struct security_descriptor *sd,
561 struct ea_list *ea_list,
562 files_struct **result,
564 int smb_vfs_call_close_fn(struct vfs_handle_struct *handle,
565 struct files_struct *fsp);
566 ssize_t smb_vfs_call_vfs_read(struct vfs_handle_struct *handle,
567 struct files_struct *fsp, void *data, size_t n);
568 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
569 struct files_struct *fsp, void *data, size_t n,
571 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
572 struct files_struct *fsp, const void *data,
574 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
575 struct files_struct *fsp, const void *data,
576 size_t n, SMB_OFF_T offset);
577 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
578 struct files_struct *fsp, SMB_OFF_T offset,
580 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
581 files_struct *fromfsp, const DATA_BLOB *header,
582 SMB_OFF_T offset, size_t count);
583 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
584 files_struct *tofsp, SMB_OFF_T offset,
586 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
587 const struct smb_filename *smb_fname_src,
588 const struct smb_filename *smb_fname_dst);
589 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
590 struct files_struct *fsp);
591 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
592 struct smb_filename *smb_fname);
593 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
594 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
595 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
596 struct smb_filename *smb_filename);
597 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
598 struct files_struct *fsp,
599 const SMB_STRUCT_STAT *sbuf);
600 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
601 const struct smb_filename *smb_fname);
602 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
604 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
605 struct files_struct *fsp, mode_t mode);
606 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
607 uid_t uid, gid_t gid);
608 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
609 struct files_struct *fsp, uid_t uid, gid_t gid);
610 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
611 uid_t uid, gid_t gid);
612 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
613 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle, char *buf);
614 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
615 const struct smb_filename *smb_fname,
616 struct smb_file_time *ft);
617 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
618 struct files_struct *fsp, SMB_OFF_T offset);
619 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
620 struct files_struct *fsp,
621 enum vfs_fallocate_mode mode,
624 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
625 struct files_struct *fsp, int op, SMB_OFF_T offset,
626 SMB_OFF_T count, int type);
627 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
628 struct files_struct *fsp, uint32 share_mode,
629 uint32_t access_mask);
630 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
631 struct files_struct *fsp, int leasetype);
632 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
633 struct files_struct *fsp, SMB_OFF_T *poffset,
634 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
635 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
636 const char *newpath);
637 int smb_vfs_call_vfs_readlink(struct vfs_handle_struct *handle,
638 const char *path, char *buf, size_t bufsiz);
639 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
640 const char *newpath);
641 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
642 mode_t mode, SMB_DEV_T dev);
643 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
644 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
645 struct sys_notify_context *ctx,
646 struct notify_entry *e,
647 void (*callback)(struct sys_notify_context *ctx,
649 struct notify_event *ev),
650 void *private_data, void *handle_p);
651 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
653 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
654 const SMB_STRUCT_STAT *sbuf);
655 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
656 struct files_struct *fsp,
659 unsigned int *num_streams,
660 struct stream_struct **streams);
661 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
662 const char *path, const char *name,
663 TALLOC_CTX *mem_ctx, char **found_name);
664 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
665 const char *filename);
666 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
667 struct byte_range_lock *br_lck,
668 struct lock_struct *plock,
670 struct blocking_lock_record *blr);
671 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
672 struct messaging_context *msg_ctx,
673 struct byte_range_lock *br_lck,
674 const struct lock_struct *plock);
675 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
676 struct byte_range_lock *br_lck,
677 struct lock_struct *plock,
678 struct blocking_lock_record *blr);
679 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
680 struct files_struct *fsp,
681 struct lock_struct *plock);
682 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
683 struct files_struct *fsp,
684 struct lock_struct *plock);
685 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
687 enum vfs_translate_direction direction,
690 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
691 struct files_struct *fsp,
692 uint32 security_info,
693 struct security_descriptor **ppdesc);
694 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
696 uint32 security_info,
697 struct security_descriptor **ppdesc);
698 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
699 struct files_struct *fsp,
700 uint32 security_info_sent,
701 const struct security_descriptor *psd);
702 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
704 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
705 struct files_struct *fsp, mode_t mode);
706 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
707 SMB_ACL_T theacl, int entry_id,
708 SMB_ACL_ENTRY_T *entry_p);
709 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
710 SMB_ACL_ENTRY_T entry_d,
711 SMB_ACL_TAG_T *tag_type_p);
712 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
713 SMB_ACL_ENTRY_T entry_d,
714 SMB_ACL_PERMSET_T *permset_p);
715 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
716 SMB_ACL_ENTRY_T entry_d);
717 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
719 SMB_ACL_TYPE_T type);
720 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
721 struct files_struct *fsp);
722 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
723 SMB_ACL_PERMSET_T permset);
724 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
725 SMB_ACL_PERMSET_T permset,
726 SMB_ACL_PERM_T perm);
727 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
728 SMB_ACL_T theacl, ssize_t *plen);
729 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
731 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
732 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
733 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
734 SMB_ACL_ENTRY_T entry,
735 SMB_ACL_TAG_T tagtype);
736 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
737 SMB_ACL_ENTRY_T entry, void *qual);
738 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
739 SMB_ACL_ENTRY_T entry,
740 SMB_ACL_PERMSET_T permset);
741 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
743 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
744 const char *name, SMB_ACL_TYPE_T acltype,
746 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
747 struct files_struct *fsp, SMB_ACL_T theacl);
748 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
750 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
751 SMB_ACL_PERMSET_T permset,
752 SMB_ACL_PERM_T perm);
753 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
755 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
756 SMB_ACL_T posix_acl);
757 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
758 void *qualifier, SMB_ACL_TAG_T tagtype);
759 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
760 const char *path, const char *name, void *value,
762 ssize_t smb_vfs_call_lgetxattr(struct vfs_handle_struct *handle,
763 const char *path, const char *name, void *value,
765 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
766 struct files_struct *fsp, const char *name,
767 void *value, size_t size);
768 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
769 const char *path, char *list, size_t size);
770 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
771 const char *path, char *list, size_t size);
772 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
773 struct files_struct *fsp, char *list,
775 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
776 const char *path, const char *name);
777 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
778 const char *path, const char *name);
779 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
780 struct files_struct *fsp, const char *name);
781 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
782 const char *name, const void *value, size_t size,
784 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
785 const char *name, const void *value, size_t size,
787 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
788 struct files_struct *fsp, const char *name,
789 const void *value, size_t size, int flags);
790 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
791 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
792 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
793 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
794 ssize_t smb_vfs_call_aio_return_fn(struct vfs_handle_struct *handle,
795 struct files_struct *fsp,
796 SMB_STRUCT_AIOCB *aiocb);
797 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
798 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
799 int smb_vfs_call_aio_error_fn(struct vfs_handle_struct *handle,
800 struct files_struct *fsp,
801 SMB_STRUCT_AIOCB *aiocb);
802 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
803 struct files_struct *fsp, int op,
804 SMB_STRUCT_AIOCB *aiocb);
805 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
806 struct files_struct *fsp,
807 const SMB_STRUCT_AIOCB * const aiocb[], int n,
808 const struct timespec *timeout);
809 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
810 struct files_struct *fsp);
811 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
812 const char *path, SMB_STRUCT_STAT *sbuf);
813 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,