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 * */
209 #define SMB_VFS_INTERFACE_VERSION 37
212 All intercepted VFS operations must be declared as static functions inside module source
213 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
214 example VFS modules for more details.
217 /* VFS operations structure */
219 struct vfs_handle_struct;
220 struct connection_struct;
222 struct security_descriptor;
223 struct vfs_statvfs_struct;
226 struct smb_file_time;
227 struct blocking_lock_record;
229 struct dfs_GetDFSReferral;
231 typedef union unid_t {
239 uint64_t position_information;
241 uint32_t private_options; /* NT Create options, but we only look at
242 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
243 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
244 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
245 * for print files *only*, where
246 * DELETE_ON_CLOSE is not stored in the share
249 unsigned long gen_id;
254 struct smbd_server_connection *sconn;
255 struct tevent_timer *timeout;
256 struct smb2_lease lease;
259 typedef struct files_struct {
260 struct files_struct *next, *prev;
262 struct smbXsrv_open *op;
263 struct connection_struct *conn;
264 struct fd_handle *fh;
265 unsigned int num_smb_operations;
266 struct file_id file_id;
267 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
269 uint64_t vuid; /* SMB2 compat */
270 struct write_cache *wcp;
271 struct timeval open_time;
272 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
273 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
275 bool kernel_share_modes_taken;
277 bool update_write_time_triggered;
278 struct tevent_timer *update_write_time_event;
279 bool update_write_time_on_close;
280 struct timespec close_write_time;
281 bool write_time_forced;
284 struct fsp_lease *lease;
285 int sent_oplock_break;
286 struct tevent_timer *oplock_timeout;
287 struct lock_struct last_lock_failure;
288 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
295 bool aio_write_behind;
296 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
297 bool delete_on_close;
298 uint64_t posix_flags;
300 bool backup_intent; /* Handle was successfully opened with backup intent
301 and opener has privilege to do so. */
302 bool aapl_copyfile_supported;
303 bool use_ofd_locks; /* Are we using open file description locks ? */
304 struct smb_filename *fsp_name;
305 uint32_t name_hash; /* Jenkins hash of full pathname. */
306 uint64_t mid; /* Mid of the operation that created us. */
308 struct vfs_fsp_data *vfs_extension;
309 struct fake_file_handle *fake_file_handle;
311 struct notify_change_buf *notify;
313 struct files_struct *base_fsp; /* placeholder for delete on close */
316 * Read-only cached brlock record, thrown away when the
317 * brlock.tdb seqnum changes. This avoids fetching data from
318 * the brlock.tdb on every read/write call.
321 struct byte_range_lock *brlock_rec;
323 struct dptr_struct *dptr;
325 /* if not NULL, means this is a print file */
326 struct print_file_data *print_file;
328 unsigned num_aio_requests;
329 struct tevent_req **aio_requests;
332 * If a close request comes in while we still have aio_requests
333 * around, we need to hold back the close. When all aio_requests are
334 * done, the aio completion routines need tevent_wait_done() on
335 * this. A bit ugly, but before we have close_file() fully async
336 * possibly the simplest approach. Thanks, Jeremy for the idea.
338 struct tevent_req *deferred_close;
341 #define FSP_POSIX_FLAGS_OPEN 0x01
342 #define FSP_POSIX_FLAGS_RENAME 0x02
343 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
345 #define FSP_POSIX_FLAGS_ALL \
346 (FSP_POSIX_FLAGS_OPEN | \
347 FSP_POSIX_FLAGS_PATHNAMES | \
348 FSP_POSIX_FLAGS_RENAME)
350 struct vuid_cache_entry {
351 struct auth_session_info *session_info;
352 uint64_t vuid; /* SMB2 compat */
354 uint32_t share_access;
358 unsigned int next_entry;
359 struct vuid_cache_entry array[VUID_CACHE_SIZE];
365 } name_compare_entry;
367 struct dfree_cached_info {
368 time_t last_dfree_time;
375 struct share_params {
379 typedef struct connection_struct {
380 struct connection_struct *next, *prev;
381 struct smbd_server_connection *sconn; /* can be NULL */
382 struct smbXsrv_tcon *tcon; /* can be NULL */
383 uint32_t cnum; /* an index passed over the wire */
384 struct share_params *params;
386 struct vuid_cache *vuid_cache;
389 bool read_only; /* Attributes for the current user of the share. */
390 uint32_t share_access;
391 /* Does this filesystem honor
392 sub second timestamps on files
393 and directories when setting time ? */
394 enum timestamp_set_resolution ts_res;
397 char *cwd; /* Working directory. */
399 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
402 * This represents the user information on this connection. Depending
403 * on the vuid using this tid, this might change per SMB request.
405 struct auth_session_info *session_info;
408 * If the "force group" parameter is set, this is the primary gid that
409 * may be used in the users token, depending on the vuid using this tid.
411 gid_t force_group_gid;
413 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
416 time_t lastused_count;
418 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
422 /* Semantics requested by the client or forced by the server config. */
425 bool short_case_preserve;
427 /* Semantics provided by the underlying filesystem. */
429 /* Device number of the directory of the share mount.
430 Used to ensure unique FileIndex returns. */
431 SMB_DEV_T base_share_dev;
433 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
434 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
435 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
436 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
437 struct dfree_cached_info *dfree_info;
438 struct trans_state *pending_trans;
440 struct rpc_pipe_client *spoolss_pipe;
444 struct smbd_smb2_request;
445 struct privilege_paths;
451 uint64_t mid; /* For compatibility with SMB2. */
453 uint64_t vuid; /* For compatibility with SMB2. */
459 const uint8_t *inbuf;
462 * Async handling in the main smb processing loop is directed by
463 * outbuf: reply_xxx routines indicate sync behaviour by putting their
464 * reply into "outbuf". If they leave it as NULL, they take care of it
465 * themselves, possibly later.
467 * If async handling is wanted, the reply_xxx routine must make sure
468 * that it talloc_move()s the smb_req somewhere else.
474 connection_struct *conn;
475 struct smbd_server_connection *sconn;
476 struct smbXsrv_connection *xconn;
477 struct smb_perfcount_data pcd;
480 * Chained request handling
482 struct files_struct *chain_fsp;
485 * state information for async smb handling
490 * Back pointer to smb2 request.
492 struct smbd_smb2_request *smb2req;
495 * Pathnames used if request done
498 struct privilege_paths *priv_paths;
501 * Request list for chained requests, we're part of it.
503 struct smb_request **chain;
505 struct timeval request_time;
507 bool posix_pathnames;
511 * Info about an alternate data stream
514 struct stream_struct {
521 struct smb_file_time {
522 struct timespec mtime;
523 struct timespec atime;
524 struct timespec ctime;
525 struct timespec create_time;
531 struct smb_filename {
534 char *original_lcomp;
540 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
541 * to keep the numeric values consistent.
544 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
546 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
547 handle = handle->next; \
550 enum vfs_translate_direction {
551 vfs_translate_to_unix = 0,
552 vfs_translate_to_windows
555 enum vfs_fallocate_flags {
556 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
557 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
561 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
562 * be handled as a COW clone, AKA reflink.
563 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
565 enum vfs_copy_chunk_flags {
566 VFS_COPY_CHUNK_FL_MUST_CLONE = 0x0001,
567 VFS_COPY_CHUNK_FL_IGNORE_LOCKS = 0x0002,
569 VFS_COPY_CHUNK_FL_MASK_ALL =
570 (VFS_COPY_CHUNK_FL_MUST_CLONE
571 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
574 struct vfs_aio_state {
580 Available VFS operations. These values must be in sync with vfs_ops struct
581 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
582 In particular, if new operations are added to vfs_ops, appropriate constants
583 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
585 struct shadow_copy_data;
587 struct vfs_fn_pointers {
588 /* Disk operations */
590 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
591 void (*disconnect_fn)(struct vfs_handle_struct *handle);
592 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
593 uint64_t *dfree, uint64_t *dsize);
594 int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
595 enum SMB_QUOTA_TYPE qtype, unid_t id,
597 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
598 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
599 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
600 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
603 * Note: that "struct dfs_GetDFSReferral *r"
604 * needs to be a valid TALLOC_CTX
606 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
607 struct dfs_GetDFSReferral *r);
609 /* Directory operations */
611 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
612 const struct smb_filename *smb_fname,
614 uint32_t attributes);
615 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
616 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
618 SMB_STRUCT_STAT *sbuf);
619 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
620 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
621 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
622 int (*mkdir_fn)(struct vfs_handle_struct *handle,
623 const struct smb_filename *smb_fname,
625 int (*rmdir_fn)(struct vfs_handle_struct *handle,
626 const struct smb_filename *smb_fname);
627 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
628 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
630 /* File operations */
632 int (*open_fn)(struct vfs_handle_struct *handle,
633 struct smb_filename *smb_fname, files_struct *fsp,
634 int flags, mode_t mode);
635 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
636 struct smb_request *req,
637 uint16_t root_dir_fid,
638 struct smb_filename *smb_fname,
639 uint32_t access_mask,
640 uint32_t share_access,
641 uint32_t create_disposition,
642 uint32_t create_options,
643 uint32_t file_attributes,
644 uint32_t oplock_request,
645 struct smb2_lease *lease,
646 uint64_t allocation_size,
647 uint32_t private_flags,
648 struct security_descriptor *sd,
649 struct ea_list *ea_list,
650 files_struct **result,
652 const struct smb2_create_blobs *in_context_blobs,
653 struct smb2_create_blobs *out_context_blobs);
654 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
655 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
656 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
657 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
659 struct tevent_context *ev,
660 struct files_struct *fsp,
662 size_t n, off_t offset);
663 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
664 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
665 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
666 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
668 struct tevent_context *ev,
669 struct files_struct *fsp,
671 size_t n, off_t offset);
672 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
673 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
674 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
675 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
676 int (*rename_fn)(struct vfs_handle_struct *handle,
677 const struct smb_filename *smb_fname_src,
678 const struct smb_filename *smb_fname_dst);
679 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
680 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
682 struct tevent_context *ev,
683 struct files_struct *fsp);
684 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
685 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
686 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
687 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
688 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
689 int (*unlink_fn)(struct vfs_handle_struct *handle,
690 const struct smb_filename *smb_fname);
691 int (*chmod_fn)(struct vfs_handle_struct *handle,
692 const struct smb_filename *smb_fname,
694 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
695 int (*chown_fn)(struct vfs_handle_struct *handle,
696 const struct smb_filename *smb_fname,
699 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
700 int (*lchown_fn)(struct vfs_handle_struct *handle,
701 const struct smb_filename *smb_fname,
704 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
705 char *(*getwd_fn)(struct vfs_handle_struct *handle);
706 int (*ntimes_fn)(struct vfs_handle_struct *handle,
707 const struct smb_filename *smb_fname,
708 struct smb_file_time *ft);
709 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
710 int (*fallocate_fn)(struct vfs_handle_struct *handle,
711 struct files_struct *fsp,
715 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
716 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
717 uint32_t share_mode, uint32_t access_mask);
718 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
719 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
720 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
721 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
722 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
723 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
724 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
725 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
726 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
727 const SMB_STRUCT_STAT *sbuf);
728 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
730 struct tevent_context *ev,
731 struct files_struct *src_fsp,
733 struct files_struct *dest_fsp,
737 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
738 struct tevent_req *req,
740 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
742 struct files_struct *fsp,
743 struct smb_filename *smb_fname,
744 uint16_t *_compression_fmt);
745 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
747 struct files_struct *fsp,
748 uint16_t compression_fmt);
749 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
751 const char *service_path,
753 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
755 const char *base_volume,
760 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
765 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
766 struct files_struct *fsp,
767 const struct smb_filename *smb_fname,
769 unsigned int *num_streams,
770 struct stream_struct **streams);
772 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
778 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
779 const char *filename);
781 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
782 struct byte_range_lock *br_lck,
783 struct lock_struct *plock,
786 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
787 struct messaging_context *msg_ctx,
788 struct byte_range_lock *br_lck,
789 const struct lock_struct *plock);
791 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
792 struct byte_range_lock *br_lck,
793 struct lock_struct *plock);
795 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
796 struct files_struct *fsp,
797 struct lock_struct *plock);
799 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
800 struct files_struct *fsp,
801 struct lock_struct *plock);
803 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
805 enum vfs_translate_direction direction,
809 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
810 struct files_struct *fsp,
814 const uint8_t *_in_data,
817 uint32_t max_out_len,
820 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
821 struct smb_filename *smb_fname,
824 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
825 struct files_struct *fsp,
828 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
829 const struct smb_filename *smb_fname,
832 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
833 struct files_struct *fsp,
836 /* NT ACL operations. */
838 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
839 struct files_struct *fsp,
840 uint32_t security_info,
842 struct security_descriptor **ppdesc);
843 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
844 const struct smb_filename *smb_fname,
845 uint32_t security_info,
847 struct security_descriptor **ppdesc);
848 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
849 struct files_struct *fsp,
850 uint32_t security_info_sent,
851 const struct security_descriptor *psd);
853 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
854 struct smb_filename *file,
855 struct security_acl *sacl,
856 uint32_t access_requested,
857 uint32_t access_denied);
859 /* POSIX ACL operations. */
861 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
862 const struct smb_filename *smb_fname,
864 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
866 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
867 const struct smb_filename *smb_fname,
869 TALLOC_CTX *mem_ctx);
870 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
871 struct files_struct *fsp,
872 TALLOC_CTX *mem_ctx);
873 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
874 const struct smb_filename *smb_fname,
876 char **blob_description,
878 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
879 TALLOC_CTX *mem_ctx, char **blob_description,
881 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
882 const struct smb_filename *smb_fname,
883 SMB_ACL_TYPE_T acltype,
885 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
886 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
887 const struct smb_filename *smb_fname);
890 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
891 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
892 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
893 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
894 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
895 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
896 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
897 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
900 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
902 /* durable handle operations */
903 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
904 struct files_struct *fsp,
907 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
908 struct files_struct *fsp,
909 const DATA_BLOB old_cookie,
911 DATA_BLOB *new_cookie);
912 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
913 struct smb_request *smb1req,
914 struct smbXsrv_open *op,
915 const DATA_BLOB old_cookie,
917 struct files_struct **fsp,
918 DATA_BLOB *new_cookie);
920 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
921 const struct smb_filename *fname,
923 struct readdir_attr_data **attr_data);
927 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
928 which describes all operations this module is willing to intercept.
929 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
930 using this information.
933 typedef struct vfs_handle_struct {
934 struct vfs_handle_struct *next, *prev;
936 struct connection_struct *conn;
937 const struct vfs_fn_pointers *fns;
939 void (*free_data)(void **data);
943 typedef struct vfs_statvfs_struct {
944 /* For undefined recommended transfer size return -1 in that field */
945 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
949 The next three fields are in terms of the block size.
950 (above). If block size is unknown, 4096 would be a
951 reasonable block size for a server to report.
952 Note that returning the blocks/blocksavail removes need
953 to make a second call (to QFSInfo level 0x103 to get this info.
954 UserBlockAvail is typically less than or equal to BlocksAvail,
955 if no distinction is made return the same value in each.
958 uint64_t TotalBlocks;
959 uint64_t BlocksAvail; /* bfree */
960 uint64_t UserBlocksAvail; /* bavail */
962 /* For undefined Node fields or FSID return -1 */
963 uint64_t TotalFileNodes;
964 uint64_t FreeFileNodes;
965 uint64_t FsIdentifier; /* fsid */
966 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
967 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
970 } vfs_statvfs_struct;
972 /* Add a new FSP extension of the given type. Returns a pointer to the
975 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
976 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
978 /* Return a pointer to the existing FSP extension data. */
979 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
980 vfs_fetch_fsp_extension(handle, (fsp))
982 /* Return the talloc context associated with an FSP extension. */
983 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
984 vfs_memctx_fsp_extension(handle, (fsp))
986 /* Remove and destroy an FSP extension. */
987 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
988 vfs_remove_fsp_extension((handle), (fsp))
990 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
991 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
992 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
997 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
999 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1002 if ((handle)->free_data) { \
1003 (handle)->free_data(&(handle)->data); \
1005 (handle)->data = (void *)datap; \
1006 (handle)->free_data = free_fn; \
1010 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1011 if ((handle) && (handle)->free_data) { \
1012 (handle)->free_data(&(handle)->data); \
1016 /* Check whether module-specific data handle was already allocated or not */
1017 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1019 #define SMB_VFS_OP(x) ((void *) x)
1021 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1023 #include "vfs_macros.h"
1025 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1026 const char *service, const char *user);
1027 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1028 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1029 const char *path, uint64_t *bsize,
1030 uint64_t *dfree, uint64_t *dsize);
1031 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
1032 enum SMB_QUOTA_TYPE qtype, unid_t id,
1033 SMB_DISK_QUOTA *qt);
1034 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1035 enum SMB_QUOTA_TYPE qtype, unid_t id,
1036 SMB_DISK_QUOTA *qt);
1037 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1038 struct files_struct *fsp,
1039 struct shadow_copy_data *shadow_copy_data,
1041 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
1042 struct vfs_statvfs_struct *statbuf);
1043 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1044 enum timestamp_set_resolution *p_ts_res);
1046 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1048 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1049 struct dfs_GetDFSReferral *r);
1050 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1051 const struct smb_filename *smb_fname,
1053 uint32_t attributes);
1054 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1055 struct files_struct *fsp,
1057 uint32_t attributes);
1058 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1060 SMB_STRUCT_STAT *sbuf);
1061 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1062 DIR *dirp, long offset);
1063 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1065 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1067 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1068 const struct smb_filename *smb_fname,
1070 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1071 const struct smb_filename *smb_fname);
1072 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1074 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
1076 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1077 struct smb_filename *smb_fname, struct files_struct *fsp,
1078 int flags, mode_t mode);
1079 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1080 struct smb_request *req,
1081 uint16_t root_dir_fid,
1082 struct smb_filename *smb_fname,
1083 uint32_t access_mask,
1084 uint32_t share_access,
1085 uint32_t create_disposition,
1086 uint32_t create_options,
1087 uint32_t file_attributes,
1088 uint32_t oplock_request,
1089 struct smb2_lease *lease,
1090 uint64_t allocation_size,
1091 uint32_t private_flags,
1092 struct security_descriptor *sd,
1093 struct ea_list *ea_list,
1094 files_struct **result,
1096 const struct smb2_create_blobs *in_context_blobs,
1097 struct smb2_create_blobs *out_context_blobs);
1098 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1099 struct files_struct *fsp);
1100 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1101 struct files_struct *fsp, void *data, size_t n);
1102 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1103 struct files_struct *fsp, void *data, size_t n,
1105 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1106 TALLOC_CTX *mem_ctx,
1107 struct tevent_context *ev,
1108 struct files_struct *fsp,
1110 size_t n, off_t offset);
1111 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1113 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1114 struct files_struct *fsp, const void *data,
1116 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1117 struct files_struct *fsp, const void *data,
1118 size_t n, off_t offset);
1119 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1120 TALLOC_CTX *mem_ctx,
1121 struct tevent_context *ev,
1122 struct files_struct *fsp,
1124 size_t n, off_t offset);
1125 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1127 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1128 struct files_struct *fsp, off_t offset,
1130 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1131 files_struct *fromfsp, const DATA_BLOB *header,
1132 off_t offset, size_t count);
1133 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1134 files_struct *tofsp, off_t offset,
1136 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1137 const struct smb_filename *smb_fname_src,
1138 const struct smb_filename *smb_fname_dst);
1139 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1140 struct files_struct *fsp);
1142 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1143 TALLOC_CTX *mem_ctx,
1144 struct tevent_context *ev,
1145 struct files_struct *fsp);
1146 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1148 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1149 struct smb_filename *smb_fname);
1150 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1151 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1152 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1153 struct smb_filename *smb_filename);
1154 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1155 struct files_struct *fsp,
1156 const SMB_STRUCT_STAT *sbuf);
1157 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1158 const struct smb_filename *smb_fname);
1159 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1160 const struct smb_filename *smb_fname,
1162 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1163 struct files_struct *fsp, mode_t mode);
1164 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1165 const struct smb_filename *smb_fname,
1168 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1169 struct files_struct *fsp, uid_t uid, gid_t gid);
1170 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1171 const struct smb_filename *smb_fname,
1174 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1175 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1176 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1177 const struct smb_filename *smb_fname,
1178 struct smb_file_time *ft);
1179 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1180 struct files_struct *fsp, off_t offset);
1181 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1182 struct files_struct *fsp,
1186 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1187 struct files_struct *fsp, int op, off_t offset,
1188 off_t count, int type);
1189 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1190 struct files_struct *fsp, uint32_t share_mode,
1191 uint32_t access_mask);
1192 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1193 struct files_struct *fsp, int leasetype);
1194 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1195 struct files_struct *fsp, off_t *poffset,
1196 off_t *pcount, int *ptype, pid_t *ppid);
1197 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1198 const char *newpath);
1199 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1200 const char *path, char *buf, size_t bufsiz);
1201 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1202 const char *newpath);
1203 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1204 mode_t mode, SMB_DEV_T dev);
1205 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1206 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1207 unsigned int flags);
1208 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1209 const SMB_STRUCT_STAT *sbuf);
1210 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1211 struct files_struct *fsp,
1212 const struct smb_filename *smb_fname,
1213 TALLOC_CTX *mem_ctx,
1214 unsigned int *num_streams,
1215 struct stream_struct **streams);
1216 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1217 const char *path, const char *name,
1218 TALLOC_CTX *mem_ctx, char **found_name);
1219 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1220 const char *filename);
1221 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1222 struct byte_range_lock *br_lck,
1223 struct lock_struct *plock,
1224 bool blocking_lock);
1225 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1226 struct messaging_context *msg_ctx,
1227 struct byte_range_lock *br_lck,
1228 const struct lock_struct *plock);
1229 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1230 struct byte_range_lock *br_lck,
1231 struct lock_struct *plock);
1232 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1233 struct files_struct *fsp,
1234 struct lock_struct *plock);
1235 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1236 struct files_struct *fsp,
1237 struct lock_struct *plock);
1238 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1240 enum vfs_translate_direction direction,
1241 TALLOC_CTX *mem_ctx,
1242 char **mapped_name);
1243 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1244 struct files_struct *fsp,
1248 const uint8_t *_in_data,
1250 uint8_t **_out_data,
1251 uint32_t max_out_len,
1253 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1254 struct smb_filename *smb_fname,
1256 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1257 struct files_struct *fsp,
1259 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1260 const struct smb_filename *smb_fname,
1262 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1263 struct files_struct *fsp,
1265 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1266 TALLOC_CTX *mem_ctx,
1267 struct tevent_context *ev,
1268 struct files_struct *src_fsp,
1270 struct files_struct *dest_fsp,
1274 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1275 struct tevent_req *req,
1277 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1278 TALLOC_CTX *mem_ctx,
1279 struct files_struct *fsp,
1280 struct smb_filename *smb_fname,
1281 uint16_t *_compression_fmt);
1282 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1283 TALLOC_CTX *mem_ctx,
1284 struct files_struct *fsp,
1285 uint16_t compression_fmt);
1286 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1287 TALLOC_CTX *mem_ctx,
1288 const char *service_path,
1289 char **base_volume);
1290 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1291 TALLOC_CTX *mem_ctx,
1292 const char *base_volume,
1297 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1298 TALLOC_CTX *mem_ctx,
1301 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1302 struct files_struct *fsp,
1303 uint32_t security_info,
1304 TALLOC_CTX *mem_ctx,
1305 struct security_descriptor **ppdesc);
1306 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1307 const struct smb_filename *smb_fname,
1308 uint32_t security_info,
1309 TALLOC_CTX *mem_ctx,
1310 struct security_descriptor **ppdesc);
1311 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1312 struct files_struct *fsp,
1313 uint32_t security_info_sent,
1314 const struct security_descriptor *psd);
1315 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1316 struct smb_filename *file,
1317 struct security_acl *sacl,
1318 uint32_t access_requested,
1319 uint32_t access_denied);
1320 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1321 const struct smb_filename *file,
1323 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1324 struct files_struct *fsp, mode_t mode);
1325 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1326 const struct smb_filename *smb_fname,
1327 SMB_ACL_TYPE_T type,
1328 TALLOC_CTX *mem_ctx);
1329 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1330 struct files_struct *fsp,
1331 TALLOC_CTX *mem_ctx);
1332 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1333 const struct smb_filename *smb_fname,
1334 TALLOC_CTX *mem_ctx,
1335 char **blob_description,
1337 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1338 struct files_struct *fsp,
1339 TALLOC_CTX *mem_ctx,
1340 char **blob_description,
1342 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1343 const struct smb_filename *smb_fname,
1344 SMB_ACL_TYPE_T acltype,
1346 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1347 struct files_struct *fsp, SMB_ACL_T theacl);
1348 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1349 const struct smb_filename *smb_fname);
1350 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1351 const char *path, const char *name, void *value,
1353 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1354 struct files_struct *fsp, const char *name,
1355 void *value, size_t size);
1356 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1357 const char *path, char *list, size_t size);
1358 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1359 const char *path, char *list, size_t size);
1360 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1361 struct files_struct *fsp, char *list,
1363 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1364 const char *path, const char *name);
1365 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1366 struct files_struct *fsp, const char *name);
1367 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1368 const char *name, const void *value, size_t size,
1370 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1371 const char *name, const void *value, size_t size,
1373 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1374 struct files_struct *fsp, const char *name,
1375 const void *value, size_t size, int flags);
1376 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1377 struct files_struct *fsp);
1378 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1379 const struct smb_filename *fname,
1380 SMB_STRUCT_STAT *sbuf);
1381 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1382 const struct smb_filename *fname);
1383 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1384 struct files_struct *fsp,
1385 TALLOC_CTX *mem_ctx,
1387 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1388 struct files_struct *fsp,
1389 const DATA_BLOB old_cookie,
1390 TALLOC_CTX *mem_ctx,
1391 DATA_BLOB *new_cookie);
1392 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1393 struct smb_request *smb1req,
1394 struct smbXsrv_open *op,
1395 const DATA_BLOB old_cookie,
1396 TALLOC_CTX *mem_ctx,
1397 struct files_struct **fsp,
1398 DATA_BLOB *new_cookie);
1399 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1400 const struct smb_filename *fname,
1401 TALLOC_CTX *mem_ctx,
1402 struct readdir_attr_data **attr_data);
1404 NTSTATUS smb_register_vfs(int version, const char *name,
1405 const struct vfs_fn_pointers *fns);
1406 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1407 files_struct *fsp, size_t ext_size,
1408 void (*destroy_fn)(void *p_data));
1409 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1410 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1411 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1412 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1414 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1415 const char *module);