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 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205 to const struct smb_filename * */
206 /* Version 37 - Change sys_acl_set_file from const char *
207 to const struct smb_filename * */
208 /* Version 37 - Change listxattr from const char *
209 to const struct smb_filename * */
210 /* Version 37 - Change removexattr from const char *
211 to const struct smb_filename * */
212 /* Version 37 - Change setxattr from const char *
213 to const struct smb_filename * */
214 /* Version 37 - Change getxattr from const char *
215 to const struct smb_filename * */
216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
217 /* Version 37 - Change chflags from const char *
218 to const struct smb_filename * */
219 /* Version 37 - Change disk_free from const char *
220 to const struct smb_filename * */
221 /* Version 37 - Change get_quota from const char *
222 to const struct smb_filename * */
223 /* Version 37 - Change link from const char *
224 to const struct smb_filename * */
225 /* Version 37 - Change statvfs from const char *
226 to const struct smb_filename * */
228 #define SMB_VFS_INTERFACE_VERSION 37
231 All intercepted VFS operations must be declared as static functions inside module source
232 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
233 example VFS modules for more details.
236 /* VFS operations structure */
238 struct vfs_handle_struct;
239 struct connection_struct;
241 struct security_descriptor;
242 struct vfs_statvfs_struct;
245 struct smb_file_time;
246 struct blocking_lock_record;
248 struct dfs_GetDFSReferral;
250 typedef union unid_t {
258 uint64_t position_information;
260 uint32_t private_options; /* NT Create options, but we only look at
261 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
262 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
263 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
264 * for print files *only*, where
265 * DELETE_ON_CLOSE is not stored in the share
268 unsigned long gen_id;
273 struct smbd_server_connection *sconn;
274 struct tevent_timer *timeout;
275 struct smb2_lease lease;
278 typedef struct files_struct {
279 struct files_struct *next, *prev;
281 struct smbXsrv_open *op;
282 struct connection_struct *conn;
283 struct fd_handle *fh;
284 unsigned int num_smb_operations;
285 struct file_id file_id;
286 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
288 uint64_t vuid; /* SMB2 compat */
289 struct write_cache *wcp;
290 struct timeval open_time;
291 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
292 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
294 bool kernel_share_modes_taken;
296 bool update_write_time_triggered;
297 struct tevent_timer *update_write_time_event;
298 bool update_write_time_on_close;
299 struct timespec close_write_time;
300 bool write_time_forced;
303 struct fsp_lease *lease;
304 int sent_oplock_break;
305 struct tevent_timer *oplock_timeout;
306 struct lock_struct last_lock_failure;
307 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
314 bool aio_write_behind;
315 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
316 bool delete_on_close;
317 uint64_t posix_flags;
319 bool backup_intent; /* Handle was successfully opened with backup intent
320 and opener has privilege to do so. */
321 bool aapl_copyfile_supported;
322 bool use_ofd_locks; /* Are we using open file description locks ? */
323 struct smb_filename *fsp_name;
324 uint32_t name_hash; /* Jenkins hash of full pathname. */
325 uint64_t mid; /* Mid of the operation that created us. */
327 struct vfs_fsp_data *vfs_extension;
328 struct fake_file_handle *fake_file_handle;
330 struct notify_change_buf *notify;
332 struct files_struct *base_fsp; /* placeholder for delete on close */
335 * Read-only cached brlock record, thrown away when the
336 * brlock.tdb seqnum changes. This avoids fetching data from
337 * the brlock.tdb on every read/write call.
340 struct byte_range_lock *brlock_rec;
342 struct dptr_struct *dptr;
344 /* if not NULL, means this is a print file */
345 struct print_file_data *print_file;
347 unsigned num_aio_requests;
348 struct tevent_req **aio_requests;
351 * If a close request comes in while we still have aio_requests
352 * around, we need to hold back the close. When all aio_requests are
353 * done, the aio completion routines need tevent_wait_done() on
354 * this. A bit ugly, but before we have close_file() fully async
355 * possibly the simplest approach. Thanks, Jeremy for the idea.
357 struct tevent_req *deferred_close;
360 #define FSP_POSIX_FLAGS_OPEN 0x01
361 #define FSP_POSIX_FLAGS_RENAME 0x02
362 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
364 #define FSP_POSIX_FLAGS_ALL \
365 (FSP_POSIX_FLAGS_OPEN | \
366 FSP_POSIX_FLAGS_PATHNAMES | \
367 FSP_POSIX_FLAGS_RENAME)
369 struct vuid_cache_entry {
370 struct auth_session_info *session_info;
371 uint64_t vuid; /* SMB2 compat */
373 uint32_t share_access;
377 unsigned int next_entry;
378 struct vuid_cache_entry array[VUID_CACHE_SIZE];
384 } name_compare_entry;
386 struct dfree_cached_info {
387 time_t last_dfree_time;
394 struct share_params {
398 typedef struct connection_struct {
399 struct connection_struct *next, *prev;
400 struct smbd_server_connection *sconn; /* can be NULL */
401 struct smbXsrv_tcon *tcon; /* can be NULL */
402 uint32_t cnum; /* an index passed over the wire */
403 struct share_params *params;
405 struct vuid_cache *vuid_cache;
408 bool read_only; /* Attributes for the current user of the share. */
409 uint32_t share_access;
410 /* Does this filesystem honor
411 sub second timestamps on files
412 and directories when setting time ? */
413 enum timestamp_set_resolution ts_res;
416 char *cwd; /* Working directory. */
418 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
421 * This represents the user information on this connection. Depending
422 * on the vuid using this tid, this might change per SMB request.
424 struct auth_session_info *session_info;
427 * If the "force group" parameter is set, this is the primary gid that
428 * may be used in the users token, depending on the vuid using this tid.
430 gid_t force_group_gid;
432 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
435 time_t lastused_count;
437 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
441 /* Semantics requested by the client or forced by the server config. */
444 bool short_case_preserve;
446 /* Semantics provided by the underlying filesystem. */
448 /* Device number of the directory of the share mount.
449 Used to ensure unique FileIndex returns. */
450 SMB_DEV_T base_share_dev;
452 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
453 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
454 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
455 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
456 struct dfree_cached_info *dfree_info;
457 struct trans_state *pending_trans;
459 struct rpc_pipe_client *spoolss_pipe;
463 struct smbd_smb2_request;
464 struct privilege_paths;
470 uint64_t mid; /* For compatibility with SMB2. */
472 uint64_t vuid; /* For compatibility with SMB2. */
478 const uint8_t *inbuf;
481 * Async handling in the main smb processing loop is directed by
482 * outbuf: reply_xxx routines indicate sync behaviour by putting their
483 * reply into "outbuf". If they leave it as NULL, they take care of it
484 * themselves, possibly later.
486 * If async handling is wanted, the reply_xxx routine must make sure
487 * that it talloc_move()s the smb_req somewhere else.
493 connection_struct *conn;
494 struct smbd_server_connection *sconn;
495 struct smbXsrv_connection *xconn;
496 struct smb_perfcount_data pcd;
499 * Chained request handling
501 struct files_struct *chain_fsp;
504 * state information for async smb handling
509 * Back pointer to smb2 request.
511 struct smbd_smb2_request *smb2req;
514 * Pathnames used if request done
517 struct privilege_paths *priv_paths;
520 * Request list for chained requests, we're part of it.
522 struct smb_request **chain;
524 struct timeval request_time;
526 bool posix_pathnames;
530 * Info about an alternate data stream
533 struct stream_struct {
540 struct smb_file_time {
541 struct timespec mtime;
542 struct timespec atime;
543 struct timespec ctime;
544 struct timespec create_time;
550 struct smb_filename {
553 char *original_lcomp;
559 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
560 * to keep the numeric values consistent.
563 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
565 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
566 handle = handle->next; \
569 enum vfs_translate_direction {
570 vfs_translate_to_unix = 0,
571 vfs_translate_to_windows
574 enum vfs_fallocate_flags {
575 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
576 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
580 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
581 * be handled as a COW clone, AKA reflink.
582 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
584 enum vfs_copy_chunk_flags {
585 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
586 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
588 VFS_COPY_CHUNK_FL_MASK_ALL =
589 (VFS_COPY_CHUNK_FL_MUST_CLONE
590 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
593 struct vfs_aio_state {
599 Available VFS operations. These values must be in sync with vfs_ops struct
600 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
601 In particular, if new operations are added to vfs_ops, appropriate constants
602 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
604 struct shadow_copy_data;
606 struct vfs_fn_pointers {
607 /* Disk operations */
609 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
610 void (*disconnect_fn)(struct vfs_handle_struct *handle);
611 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
612 const struct smb_filename *smb_fname,
616 int (*get_quota_fn)(struct vfs_handle_struct *handle,
617 const struct smb_filename *smb_fname,
618 enum SMB_QUOTA_TYPE qtype,
621 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
622 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
623 int (*statvfs_fn)(struct vfs_handle_struct *handle,
624 const struct smb_filename *smb_fname,
625 struct vfs_statvfs_struct *statbuf);
626 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
629 * Note: that "struct dfs_GetDFSReferral *r"
630 * needs to be a valid TALLOC_CTX
632 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
633 struct dfs_GetDFSReferral *r);
635 /* Directory operations */
637 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
638 const struct smb_filename *smb_fname,
640 uint32_t attributes);
641 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
642 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
644 SMB_STRUCT_STAT *sbuf);
645 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
646 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
647 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
648 int (*mkdir_fn)(struct vfs_handle_struct *handle,
649 const struct smb_filename *smb_fname,
651 int (*rmdir_fn)(struct vfs_handle_struct *handle,
652 const struct smb_filename *smb_fname);
653 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
654 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
656 /* File operations */
658 int (*open_fn)(struct vfs_handle_struct *handle,
659 struct smb_filename *smb_fname, files_struct *fsp,
660 int flags, mode_t mode);
661 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
662 struct smb_request *req,
663 uint16_t root_dir_fid,
664 struct smb_filename *smb_fname,
665 uint32_t access_mask,
666 uint32_t share_access,
667 uint32_t create_disposition,
668 uint32_t create_options,
669 uint32_t file_attributes,
670 uint32_t oplock_request,
671 struct smb2_lease *lease,
672 uint64_t allocation_size,
673 uint32_t private_flags,
674 struct security_descriptor *sd,
675 struct ea_list *ea_list,
676 files_struct **result,
678 const struct smb2_create_blobs *in_context_blobs,
679 struct smb2_create_blobs *out_context_blobs);
680 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
681 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
682 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
683 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
685 struct tevent_context *ev,
686 struct files_struct *fsp,
688 size_t n, off_t offset);
689 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
690 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
691 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
692 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
694 struct tevent_context *ev,
695 struct files_struct *fsp,
697 size_t n, off_t offset);
698 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
699 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
700 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
701 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
702 int (*rename_fn)(struct vfs_handle_struct *handle,
703 const struct smb_filename *smb_fname_src,
704 const struct smb_filename *smb_fname_dst);
705 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
706 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
708 struct tevent_context *ev,
709 struct files_struct *fsp);
710 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
711 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
712 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
713 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
714 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
715 int (*unlink_fn)(struct vfs_handle_struct *handle,
716 const struct smb_filename *smb_fname);
717 int (*chmod_fn)(struct vfs_handle_struct *handle,
718 const struct smb_filename *smb_fname,
720 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
721 int (*chown_fn)(struct vfs_handle_struct *handle,
722 const struct smb_filename *smb_fname,
725 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
726 int (*lchown_fn)(struct vfs_handle_struct *handle,
727 const struct smb_filename *smb_fname,
730 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
731 char *(*getwd_fn)(struct vfs_handle_struct *handle);
732 int (*ntimes_fn)(struct vfs_handle_struct *handle,
733 const struct smb_filename *smb_fname,
734 struct smb_file_time *ft);
735 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
736 int (*fallocate_fn)(struct vfs_handle_struct *handle,
737 struct files_struct *fsp,
741 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
742 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
743 uint32_t share_mode, uint32_t access_mask);
744 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
745 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
746 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
747 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
748 int (*link_fn)(struct vfs_handle_struct *handle,
749 const struct smb_filename *old_smb_fname,
750 const struct smb_filename *new_smb_fname);
751 int (*mknod_fn)(struct vfs_handle_struct *handle,
752 const struct smb_filename *smb_fname,
755 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
756 int (*chflags_fn)(struct vfs_handle_struct *handle,
757 const struct smb_filename *smb_fname,
759 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
760 const SMB_STRUCT_STAT *sbuf);
761 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
763 struct tevent_context *ev,
764 struct files_struct *src_fsp,
766 struct files_struct *dest_fsp,
770 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
771 struct tevent_req *req,
773 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
775 struct files_struct *fsp,
776 struct smb_filename *smb_fname,
777 uint16_t *_compression_fmt);
778 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
780 struct files_struct *fsp,
781 uint16_t compression_fmt);
782 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
784 const char *service_path,
786 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
788 const char *base_volume,
793 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
798 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
799 struct files_struct *fsp,
800 const struct smb_filename *smb_fname,
802 unsigned int *num_streams,
803 struct stream_struct **streams);
805 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
811 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
812 const char *filename);
814 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
815 struct byte_range_lock *br_lck,
816 struct lock_struct *plock,
819 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
820 struct messaging_context *msg_ctx,
821 struct byte_range_lock *br_lck,
822 const struct lock_struct *plock);
824 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
825 struct byte_range_lock *br_lck,
826 struct lock_struct *plock);
828 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
829 struct files_struct *fsp,
830 struct lock_struct *plock);
832 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
833 struct files_struct *fsp,
834 struct lock_struct *plock);
836 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
838 enum vfs_translate_direction direction,
842 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
843 struct files_struct *fsp,
847 const uint8_t *_in_data,
850 uint32_t max_out_len,
853 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
854 struct smb_filename *smb_fname,
857 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
858 struct files_struct *fsp,
861 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
862 const struct smb_filename *smb_fname,
865 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
866 struct files_struct *fsp,
869 /* NT ACL operations. */
871 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
872 struct files_struct *fsp,
873 uint32_t security_info,
875 struct security_descriptor **ppdesc);
876 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
877 const struct smb_filename *smb_fname,
878 uint32_t security_info,
880 struct security_descriptor **ppdesc);
881 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
882 struct files_struct *fsp,
883 uint32_t security_info_sent,
884 const struct security_descriptor *psd);
886 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
887 struct smb_filename *file,
888 struct security_acl *sacl,
889 uint32_t access_requested,
890 uint32_t access_denied);
892 /* POSIX ACL operations. */
894 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
895 const struct smb_filename *smb_fname,
897 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
899 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
900 const struct smb_filename *smb_fname,
902 TALLOC_CTX *mem_ctx);
903 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
904 struct files_struct *fsp,
905 TALLOC_CTX *mem_ctx);
906 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
907 const struct smb_filename *smb_fname,
909 char **blob_description,
911 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
912 TALLOC_CTX *mem_ctx, char **blob_description,
914 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
915 const struct smb_filename *smb_fname,
916 SMB_ACL_TYPE_T acltype,
918 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
919 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
920 const struct smb_filename *smb_fname);
923 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
924 const struct smb_filename *smb_fname,
928 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
929 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
930 const struct smb_filename *smb_fname,
933 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
934 int (*removexattr_fn)(struct vfs_handle_struct *handle,
935 const struct smb_filename *smb_fname,
937 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
938 int (*setxattr_fn)(struct vfs_handle_struct *handle,
939 const struct smb_filename *smb_fname,
944 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
947 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
949 /* durable handle operations */
950 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
951 struct files_struct *fsp,
954 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
955 struct files_struct *fsp,
956 const DATA_BLOB old_cookie,
958 DATA_BLOB *new_cookie);
959 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
960 struct smb_request *smb1req,
961 struct smbXsrv_open *op,
962 const DATA_BLOB old_cookie,
964 struct files_struct **fsp,
965 DATA_BLOB *new_cookie);
967 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
968 const struct smb_filename *fname,
970 struct readdir_attr_data **attr_data);
974 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
975 which describes all operations this module is willing to intercept.
976 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
977 using this information.
980 typedef struct vfs_handle_struct {
981 struct vfs_handle_struct *next, *prev;
983 struct connection_struct *conn;
984 const struct vfs_fn_pointers *fns;
986 void (*free_data)(void **data);
990 typedef struct vfs_statvfs_struct {
991 /* For undefined recommended transfer size return -1 in that field */
992 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
996 The next three fields are in terms of the block size.
997 (above). If block size is unknown, 4096 would be a
998 reasonable block size for a server to report.
999 Note that returning the blocks/blocksavail removes need
1000 to make a second call (to QFSInfo level 0x103 to get this info.
1001 UserBlockAvail is typically less than or equal to BlocksAvail,
1002 if no distinction is made return the same value in each.
1005 uint64_t TotalBlocks;
1006 uint64_t BlocksAvail; /* bfree */
1007 uint64_t UserBlocksAvail; /* bavail */
1009 /* For undefined Node fields or FSID return -1 */
1010 uint64_t TotalFileNodes;
1011 uint64_t FreeFileNodes;
1012 uint64_t FsIdentifier; /* fsid */
1013 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1014 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1017 } vfs_statvfs_struct;
1019 /* Add a new FSP extension of the given type. Returns a pointer to the
1022 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1023 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1025 /* Return a pointer to the existing FSP extension data. */
1026 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1027 vfs_fetch_fsp_extension(handle, (fsp))
1029 /* Return the talloc context associated with an FSP extension. */
1030 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1031 vfs_memctx_fsp_extension(handle, (fsp))
1033 /* Remove and destroy an FSP extension. */
1034 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1035 vfs_remove_fsp_extension((handle), (fsp))
1037 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1038 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1039 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1044 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1046 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1049 if ((handle)->free_data) { \
1050 (handle)->free_data(&(handle)->data); \
1052 (handle)->data = (void *)datap; \
1053 (handle)->free_data = free_fn; \
1057 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1058 if ((handle) && (handle)->free_data) { \
1059 (handle)->free_data(&(handle)->data); \
1063 /* Check whether module-specific data handle was already allocated or not */
1064 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1066 #define SMB_VFS_OP(x) ((void *) x)
1068 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1070 #include "vfs_macros.h"
1072 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1073 const char *service, const char *user);
1074 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1075 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1076 const struct smb_filename *smb_filename,
1080 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1081 const struct smb_filename *smb_filename,
1082 enum SMB_QUOTA_TYPE qtype,
1084 SMB_DISK_QUOTA *qt);
1085 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1086 enum SMB_QUOTA_TYPE qtype, unid_t id,
1087 SMB_DISK_QUOTA *qt);
1088 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1089 struct files_struct *fsp,
1090 struct shadow_copy_data *shadow_copy_data,
1092 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1093 const struct smb_filename *smb_fname,
1094 struct vfs_statvfs_struct *statbuf);
1095 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1096 enum timestamp_set_resolution *p_ts_res);
1098 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1100 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1101 struct dfs_GetDFSReferral *r);
1102 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1103 const struct smb_filename *smb_fname,
1105 uint32_t attributes);
1106 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1107 struct files_struct *fsp,
1109 uint32_t attributes);
1110 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1112 SMB_STRUCT_STAT *sbuf);
1113 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1114 DIR *dirp, long offset);
1115 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1117 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1119 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1120 const struct smb_filename *smb_fname,
1122 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1123 const struct smb_filename *smb_fname);
1124 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1126 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1128 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1129 struct smb_filename *smb_fname, struct files_struct *fsp,
1130 int flags, mode_t mode);
1131 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1132 struct smb_request *req,
1133 uint16_t root_dir_fid,
1134 struct smb_filename *smb_fname,
1135 uint32_t access_mask,
1136 uint32_t share_access,
1137 uint32_t create_disposition,
1138 uint32_t create_options,
1139 uint32_t file_attributes,
1140 uint32_t oplock_request,
1141 struct smb2_lease *lease,
1142 uint64_t allocation_size,
1143 uint32_t private_flags,
1144 struct security_descriptor *sd,
1145 struct ea_list *ea_list,
1146 files_struct **result,
1148 const struct smb2_create_blobs *in_context_blobs,
1149 struct smb2_create_blobs *out_context_blobs);
1150 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1151 struct files_struct *fsp);
1152 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1153 struct files_struct *fsp, void *data, size_t n);
1154 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1155 struct files_struct *fsp, void *data, size_t n,
1157 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1158 TALLOC_CTX *mem_ctx,
1159 struct tevent_context *ev,
1160 struct files_struct *fsp,
1162 size_t n, off_t offset);
1163 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1165 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1166 struct files_struct *fsp, const void *data,
1168 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1169 struct files_struct *fsp, const void *data,
1170 size_t n, off_t offset);
1171 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1172 TALLOC_CTX *mem_ctx,
1173 struct tevent_context *ev,
1174 struct files_struct *fsp,
1176 size_t n, off_t offset);
1177 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1179 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1180 struct files_struct *fsp, off_t offset,
1182 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1183 files_struct *fromfsp, const DATA_BLOB *header,
1184 off_t offset, size_t count);
1185 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1186 files_struct *tofsp, off_t offset,
1188 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1189 const struct smb_filename *smb_fname_src,
1190 const struct smb_filename *smb_fname_dst);
1191 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1192 struct files_struct *fsp);
1194 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1195 TALLOC_CTX *mem_ctx,
1196 struct tevent_context *ev,
1197 struct files_struct *fsp);
1198 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1200 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1201 struct smb_filename *smb_fname);
1202 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1203 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1204 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1205 struct smb_filename *smb_filename);
1206 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1207 struct files_struct *fsp,
1208 const SMB_STRUCT_STAT *sbuf);
1209 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1210 const struct smb_filename *smb_fname);
1211 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1212 const struct smb_filename *smb_fname,
1214 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1215 struct files_struct *fsp, mode_t mode);
1216 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1217 const struct smb_filename *smb_fname,
1220 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1221 struct files_struct *fsp, uid_t uid, gid_t gid);
1222 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1223 const struct smb_filename *smb_fname,
1226 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1227 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1228 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1229 const struct smb_filename *smb_fname,
1230 struct smb_file_time *ft);
1231 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1232 struct files_struct *fsp, off_t offset);
1233 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1234 struct files_struct *fsp,
1238 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1239 struct files_struct *fsp, int op, off_t offset,
1240 off_t count, int type);
1241 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1242 struct files_struct *fsp, uint32_t share_mode,
1243 uint32_t access_mask);
1244 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1245 struct files_struct *fsp, int leasetype);
1246 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1247 struct files_struct *fsp, off_t *poffset,
1248 off_t *pcount, int *ptype, pid_t *ppid);
1249 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1250 const char *newpath);
1251 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1252 const char *path, char *buf, size_t bufsiz);
1253 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1254 const struct smb_filename *old_smb_fname,
1255 const struct smb_filename *new_smb_fname);
1256 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1257 const struct smb_filename *smb_fname,
1260 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1261 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1262 const struct smb_filename *smb_fname,
1263 unsigned int flags);
1264 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1265 const SMB_STRUCT_STAT *sbuf);
1266 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1267 struct files_struct *fsp,
1268 const struct smb_filename *smb_fname,
1269 TALLOC_CTX *mem_ctx,
1270 unsigned int *num_streams,
1271 struct stream_struct **streams);
1272 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1273 const char *path, const char *name,
1274 TALLOC_CTX *mem_ctx, char **found_name);
1275 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1276 const char *filename);
1277 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1278 struct byte_range_lock *br_lck,
1279 struct lock_struct *plock,
1280 bool blocking_lock);
1281 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1282 struct messaging_context *msg_ctx,
1283 struct byte_range_lock *br_lck,
1284 const struct lock_struct *plock);
1285 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1286 struct byte_range_lock *br_lck,
1287 struct lock_struct *plock);
1288 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1289 struct files_struct *fsp,
1290 struct lock_struct *plock);
1291 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1292 struct files_struct *fsp,
1293 struct lock_struct *plock);
1294 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1296 enum vfs_translate_direction direction,
1297 TALLOC_CTX *mem_ctx,
1298 char **mapped_name);
1299 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1300 struct files_struct *fsp,
1304 const uint8_t *_in_data,
1306 uint8_t **_out_data,
1307 uint32_t max_out_len,
1309 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1310 struct smb_filename *smb_fname,
1312 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1313 struct files_struct *fsp,
1315 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1316 const struct smb_filename *smb_fname,
1318 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1319 struct files_struct *fsp,
1321 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1322 TALLOC_CTX *mem_ctx,
1323 struct tevent_context *ev,
1324 struct files_struct *src_fsp,
1326 struct files_struct *dest_fsp,
1330 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1331 struct tevent_req *req,
1333 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1334 TALLOC_CTX *mem_ctx,
1335 struct files_struct *fsp,
1336 struct smb_filename *smb_fname,
1337 uint16_t *_compression_fmt);
1338 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1339 TALLOC_CTX *mem_ctx,
1340 struct files_struct *fsp,
1341 uint16_t compression_fmt);
1342 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1343 TALLOC_CTX *mem_ctx,
1344 const char *service_path,
1345 char **base_volume);
1346 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1347 TALLOC_CTX *mem_ctx,
1348 const char *base_volume,
1353 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1354 TALLOC_CTX *mem_ctx,
1357 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1358 struct files_struct *fsp,
1359 uint32_t security_info,
1360 TALLOC_CTX *mem_ctx,
1361 struct security_descriptor **ppdesc);
1362 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1363 const struct smb_filename *smb_fname,
1364 uint32_t security_info,
1365 TALLOC_CTX *mem_ctx,
1366 struct security_descriptor **ppdesc);
1367 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1368 struct files_struct *fsp,
1369 uint32_t security_info_sent,
1370 const struct security_descriptor *psd);
1371 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1372 struct smb_filename *file,
1373 struct security_acl *sacl,
1374 uint32_t access_requested,
1375 uint32_t access_denied);
1376 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1377 const struct smb_filename *file,
1379 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1380 struct files_struct *fsp, mode_t mode);
1381 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1382 const struct smb_filename *smb_fname,
1383 SMB_ACL_TYPE_T type,
1384 TALLOC_CTX *mem_ctx);
1385 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1386 struct files_struct *fsp,
1387 TALLOC_CTX *mem_ctx);
1388 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1389 const struct smb_filename *smb_fname,
1390 TALLOC_CTX *mem_ctx,
1391 char **blob_description,
1393 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1394 struct files_struct *fsp,
1395 TALLOC_CTX *mem_ctx,
1396 char **blob_description,
1398 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1399 const struct smb_filename *smb_fname,
1400 SMB_ACL_TYPE_T acltype,
1402 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1403 struct files_struct *fsp, SMB_ACL_T theacl);
1404 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1405 const struct smb_filename *smb_fname);
1406 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1407 const struct smb_filename *smb_fname,
1411 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1412 struct files_struct *fsp, const char *name,
1413 void *value, size_t size);
1414 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1415 const struct smb_filename *smb_fname,
1418 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1419 struct files_struct *fsp, char *list,
1421 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1422 const struct smb_filename *smb_fname,
1424 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1425 struct files_struct *fsp, const char *name);
1426 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1427 const struct smb_filename *smb_fname,
1432 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1433 const char *name, const void *value, size_t size,
1435 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1436 struct files_struct *fsp, const char *name,
1437 const void *value, size_t size, int flags);
1438 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1439 struct files_struct *fsp);
1440 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1441 const struct smb_filename *fname,
1442 SMB_STRUCT_STAT *sbuf);
1443 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1444 const struct smb_filename *fname);
1445 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1446 struct files_struct *fsp,
1447 TALLOC_CTX *mem_ctx,
1449 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1450 struct files_struct *fsp,
1451 const DATA_BLOB old_cookie,
1452 TALLOC_CTX *mem_ctx,
1453 DATA_BLOB *new_cookie);
1454 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1455 struct smb_request *smb1req,
1456 struct smbXsrv_open *op,
1457 const DATA_BLOB old_cookie,
1458 TALLOC_CTX *mem_ctx,
1459 struct files_struct **fsp,
1460 DATA_BLOB *new_cookie);
1461 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1462 const struct smb_filename *fname,
1463 TALLOC_CTX *mem_ctx,
1464 struct readdir_attr_data **attr_data);
1466 NTSTATUS smb_register_vfs(int version, const char *name,
1467 const struct vfs_fn_pointers *fns);
1468 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1469 files_struct *fsp, size_t ext_size,
1470 void (*destroy_fn)(void *p_data));
1471 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1472 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1473 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1474 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1476 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1477 const char *module);