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 * */
220 #define SMB_VFS_INTERFACE_VERSION 37
223 All intercepted VFS operations must be declared as static functions inside module source
224 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
225 example VFS modules for more details.
228 /* VFS operations structure */
230 struct vfs_handle_struct;
231 struct connection_struct;
233 struct security_descriptor;
234 struct vfs_statvfs_struct;
237 struct smb_file_time;
238 struct blocking_lock_record;
240 struct dfs_GetDFSReferral;
242 typedef union unid_t {
250 uint64_t position_information;
252 uint32_t private_options; /* NT Create options, but we only look at
253 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
254 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
255 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
256 * for print files *only*, where
257 * DELETE_ON_CLOSE is not stored in the share
260 unsigned long gen_id;
265 struct smbd_server_connection *sconn;
266 struct tevent_timer *timeout;
267 struct smb2_lease lease;
270 typedef struct files_struct {
271 struct files_struct *next, *prev;
273 struct smbXsrv_open *op;
274 struct connection_struct *conn;
275 struct fd_handle *fh;
276 unsigned int num_smb_operations;
277 struct file_id file_id;
278 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
280 uint64_t vuid; /* SMB2 compat */
281 struct write_cache *wcp;
282 struct timeval open_time;
283 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
284 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
286 bool kernel_share_modes_taken;
288 bool update_write_time_triggered;
289 struct tevent_timer *update_write_time_event;
290 bool update_write_time_on_close;
291 struct timespec close_write_time;
292 bool write_time_forced;
295 struct fsp_lease *lease;
296 int sent_oplock_break;
297 struct tevent_timer *oplock_timeout;
298 struct lock_struct last_lock_failure;
299 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
306 bool aio_write_behind;
307 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
308 bool delete_on_close;
309 uint64_t posix_flags;
311 bool backup_intent; /* Handle was successfully opened with backup intent
312 and opener has privilege to do so. */
313 bool aapl_copyfile_supported;
314 bool use_ofd_locks; /* Are we using open file description locks ? */
315 struct smb_filename *fsp_name;
316 uint32_t name_hash; /* Jenkins hash of full pathname. */
317 uint64_t mid; /* Mid of the operation that created us. */
319 struct vfs_fsp_data *vfs_extension;
320 struct fake_file_handle *fake_file_handle;
322 struct notify_change_buf *notify;
324 struct files_struct *base_fsp; /* placeholder for delete on close */
327 * Read-only cached brlock record, thrown away when the
328 * brlock.tdb seqnum changes. This avoids fetching data from
329 * the brlock.tdb on every read/write call.
332 struct byte_range_lock *brlock_rec;
334 struct dptr_struct *dptr;
336 /* if not NULL, means this is a print file */
337 struct print_file_data *print_file;
339 unsigned num_aio_requests;
340 struct tevent_req **aio_requests;
343 * If a close request comes in while we still have aio_requests
344 * around, we need to hold back the close. When all aio_requests are
345 * done, the aio completion routines need tevent_wait_done() on
346 * this. A bit ugly, but before we have close_file() fully async
347 * possibly the simplest approach. Thanks, Jeremy for the idea.
349 struct tevent_req *deferred_close;
352 #define FSP_POSIX_FLAGS_OPEN 0x01
353 #define FSP_POSIX_FLAGS_RENAME 0x02
354 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
356 #define FSP_POSIX_FLAGS_ALL \
357 (FSP_POSIX_FLAGS_OPEN | \
358 FSP_POSIX_FLAGS_PATHNAMES | \
359 FSP_POSIX_FLAGS_RENAME)
361 struct vuid_cache_entry {
362 struct auth_session_info *session_info;
363 uint64_t vuid; /* SMB2 compat */
365 uint32_t share_access;
369 unsigned int next_entry;
370 struct vuid_cache_entry array[VUID_CACHE_SIZE];
376 } name_compare_entry;
378 struct dfree_cached_info {
379 time_t last_dfree_time;
386 struct share_params {
390 typedef struct connection_struct {
391 struct connection_struct *next, *prev;
392 struct smbd_server_connection *sconn; /* can be NULL */
393 struct smbXsrv_tcon *tcon; /* can be NULL */
394 uint32_t cnum; /* an index passed over the wire */
395 struct share_params *params;
397 struct vuid_cache *vuid_cache;
400 bool read_only; /* Attributes for the current user of the share. */
401 uint32_t share_access;
402 /* Does this filesystem honor
403 sub second timestamps on files
404 and directories when setting time ? */
405 enum timestamp_set_resolution ts_res;
408 char *cwd; /* Working directory. */
410 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
413 * This represents the user information on this connection. Depending
414 * on the vuid using this tid, this might change per SMB request.
416 struct auth_session_info *session_info;
419 * If the "force group" parameter is set, this is the primary gid that
420 * may be used in the users token, depending on the vuid using this tid.
422 gid_t force_group_gid;
424 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
427 time_t lastused_count;
429 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
433 /* Semantics requested by the client or forced by the server config. */
436 bool short_case_preserve;
438 /* Semantics provided by the underlying filesystem. */
440 /* Device number of the directory of the share mount.
441 Used to ensure unique FileIndex returns. */
442 SMB_DEV_T base_share_dev;
444 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
445 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
446 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
447 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
448 struct dfree_cached_info *dfree_info;
449 struct trans_state *pending_trans;
451 struct rpc_pipe_client *spoolss_pipe;
455 struct smbd_smb2_request;
456 struct privilege_paths;
462 uint64_t mid; /* For compatibility with SMB2. */
464 uint64_t vuid; /* For compatibility with SMB2. */
470 const uint8_t *inbuf;
473 * Async handling in the main smb processing loop is directed by
474 * outbuf: reply_xxx routines indicate sync behaviour by putting their
475 * reply into "outbuf". If they leave it as NULL, they take care of it
476 * themselves, possibly later.
478 * If async handling is wanted, the reply_xxx routine must make sure
479 * that it talloc_move()s the smb_req somewhere else.
485 connection_struct *conn;
486 struct smbd_server_connection *sconn;
487 struct smbXsrv_connection *xconn;
488 struct smb_perfcount_data pcd;
491 * Chained request handling
493 struct files_struct *chain_fsp;
496 * state information for async smb handling
501 * Back pointer to smb2 request.
503 struct smbd_smb2_request *smb2req;
506 * Pathnames used if request done
509 struct privilege_paths *priv_paths;
512 * Request list for chained requests, we're part of it.
514 struct smb_request **chain;
516 struct timeval request_time;
518 bool posix_pathnames;
522 * Info about an alternate data stream
525 struct stream_struct {
532 struct smb_file_time {
533 struct timespec mtime;
534 struct timespec atime;
535 struct timespec ctime;
536 struct timespec create_time;
542 struct smb_filename {
545 char *original_lcomp;
551 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
552 * to keep the numeric values consistent.
555 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
557 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
558 handle = handle->next; \
561 enum vfs_translate_direction {
562 vfs_translate_to_unix = 0,
563 vfs_translate_to_windows
566 enum vfs_fallocate_flags {
567 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
568 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
572 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
573 * be handled as a COW clone, AKA reflink.
574 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
576 enum vfs_copy_chunk_flags {
577 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
578 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
580 VFS_COPY_CHUNK_FL_MASK_ALL =
581 (VFS_COPY_CHUNK_FL_MUST_CLONE
582 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
585 struct vfs_aio_state {
591 Available VFS operations. These values must be in sync with vfs_ops struct
592 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
593 In particular, if new operations are added to vfs_ops, appropriate constants
594 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
596 struct shadow_copy_data;
598 struct vfs_fn_pointers {
599 /* Disk operations */
601 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
602 void (*disconnect_fn)(struct vfs_handle_struct *handle);
603 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
604 uint64_t *dfree, uint64_t *dsize);
605 int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
606 enum SMB_QUOTA_TYPE qtype, unid_t id,
608 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
609 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
610 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
611 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
614 * Note: that "struct dfs_GetDFSReferral *r"
615 * needs to be a valid TALLOC_CTX
617 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
618 struct dfs_GetDFSReferral *r);
620 /* Directory operations */
622 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
623 const struct smb_filename *smb_fname,
625 uint32_t attributes);
626 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
627 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
629 SMB_STRUCT_STAT *sbuf);
630 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
631 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
632 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
633 int (*mkdir_fn)(struct vfs_handle_struct *handle,
634 const struct smb_filename *smb_fname,
636 int (*rmdir_fn)(struct vfs_handle_struct *handle,
637 const struct smb_filename *smb_fname);
638 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
639 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
641 /* File operations */
643 int (*open_fn)(struct vfs_handle_struct *handle,
644 struct smb_filename *smb_fname, files_struct *fsp,
645 int flags, mode_t mode);
646 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
647 struct smb_request *req,
648 uint16_t root_dir_fid,
649 struct smb_filename *smb_fname,
650 uint32_t access_mask,
651 uint32_t share_access,
652 uint32_t create_disposition,
653 uint32_t create_options,
654 uint32_t file_attributes,
655 uint32_t oplock_request,
656 struct smb2_lease *lease,
657 uint64_t allocation_size,
658 uint32_t private_flags,
659 struct security_descriptor *sd,
660 struct ea_list *ea_list,
661 files_struct **result,
663 const struct smb2_create_blobs *in_context_blobs,
664 struct smb2_create_blobs *out_context_blobs);
665 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
666 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
667 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
668 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
670 struct tevent_context *ev,
671 struct files_struct *fsp,
673 size_t n, off_t offset);
674 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
675 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
676 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
677 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
679 struct tevent_context *ev,
680 struct files_struct *fsp,
682 size_t n, off_t offset);
683 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
684 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
685 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
686 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
687 int (*rename_fn)(struct vfs_handle_struct *handle,
688 const struct smb_filename *smb_fname_src,
689 const struct smb_filename *smb_fname_dst);
690 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
691 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
693 struct tevent_context *ev,
694 struct files_struct *fsp);
695 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
696 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
697 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
698 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
699 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
700 int (*unlink_fn)(struct vfs_handle_struct *handle,
701 const struct smb_filename *smb_fname);
702 int (*chmod_fn)(struct vfs_handle_struct *handle,
703 const struct smb_filename *smb_fname,
705 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
706 int (*chown_fn)(struct vfs_handle_struct *handle,
707 const struct smb_filename *smb_fname,
710 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
711 int (*lchown_fn)(struct vfs_handle_struct *handle,
712 const struct smb_filename *smb_fname,
715 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
716 char *(*getwd_fn)(struct vfs_handle_struct *handle);
717 int (*ntimes_fn)(struct vfs_handle_struct *handle,
718 const struct smb_filename *smb_fname,
719 struct smb_file_time *ft);
720 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
721 int (*fallocate_fn)(struct vfs_handle_struct *handle,
722 struct files_struct *fsp,
726 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
727 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
728 uint32_t share_mode, uint32_t access_mask);
729 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
730 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
731 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
732 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
733 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
734 int (*mknod_fn)(struct vfs_handle_struct *handle,
735 const struct smb_filename *smb_fname,
738 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
739 int (*chflags_fn)(struct vfs_handle_struct *handle,
740 const struct smb_filename *smb_fname,
742 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
743 const SMB_STRUCT_STAT *sbuf);
744 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
746 struct tevent_context *ev,
747 struct files_struct *src_fsp,
749 struct files_struct *dest_fsp,
753 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
754 struct tevent_req *req,
756 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
758 struct files_struct *fsp,
759 struct smb_filename *smb_fname,
760 uint16_t *_compression_fmt);
761 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
763 struct files_struct *fsp,
764 uint16_t compression_fmt);
765 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
767 const char *service_path,
769 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
771 const char *base_volume,
776 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
781 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
782 struct files_struct *fsp,
783 const struct smb_filename *smb_fname,
785 unsigned int *num_streams,
786 struct stream_struct **streams);
788 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
794 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
795 const char *filename);
797 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
798 struct byte_range_lock *br_lck,
799 struct lock_struct *plock,
802 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
803 struct messaging_context *msg_ctx,
804 struct byte_range_lock *br_lck,
805 const struct lock_struct *plock);
807 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
808 struct byte_range_lock *br_lck,
809 struct lock_struct *plock);
811 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
812 struct files_struct *fsp,
813 struct lock_struct *plock);
815 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
816 struct files_struct *fsp,
817 struct lock_struct *plock);
819 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
821 enum vfs_translate_direction direction,
825 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
826 struct files_struct *fsp,
830 const uint8_t *_in_data,
833 uint32_t max_out_len,
836 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
837 struct smb_filename *smb_fname,
840 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
841 struct files_struct *fsp,
844 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
845 const struct smb_filename *smb_fname,
848 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
849 struct files_struct *fsp,
852 /* NT ACL operations. */
854 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
855 struct files_struct *fsp,
856 uint32_t security_info,
858 struct security_descriptor **ppdesc);
859 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
860 const struct smb_filename *smb_fname,
861 uint32_t security_info,
863 struct security_descriptor **ppdesc);
864 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
865 struct files_struct *fsp,
866 uint32_t security_info_sent,
867 const struct security_descriptor *psd);
869 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
870 struct smb_filename *file,
871 struct security_acl *sacl,
872 uint32_t access_requested,
873 uint32_t access_denied);
875 /* POSIX ACL operations. */
877 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
878 const struct smb_filename *smb_fname,
880 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
882 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
883 const struct smb_filename *smb_fname,
885 TALLOC_CTX *mem_ctx);
886 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
887 struct files_struct *fsp,
888 TALLOC_CTX *mem_ctx);
889 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
890 const struct smb_filename *smb_fname,
892 char **blob_description,
894 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
895 TALLOC_CTX *mem_ctx, char **blob_description,
897 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
898 const struct smb_filename *smb_fname,
899 SMB_ACL_TYPE_T acltype,
901 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
902 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
903 const struct smb_filename *smb_fname);
906 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
907 const struct smb_filename *smb_fname,
911 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
912 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
913 const struct smb_filename *smb_fname,
916 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
917 int (*removexattr_fn)(struct vfs_handle_struct *handle,
918 const struct smb_filename *smb_fname,
920 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
921 int (*setxattr_fn)(struct vfs_handle_struct *handle,
922 const struct smb_filename *smb_fname,
927 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
930 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
932 /* durable handle operations */
933 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
934 struct files_struct *fsp,
937 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
938 struct files_struct *fsp,
939 const DATA_BLOB old_cookie,
941 DATA_BLOB *new_cookie);
942 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
943 struct smb_request *smb1req,
944 struct smbXsrv_open *op,
945 const DATA_BLOB old_cookie,
947 struct files_struct **fsp,
948 DATA_BLOB *new_cookie);
950 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
951 const struct smb_filename *fname,
953 struct readdir_attr_data **attr_data);
957 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
958 which describes all operations this module is willing to intercept.
959 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
960 using this information.
963 typedef struct vfs_handle_struct {
964 struct vfs_handle_struct *next, *prev;
966 struct connection_struct *conn;
967 const struct vfs_fn_pointers *fns;
969 void (*free_data)(void **data);
973 typedef struct vfs_statvfs_struct {
974 /* For undefined recommended transfer size return -1 in that field */
975 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
979 The next three fields are in terms of the block size.
980 (above). If block size is unknown, 4096 would be a
981 reasonable block size for a server to report.
982 Note that returning the blocks/blocksavail removes need
983 to make a second call (to QFSInfo level 0x103 to get this info.
984 UserBlockAvail is typically less than or equal to BlocksAvail,
985 if no distinction is made return the same value in each.
988 uint64_t TotalBlocks;
989 uint64_t BlocksAvail; /* bfree */
990 uint64_t UserBlocksAvail; /* bavail */
992 /* For undefined Node fields or FSID return -1 */
993 uint64_t TotalFileNodes;
994 uint64_t FreeFileNodes;
995 uint64_t FsIdentifier; /* fsid */
996 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
997 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1000 } vfs_statvfs_struct;
1002 /* Add a new FSP extension of the given type. Returns a pointer to the
1005 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1006 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1008 /* Return a pointer to the existing FSP extension data. */
1009 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1010 vfs_fetch_fsp_extension(handle, (fsp))
1012 /* Return the talloc context associated with an FSP extension. */
1013 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1014 vfs_memctx_fsp_extension(handle, (fsp))
1016 /* Remove and destroy an FSP extension. */
1017 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1018 vfs_remove_fsp_extension((handle), (fsp))
1020 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1021 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1022 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1027 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1029 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1032 if ((handle)->free_data) { \
1033 (handle)->free_data(&(handle)->data); \
1035 (handle)->data = (void *)datap; \
1036 (handle)->free_data = free_fn; \
1040 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1041 if ((handle) && (handle)->free_data) { \
1042 (handle)->free_data(&(handle)->data); \
1046 /* Check whether module-specific data handle was already allocated or not */
1047 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1049 #define SMB_VFS_OP(x) ((void *) x)
1051 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1053 #include "vfs_macros.h"
1055 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1056 const char *service, const char *user);
1057 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1058 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1059 const char *path, uint64_t *bsize,
1060 uint64_t *dfree, uint64_t *dsize);
1061 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
1062 enum SMB_QUOTA_TYPE qtype, unid_t id,
1063 SMB_DISK_QUOTA *qt);
1064 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1065 enum SMB_QUOTA_TYPE qtype, unid_t id,
1066 SMB_DISK_QUOTA *qt);
1067 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1068 struct files_struct *fsp,
1069 struct shadow_copy_data *shadow_copy_data,
1071 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
1072 struct vfs_statvfs_struct *statbuf);
1073 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1074 enum timestamp_set_resolution *p_ts_res);
1076 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1078 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1079 struct dfs_GetDFSReferral *r);
1080 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1081 const struct smb_filename *smb_fname,
1083 uint32_t attributes);
1084 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1085 struct files_struct *fsp,
1087 uint32_t attributes);
1088 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1090 SMB_STRUCT_STAT *sbuf);
1091 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1092 DIR *dirp, long offset);
1093 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1095 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1097 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1098 const struct smb_filename *smb_fname,
1100 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1101 const struct smb_filename *smb_fname);
1102 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1104 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1106 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1107 struct smb_filename *smb_fname, struct files_struct *fsp,
1108 int flags, mode_t mode);
1109 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1110 struct smb_request *req,
1111 uint16_t root_dir_fid,
1112 struct smb_filename *smb_fname,
1113 uint32_t access_mask,
1114 uint32_t share_access,
1115 uint32_t create_disposition,
1116 uint32_t create_options,
1117 uint32_t file_attributes,
1118 uint32_t oplock_request,
1119 struct smb2_lease *lease,
1120 uint64_t allocation_size,
1121 uint32_t private_flags,
1122 struct security_descriptor *sd,
1123 struct ea_list *ea_list,
1124 files_struct **result,
1126 const struct smb2_create_blobs *in_context_blobs,
1127 struct smb2_create_blobs *out_context_blobs);
1128 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1129 struct files_struct *fsp);
1130 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1131 struct files_struct *fsp, void *data, size_t n);
1132 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1133 struct files_struct *fsp, void *data, size_t n,
1135 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1136 TALLOC_CTX *mem_ctx,
1137 struct tevent_context *ev,
1138 struct files_struct *fsp,
1140 size_t n, off_t offset);
1141 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1143 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1144 struct files_struct *fsp, const void *data,
1146 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1147 struct files_struct *fsp, const void *data,
1148 size_t n, off_t offset);
1149 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1150 TALLOC_CTX *mem_ctx,
1151 struct tevent_context *ev,
1152 struct files_struct *fsp,
1154 size_t n, off_t offset);
1155 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1157 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1158 struct files_struct *fsp, off_t offset,
1160 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1161 files_struct *fromfsp, const DATA_BLOB *header,
1162 off_t offset, size_t count);
1163 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1164 files_struct *tofsp, off_t offset,
1166 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1167 const struct smb_filename *smb_fname_src,
1168 const struct smb_filename *smb_fname_dst);
1169 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1170 struct files_struct *fsp);
1172 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1173 TALLOC_CTX *mem_ctx,
1174 struct tevent_context *ev,
1175 struct files_struct *fsp);
1176 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1178 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1179 struct smb_filename *smb_fname);
1180 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1181 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1182 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1183 struct smb_filename *smb_filename);
1184 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1185 struct files_struct *fsp,
1186 const SMB_STRUCT_STAT *sbuf);
1187 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1188 const struct smb_filename *smb_fname);
1189 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1190 const struct smb_filename *smb_fname,
1192 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1193 struct files_struct *fsp, mode_t mode);
1194 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1195 const struct smb_filename *smb_fname,
1198 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1199 struct files_struct *fsp, uid_t uid, gid_t gid);
1200 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1201 const struct smb_filename *smb_fname,
1204 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1205 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1206 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1207 const struct smb_filename *smb_fname,
1208 struct smb_file_time *ft);
1209 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1210 struct files_struct *fsp, off_t offset);
1211 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1212 struct files_struct *fsp,
1216 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1217 struct files_struct *fsp, int op, off_t offset,
1218 off_t count, int type);
1219 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1220 struct files_struct *fsp, uint32_t share_mode,
1221 uint32_t access_mask);
1222 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1223 struct files_struct *fsp, int leasetype);
1224 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1225 struct files_struct *fsp, off_t *poffset,
1226 off_t *pcount, int *ptype, pid_t *ppid);
1227 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1228 const char *newpath);
1229 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1230 const char *path, char *buf, size_t bufsiz);
1231 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1232 const char *newpath);
1233 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1234 const struct smb_filename *smb_fname,
1237 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1238 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1239 const struct smb_filename *smb_fname,
1240 unsigned int flags);
1241 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1242 const SMB_STRUCT_STAT *sbuf);
1243 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1244 struct files_struct *fsp,
1245 const struct smb_filename *smb_fname,
1246 TALLOC_CTX *mem_ctx,
1247 unsigned int *num_streams,
1248 struct stream_struct **streams);
1249 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1250 const char *path, const char *name,
1251 TALLOC_CTX *mem_ctx, char **found_name);
1252 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1253 const char *filename);
1254 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1255 struct byte_range_lock *br_lck,
1256 struct lock_struct *plock,
1257 bool blocking_lock);
1258 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1259 struct messaging_context *msg_ctx,
1260 struct byte_range_lock *br_lck,
1261 const struct lock_struct *plock);
1262 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1263 struct byte_range_lock *br_lck,
1264 struct lock_struct *plock);
1265 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1266 struct files_struct *fsp,
1267 struct lock_struct *plock);
1268 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1269 struct files_struct *fsp,
1270 struct lock_struct *plock);
1271 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1273 enum vfs_translate_direction direction,
1274 TALLOC_CTX *mem_ctx,
1275 char **mapped_name);
1276 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1277 struct files_struct *fsp,
1281 const uint8_t *_in_data,
1283 uint8_t **_out_data,
1284 uint32_t max_out_len,
1286 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1287 struct smb_filename *smb_fname,
1289 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1290 struct files_struct *fsp,
1292 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1293 const struct smb_filename *smb_fname,
1295 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1296 struct files_struct *fsp,
1298 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1299 TALLOC_CTX *mem_ctx,
1300 struct tevent_context *ev,
1301 struct files_struct *src_fsp,
1303 struct files_struct *dest_fsp,
1307 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1308 struct tevent_req *req,
1310 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1311 TALLOC_CTX *mem_ctx,
1312 struct files_struct *fsp,
1313 struct smb_filename *smb_fname,
1314 uint16_t *_compression_fmt);
1315 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1316 TALLOC_CTX *mem_ctx,
1317 struct files_struct *fsp,
1318 uint16_t compression_fmt);
1319 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1320 TALLOC_CTX *mem_ctx,
1321 const char *service_path,
1322 char **base_volume);
1323 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1324 TALLOC_CTX *mem_ctx,
1325 const char *base_volume,
1330 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1331 TALLOC_CTX *mem_ctx,
1334 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1335 struct files_struct *fsp,
1336 uint32_t security_info,
1337 TALLOC_CTX *mem_ctx,
1338 struct security_descriptor **ppdesc);
1339 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1340 const struct smb_filename *smb_fname,
1341 uint32_t security_info,
1342 TALLOC_CTX *mem_ctx,
1343 struct security_descriptor **ppdesc);
1344 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1345 struct files_struct *fsp,
1346 uint32_t security_info_sent,
1347 const struct security_descriptor *psd);
1348 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1349 struct smb_filename *file,
1350 struct security_acl *sacl,
1351 uint32_t access_requested,
1352 uint32_t access_denied);
1353 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1354 const struct smb_filename *file,
1356 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1357 struct files_struct *fsp, mode_t mode);
1358 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1359 const struct smb_filename *smb_fname,
1360 SMB_ACL_TYPE_T type,
1361 TALLOC_CTX *mem_ctx);
1362 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1363 struct files_struct *fsp,
1364 TALLOC_CTX *mem_ctx);
1365 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1366 const struct smb_filename *smb_fname,
1367 TALLOC_CTX *mem_ctx,
1368 char **blob_description,
1370 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1371 struct files_struct *fsp,
1372 TALLOC_CTX *mem_ctx,
1373 char **blob_description,
1375 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1376 const struct smb_filename *smb_fname,
1377 SMB_ACL_TYPE_T acltype,
1379 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1380 struct files_struct *fsp, SMB_ACL_T theacl);
1381 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1382 const struct smb_filename *smb_fname);
1383 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1384 const struct smb_filename *smb_fname,
1388 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1389 struct files_struct *fsp, const char *name,
1390 void *value, size_t size);
1391 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1392 const struct smb_filename *smb_fname,
1395 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1396 struct files_struct *fsp, char *list,
1398 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1399 const struct smb_filename *smb_fname,
1401 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1402 struct files_struct *fsp, const char *name);
1403 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1404 const struct smb_filename *smb_fname,
1409 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1410 const char *name, const void *value, size_t size,
1412 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1413 struct files_struct *fsp, const char *name,
1414 const void *value, size_t size, int flags);
1415 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1416 struct files_struct *fsp);
1417 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1418 const struct smb_filename *fname,
1419 SMB_STRUCT_STAT *sbuf);
1420 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1421 const struct smb_filename *fname);
1422 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1423 struct files_struct *fsp,
1424 TALLOC_CTX *mem_ctx,
1426 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1427 struct files_struct *fsp,
1428 const DATA_BLOB old_cookie,
1429 TALLOC_CTX *mem_ctx,
1430 DATA_BLOB *new_cookie);
1431 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1432 struct smb_request *smb1req,
1433 struct smbXsrv_open *op,
1434 const DATA_BLOB old_cookie,
1435 TALLOC_CTX *mem_ctx,
1436 struct files_struct **fsp,
1437 DATA_BLOB *new_cookie);
1438 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1439 const struct smb_filename *fname,
1440 TALLOC_CTX *mem_ctx,
1441 struct readdir_attr_data **attr_data);
1443 NTSTATUS smb_register_vfs(int version, const char *name,
1444 const struct vfs_fn_pointers *fns);
1445 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1446 files_struct *fsp, size_t ext_size,
1447 void (*destroy_fn)(void *p_data));
1448 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1449 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1450 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1451 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1453 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1454 const char *module);