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 * */
217 #define SMB_VFS_INTERFACE_VERSION 37
220 All intercepted VFS operations must be declared as static functions inside module source
221 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
222 example VFS modules for more details.
225 /* VFS operations structure */
227 struct vfs_handle_struct;
228 struct connection_struct;
230 struct security_descriptor;
231 struct vfs_statvfs_struct;
234 struct smb_file_time;
235 struct blocking_lock_record;
237 struct dfs_GetDFSReferral;
239 typedef union unid_t {
247 uint64_t position_information;
249 uint32_t private_options; /* NT Create options, but we only look at
250 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
251 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
252 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
253 * for print files *only*, where
254 * DELETE_ON_CLOSE is not stored in the share
257 unsigned long gen_id;
262 struct smbd_server_connection *sconn;
263 struct tevent_timer *timeout;
264 struct smb2_lease lease;
267 typedef struct files_struct {
268 struct files_struct *next, *prev;
270 struct smbXsrv_open *op;
271 struct connection_struct *conn;
272 struct fd_handle *fh;
273 unsigned int num_smb_operations;
274 struct file_id file_id;
275 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
277 uint64_t vuid; /* SMB2 compat */
278 struct write_cache *wcp;
279 struct timeval open_time;
280 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
281 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
283 bool kernel_share_modes_taken;
285 bool update_write_time_triggered;
286 struct tevent_timer *update_write_time_event;
287 bool update_write_time_on_close;
288 struct timespec close_write_time;
289 bool write_time_forced;
292 struct fsp_lease *lease;
293 int sent_oplock_break;
294 struct tevent_timer *oplock_timeout;
295 struct lock_struct last_lock_failure;
296 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
303 bool aio_write_behind;
304 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
305 bool delete_on_close;
306 uint64_t posix_flags;
308 bool backup_intent; /* Handle was successfully opened with backup intent
309 and opener has privilege to do so. */
310 bool aapl_copyfile_supported;
311 bool use_ofd_locks; /* Are we using open file description locks ? */
312 struct smb_filename *fsp_name;
313 uint32_t name_hash; /* Jenkins hash of full pathname. */
314 uint64_t mid; /* Mid of the operation that created us. */
316 struct vfs_fsp_data *vfs_extension;
317 struct fake_file_handle *fake_file_handle;
319 struct notify_change_buf *notify;
321 struct files_struct *base_fsp; /* placeholder for delete on close */
324 * Read-only cached brlock record, thrown away when the
325 * brlock.tdb seqnum changes. This avoids fetching data from
326 * the brlock.tdb on every read/write call.
329 struct byte_range_lock *brlock_rec;
331 struct dptr_struct *dptr;
333 /* if not NULL, means this is a print file */
334 struct print_file_data *print_file;
336 unsigned num_aio_requests;
337 struct tevent_req **aio_requests;
340 * If a close request comes in while we still have aio_requests
341 * around, we need to hold back the close. When all aio_requests are
342 * done, the aio completion routines need tevent_wait_done() on
343 * this. A bit ugly, but before we have close_file() fully async
344 * possibly the simplest approach. Thanks, Jeremy for the idea.
346 struct tevent_req *deferred_close;
349 #define FSP_POSIX_FLAGS_OPEN 0x01
350 #define FSP_POSIX_FLAGS_RENAME 0x02
351 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
353 #define FSP_POSIX_FLAGS_ALL \
354 (FSP_POSIX_FLAGS_OPEN | \
355 FSP_POSIX_FLAGS_PATHNAMES | \
356 FSP_POSIX_FLAGS_RENAME)
358 struct vuid_cache_entry {
359 struct auth_session_info *session_info;
360 uint64_t vuid; /* SMB2 compat */
362 uint32_t share_access;
366 unsigned int next_entry;
367 struct vuid_cache_entry array[VUID_CACHE_SIZE];
373 } name_compare_entry;
375 struct dfree_cached_info {
376 time_t last_dfree_time;
383 struct share_params {
387 typedef struct connection_struct {
388 struct connection_struct *next, *prev;
389 struct smbd_server_connection *sconn; /* can be NULL */
390 struct smbXsrv_tcon *tcon; /* can be NULL */
391 uint32_t cnum; /* an index passed over the wire */
392 struct share_params *params;
394 struct vuid_cache *vuid_cache;
397 bool read_only; /* Attributes for the current user of the share. */
398 uint32_t share_access;
399 /* Does this filesystem honor
400 sub second timestamps on files
401 and directories when setting time ? */
402 enum timestamp_set_resolution ts_res;
405 char *cwd; /* Working directory. */
407 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
410 * This represents the user information on this connection. Depending
411 * on the vuid using this tid, this might change per SMB request.
413 struct auth_session_info *session_info;
416 * If the "force group" parameter is set, this is the primary gid that
417 * may be used in the users token, depending on the vuid using this tid.
419 gid_t force_group_gid;
421 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
424 time_t lastused_count;
426 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
430 /* Semantics requested by the client or forced by the server config. */
433 bool short_case_preserve;
435 /* Semantics provided by the underlying filesystem. */
437 /* Device number of the directory of the share mount.
438 Used to ensure unique FileIndex returns. */
439 SMB_DEV_T base_share_dev;
441 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
442 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
443 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
444 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
445 struct dfree_cached_info *dfree_info;
446 struct trans_state *pending_trans;
448 struct rpc_pipe_client *spoolss_pipe;
452 struct smbd_smb2_request;
453 struct privilege_paths;
459 uint64_t mid; /* For compatibility with SMB2. */
461 uint64_t vuid; /* For compatibility with SMB2. */
467 const uint8_t *inbuf;
470 * Async handling in the main smb processing loop is directed by
471 * outbuf: reply_xxx routines indicate sync behaviour by putting their
472 * reply into "outbuf". If they leave it as NULL, they take care of it
473 * themselves, possibly later.
475 * If async handling is wanted, the reply_xxx routine must make sure
476 * that it talloc_move()s the smb_req somewhere else.
482 connection_struct *conn;
483 struct smbd_server_connection *sconn;
484 struct smbXsrv_connection *xconn;
485 struct smb_perfcount_data pcd;
488 * Chained request handling
490 struct files_struct *chain_fsp;
493 * state information for async smb handling
498 * Back pointer to smb2 request.
500 struct smbd_smb2_request *smb2req;
503 * Pathnames used if request done
506 struct privilege_paths *priv_paths;
509 * Request list for chained requests, we're part of it.
511 struct smb_request **chain;
513 struct timeval request_time;
515 bool posix_pathnames;
519 * Info about an alternate data stream
522 struct stream_struct {
529 struct smb_file_time {
530 struct timespec mtime;
531 struct timespec atime;
532 struct timespec ctime;
533 struct timespec create_time;
539 struct smb_filename {
542 char *original_lcomp;
548 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
549 * to keep the numeric values consistent.
552 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
554 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
555 handle = handle->next; \
558 enum vfs_translate_direction {
559 vfs_translate_to_unix = 0,
560 vfs_translate_to_windows
563 enum vfs_fallocate_flags {
564 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
565 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
569 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
570 * be handled as a COW clone, AKA reflink.
571 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
573 enum vfs_copy_chunk_flags {
574 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
575 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
577 VFS_COPY_CHUNK_FL_MASK_ALL =
578 (VFS_COPY_CHUNK_FL_MUST_CLONE
579 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
582 struct vfs_aio_state {
588 Available VFS operations. These values must be in sync with vfs_ops struct
589 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
590 In particular, if new operations are added to vfs_ops, appropriate constants
591 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
593 struct shadow_copy_data;
595 struct vfs_fn_pointers {
596 /* Disk operations */
598 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
599 void (*disconnect_fn)(struct vfs_handle_struct *handle);
600 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
601 uint64_t *dfree, uint64_t *dsize);
602 int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
603 enum SMB_QUOTA_TYPE qtype, unid_t id,
605 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
606 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
607 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
608 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
611 * Note: that "struct dfs_GetDFSReferral *r"
612 * needs to be a valid TALLOC_CTX
614 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
615 struct dfs_GetDFSReferral *r);
617 /* Directory operations */
619 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
620 const struct smb_filename *smb_fname,
622 uint32_t attributes);
623 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
624 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
626 SMB_STRUCT_STAT *sbuf);
627 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
628 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
629 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
630 int (*mkdir_fn)(struct vfs_handle_struct *handle,
631 const struct smb_filename *smb_fname,
633 int (*rmdir_fn)(struct vfs_handle_struct *handle,
634 const struct smb_filename *smb_fname);
635 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
636 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
638 /* File operations */
640 int (*open_fn)(struct vfs_handle_struct *handle,
641 struct smb_filename *smb_fname, files_struct *fsp,
642 int flags, mode_t mode);
643 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
644 struct smb_request *req,
645 uint16_t root_dir_fid,
646 struct smb_filename *smb_fname,
647 uint32_t access_mask,
648 uint32_t share_access,
649 uint32_t create_disposition,
650 uint32_t create_options,
651 uint32_t file_attributes,
652 uint32_t oplock_request,
653 struct smb2_lease *lease,
654 uint64_t allocation_size,
655 uint32_t private_flags,
656 struct security_descriptor *sd,
657 struct ea_list *ea_list,
658 files_struct **result,
660 const struct smb2_create_blobs *in_context_blobs,
661 struct smb2_create_blobs *out_context_blobs);
662 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
663 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
664 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
665 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
667 struct tevent_context *ev,
668 struct files_struct *fsp,
670 size_t n, off_t offset);
671 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
672 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
673 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
674 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
676 struct tevent_context *ev,
677 struct files_struct *fsp,
679 size_t n, off_t offset);
680 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
681 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
682 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
683 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
684 int (*rename_fn)(struct vfs_handle_struct *handle,
685 const struct smb_filename *smb_fname_src,
686 const struct smb_filename *smb_fname_dst);
687 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
688 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
690 struct tevent_context *ev,
691 struct files_struct *fsp);
692 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
693 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
694 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
695 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
696 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
697 int (*unlink_fn)(struct vfs_handle_struct *handle,
698 const struct smb_filename *smb_fname);
699 int (*chmod_fn)(struct vfs_handle_struct *handle,
700 const struct smb_filename *smb_fname,
702 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
703 int (*chown_fn)(struct vfs_handle_struct *handle,
704 const struct smb_filename *smb_fname,
707 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
708 int (*lchown_fn)(struct vfs_handle_struct *handle,
709 const struct smb_filename *smb_fname,
712 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
713 char *(*getwd_fn)(struct vfs_handle_struct *handle);
714 int (*ntimes_fn)(struct vfs_handle_struct *handle,
715 const struct smb_filename *smb_fname,
716 struct smb_file_time *ft);
717 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
718 int (*fallocate_fn)(struct vfs_handle_struct *handle,
719 struct files_struct *fsp,
723 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
724 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
725 uint32_t share_mode, uint32_t access_mask);
726 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
727 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
728 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
729 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
730 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
731 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
732 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
733 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
734 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
735 const SMB_STRUCT_STAT *sbuf);
736 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
738 struct tevent_context *ev,
739 struct files_struct *src_fsp,
741 struct files_struct *dest_fsp,
745 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
746 struct tevent_req *req,
748 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
750 struct files_struct *fsp,
751 struct smb_filename *smb_fname,
752 uint16_t *_compression_fmt);
753 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
755 struct files_struct *fsp,
756 uint16_t compression_fmt);
757 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
759 const char *service_path,
761 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
763 const char *base_volume,
768 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
773 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
774 struct files_struct *fsp,
775 const struct smb_filename *smb_fname,
777 unsigned int *num_streams,
778 struct stream_struct **streams);
780 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
786 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
787 const char *filename);
789 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
790 struct byte_range_lock *br_lck,
791 struct lock_struct *plock,
794 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
795 struct messaging_context *msg_ctx,
796 struct byte_range_lock *br_lck,
797 const struct lock_struct *plock);
799 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
800 struct byte_range_lock *br_lck,
801 struct lock_struct *plock);
803 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 struct lock_struct *plock);
807 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
808 struct files_struct *fsp,
809 struct lock_struct *plock);
811 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
813 enum vfs_translate_direction direction,
817 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
818 struct files_struct *fsp,
822 const uint8_t *_in_data,
825 uint32_t max_out_len,
828 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
829 struct smb_filename *smb_fname,
832 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
833 struct files_struct *fsp,
836 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
837 const struct smb_filename *smb_fname,
840 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
841 struct files_struct *fsp,
844 /* NT ACL operations. */
846 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
847 struct files_struct *fsp,
848 uint32_t security_info,
850 struct security_descriptor **ppdesc);
851 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
852 const struct smb_filename *smb_fname,
853 uint32_t security_info,
855 struct security_descriptor **ppdesc);
856 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
857 struct files_struct *fsp,
858 uint32_t security_info_sent,
859 const struct security_descriptor *psd);
861 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
862 struct smb_filename *file,
863 struct security_acl *sacl,
864 uint32_t access_requested,
865 uint32_t access_denied);
867 /* POSIX ACL operations. */
869 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
870 const struct smb_filename *smb_fname,
872 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
874 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
875 const struct smb_filename *smb_fname,
877 TALLOC_CTX *mem_ctx);
878 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
879 struct files_struct *fsp,
880 TALLOC_CTX *mem_ctx);
881 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
882 const struct smb_filename *smb_fname,
884 char **blob_description,
886 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
887 TALLOC_CTX *mem_ctx, char **blob_description,
889 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
890 const struct smb_filename *smb_fname,
891 SMB_ACL_TYPE_T acltype,
893 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
894 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
895 const struct smb_filename *smb_fname);
898 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
899 const struct smb_filename *smb_fname,
903 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
904 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
905 const struct smb_filename *smb_fname,
908 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
909 int (*removexattr_fn)(struct vfs_handle_struct *handle,
910 const struct smb_filename *smb_fname,
912 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
913 int (*setxattr_fn)(struct vfs_handle_struct *handle,
914 const struct smb_filename *smb_fname,
919 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
922 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
924 /* durable handle operations */
925 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
926 struct files_struct *fsp,
929 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
930 struct files_struct *fsp,
931 const DATA_BLOB old_cookie,
933 DATA_BLOB *new_cookie);
934 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
935 struct smb_request *smb1req,
936 struct smbXsrv_open *op,
937 const DATA_BLOB old_cookie,
939 struct files_struct **fsp,
940 DATA_BLOB *new_cookie);
942 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
943 const struct smb_filename *fname,
945 struct readdir_attr_data **attr_data);
949 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
950 which describes all operations this module is willing to intercept.
951 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
952 using this information.
955 typedef struct vfs_handle_struct {
956 struct vfs_handle_struct *next, *prev;
958 struct connection_struct *conn;
959 const struct vfs_fn_pointers *fns;
961 void (*free_data)(void **data);
965 typedef struct vfs_statvfs_struct {
966 /* For undefined recommended transfer size return -1 in that field */
967 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
971 The next three fields are in terms of the block size.
972 (above). If block size is unknown, 4096 would be a
973 reasonable block size for a server to report.
974 Note that returning the blocks/blocksavail removes need
975 to make a second call (to QFSInfo level 0x103 to get this info.
976 UserBlockAvail is typically less than or equal to BlocksAvail,
977 if no distinction is made return the same value in each.
980 uint64_t TotalBlocks;
981 uint64_t BlocksAvail; /* bfree */
982 uint64_t UserBlocksAvail; /* bavail */
984 /* For undefined Node fields or FSID return -1 */
985 uint64_t TotalFileNodes;
986 uint64_t FreeFileNodes;
987 uint64_t FsIdentifier; /* fsid */
988 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
989 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
992 } vfs_statvfs_struct;
994 /* Add a new FSP extension of the given type. Returns a pointer to the
997 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
998 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1000 /* Return a pointer to the existing FSP extension data. */
1001 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1002 vfs_fetch_fsp_extension(handle, (fsp))
1004 /* Return the talloc context associated with an FSP extension. */
1005 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1006 vfs_memctx_fsp_extension(handle, (fsp))
1008 /* Remove and destroy an FSP extension. */
1009 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1010 vfs_remove_fsp_extension((handle), (fsp))
1012 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1013 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1014 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1019 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1021 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1024 if ((handle)->free_data) { \
1025 (handle)->free_data(&(handle)->data); \
1027 (handle)->data = (void *)datap; \
1028 (handle)->free_data = free_fn; \
1032 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1033 if ((handle) && (handle)->free_data) { \
1034 (handle)->free_data(&(handle)->data); \
1038 /* Check whether module-specific data handle was already allocated or not */
1039 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1041 #define SMB_VFS_OP(x) ((void *) x)
1043 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1045 #include "vfs_macros.h"
1047 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1048 const char *service, const char *user);
1049 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1050 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1051 const char *path, uint64_t *bsize,
1052 uint64_t *dfree, uint64_t *dsize);
1053 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
1054 enum SMB_QUOTA_TYPE qtype, unid_t id,
1055 SMB_DISK_QUOTA *qt);
1056 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1057 enum SMB_QUOTA_TYPE qtype, unid_t id,
1058 SMB_DISK_QUOTA *qt);
1059 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1060 struct files_struct *fsp,
1061 struct shadow_copy_data *shadow_copy_data,
1063 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
1064 struct vfs_statvfs_struct *statbuf);
1065 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1066 enum timestamp_set_resolution *p_ts_res);
1068 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1070 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1071 struct dfs_GetDFSReferral *r);
1072 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1073 const struct smb_filename *smb_fname,
1075 uint32_t attributes);
1076 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1077 struct files_struct *fsp,
1079 uint32_t attributes);
1080 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1082 SMB_STRUCT_STAT *sbuf);
1083 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1084 DIR *dirp, long offset);
1085 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1087 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1089 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1090 const struct smb_filename *smb_fname,
1092 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1093 const struct smb_filename *smb_fname);
1094 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1096 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1098 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1099 struct smb_filename *smb_fname, struct files_struct *fsp,
1100 int flags, mode_t mode);
1101 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1102 struct smb_request *req,
1103 uint16_t root_dir_fid,
1104 struct smb_filename *smb_fname,
1105 uint32_t access_mask,
1106 uint32_t share_access,
1107 uint32_t create_disposition,
1108 uint32_t create_options,
1109 uint32_t file_attributes,
1110 uint32_t oplock_request,
1111 struct smb2_lease *lease,
1112 uint64_t allocation_size,
1113 uint32_t private_flags,
1114 struct security_descriptor *sd,
1115 struct ea_list *ea_list,
1116 files_struct **result,
1118 const struct smb2_create_blobs *in_context_blobs,
1119 struct smb2_create_blobs *out_context_blobs);
1120 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1121 struct files_struct *fsp);
1122 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1123 struct files_struct *fsp, void *data, size_t n);
1124 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1125 struct files_struct *fsp, void *data, size_t n,
1127 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1128 TALLOC_CTX *mem_ctx,
1129 struct tevent_context *ev,
1130 struct files_struct *fsp,
1132 size_t n, off_t offset);
1133 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1135 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1136 struct files_struct *fsp, const void *data,
1138 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1139 struct files_struct *fsp, const void *data,
1140 size_t n, off_t offset);
1141 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1142 TALLOC_CTX *mem_ctx,
1143 struct tevent_context *ev,
1144 struct files_struct *fsp,
1146 size_t n, off_t offset);
1147 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1149 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1150 struct files_struct *fsp, off_t offset,
1152 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1153 files_struct *fromfsp, const DATA_BLOB *header,
1154 off_t offset, size_t count);
1155 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1156 files_struct *tofsp, off_t offset,
1158 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1159 const struct smb_filename *smb_fname_src,
1160 const struct smb_filename *smb_fname_dst);
1161 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1162 struct files_struct *fsp);
1164 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1165 TALLOC_CTX *mem_ctx,
1166 struct tevent_context *ev,
1167 struct files_struct *fsp);
1168 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1170 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1171 struct smb_filename *smb_fname);
1172 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1173 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1174 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1175 struct smb_filename *smb_filename);
1176 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1177 struct files_struct *fsp,
1178 const SMB_STRUCT_STAT *sbuf);
1179 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1180 const struct smb_filename *smb_fname);
1181 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1182 const struct smb_filename *smb_fname,
1184 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1185 struct files_struct *fsp, mode_t mode);
1186 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1187 const struct smb_filename *smb_fname,
1190 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1191 struct files_struct *fsp, uid_t uid, gid_t gid);
1192 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1193 const struct smb_filename *smb_fname,
1196 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1197 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1198 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1199 const struct smb_filename *smb_fname,
1200 struct smb_file_time *ft);
1201 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1202 struct files_struct *fsp, off_t offset);
1203 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1204 struct files_struct *fsp,
1208 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1209 struct files_struct *fsp, int op, off_t offset,
1210 off_t count, int type);
1211 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1212 struct files_struct *fsp, uint32_t share_mode,
1213 uint32_t access_mask);
1214 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1215 struct files_struct *fsp, int leasetype);
1216 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1217 struct files_struct *fsp, off_t *poffset,
1218 off_t *pcount, int *ptype, pid_t *ppid);
1219 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1220 const char *newpath);
1221 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1222 const char *path, char *buf, size_t bufsiz);
1223 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1224 const char *newpath);
1225 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1226 mode_t mode, SMB_DEV_T dev);
1227 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1228 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1229 unsigned int flags);
1230 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1231 const SMB_STRUCT_STAT *sbuf);
1232 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1233 struct files_struct *fsp,
1234 const struct smb_filename *smb_fname,
1235 TALLOC_CTX *mem_ctx,
1236 unsigned int *num_streams,
1237 struct stream_struct **streams);
1238 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1239 const char *path, const char *name,
1240 TALLOC_CTX *mem_ctx, char **found_name);
1241 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1242 const char *filename);
1243 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1244 struct byte_range_lock *br_lck,
1245 struct lock_struct *plock,
1246 bool blocking_lock);
1247 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1248 struct messaging_context *msg_ctx,
1249 struct byte_range_lock *br_lck,
1250 const struct lock_struct *plock);
1251 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1252 struct byte_range_lock *br_lck,
1253 struct lock_struct *plock);
1254 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1255 struct files_struct *fsp,
1256 struct lock_struct *plock);
1257 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1258 struct files_struct *fsp,
1259 struct lock_struct *plock);
1260 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1262 enum vfs_translate_direction direction,
1263 TALLOC_CTX *mem_ctx,
1264 char **mapped_name);
1265 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1266 struct files_struct *fsp,
1270 const uint8_t *_in_data,
1272 uint8_t **_out_data,
1273 uint32_t max_out_len,
1275 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1276 struct smb_filename *smb_fname,
1278 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1279 struct files_struct *fsp,
1281 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1282 const struct smb_filename *smb_fname,
1284 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1285 struct files_struct *fsp,
1287 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1288 TALLOC_CTX *mem_ctx,
1289 struct tevent_context *ev,
1290 struct files_struct *src_fsp,
1292 struct files_struct *dest_fsp,
1296 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1297 struct tevent_req *req,
1299 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1300 TALLOC_CTX *mem_ctx,
1301 struct files_struct *fsp,
1302 struct smb_filename *smb_fname,
1303 uint16_t *_compression_fmt);
1304 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1305 TALLOC_CTX *mem_ctx,
1306 struct files_struct *fsp,
1307 uint16_t compression_fmt);
1308 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1309 TALLOC_CTX *mem_ctx,
1310 const char *service_path,
1311 char **base_volume);
1312 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1313 TALLOC_CTX *mem_ctx,
1314 const char *base_volume,
1319 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1320 TALLOC_CTX *mem_ctx,
1323 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1324 struct files_struct *fsp,
1325 uint32_t security_info,
1326 TALLOC_CTX *mem_ctx,
1327 struct security_descriptor **ppdesc);
1328 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1329 const struct smb_filename *smb_fname,
1330 uint32_t security_info,
1331 TALLOC_CTX *mem_ctx,
1332 struct security_descriptor **ppdesc);
1333 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1334 struct files_struct *fsp,
1335 uint32_t security_info_sent,
1336 const struct security_descriptor *psd);
1337 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1338 struct smb_filename *file,
1339 struct security_acl *sacl,
1340 uint32_t access_requested,
1341 uint32_t access_denied);
1342 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1343 const struct smb_filename *file,
1345 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1346 struct files_struct *fsp, mode_t mode);
1347 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1348 const struct smb_filename *smb_fname,
1349 SMB_ACL_TYPE_T type,
1350 TALLOC_CTX *mem_ctx);
1351 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1352 struct files_struct *fsp,
1353 TALLOC_CTX *mem_ctx);
1354 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1355 const struct smb_filename *smb_fname,
1356 TALLOC_CTX *mem_ctx,
1357 char **blob_description,
1359 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1360 struct files_struct *fsp,
1361 TALLOC_CTX *mem_ctx,
1362 char **blob_description,
1364 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1365 const struct smb_filename *smb_fname,
1366 SMB_ACL_TYPE_T acltype,
1368 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1369 struct files_struct *fsp, SMB_ACL_T theacl);
1370 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1371 const struct smb_filename *smb_fname);
1372 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1373 const struct smb_filename *smb_fname,
1377 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1378 struct files_struct *fsp, const char *name,
1379 void *value, size_t size);
1380 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1381 const struct smb_filename *smb_fname,
1384 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1385 const char *path, char *list, size_t size);
1386 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1387 struct files_struct *fsp, char *list,
1389 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1390 const struct smb_filename *smb_fname,
1392 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1393 struct files_struct *fsp, const char *name);
1394 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1395 const struct smb_filename *smb_fname,
1400 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1401 const char *name, const void *value, size_t size,
1403 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1404 struct files_struct *fsp, const char *name,
1405 const void *value, size_t size, int flags);
1406 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1407 struct files_struct *fsp);
1408 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1409 const struct smb_filename *fname,
1410 SMB_STRUCT_STAT *sbuf);
1411 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1412 const struct smb_filename *fname);
1413 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1414 struct files_struct *fsp,
1415 TALLOC_CTX *mem_ctx,
1417 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1418 struct files_struct *fsp,
1419 const DATA_BLOB old_cookie,
1420 TALLOC_CTX *mem_ctx,
1421 DATA_BLOB *new_cookie);
1422 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1423 struct smb_request *smb1req,
1424 struct smbXsrv_open *op,
1425 const DATA_BLOB old_cookie,
1426 TALLOC_CTX *mem_ctx,
1427 struct files_struct **fsp,
1428 DATA_BLOB *new_cookie);
1429 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1430 const struct smb_filename *fname,
1431 TALLOC_CTX *mem_ctx,
1432 struct readdir_attr_data **attr_data);
1434 NTSTATUS smb_register_vfs(int version, const char *name,
1435 const struct vfs_fn_pointers *fns);
1436 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1437 files_struct *fsp, size_t ext_size,
1438 void (*destroy_fn)(void *p_data));
1439 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1440 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1441 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1442 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1444 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1445 const char *module);