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 * */
229 /* Version 37 - Change symlink from const char *
230 to const struct smb_filename * */
231 /* Version 37 - Change chdir from const char *
232 to const struct smb_filename * */
233 /* Version 37 - Change getwd from char *
234 to const struct smb_filename * */
235 /* Version 37 - Change conn->cwd from char *
236 to struct smb_filename * */
237 /* Version 37 - Change realpath from char *
238 to struct smb_filename * */
239 /* Version 37 - Change connectpath from char *
240 to struct smb_filename * */
241 /* Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND/RECV */
242 /* Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND/RECV to
243 SMB_VFS_OFFLOAD_READ_SEND/RECV */
244 /* Version 37 - Remove SMB_VFS_STRICT_UNLOCK */
246 #define SMB_VFS_INTERFACE_VERSION 37
249 All intercepted VFS operations must be declared as static functions inside module source
250 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
251 example VFS modules for more details.
254 /* VFS operations structure */
256 struct vfs_handle_struct;
257 struct connection_struct;
259 struct security_descriptor;
260 struct vfs_statvfs_struct;
263 struct smb_file_time;
264 struct blocking_lock_record;
266 struct dfs_GetDFSReferral;
268 typedef union unid_t {
276 uint64_t position_information;
278 uint32_t private_options; /* NT Create options, but we only look at
279 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
280 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
281 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
282 * for print files *only*, where
283 * DELETE_ON_CLOSE is not stored in the share
286 unsigned long gen_id;
291 struct smbd_server_connection *sconn;
292 struct tevent_timer *timeout;
293 struct smb2_lease lease;
296 typedef struct files_struct {
297 struct files_struct *next, *prev;
299 struct smbXsrv_open *op;
300 struct connection_struct *conn;
301 struct fd_handle *fh;
302 unsigned int num_smb_operations;
303 struct file_id file_id;
304 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
306 uint64_t vuid; /* SMB2 compat */
307 struct write_cache *wcp;
308 struct timeval open_time;
309 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
310 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
312 bool kernel_share_modes_taken;
314 bool update_write_time_triggered;
315 struct tevent_timer *update_write_time_event;
316 bool update_write_time_on_close;
317 struct timespec close_write_time;
318 bool write_time_forced;
321 struct fsp_lease *lease;
322 int sent_oplock_break;
323 struct tevent_timer *oplock_timeout;
324 struct lock_struct last_lock_failure;
325 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
332 bool aio_write_behind;
333 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
334 bool delete_on_close;
335 uint64_t posix_flags;
337 bool backup_intent; /* Handle was successfully opened with backup intent
338 and opener has privilege to do so. */
339 bool use_ofd_locks; /* Are we using open file description locks ? */
340 struct smb_filename *fsp_name;
341 uint32_t name_hash; /* Jenkins hash of full pathname. */
342 uint64_t mid; /* Mid of the operation that created us. */
344 struct vfs_fsp_data *vfs_extension;
345 struct fake_file_handle *fake_file_handle;
347 struct notify_change_buf *notify;
349 struct files_struct *base_fsp; /* placeholder for delete on close */
352 * Read-only cached brlock record, thrown away when the
353 * brlock.tdb seqnum changes. This avoids fetching data from
354 * the brlock.tdb on every read/write call.
357 struct byte_range_lock *brlock_rec;
359 struct dptr_struct *dptr;
361 /* if not NULL, means this is a print file */
362 struct print_file_data *print_file;
364 unsigned num_aio_requests;
365 struct tevent_req **aio_requests;
368 * If a close request comes in while we still have aio_requests
369 * around, we need to hold back the close. When all aio_requests are
370 * done, the aio completion routines need tevent_wait_done() on
371 * this. A bit ugly, but before we have close_file() fully async
372 * possibly the simplest approach. Thanks, Jeremy for the idea.
374 struct tevent_req *deferred_close;
377 #define FSP_POSIX_FLAGS_OPEN 0x01
378 #define FSP_POSIX_FLAGS_RENAME 0x02
379 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
381 #define FSP_POSIX_FLAGS_ALL \
382 (FSP_POSIX_FLAGS_OPEN | \
383 FSP_POSIX_FLAGS_PATHNAMES | \
384 FSP_POSIX_FLAGS_RENAME)
386 struct vuid_cache_entry {
387 struct auth_session_info *session_info;
388 uint64_t vuid; /* SMB2 compat */
390 uint32_t share_access;
394 unsigned int next_entry;
395 struct vuid_cache_entry array[VUID_CACHE_SIZE];
401 } name_compare_entry;
403 struct dfree_cached_info {
404 time_t last_dfree_time;
411 struct share_params {
415 typedef struct connection_struct {
416 struct connection_struct *next, *prev;
417 struct smbd_server_connection *sconn; /* can be NULL */
418 struct smbXsrv_tcon *tcon; /* can be NULL */
419 uint32_t cnum; /* an index passed over the wire */
420 struct share_params *params;
422 struct vuid_cache *vuid_cache;
425 bool read_only; /* Attributes for the current user of the share. */
426 uint32_t share_access;
427 /* Does this filesystem honor
428 sub second timestamps on files
429 and directories when setting time ? */
430 enum timestamp_set_resolution ts_res;
433 struct smb_filename *cwd_fname; /* Working directory. */
435 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
438 * This represents the user information on this connection. Depending
439 * on the vuid using this tid, this might change per SMB request.
441 struct auth_session_info *session_info;
444 * If the "force group" parameter is set, this is the primary gid that
445 * may be used in the users token, depending on the vuid using this tid.
447 gid_t force_group_gid;
449 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
452 time_t lastused_count;
454 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
458 /* Semantics requested by the client or forced by the server config. */
461 bool short_case_preserve;
463 /* Semantics provided by the underlying filesystem. */
465 /* Device number of the directory of the share mount.
466 Used to ensure unique FileIndex returns. */
467 SMB_DEV_T base_share_dev;
469 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
470 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
471 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
472 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
473 struct dfree_cached_info *dfree_info;
474 struct trans_state *pending_trans;
476 struct rpc_pipe_client *spoolss_pipe;
480 struct smbd_smb2_request;
481 struct privilege_paths;
487 uint64_t mid; /* For compatibility with SMB2. */
489 uint64_t vuid; /* For compatibility with SMB2. */
495 const uint8_t *inbuf;
498 * Async handling in the main smb processing loop is directed by
499 * outbuf: reply_xxx routines indicate sync behaviour by putting their
500 * reply into "outbuf". If they leave it as NULL, they take care of it
501 * themselves, possibly later.
503 * If async handling is wanted, the reply_xxx routine must make sure
504 * that it talloc_move()s the smb_req somewhere else.
510 connection_struct *conn;
511 struct smbd_server_connection *sconn;
512 struct smbXsrv_connection *xconn;
513 struct smb_perfcount_data pcd;
516 * Chained request handling
518 struct files_struct *chain_fsp;
521 * state information for async smb handling
526 * Back pointer to smb2 request.
528 struct smbd_smb2_request *smb2req;
531 * Pathnames used if request done
534 struct privilege_paths *priv_paths;
537 * Request list for chained requests, we're part of it.
539 struct smb_request **chain;
541 struct timeval request_time;
543 bool posix_pathnames;
547 * Info about an alternate data stream
550 struct stream_struct {
557 struct smb_file_time {
558 struct timespec mtime;
559 struct timespec atime;
560 struct timespec ctime;
561 struct timespec create_time;
567 struct smb_filename {
570 char *original_lcomp;
576 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
577 * to keep the numeric values consistent.
580 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
582 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
583 handle = handle->next; \
586 enum vfs_translate_direction {
587 vfs_translate_to_unix = 0,
588 vfs_translate_to_windows
591 enum vfs_fallocate_flags {
592 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
593 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
596 struct vfs_aio_state {
602 Available VFS operations. These values must be in sync with vfs_ops struct
603 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
604 In particular, if new operations are added to vfs_ops, appropriate constants
605 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
607 struct shadow_copy_data;
609 struct vfs_fn_pointers {
610 /* Disk operations */
612 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
613 void (*disconnect_fn)(struct vfs_handle_struct *handle);
614 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
615 const struct smb_filename *smb_fname,
619 int (*get_quota_fn)(struct vfs_handle_struct *handle,
620 const struct smb_filename *smb_fname,
621 enum SMB_QUOTA_TYPE qtype,
624 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
625 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
626 int (*statvfs_fn)(struct vfs_handle_struct *handle,
627 const struct smb_filename *smb_fname,
628 struct vfs_statvfs_struct *statbuf);
629 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
632 * Note: that "struct dfs_GetDFSReferral *r"
633 * needs to be a valid TALLOC_CTX
635 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
636 struct dfs_GetDFSReferral *r);
638 /* Directory operations */
640 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
641 const struct smb_filename *smb_fname,
643 uint32_t attributes);
644 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
645 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
647 SMB_STRUCT_STAT *sbuf);
648 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
649 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
650 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
651 int (*mkdir_fn)(struct vfs_handle_struct *handle,
652 const struct smb_filename *smb_fname,
654 int (*rmdir_fn)(struct vfs_handle_struct *handle,
655 const struct smb_filename *smb_fname);
656 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
657 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
659 /* File operations */
661 int (*open_fn)(struct vfs_handle_struct *handle,
662 struct smb_filename *smb_fname, files_struct *fsp,
663 int flags, mode_t mode);
664 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
665 struct smb_request *req,
666 uint16_t root_dir_fid,
667 struct smb_filename *smb_fname,
668 uint32_t access_mask,
669 uint32_t share_access,
670 uint32_t create_disposition,
671 uint32_t create_options,
672 uint32_t file_attributes,
673 uint32_t oplock_request,
674 struct smb2_lease *lease,
675 uint64_t allocation_size,
676 uint32_t private_flags,
677 struct security_descriptor *sd,
678 struct ea_list *ea_list,
679 files_struct **result,
681 const struct smb2_create_blobs *in_context_blobs,
682 struct smb2_create_blobs *out_context_blobs);
683 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
684 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
685 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
686 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
688 struct tevent_context *ev,
689 struct files_struct *fsp,
691 size_t n, off_t offset);
692 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
693 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
694 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
695 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
697 struct tevent_context *ev,
698 struct files_struct *fsp,
700 size_t n, off_t offset);
701 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
702 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
703 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
704 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
705 int (*rename_fn)(struct vfs_handle_struct *handle,
706 const struct smb_filename *smb_fname_src,
707 const struct smb_filename *smb_fname_dst);
708 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
709 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
711 struct tevent_context *ev,
712 struct files_struct *fsp);
713 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
714 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
715 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
716 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
717 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
718 int (*unlink_fn)(struct vfs_handle_struct *handle,
719 const struct smb_filename *smb_fname);
720 int (*chmod_fn)(struct vfs_handle_struct *handle,
721 const struct smb_filename *smb_fname,
723 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
724 int (*chown_fn)(struct vfs_handle_struct *handle,
725 const struct smb_filename *smb_fname,
728 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
729 int (*lchown_fn)(struct vfs_handle_struct *handle,
730 const struct smb_filename *smb_fname,
733 int (*chdir_fn)(struct vfs_handle_struct *handle,
734 const struct smb_filename *smb_fname);
735 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
736 TALLOC_CTX *mem_ctx);
737 int (*ntimes_fn)(struct vfs_handle_struct *handle,
738 const struct smb_filename *smb_fname,
739 struct smb_file_time *ft);
740 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
741 int (*fallocate_fn)(struct vfs_handle_struct *handle,
742 struct files_struct *fsp,
746 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
747 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
748 uint32_t share_mode, uint32_t access_mask);
749 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
750 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
751 int (*symlink_fn)(struct vfs_handle_struct *handle,
752 const char *link_contents,
753 const struct smb_filename *new_smb_fname);
754 int (*readlink_fn)(struct vfs_handle_struct *handle,
755 const struct smb_filename *smb_fname,
758 int (*link_fn)(struct vfs_handle_struct *handle,
759 const struct smb_filename *old_smb_fname,
760 const struct smb_filename *new_smb_fname);
761 int (*mknod_fn)(struct vfs_handle_struct *handle,
762 const struct smb_filename *smb_fname,
765 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
767 const struct smb_filename *smb_fname);
768 int (*chflags_fn)(struct vfs_handle_struct *handle,
769 const struct smb_filename *smb_fname,
771 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
772 const SMB_STRUCT_STAT *sbuf);
773 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
774 struct tevent_context *ev,
775 struct vfs_handle_struct *handle,
776 struct files_struct *fsp,
781 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
782 struct vfs_handle_struct *handle,
784 DATA_BLOB *token_blob);
785 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
787 struct tevent_context *ev,
790 off_t transfer_offset,
791 struct files_struct *dest_fsp,
794 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
795 struct tevent_req *req,
797 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
799 struct files_struct *fsp,
800 struct smb_filename *smb_fname,
801 uint16_t *_compression_fmt);
802 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 uint16_t compression_fmt);
806 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
808 const char *service_path,
810 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
812 const char *base_volume,
817 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
822 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
823 struct files_struct *fsp,
824 const struct smb_filename *smb_fname,
826 unsigned int *num_streams,
827 struct stream_struct **streams);
829 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
835 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
836 const struct smb_filename *smb_fname);
838 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
839 struct byte_range_lock *br_lck,
840 struct lock_struct *plock,
843 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
844 struct messaging_context *msg_ctx,
845 struct byte_range_lock *br_lck,
846 const struct lock_struct *plock);
848 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
849 struct byte_range_lock *br_lck,
850 struct lock_struct *plock);
852 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
853 struct files_struct *fsp,
854 struct lock_struct *plock);
856 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
858 enum vfs_translate_direction direction,
862 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
863 struct files_struct *fsp,
867 const uint8_t *_in_data,
870 uint32_t max_out_len,
873 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
874 struct smb_filename *smb_fname,
877 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
878 struct files_struct *fsp,
881 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
882 const struct smb_filename *smb_fname,
885 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
886 struct files_struct *fsp,
889 /* NT ACL operations. */
891 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
892 struct files_struct *fsp,
893 uint32_t security_info,
895 struct security_descriptor **ppdesc);
896 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
897 const struct smb_filename *smb_fname,
898 uint32_t security_info,
900 struct security_descriptor **ppdesc);
901 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
902 struct files_struct *fsp,
903 uint32_t security_info_sent,
904 const struct security_descriptor *psd);
906 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
907 struct smb_filename *file,
908 struct security_acl *sacl,
909 uint32_t access_requested,
910 uint32_t access_denied);
912 /* POSIX ACL operations. */
914 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
915 const struct smb_filename *smb_fname,
917 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
919 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
920 const struct smb_filename *smb_fname,
922 TALLOC_CTX *mem_ctx);
923 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
924 struct files_struct *fsp,
925 TALLOC_CTX *mem_ctx);
926 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
927 const struct smb_filename *smb_fname,
929 char **blob_description,
931 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
932 TALLOC_CTX *mem_ctx, char **blob_description,
934 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
935 const struct smb_filename *smb_fname,
936 SMB_ACL_TYPE_T acltype,
938 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
939 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
940 const struct smb_filename *smb_fname);
943 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
944 const struct smb_filename *smb_fname,
948 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
949 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
950 const struct smb_filename *smb_fname,
953 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
954 int (*removexattr_fn)(struct vfs_handle_struct *handle,
955 const struct smb_filename *smb_fname,
957 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
958 int (*setxattr_fn)(struct vfs_handle_struct *handle,
959 const struct smb_filename *smb_fname,
964 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
967 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
969 /* durable handle operations */
970 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
971 struct files_struct *fsp,
974 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
975 struct files_struct *fsp,
976 const DATA_BLOB old_cookie,
978 DATA_BLOB *new_cookie);
979 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
980 struct smb_request *smb1req,
981 struct smbXsrv_open *op,
982 const DATA_BLOB old_cookie,
984 struct files_struct **fsp,
985 DATA_BLOB *new_cookie);
987 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
988 const struct smb_filename *fname,
990 struct readdir_attr_data **attr_data);
994 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
995 which describes all operations this module is willing to intercept.
996 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
997 using this information.
1000 typedef struct vfs_handle_struct {
1001 struct vfs_handle_struct *next, *prev;
1003 struct connection_struct *conn;
1004 const struct vfs_fn_pointers *fns;
1006 void (*free_data)(void **data);
1007 } vfs_handle_struct;
1010 typedef struct vfs_statvfs_struct {
1011 /* For undefined recommended transfer size return -1 in that field */
1012 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1016 The next three fields are in terms of the block size.
1017 (above). If block size is unknown, 4096 would be a
1018 reasonable block size for a server to report.
1019 Note that returning the blocks/blocksavail removes need
1020 to make a second call (to QFSInfo level 0x103 to get this info.
1021 UserBlockAvail is typically less than or equal to BlocksAvail,
1022 if no distinction is made return the same value in each.
1025 uint64_t TotalBlocks;
1026 uint64_t BlocksAvail; /* bfree */
1027 uint64_t UserBlocksAvail; /* bavail */
1029 /* For undefined Node fields or FSID return -1 */
1030 uint64_t TotalFileNodes;
1031 uint64_t FreeFileNodes;
1032 uint64_t FsIdentifier; /* fsid */
1033 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1034 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1037 } vfs_statvfs_struct;
1039 /* Add a new FSP extension of the given type. Returns a pointer to the
1042 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1043 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1045 /* Return a pointer to the existing FSP extension data. */
1046 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1047 vfs_fetch_fsp_extension(handle, (fsp))
1049 /* Return the talloc context associated with an FSP extension. */
1050 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1051 vfs_memctx_fsp_extension(handle, (fsp))
1053 /* Remove and destroy an FSP extension. */
1054 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1055 vfs_remove_fsp_extension((handle), (fsp))
1057 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1058 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1059 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1064 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1066 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1069 if ((handle)->free_data) { \
1070 (handle)->free_data(&(handle)->data); \
1072 (handle)->data = (void *)datap; \
1073 (handle)->free_data = free_fn; \
1077 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1078 if ((handle) && (handle)->free_data) { \
1079 (handle)->free_data(&(handle)->data); \
1083 /* Check whether module-specific data handle was already allocated or not */
1084 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1086 #define SMB_VFS_OP(x) ((void *) x)
1088 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1090 #include "vfs_macros.h"
1092 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1093 const char *service, const char *user);
1094 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1095 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1096 const struct smb_filename *smb_filename,
1100 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1101 const struct smb_filename *smb_filename,
1102 enum SMB_QUOTA_TYPE qtype,
1104 SMB_DISK_QUOTA *qt);
1105 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1106 enum SMB_QUOTA_TYPE qtype, unid_t id,
1107 SMB_DISK_QUOTA *qt);
1108 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1109 struct files_struct *fsp,
1110 struct shadow_copy_data *shadow_copy_data,
1112 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1113 const struct smb_filename *smb_fname,
1114 struct vfs_statvfs_struct *statbuf);
1115 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1116 enum timestamp_set_resolution *p_ts_res);
1118 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1120 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1121 struct dfs_GetDFSReferral *r);
1122 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1123 const struct smb_filename *smb_fname,
1125 uint32_t attributes);
1126 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1127 struct files_struct *fsp,
1129 uint32_t attributes);
1130 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1132 SMB_STRUCT_STAT *sbuf);
1133 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1134 DIR *dirp, long offset);
1135 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1137 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1139 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1140 const struct smb_filename *smb_fname,
1142 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1143 const struct smb_filename *smb_fname);
1144 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1146 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1148 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1149 struct smb_filename *smb_fname, struct files_struct *fsp,
1150 int flags, mode_t mode);
1151 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1152 struct smb_request *req,
1153 uint16_t root_dir_fid,
1154 struct smb_filename *smb_fname,
1155 uint32_t access_mask,
1156 uint32_t share_access,
1157 uint32_t create_disposition,
1158 uint32_t create_options,
1159 uint32_t file_attributes,
1160 uint32_t oplock_request,
1161 struct smb2_lease *lease,
1162 uint64_t allocation_size,
1163 uint32_t private_flags,
1164 struct security_descriptor *sd,
1165 struct ea_list *ea_list,
1166 files_struct **result,
1168 const struct smb2_create_blobs *in_context_blobs,
1169 struct smb2_create_blobs *out_context_blobs);
1170 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1171 struct files_struct *fsp);
1172 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1173 struct files_struct *fsp, void *data, size_t n);
1174 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1175 struct files_struct *fsp, void *data, size_t n,
1177 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1178 TALLOC_CTX *mem_ctx,
1179 struct tevent_context *ev,
1180 struct files_struct *fsp,
1182 size_t n, off_t offset);
1183 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1185 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1186 struct files_struct *fsp, const void *data,
1188 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1189 struct files_struct *fsp, const void *data,
1190 size_t n, off_t offset);
1191 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1192 TALLOC_CTX *mem_ctx,
1193 struct tevent_context *ev,
1194 struct files_struct *fsp,
1196 size_t n, off_t offset);
1197 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1199 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1200 struct files_struct *fsp, off_t offset,
1202 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1203 files_struct *fromfsp, const DATA_BLOB *header,
1204 off_t offset, size_t count);
1205 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1206 files_struct *tofsp, off_t offset,
1208 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1209 const struct smb_filename *smb_fname_src,
1210 const struct smb_filename *smb_fname_dst);
1211 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1212 struct files_struct *fsp);
1214 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1215 TALLOC_CTX *mem_ctx,
1216 struct tevent_context *ev,
1217 struct files_struct *fsp);
1218 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1220 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1221 struct smb_filename *smb_fname);
1222 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1223 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1224 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1225 struct smb_filename *smb_filename);
1226 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1227 struct files_struct *fsp,
1228 const SMB_STRUCT_STAT *sbuf);
1229 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1230 const struct smb_filename *smb_fname);
1231 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1232 const struct smb_filename *smb_fname,
1234 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1235 struct files_struct *fsp, mode_t mode);
1236 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1237 const struct smb_filename *smb_fname,
1240 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1241 struct files_struct *fsp, uid_t uid, gid_t gid);
1242 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1243 const struct smb_filename *smb_fname,
1246 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1247 const struct smb_filename *smb_fname);
1248 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1250 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1251 const struct smb_filename *smb_fname,
1252 struct smb_file_time *ft);
1253 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1254 struct files_struct *fsp, off_t offset);
1255 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1256 struct files_struct *fsp,
1260 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1261 struct files_struct *fsp, int op, off_t offset,
1262 off_t count, int type);
1263 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1264 struct files_struct *fsp, uint32_t share_mode,
1265 uint32_t access_mask);
1266 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1267 struct files_struct *fsp, int leasetype);
1268 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1269 struct files_struct *fsp, off_t *poffset,
1270 off_t *pcount, int *ptype, pid_t *ppid);
1271 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1272 const char *link_contents,
1273 const struct smb_filename *new_smb_fname);
1274 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1275 const struct smb_filename *smb_fname,
1278 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1279 const struct smb_filename *old_smb_fname,
1280 const struct smb_filename *new_smb_fname);
1281 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1282 const struct smb_filename *smb_fname,
1285 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1287 const struct smb_filename *smb_fname);
1288 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1289 const struct smb_filename *smb_fname,
1290 unsigned int flags);
1291 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1292 const SMB_STRUCT_STAT *sbuf);
1293 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1294 struct files_struct *fsp,
1295 const struct smb_filename *smb_fname,
1296 TALLOC_CTX *mem_ctx,
1297 unsigned int *num_streams,
1298 struct stream_struct **streams);
1299 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1300 const char *path, const char *name,
1301 TALLOC_CTX *mem_ctx, char **found_name);
1302 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1303 const struct smb_filename *smb_fname);
1304 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1305 struct byte_range_lock *br_lck,
1306 struct lock_struct *plock,
1307 bool blocking_lock);
1308 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1309 struct messaging_context *msg_ctx,
1310 struct byte_range_lock *br_lck,
1311 const struct lock_struct *plock);
1312 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1313 struct byte_range_lock *br_lck,
1314 struct lock_struct *plock);
1315 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1316 struct files_struct *fsp,
1317 struct lock_struct *plock);
1318 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1320 enum vfs_translate_direction direction,
1321 TALLOC_CTX *mem_ctx,
1322 char **mapped_name);
1323 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1324 struct files_struct *fsp,
1328 const uint8_t *_in_data,
1330 uint8_t **_out_data,
1331 uint32_t max_out_len,
1333 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1334 struct smb_filename *smb_fname,
1336 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1337 struct files_struct *fsp,
1339 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1340 const struct smb_filename *smb_fname,
1342 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1343 struct files_struct *fsp,
1345 struct tevent_req *smb_vfs_call_offload_read_send(
1346 TALLOC_CTX *mem_ctx,
1347 struct tevent_context *ev,
1348 struct vfs_handle_struct *handle,
1349 struct files_struct *fsp,
1354 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1355 struct vfs_handle_struct *handle,
1356 TALLOC_CTX *mem_ctx,
1357 DATA_BLOB *token_blob);
1358 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1359 TALLOC_CTX *mem_ctx,
1360 struct tevent_context *ev,
1363 off_t transfer_offset,
1364 struct files_struct *dest_fsp,
1367 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1368 struct tevent_req *req,
1370 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1371 TALLOC_CTX *mem_ctx,
1372 struct files_struct *fsp,
1373 struct smb_filename *smb_fname,
1374 uint16_t *_compression_fmt);
1375 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1376 TALLOC_CTX *mem_ctx,
1377 struct files_struct *fsp,
1378 uint16_t compression_fmt);
1379 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1380 TALLOC_CTX *mem_ctx,
1381 const char *service_path,
1382 char **base_volume);
1383 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1384 TALLOC_CTX *mem_ctx,
1385 const char *base_volume,
1390 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1391 TALLOC_CTX *mem_ctx,
1394 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1395 struct files_struct *fsp,
1396 uint32_t security_info,
1397 TALLOC_CTX *mem_ctx,
1398 struct security_descriptor **ppdesc);
1399 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1400 const struct smb_filename *smb_fname,
1401 uint32_t security_info,
1402 TALLOC_CTX *mem_ctx,
1403 struct security_descriptor **ppdesc);
1404 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1405 struct files_struct *fsp,
1406 uint32_t security_info_sent,
1407 const struct security_descriptor *psd);
1408 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1409 struct smb_filename *file,
1410 struct security_acl *sacl,
1411 uint32_t access_requested,
1412 uint32_t access_denied);
1413 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1414 const struct smb_filename *file,
1416 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1417 struct files_struct *fsp, mode_t mode);
1418 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1419 const struct smb_filename *smb_fname,
1420 SMB_ACL_TYPE_T type,
1421 TALLOC_CTX *mem_ctx);
1422 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1423 struct files_struct *fsp,
1424 TALLOC_CTX *mem_ctx);
1425 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1426 const struct smb_filename *smb_fname,
1427 TALLOC_CTX *mem_ctx,
1428 char **blob_description,
1430 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1431 struct files_struct *fsp,
1432 TALLOC_CTX *mem_ctx,
1433 char **blob_description,
1435 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1436 const struct smb_filename *smb_fname,
1437 SMB_ACL_TYPE_T acltype,
1439 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1440 struct files_struct *fsp, SMB_ACL_T theacl);
1441 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1442 const struct smb_filename *smb_fname);
1443 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1444 const struct smb_filename *smb_fname,
1448 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1449 struct files_struct *fsp, const char *name,
1450 void *value, size_t size);
1451 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1452 const struct smb_filename *smb_fname,
1455 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1456 struct files_struct *fsp, char *list,
1458 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1459 const struct smb_filename *smb_fname,
1461 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1462 struct files_struct *fsp, const char *name);
1463 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1464 const struct smb_filename *smb_fname,
1469 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1470 const char *name, const void *value, size_t size,
1472 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1473 struct files_struct *fsp, const char *name,
1474 const void *value, size_t size, int flags);
1475 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1476 struct files_struct *fsp);
1477 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1478 const struct smb_filename *fname,
1479 SMB_STRUCT_STAT *sbuf);
1480 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1481 const struct smb_filename *fname);
1482 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1483 struct files_struct *fsp,
1484 TALLOC_CTX *mem_ctx,
1486 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1487 struct files_struct *fsp,
1488 const DATA_BLOB old_cookie,
1489 TALLOC_CTX *mem_ctx,
1490 DATA_BLOB *new_cookie);
1491 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1492 struct smb_request *smb1req,
1493 struct smbXsrv_open *op,
1494 const DATA_BLOB old_cookie,
1495 TALLOC_CTX *mem_ctx,
1496 struct files_struct **fsp,
1497 DATA_BLOB *new_cookie);
1498 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1499 const struct smb_filename *fname,
1500 TALLOC_CTX *mem_ctx,
1501 struct readdir_attr_data **attr_data);
1503 NTSTATUS smb_register_vfs(int version, const char *name,
1504 const struct vfs_fn_pointers *fns);
1505 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1506 files_struct *fsp, size_t ext_size,
1507 void (*destroy_fn)(void *p_data));
1508 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1509 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1510 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1511 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1513 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1514 const char *module);