2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
29 /* Avoid conflict with an AIX include file */
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
45 * If you change anything here, please also update modules/vfs_full_audit.c.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205 to const struct smb_filename * */
206 /* Version 37 - Change sys_acl_set_file from const char *
207 to const struct smb_filename * */
208 /* Version 37 - Change listxattr from const char *
209 to const struct smb_filename * */
210 /* Version 37 - Change removexattr from const char *
211 to const struct smb_filename * */
212 /* Version 37 - Change setxattr from const char *
213 to const struct smb_filename * */
214 /* Version 37 - Change getxattr from const char *
215 to const struct smb_filename * */
216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
217 /* Version 37 - Change chflags from const char *
218 to const struct smb_filename * */
219 /* Version 37 - Change disk_free from const char *
220 to const struct smb_filename * */
221 /* Version 37 - Change get_quota from const char *
222 to const struct smb_filename * */
223 /* Version 37 - Change link from const char *
224 to const struct smb_filename * */
225 /* Version 37 - Change statvfs from const char *
226 to const struct smb_filename * */
227 /* Version 37 - Change readlink from const char *
228 to const struct smb_filename * */
229 /* Version 37 - Change symlink from const char *
230 to const struct smb_filename * */
231 /* Version 37 - Change chdir from const char *
232 to const struct smb_filename * */
233 /* Version 37 - Change getwd from char *
234 to const struct smb_filename * */
235 /* Version 37 - Change conn->cwd from char *
236 to struct smb_filename * */
237 /* Version 37 - Change realpath from char *
238 to struct smb_filename * */
239 /* Version 37 - Change connectpath from char *
240 to struct smb_filename * */
241 /* Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND/RECV */
242 /* Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND/RECV to
243 SMB_VFS_OFFLOAD_READ_SEND/RECV */
245 #define SMB_VFS_INTERFACE_VERSION 37
248 All intercepted VFS operations must be declared as static functions inside module source
249 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
250 example VFS modules for more details.
253 /* VFS operations structure */
255 struct vfs_handle_struct;
256 struct connection_struct;
258 struct security_descriptor;
259 struct vfs_statvfs_struct;
262 struct smb_file_time;
263 struct blocking_lock_record;
265 struct dfs_GetDFSReferral;
267 typedef union unid_t {
275 uint64_t position_information;
277 uint32_t private_options; /* NT Create options, but we only look at
278 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
279 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
280 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
281 * for print files *only*, where
282 * DELETE_ON_CLOSE is not stored in the share
285 unsigned long gen_id;
290 struct smbd_server_connection *sconn;
291 struct tevent_timer *timeout;
292 struct smb2_lease lease;
295 typedef struct files_struct {
296 struct files_struct *next, *prev;
298 struct smbXsrv_open *op;
299 struct connection_struct *conn;
300 struct fd_handle *fh;
301 unsigned int num_smb_operations;
302 struct file_id file_id;
303 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
305 uint64_t vuid; /* SMB2 compat */
306 struct write_cache *wcp;
307 struct timeval open_time;
308 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
309 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
311 bool kernel_share_modes_taken;
313 bool update_write_time_triggered;
314 struct tevent_timer *update_write_time_event;
315 bool update_write_time_on_close;
316 struct timespec close_write_time;
317 bool write_time_forced;
320 struct fsp_lease *lease;
321 int sent_oplock_break;
322 struct tevent_timer *oplock_timeout;
323 struct lock_struct last_lock_failure;
324 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
331 bool aio_write_behind;
332 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
333 bool delete_on_close;
334 uint64_t posix_flags;
336 bool backup_intent; /* Handle was successfully opened with backup intent
337 and opener has privilege to do so. */
338 bool use_ofd_locks; /* Are we using open file description locks ? */
339 struct smb_filename *fsp_name;
340 uint32_t name_hash; /* Jenkins hash of full pathname. */
341 uint64_t mid; /* Mid of the operation that created us. */
343 struct vfs_fsp_data *vfs_extension;
344 struct fake_file_handle *fake_file_handle;
346 struct notify_change_buf *notify;
348 struct files_struct *base_fsp; /* placeholder for delete on close */
351 * Read-only cached brlock record, thrown away when the
352 * brlock.tdb seqnum changes. This avoids fetching data from
353 * the brlock.tdb on every read/write call.
356 struct byte_range_lock *brlock_rec;
358 struct dptr_struct *dptr;
360 /* if not NULL, means this is a print file */
361 struct print_file_data *print_file;
363 unsigned num_aio_requests;
364 struct tevent_req **aio_requests;
367 * If a close request comes in while we still have aio_requests
368 * around, we need to hold back the close. When all aio_requests are
369 * done, the aio completion routines need tevent_wait_done() on
370 * this. A bit ugly, but before we have close_file() fully async
371 * possibly the simplest approach. Thanks, Jeremy for the idea.
373 struct tevent_req *deferred_close;
376 #define FSP_POSIX_FLAGS_OPEN 0x01
377 #define FSP_POSIX_FLAGS_RENAME 0x02
378 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
380 #define FSP_POSIX_FLAGS_ALL \
381 (FSP_POSIX_FLAGS_OPEN | \
382 FSP_POSIX_FLAGS_PATHNAMES | \
383 FSP_POSIX_FLAGS_RENAME)
385 struct vuid_cache_entry {
386 struct auth_session_info *session_info;
387 uint64_t vuid; /* SMB2 compat */
389 uint32_t share_access;
393 unsigned int next_entry;
394 struct vuid_cache_entry array[VUID_CACHE_SIZE];
400 } name_compare_entry;
402 struct dfree_cached_info {
403 time_t last_dfree_time;
410 struct share_params {
414 typedef struct connection_struct {
415 struct connection_struct *next, *prev;
416 struct smbd_server_connection *sconn; /* can be NULL */
417 struct smbXsrv_tcon *tcon; /* can be NULL */
418 uint32_t cnum; /* an index passed over the wire */
419 struct share_params *params;
421 struct vuid_cache *vuid_cache;
424 bool read_only; /* Attributes for the current user of the share. */
425 uint32_t share_access;
426 /* Does this filesystem honor
427 sub second timestamps on files
428 and directories when setting time ? */
429 enum timestamp_set_resolution ts_res;
432 struct smb_filename *cwd_fname; /* Working directory. */
434 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
437 * This represents the user information on this connection. Depending
438 * on the vuid using this tid, this might change per SMB request.
440 struct auth_session_info *session_info;
443 * If the "force group" parameter is set, this is the primary gid that
444 * may be used in the users token, depending on the vuid using this tid.
446 gid_t force_group_gid;
448 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
451 time_t lastused_count;
453 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
457 /* Semantics requested by the client or forced by the server config. */
460 bool short_case_preserve;
462 /* Semantics provided by the underlying filesystem. */
464 /* Device number of the directory of the share mount.
465 Used to ensure unique FileIndex returns. */
466 SMB_DEV_T base_share_dev;
468 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
469 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
470 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
471 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
472 struct dfree_cached_info *dfree_info;
473 struct trans_state *pending_trans;
475 struct rpc_pipe_client *spoolss_pipe;
479 struct smbd_smb2_request;
480 struct privilege_paths;
486 uint64_t mid; /* For compatibility with SMB2. */
488 uint64_t vuid; /* For compatibility with SMB2. */
494 const uint8_t *inbuf;
497 * Async handling in the main smb processing loop is directed by
498 * outbuf: reply_xxx routines indicate sync behaviour by putting their
499 * reply into "outbuf". If they leave it as NULL, they take care of it
500 * themselves, possibly later.
502 * If async handling is wanted, the reply_xxx routine must make sure
503 * that it talloc_move()s the smb_req somewhere else.
509 connection_struct *conn;
510 struct smbd_server_connection *sconn;
511 struct smbXsrv_connection *xconn;
512 struct smb_perfcount_data pcd;
515 * Chained request handling
517 struct files_struct *chain_fsp;
520 * state information for async smb handling
525 * Back pointer to smb2 request.
527 struct smbd_smb2_request *smb2req;
530 * Pathnames used if request done
533 struct privilege_paths *priv_paths;
536 * Request list for chained requests, we're part of it.
538 struct smb_request **chain;
540 struct timeval request_time;
542 bool posix_pathnames;
546 * Info about an alternate data stream
549 struct stream_struct {
556 struct smb_file_time {
557 struct timespec mtime;
558 struct timespec atime;
559 struct timespec ctime;
560 struct timespec create_time;
566 struct smb_filename {
569 char *original_lcomp;
575 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
576 * to keep the numeric values consistent.
579 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
581 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
582 handle = handle->next; \
585 enum vfs_translate_direction {
586 vfs_translate_to_unix = 0,
587 vfs_translate_to_windows
590 enum vfs_fallocate_flags {
591 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
592 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
596 * @VFS_OFFLOAD_WRITE_FL_MUST_CLONE: indicates that offload_write_send_fn() copy must
597 * be handled as a COW clone, AKA reflink.
598 * @VFS_OFFLOAD_WRITE_FL_MASK_ALL: all valid flags.
600 enum vfs_offload_write_flags {
601 VFS_OFFLOAD_WRITE_FL_MUST_CLONE = 0x0001,
602 VFS_OFFLOAD_WRITE_FL_IGNORE_LOCKS = 0x0002,
604 VFS_OFFLOAD_WRITE_FL_MASK_ALL =
605 (VFS_OFFLOAD_WRITE_FL_MUST_CLONE
606 | VFS_OFFLOAD_WRITE_FL_IGNORE_LOCKS),
609 struct vfs_aio_state {
615 Available VFS operations. These values must be in sync with vfs_ops struct
616 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
617 In particular, if new operations are added to vfs_ops, appropriate constants
618 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
620 struct shadow_copy_data;
622 struct vfs_fn_pointers {
623 /* Disk operations */
625 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
626 void (*disconnect_fn)(struct vfs_handle_struct *handle);
627 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
628 const struct smb_filename *smb_fname,
632 int (*get_quota_fn)(struct vfs_handle_struct *handle,
633 const struct smb_filename *smb_fname,
634 enum SMB_QUOTA_TYPE qtype,
637 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
638 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
639 int (*statvfs_fn)(struct vfs_handle_struct *handle,
640 const struct smb_filename *smb_fname,
641 struct vfs_statvfs_struct *statbuf);
642 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
645 * Note: that "struct dfs_GetDFSReferral *r"
646 * needs to be a valid TALLOC_CTX
648 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
649 struct dfs_GetDFSReferral *r);
651 /* Directory operations */
653 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
654 const struct smb_filename *smb_fname,
656 uint32_t attributes);
657 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
658 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
660 SMB_STRUCT_STAT *sbuf);
661 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
662 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
663 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
664 int (*mkdir_fn)(struct vfs_handle_struct *handle,
665 const struct smb_filename *smb_fname,
667 int (*rmdir_fn)(struct vfs_handle_struct *handle,
668 const struct smb_filename *smb_fname);
669 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
670 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
672 /* File operations */
674 int (*open_fn)(struct vfs_handle_struct *handle,
675 struct smb_filename *smb_fname, files_struct *fsp,
676 int flags, mode_t mode);
677 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
678 struct smb_request *req,
679 uint16_t root_dir_fid,
680 struct smb_filename *smb_fname,
681 uint32_t access_mask,
682 uint32_t share_access,
683 uint32_t create_disposition,
684 uint32_t create_options,
685 uint32_t file_attributes,
686 uint32_t oplock_request,
687 struct smb2_lease *lease,
688 uint64_t allocation_size,
689 uint32_t private_flags,
690 struct security_descriptor *sd,
691 struct ea_list *ea_list,
692 files_struct **result,
694 const struct smb2_create_blobs *in_context_blobs,
695 struct smb2_create_blobs *out_context_blobs);
696 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
697 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
698 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
699 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
701 struct tevent_context *ev,
702 struct files_struct *fsp,
704 size_t n, off_t offset);
705 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
706 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
707 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
708 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
710 struct tevent_context *ev,
711 struct files_struct *fsp,
713 size_t n, off_t offset);
714 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
715 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
716 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
717 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
718 int (*rename_fn)(struct vfs_handle_struct *handle,
719 const struct smb_filename *smb_fname_src,
720 const struct smb_filename *smb_fname_dst);
721 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
722 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
724 struct tevent_context *ev,
725 struct files_struct *fsp);
726 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
727 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
728 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
729 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
730 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
731 int (*unlink_fn)(struct vfs_handle_struct *handle,
732 const struct smb_filename *smb_fname);
733 int (*chmod_fn)(struct vfs_handle_struct *handle,
734 const struct smb_filename *smb_fname,
736 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
737 int (*chown_fn)(struct vfs_handle_struct *handle,
738 const struct smb_filename *smb_fname,
741 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
742 int (*lchown_fn)(struct vfs_handle_struct *handle,
743 const struct smb_filename *smb_fname,
746 int (*chdir_fn)(struct vfs_handle_struct *handle,
747 const struct smb_filename *smb_fname);
748 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
749 TALLOC_CTX *mem_ctx);
750 int (*ntimes_fn)(struct vfs_handle_struct *handle,
751 const struct smb_filename *smb_fname,
752 struct smb_file_time *ft);
753 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
754 int (*fallocate_fn)(struct vfs_handle_struct *handle,
755 struct files_struct *fsp,
759 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
760 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
761 uint32_t share_mode, uint32_t access_mask);
762 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
763 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
764 int (*symlink_fn)(struct vfs_handle_struct *handle,
765 const char *link_contents,
766 const struct smb_filename *new_smb_fname);
767 int (*readlink_fn)(struct vfs_handle_struct *handle,
768 const struct smb_filename *smb_fname,
771 int (*link_fn)(struct vfs_handle_struct *handle,
772 const struct smb_filename *old_smb_fname,
773 const struct smb_filename *new_smb_fname);
774 int (*mknod_fn)(struct vfs_handle_struct *handle,
775 const struct smb_filename *smb_fname,
778 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
780 const struct smb_filename *smb_fname);
781 int (*chflags_fn)(struct vfs_handle_struct *handle,
782 const struct smb_filename *smb_fname,
784 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
785 const SMB_STRUCT_STAT *sbuf);
786 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
787 struct tevent_context *ev,
788 struct vfs_handle_struct *handle,
789 struct files_struct *fsp,
794 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
795 struct vfs_handle_struct *handle,
797 DATA_BLOB *token_blob);
798 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
800 struct tevent_context *ev,
803 off_t transfer_offset,
804 struct files_struct *dest_fsp,
808 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
809 struct tevent_req *req,
811 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
813 struct files_struct *fsp,
814 struct smb_filename *smb_fname,
815 uint16_t *_compression_fmt);
816 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
818 struct files_struct *fsp,
819 uint16_t compression_fmt);
820 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
822 const char *service_path,
824 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
826 const char *base_volume,
831 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
836 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
837 struct files_struct *fsp,
838 const struct smb_filename *smb_fname,
840 unsigned int *num_streams,
841 struct stream_struct **streams);
843 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
849 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
850 const struct smb_filename *smb_fname);
852 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
853 struct byte_range_lock *br_lck,
854 struct lock_struct *plock,
857 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
858 struct messaging_context *msg_ctx,
859 struct byte_range_lock *br_lck,
860 const struct lock_struct *plock);
862 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
863 struct byte_range_lock *br_lck,
864 struct lock_struct *plock);
866 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
867 struct files_struct *fsp,
868 struct lock_struct *plock);
870 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
871 struct files_struct *fsp,
872 struct lock_struct *plock);
874 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
876 enum vfs_translate_direction direction,
880 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
881 struct files_struct *fsp,
885 const uint8_t *_in_data,
888 uint32_t max_out_len,
891 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
892 struct smb_filename *smb_fname,
895 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
896 struct files_struct *fsp,
899 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
900 const struct smb_filename *smb_fname,
903 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
904 struct files_struct *fsp,
907 /* NT ACL operations. */
909 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
910 struct files_struct *fsp,
911 uint32_t security_info,
913 struct security_descriptor **ppdesc);
914 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
915 const struct smb_filename *smb_fname,
916 uint32_t security_info,
918 struct security_descriptor **ppdesc);
919 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
920 struct files_struct *fsp,
921 uint32_t security_info_sent,
922 const struct security_descriptor *psd);
924 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
925 struct smb_filename *file,
926 struct security_acl *sacl,
927 uint32_t access_requested,
928 uint32_t access_denied);
930 /* POSIX ACL operations. */
932 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
933 const struct smb_filename *smb_fname,
935 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
937 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
938 const struct smb_filename *smb_fname,
940 TALLOC_CTX *mem_ctx);
941 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
942 struct files_struct *fsp,
943 TALLOC_CTX *mem_ctx);
944 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
945 const struct smb_filename *smb_fname,
947 char **blob_description,
949 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
950 TALLOC_CTX *mem_ctx, char **blob_description,
952 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
953 const struct smb_filename *smb_fname,
954 SMB_ACL_TYPE_T acltype,
956 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
957 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
958 const struct smb_filename *smb_fname);
961 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
962 const struct smb_filename *smb_fname,
966 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
967 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
968 const struct smb_filename *smb_fname,
971 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
972 int (*removexattr_fn)(struct vfs_handle_struct *handle,
973 const struct smb_filename *smb_fname,
975 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
976 int (*setxattr_fn)(struct vfs_handle_struct *handle,
977 const struct smb_filename *smb_fname,
982 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
985 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
987 /* durable handle operations */
988 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
989 struct files_struct *fsp,
992 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
993 struct files_struct *fsp,
994 const DATA_BLOB old_cookie,
996 DATA_BLOB *new_cookie);
997 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
998 struct smb_request *smb1req,
999 struct smbXsrv_open *op,
1000 const DATA_BLOB old_cookie,
1001 TALLOC_CTX *mem_ctx,
1002 struct files_struct **fsp,
1003 DATA_BLOB *new_cookie);
1005 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
1006 const struct smb_filename *fname,
1007 TALLOC_CTX *mem_ctx,
1008 struct readdir_attr_data **attr_data);
1012 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1013 which describes all operations this module is willing to intercept.
1014 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1015 using this information.
1018 typedef struct vfs_handle_struct {
1019 struct vfs_handle_struct *next, *prev;
1021 struct connection_struct *conn;
1022 const struct vfs_fn_pointers *fns;
1024 void (*free_data)(void **data);
1025 } vfs_handle_struct;
1028 typedef struct vfs_statvfs_struct {
1029 /* For undefined recommended transfer size return -1 in that field */
1030 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1034 The next three fields are in terms of the block size.
1035 (above). If block size is unknown, 4096 would be a
1036 reasonable block size for a server to report.
1037 Note that returning the blocks/blocksavail removes need
1038 to make a second call (to QFSInfo level 0x103 to get this info.
1039 UserBlockAvail is typically less than or equal to BlocksAvail,
1040 if no distinction is made return the same value in each.
1043 uint64_t TotalBlocks;
1044 uint64_t BlocksAvail; /* bfree */
1045 uint64_t UserBlocksAvail; /* bavail */
1047 /* For undefined Node fields or FSID return -1 */
1048 uint64_t TotalFileNodes;
1049 uint64_t FreeFileNodes;
1050 uint64_t FsIdentifier; /* fsid */
1051 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1052 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1055 } vfs_statvfs_struct;
1057 /* Add a new FSP extension of the given type. Returns a pointer to the
1060 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1061 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1063 /* Return a pointer to the existing FSP extension data. */
1064 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1065 vfs_fetch_fsp_extension(handle, (fsp))
1067 /* Return the talloc context associated with an FSP extension. */
1068 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1069 vfs_memctx_fsp_extension(handle, (fsp))
1071 /* Remove and destroy an FSP extension. */
1072 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1073 vfs_remove_fsp_extension((handle), (fsp))
1075 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1076 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1077 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1082 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1084 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1087 if ((handle)->free_data) { \
1088 (handle)->free_data(&(handle)->data); \
1090 (handle)->data = (void *)datap; \
1091 (handle)->free_data = free_fn; \
1095 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1096 if ((handle) && (handle)->free_data) { \
1097 (handle)->free_data(&(handle)->data); \
1101 /* Check whether module-specific data handle was already allocated or not */
1102 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1104 #define SMB_VFS_OP(x) ((void *) x)
1106 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1108 #include "vfs_macros.h"
1110 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1111 const char *service, const char *user);
1112 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1113 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1114 const struct smb_filename *smb_filename,
1118 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1119 const struct smb_filename *smb_filename,
1120 enum SMB_QUOTA_TYPE qtype,
1122 SMB_DISK_QUOTA *qt);
1123 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1124 enum SMB_QUOTA_TYPE qtype, unid_t id,
1125 SMB_DISK_QUOTA *qt);
1126 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1127 struct files_struct *fsp,
1128 struct shadow_copy_data *shadow_copy_data,
1130 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1131 const struct smb_filename *smb_fname,
1132 struct vfs_statvfs_struct *statbuf);
1133 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1134 enum timestamp_set_resolution *p_ts_res);
1136 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1138 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1139 struct dfs_GetDFSReferral *r);
1140 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1141 const struct smb_filename *smb_fname,
1143 uint32_t attributes);
1144 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1145 struct files_struct *fsp,
1147 uint32_t attributes);
1148 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1150 SMB_STRUCT_STAT *sbuf);
1151 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1152 DIR *dirp, long offset);
1153 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1155 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1157 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1158 const struct smb_filename *smb_fname,
1160 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1161 const struct smb_filename *smb_fname);
1162 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1164 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1166 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1167 struct smb_filename *smb_fname, struct files_struct *fsp,
1168 int flags, mode_t mode);
1169 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1170 struct smb_request *req,
1171 uint16_t root_dir_fid,
1172 struct smb_filename *smb_fname,
1173 uint32_t access_mask,
1174 uint32_t share_access,
1175 uint32_t create_disposition,
1176 uint32_t create_options,
1177 uint32_t file_attributes,
1178 uint32_t oplock_request,
1179 struct smb2_lease *lease,
1180 uint64_t allocation_size,
1181 uint32_t private_flags,
1182 struct security_descriptor *sd,
1183 struct ea_list *ea_list,
1184 files_struct **result,
1186 const struct smb2_create_blobs *in_context_blobs,
1187 struct smb2_create_blobs *out_context_blobs);
1188 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1189 struct files_struct *fsp);
1190 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1191 struct files_struct *fsp, void *data, size_t n);
1192 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1193 struct files_struct *fsp, void *data, size_t n,
1195 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1196 TALLOC_CTX *mem_ctx,
1197 struct tevent_context *ev,
1198 struct files_struct *fsp,
1200 size_t n, off_t offset);
1201 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1203 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1204 struct files_struct *fsp, const void *data,
1206 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1207 struct files_struct *fsp, const void *data,
1208 size_t n, off_t offset);
1209 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1210 TALLOC_CTX *mem_ctx,
1211 struct tevent_context *ev,
1212 struct files_struct *fsp,
1214 size_t n, off_t offset);
1215 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1217 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1218 struct files_struct *fsp, off_t offset,
1220 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1221 files_struct *fromfsp, const DATA_BLOB *header,
1222 off_t offset, size_t count);
1223 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1224 files_struct *tofsp, off_t offset,
1226 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1227 const struct smb_filename *smb_fname_src,
1228 const struct smb_filename *smb_fname_dst);
1229 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1230 struct files_struct *fsp);
1232 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1233 TALLOC_CTX *mem_ctx,
1234 struct tevent_context *ev,
1235 struct files_struct *fsp);
1236 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1238 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1239 struct smb_filename *smb_fname);
1240 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1241 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1242 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1243 struct smb_filename *smb_filename);
1244 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1245 struct files_struct *fsp,
1246 const SMB_STRUCT_STAT *sbuf);
1247 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1248 const struct smb_filename *smb_fname);
1249 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1250 const struct smb_filename *smb_fname,
1252 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1253 struct files_struct *fsp, mode_t mode);
1254 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1255 const struct smb_filename *smb_fname,
1258 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1259 struct files_struct *fsp, uid_t uid, gid_t gid);
1260 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1261 const struct smb_filename *smb_fname,
1264 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1265 const struct smb_filename *smb_fname);
1266 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1268 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1269 const struct smb_filename *smb_fname,
1270 struct smb_file_time *ft);
1271 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1272 struct files_struct *fsp, off_t offset);
1273 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1274 struct files_struct *fsp,
1278 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1279 struct files_struct *fsp, int op, off_t offset,
1280 off_t count, int type);
1281 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1282 struct files_struct *fsp, uint32_t share_mode,
1283 uint32_t access_mask);
1284 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1285 struct files_struct *fsp, int leasetype);
1286 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1287 struct files_struct *fsp, off_t *poffset,
1288 off_t *pcount, int *ptype, pid_t *ppid);
1289 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1290 const char *link_contents,
1291 const struct smb_filename *new_smb_fname);
1292 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1293 const struct smb_filename *smb_fname,
1296 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1297 const struct smb_filename *old_smb_fname,
1298 const struct smb_filename *new_smb_fname);
1299 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1300 const struct smb_filename *smb_fname,
1303 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1305 const struct smb_filename *smb_fname);
1306 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1307 const struct smb_filename *smb_fname,
1308 unsigned int flags);
1309 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1310 const SMB_STRUCT_STAT *sbuf);
1311 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1312 struct files_struct *fsp,
1313 const struct smb_filename *smb_fname,
1314 TALLOC_CTX *mem_ctx,
1315 unsigned int *num_streams,
1316 struct stream_struct **streams);
1317 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1318 const char *path, const char *name,
1319 TALLOC_CTX *mem_ctx, char **found_name);
1320 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1321 const struct smb_filename *smb_fname);
1322 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1323 struct byte_range_lock *br_lck,
1324 struct lock_struct *plock,
1325 bool blocking_lock);
1326 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1327 struct messaging_context *msg_ctx,
1328 struct byte_range_lock *br_lck,
1329 const struct lock_struct *plock);
1330 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1331 struct byte_range_lock *br_lck,
1332 struct lock_struct *plock);
1333 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1334 struct files_struct *fsp,
1335 struct lock_struct *plock);
1336 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1337 struct files_struct *fsp,
1338 struct lock_struct *plock);
1339 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1341 enum vfs_translate_direction direction,
1342 TALLOC_CTX *mem_ctx,
1343 char **mapped_name);
1344 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1345 struct files_struct *fsp,
1349 const uint8_t *_in_data,
1351 uint8_t **_out_data,
1352 uint32_t max_out_len,
1354 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1355 struct smb_filename *smb_fname,
1357 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1358 struct files_struct *fsp,
1360 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1361 const struct smb_filename *smb_fname,
1363 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1364 struct files_struct *fsp,
1366 struct tevent_req *smb_vfs_call_offload_read_send(
1367 TALLOC_CTX *mem_ctx,
1368 struct tevent_context *ev,
1369 struct vfs_handle_struct *handle,
1370 struct files_struct *fsp,
1375 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1376 struct vfs_handle_struct *handle,
1377 TALLOC_CTX *mem_ctx,
1378 DATA_BLOB *token_blob);
1379 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1380 TALLOC_CTX *mem_ctx,
1381 struct tevent_context *ev,
1384 off_t transfer_offset,
1385 struct files_struct *dest_fsp,
1389 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1390 struct tevent_req *req,
1392 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1393 TALLOC_CTX *mem_ctx,
1394 struct files_struct *fsp,
1395 struct smb_filename *smb_fname,
1396 uint16_t *_compression_fmt);
1397 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1398 TALLOC_CTX *mem_ctx,
1399 struct files_struct *fsp,
1400 uint16_t compression_fmt);
1401 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1402 TALLOC_CTX *mem_ctx,
1403 const char *service_path,
1404 char **base_volume);
1405 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1406 TALLOC_CTX *mem_ctx,
1407 const char *base_volume,
1412 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1413 TALLOC_CTX *mem_ctx,
1416 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1417 struct files_struct *fsp,
1418 uint32_t security_info,
1419 TALLOC_CTX *mem_ctx,
1420 struct security_descriptor **ppdesc);
1421 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1422 const struct smb_filename *smb_fname,
1423 uint32_t security_info,
1424 TALLOC_CTX *mem_ctx,
1425 struct security_descriptor **ppdesc);
1426 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1427 struct files_struct *fsp,
1428 uint32_t security_info_sent,
1429 const struct security_descriptor *psd);
1430 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1431 struct smb_filename *file,
1432 struct security_acl *sacl,
1433 uint32_t access_requested,
1434 uint32_t access_denied);
1435 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1436 const struct smb_filename *file,
1438 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1439 struct files_struct *fsp, mode_t mode);
1440 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1441 const struct smb_filename *smb_fname,
1442 SMB_ACL_TYPE_T type,
1443 TALLOC_CTX *mem_ctx);
1444 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1445 struct files_struct *fsp,
1446 TALLOC_CTX *mem_ctx);
1447 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1448 const struct smb_filename *smb_fname,
1449 TALLOC_CTX *mem_ctx,
1450 char **blob_description,
1452 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1453 struct files_struct *fsp,
1454 TALLOC_CTX *mem_ctx,
1455 char **blob_description,
1457 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1458 const struct smb_filename *smb_fname,
1459 SMB_ACL_TYPE_T acltype,
1461 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1462 struct files_struct *fsp, SMB_ACL_T theacl);
1463 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1464 const struct smb_filename *smb_fname);
1465 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1466 const struct smb_filename *smb_fname,
1470 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1471 struct files_struct *fsp, const char *name,
1472 void *value, size_t size);
1473 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1474 const struct smb_filename *smb_fname,
1477 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1478 struct files_struct *fsp, char *list,
1480 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1481 const struct smb_filename *smb_fname,
1483 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1484 struct files_struct *fsp, const char *name);
1485 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1486 const struct smb_filename *smb_fname,
1491 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1492 const char *name, const void *value, size_t size,
1494 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1495 struct files_struct *fsp, const char *name,
1496 const void *value, size_t size, int flags);
1497 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1498 struct files_struct *fsp);
1499 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1500 const struct smb_filename *fname,
1501 SMB_STRUCT_STAT *sbuf);
1502 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1503 const struct smb_filename *fname);
1504 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1505 struct files_struct *fsp,
1506 TALLOC_CTX *mem_ctx,
1508 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1509 struct files_struct *fsp,
1510 const DATA_BLOB old_cookie,
1511 TALLOC_CTX *mem_ctx,
1512 DATA_BLOB *new_cookie);
1513 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1514 struct smb_request *smb1req,
1515 struct smbXsrv_open *op,
1516 const DATA_BLOB old_cookie,
1517 TALLOC_CTX *mem_ctx,
1518 struct files_struct **fsp,
1519 DATA_BLOB *new_cookie);
1520 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1521 const struct smb_filename *fname,
1522 TALLOC_CTX *mem_ctx,
1523 struct readdir_attr_data **attr_data);
1525 NTSTATUS smb_register_vfs(int version, const char *name,
1526 const struct vfs_fn_pointers *fns);
1527 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1528 files_struct *fsp, size_t ext_size,
1529 void (*destroy_fn)(void *p_data));
1530 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1531 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1532 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1533 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1535 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1536 const char *module);