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 * */
227 /* Version 37 - Change readlink from const char *
228 to const struct smb_filename * */
230 #define SMB_VFS_INTERFACE_VERSION 37
233 All intercepted VFS operations must be declared as static functions inside module source
234 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
235 example VFS modules for more details.
238 /* VFS operations structure */
240 struct vfs_handle_struct;
241 struct connection_struct;
243 struct security_descriptor;
244 struct vfs_statvfs_struct;
247 struct smb_file_time;
248 struct blocking_lock_record;
250 struct dfs_GetDFSReferral;
252 typedef union unid_t {
260 uint64_t position_information;
262 uint32_t private_options; /* NT Create options, but we only look at
263 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
264 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
265 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
266 * for print files *only*, where
267 * DELETE_ON_CLOSE is not stored in the share
270 unsigned long gen_id;
275 struct smbd_server_connection *sconn;
276 struct tevent_timer *timeout;
277 struct smb2_lease lease;
280 typedef struct files_struct {
281 struct files_struct *next, *prev;
283 struct smbXsrv_open *op;
284 struct connection_struct *conn;
285 struct fd_handle *fh;
286 unsigned int num_smb_operations;
287 struct file_id file_id;
288 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
290 uint64_t vuid; /* SMB2 compat */
291 struct write_cache *wcp;
292 struct timeval open_time;
293 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
294 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
296 bool kernel_share_modes_taken;
298 bool update_write_time_triggered;
299 struct tevent_timer *update_write_time_event;
300 bool update_write_time_on_close;
301 struct timespec close_write_time;
302 bool write_time_forced;
305 struct fsp_lease *lease;
306 int sent_oplock_break;
307 struct tevent_timer *oplock_timeout;
308 struct lock_struct last_lock_failure;
309 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
316 bool aio_write_behind;
317 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
318 bool delete_on_close;
319 uint64_t posix_flags;
321 bool backup_intent; /* Handle was successfully opened with backup intent
322 and opener has privilege to do so. */
323 bool aapl_copyfile_supported;
324 bool use_ofd_locks; /* Are we using open file description locks ? */
325 struct smb_filename *fsp_name;
326 uint32_t name_hash; /* Jenkins hash of full pathname. */
327 uint64_t mid; /* Mid of the operation that created us. */
329 struct vfs_fsp_data *vfs_extension;
330 struct fake_file_handle *fake_file_handle;
332 struct notify_change_buf *notify;
334 struct files_struct *base_fsp; /* placeholder for delete on close */
337 * Read-only cached brlock record, thrown away when the
338 * brlock.tdb seqnum changes. This avoids fetching data from
339 * the brlock.tdb on every read/write call.
342 struct byte_range_lock *brlock_rec;
344 struct dptr_struct *dptr;
346 /* if not NULL, means this is a print file */
347 struct print_file_data *print_file;
349 unsigned num_aio_requests;
350 struct tevent_req **aio_requests;
353 * If a close request comes in while we still have aio_requests
354 * around, we need to hold back the close. When all aio_requests are
355 * done, the aio completion routines need tevent_wait_done() on
356 * this. A bit ugly, but before we have close_file() fully async
357 * possibly the simplest approach. Thanks, Jeremy for the idea.
359 struct tevent_req *deferred_close;
362 #define FSP_POSIX_FLAGS_OPEN 0x01
363 #define FSP_POSIX_FLAGS_RENAME 0x02
364 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
366 #define FSP_POSIX_FLAGS_ALL \
367 (FSP_POSIX_FLAGS_OPEN | \
368 FSP_POSIX_FLAGS_PATHNAMES | \
369 FSP_POSIX_FLAGS_RENAME)
371 struct vuid_cache_entry {
372 struct auth_session_info *session_info;
373 uint64_t vuid; /* SMB2 compat */
375 uint32_t share_access;
379 unsigned int next_entry;
380 struct vuid_cache_entry array[VUID_CACHE_SIZE];
386 } name_compare_entry;
388 struct dfree_cached_info {
389 time_t last_dfree_time;
396 struct share_params {
400 typedef struct connection_struct {
401 struct connection_struct *next, *prev;
402 struct smbd_server_connection *sconn; /* can be NULL */
403 struct smbXsrv_tcon *tcon; /* can be NULL */
404 uint32_t cnum; /* an index passed over the wire */
405 struct share_params *params;
407 struct vuid_cache *vuid_cache;
410 bool read_only; /* Attributes for the current user of the share. */
411 uint32_t share_access;
412 /* Does this filesystem honor
413 sub second timestamps on files
414 and directories when setting time ? */
415 enum timestamp_set_resolution ts_res;
418 char *cwd; /* Working directory. */
420 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
423 * This represents the user information on this connection. Depending
424 * on the vuid using this tid, this might change per SMB request.
426 struct auth_session_info *session_info;
429 * If the "force group" parameter is set, this is the primary gid that
430 * may be used in the users token, depending on the vuid using this tid.
432 gid_t force_group_gid;
434 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
437 time_t lastused_count;
439 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
443 /* Semantics requested by the client or forced by the server config. */
446 bool short_case_preserve;
448 /* Semantics provided by the underlying filesystem. */
450 /* Device number of the directory of the share mount.
451 Used to ensure unique FileIndex returns. */
452 SMB_DEV_T base_share_dev;
454 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
455 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
456 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
457 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
458 struct dfree_cached_info *dfree_info;
459 struct trans_state *pending_trans;
461 struct rpc_pipe_client *spoolss_pipe;
465 struct smbd_smb2_request;
466 struct privilege_paths;
472 uint64_t mid; /* For compatibility with SMB2. */
474 uint64_t vuid; /* For compatibility with SMB2. */
480 const uint8_t *inbuf;
483 * Async handling in the main smb processing loop is directed by
484 * outbuf: reply_xxx routines indicate sync behaviour by putting their
485 * reply into "outbuf". If they leave it as NULL, they take care of it
486 * themselves, possibly later.
488 * If async handling is wanted, the reply_xxx routine must make sure
489 * that it talloc_move()s the smb_req somewhere else.
495 connection_struct *conn;
496 struct smbd_server_connection *sconn;
497 struct smbXsrv_connection *xconn;
498 struct smb_perfcount_data pcd;
501 * Chained request handling
503 struct files_struct *chain_fsp;
506 * state information for async smb handling
511 * Back pointer to smb2 request.
513 struct smbd_smb2_request *smb2req;
516 * Pathnames used if request done
519 struct privilege_paths *priv_paths;
522 * Request list for chained requests, we're part of it.
524 struct smb_request **chain;
526 struct timeval request_time;
528 bool posix_pathnames;
532 * Info about an alternate data stream
535 struct stream_struct {
542 struct smb_file_time {
543 struct timespec mtime;
544 struct timespec atime;
545 struct timespec ctime;
546 struct timespec create_time;
552 struct smb_filename {
555 char *original_lcomp;
561 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
562 * to keep the numeric values consistent.
565 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
567 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
568 handle = handle->next; \
571 enum vfs_translate_direction {
572 vfs_translate_to_unix = 0,
573 vfs_translate_to_windows
576 enum vfs_fallocate_flags {
577 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
578 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
582 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
583 * be handled as a COW clone, AKA reflink.
584 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
586 enum vfs_copy_chunk_flags {
587 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
588 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
590 VFS_COPY_CHUNK_FL_MASK_ALL =
591 (VFS_COPY_CHUNK_FL_MUST_CLONE
592 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
595 struct vfs_aio_state {
601 Available VFS operations. These values must be in sync with vfs_ops struct
602 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
603 In particular, if new operations are added to vfs_ops, appropriate constants
604 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
606 struct shadow_copy_data;
608 struct vfs_fn_pointers {
609 /* Disk operations */
611 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
612 void (*disconnect_fn)(struct vfs_handle_struct *handle);
613 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
614 const struct smb_filename *smb_fname,
618 int (*get_quota_fn)(struct vfs_handle_struct *handle,
619 const struct smb_filename *smb_fname,
620 enum SMB_QUOTA_TYPE qtype,
623 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
624 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
625 int (*statvfs_fn)(struct vfs_handle_struct *handle,
626 const struct smb_filename *smb_fname,
627 struct vfs_statvfs_struct *statbuf);
628 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
631 * Note: that "struct dfs_GetDFSReferral *r"
632 * needs to be a valid TALLOC_CTX
634 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
635 struct dfs_GetDFSReferral *r);
637 /* Directory operations */
639 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
640 const struct smb_filename *smb_fname,
642 uint32_t attributes);
643 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
644 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
646 SMB_STRUCT_STAT *sbuf);
647 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
648 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
649 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
650 int (*mkdir_fn)(struct vfs_handle_struct *handle,
651 const struct smb_filename *smb_fname,
653 int (*rmdir_fn)(struct vfs_handle_struct *handle,
654 const struct smb_filename *smb_fname);
655 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
656 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
658 /* File operations */
660 int (*open_fn)(struct vfs_handle_struct *handle,
661 struct smb_filename *smb_fname, files_struct *fsp,
662 int flags, mode_t mode);
663 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
664 struct smb_request *req,
665 uint16_t root_dir_fid,
666 struct smb_filename *smb_fname,
667 uint32_t access_mask,
668 uint32_t share_access,
669 uint32_t create_disposition,
670 uint32_t create_options,
671 uint32_t file_attributes,
672 uint32_t oplock_request,
673 struct smb2_lease *lease,
674 uint64_t allocation_size,
675 uint32_t private_flags,
676 struct security_descriptor *sd,
677 struct ea_list *ea_list,
678 files_struct **result,
680 const struct smb2_create_blobs *in_context_blobs,
681 struct smb2_create_blobs *out_context_blobs);
682 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
683 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
684 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
685 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
687 struct tevent_context *ev,
688 struct files_struct *fsp,
690 size_t n, off_t offset);
691 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
692 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
693 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
694 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
696 struct tevent_context *ev,
697 struct files_struct *fsp,
699 size_t n, off_t offset);
700 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
701 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
702 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
703 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
704 int (*rename_fn)(struct vfs_handle_struct *handle,
705 const struct smb_filename *smb_fname_src,
706 const struct smb_filename *smb_fname_dst);
707 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
708 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
710 struct tevent_context *ev,
711 struct files_struct *fsp);
712 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
713 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
714 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
715 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
716 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
717 int (*unlink_fn)(struct vfs_handle_struct *handle,
718 const struct smb_filename *smb_fname);
719 int (*chmod_fn)(struct vfs_handle_struct *handle,
720 const struct smb_filename *smb_fname,
722 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
723 int (*chown_fn)(struct vfs_handle_struct *handle,
724 const struct smb_filename *smb_fname,
727 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
728 int (*lchown_fn)(struct vfs_handle_struct *handle,
729 const struct smb_filename *smb_fname,
732 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
733 char *(*getwd_fn)(struct vfs_handle_struct *handle);
734 int (*ntimes_fn)(struct vfs_handle_struct *handle,
735 const struct smb_filename *smb_fname,
736 struct smb_file_time *ft);
737 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
738 int (*fallocate_fn)(struct vfs_handle_struct *handle,
739 struct files_struct *fsp,
743 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
744 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
745 uint32_t share_mode, uint32_t access_mask);
746 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
747 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
748 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
749 int (*readlink_fn)(struct vfs_handle_struct *handle,
750 const struct smb_filename *smb_fname,
753 int (*link_fn)(struct vfs_handle_struct *handle,
754 const struct smb_filename *old_smb_fname,
755 const struct smb_filename *new_smb_fname);
756 int (*mknod_fn)(struct vfs_handle_struct *handle,
757 const struct smb_filename *smb_fname,
760 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
761 int (*chflags_fn)(struct vfs_handle_struct *handle,
762 const struct smb_filename *smb_fname,
764 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
765 const SMB_STRUCT_STAT *sbuf);
766 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
768 struct tevent_context *ev,
769 struct files_struct *src_fsp,
771 struct files_struct *dest_fsp,
775 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
776 struct tevent_req *req,
778 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
780 struct files_struct *fsp,
781 struct smb_filename *smb_fname,
782 uint16_t *_compression_fmt);
783 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
785 struct files_struct *fsp,
786 uint16_t compression_fmt);
787 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
789 const char *service_path,
791 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
793 const char *base_volume,
798 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
803 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 const struct smb_filename *smb_fname,
807 unsigned int *num_streams,
808 struct stream_struct **streams);
810 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
816 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
817 const char *filename);
819 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
820 struct byte_range_lock *br_lck,
821 struct lock_struct *plock,
824 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
825 struct messaging_context *msg_ctx,
826 struct byte_range_lock *br_lck,
827 const struct lock_struct *plock);
829 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
830 struct byte_range_lock *br_lck,
831 struct lock_struct *plock);
833 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
834 struct files_struct *fsp,
835 struct lock_struct *plock);
837 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
838 struct files_struct *fsp,
839 struct lock_struct *plock);
841 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
843 enum vfs_translate_direction direction,
847 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
848 struct files_struct *fsp,
852 const uint8_t *_in_data,
855 uint32_t max_out_len,
858 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
859 struct smb_filename *smb_fname,
862 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
863 struct files_struct *fsp,
866 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
867 const struct smb_filename *smb_fname,
870 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
871 struct files_struct *fsp,
874 /* NT ACL operations. */
876 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
877 struct files_struct *fsp,
878 uint32_t security_info,
880 struct security_descriptor **ppdesc);
881 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
882 const struct smb_filename *smb_fname,
883 uint32_t security_info,
885 struct security_descriptor **ppdesc);
886 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
887 struct files_struct *fsp,
888 uint32_t security_info_sent,
889 const struct security_descriptor *psd);
891 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
892 struct smb_filename *file,
893 struct security_acl *sacl,
894 uint32_t access_requested,
895 uint32_t access_denied);
897 /* POSIX ACL operations. */
899 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
900 const struct smb_filename *smb_fname,
902 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
904 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
905 const struct smb_filename *smb_fname,
907 TALLOC_CTX *mem_ctx);
908 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
909 struct files_struct *fsp,
910 TALLOC_CTX *mem_ctx);
911 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
912 const struct smb_filename *smb_fname,
914 char **blob_description,
916 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
917 TALLOC_CTX *mem_ctx, char **blob_description,
919 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
920 const struct smb_filename *smb_fname,
921 SMB_ACL_TYPE_T acltype,
923 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
924 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
925 const struct smb_filename *smb_fname);
928 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
929 const struct smb_filename *smb_fname,
933 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
934 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
935 const struct smb_filename *smb_fname,
938 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
939 int (*removexattr_fn)(struct vfs_handle_struct *handle,
940 const struct smb_filename *smb_fname,
942 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
943 int (*setxattr_fn)(struct vfs_handle_struct *handle,
944 const struct smb_filename *smb_fname,
949 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
952 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
954 /* durable handle operations */
955 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
956 struct files_struct *fsp,
959 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
960 struct files_struct *fsp,
961 const DATA_BLOB old_cookie,
963 DATA_BLOB *new_cookie);
964 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
965 struct smb_request *smb1req,
966 struct smbXsrv_open *op,
967 const DATA_BLOB old_cookie,
969 struct files_struct **fsp,
970 DATA_BLOB *new_cookie);
972 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
973 const struct smb_filename *fname,
975 struct readdir_attr_data **attr_data);
979 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
980 which describes all operations this module is willing to intercept.
981 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
982 using this information.
985 typedef struct vfs_handle_struct {
986 struct vfs_handle_struct *next, *prev;
988 struct connection_struct *conn;
989 const struct vfs_fn_pointers *fns;
991 void (*free_data)(void **data);
995 typedef struct vfs_statvfs_struct {
996 /* For undefined recommended transfer size return -1 in that field */
997 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1001 The next three fields are in terms of the block size.
1002 (above). If block size is unknown, 4096 would be a
1003 reasonable block size for a server to report.
1004 Note that returning the blocks/blocksavail removes need
1005 to make a second call (to QFSInfo level 0x103 to get this info.
1006 UserBlockAvail is typically less than or equal to BlocksAvail,
1007 if no distinction is made return the same value in each.
1010 uint64_t TotalBlocks;
1011 uint64_t BlocksAvail; /* bfree */
1012 uint64_t UserBlocksAvail; /* bavail */
1014 /* For undefined Node fields or FSID return -1 */
1015 uint64_t TotalFileNodes;
1016 uint64_t FreeFileNodes;
1017 uint64_t FsIdentifier; /* fsid */
1018 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1019 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1022 } vfs_statvfs_struct;
1024 /* Add a new FSP extension of the given type. Returns a pointer to the
1027 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1028 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1030 /* Return a pointer to the existing FSP extension data. */
1031 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1032 vfs_fetch_fsp_extension(handle, (fsp))
1034 /* Return the talloc context associated with an FSP extension. */
1035 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1036 vfs_memctx_fsp_extension(handle, (fsp))
1038 /* Remove and destroy an FSP extension. */
1039 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1040 vfs_remove_fsp_extension((handle), (fsp))
1042 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1043 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1044 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1049 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1051 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1054 if ((handle)->free_data) { \
1055 (handle)->free_data(&(handle)->data); \
1057 (handle)->data = (void *)datap; \
1058 (handle)->free_data = free_fn; \
1062 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1063 if ((handle) && (handle)->free_data) { \
1064 (handle)->free_data(&(handle)->data); \
1068 /* Check whether module-specific data handle was already allocated or not */
1069 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1071 #define SMB_VFS_OP(x) ((void *) x)
1073 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1075 #include "vfs_macros.h"
1077 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1078 const char *service, const char *user);
1079 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1080 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1081 const struct smb_filename *smb_filename,
1085 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1086 const struct smb_filename *smb_filename,
1087 enum SMB_QUOTA_TYPE qtype,
1089 SMB_DISK_QUOTA *qt);
1090 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1091 enum SMB_QUOTA_TYPE qtype, unid_t id,
1092 SMB_DISK_QUOTA *qt);
1093 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1094 struct files_struct *fsp,
1095 struct shadow_copy_data *shadow_copy_data,
1097 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1098 const struct smb_filename *smb_fname,
1099 struct vfs_statvfs_struct *statbuf);
1100 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1101 enum timestamp_set_resolution *p_ts_res);
1103 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1105 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1106 struct dfs_GetDFSReferral *r);
1107 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1108 const struct smb_filename *smb_fname,
1110 uint32_t attributes);
1111 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1112 struct files_struct *fsp,
1114 uint32_t attributes);
1115 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1117 SMB_STRUCT_STAT *sbuf);
1118 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1119 DIR *dirp, long offset);
1120 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1122 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1124 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1125 const struct smb_filename *smb_fname,
1127 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1128 const struct smb_filename *smb_fname);
1129 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1131 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1133 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1134 struct smb_filename *smb_fname, struct files_struct *fsp,
1135 int flags, mode_t mode);
1136 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1137 struct smb_request *req,
1138 uint16_t root_dir_fid,
1139 struct smb_filename *smb_fname,
1140 uint32_t access_mask,
1141 uint32_t share_access,
1142 uint32_t create_disposition,
1143 uint32_t create_options,
1144 uint32_t file_attributes,
1145 uint32_t oplock_request,
1146 struct smb2_lease *lease,
1147 uint64_t allocation_size,
1148 uint32_t private_flags,
1149 struct security_descriptor *sd,
1150 struct ea_list *ea_list,
1151 files_struct **result,
1153 const struct smb2_create_blobs *in_context_blobs,
1154 struct smb2_create_blobs *out_context_blobs);
1155 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1156 struct files_struct *fsp);
1157 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1158 struct files_struct *fsp, void *data, size_t n);
1159 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1160 struct files_struct *fsp, void *data, size_t n,
1162 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1163 TALLOC_CTX *mem_ctx,
1164 struct tevent_context *ev,
1165 struct files_struct *fsp,
1167 size_t n, off_t offset);
1168 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1170 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1171 struct files_struct *fsp, const void *data,
1173 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1174 struct files_struct *fsp, const void *data,
1175 size_t n, off_t offset);
1176 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1177 TALLOC_CTX *mem_ctx,
1178 struct tevent_context *ev,
1179 struct files_struct *fsp,
1181 size_t n, off_t offset);
1182 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1184 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1185 struct files_struct *fsp, off_t offset,
1187 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1188 files_struct *fromfsp, const DATA_BLOB *header,
1189 off_t offset, size_t count);
1190 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1191 files_struct *tofsp, off_t offset,
1193 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1194 const struct smb_filename *smb_fname_src,
1195 const struct smb_filename *smb_fname_dst);
1196 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1197 struct files_struct *fsp);
1199 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1200 TALLOC_CTX *mem_ctx,
1201 struct tevent_context *ev,
1202 struct files_struct *fsp);
1203 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1205 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1206 struct smb_filename *smb_fname);
1207 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1208 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1209 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1210 struct smb_filename *smb_filename);
1211 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1212 struct files_struct *fsp,
1213 const SMB_STRUCT_STAT *sbuf);
1214 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1215 const struct smb_filename *smb_fname);
1216 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1217 const struct smb_filename *smb_fname,
1219 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1220 struct files_struct *fsp, mode_t mode);
1221 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1222 const struct smb_filename *smb_fname,
1225 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1226 struct files_struct *fsp, uid_t uid, gid_t gid);
1227 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1228 const struct smb_filename *smb_fname,
1231 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1232 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1233 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1234 const struct smb_filename *smb_fname,
1235 struct smb_file_time *ft);
1236 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1237 struct files_struct *fsp, off_t offset);
1238 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1239 struct files_struct *fsp,
1243 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1244 struct files_struct *fsp, int op, off_t offset,
1245 off_t count, int type);
1246 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1247 struct files_struct *fsp, uint32_t share_mode,
1248 uint32_t access_mask);
1249 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1250 struct files_struct *fsp, int leasetype);
1251 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1252 struct files_struct *fsp, off_t *poffset,
1253 off_t *pcount, int *ptype, pid_t *ppid);
1254 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1255 const char *newpath);
1256 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1257 const struct smb_filename *smb_fname,
1260 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1261 const struct smb_filename *old_smb_fname,
1262 const struct smb_filename *new_smb_fname);
1263 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1264 const struct smb_filename *smb_fname,
1267 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1268 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1269 const struct smb_filename *smb_fname,
1270 unsigned int flags);
1271 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1272 const SMB_STRUCT_STAT *sbuf);
1273 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1274 struct files_struct *fsp,
1275 const struct smb_filename *smb_fname,
1276 TALLOC_CTX *mem_ctx,
1277 unsigned int *num_streams,
1278 struct stream_struct **streams);
1279 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1280 const char *path, const char *name,
1281 TALLOC_CTX *mem_ctx, char **found_name);
1282 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1283 const char *filename);
1284 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1285 struct byte_range_lock *br_lck,
1286 struct lock_struct *plock,
1287 bool blocking_lock);
1288 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1289 struct messaging_context *msg_ctx,
1290 struct byte_range_lock *br_lck,
1291 const struct lock_struct *plock);
1292 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1293 struct byte_range_lock *br_lck,
1294 struct lock_struct *plock);
1295 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1296 struct files_struct *fsp,
1297 struct lock_struct *plock);
1298 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1299 struct files_struct *fsp,
1300 struct lock_struct *plock);
1301 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1303 enum vfs_translate_direction direction,
1304 TALLOC_CTX *mem_ctx,
1305 char **mapped_name);
1306 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1307 struct files_struct *fsp,
1311 const uint8_t *_in_data,
1313 uint8_t **_out_data,
1314 uint32_t max_out_len,
1316 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1317 struct smb_filename *smb_fname,
1319 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1320 struct files_struct *fsp,
1322 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1323 const struct smb_filename *smb_fname,
1325 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1326 struct files_struct *fsp,
1328 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1329 TALLOC_CTX *mem_ctx,
1330 struct tevent_context *ev,
1331 struct files_struct *src_fsp,
1333 struct files_struct *dest_fsp,
1337 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1338 struct tevent_req *req,
1340 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1341 TALLOC_CTX *mem_ctx,
1342 struct files_struct *fsp,
1343 struct smb_filename *smb_fname,
1344 uint16_t *_compression_fmt);
1345 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1346 TALLOC_CTX *mem_ctx,
1347 struct files_struct *fsp,
1348 uint16_t compression_fmt);
1349 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1350 TALLOC_CTX *mem_ctx,
1351 const char *service_path,
1352 char **base_volume);
1353 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1354 TALLOC_CTX *mem_ctx,
1355 const char *base_volume,
1360 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1361 TALLOC_CTX *mem_ctx,
1364 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1365 struct files_struct *fsp,
1366 uint32_t security_info,
1367 TALLOC_CTX *mem_ctx,
1368 struct security_descriptor **ppdesc);
1369 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1370 const struct smb_filename *smb_fname,
1371 uint32_t security_info,
1372 TALLOC_CTX *mem_ctx,
1373 struct security_descriptor **ppdesc);
1374 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1375 struct files_struct *fsp,
1376 uint32_t security_info_sent,
1377 const struct security_descriptor *psd);
1378 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1379 struct smb_filename *file,
1380 struct security_acl *sacl,
1381 uint32_t access_requested,
1382 uint32_t access_denied);
1383 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1384 const struct smb_filename *file,
1386 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1387 struct files_struct *fsp, mode_t mode);
1388 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1389 const struct smb_filename *smb_fname,
1390 SMB_ACL_TYPE_T type,
1391 TALLOC_CTX *mem_ctx);
1392 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1393 struct files_struct *fsp,
1394 TALLOC_CTX *mem_ctx);
1395 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1396 const struct smb_filename *smb_fname,
1397 TALLOC_CTX *mem_ctx,
1398 char **blob_description,
1400 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1401 struct files_struct *fsp,
1402 TALLOC_CTX *mem_ctx,
1403 char **blob_description,
1405 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1406 const struct smb_filename *smb_fname,
1407 SMB_ACL_TYPE_T acltype,
1409 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1410 struct files_struct *fsp, SMB_ACL_T theacl);
1411 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1412 const struct smb_filename *smb_fname);
1413 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1414 const struct smb_filename *smb_fname,
1418 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1419 struct files_struct *fsp, const char *name,
1420 void *value, size_t size);
1421 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1422 const struct smb_filename *smb_fname,
1425 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1426 struct files_struct *fsp, char *list,
1428 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1429 const struct smb_filename *smb_fname,
1431 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1432 struct files_struct *fsp, const char *name);
1433 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1434 const struct smb_filename *smb_fname,
1439 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1440 const char *name, const void *value, size_t size,
1442 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1443 struct files_struct *fsp, const char *name,
1444 const void *value, size_t size, int flags);
1445 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1446 struct files_struct *fsp);
1447 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1448 const struct smb_filename *fname,
1449 SMB_STRUCT_STAT *sbuf);
1450 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1451 const struct smb_filename *fname);
1452 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1453 struct files_struct *fsp,
1454 TALLOC_CTX *mem_ctx,
1456 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1457 struct files_struct *fsp,
1458 const DATA_BLOB old_cookie,
1459 TALLOC_CTX *mem_ctx,
1460 DATA_BLOB *new_cookie);
1461 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1462 struct smb_request *smb1req,
1463 struct smbXsrv_open *op,
1464 const DATA_BLOB old_cookie,
1465 TALLOC_CTX *mem_ctx,
1466 struct files_struct **fsp,
1467 DATA_BLOB *new_cookie);
1468 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1469 const struct smb_filename *fname,
1470 TALLOC_CTX *mem_ctx,
1471 struct readdir_attr_data **attr_data);
1473 NTSTATUS smb_register_vfs(int version, const char *name,
1474 const struct vfs_fn_pointers *fns);
1475 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1476 files_struct *fsp, size_t ext_size,
1477 void (*destroy_fn)(void *p_data));
1478 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1479 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1480 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1481 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1483 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1484 const char *module);