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 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 #define SMB_VFS_INTERFACE_VERSION 29
145 All intercepted VFS operations must be declared as static functions inside module source
146 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
147 example VFS modules for more details.
150 /* VFS operations structure */
152 struct vfs_handle_struct;
153 struct connection_struct;
155 struct security_descriptor;
156 struct vfs_statvfs_struct;
159 struct smb_file_time;
160 struct blocking_lock_record;
162 struct dfs_GetDFSReferral;
164 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_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.
184 struct shadow_copy_data;
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_fn)(struct vfs_handle_struct *handle);
191 uint64_t (*disk_free_fn)(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_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
194 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
195 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
196 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
197 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
200 * Note: that "struct dfs_GetDFSReferral *r"
201 * needs to be a valid TALLOC_CTX
203 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
204 struct dfs_GetDFSReferral *r);
206 /* Directory operations */
208 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
209 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
210 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
212 SMB_STRUCT_STAT *sbuf);
213 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
214 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
215 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
216 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
217 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
218 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
219 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
221 /* File operations */
223 int (*open_fn)(struct vfs_handle_struct *handle,
224 struct smb_filename *smb_fname, files_struct *fsp,
225 int flags, mode_t mode);
226 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
227 struct smb_request *req,
228 uint16_t root_dir_fid,
229 struct smb_filename *smb_fname,
230 uint32_t access_mask,
231 uint32_t share_access,
232 uint32_t create_disposition,
233 uint32_t create_options,
234 uint32_t file_attributes,
235 uint32_t oplock_request,
236 uint64_t allocation_size,
237 uint32_t private_flags,
238 struct security_descriptor *sd,
239 struct ea_list *ea_list,
240 files_struct **result,
242 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
243 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
244 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
245 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
246 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
247 SMB_OFF_T (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
248 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
249 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
250 int (*rename_fn)(struct vfs_handle_struct *handle,
251 const struct smb_filename *smb_fname_src,
252 const struct smb_filename *smb_fname_dst);
253 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
254 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
255 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
256 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
257 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
258 int (*unlink_fn)(struct vfs_handle_struct *handle,
259 const struct smb_filename *smb_fname);
260 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
261 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
262 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
263 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
264 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
265 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
266 char *(*getwd_fn)(struct vfs_handle_struct *handle);
267 int (*ntimes_fn)(struct vfs_handle_struct *handle,
268 const struct smb_filename *smb_fname,
269 struct smb_file_time *ft);
270 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
271 int (*fallocate_fn)(struct vfs_handle_struct *handle,
272 struct files_struct *fsp,
273 enum vfs_fallocate_mode mode,
276 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
277 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
278 uint32 share_mode, uint32_t access_mask);
279 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
280 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
281 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
282 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
283 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
284 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
285 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
286 NTSTATUS (*notify_watch_fn)(struct vfs_handle_struct *handle,
287 struct sys_notify_context *ctx,
290 uint32_t *subdir_filter,
291 void (*callback)(struct sys_notify_context *ctx,
293 struct notify_event *ev),
296 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
297 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
298 const SMB_STRUCT_STAT *sbuf);
300 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
301 struct files_struct *fsp,
304 unsigned int *num_streams,
305 struct stream_struct **streams);
307 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
313 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
314 const char *filename);
316 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
317 struct byte_range_lock *br_lck,
318 struct lock_struct *plock,
320 struct blocking_lock_record *blr);
322 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
323 struct messaging_context *msg_ctx,
324 struct byte_range_lock *br_lck,
325 const struct lock_struct *plock);
327 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
328 struct byte_range_lock *br_lck,
329 struct lock_struct *plock,
330 struct blocking_lock_record *blr);
332 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
333 struct files_struct *fsp,
334 struct lock_struct *plock);
336 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
337 struct files_struct *fsp,
338 struct lock_struct *plock);
340 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
342 enum vfs_translate_direction direction,
346 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
347 struct files_struct *fsp,
351 const uint8_t *_in_data,
354 uint32_t max_out_len,
357 /* NT ACL operations. */
359 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
360 struct files_struct *fsp,
361 uint32 security_info,
362 struct security_descriptor **ppdesc);
363 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
365 uint32 security_info,
366 struct security_descriptor **ppdesc);
367 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
368 struct files_struct *fsp,
369 uint32 security_info_sent,
370 const struct security_descriptor *psd);
372 /* POSIX ACL operations. */
374 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
375 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
377 int (*sys_acl_get_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
378 int (*sys_acl_get_tag_type_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
379 int (*sys_acl_get_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
380 void * (*sys_acl_get_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
381 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
382 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
383 int (*sys_acl_clear_perms_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
384 int (*sys_acl_add_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
385 char * (*sys_acl_to_text_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
386 SMB_ACL_T (*sys_acl_init_fn)(struct vfs_handle_struct *handle, int count);
387 int (*sys_acl_create_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
388 int (*sys_acl_set_tag_type_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
389 int (*sys_acl_set_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
390 int (*sys_acl_set_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
391 int (*sys_acl_valid_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
392 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
393 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
394 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
395 int (*sys_acl_get_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
396 int (*sys_acl_free_text_fn)(struct vfs_handle_struct *handle, char *text);
397 int (*sys_acl_free_acl_fn)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
398 int (*sys_acl_free_qualifier_fn)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
401 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
402 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
403 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
404 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
405 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
406 int (*lremovexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
407 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
408 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
409 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
412 int (*aio_read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
413 int (*aio_write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
414 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
415 int (*aio_cancel_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
416 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
417 int (*aio_fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
418 int (*aio_suspend_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
419 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
421 /* offline operations */
422 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
423 const struct smb_filename *fname,
424 SMB_STRUCT_STAT *sbuf);
425 int (*set_offline_fn)(struct vfs_handle_struct *handle,
426 const struct smb_filename *fname);
430 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
431 which describes all operations this module is willing to intercept.
432 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
433 using this information.
436 typedef struct vfs_handle_struct {
437 struct vfs_handle_struct *next, *prev;
439 struct connection_struct *conn;
440 const struct vfs_fn_pointers *fns;
442 void (*free_data)(void **data);
446 typedef struct vfs_statvfs_struct {
447 /* For undefined recommended transfer size return -1 in that field */
448 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
452 The next three fields are in terms of the block size.
453 (above). If block size is unknown, 4096 would be a
454 reasonable block size for a server to report.
455 Note that returning the blocks/blocksavail removes need
456 to make a second call (to QFSInfo level 0x103 to get this info.
457 UserBlockAvail is typically less than or equal to BlocksAvail,
458 if no distinction is made return the same value in each.
461 uint64_t TotalBlocks;
462 uint64_t BlocksAvail; /* bfree */
463 uint64_t UserBlocksAvail; /* bavail */
465 /* For undefined Node fields or FSID return -1 */
466 uint64_t TotalFileNodes;
467 uint64_t FreeFileNodes;
468 uint64_t FsIdentifier; /* fsid */
469 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
470 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
473 } vfs_statvfs_struct;
475 /* Add a new FSP extension of the given type. Returns a pointer to the
478 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
479 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
481 /* Return a pointer to the existing FSP extension data. */
482 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
483 vfs_fetch_fsp_extension(handle, (fsp))
485 /* Return the talloc context associated with an FSP extension. */
486 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
487 vfs_memctx_fsp_extension(handle, (fsp))
489 /* Remove and destroy an FSP extension. */
490 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
491 vfs_remove_fsp_extension((handle), (fsp))
493 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
494 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
495 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
500 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
502 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
505 if ((handle)->free_data) { \
506 (handle)->free_data(&(handle)->data); \
508 (handle)->data = (void *)datap; \
509 (handle)->free_data = free_fn; \
513 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
514 if ((handle) && (handle)->free_data) { \
515 (handle)->free_data(&(handle)->data); \
519 /* Check whether module-specific data handle was already allocated or not */
520 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
522 #define SMB_VFS_OP(x) ((void *) x)
524 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
526 #include "vfs_macros.h"
528 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
529 const char *service, const char *user);
530 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
531 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
532 const char *path, bool small_query,
533 uint64_t *bsize, uint64_t *dfree,
535 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
536 enum SMB_QUOTA_TYPE qtype, unid_t id,
538 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
539 enum SMB_QUOTA_TYPE qtype, unid_t id,
541 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
542 struct files_struct *fsp,
543 struct shadow_copy_data *shadow_copy_data,
545 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
546 struct vfs_statvfs_struct *statbuf);
547 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
548 enum timestamp_set_resolution *p_ts_res);
550 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
552 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
553 struct dfs_GetDFSReferral *r);
554 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
555 const char *fname, const char *mask,
557 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
558 struct files_struct *fsp,
561 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
563 SMB_STRUCT_STAT *sbuf);
564 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
565 DIR *dirp, long offset);
566 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
568 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
570 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
572 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
573 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
575 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
577 int smb_vfs_call_open(struct vfs_handle_struct *handle,
578 struct smb_filename *smb_fname, struct files_struct *fsp,
579 int flags, mode_t mode);
580 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
581 struct smb_request *req,
582 uint16_t root_dir_fid,
583 struct smb_filename *smb_fname,
584 uint32_t access_mask,
585 uint32_t share_access,
586 uint32_t create_disposition,
587 uint32_t create_options,
588 uint32_t file_attributes,
589 uint32_t oplock_request,
590 uint64_t allocation_size,
591 uint32_t private_flags,
592 struct security_descriptor *sd,
593 struct ea_list *ea_list,
594 files_struct **result,
596 int smb_vfs_call_close(struct vfs_handle_struct *handle,
597 struct files_struct *fsp);
598 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
599 struct files_struct *fsp, void *data, size_t n);
600 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
601 struct files_struct *fsp, void *data, size_t n,
603 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
604 struct files_struct *fsp, const void *data,
606 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
607 struct files_struct *fsp, const void *data,
608 size_t n, SMB_OFF_T offset);
609 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
610 struct files_struct *fsp, SMB_OFF_T offset,
612 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
613 files_struct *fromfsp, const DATA_BLOB *header,
614 SMB_OFF_T offset, size_t count);
615 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
616 files_struct *tofsp, SMB_OFF_T offset,
618 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
619 const struct smb_filename *smb_fname_src,
620 const struct smb_filename *smb_fname_dst);
621 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
622 struct files_struct *fsp);
623 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
624 struct smb_filename *smb_fname);
625 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
626 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
627 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
628 struct smb_filename *smb_filename);
629 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
630 struct files_struct *fsp,
631 const SMB_STRUCT_STAT *sbuf);
632 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
633 const struct smb_filename *smb_fname);
634 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
636 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
637 struct files_struct *fsp, mode_t mode);
638 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
639 uid_t uid, gid_t gid);
640 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
641 struct files_struct *fsp, uid_t uid, gid_t gid);
642 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
643 uid_t uid, gid_t gid);
644 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
645 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
646 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
647 const struct smb_filename *smb_fname,
648 struct smb_file_time *ft);
649 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
650 struct files_struct *fsp, SMB_OFF_T offset);
651 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
652 struct files_struct *fsp,
653 enum vfs_fallocate_mode mode,
656 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
657 struct files_struct *fsp, int op, SMB_OFF_T offset,
658 SMB_OFF_T count, int type);
659 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
660 struct files_struct *fsp, uint32 share_mode,
661 uint32_t access_mask);
662 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
663 struct files_struct *fsp, int leasetype);
664 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
665 struct files_struct *fsp, SMB_OFF_T *poffset,
666 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
667 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
668 const char *newpath);
669 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
670 const char *path, char *buf, size_t bufsiz);
671 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
672 const char *newpath);
673 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
674 mode_t mode, SMB_DEV_T dev);
675 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
676 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
677 struct sys_notify_context *ctx,
680 uint32_t *subdir_filter,
681 void (*callback)(struct sys_notify_context *ctx,
683 struct notify_event *ev),
684 void *private_data, void *handle_p);
685 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
687 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
688 const SMB_STRUCT_STAT *sbuf);
689 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
690 struct files_struct *fsp,
693 unsigned int *num_streams,
694 struct stream_struct **streams);
695 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
696 const char *path, const char *name,
697 TALLOC_CTX *mem_ctx, char **found_name);
698 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
699 const char *filename);
700 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
701 struct byte_range_lock *br_lck,
702 struct lock_struct *plock,
704 struct blocking_lock_record *blr);
705 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
706 struct messaging_context *msg_ctx,
707 struct byte_range_lock *br_lck,
708 const struct lock_struct *plock);
709 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
710 struct byte_range_lock *br_lck,
711 struct lock_struct *plock,
712 struct blocking_lock_record *blr);
713 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
714 struct files_struct *fsp,
715 struct lock_struct *plock);
716 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
717 struct files_struct *fsp,
718 struct lock_struct *plock);
719 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
721 enum vfs_translate_direction direction,
724 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
725 struct files_struct *fsp,
729 const uint8_t *_in_data,
732 uint32_t max_out_len,
734 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
735 struct files_struct *fsp,
736 uint32 security_info,
737 struct security_descriptor **ppdesc);
738 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
740 uint32 security_info,
741 struct security_descriptor **ppdesc);
742 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
743 struct files_struct *fsp,
744 uint32 security_info_sent,
745 const struct security_descriptor *psd);
746 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
748 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
749 struct files_struct *fsp, mode_t mode);
750 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
751 SMB_ACL_T theacl, int entry_id,
752 SMB_ACL_ENTRY_T *entry_p);
753 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
754 SMB_ACL_ENTRY_T entry_d,
755 SMB_ACL_TAG_T *tag_type_p);
756 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
757 SMB_ACL_ENTRY_T entry_d,
758 SMB_ACL_PERMSET_T *permset_p);
759 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
760 SMB_ACL_ENTRY_T entry_d);
761 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
763 SMB_ACL_TYPE_T type);
764 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
765 struct files_struct *fsp);
766 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
767 SMB_ACL_PERMSET_T permset);
768 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
769 SMB_ACL_PERMSET_T permset,
770 SMB_ACL_PERM_T perm);
771 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
772 SMB_ACL_T theacl, ssize_t *plen);
773 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
775 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
776 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
777 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
778 SMB_ACL_ENTRY_T entry,
779 SMB_ACL_TAG_T tagtype);
780 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
781 SMB_ACL_ENTRY_T entry, void *qual);
782 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
783 SMB_ACL_ENTRY_T entry,
784 SMB_ACL_PERMSET_T permset);
785 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
787 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
788 const char *name, SMB_ACL_TYPE_T acltype,
790 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
791 struct files_struct *fsp, SMB_ACL_T theacl);
792 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
794 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
795 SMB_ACL_PERMSET_T permset,
796 SMB_ACL_PERM_T perm);
797 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
799 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
800 SMB_ACL_T posix_acl);
801 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
802 void *qualifier, SMB_ACL_TAG_T tagtype);
803 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
804 const char *path, const char *name, void *value,
806 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
807 struct files_struct *fsp, const char *name,
808 void *value, size_t size);
809 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
810 const char *path, char *list, size_t size);
811 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
812 const char *path, char *list, size_t size);
813 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
814 struct files_struct *fsp, char *list,
816 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
817 const char *path, const char *name);
818 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
819 const char *path, const char *name);
820 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
821 struct files_struct *fsp, const char *name);
822 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
823 const char *name, const void *value, size_t size,
825 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
826 const char *name, const void *value, size_t size,
828 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
829 struct files_struct *fsp, const char *name,
830 const void *value, size_t size, int flags);
831 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
832 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
833 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
834 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
835 ssize_t smb_vfs_call_aio_return(struct vfs_handle_struct *handle,
836 struct files_struct *fsp,
837 SMB_STRUCT_AIOCB *aiocb);
838 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
839 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
840 int smb_vfs_call_aio_error(struct vfs_handle_struct *handle,
841 struct files_struct *fsp,
842 SMB_STRUCT_AIOCB *aiocb);
843 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
844 struct files_struct *fsp, int op,
845 SMB_STRUCT_AIOCB *aiocb);
846 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
847 struct files_struct *fsp,
848 const SMB_STRUCT_AIOCB * const aiocb[], int n,
849 const struct timespec *timeout);
850 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
851 struct files_struct *fsp);
852 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
853 const struct smb_filename *fname,
854 SMB_STRUCT_STAT *sbuf);
855 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
856 const struct smb_filename *fname);