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 * */
240 #define SMB_VFS_INTERFACE_VERSION 37
243 All intercepted VFS operations must be declared as static functions inside module source
244 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
245 example VFS modules for more details.
248 /* VFS operations structure */
250 struct vfs_handle_struct;
251 struct connection_struct;
253 struct security_descriptor;
254 struct vfs_statvfs_struct;
257 struct smb_file_time;
258 struct blocking_lock_record;
260 struct dfs_GetDFSReferral;
262 typedef union unid_t {
270 uint64_t position_information;
272 uint32_t private_options; /* NT Create options, but we only look at
273 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
274 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
275 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
276 * for print files *only*, where
277 * DELETE_ON_CLOSE is not stored in the share
280 unsigned long gen_id;
285 struct smbd_server_connection *sconn;
286 struct tevent_timer *timeout;
287 struct smb2_lease lease;
290 typedef struct files_struct {
291 struct files_struct *next, *prev;
293 struct smbXsrv_open *op;
294 struct connection_struct *conn;
295 struct fd_handle *fh;
296 unsigned int num_smb_operations;
297 struct file_id file_id;
298 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
300 uint64_t vuid; /* SMB2 compat */
301 struct write_cache *wcp;
302 struct timeval open_time;
303 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
304 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
306 bool kernel_share_modes_taken;
308 bool update_write_time_triggered;
309 struct tevent_timer *update_write_time_event;
310 bool update_write_time_on_close;
311 struct timespec close_write_time;
312 bool write_time_forced;
315 struct fsp_lease *lease;
316 int sent_oplock_break;
317 struct tevent_timer *oplock_timeout;
318 struct lock_struct last_lock_failure;
319 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
326 bool aio_write_behind;
327 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
328 bool delete_on_close;
329 uint64_t posix_flags;
331 bool backup_intent; /* Handle was successfully opened with backup intent
332 and opener has privilege to do so. */
333 bool aapl_copyfile_supported;
334 bool use_ofd_locks; /* Are we using open file description locks ? */
335 struct smb_filename *fsp_name;
336 uint32_t name_hash; /* Jenkins hash of full pathname. */
337 uint64_t mid; /* Mid of the operation that created us. */
339 struct vfs_fsp_data *vfs_extension;
340 struct fake_file_handle *fake_file_handle;
342 struct notify_change_buf *notify;
344 struct files_struct *base_fsp; /* placeholder for delete on close */
347 * Read-only cached brlock record, thrown away when the
348 * brlock.tdb seqnum changes. This avoids fetching data from
349 * the brlock.tdb on every read/write call.
352 struct byte_range_lock *brlock_rec;
354 struct dptr_struct *dptr;
356 /* if not NULL, means this is a print file */
357 struct print_file_data *print_file;
359 unsigned num_aio_requests;
360 struct tevent_req **aio_requests;
363 * If a close request comes in while we still have aio_requests
364 * around, we need to hold back the close. When all aio_requests are
365 * done, the aio completion routines need tevent_wait_done() on
366 * this. A bit ugly, but before we have close_file() fully async
367 * possibly the simplest approach. Thanks, Jeremy for the idea.
369 struct tevent_req *deferred_close;
372 #define FSP_POSIX_FLAGS_OPEN 0x01
373 #define FSP_POSIX_FLAGS_RENAME 0x02
374 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
376 #define FSP_POSIX_FLAGS_ALL \
377 (FSP_POSIX_FLAGS_OPEN | \
378 FSP_POSIX_FLAGS_PATHNAMES | \
379 FSP_POSIX_FLAGS_RENAME)
381 struct vuid_cache_entry {
382 struct auth_session_info *session_info;
383 uint64_t vuid; /* SMB2 compat */
385 uint32_t share_access;
389 unsigned int next_entry;
390 struct vuid_cache_entry array[VUID_CACHE_SIZE];
396 } name_compare_entry;
398 struct dfree_cached_info {
399 time_t last_dfree_time;
406 struct share_params {
410 typedef struct connection_struct {
411 struct connection_struct *next, *prev;
412 struct smbd_server_connection *sconn; /* can be NULL */
413 struct smbXsrv_tcon *tcon; /* can be NULL */
414 uint32_t cnum; /* an index passed over the wire */
415 struct share_params *params;
417 struct vuid_cache *vuid_cache;
420 bool read_only; /* Attributes for the current user of the share. */
421 uint32_t share_access;
422 /* Does this filesystem honor
423 sub second timestamps on files
424 and directories when setting time ? */
425 enum timestamp_set_resolution ts_res;
428 struct smb_filename *cwd_fname; /* Working directory. */
430 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
433 * This represents the user information on this connection. Depending
434 * on the vuid using this tid, this might change per SMB request.
436 struct auth_session_info *session_info;
439 * If the "force group" parameter is set, this is the primary gid that
440 * may be used in the users token, depending on the vuid using this tid.
442 gid_t force_group_gid;
444 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
447 time_t lastused_count;
449 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
453 /* Semantics requested by the client or forced by the server config. */
456 bool short_case_preserve;
458 /* Semantics provided by the underlying filesystem. */
460 /* Device number of the directory of the share mount.
461 Used to ensure unique FileIndex returns. */
462 SMB_DEV_T base_share_dev;
464 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
465 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
466 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
467 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
468 struct dfree_cached_info *dfree_info;
469 struct trans_state *pending_trans;
471 struct rpc_pipe_client *spoolss_pipe;
475 struct smbd_smb2_request;
476 struct privilege_paths;
482 uint64_t mid; /* For compatibility with SMB2. */
484 uint64_t vuid; /* For compatibility with SMB2. */
490 const uint8_t *inbuf;
493 * Async handling in the main smb processing loop is directed by
494 * outbuf: reply_xxx routines indicate sync behaviour by putting their
495 * reply into "outbuf". If they leave it as NULL, they take care of it
496 * themselves, possibly later.
498 * If async handling is wanted, the reply_xxx routine must make sure
499 * that it talloc_move()s the smb_req somewhere else.
505 connection_struct *conn;
506 struct smbd_server_connection *sconn;
507 struct smbXsrv_connection *xconn;
508 struct smb_perfcount_data pcd;
511 * Chained request handling
513 struct files_struct *chain_fsp;
516 * state information for async smb handling
521 * Back pointer to smb2 request.
523 struct smbd_smb2_request *smb2req;
526 * Pathnames used if request done
529 struct privilege_paths *priv_paths;
532 * Request list for chained requests, we're part of it.
534 struct smb_request **chain;
536 struct timeval request_time;
538 bool posix_pathnames;
542 * Info about an alternate data stream
545 struct stream_struct {
552 struct smb_file_time {
553 struct timespec mtime;
554 struct timespec atime;
555 struct timespec ctime;
556 struct timespec create_time;
562 struct smb_filename {
565 char *original_lcomp;
571 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
572 * to keep the numeric values consistent.
575 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
577 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
578 handle = handle->next; \
581 enum vfs_translate_direction {
582 vfs_translate_to_unix = 0,
583 vfs_translate_to_windows
586 enum vfs_fallocate_flags {
587 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
588 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
592 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
593 * be handled as a COW clone, AKA reflink.
594 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
596 enum vfs_copy_chunk_flags {
597 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
598 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
600 VFS_COPY_CHUNK_FL_MASK_ALL =
601 (VFS_COPY_CHUNK_FL_MUST_CLONE
602 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
605 struct vfs_aio_state {
611 Available VFS operations. These values must be in sync with vfs_ops struct
612 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
613 In particular, if new operations are added to vfs_ops, appropriate constants
614 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
616 struct shadow_copy_data;
618 struct vfs_fn_pointers {
619 /* Disk operations */
621 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
622 void (*disconnect_fn)(struct vfs_handle_struct *handle);
623 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
624 const struct smb_filename *smb_fname,
628 int (*get_quota_fn)(struct vfs_handle_struct *handle,
629 const struct smb_filename *smb_fname,
630 enum SMB_QUOTA_TYPE qtype,
633 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
634 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
635 int (*statvfs_fn)(struct vfs_handle_struct *handle,
636 const struct smb_filename *smb_fname,
637 struct vfs_statvfs_struct *statbuf);
638 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
641 * Note: that "struct dfs_GetDFSReferral *r"
642 * needs to be a valid TALLOC_CTX
644 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
645 struct dfs_GetDFSReferral *r);
647 /* Directory operations */
649 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
650 const struct smb_filename *smb_fname,
652 uint32_t attributes);
653 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
654 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
656 SMB_STRUCT_STAT *sbuf);
657 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
658 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
659 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
660 int (*mkdir_fn)(struct vfs_handle_struct *handle,
661 const struct smb_filename *smb_fname,
663 int (*rmdir_fn)(struct vfs_handle_struct *handle,
664 const struct smb_filename *smb_fname);
665 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
666 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
668 /* File operations */
670 int (*open_fn)(struct vfs_handle_struct *handle,
671 struct smb_filename *smb_fname, files_struct *fsp,
672 int flags, mode_t mode);
673 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
674 struct smb_request *req,
675 uint16_t root_dir_fid,
676 struct smb_filename *smb_fname,
677 uint32_t access_mask,
678 uint32_t share_access,
679 uint32_t create_disposition,
680 uint32_t create_options,
681 uint32_t file_attributes,
682 uint32_t oplock_request,
683 struct smb2_lease *lease,
684 uint64_t allocation_size,
685 uint32_t private_flags,
686 struct security_descriptor *sd,
687 struct ea_list *ea_list,
688 files_struct **result,
690 const struct smb2_create_blobs *in_context_blobs,
691 struct smb2_create_blobs *out_context_blobs);
692 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
693 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
694 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
695 struct tevent_req *(*pread_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 (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
702 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
703 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
704 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
706 struct tevent_context *ev,
707 struct files_struct *fsp,
709 size_t n, off_t offset);
710 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
711 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
712 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
713 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
714 int (*rename_fn)(struct vfs_handle_struct *handle,
715 const struct smb_filename *smb_fname_src,
716 const struct smb_filename *smb_fname_dst);
717 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
718 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
720 struct tevent_context *ev,
721 struct files_struct *fsp);
722 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
723 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
724 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
725 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
726 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
727 int (*unlink_fn)(struct vfs_handle_struct *handle,
728 const struct smb_filename *smb_fname);
729 int (*chmod_fn)(struct vfs_handle_struct *handle,
730 const struct smb_filename *smb_fname,
732 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
733 int (*chown_fn)(struct vfs_handle_struct *handle,
734 const struct smb_filename *smb_fname,
737 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
738 int (*lchown_fn)(struct vfs_handle_struct *handle,
739 const struct smb_filename *smb_fname,
742 int (*chdir_fn)(struct vfs_handle_struct *handle,
743 const struct smb_filename *smb_fname);
744 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
745 TALLOC_CTX *mem_ctx);
746 int (*ntimes_fn)(struct vfs_handle_struct *handle,
747 const struct smb_filename *smb_fname,
748 struct smb_file_time *ft);
749 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
750 int (*fallocate_fn)(struct vfs_handle_struct *handle,
751 struct files_struct *fsp,
755 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
756 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
757 uint32_t share_mode, uint32_t access_mask);
758 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
759 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
760 int (*symlink_fn)(struct vfs_handle_struct *handle,
761 const char *link_contents,
762 const struct smb_filename *new_smb_fname);
763 int (*readlink_fn)(struct vfs_handle_struct *handle,
764 const struct smb_filename *smb_fname,
767 int (*link_fn)(struct vfs_handle_struct *handle,
768 const struct smb_filename *old_smb_fname,
769 const struct smb_filename *new_smb_fname);
770 int (*mknod_fn)(struct vfs_handle_struct *handle,
771 const struct smb_filename *smb_fname,
774 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
776 const struct smb_filename *smb_fname);
777 int (*chflags_fn)(struct vfs_handle_struct *handle,
778 const struct smb_filename *smb_fname,
780 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
781 const SMB_STRUCT_STAT *sbuf);
782 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
784 struct tevent_context *ev,
785 struct files_struct *src_fsp,
787 struct files_struct *dest_fsp,
791 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
792 struct tevent_req *req,
794 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
796 struct files_struct *fsp,
797 struct smb_filename *smb_fname,
798 uint16_t *_compression_fmt);
799 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
801 struct files_struct *fsp,
802 uint16_t compression_fmt);
803 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
805 const char *service_path,
807 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
809 const char *base_volume,
814 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
819 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
820 struct files_struct *fsp,
821 const struct smb_filename *smb_fname,
823 unsigned int *num_streams,
824 struct stream_struct **streams);
826 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
832 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
833 const char *filename);
835 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
836 struct byte_range_lock *br_lck,
837 struct lock_struct *plock,
840 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
841 struct messaging_context *msg_ctx,
842 struct byte_range_lock *br_lck,
843 const struct lock_struct *plock);
845 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
846 struct byte_range_lock *br_lck,
847 struct lock_struct *plock);
849 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
850 struct files_struct *fsp,
851 struct lock_struct *plock);
853 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
854 struct files_struct *fsp,
855 struct lock_struct *plock);
857 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
859 enum vfs_translate_direction direction,
863 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
864 struct files_struct *fsp,
868 const uint8_t *_in_data,
871 uint32_t max_out_len,
874 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
875 struct smb_filename *smb_fname,
878 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
879 struct files_struct *fsp,
882 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
883 const struct smb_filename *smb_fname,
886 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
887 struct files_struct *fsp,
890 /* NT ACL operations. */
892 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
893 struct files_struct *fsp,
894 uint32_t security_info,
896 struct security_descriptor **ppdesc);
897 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
898 const struct smb_filename *smb_fname,
899 uint32_t security_info,
901 struct security_descriptor **ppdesc);
902 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
903 struct files_struct *fsp,
904 uint32_t security_info_sent,
905 const struct security_descriptor *psd);
907 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
908 struct smb_filename *file,
909 struct security_acl *sacl,
910 uint32_t access_requested,
911 uint32_t access_denied);
913 /* POSIX ACL operations. */
915 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
916 const struct smb_filename *smb_fname,
918 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
920 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
921 const struct smb_filename *smb_fname,
923 TALLOC_CTX *mem_ctx);
924 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
925 struct files_struct *fsp,
926 TALLOC_CTX *mem_ctx);
927 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
928 const struct smb_filename *smb_fname,
930 char **blob_description,
932 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
933 TALLOC_CTX *mem_ctx, char **blob_description,
935 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
936 const struct smb_filename *smb_fname,
937 SMB_ACL_TYPE_T acltype,
939 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
940 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
941 const struct smb_filename *smb_fname);
944 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
945 const struct smb_filename *smb_fname,
949 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
950 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
951 const struct smb_filename *smb_fname,
954 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
955 int (*removexattr_fn)(struct vfs_handle_struct *handle,
956 const struct smb_filename *smb_fname,
958 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
959 int (*setxattr_fn)(struct vfs_handle_struct *handle,
960 const struct smb_filename *smb_fname,
965 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
968 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
970 /* durable handle operations */
971 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
972 struct files_struct *fsp,
975 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
976 struct files_struct *fsp,
977 const DATA_BLOB old_cookie,
979 DATA_BLOB *new_cookie);
980 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
981 struct smb_request *smb1req,
982 struct smbXsrv_open *op,
983 const DATA_BLOB old_cookie,
985 struct files_struct **fsp,
986 DATA_BLOB *new_cookie);
988 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
989 const struct smb_filename *fname,
991 struct readdir_attr_data **attr_data);
995 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
996 which describes all operations this module is willing to intercept.
997 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
998 using this information.
1001 typedef struct vfs_handle_struct {
1002 struct vfs_handle_struct *next, *prev;
1004 struct connection_struct *conn;
1005 const struct vfs_fn_pointers *fns;
1007 void (*free_data)(void **data);
1008 } vfs_handle_struct;
1011 typedef struct vfs_statvfs_struct {
1012 /* For undefined recommended transfer size return -1 in that field */
1013 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1017 The next three fields are in terms of the block size.
1018 (above). If block size is unknown, 4096 would be a
1019 reasonable block size for a server to report.
1020 Note that returning the blocks/blocksavail removes need
1021 to make a second call (to QFSInfo level 0x103 to get this info.
1022 UserBlockAvail is typically less than or equal to BlocksAvail,
1023 if no distinction is made return the same value in each.
1026 uint64_t TotalBlocks;
1027 uint64_t BlocksAvail; /* bfree */
1028 uint64_t UserBlocksAvail; /* bavail */
1030 /* For undefined Node fields or FSID return -1 */
1031 uint64_t TotalFileNodes;
1032 uint64_t FreeFileNodes;
1033 uint64_t FsIdentifier; /* fsid */
1034 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1035 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1038 } vfs_statvfs_struct;
1040 /* Add a new FSP extension of the given type. Returns a pointer to the
1043 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1044 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1046 /* Return a pointer to the existing FSP extension data. */
1047 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1048 vfs_fetch_fsp_extension(handle, (fsp))
1050 /* Return the talloc context associated with an FSP extension. */
1051 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1052 vfs_memctx_fsp_extension(handle, (fsp))
1054 /* Remove and destroy an FSP extension. */
1055 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1056 vfs_remove_fsp_extension((handle), (fsp))
1058 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1059 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1060 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1065 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1067 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1070 if ((handle)->free_data) { \
1071 (handle)->free_data(&(handle)->data); \
1073 (handle)->data = (void *)datap; \
1074 (handle)->free_data = free_fn; \
1078 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1079 if ((handle) && (handle)->free_data) { \
1080 (handle)->free_data(&(handle)->data); \
1084 /* Check whether module-specific data handle was already allocated or not */
1085 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1087 #define SMB_VFS_OP(x) ((void *) x)
1089 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1091 #include "vfs_macros.h"
1093 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1094 const char *service, const char *user);
1095 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1096 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1097 const struct smb_filename *smb_filename,
1101 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1102 const struct smb_filename *smb_filename,
1103 enum SMB_QUOTA_TYPE qtype,
1105 SMB_DISK_QUOTA *qt);
1106 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1107 enum SMB_QUOTA_TYPE qtype, unid_t id,
1108 SMB_DISK_QUOTA *qt);
1109 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1110 struct files_struct *fsp,
1111 struct shadow_copy_data *shadow_copy_data,
1113 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1114 const struct smb_filename *smb_fname,
1115 struct vfs_statvfs_struct *statbuf);
1116 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1117 enum timestamp_set_resolution *p_ts_res);
1119 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1121 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1122 struct dfs_GetDFSReferral *r);
1123 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1124 const struct smb_filename *smb_fname,
1126 uint32_t attributes);
1127 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1128 struct files_struct *fsp,
1130 uint32_t attributes);
1131 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1133 SMB_STRUCT_STAT *sbuf);
1134 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1135 DIR *dirp, long offset);
1136 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1138 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1140 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1141 const struct smb_filename *smb_fname,
1143 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1144 const struct smb_filename *smb_fname);
1145 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1147 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1149 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1150 struct smb_filename *smb_fname, struct files_struct *fsp,
1151 int flags, mode_t mode);
1152 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1153 struct smb_request *req,
1154 uint16_t root_dir_fid,
1155 struct smb_filename *smb_fname,
1156 uint32_t access_mask,
1157 uint32_t share_access,
1158 uint32_t create_disposition,
1159 uint32_t create_options,
1160 uint32_t file_attributes,
1161 uint32_t oplock_request,
1162 struct smb2_lease *lease,
1163 uint64_t allocation_size,
1164 uint32_t private_flags,
1165 struct security_descriptor *sd,
1166 struct ea_list *ea_list,
1167 files_struct **result,
1169 const struct smb2_create_blobs *in_context_blobs,
1170 struct smb2_create_blobs *out_context_blobs);
1171 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1172 struct files_struct *fsp);
1173 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1174 struct files_struct *fsp, void *data, size_t n);
1175 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1176 struct files_struct *fsp, void *data, size_t n,
1178 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1179 TALLOC_CTX *mem_ctx,
1180 struct tevent_context *ev,
1181 struct files_struct *fsp,
1183 size_t n, off_t offset);
1184 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1186 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1187 struct files_struct *fsp, const void *data,
1189 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1190 struct files_struct *fsp, const void *data,
1191 size_t n, off_t offset);
1192 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1193 TALLOC_CTX *mem_ctx,
1194 struct tevent_context *ev,
1195 struct files_struct *fsp,
1197 size_t n, off_t offset);
1198 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1200 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1201 struct files_struct *fsp, off_t offset,
1203 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1204 files_struct *fromfsp, const DATA_BLOB *header,
1205 off_t offset, size_t count);
1206 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1207 files_struct *tofsp, off_t offset,
1209 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1210 const struct smb_filename *smb_fname_src,
1211 const struct smb_filename *smb_fname_dst);
1212 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1213 struct files_struct *fsp);
1215 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1216 TALLOC_CTX *mem_ctx,
1217 struct tevent_context *ev,
1218 struct files_struct *fsp);
1219 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1221 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1222 struct smb_filename *smb_fname);
1223 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1224 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1225 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1226 struct smb_filename *smb_filename);
1227 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1228 struct files_struct *fsp,
1229 const SMB_STRUCT_STAT *sbuf);
1230 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1231 const struct smb_filename *smb_fname);
1232 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1233 const struct smb_filename *smb_fname,
1235 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1236 struct files_struct *fsp, mode_t mode);
1237 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1238 const struct smb_filename *smb_fname,
1241 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1242 struct files_struct *fsp, uid_t uid, gid_t gid);
1243 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1244 const struct smb_filename *smb_fname,
1247 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1248 const struct smb_filename *smb_fname);
1249 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1251 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1252 const struct smb_filename *smb_fname,
1253 struct smb_file_time *ft);
1254 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1255 struct files_struct *fsp, off_t offset);
1256 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1257 struct files_struct *fsp,
1261 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1262 struct files_struct *fsp, int op, off_t offset,
1263 off_t count, int type);
1264 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1265 struct files_struct *fsp, uint32_t share_mode,
1266 uint32_t access_mask);
1267 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1268 struct files_struct *fsp, int leasetype);
1269 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1270 struct files_struct *fsp, off_t *poffset,
1271 off_t *pcount, int *ptype, pid_t *ppid);
1272 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1273 const char *link_contents,
1274 const struct smb_filename *new_smb_fname);
1275 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1276 const struct smb_filename *smb_fname,
1279 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1280 const struct smb_filename *old_smb_fname,
1281 const struct smb_filename *new_smb_fname);
1282 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1283 const struct smb_filename *smb_fname,
1286 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1288 const struct smb_filename *smb_fname);
1289 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1290 const struct smb_filename *smb_fname,
1291 unsigned int flags);
1292 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1293 const SMB_STRUCT_STAT *sbuf);
1294 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1295 struct files_struct *fsp,
1296 const struct smb_filename *smb_fname,
1297 TALLOC_CTX *mem_ctx,
1298 unsigned int *num_streams,
1299 struct stream_struct **streams);
1300 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1301 const char *path, const char *name,
1302 TALLOC_CTX *mem_ctx, char **found_name);
1303 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1304 const char *filename);
1305 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1306 struct byte_range_lock *br_lck,
1307 struct lock_struct *plock,
1308 bool blocking_lock);
1309 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1310 struct messaging_context *msg_ctx,
1311 struct byte_range_lock *br_lck,
1312 const struct lock_struct *plock);
1313 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1314 struct byte_range_lock *br_lck,
1315 struct lock_struct *plock);
1316 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1317 struct files_struct *fsp,
1318 struct lock_struct *plock);
1319 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1320 struct files_struct *fsp,
1321 struct lock_struct *plock);
1322 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1324 enum vfs_translate_direction direction,
1325 TALLOC_CTX *mem_ctx,
1326 char **mapped_name);
1327 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1328 struct files_struct *fsp,
1332 const uint8_t *_in_data,
1334 uint8_t **_out_data,
1335 uint32_t max_out_len,
1337 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1338 struct smb_filename *smb_fname,
1340 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1341 struct files_struct *fsp,
1343 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1344 const struct smb_filename *smb_fname,
1346 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1347 struct files_struct *fsp,
1349 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1350 TALLOC_CTX *mem_ctx,
1351 struct tevent_context *ev,
1352 struct files_struct *src_fsp,
1354 struct files_struct *dest_fsp,
1358 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1359 struct tevent_req *req,
1361 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1362 TALLOC_CTX *mem_ctx,
1363 struct files_struct *fsp,
1364 struct smb_filename *smb_fname,
1365 uint16_t *_compression_fmt);
1366 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1367 TALLOC_CTX *mem_ctx,
1368 struct files_struct *fsp,
1369 uint16_t compression_fmt);
1370 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1371 TALLOC_CTX *mem_ctx,
1372 const char *service_path,
1373 char **base_volume);
1374 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1375 TALLOC_CTX *mem_ctx,
1376 const char *base_volume,
1381 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1382 TALLOC_CTX *mem_ctx,
1385 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1386 struct files_struct *fsp,
1387 uint32_t security_info,
1388 TALLOC_CTX *mem_ctx,
1389 struct security_descriptor **ppdesc);
1390 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1391 const struct smb_filename *smb_fname,
1392 uint32_t security_info,
1393 TALLOC_CTX *mem_ctx,
1394 struct security_descriptor **ppdesc);
1395 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1396 struct files_struct *fsp,
1397 uint32_t security_info_sent,
1398 const struct security_descriptor *psd);
1399 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1400 struct smb_filename *file,
1401 struct security_acl *sacl,
1402 uint32_t access_requested,
1403 uint32_t access_denied);
1404 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1405 const struct smb_filename *file,
1407 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1408 struct files_struct *fsp, mode_t mode);
1409 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1410 const struct smb_filename *smb_fname,
1411 SMB_ACL_TYPE_T type,
1412 TALLOC_CTX *mem_ctx);
1413 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1414 struct files_struct *fsp,
1415 TALLOC_CTX *mem_ctx);
1416 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1417 const struct smb_filename *smb_fname,
1418 TALLOC_CTX *mem_ctx,
1419 char **blob_description,
1421 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1422 struct files_struct *fsp,
1423 TALLOC_CTX *mem_ctx,
1424 char **blob_description,
1426 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1427 const struct smb_filename *smb_fname,
1428 SMB_ACL_TYPE_T acltype,
1430 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1431 struct files_struct *fsp, SMB_ACL_T theacl);
1432 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1433 const struct smb_filename *smb_fname);
1434 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1435 const struct smb_filename *smb_fname,
1439 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1440 struct files_struct *fsp, const char *name,
1441 void *value, size_t size);
1442 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1443 const struct smb_filename *smb_fname,
1446 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1447 struct files_struct *fsp, char *list,
1449 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1450 const struct smb_filename *smb_fname,
1452 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1453 struct files_struct *fsp, const char *name);
1454 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1455 const struct smb_filename *smb_fname,
1460 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1461 const char *name, const void *value, size_t size,
1463 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1464 struct files_struct *fsp, const char *name,
1465 const void *value, size_t size, int flags);
1466 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1467 struct files_struct *fsp);
1468 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1469 const struct smb_filename *fname,
1470 SMB_STRUCT_STAT *sbuf);
1471 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1472 const struct smb_filename *fname);
1473 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1474 struct files_struct *fsp,
1475 TALLOC_CTX *mem_ctx,
1477 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1478 struct files_struct *fsp,
1479 const DATA_BLOB old_cookie,
1480 TALLOC_CTX *mem_ctx,
1481 DATA_BLOB *new_cookie);
1482 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1483 struct smb_request *smb1req,
1484 struct smbXsrv_open *op,
1485 const DATA_BLOB old_cookie,
1486 TALLOC_CTX *mem_ctx,
1487 struct files_struct **fsp,
1488 DATA_BLOB *new_cookie);
1489 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1490 const struct smb_filename *fname,
1491 TALLOC_CTX *mem_ctx,
1492 struct readdir_attr_data **attr_data);
1494 NTSTATUS smb_register_vfs(int version, const char *name,
1495 const struct vfs_fn_pointers *fns);
1496 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1497 files_struct *fsp, size_t ext_size,
1498 void (*destroy_fn)(void *p_data));
1499 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1500 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1501 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1502 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1504 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1505 const char *module);