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