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 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 #define SMB_VFS_INTERFACE_VERSION 28
139 /* to bug old modules which are trying to compile with the old functions */
140 #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 };
141 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
142 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
143 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
144 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
147 All intercepted VFS operations must be declared as static functions inside module source
148 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
149 example VFS modules for more details.
152 /* VFS operations structure */
154 struct vfs_handle_struct;
155 struct connection_struct;
157 struct security_descriptor;
158 struct vfs_statvfs_struct;
161 struct smb_file_time;
162 struct blocking_lock_record;
165 #define VFS_FIND(__fn__) while (handle->fns->__fn__==NULL) { \
166 handle = handle->next; \
169 enum vfs_translate_direction {
170 vfs_translate_to_unix = 0,
171 vfs_translate_to_windows
174 enum vfs_fallocate_mode {
175 VFS_FALLOCATE_EXTEND_SIZE = 0,
176 VFS_FALLOCATE_KEEP_SIZE = 1
180 Available VFS operations. These values must be in sync with vfs_ops struct
181 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
182 In particular, if new operations are added to vfs_ops, appropriate constants
183 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
186 struct vfs_fn_pointers {
187 /* Disk operations */
189 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
190 void (*disconnect)(struct vfs_handle_struct *handle);
191 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
192 uint64_t *dfree, uint64_t *dsize);
193 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
194 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
195 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
196 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
197 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
199 /* Directory operations */
201 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
202 SMB_STRUCT_DIR *(*fdopendir)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
203 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle,
204 SMB_STRUCT_DIR *dirp,
205 SMB_STRUCT_STAT *sbuf);
206 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
207 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
208 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
209 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
210 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
211 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
212 void (*init_search_op)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
214 /* File operations */
216 int (*open)(struct vfs_handle_struct *handle,
217 struct smb_filename *smb_fname, files_struct *fsp,
218 int flags, mode_t mode);
219 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
220 struct smb_request *req,
221 uint16_t root_dir_fid,
222 struct smb_filename *smb_fname,
223 uint32_t access_mask,
224 uint32_t share_access,
225 uint32_t create_disposition,
226 uint32_t create_options,
227 uint32_t file_attributes,
228 uint32_t oplock_request,
229 uint64_t allocation_size,
230 uint32_t private_flags,
231 struct security_descriptor *sd,
232 struct ea_list *ea_list,
233 files_struct **result,
235 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
236 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
237 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
238 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
239 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
240 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
241 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
242 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
243 int (*rename)(struct vfs_handle_struct *handle,
244 const struct smb_filename *smb_fname_src,
245 const struct smb_filename *smb_fname_dst);
246 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
247 int (*stat)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
248 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
249 int (*lstat)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
250 uint64_t (*get_alloc_size)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
251 int (*unlink)(struct vfs_handle_struct *handle,
252 const struct smb_filename *smb_fname);
253 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
254 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
255 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
256 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
257 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
258 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
259 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
260 int (*ntimes)(struct vfs_handle_struct *handle,
261 const struct smb_filename *smb_fname,
262 struct smb_file_time *ft);
263 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
264 int (*fallocate)(struct vfs_handle_struct *handle,
265 struct files_struct *fsp,
266 enum vfs_fallocate_mode mode,
269 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
270 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp,
271 uint32 share_mode, uint32_t access_mask);
272 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
273 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
274 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
275 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
276 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
277 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
278 char *(*realpath)(struct vfs_handle_struct *handle, const char *path);
279 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
280 struct sys_notify_context *ctx,
281 struct notify_entry *e,
282 void (*callback)(struct sys_notify_context *ctx,
284 struct notify_event *ev),
285 void *private_data, void *handle_p);
286 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
287 struct file_id (*file_id_create)(struct vfs_handle_struct *handle,
288 const SMB_STRUCT_STAT *sbuf);
290 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
291 struct files_struct *fsp,
294 unsigned int *num_streams,
295 struct stream_struct **streams);
297 int (*get_real_filename)(struct vfs_handle_struct *handle,
303 const char *(*connectpath)(struct vfs_handle_struct *handle,
304 const char *filename);
306 NTSTATUS (*brl_lock_windows)(struct vfs_handle_struct *handle,
307 struct byte_range_lock *br_lck,
308 struct lock_struct *plock,
310 struct blocking_lock_record *blr);
312 bool (*brl_unlock_windows)(struct vfs_handle_struct *handle,
313 struct messaging_context *msg_ctx,
314 struct byte_range_lock *br_lck,
315 const struct lock_struct *plock);
317 bool (*brl_cancel_windows)(struct vfs_handle_struct *handle,
318 struct byte_range_lock *br_lck,
319 struct lock_struct *plock,
320 struct blocking_lock_record *blr);
322 bool (*strict_lock)(struct vfs_handle_struct *handle,
323 struct files_struct *fsp,
324 struct lock_struct *plock);
326 void (*strict_unlock)(struct vfs_handle_struct *handle,
327 struct files_struct *fsp,
328 struct lock_struct *plock);
330 NTSTATUS (*translate_name)(struct vfs_handle_struct *handle,
332 enum vfs_translate_direction direction,
336 /* NT ACL operations. */
338 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
339 struct files_struct *fsp,
340 uint32 security_info,
341 struct security_descriptor **ppdesc);
342 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
344 uint32 security_info,
345 struct security_descriptor **ppdesc);
346 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
347 struct files_struct *fsp,
348 uint32 security_info_sent,
349 const struct security_descriptor *psd);
351 /* POSIX ACL operations. */
353 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
354 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
356 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
357 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
358 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
359 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
360 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
361 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
362 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
363 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
364 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
365 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
366 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
367 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
368 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
369 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
370 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
371 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
372 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
373 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
374 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
375 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
376 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
377 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
380 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
381 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
382 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
383 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
384 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
385 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
386 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
387 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
388 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
389 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
390 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
391 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
394 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
395 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
396 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
397 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
398 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
399 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
400 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
401 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
403 /* offline operations */
404 bool (*is_offline)(struct vfs_handle_struct *handle,
405 const struct smb_filename *fname,
406 SMB_STRUCT_STAT *sbuf);
407 int (*set_offline)(struct vfs_handle_struct *handle,
408 const struct smb_filename *fname);
412 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
413 which describes all operations this module is willing to intercept.
414 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
415 using this information.
418 typedef struct vfs_handle_struct {
419 struct vfs_handle_struct *next, *prev;
421 struct connection_struct *conn;
422 const struct vfs_fn_pointers *fns;
424 void (*free_data)(void **data);
428 typedef struct vfs_statvfs_struct {
429 /* For undefined recommended transfer size return -1 in that field */
430 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
434 The next three fields are in terms of the block size.
435 (above). If block size is unknown, 4096 would be a
436 reasonable block size for a server to report.
437 Note that returning the blocks/blocksavail removes need
438 to make a second call (to QFSInfo level 0x103 to get this info.
439 UserBlockAvail is typically less than or equal to BlocksAvail,
440 if no distinction is made return the same value in each.
443 uint64_t TotalBlocks;
444 uint64_t BlocksAvail; /* bfree */
445 uint64_t UserBlocksAvail; /* bavail */
447 /* For undefined Node fields or FSID return -1 */
448 uint64_t TotalFileNodes;
449 uint64_t FreeFileNodes;
450 uint64_t FsIdentifier; /* fsid */
451 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
452 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
455 } vfs_statvfs_struct;
457 /* Add a new FSP extension of the given type. Returns a pointer to the
460 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
461 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
463 /* Return a pointer to the existing FSP extension data. */
464 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
465 vfs_fetch_fsp_extension(handle, (fsp))
467 /* Return the talloc context associated with an FSP extension. */
468 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
469 vfs_memctx_fsp_extension(handle, (fsp))
471 /* Remove and destroy an FSP extension. */
472 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
473 vfs_remove_fsp_extension((handle), (fsp))
475 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
476 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
477 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
482 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
484 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
487 if ((handle)->free_data) { \
488 (handle)->free_data(&(handle)->data); \
490 (handle)->data = (void *)datap; \
491 (handle)->free_data = free_fn; \
495 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
496 if ((handle) && (handle)->free_data) { \
497 (handle)->free_data(&(handle)->data); \
501 /* Check whether module-specific data handle was already allocated or not */
502 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
504 #define SMB_VFS_OP(x) ((void *) x)
506 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
508 #include "vfs_macros.h"
510 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
511 const char *service, const char *user);
512 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
513 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
514 const char *path, bool small_query,
515 uint64_t *bsize, uint64_t *dfree,
517 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
518 enum SMB_QUOTA_TYPE qtype, unid_t id,
520 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
521 enum SMB_QUOTA_TYPE qtype, unid_t id,
523 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
524 struct files_struct *fsp,
525 SHADOW_COPY_DATA *shadow_copy_data,
527 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
528 struct vfs_statvfs_struct *statbuf);
529 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
530 enum timestamp_set_resolution *p_ts_res);
531 SMB_STRUCT_DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
532 const char *fname, const char *mask,
534 SMB_STRUCT_DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
535 struct files_struct *fsp,
538 SMB_STRUCT_DIRENT *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
539 SMB_STRUCT_DIR *dirp,
540 SMB_STRUCT_STAT *sbuf);
541 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
542 SMB_STRUCT_DIR *dirp, long offset);
543 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
544 SMB_STRUCT_DIR *dirp);
545 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
546 SMB_STRUCT_DIR *dirp);
547 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
549 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
550 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
551 SMB_STRUCT_DIR *dir);
552 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
553 SMB_STRUCT_DIR *dirp);
554 int smb_vfs_call_open(struct vfs_handle_struct *handle,
555 struct smb_filename *smb_fname, struct files_struct *fsp,
556 int flags, mode_t mode);
557 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
558 struct smb_request *req,
559 uint16_t root_dir_fid,
560 struct smb_filename *smb_fname,
561 uint32_t access_mask,
562 uint32_t share_access,
563 uint32_t create_disposition,
564 uint32_t create_options,
565 uint32_t file_attributes,
566 uint32_t oplock_request,
567 uint64_t allocation_size,
568 uint32_t private_flags,
569 struct security_descriptor *sd,
570 struct ea_list *ea_list,
571 files_struct **result,
573 int smb_vfs_call_close_fn(struct vfs_handle_struct *handle,
574 struct files_struct *fsp);
575 ssize_t smb_vfs_call_vfs_read(struct vfs_handle_struct *handle,
576 struct files_struct *fsp, void *data, size_t n);
577 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
578 struct files_struct *fsp, void *data, size_t n,
580 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
581 struct files_struct *fsp, const void *data,
583 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
584 struct files_struct *fsp, const void *data,
585 size_t n, SMB_OFF_T offset);
586 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
587 struct files_struct *fsp, SMB_OFF_T offset,
589 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
590 files_struct *fromfsp, const DATA_BLOB *header,
591 SMB_OFF_T offset, size_t count);
592 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
593 files_struct *tofsp, SMB_OFF_T offset,
595 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
596 const struct smb_filename *smb_fname_src,
597 const struct smb_filename *smb_fname_dst);
598 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
599 struct files_struct *fsp);
600 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
601 struct smb_filename *smb_fname);
602 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
603 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
604 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
605 struct smb_filename *smb_filename);
606 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
607 struct files_struct *fsp,
608 const SMB_STRUCT_STAT *sbuf);
609 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
610 const struct smb_filename *smb_fname);
611 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
613 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
614 struct files_struct *fsp, mode_t mode);
615 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
616 uid_t uid, gid_t gid);
617 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
618 struct files_struct *fsp, uid_t uid, gid_t gid);
619 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
620 uid_t uid, gid_t gid);
621 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
622 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle, char *buf);
623 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
624 const struct smb_filename *smb_fname,
625 struct smb_file_time *ft);
626 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
627 struct files_struct *fsp, SMB_OFF_T offset);
628 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
629 struct files_struct *fsp,
630 enum vfs_fallocate_mode mode,
633 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
634 struct files_struct *fsp, int op, SMB_OFF_T offset,
635 SMB_OFF_T count, int type);
636 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
637 struct files_struct *fsp, uint32 share_mode,
638 uint32_t access_mask);
639 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
640 struct files_struct *fsp, int leasetype);
641 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
642 struct files_struct *fsp, SMB_OFF_T *poffset,
643 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
644 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
645 const char *newpath);
646 int smb_vfs_call_vfs_readlink(struct vfs_handle_struct *handle,
647 const char *path, char *buf, size_t bufsiz);
648 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
649 const char *newpath);
650 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
651 mode_t mode, SMB_DEV_T dev);
652 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
653 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
654 struct sys_notify_context *ctx,
655 struct notify_entry *e,
656 void (*callback)(struct sys_notify_context *ctx,
658 struct notify_event *ev),
659 void *private_data, void *handle_p);
660 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
662 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
663 const SMB_STRUCT_STAT *sbuf);
664 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
665 struct files_struct *fsp,
668 unsigned int *num_streams,
669 struct stream_struct **streams);
670 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
671 const char *path, const char *name,
672 TALLOC_CTX *mem_ctx, char **found_name);
673 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
674 const char *filename);
675 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
676 struct byte_range_lock *br_lck,
677 struct lock_struct *plock,
679 struct blocking_lock_record *blr);
680 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
681 struct messaging_context *msg_ctx,
682 struct byte_range_lock *br_lck,
683 const struct lock_struct *plock);
684 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
685 struct byte_range_lock *br_lck,
686 struct lock_struct *plock,
687 struct blocking_lock_record *blr);
688 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
689 struct files_struct *fsp,
690 struct lock_struct *plock);
691 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
692 struct files_struct *fsp,
693 struct lock_struct *plock);
694 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
696 enum vfs_translate_direction direction,
699 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
700 struct files_struct *fsp,
701 uint32 security_info,
702 struct security_descriptor **ppdesc);
703 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
705 uint32 security_info,
706 struct security_descriptor **ppdesc);
707 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
708 struct files_struct *fsp,
709 uint32 security_info_sent,
710 const struct security_descriptor *psd);
711 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
713 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
714 struct files_struct *fsp, mode_t mode);
715 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
716 SMB_ACL_T theacl, int entry_id,
717 SMB_ACL_ENTRY_T *entry_p);
718 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
719 SMB_ACL_ENTRY_T entry_d,
720 SMB_ACL_TAG_T *tag_type_p);
721 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
722 SMB_ACL_ENTRY_T entry_d,
723 SMB_ACL_PERMSET_T *permset_p);
724 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
725 SMB_ACL_ENTRY_T entry_d);
726 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
728 SMB_ACL_TYPE_T type);
729 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
730 struct files_struct *fsp);
731 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
732 SMB_ACL_PERMSET_T permset);
733 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
734 SMB_ACL_PERMSET_T permset,
735 SMB_ACL_PERM_T perm);
736 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
737 SMB_ACL_T theacl, ssize_t *plen);
738 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
740 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
741 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
742 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
743 SMB_ACL_ENTRY_T entry,
744 SMB_ACL_TAG_T tagtype);
745 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
746 SMB_ACL_ENTRY_T entry, void *qual);
747 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
748 SMB_ACL_ENTRY_T entry,
749 SMB_ACL_PERMSET_T permset);
750 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
752 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
753 const char *name, SMB_ACL_TYPE_T acltype,
755 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
756 struct files_struct *fsp, SMB_ACL_T theacl);
757 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
759 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
760 SMB_ACL_PERMSET_T permset,
761 SMB_ACL_PERM_T perm);
762 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
764 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
765 SMB_ACL_T posix_acl);
766 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
767 void *qualifier, SMB_ACL_TAG_T tagtype);
768 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
769 const char *path, const char *name, void *value,
771 ssize_t smb_vfs_call_lgetxattr(struct vfs_handle_struct *handle,
772 const char *path, const char *name, void *value,
774 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
775 struct files_struct *fsp, const char *name,
776 void *value, size_t size);
777 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
778 const char *path, char *list, size_t size);
779 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
780 const char *path, char *list, size_t size);
781 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
782 struct files_struct *fsp, char *list,
784 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
785 const char *path, const char *name);
786 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
787 const char *path, const char *name);
788 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
789 struct files_struct *fsp, const char *name);
790 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
791 const char *name, const void *value, size_t size,
793 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
794 const char *name, const void *value, size_t size,
796 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
797 struct files_struct *fsp, const char *name,
798 const void *value, size_t size, int flags);
799 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
800 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
801 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
802 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
803 ssize_t smb_vfs_call_aio_return_fn(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 SMB_STRUCT_AIOCB *aiocb);
806 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
807 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
808 int smb_vfs_call_aio_error_fn(struct vfs_handle_struct *handle,
809 struct files_struct *fsp,
810 SMB_STRUCT_AIOCB *aiocb);
811 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
812 struct files_struct *fsp, int op,
813 SMB_STRUCT_AIOCB *aiocb);
814 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
815 struct files_struct *fsp,
816 const SMB_STRUCT_AIOCB * const aiocb[], int n,
817 const struct timespec *timeout);
818 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
819 struct files_struct *fsp);
820 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
821 const struct smb_filename *fname,
822 SMB_STRUCT_STAT *sbuf);
823 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
824 const struct smb_filename *fname);