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 #define SMB_VFS_INTERFACE_VERSION 29
144 All intercepted VFS operations must be declared as static functions inside module source
145 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
146 example VFS modules for more details.
149 /* VFS operations structure */
151 struct vfs_handle_struct;
152 struct connection_struct;
154 struct security_descriptor;
155 struct vfs_statvfs_struct;
158 struct smb_file_time;
159 struct blocking_lock_record;
161 struct dfs_GetDFSReferral;
163 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
164 handle = handle->next; \
167 enum vfs_translate_direction {
168 vfs_translate_to_unix = 0,
169 vfs_translate_to_windows
172 enum vfs_fallocate_mode {
173 VFS_FALLOCATE_EXTEND_SIZE = 0,
174 VFS_FALLOCATE_KEEP_SIZE = 1
178 Available VFS operations. These values must be in sync with vfs_ops struct
179 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
180 In particular, if new operations are added to vfs_ops, appropriate constants
181 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
183 struct shadow_copy_data;
185 struct vfs_fn_pointers {
186 /* Disk operations */
188 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
189 void (*disconnect_fn)(struct vfs_handle_struct *handle);
190 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
191 uint64_t *dfree, uint64_t *dsize);
192 int (*get_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
193 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
194 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
195 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
196 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
199 * Note: that "struct dfs_GetDFSReferral *r"
200 * needs to be a valid TALLOC_CTX
202 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
203 struct dfs_GetDFSReferral *r);
205 /* Directory operations */
207 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
208 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
209 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
211 SMB_STRUCT_STAT *sbuf);
212 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
213 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
214 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
215 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
216 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
217 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
218 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
220 /* File operations */
222 int (*open_fn)(struct vfs_handle_struct *handle,
223 struct smb_filename *smb_fname, files_struct *fsp,
224 int flags, mode_t mode);
225 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
226 struct smb_request *req,
227 uint16_t root_dir_fid,
228 struct smb_filename *smb_fname,
229 uint32_t access_mask,
230 uint32_t share_access,
231 uint32_t create_disposition,
232 uint32_t create_options,
233 uint32_t file_attributes,
234 uint32_t oplock_request,
235 uint64_t allocation_size,
236 uint32_t private_flags,
237 struct security_descriptor *sd,
238 struct ea_list *ea_list,
239 files_struct **result,
241 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
242 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
243 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
244 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
245 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
246 SMB_OFF_T (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
247 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);
248 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
249 int (*rename_fn)(struct vfs_handle_struct *handle,
250 const struct smb_filename *smb_fname_src,
251 const struct smb_filename *smb_fname_dst);
252 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
253 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
254 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
255 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
256 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
257 int (*unlink_fn)(struct vfs_handle_struct *handle,
258 const struct smb_filename *smb_fname);
259 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
260 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
261 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
262 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
263 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
264 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
265 char *(*getwd_fn)(struct vfs_handle_struct *handle);
266 int (*ntimes_fn)(struct vfs_handle_struct *handle,
267 const struct smb_filename *smb_fname,
268 struct smb_file_time *ft);
269 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
270 int (*fallocate_fn)(struct vfs_handle_struct *handle,
271 struct files_struct *fsp,
272 enum vfs_fallocate_mode mode,
275 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
276 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
277 uint32 share_mode, uint32_t access_mask);
278 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
279 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);
280 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
281 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
282 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
283 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
284 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
285 NTSTATUS (*notify_watch_fn)(struct vfs_handle_struct *handle,
286 struct sys_notify_context *ctx,
289 uint32_t *subdir_filter,
290 void (*callback)(struct sys_notify_context *ctx,
292 struct notify_event *ev),
295 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
296 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
297 const SMB_STRUCT_STAT *sbuf);
299 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
300 struct files_struct *fsp,
303 unsigned int *num_streams,
304 struct stream_struct **streams);
306 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
312 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
313 const char *filename);
315 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
316 struct byte_range_lock *br_lck,
317 struct lock_struct *plock,
319 struct blocking_lock_record *blr);
321 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
322 struct messaging_context *msg_ctx,
323 struct byte_range_lock *br_lck,
324 const struct lock_struct *plock);
326 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
327 struct byte_range_lock *br_lck,
328 struct lock_struct *plock,
329 struct blocking_lock_record *blr);
331 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
332 struct files_struct *fsp,
333 struct lock_struct *plock);
335 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
336 struct files_struct *fsp,
337 struct lock_struct *plock);
339 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
341 enum vfs_translate_direction direction,
345 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
346 struct files_struct *fsp,
350 const uint8_t *_in_data,
353 uint32_t max_out_len,
356 /* NT ACL operations. */
358 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
359 struct files_struct *fsp,
360 uint32 security_info,
361 struct security_descriptor **ppdesc);
362 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
364 uint32 security_info,
365 struct security_descriptor **ppdesc);
366 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
367 struct files_struct *fsp,
368 uint32 security_info_sent,
369 const struct security_descriptor *psd);
371 /* POSIX ACL operations. */
373 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
374 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
376 int (*sys_acl_get_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
377 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);
378 int (*sys_acl_get_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
379 void * (*sys_acl_get_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
380 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
381 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
382 int (*sys_acl_clear_perms_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
383 int (*sys_acl_add_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
384 char * (*sys_acl_to_text_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
385 SMB_ACL_T (*sys_acl_init_fn)(struct vfs_handle_struct *handle, int count);
386 int (*sys_acl_create_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
387 int (*sys_acl_set_tag_type_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
388 int (*sys_acl_set_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
389 int (*sys_acl_set_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
390 int (*sys_acl_valid_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
391 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
392 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
393 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
394 int (*sys_acl_get_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
395 int (*sys_acl_free_text_fn)(struct vfs_handle_struct *handle, char *text);
396 int (*sys_acl_free_acl_fn)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
397 int (*sys_acl_free_qualifier_fn)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
400 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
401 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
402 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
403 ssize_t (*llistxattr_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 (*lsetxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
410 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
413 int (*aio_read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
414 int (*aio_write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
415 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
416 int (*aio_cancel_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
417 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
418 int (*aio_fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
419 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);
420 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
422 /* offline operations */
423 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
424 const struct smb_filename *fname,
425 SMB_STRUCT_STAT *sbuf);
426 int (*set_offline_fn)(struct vfs_handle_struct *handle,
427 const struct smb_filename *fname);
431 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
432 which describes all operations this module is willing to intercept.
433 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
434 using this information.
437 typedef struct vfs_handle_struct {
438 struct vfs_handle_struct *next, *prev;
440 struct connection_struct *conn;
441 const struct vfs_fn_pointers *fns;
443 void (*free_data)(void **data);
447 typedef struct vfs_statvfs_struct {
448 /* For undefined recommended transfer size return -1 in that field */
449 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
453 The next three fields are in terms of the block size.
454 (above). If block size is unknown, 4096 would be a
455 reasonable block size for a server to report.
456 Note that returning the blocks/blocksavail removes need
457 to make a second call (to QFSInfo level 0x103 to get this info.
458 UserBlockAvail is typically less than or equal to BlocksAvail,
459 if no distinction is made return the same value in each.
462 uint64_t TotalBlocks;
463 uint64_t BlocksAvail; /* bfree */
464 uint64_t UserBlocksAvail; /* bavail */
466 /* For undefined Node fields or FSID return -1 */
467 uint64_t TotalFileNodes;
468 uint64_t FreeFileNodes;
469 uint64_t FsIdentifier; /* fsid */
470 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
471 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
474 } vfs_statvfs_struct;
476 /* Add a new FSP extension of the given type. Returns a pointer to the
479 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
480 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
482 /* Return a pointer to the existing FSP extension data. */
483 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
484 vfs_fetch_fsp_extension(handle, (fsp))
486 /* Return the talloc context associated with an FSP extension. */
487 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
488 vfs_memctx_fsp_extension(handle, (fsp))
490 /* Remove and destroy an FSP extension. */
491 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
492 vfs_remove_fsp_extension((handle), (fsp))
494 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
495 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
496 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
501 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
503 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
506 if ((handle)->free_data) { \
507 (handle)->free_data(&(handle)->data); \
509 (handle)->data = (void *)datap; \
510 (handle)->free_data = free_fn; \
514 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
515 if ((handle) && (handle)->free_data) { \
516 (handle)->free_data(&(handle)->data); \
520 /* Check whether module-specific data handle was already allocated or not */
521 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
523 #define SMB_VFS_OP(x) ((void *) x)
525 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
527 #include "vfs_macros.h"
529 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
530 const char *service, const char *user);
531 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
532 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
533 const char *path, bool small_query,
534 uint64_t *bsize, uint64_t *dfree,
536 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
537 enum SMB_QUOTA_TYPE qtype, unid_t id,
539 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
540 enum SMB_QUOTA_TYPE qtype, unid_t id,
542 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
543 struct files_struct *fsp,
544 struct shadow_copy_data *shadow_copy_data,
546 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
547 struct vfs_statvfs_struct *statbuf);
548 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
549 enum timestamp_set_resolution *p_ts_res);
551 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
553 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
554 struct dfs_GetDFSReferral *r);
555 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
556 const char *fname, const char *mask,
558 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
559 struct files_struct *fsp,
562 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
564 SMB_STRUCT_STAT *sbuf);
565 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
566 DIR *dirp, long offset);
567 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
569 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
571 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
573 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
574 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
576 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
578 int smb_vfs_call_open(struct vfs_handle_struct *handle,
579 struct smb_filename *smb_fname, struct files_struct *fsp,
580 int flags, mode_t mode);
581 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
582 struct smb_request *req,
583 uint16_t root_dir_fid,
584 struct smb_filename *smb_fname,
585 uint32_t access_mask,
586 uint32_t share_access,
587 uint32_t create_disposition,
588 uint32_t create_options,
589 uint32_t file_attributes,
590 uint32_t oplock_request,
591 uint64_t allocation_size,
592 uint32_t private_flags,
593 struct security_descriptor *sd,
594 struct ea_list *ea_list,
595 files_struct **result,
597 int smb_vfs_call_close(struct vfs_handle_struct *handle,
598 struct files_struct *fsp);
599 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
600 struct files_struct *fsp, void *data, size_t n);
601 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
602 struct files_struct *fsp, void *data, size_t n,
604 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
605 struct files_struct *fsp, const void *data,
607 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
608 struct files_struct *fsp, const void *data,
609 size_t n, SMB_OFF_T offset);
610 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
611 struct files_struct *fsp, SMB_OFF_T offset,
613 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
614 files_struct *fromfsp, const DATA_BLOB *header,
615 SMB_OFF_T offset, size_t count);
616 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
617 files_struct *tofsp, SMB_OFF_T offset,
619 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
620 const struct smb_filename *smb_fname_src,
621 const struct smb_filename *smb_fname_dst);
622 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
623 struct files_struct *fsp);
624 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
625 struct smb_filename *smb_fname);
626 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
627 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
628 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
629 struct smb_filename *smb_filename);
630 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
631 struct files_struct *fsp,
632 const SMB_STRUCT_STAT *sbuf);
633 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
634 const struct smb_filename *smb_fname);
635 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
637 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
638 struct files_struct *fsp, mode_t mode);
639 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
640 uid_t uid, gid_t gid);
641 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
642 struct files_struct *fsp, uid_t uid, gid_t gid);
643 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
644 uid_t uid, gid_t gid);
645 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
646 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
647 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
648 const struct smb_filename *smb_fname,
649 struct smb_file_time *ft);
650 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
651 struct files_struct *fsp, SMB_OFF_T offset);
652 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
653 struct files_struct *fsp,
654 enum vfs_fallocate_mode mode,
657 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
658 struct files_struct *fsp, int op, SMB_OFF_T offset,
659 SMB_OFF_T count, int type);
660 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
661 struct files_struct *fsp, uint32 share_mode,
662 uint32_t access_mask);
663 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
664 struct files_struct *fsp, int leasetype);
665 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
666 struct files_struct *fsp, SMB_OFF_T *poffset,
667 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
668 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
669 const char *newpath);
670 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
671 const char *path, char *buf, size_t bufsiz);
672 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
673 const char *newpath);
674 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
675 mode_t mode, SMB_DEV_T dev);
676 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
677 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
678 struct sys_notify_context *ctx,
681 uint32_t *subdir_filter,
682 void (*callback)(struct sys_notify_context *ctx,
684 struct notify_event *ev),
685 void *private_data, void *handle_p);
686 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
688 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
689 const SMB_STRUCT_STAT *sbuf);
690 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
691 struct files_struct *fsp,
694 unsigned int *num_streams,
695 struct stream_struct **streams);
696 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
697 const char *path, const char *name,
698 TALLOC_CTX *mem_ctx, char **found_name);
699 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
700 const char *filename);
701 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
702 struct byte_range_lock *br_lck,
703 struct lock_struct *plock,
705 struct blocking_lock_record *blr);
706 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
707 struct messaging_context *msg_ctx,
708 struct byte_range_lock *br_lck,
709 const struct lock_struct *plock);
710 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
711 struct byte_range_lock *br_lck,
712 struct lock_struct *plock,
713 struct blocking_lock_record *blr);
714 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
715 struct files_struct *fsp,
716 struct lock_struct *plock);
717 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
718 struct files_struct *fsp,
719 struct lock_struct *plock);
720 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
722 enum vfs_translate_direction direction,
725 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
726 struct files_struct *fsp,
730 const uint8_t *_in_data,
733 uint32_t max_out_len,
735 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
736 struct files_struct *fsp,
737 uint32 security_info,
738 struct security_descriptor **ppdesc);
739 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
741 uint32 security_info,
742 struct security_descriptor **ppdesc);
743 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
744 struct files_struct *fsp,
745 uint32 security_info_sent,
746 const struct security_descriptor *psd);
747 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
749 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
750 struct files_struct *fsp, mode_t mode);
751 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
752 SMB_ACL_T theacl, int entry_id,
753 SMB_ACL_ENTRY_T *entry_p);
754 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
755 SMB_ACL_ENTRY_T entry_d,
756 SMB_ACL_TAG_T *tag_type_p);
757 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
758 SMB_ACL_ENTRY_T entry_d,
759 SMB_ACL_PERMSET_T *permset_p);
760 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
761 SMB_ACL_ENTRY_T entry_d);
762 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
764 SMB_ACL_TYPE_T type);
765 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
766 struct files_struct *fsp);
767 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
768 SMB_ACL_PERMSET_T permset);
769 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
770 SMB_ACL_PERMSET_T permset,
771 SMB_ACL_PERM_T perm);
772 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
773 SMB_ACL_T theacl, ssize_t *plen);
774 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
776 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
777 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
778 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
779 SMB_ACL_ENTRY_T entry,
780 SMB_ACL_TAG_T tagtype);
781 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
782 SMB_ACL_ENTRY_T entry, void *qual);
783 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
784 SMB_ACL_ENTRY_T entry,
785 SMB_ACL_PERMSET_T permset);
786 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
788 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
789 const char *name, SMB_ACL_TYPE_T acltype,
791 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
792 struct files_struct *fsp, SMB_ACL_T theacl);
793 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
795 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
796 SMB_ACL_PERMSET_T permset,
797 SMB_ACL_PERM_T perm);
798 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
800 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
801 SMB_ACL_T posix_acl);
802 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
803 void *qualifier, SMB_ACL_TAG_T tagtype);
804 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
805 const char *path, const char *name, void *value,
807 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
808 struct files_struct *fsp, const char *name,
809 void *value, size_t size);
810 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
811 const char *path, char *list, size_t size);
812 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
813 const char *path, char *list, size_t size);
814 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
815 struct files_struct *fsp, char *list,
817 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
818 const char *path, const char *name);
819 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
820 const char *path, const char *name);
821 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
822 struct files_struct *fsp, const char *name);
823 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
824 const char *name, const void *value, size_t size,
826 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
827 const char *name, const void *value, size_t size,
829 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
830 struct files_struct *fsp, const char *name,
831 const void *value, size_t size, int flags);
832 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
833 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
834 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
835 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
836 ssize_t smb_vfs_call_aio_return(struct vfs_handle_struct *handle,
837 struct files_struct *fsp,
838 SMB_STRUCT_AIOCB *aiocb);
839 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
840 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
841 int smb_vfs_call_aio_error(struct vfs_handle_struct *handle,
842 struct files_struct *fsp,
843 SMB_STRUCT_AIOCB *aiocb);
844 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
845 struct files_struct *fsp, int op,
846 SMB_STRUCT_AIOCB *aiocb);
847 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
848 struct files_struct *fsp,
849 const SMB_STRUCT_AIOCB * const aiocb[], int n,
850 const struct timespec *timeout);
851 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
852 struct files_struct *fsp);
853 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
854 const struct smb_filename *fname,
855 SMB_STRUCT_STAT *sbuf);
856 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
857 const struct smb_filename *fname);