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 */
245 /* Version 37 - Rename SMB_VFS_STRICT_LOCK to
246 SMB_VFS_STRICT_LOCK_CHECK */
247 /* Version 38 - Remove SMB_VFS_INIT_SEARCH_OP */
248 /* Version 39 - Remove SMB_VFS_FSYNC
249 Only implement async versions. */
251 #define SMB_VFS_INTERFACE_VERSION 39
254 All intercepted VFS operations must be declared as static functions inside module source
255 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
256 example VFS modules for more details.
259 /* VFS operations structure */
261 struct vfs_handle_struct;
262 struct connection_struct;
264 struct security_descriptor;
265 struct vfs_statvfs_struct;
268 struct smb_file_time;
269 struct blocking_lock_record;
271 struct dfs_GetDFSReferral;
273 typedef union unid_t {
281 uint64_t position_information;
283 uint32_t private_options; /* NT Create options, but we only look at
284 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
285 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
286 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
287 * for print files *only*, where
288 * DELETE_ON_CLOSE is not stored in the share
291 unsigned long gen_id;
296 struct smbd_server_connection *sconn;
297 struct tevent_timer *timeout;
298 struct smb2_lease lease;
301 typedef struct files_struct {
302 struct files_struct *next, *prev;
304 struct smbXsrv_open *op;
305 struct connection_struct *conn;
306 struct fd_handle *fh;
307 unsigned int num_smb_operations;
308 struct file_id file_id;
309 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
311 uint64_t vuid; /* SMB2 compat */
312 struct write_cache *wcp;
313 struct timeval open_time;
314 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
315 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
317 bool kernel_share_modes_taken;
319 bool update_write_time_triggered;
320 struct tevent_timer *update_write_time_event;
321 bool update_write_time_on_close;
322 struct timespec close_write_time;
323 bool write_time_forced;
326 struct fsp_lease *lease;
327 int sent_oplock_break;
328 struct tevent_timer *oplock_timeout;
329 struct lock_struct last_lock_failure;
330 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
337 bool aio_write_behind;
338 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
339 bool delete_on_close;
340 uint64_t posix_flags;
342 bool backup_intent; /* Handle was successfully opened with backup intent
343 and opener has privilege to do so. */
344 bool use_ofd_locks; /* Are we using open file description locks ? */
345 struct smb_filename *fsp_name;
346 uint32_t name_hash; /* Jenkins hash of full pathname. */
347 uint64_t mid; /* Mid of the operation that created us. */
349 struct vfs_fsp_data *vfs_extension;
350 struct fake_file_handle *fake_file_handle;
352 struct notify_change_buf *notify;
354 struct files_struct *base_fsp; /* placeholder for delete on close */
357 * Read-only cached brlock record, thrown away when the
358 * brlock.tdb seqnum changes. This avoids fetching data from
359 * the brlock.tdb on every read/write call.
362 struct byte_range_lock *brlock_rec;
364 struct dptr_struct *dptr;
366 /* if not NULL, means this is a print file */
367 struct print_file_data *print_file;
369 unsigned num_aio_requests;
370 struct tevent_req **aio_requests;
373 * If a close request comes in while we still have aio_requests
374 * around, we need to hold back the close. When all aio_requests are
375 * done, the aio completion routines need tevent_wait_done() on
376 * this. A bit ugly, but before we have close_file() fully async
377 * possibly the simplest approach. Thanks, Jeremy for the idea.
379 struct tevent_req *deferred_close;
382 #define FSP_POSIX_FLAGS_OPEN 0x01
383 #define FSP_POSIX_FLAGS_RENAME 0x02
384 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
386 #define FSP_POSIX_FLAGS_ALL \
387 (FSP_POSIX_FLAGS_OPEN | \
388 FSP_POSIX_FLAGS_PATHNAMES | \
389 FSP_POSIX_FLAGS_RENAME)
391 struct vuid_cache_entry {
392 struct auth_session_info *session_info;
393 uint64_t vuid; /* SMB2 compat */
395 uint32_t share_access;
399 unsigned int next_entry;
400 struct vuid_cache_entry array[VUID_CACHE_SIZE];
406 } name_compare_entry;
408 struct dfree_cached_info {
409 time_t last_dfree_time;
416 struct share_params {
420 typedef struct connection_struct {
421 struct connection_struct *next, *prev;
422 struct smbd_server_connection *sconn; /* can be NULL */
423 struct smbXsrv_tcon *tcon; /* can be NULL */
424 uint32_t cnum; /* an index passed over the wire */
425 struct share_params *params;
427 struct vuid_cache *vuid_cache;
430 bool read_only; /* Attributes for the current user of the share. */
431 uint32_t share_access;
432 /* Does this filesystem honor
433 sub second timestamps on files
434 and directories when setting time ? */
435 enum timestamp_set_resolution ts_res;
438 struct smb_filename *cwd_fname; /* Working directory. */
440 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
443 * This represents the user information on this connection. Depending
444 * on the vuid using this tid, this might change per SMB request.
446 struct auth_session_info *session_info;
449 * If the "force group" parameter is set, this is the primary gid that
450 * may be used in the users token, depending on the vuid using this tid.
452 gid_t force_group_gid;
454 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
457 time_t lastused_count;
459 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
463 /* Semantics requested by the client or forced by the server config. */
466 bool short_case_preserve;
468 /* Semantics provided by the underlying filesystem. */
470 /* Device number of the directory of the share mount.
471 Used to ensure unique FileIndex returns. */
472 SMB_DEV_T base_share_dev;
474 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
475 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
476 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
477 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
478 struct dfree_cached_info *dfree_info;
479 struct trans_state *pending_trans;
481 struct rpc_pipe_client *spoolss_pipe;
485 struct smbd_smb2_request;
486 struct privilege_paths;
492 uint64_t mid; /* For compatibility with SMB2. */
494 uint64_t vuid; /* For compatibility with SMB2. */
500 const uint8_t *inbuf;
503 * Async handling in the main smb processing loop is directed by
504 * outbuf: reply_xxx routines indicate sync behaviour by putting their
505 * reply into "outbuf". If they leave it as NULL, they take care of it
506 * themselves, possibly later.
508 * If async handling is wanted, the reply_xxx routine must make sure
509 * that it talloc_move()s the smb_req somewhere else.
515 connection_struct *conn;
516 struct smbd_server_connection *sconn;
517 struct smbXsrv_connection *xconn;
518 struct smb_perfcount_data pcd;
521 * Chained request handling
523 struct files_struct *chain_fsp;
526 * state information for async smb handling
531 * Back pointer to smb2 request.
533 struct smbd_smb2_request *smb2req;
536 * Pathnames used if request done
539 struct privilege_paths *priv_paths;
542 * Request list for chained requests, we're part of it.
544 struct smb_request **chain;
546 struct timeval request_time;
548 bool posix_pathnames;
552 * Info about an alternate data stream
555 struct stream_struct {
562 struct smb_file_time {
563 struct timespec mtime;
564 struct timespec atime;
565 struct timespec ctime;
566 struct timespec create_time;
572 struct smb_filename {
575 char *original_lcomp;
581 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
582 * to keep the numeric values consistent.
585 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
587 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
588 handle = handle->next; \
591 enum vfs_translate_direction {
592 vfs_translate_to_unix = 0,
593 vfs_translate_to_windows
596 enum vfs_fallocate_flags {
597 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
598 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
601 struct vfs_aio_state {
607 Available VFS operations. These values must be in sync with vfs_ops struct
608 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
609 In particular, if new operations are added to vfs_ops, appropriate constants
610 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
612 struct shadow_copy_data;
614 struct vfs_fn_pointers {
615 /* Disk operations */
617 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
618 void (*disconnect_fn)(struct vfs_handle_struct *handle);
619 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
620 const struct smb_filename *smb_fname,
624 int (*get_quota_fn)(struct vfs_handle_struct *handle,
625 const struct smb_filename *smb_fname,
626 enum SMB_QUOTA_TYPE qtype,
629 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
630 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
631 int (*statvfs_fn)(struct vfs_handle_struct *handle,
632 const struct smb_filename *smb_fname,
633 struct vfs_statvfs_struct *statbuf);
634 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
637 * Note: that "struct dfs_GetDFSReferral *r"
638 * needs to be a valid TALLOC_CTX
640 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
641 struct dfs_GetDFSReferral *r);
643 /* Directory operations */
645 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
646 const struct smb_filename *smb_fname,
648 uint32_t attributes);
649 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
650 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
652 SMB_STRUCT_STAT *sbuf);
653 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
654 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
655 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
656 int (*mkdir_fn)(struct vfs_handle_struct *handle,
657 const struct smb_filename *smb_fname,
659 int (*rmdir_fn)(struct vfs_handle_struct *handle,
660 const struct smb_filename *smb_fname);
661 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
663 /* File operations */
665 int (*open_fn)(struct vfs_handle_struct *handle,
666 struct smb_filename *smb_fname, files_struct *fsp,
667 int flags, mode_t mode);
668 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
669 struct smb_request *req,
670 uint16_t root_dir_fid,
671 struct smb_filename *smb_fname,
672 uint32_t access_mask,
673 uint32_t share_access,
674 uint32_t create_disposition,
675 uint32_t create_options,
676 uint32_t file_attributes,
677 uint32_t oplock_request,
678 struct smb2_lease *lease,
679 uint64_t allocation_size,
680 uint32_t private_flags,
681 struct security_descriptor *sd,
682 struct ea_list *ea_list,
683 files_struct **result,
685 const struct smb2_create_blobs *in_context_blobs,
686 struct smb2_create_blobs *out_context_blobs);
687 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
688 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
689 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
690 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
692 struct tevent_context *ev,
693 struct files_struct *fsp,
695 size_t n, off_t offset);
696 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
697 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
698 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
699 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
701 struct tevent_context *ev,
702 struct files_struct *fsp,
704 size_t n, off_t offset);
705 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
706 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
707 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
708 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
709 int (*rename_fn)(struct vfs_handle_struct *handle,
710 const struct smb_filename *smb_fname_src,
711 const struct smb_filename *smb_fname_dst);
712 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
714 struct tevent_context *ev,
715 struct files_struct *fsp);
716 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
717 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
718 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
719 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
720 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
721 int (*unlink_fn)(struct vfs_handle_struct *handle,
722 const struct smb_filename *smb_fname);
723 int (*chmod_fn)(struct vfs_handle_struct *handle,
724 const struct smb_filename *smb_fname,
726 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
727 int (*chown_fn)(struct vfs_handle_struct *handle,
728 const struct smb_filename *smb_fname,
731 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
732 int (*lchown_fn)(struct vfs_handle_struct *handle,
733 const struct smb_filename *smb_fname,
736 int (*chdir_fn)(struct vfs_handle_struct *handle,
737 const struct smb_filename *smb_fname);
738 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
739 TALLOC_CTX *mem_ctx);
740 int (*ntimes_fn)(struct vfs_handle_struct *handle,
741 const struct smb_filename *smb_fname,
742 struct smb_file_time *ft);
743 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
744 int (*fallocate_fn)(struct vfs_handle_struct *handle,
745 struct files_struct *fsp,
749 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
750 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
751 uint32_t share_mode, uint32_t access_mask);
752 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
753 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
754 int (*symlink_fn)(struct vfs_handle_struct *handle,
755 const char *link_contents,
756 const struct smb_filename *new_smb_fname);
757 int (*readlink_fn)(struct vfs_handle_struct *handle,
758 const struct smb_filename *smb_fname,
761 int (*link_fn)(struct vfs_handle_struct *handle,
762 const struct smb_filename *old_smb_fname,
763 const struct smb_filename *new_smb_fname);
764 int (*mknod_fn)(struct vfs_handle_struct *handle,
765 const struct smb_filename *smb_fname,
768 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
770 const struct smb_filename *smb_fname);
771 int (*chflags_fn)(struct vfs_handle_struct *handle,
772 const struct smb_filename *smb_fname,
774 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
775 const SMB_STRUCT_STAT *sbuf);
776 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
777 struct tevent_context *ev,
778 struct vfs_handle_struct *handle,
779 struct files_struct *fsp,
784 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
785 struct vfs_handle_struct *handle,
787 DATA_BLOB *token_blob);
788 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
790 struct tevent_context *ev,
793 off_t transfer_offset,
794 struct files_struct *dest_fsp,
797 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
798 struct tevent_req *req,
800 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
802 struct files_struct *fsp,
803 struct smb_filename *smb_fname,
804 uint16_t *_compression_fmt);
805 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
807 struct files_struct *fsp,
808 uint16_t compression_fmt);
809 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
811 const char *service_path,
813 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
815 const char *base_volume,
820 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
825 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
826 struct files_struct *fsp,
827 const struct smb_filename *smb_fname,
829 unsigned int *num_streams,
830 struct stream_struct **streams);
832 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
838 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
839 const struct smb_filename *smb_fname);
841 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
842 struct byte_range_lock *br_lck,
843 struct lock_struct *plock,
846 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
847 struct messaging_context *msg_ctx,
848 struct byte_range_lock *br_lck,
849 const struct lock_struct *plock);
851 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
852 struct byte_range_lock *br_lck,
853 struct lock_struct *plock);
855 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
856 struct files_struct *fsp,
857 struct lock_struct *plock);
859 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
861 enum vfs_translate_direction direction,
865 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
866 struct files_struct *fsp,
870 const uint8_t *_in_data,
873 uint32_t max_out_len,
876 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
877 struct smb_filename *smb_fname,
880 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
881 struct files_struct *fsp,
884 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
885 const struct smb_filename *smb_fname,
888 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
889 struct files_struct *fsp,
892 /* NT ACL operations. */
894 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
895 struct files_struct *fsp,
896 uint32_t security_info,
898 struct security_descriptor **ppdesc);
899 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
900 const struct smb_filename *smb_fname,
901 uint32_t security_info,
903 struct security_descriptor **ppdesc);
904 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
905 struct files_struct *fsp,
906 uint32_t security_info_sent,
907 const struct security_descriptor *psd);
909 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
910 struct smb_filename *file,
911 struct security_acl *sacl,
912 uint32_t access_requested,
913 uint32_t access_denied);
915 /* POSIX ACL operations. */
917 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
918 const struct smb_filename *smb_fname,
920 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
922 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
923 const struct smb_filename *smb_fname,
925 TALLOC_CTX *mem_ctx);
926 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
927 struct files_struct *fsp,
928 TALLOC_CTX *mem_ctx);
929 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
930 const struct smb_filename *smb_fname,
932 char **blob_description,
934 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
935 TALLOC_CTX *mem_ctx, char **blob_description,
937 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
938 const struct smb_filename *smb_fname,
939 SMB_ACL_TYPE_T acltype,
941 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
942 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
943 const struct smb_filename *smb_fname);
946 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
947 const struct smb_filename *smb_fname,
951 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
952 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
953 const struct smb_filename *smb_fname,
956 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
957 int (*removexattr_fn)(struct vfs_handle_struct *handle,
958 const struct smb_filename *smb_fname,
960 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
961 int (*setxattr_fn)(struct vfs_handle_struct *handle,
962 const struct smb_filename *smb_fname,
967 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
970 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
972 /* durable handle operations */
973 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
974 struct files_struct *fsp,
977 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
978 struct files_struct *fsp,
979 const DATA_BLOB old_cookie,
981 DATA_BLOB *new_cookie);
982 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
983 struct smb_request *smb1req,
984 struct smbXsrv_open *op,
985 const DATA_BLOB old_cookie,
987 struct files_struct **fsp,
988 DATA_BLOB *new_cookie);
990 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
991 const struct smb_filename *fname,
993 struct readdir_attr_data **attr_data);
997 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
998 which describes all operations this module is willing to intercept.
999 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1000 using this information.
1003 typedef struct vfs_handle_struct {
1004 struct vfs_handle_struct *next, *prev;
1006 struct connection_struct *conn;
1007 const struct vfs_fn_pointers *fns;
1009 void (*free_data)(void **data);
1010 } vfs_handle_struct;
1013 typedef struct vfs_statvfs_struct {
1014 /* For undefined recommended transfer size return -1 in that field */
1015 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1019 The next three fields are in terms of the block size.
1020 (above). If block size is unknown, 4096 would be a
1021 reasonable block size for a server to report.
1022 Note that returning the blocks/blocksavail removes need
1023 to make a second call (to QFSInfo level 0x103 to get this info.
1024 UserBlockAvail is typically less than or equal to BlocksAvail,
1025 if no distinction is made return the same value in each.
1028 uint64_t TotalBlocks;
1029 uint64_t BlocksAvail; /* bfree */
1030 uint64_t UserBlocksAvail; /* bavail */
1032 /* For undefined Node fields or FSID return -1 */
1033 uint64_t TotalFileNodes;
1034 uint64_t FreeFileNodes;
1035 uint64_t FsIdentifier; /* fsid */
1036 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1037 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1040 } vfs_statvfs_struct;
1042 /* Add a new FSP extension of the given type. Returns a pointer to the
1045 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1046 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1048 /* Return a pointer to the existing FSP extension data. */
1049 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1050 vfs_fetch_fsp_extension(handle, (fsp))
1052 /* Return the talloc context associated with an FSP extension. */
1053 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1054 vfs_memctx_fsp_extension(handle, (fsp))
1056 /* Remove and destroy an FSP extension. */
1057 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1058 vfs_remove_fsp_extension((handle), (fsp))
1060 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1061 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1062 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1067 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1069 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1072 if ((handle)->free_data) { \
1073 (handle)->free_data(&(handle)->data); \
1075 (handle)->data = (void *)datap; \
1076 (handle)->free_data = free_fn; \
1080 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1081 if ((handle) && (handle)->free_data) { \
1082 (handle)->free_data(&(handle)->data); \
1086 /* Check whether module-specific data handle was already allocated or not */
1087 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1089 #define SMB_VFS_OP(x) ((void *) x)
1091 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1093 #include "vfs_macros.h"
1095 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1096 const char *service, const char *user);
1097 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1098 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1099 const struct smb_filename *smb_filename,
1103 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1104 const struct smb_filename *smb_filename,
1105 enum SMB_QUOTA_TYPE qtype,
1107 SMB_DISK_QUOTA *qt);
1108 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1109 enum SMB_QUOTA_TYPE qtype, unid_t id,
1110 SMB_DISK_QUOTA *qt);
1111 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1112 struct files_struct *fsp,
1113 struct shadow_copy_data *shadow_copy_data,
1115 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1116 const struct smb_filename *smb_fname,
1117 struct vfs_statvfs_struct *statbuf);
1118 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1119 enum timestamp_set_resolution *p_ts_res);
1121 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1123 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1124 struct dfs_GetDFSReferral *r);
1125 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1126 const struct smb_filename *smb_fname,
1128 uint32_t attributes);
1129 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1130 struct files_struct *fsp,
1132 uint32_t attributes);
1133 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1135 SMB_STRUCT_STAT *sbuf);
1136 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1137 DIR *dirp, long offset);
1138 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1140 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1142 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1143 const struct smb_filename *smb_fname,
1145 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1146 const struct smb_filename *smb_fname);
1147 int smb_vfs_call_closedir(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);
1213 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1214 TALLOC_CTX *mem_ctx,
1215 struct tevent_context *ev,
1216 struct files_struct *fsp);
1217 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1219 int smb_vfs_fsync_sync(files_struct *fsp);
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_check(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 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1478 struct files_struct *fsp,
1479 TALLOC_CTX *mem_ctx,
1481 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1482 struct files_struct *fsp,
1483 const DATA_BLOB old_cookie,
1484 TALLOC_CTX *mem_ctx,
1485 DATA_BLOB *new_cookie);
1486 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1487 struct smb_request *smb1req,
1488 struct smbXsrv_open *op,
1489 const DATA_BLOB old_cookie,
1490 TALLOC_CTX *mem_ctx,
1491 struct files_struct **fsp,
1492 DATA_BLOB *new_cookie);
1493 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1494 const struct smb_filename *fname,
1495 TALLOC_CTX *mem_ctx,
1496 struct readdir_attr_data **attr_data);
1498 NTSTATUS smb_register_vfs(int version, const char *name,
1499 const struct vfs_fn_pointers *fns);
1500 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1501 files_struct *fsp, size_t ext_size,
1502 void (*destroy_fn)(void *p_data));
1503 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1504 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1505 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1506 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1508 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1509 const char *module);