2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
29 /* Avoid conflict with an AIX include file */
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
45 * If you change anything here, please also update modules/vfs_full_audit.c.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205 to const struct smb_filename * */
206 /* Version 37 - Change sys_acl_set_file from const char *
207 to const struct smb_filename * */
208 /* Version 37 - Change listxattr from const char *
209 to const struct smb_filename * */
210 /* Version 37 - Change removexattr from const char *
211 to const struct smb_filename * */
212 /* Version 37 - Change setxattr from const char *
213 to const struct smb_filename * */
214 /* Version 37 - Change getxattr from const char *
215 to const struct smb_filename * */
216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
217 /* Version 37 - Change chflags from const char *
218 to const struct smb_filename * */
219 /* Version 37 - Change disk_free from const char *
220 to const struct smb_filename * */
221 /* Version 37 - Change get_quota from const char *
222 to const struct smb_filename * */
223 /* Version 37 - Change link from const char *
224 to const struct smb_filename * */
225 /* Version 37 - Change statvfs from const char *
226 to const struct smb_filename * */
227 /* Version 37 - Change readlink from const char *
228 to const struct smb_filename * */
229 /* Version 37 - Change symlink from const char *
230 to const struct smb_filename * */
231 /* Version 37 - Change chdir from const char *
232 to const struct smb_filename * */
233 /* Version 37 - Change getwd from char *
234 to const struct smb_filename * */
235 /* Version 37 - Change conn->cwd from char *
236 to struct smb_filename * */
237 /* Version 37 - Change realpath from char *
238 to struct smb_filename * */
239 /* Version 37 - Change connectpath from char *
240 to struct smb_filename * */
241 /* Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND/RECV */
242 /* Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND/RECV to
243 SMB_VFS_OFFLOAD_READ_SEND/RECV */
244 /* Version 37 - Remove SMB_VFS_STRICT_UNLOCK */
245 /* Version 37 - Rename SMB_VFS_STRICT_LOCK to
246 SMB_VFS_STRICT_LOCK_CHECK */
247 /* Version 38 - Remove SMB_VFS_INIT_SEARCH_OP */
248 /* Version 39 - Remove SMB_VFS_FSYNC
249 Only implement async versions. */
250 /* Version 39 - Remove SMB_VFS_READ
251 All users are now pread or async versions. */
252 /* Version 39 - Remove SMB_VFS_WRITE
253 All users are now pwrite or async versions. */
254 /* Version 39 - Remove SMB_VFS_CHMOD_ACL - no longer used. */
255 /* Version 39 - Remove SMB_VFS_FCHMOD_ACL - no longer used. */
256 /* Version 39 - Remove struct dfree_cached_info pointer from
259 #define SMB_VFS_INTERFACE_VERSION 39
262 All intercepted VFS operations must be declared as static functions inside module source
263 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
264 example VFS modules for more details.
267 /* VFS operations structure */
269 struct vfs_handle_struct;
270 struct connection_struct;
272 struct security_descriptor;
273 struct vfs_statvfs_struct;
276 struct smb_file_time;
277 struct blocking_lock_record;
279 struct dfs_GetDFSReferral;
281 typedef union unid_t {
289 uint64_t position_information;
291 uint32_t private_options; /* NT Create options, but we only look at
292 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
293 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
294 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
295 * for print files *only*, where
296 * DELETE_ON_CLOSE is not stored in the share
299 unsigned long gen_id;
304 struct smbd_server_connection *sconn;
305 struct tevent_timer *timeout;
306 struct smb2_lease lease;
309 typedef struct files_struct {
310 struct files_struct *next, *prev;
312 struct smbXsrv_open *op;
313 struct connection_struct *conn;
314 struct fd_handle *fh;
315 unsigned int num_smb_operations;
316 struct file_id file_id;
317 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
319 uint64_t vuid; /* SMB2 compat */
320 struct write_cache *wcp;
321 struct timeval open_time;
322 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
323 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
325 bool kernel_share_modes_taken;
327 bool update_write_time_triggered;
328 struct tevent_timer *update_write_time_event;
329 bool update_write_time_on_close;
330 struct timespec close_write_time;
331 bool write_time_forced;
334 struct fsp_lease *lease;
335 int sent_oplock_break;
336 struct tevent_timer *oplock_timeout;
337 struct lock_struct last_lock_failure;
338 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
345 bool aio_write_behind;
346 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
347 bool delete_on_close;
348 uint64_t posix_flags;
350 bool backup_intent; /* Handle was successfully opened with backup intent
351 and opener has privilege to do so. */
352 bool use_ofd_locks; /* Are we using open file description locks ? */
353 struct smb_filename *fsp_name;
354 uint32_t name_hash; /* Jenkins hash of full pathname. */
355 uint64_t mid; /* Mid of the operation that created us. */
357 struct vfs_fsp_data *vfs_extension;
358 struct fake_file_handle *fake_file_handle;
360 struct notify_change_buf *notify;
362 struct files_struct *base_fsp; /* placeholder for delete on close */
365 * Read-only cached brlock record, thrown away when the
366 * brlock.tdb seqnum changes. This avoids fetching data from
367 * the brlock.tdb on every read/write call.
370 struct byte_range_lock *brlock_rec;
372 struct dptr_struct *dptr;
374 /* if not NULL, means this is a print file */
375 struct print_file_data *print_file;
377 unsigned num_aio_requests;
378 struct tevent_req **aio_requests;
381 * If a close request comes in while we still have aio_requests
382 * around, we need to hold back the close. When all aio_requests are
383 * done, the aio completion routines need tevent_wait_done() on
384 * this. A bit ugly, but before we have close_file() fully async
385 * possibly the simplest approach. Thanks, Jeremy for the idea.
387 struct tevent_req *deferred_close;
390 #define FSP_POSIX_FLAGS_OPEN 0x01
391 #define FSP_POSIX_FLAGS_RENAME 0x02
392 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
394 #define FSP_POSIX_FLAGS_ALL \
395 (FSP_POSIX_FLAGS_OPEN | \
396 FSP_POSIX_FLAGS_PATHNAMES | \
397 FSP_POSIX_FLAGS_RENAME)
399 struct vuid_cache_entry {
400 struct auth_session_info *session_info;
401 uint64_t vuid; /* SMB2 compat */
403 uint32_t share_access;
407 unsigned int next_entry;
408 struct vuid_cache_entry array[VUID_CACHE_SIZE];
414 } name_compare_entry;
416 struct share_params {
420 typedef struct connection_struct {
421 struct connection_struct *next, *prev;
422 struct smbd_server_connection *sconn; /* can be NULL */
423 struct smbXsrv_tcon *tcon; /* can be NULL */
424 uint32_t cnum; /* an index passed over the wire */
425 struct share_params *params;
427 struct vuid_cache *vuid_cache;
430 bool read_only; /* Attributes for the current user of the share. */
431 uint32_t share_access;
432 /* Does this filesystem honor
433 sub second timestamps on files
434 and directories when setting time ? */
435 enum timestamp_set_resolution ts_res;
438 struct smb_filename *cwd_fname; /* Working directory. */
440 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
443 * This represents the user information on this connection. Depending
444 * on the vuid using this tid, this might change per SMB request.
446 struct auth_session_info *session_info;
449 * If the "force group" parameter is set, this is the primary gid that
450 * may be used in the users token, depending on the vuid using this tid.
452 gid_t force_group_gid;
454 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
457 time_t lastused_count;
459 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
463 /* Semantics requested by the client or forced by the server config. */
466 bool short_case_preserve;
468 /* Semantics provided by the underlying filesystem. */
470 /* Device number of the directory of the share mount.
471 Used to ensure unique FileIndex returns. */
472 SMB_DEV_T base_share_dev;
474 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
475 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
476 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
477 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
478 struct trans_state *pending_trans;
480 struct rpc_pipe_client *spoolss_pipe;
484 struct smbd_smb2_request;
485 struct privilege_paths;
491 uint64_t mid; /* For compatibility with SMB2. */
493 uint64_t vuid; /* For compatibility with SMB2. */
499 const uint8_t *inbuf;
502 * Async handling in the main smb processing loop is directed by
503 * outbuf: reply_xxx routines indicate sync behaviour by putting their
504 * reply into "outbuf". If they leave it as NULL, they take care of it
505 * themselves, possibly later.
507 * If async handling is wanted, the reply_xxx routine must make sure
508 * that it talloc_move()s the smb_req somewhere else.
514 connection_struct *conn;
515 struct smbd_server_connection *sconn;
516 struct smbXsrv_connection *xconn;
517 struct smb_perfcount_data pcd;
520 * Chained request handling
522 struct files_struct *chain_fsp;
525 * state information for async smb handling
530 * Back pointer to smb2 request.
532 struct smbd_smb2_request *smb2req;
535 * Pathnames used if request done
538 struct privilege_paths *priv_paths;
541 * Request list for chained requests, we're part of it.
543 struct smb_request **chain;
545 struct timeval request_time;
547 bool posix_pathnames;
551 * Info about an alternate data stream
554 struct stream_struct {
561 struct smb_file_time {
562 struct timespec mtime;
563 struct timespec atime;
564 struct timespec ctime;
565 struct timespec create_time;
571 struct smb_filename {
574 char *original_lcomp;
580 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
581 * to keep the numeric values consistent.
584 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
586 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
587 handle = handle->next; \
590 enum vfs_translate_direction {
591 vfs_translate_to_unix = 0,
592 vfs_translate_to_windows
595 enum vfs_fallocate_flags {
596 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
597 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
600 struct vfs_aio_state {
606 Available VFS operations. These values must be in sync with vfs_ops struct
607 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
608 In particular, if new operations are added to vfs_ops, appropriate constants
609 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
611 struct shadow_copy_data;
613 struct vfs_fn_pointers {
614 /* Disk operations */
616 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
617 void (*disconnect_fn)(struct vfs_handle_struct *handle);
618 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
619 const struct smb_filename *smb_fname,
623 int (*get_quota_fn)(struct vfs_handle_struct *handle,
624 const struct smb_filename *smb_fname,
625 enum SMB_QUOTA_TYPE qtype,
628 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
629 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
630 int (*statvfs_fn)(struct vfs_handle_struct *handle,
631 const struct smb_filename *smb_fname,
632 struct vfs_statvfs_struct *statbuf);
633 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
636 * Note: that "struct dfs_GetDFSReferral *r"
637 * needs to be a valid TALLOC_CTX
639 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
640 struct dfs_GetDFSReferral *r);
642 /* Directory operations */
644 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
645 const struct smb_filename *smb_fname,
647 uint32_t attributes);
648 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
649 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
651 SMB_STRUCT_STAT *sbuf);
652 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
653 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
654 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
655 int (*mkdir_fn)(struct vfs_handle_struct *handle,
656 const struct smb_filename *smb_fname,
658 int (*rmdir_fn)(struct vfs_handle_struct *handle,
659 const struct smb_filename *smb_fname);
660 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
662 /* File operations */
664 int (*open_fn)(struct vfs_handle_struct *handle,
665 struct smb_filename *smb_fname, files_struct *fsp,
666 int flags, mode_t mode);
667 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
668 struct smb_request *req,
669 uint16_t root_dir_fid,
670 struct smb_filename *smb_fname,
671 uint32_t access_mask,
672 uint32_t share_access,
673 uint32_t create_disposition,
674 uint32_t create_options,
675 uint32_t file_attributes,
676 uint32_t oplock_request,
677 struct smb2_lease *lease,
678 uint64_t allocation_size,
679 uint32_t private_flags,
680 struct security_descriptor *sd,
681 struct ea_list *ea_list,
682 files_struct **result,
684 const struct smb2_create_blobs *in_context_blobs,
685 struct smb2_create_blobs *out_context_blobs);
686 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
687 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
688 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
690 struct tevent_context *ev,
691 struct files_struct *fsp,
693 size_t n, off_t offset);
694 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
695 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
696 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
698 struct tevent_context *ev,
699 struct files_struct *fsp,
701 size_t n, off_t offset);
702 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
703 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
704 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
705 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
706 int (*rename_fn)(struct vfs_handle_struct *handle,
707 const struct smb_filename *smb_fname_src,
708 const struct smb_filename *smb_fname_dst);
709 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
711 struct tevent_context *ev,
712 struct files_struct *fsp);
713 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
714 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
715 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
716 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
717 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
718 int (*unlink_fn)(struct vfs_handle_struct *handle,
719 const struct smb_filename *smb_fname);
720 int (*chmod_fn)(struct vfs_handle_struct *handle,
721 const struct smb_filename *smb_fname,
723 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
724 int (*chown_fn)(struct vfs_handle_struct *handle,
725 const struct smb_filename *smb_fname,
728 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
729 int (*lchown_fn)(struct vfs_handle_struct *handle,
730 const struct smb_filename *smb_fname,
733 int (*chdir_fn)(struct vfs_handle_struct *handle,
734 const struct smb_filename *smb_fname);
735 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
736 TALLOC_CTX *mem_ctx);
737 int (*ntimes_fn)(struct vfs_handle_struct *handle,
738 const struct smb_filename *smb_fname,
739 struct smb_file_time *ft);
740 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
741 int (*fallocate_fn)(struct vfs_handle_struct *handle,
742 struct files_struct *fsp,
746 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
747 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
748 uint32_t share_mode, uint32_t access_mask);
749 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
750 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
751 int (*symlink_fn)(struct vfs_handle_struct *handle,
752 const char *link_contents,
753 const struct smb_filename *new_smb_fname);
754 int (*readlink_fn)(struct vfs_handle_struct *handle,
755 const struct smb_filename *smb_fname,
758 int (*link_fn)(struct vfs_handle_struct *handle,
759 const struct smb_filename *old_smb_fname,
760 const struct smb_filename *new_smb_fname);
761 int (*mknod_fn)(struct vfs_handle_struct *handle,
762 const struct smb_filename *smb_fname,
765 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
767 const struct smb_filename *smb_fname);
768 int (*chflags_fn)(struct vfs_handle_struct *handle,
769 const struct smb_filename *smb_fname,
771 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
772 const SMB_STRUCT_STAT *sbuf);
773 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
774 struct tevent_context *ev,
775 struct vfs_handle_struct *handle,
776 struct files_struct *fsp,
781 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
782 struct vfs_handle_struct *handle,
784 DATA_BLOB *token_blob);
785 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
787 struct tevent_context *ev,
790 off_t transfer_offset,
791 struct files_struct *dest_fsp,
794 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
795 struct tevent_req *req,
797 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
799 struct files_struct *fsp,
800 struct smb_filename *smb_fname,
801 uint16_t *_compression_fmt);
802 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 uint16_t compression_fmt);
806 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
808 const char *service_path,
810 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
812 const char *base_volume,
817 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
822 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
823 struct files_struct *fsp,
824 const struct smb_filename *smb_fname,
826 unsigned int *num_streams,
827 struct stream_struct **streams);
829 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
835 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
836 const struct smb_filename *smb_fname);
838 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
839 struct byte_range_lock *br_lck,
840 struct lock_struct *plock,
843 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
844 struct messaging_context *msg_ctx,
845 struct byte_range_lock *br_lck,
846 const struct lock_struct *plock);
848 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
849 struct byte_range_lock *br_lck,
850 struct lock_struct *plock);
852 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
853 struct files_struct *fsp,
854 struct lock_struct *plock);
856 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
858 enum vfs_translate_direction direction,
862 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
863 struct files_struct *fsp,
867 const uint8_t *_in_data,
870 uint32_t max_out_len,
873 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
874 struct smb_filename *smb_fname,
877 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
878 struct files_struct *fsp,
881 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
882 const struct smb_filename *smb_fname,
885 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
886 struct files_struct *fsp,
889 /* NT ACL operations. */
891 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
892 struct files_struct *fsp,
893 uint32_t security_info,
895 struct security_descriptor **ppdesc);
896 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
897 const struct smb_filename *smb_fname,
898 uint32_t security_info,
900 struct security_descriptor **ppdesc);
901 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
902 struct files_struct *fsp,
903 uint32_t security_info_sent,
904 const struct security_descriptor *psd);
906 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
907 struct smb_filename *file,
908 struct security_acl *sacl,
909 uint32_t access_requested,
910 uint32_t access_denied);
912 /* POSIX ACL operations. */
914 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
915 const struct smb_filename *smb_fname,
917 TALLOC_CTX *mem_ctx);
918 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
919 struct files_struct *fsp,
920 TALLOC_CTX *mem_ctx);
921 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
922 const struct smb_filename *smb_fname,
924 char **blob_description,
926 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
927 TALLOC_CTX *mem_ctx, char **blob_description,
929 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
930 const struct smb_filename *smb_fname,
931 SMB_ACL_TYPE_T acltype,
933 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
934 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
935 const struct smb_filename *smb_fname);
938 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
939 const struct smb_filename *smb_fname,
943 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
944 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
945 const struct smb_filename *smb_fname,
948 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
949 int (*removexattr_fn)(struct vfs_handle_struct *handle,
950 const struct smb_filename *smb_fname,
952 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
953 int (*setxattr_fn)(struct vfs_handle_struct *handle,
954 const struct smb_filename *smb_fname,
959 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
962 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
964 /* durable handle operations */
965 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
966 struct files_struct *fsp,
969 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
970 struct files_struct *fsp,
971 const DATA_BLOB old_cookie,
973 DATA_BLOB *new_cookie);
974 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
975 struct smb_request *smb1req,
976 struct smbXsrv_open *op,
977 const DATA_BLOB old_cookie,
979 struct files_struct **fsp,
980 DATA_BLOB *new_cookie);
982 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
983 const struct smb_filename *fname,
985 struct readdir_attr_data **attr_data);
989 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
990 which describes all operations this module is willing to intercept.
991 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
992 using this information.
995 typedef struct vfs_handle_struct {
996 struct vfs_handle_struct *next, *prev;
998 struct connection_struct *conn;
999 const struct vfs_fn_pointers *fns;
1001 void (*free_data)(void **data);
1002 } vfs_handle_struct;
1005 typedef struct vfs_statvfs_struct {
1006 /* For undefined recommended transfer size return -1 in that field */
1007 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1011 The next three fields are in terms of the block size.
1012 (above). If block size is unknown, 4096 would be a
1013 reasonable block size for a server to report.
1014 Note that returning the blocks/blocksavail removes need
1015 to make a second call (to QFSInfo level 0x103 to get this info.
1016 UserBlockAvail is typically less than or equal to BlocksAvail,
1017 if no distinction is made return the same value in each.
1020 uint64_t TotalBlocks;
1021 uint64_t BlocksAvail; /* bfree */
1022 uint64_t UserBlocksAvail; /* bavail */
1024 /* For undefined Node fields or FSID return -1 */
1025 uint64_t TotalFileNodes;
1026 uint64_t FreeFileNodes;
1027 uint64_t FsIdentifier; /* fsid */
1028 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1029 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1032 } vfs_statvfs_struct;
1034 /* Add a new FSP extension of the given type. Returns a pointer to the
1037 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1038 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1040 /* Return a pointer to the existing FSP extension data. */
1041 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1042 vfs_fetch_fsp_extension(handle, (fsp))
1044 /* Return the talloc context associated with an FSP extension. */
1045 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1046 vfs_memctx_fsp_extension(handle, (fsp))
1048 /* Remove and destroy an FSP extension. */
1049 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1050 vfs_remove_fsp_extension((handle), (fsp))
1052 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1053 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1054 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1059 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1061 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1064 if ((handle)->free_data) { \
1065 (handle)->free_data(&(handle)->data); \
1067 (handle)->data = (void *)datap; \
1068 (handle)->free_data = free_fn; \
1072 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1073 if ((handle) && (handle)->free_data) { \
1074 (handle)->free_data(&(handle)->data); \
1078 /* Check whether module-specific data handle was already allocated or not */
1079 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1081 #define SMB_VFS_OP(x) ((void *) x)
1083 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1085 #include "vfs_macros.h"
1087 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1088 const char *service, const char *user);
1089 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1090 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1091 const struct smb_filename *smb_filename,
1095 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1096 const struct smb_filename *smb_filename,
1097 enum SMB_QUOTA_TYPE qtype,
1099 SMB_DISK_QUOTA *qt);
1100 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1101 enum SMB_QUOTA_TYPE qtype, unid_t id,
1102 SMB_DISK_QUOTA *qt);
1103 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1104 struct files_struct *fsp,
1105 struct shadow_copy_data *shadow_copy_data,
1107 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1108 const struct smb_filename *smb_fname,
1109 struct vfs_statvfs_struct *statbuf);
1110 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1111 enum timestamp_set_resolution *p_ts_res);
1113 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1115 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1116 struct dfs_GetDFSReferral *r);
1117 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1118 const struct smb_filename *smb_fname,
1120 uint32_t attributes);
1121 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1122 struct files_struct *fsp,
1124 uint32_t attributes);
1125 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1127 SMB_STRUCT_STAT *sbuf);
1128 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1129 DIR *dirp, long offset);
1130 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1132 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1134 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1135 const struct smb_filename *smb_fname,
1137 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1138 const struct smb_filename *smb_fname);
1139 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1141 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1142 struct smb_filename *smb_fname, struct files_struct *fsp,
1143 int flags, mode_t mode);
1144 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1145 struct smb_request *req,
1146 uint16_t root_dir_fid,
1147 struct smb_filename *smb_fname,
1148 uint32_t access_mask,
1149 uint32_t share_access,
1150 uint32_t create_disposition,
1151 uint32_t create_options,
1152 uint32_t file_attributes,
1153 uint32_t oplock_request,
1154 struct smb2_lease *lease,
1155 uint64_t allocation_size,
1156 uint32_t private_flags,
1157 struct security_descriptor *sd,
1158 struct ea_list *ea_list,
1159 files_struct **result,
1161 const struct smb2_create_blobs *in_context_blobs,
1162 struct smb2_create_blobs *out_context_blobs);
1163 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1164 struct files_struct *fsp);
1165 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1166 struct files_struct *fsp, void *data, size_t n,
1168 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1169 TALLOC_CTX *mem_ctx,
1170 struct tevent_context *ev,
1171 struct files_struct *fsp,
1173 size_t n, off_t offset);
1174 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1176 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1177 struct files_struct *fsp, const void *data,
1178 size_t n, off_t offset);
1179 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1180 TALLOC_CTX *mem_ctx,
1181 struct tevent_context *ev,
1182 struct files_struct *fsp,
1184 size_t n, off_t offset);
1185 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1187 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1188 struct files_struct *fsp, off_t offset,
1190 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1191 files_struct *fromfsp, const DATA_BLOB *header,
1192 off_t offset, size_t count);
1193 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1194 files_struct *tofsp, off_t offset,
1196 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1197 const struct smb_filename *smb_fname_src,
1198 const struct smb_filename *smb_fname_dst);
1200 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1201 TALLOC_CTX *mem_ctx,
1202 struct tevent_context *ev,
1203 struct files_struct *fsp);
1204 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1206 int smb_vfs_fsync_sync(files_struct *fsp);
1207 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1208 struct smb_filename *smb_fname);
1209 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1210 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1211 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1212 struct smb_filename *smb_filename);
1213 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1214 struct files_struct *fsp,
1215 const SMB_STRUCT_STAT *sbuf);
1216 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1217 const struct smb_filename *smb_fname);
1218 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1219 const struct smb_filename *smb_fname,
1221 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1222 struct files_struct *fsp, mode_t mode);
1223 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1224 const struct smb_filename *smb_fname,
1227 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1228 struct files_struct *fsp, uid_t uid, gid_t gid);
1229 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1230 const struct smb_filename *smb_fname,
1233 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1234 const struct smb_filename *smb_fname);
1235 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1237 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1238 const struct smb_filename *smb_fname,
1239 struct smb_file_time *ft);
1240 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1241 struct files_struct *fsp, off_t offset);
1242 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1243 struct files_struct *fsp,
1247 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1248 struct files_struct *fsp, int op, off_t offset,
1249 off_t count, int type);
1250 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1251 struct files_struct *fsp, uint32_t share_mode,
1252 uint32_t access_mask);
1253 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1254 struct files_struct *fsp, int leasetype);
1255 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1256 struct files_struct *fsp, off_t *poffset,
1257 off_t *pcount, int *ptype, pid_t *ppid);
1258 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1259 const char *link_contents,
1260 const struct smb_filename *new_smb_fname);
1261 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1262 const struct smb_filename *smb_fname,
1265 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1266 const struct smb_filename *old_smb_fname,
1267 const struct smb_filename *new_smb_fname);
1268 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1269 const struct smb_filename *smb_fname,
1272 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1274 const struct smb_filename *smb_fname);
1275 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1276 const struct smb_filename *smb_fname,
1277 unsigned int flags);
1278 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1279 const SMB_STRUCT_STAT *sbuf);
1280 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1281 struct files_struct *fsp,
1282 const struct smb_filename *smb_fname,
1283 TALLOC_CTX *mem_ctx,
1284 unsigned int *num_streams,
1285 struct stream_struct **streams);
1286 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1287 const char *path, const char *name,
1288 TALLOC_CTX *mem_ctx, char **found_name);
1289 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1290 const struct smb_filename *smb_fname);
1291 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1292 struct byte_range_lock *br_lck,
1293 struct lock_struct *plock,
1294 bool blocking_lock);
1295 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1296 struct messaging_context *msg_ctx,
1297 struct byte_range_lock *br_lck,
1298 const struct lock_struct *plock);
1299 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1300 struct byte_range_lock *br_lck,
1301 struct lock_struct *plock);
1302 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1303 struct files_struct *fsp,
1304 struct lock_struct *plock);
1305 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1307 enum vfs_translate_direction direction,
1308 TALLOC_CTX *mem_ctx,
1309 char **mapped_name);
1310 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1311 struct files_struct *fsp,
1315 const uint8_t *_in_data,
1317 uint8_t **_out_data,
1318 uint32_t max_out_len,
1320 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1321 struct smb_filename *smb_fname,
1323 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1324 struct files_struct *fsp,
1326 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1327 const struct smb_filename *smb_fname,
1329 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1330 struct files_struct *fsp,
1332 struct tevent_req *smb_vfs_call_offload_read_send(
1333 TALLOC_CTX *mem_ctx,
1334 struct tevent_context *ev,
1335 struct vfs_handle_struct *handle,
1336 struct files_struct *fsp,
1341 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1342 struct vfs_handle_struct *handle,
1343 TALLOC_CTX *mem_ctx,
1344 DATA_BLOB *token_blob);
1345 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1346 TALLOC_CTX *mem_ctx,
1347 struct tevent_context *ev,
1350 off_t transfer_offset,
1351 struct files_struct *dest_fsp,
1354 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1355 struct tevent_req *req,
1357 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1358 TALLOC_CTX *mem_ctx,
1359 struct files_struct *fsp,
1360 struct smb_filename *smb_fname,
1361 uint16_t *_compression_fmt);
1362 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1363 TALLOC_CTX *mem_ctx,
1364 struct files_struct *fsp,
1365 uint16_t compression_fmt);
1366 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1367 TALLOC_CTX *mem_ctx,
1368 const char *service_path,
1369 char **base_volume);
1370 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1371 TALLOC_CTX *mem_ctx,
1372 const char *base_volume,
1377 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1378 TALLOC_CTX *mem_ctx,
1381 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1382 struct files_struct *fsp,
1383 uint32_t security_info,
1384 TALLOC_CTX *mem_ctx,
1385 struct security_descriptor **ppdesc);
1386 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1387 const struct smb_filename *smb_fname,
1388 uint32_t security_info,
1389 TALLOC_CTX *mem_ctx,
1390 struct security_descriptor **ppdesc);
1391 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1392 struct files_struct *fsp,
1393 uint32_t security_info_sent,
1394 const struct security_descriptor *psd);
1395 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1396 struct smb_filename *file,
1397 struct security_acl *sacl,
1398 uint32_t access_requested,
1399 uint32_t access_denied);
1400 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1401 const struct smb_filename *file,
1403 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1404 const struct smb_filename *smb_fname,
1405 SMB_ACL_TYPE_T type,
1406 TALLOC_CTX *mem_ctx);
1407 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1408 struct files_struct *fsp,
1409 TALLOC_CTX *mem_ctx);
1410 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1411 const struct smb_filename *smb_fname,
1412 TALLOC_CTX *mem_ctx,
1413 char **blob_description,
1415 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1416 struct files_struct *fsp,
1417 TALLOC_CTX *mem_ctx,
1418 char **blob_description,
1420 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1421 const struct smb_filename *smb_fname,
1422 SMB_ACL_TYPE_T acltype,
1424 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1425 struct files_struct *fsp, SMB_ACL_T theacl);
1426 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1427 const struct smb_filename *smb_fname);
1428 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1429 const struct smb_filename *smb_fname,
1433 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1434 struct files_struct *fsp, const char *name,
1435 void *value, size_t size);
1436 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1437 const struct smb_filename *smb_fname,
1440 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1441 struct files_struct *fsp, char *list,
1443 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1444 const struct smb_filename *smb_fname,
1446 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1447 struct files_struct *fsp, const char *name);
1448 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1449 const struct smb_filename *smb_fname,
1454 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1455 const char *name, const void *value, size_t size,
1457 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1458 struct files_struct *fsp, const char *name,
1459 const void *value, size_t size, int flags);
1460 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1461 struct files_struct *fsp);
1462 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1463 struct files_struct *fsp,
1464 TALLOC_CTX *mem_ctx,
1466 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1467 struct files_struct *fsp,
1468 const DATA_BLOB old_cookie,
1469 TALLOC_CTX *mem_ctx,
1470 DATA_BLOB *new_cookie);
1471 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1472 struct smb_request *smb1req,
1473 struct smbXsrv_open *op,
1474 const DATA_BLOB old_cookie,
1475 TALLOC_CTX *mem_ctx,
1476 struct files_struct **fsp,
1477 DATA_BLOB *new_cookie);
1478 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1479 const struct smb_filename *fname,
1480 TALLOC_CTX *mem_ctx,
1481 struct readdir_attr_data **attr_data);
1483 NTSTATUS smb_register_vfs(int version, const char *name,
1484 const struct vfs_fn_pointers *fns);
1485 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1486 files_struct *fsp, size_t ext_size,
1487 void (*destroy_fn)(void *p_data));
1488 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1489 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1490 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1491 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1493 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1494 const char *module);