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 */
173 #define SMB_VFS_INTERFACE_VERSION 34
176 All intercepted VFS operations must be declared as static functions inside module source
177 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
178 example VFS modules for more details.
181 /* VFS operations structure */
183 struct vfs_handle_struct;
184 struct connection_struct;
186 struct security_descriptor;
187 struct vfs_statvfs_struct;
190 struct smb_file_time;
191 struct blocking_lock_record;
193 struct dfs_GetDFSReferral;
195 typedef union unid_t {
203 uint64_t position_information;
205 uint32_t private_options; /* NT Create options, but we only look at
206 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
207 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
208 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
209 * for print files *only*, where
210 * DELETE_ON_CLOSE is not stored in the share
213 unsigned long gen_id;
218 struct smbd_server_connection *sconn;
219 struct tevent_timer *timeout;
220 struct smb2_lease lease;
223 typedef struct files_struct {
224 struct files_struct *next, *prev;
226 struct smbXsrv_open *op;
227 struct connection_struct *conn;
228 struct fd_handle *fh;
229 unsigned int num_smb_operations;
230 struct file_id file_id;
231 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
233 uint64_t vuid; /* SMB2 compat */
234 struct write_cache *wcp;
235 struct timeval open_time;
236 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
237 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
239 bool update_write_time_triggered;
240 struct tevent_timer *update_write_time_event;
241 bool update_write_time_on_close;
242 struct timespec close_write_time;
243 bool write_time_forced;
246 struct fsp_lease *lease; /* Not yet used. Placeholder for leases. */
247 int sent_oplock_break;
248 struct tevent_timer *oplock_timeout;
249 struct lock_struct last_lock_failure;
250 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
257 bool aio_write_behind;
258 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
259 bool delete_on_close;
260 uint64_t posix_flags;
262 bool backup_intent; /* Handle was successfully opened with backup intent
263 and opener has privilege to do so. */
264 bool aapl_copyfile_supported;
265 struct smb_filename *fsp_name;
266 uint32_t name_hash; /* Jenkins hash of full pathname. */
267 uint64_t mid; /* Mid of the operation that created us. */
269 struct vfs_fsp_data *vfs_extension;
270 struct fake_file_handle *fake_file_handle;
272 struct notify_change_buf *notify;
274 struct files_struct *base_fsp; /* placeholder for delete on close */
277 * Read-only cached brlock record, thrown away when the
278 * brlock.tdb seqnum changes. This avoids fetching data from
279 * the brlock.tdb on every read/write call.
282 struct byte_range_lock *brlock_rec;
284 struct dptr_struct *dptr;
286 /* if not NULL, means this is a print file */
287 struct print_file_data *print_file;
289 unsigned num_aio_requests;
290 struct tevent_req **aio_requests;
293 * If a close request comes in while we still have aio_requests
294 * around, we need to hold back the close. When all aio_requests are
295 * done, the aio completion routines need tevent_wait_done() on
296 * this. A bit ugly, but before we have close_file() fully async
297 * possibly the simplest approach. Thanks, Jeremy for the idea.
299 struct tevent_req *deferred_close;
302 #define FSP_POSIX_FLAGS_OPEN 0x01
303 #define FSP_POSIX_FLAGS_RENAME 0x02
305 #define FSP_POSIX_FLAGS_ALL \
306 (FSP_POSIX_FLAGS_OPEN | \
307 FSP_POSIX_FLAGS_RENAME)
309 struct vuid_cache_entry {
310 struct auth_session_info *session_info;
311 uint64_t vuid; /* SMB2 compat */
313 uint32_t share_access;
317 unsigned int next_entry;
318 struct vuid_cache_entry array[VUID_CACHE_SIZE];
324 } name_compare_entry;
326 struct dfree_cached_info {
327 time_t last_dfree_time;
334 struct share_params {
338 typedef struct connection_struct {
339 struct connection_struct *next, *prev;
340 struct smbd_server_connection *sconn; /* can be NULL */
341 struct smbXsrv_tcon *tcon; /* can be NULL */
342 uint32_t cnum; /* an index passed over the wire */
343 struct share_params *params;
345 struct vuid_cache *vuid_cache;
348 bool read_only; /* Attributes for the current user of the share. */
349 uint32_t share_access;
350 /* Does this filesystem honor
351 sub second timestamps on files
352 and directories when setting time ? */
353 enum timestamp_set_resolution ts_res;
356 char *cwd; /* Working directory. */
358 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
361 * This represents the user information on this connection. Depending
362 * on the vuid using this tid, this might change per SMB request.
364 struct auth_session_info *session_info;
367 * If the "force group" parameter is set, this is the primary gid that
368 * may be used in the users token, depending on the vuid using this tid.
370 gid_t force_group_gid;
372 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
375 time_t lastused_count;
377 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
381 /* Semantics requested by the client or forced by the server config. */
384 bool short_case_preserve;
386 /* Semantics provided by the underlying filesystem. */
388 /* Device number of the directory of the share mount.
389 Used to ensure unique FileIndex returns. */
390 SMB_DEV_T base_share_dev;
392 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
393 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
394 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
395 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
396 struct dfree_cached_info *dfree_info;
397 struct trans_state *pending_trans;
399 struct rpc_pipe_client *spoolss_pipe;
403 struct smbd_smb2_request;
404 struct privilege_paths;
410 uint64_t mid; /* For compatibility with SMB2. */
412 uint64_t vuid; /* For compatibility with SMB2. */
418 const uint8_t *inbuf;
421 * Async handling in the main smb processing loop is directed by
422 * outbuf: reply_xxx routines indicate sync behaviour by putting their
423 * reply into "outbuf". If they leave it as NULL, they take care of it
424 * themselves, possibly later.
426 * If async handling is wanted, the reply_xxx routine must make sure
427 * that it talloc_move()s the smb_req somewhere else.
433 connection_struct *conn;
434 struct smbd_server_connection *sconn;
435 struct smbXsrv_connection *xconn;
436 struct smb_perfcount_data pcd;
439 * Chained request handling
441 struct files_struct *chain_fsp;
444 * state information for async smb handling
449 * Back pointer to smb2 request.
451 struct smbd_smb2_request *smb2req;
454 * Pathnames used if request done
457 struct privilege_paths *priv_paths;
460 * Request list for chained requests, we're part of it.
462 struct smb_request **chain;
464 struct timeval request_time;
468 * Info about an alternate data stream
471 struct stream_struct {
478 struct smb_file_time {
479 struct timespec mtime;
480 struct timespec atime;
481 struct timespec ctime;
482 struct timespec create_time;
488 struct smb_filename {
491 char *original_lcomp;
495 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
496 handle = handle->next; \
499 enum vfs_translate_direction {
500 vfs_translate_to_unix = 0,
501 vfs_translate_to_windows
504 enum vfs_fallocate_flags {
505 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
506 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
510 Available VFS operations. These values must be in sync with vfs_ops struct
511 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
512 In particular, if new operations are added to vfs_ops, appropriate constants
513 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
515 struct shadow_copy_data;
517 struct vfs_fn_pointers {
518 /* Disk operations */
520 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
521 void (*disconnect_fn)(struct vfs_handle_struct *handle);
522 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
523 uint64_t *dfree, uint64_t *dsize);
524 int (*get_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
525 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
526 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
527 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
528 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
531 * Note: that "struct dfs_GetDFSReferral *r"
532 * needs to be a valid TALLOC_CTX
534 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
535 struct dfs_GetDFSReferral *r);
537 /* Directory operations */
539 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32_t attributes);
540 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
541 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
543 SMB_STRUCT_STAT *sbuf);
544 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
545 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
546 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
547 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
548 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
549 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
550 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
552 /* File operations */
554 int (*open_fn)(struct vfs_handle_struct *handle,
555 struct smb_filename *smb_fname, files_struct *fsp,
556 int flags, mode_t mode);
557 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
558 struct smb_request *req,
559 uint16_t root_dir_fid,
560 struct smb_filename *smb_fname,
561 uint32_t access_mask,
562 uint32_t share_access,
563 uint32_t create_disposition,
564 uint32_t create_options,
565 uint32_t file_attributes,
566 uint32_t oplock_request,
567 struct smb2_lease *lease,
568 uint64_t allocation_size,
569 uint32_t private_flags,
570 struct security_descriptor *sd,
571 struct ea_list *ea_list,
572 files_struct **result,
574 const struct smb2_create_blobs *in_context_blobs,
575 struct smb2_create_blobs *out_context_blobs);
576 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
577 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
578 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
579 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
581 struct tevent_context *ev,
582 struct files_struct *fsp,
584 size_t n, off_t offset);
585 ssize_t (*pread_recv_fn)(struct tevent_req *req, int *err);
586 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
587 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
588 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
590 struct tevent_context *ev,
591 struct files_struct *fsp,
593 size_t n, off_t offset);
594 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, int *err);
595 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
596 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
597 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
598 int (*rename_fn)(struct vfs_handle_struct *handle,
599 const struct smb_filename *smb_fname_src,
600 const struct smb_filename *smb_fname_dst);
601 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
602 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
604 struct tevent_context *ev,
605 struct files_struct *fsp);
606 int (*fsync_recv_fn)(struct tevent_req *req, int *err);
607 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
608 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
609 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
610 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
611 int (*unlink_fn)(struct vfs_handle_struct *handle,
612 const struct smb_filename *smb_fname);
613 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
614 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
615 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
616 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
617 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
618 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
619 char *(*getwd_fn)(struct vfs_handle_struct *handle);
620 int (*ntimes_fn)(struct vfs_handle_struct *handle,
621 const struct smb_filename *smb_fname,
622 struct smb_file_time *ft);
623 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
624 int (*fallocate_fn)(struct vfs_handle_struct *handle,
625 struct files_struct *fsp,
629 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
630 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
631 uint32_t share_mode, uint32_t access_mask);
632 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
633 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
634 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
635 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
636 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
637 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
638 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
639 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
640 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
641 const SMB_STRUCT_STAT *sbuf);
642 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
644 struct tevent_context *ev,
645 struct files_struct *src_fsp,
647 struct files_struct *dest_fsp,
650 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
651 struct tevent_req *req,
653 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
655 struct files_struct *fsp,
656 struct smb_filename *smb_fname,
657 uint16_t *_compression_fmt);
658 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
660 struct files_struct *fsp,
661 uint16_t compression_fmt);
662 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
664 const char *service_path,
666 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
668 const char *base_volume,
673 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
678 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
679 struct files_struct *fsp,
682 unsigned int *num_streams,
683 struct stream_struct **streams);
685 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
691 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
692 const char *filename);
694 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
695 struct byte_range_lock *br_lck,
696 struct lock_struct *plock,
699 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
700 struct messaging_context *msg_ctx,
701 struct byte_range_lock *br_lck,
702 const struct lock_struct *plock);
704 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
705 struct byte_range_lock *br_lck,
706 struct lock_struct *plock);
708 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
709 struct files_struct *fsp,
710 struct lock_struct *plock);
712 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
713 struct files_struct *fsp,
714 struct lock_struct *plock);
716 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
718 enum vfs_translate_direction direction,
722 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
723 struct files_struct *fsp,
727 const uint8_t *_in_data,
730 uint32_t max_out_len,
733 /* NT ACL operations. */
735 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
736 struct files_struct *fsp,
737 uint32_t security_info,
739 struct security_descriptor **ppdesc);
740 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
742 uint32_t security_info,
744 struct security_descriptor **ppdesc);
745 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
746 struct files_struct *fsp,
747 uint32_t security_info_sent,
748 const struct security_descriptor *psd);
750 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
751 struct smb_filename *file,
752 struct security_acl *sacl,
753 uint32_t access_requested,
754 uint32_t access_denied);
756 /* POSIX ACL operations. */
758 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
759 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
761 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
764 TALLOC_CTX *mem_ctx);
765 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
766 struct files_struct *fsp,
767 TALLOC_CTX *mem_ctx);
768 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
771 char **blob_description,
773 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
774 TALLOC_CTX *mem_ctx, char **blob_description,
776 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
777 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
778 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
781 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
782 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
783 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
784 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
785 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
786 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
787 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
788 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
791 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
793 /* offline operations */
794 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
795 const struct smb_filename *fname,
796 SMB_STRUCT_STAT *sbuf);
797 int (*set_offline_fn)(struct vfs_handle_struct *handle,
798 const struct smb_filename *fname);
800 /* durable handle operations */
801 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
802 struct files_struct *fsp,
805 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
806 struct files_struct *fsp,
807 const DATA_BLOB old_cookie,
809 DATA_BLOB *new_cookie);
810 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
811 struct smb_request *smb1req,
812 struct smbXsrv_open *op,
813 const DATA_BLOB old_cookie,
815 struct files_struct **fsp,
816 DATA_BLOB *new_cookie);
818 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
819 const struct smb_filename *fname,
821 struct readdir_attr_data **attr_data);
825 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
826 which describes all operations this module is willing to intercept.
827 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
828 using this information.
831 typedef struct vfs_handle_struct {
832 struct vfs_handle_struct *next, *prev;
834 struct connection_struct *conn;
835 const struct vfs_fn_pointers *fns;
837 void (*free_data)(void **data);
841 typedef struct vfs_statvfs_struct {
842 /* For undefined recommended transfer size return -1 in that field */
843 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
847 The next three fields are in terms of the block size.
848 (above). If block size is unknown, 4096 would be a
849 reasonable block size for a server to report.
850 Note that returning the blocks/blocksavail removes need
851 to make a second call (to QFSInfo level 0x103 to get this info.
852 UserBlockAvail is typically less than or equal to BlocksAvail,
853 if no distinction is made return the same value in each.
856 uint64_t TotalBlocks;
857 uint64_t BlocksAvail; /* bfree */
858 uint64_t UserBlocksAvail; /* bavail */
860 /* For undefined Node fields or FSID return -1 */
861 uint64_t TotalFileNodes;
862 uint64_t FreeFileNodes;
863 uint64_t FsIdentifier; /* fsid */
864 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
865 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
868 } vfs_statvfs_struct;
870 /* Add a new FSP extension of the given type. Returns a pointer to the
873 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
874 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
876 /* Return a pointer to the existing FSP extension data. */
877 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
878 vfs_fetch_fsp_extension(handle, (fsp))
880 /* Return the talloc context associated with an FSP extension. */
881 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
882 vfs_memctx_fsp_extension(handle, (fsp))
884 /* Remove and destroy an FSP extension. */
885 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
886 vfs_remove_fsp_extension((handle), (fsp))
888 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
889 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
890 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
895 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
897 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
900 if ((handle)->free_data) { \
901 (handle)->free_data(&(handle)->data); \
903 (handle)->data = (void *)datap; \
904 (handle)->free_data = free_fn; \
908 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
909 if ((handle) && (handle)->free_data) { \
910 (handle)->free_data(&(handle)->data); \
914 /* Check whether module-specific data handle was already allocated or not */
915 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
917 #define SMB_VFS_OP(x) ((void *) x)
919 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
921 #include "vfs_macros.h"
923 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
924 const char *service, const char *user);
925 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
926 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
927 const char *path, uint64_t *bsize,
928 uint64_t *dfree, uint64_t *dsize);
929 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
930 enum SMB_QUOTA_TYPE qtype, unid_t id,
932 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
933 enum SMB_QUOTA_TYPE qtype, unid_t id,
935 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
936 struct files_struct *fsp,
937 struct shadow_copy_data *shadow_copy_data,
939 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
940 struct vfs_statvfs_struct *statbuf);
941 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
942 enum timestamp_set_resolution *p_ts_res);
944 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
946 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
947 struct dfs_GetDFSReferral *r);
948 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
949 const char *fname, const char *mask,
950 uint32_t attributes);
951 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
952 struct files_struct *fsp,
954 uint32_t attributes);
955 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
957 SMB_STRUCT_STAT *sbuf);
958 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
959 DIR *dirp, long offset);
960 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
962 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
964 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
966 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
967 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
969 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
971 int smb_vfs_call_open(struct vfs_handle_struct *handle,
972 struct smb_filename *smb_fname, struct files_struct *fsp,
973 int flags, mode_t mode);
974 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
975 struct smb_request *req,
976 uint16_t root_dir_fid,
977 struct smb_filename *smb_fname,
978 uint32_t access_mask,
979 uint32_t share_access,
980 uint32_t create_disposition,
981 uint32_t create_options,
982 uint32_t file_attributes,
983 uint32_t oplock_request,
984 struct smb2_lease *lease,
985 uint64_t allocation_size,
986 uint32_t private_flags,
987 struct security_descriptor *sd,
988 struct ea_list *ea_list,
989 files_struct **result,
991 const struct smb2_create_blobs *in_context_blobs,
992 struct smb2_create_blobs *out_context_blobs);
993 int smb_vfs_call_close(struct vfs_handle_struct *handle,
994 struct files_struct *fsp);
995 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
996 struct files_struct *fsp, void *data, size_t n);
997 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
998 struct files_struct *fsp, void *data, size_t n,
1000 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1001 TALLOC_CTX *mem_ctx,
1002 struct tevent_context *ev,
1003 struct files_struct *fsp,
1005 size_t n, off_t offset);
1006 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, int *perrno);
1008 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1009 struct files_struct *fsp, const void *data,
1011 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1012 struct files_struct *fsp, const void *data,
1013 size_t n, off_t offset);
1014 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1015 TALLOC_CTX *mem_ctx,
1016 struct tevent_context *ev,
1017 struct files_struct *fsp,
1019 size_t n, off_t offset);
1020 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, int *perrno);
1022 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1023 struct files_struct *fsp, off_t offset,
1025 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1026 files_struct *fromfsp, const DATA_BLOB *header,
1027 off_t offset, size_t count);
1028 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1029 files_struct *tofsp, off_t offset,
1031 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1032 const struct smb_filename *smb_fname_src,
1033 const struct smb_filename *smb_fname_dst);
1034 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1035 struct files_struct *fsp);
1037 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1038 TALLOC_CTX *mem_ctx,
1039 struct tevent_context *ev,
1040 struct files_struct *fsp);
1041 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, int *perrno);
1043 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1044 struct smb_filename *smb_fname);
1045 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1046 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1047 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1048 struct smb_filename *smb_filename);
1049 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1050 struct files_struct *fsp,
1051 const SMB_STRUCT_STAT *sbuf);
1052 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1053 const struct smb_filename *smb_fname);
1054 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
1056 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1057 struct files_struct *fsp, mode_t mode);
1058 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
1059 uid_t uid, gid_t gid);
1060 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1061 struct files_struct *fsp, uid_t uid, gid_t gid);
1062 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
1063 uid_t uid, gid_t gid);
1064 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1065 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1066 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1067 const struct smb_filename *smb_fname,
1068 struct smb_file_time *ft);
1069 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1070 struct files_struct *fsp, off_t offset);
1071 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1072 struct files_struct *fsp,
1076 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1077 struct files_struct *fsp, int op, off_t offset,
1078 off_t count, int type);
1079 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1080 struct files_struct *fsp, uint32_t share_mode,
1081 uint32_t access_mask);
1082 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1083 struct files_struct *fsp, int leasetype);
1084 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1085 struct files_struct *fsp, off_t *poffset,
1086 off_t *pcount, int *ptype, pid_t *ppid);
1087 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1088 const char *newpath);
1089 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1090 const char *path, char *buf, size_t bufsiz);
1091 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1092 const char *newpath);
1093 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1094 mode_t mode, SMB_DEV_T dev);
1095 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1096 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1097 unsigned int flags);
1098 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1099 const SMB_STRUCT_STAT *sbuf);
1100 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1101 struct files_struct *fsp,
1103 TALLOC_CTX *mem_ctx,
1104 unsigned int *num_streams,
1105 struct stream_struct **streams);
1106 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1107 const char *path, const char *name,
1108 TALLOC_CTX *mem_ctx, char **found_name);
1109 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1110 const char *filename);
1111 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1112 struct byte_range_lock *br_lck,
1113 struct lock_struct *plock,
1114 bool blocking_lock);
1115 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1116 struct messaging_context *msg_ctx,
1117 struct byte_range_lock *br_lck,
1118 const struct lock_struct *plock);
1119 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1120 struct byte_range_lock *br_lck,
1121 struct lock_struct *plock);
1122 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1123 struct files_struct *fsp,
1124 struct lock_struct *plock);
1125 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1126 struct files_struct *fsp,
1127 struct lock_struct *plock);
1128 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1130 enum vfs_translate_direction direction,
1131 TALLOC_CTX *mem_ctx,
1132 char **mapped_name);
1133 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1134 struct files_struct *fsp,
1138 const uint8_t *_in_data,
1140 uint8_t **_out_data,
1141 uint32_t max_out_len,
1143 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1144 TALLOC_CTX *mem_ctx,
1145 struct tevent_context *ev,
1146 struct files_struct *src_fsp,
1148 struct files_struct *dest_fsp,
1151 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1152 struct tevent_req *req,
1154 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1155 TALLOC_CTX *mem_ctx,
1156 struct files_struct *fsp,
1157 struct smb_filename *smb_fname,
1158 uint16_t *_compression_fmt);
1159 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1160 TALLOC_CTX *mem_ctx,
1161 struct files_struct *fsp,
1162 uint16_t compression_fmt);
1163 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1164 TALLOC_CTX *mem_ctx,
1165 const char *service_path,
1166 char **base_volume);
1167 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1168 TALLOC_CTX *mem_ctx,
1169 const char *base_volume,
1174 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1175 TALLOC_CTX *mem_ctx,
1178 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1179 struct files_struct *fsp,
1180 uint32_t security_info,
1181 TALLOC_CTX *mem_ctx,
1182 struct security_descriptor **ppdesc);
1183 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1185 uint32_t security_info,
1186 TALLOC_CTX *mem_ctx,
1187 struct security_descriptor **ppdesc);
1188 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1189 struct files_struct *fsp,
1190 uint32_t security_info_sent,
1191 const struct security_descriptor *psd);
1192 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1193 struct smb_filename *file,
1194 struct security_acl *sacl,
1195 uint32_t access_requested,
1196 uint32_t access_denied);
1197 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
1199 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1200 struct files_struct *fsp, mode_t mode);
1201 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1203 SMB_ACL_TYPE_T type,
1204 TALLOC_CTX *mem_ctx);
1205 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1206 struct files_struct *fsp,
1207 TALLOC_CTX *mem_ctx);
1208 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1210 TALLOC_CTX *mem_ctx,
1211 char **blob_description,
1213 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1214 struct files_struct *fsp,
1215 TALLOC_CTX *mem_ctx,
1216 char **blob_description,
1218 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1219 const char *name, SMB_ACL_TYPE_T acltype,
1221 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1222 struct files_struct *fsp, SMB_ACL_T theacl);
1223 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1225 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1226 const char *path, const char *name, void *value,
1228 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1229 struct files_struct *fsp, const char *name,
1230 void *value, size_t size);
1231 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1232 const char *path, char *list, size_t size);
1233 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1234 const char *path, char *list, size_t size);
1235 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1236 struct files_struct *fsp, char *list,
1238 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1239 const char *path, const char *name);
1240 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1241 struct files_struct *fsp, const char *name);
1242 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1243 const char *name, const void *value, size_t size,
1245 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1246 const char *name, const void *value, size_t size,
1248 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1249 struct files_struct *fsp, const char *name,
1250 const void *value, size_t size, int flags);
1251 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1252 struct files_struct *fsp);
1253 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1254 const struct smb_filename *fname,
1255 SMB_STRUCT_STAT *sbuf);
1256 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1257 const struct smb_filename *fname);
1258 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1259 struct files_struct *fsp,
1260 TALLOC_CTX *mem_ctx,
1262 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1263 struct files_struct *fsp,
1264 const DATA_BLOB old_cookie,
1265 TALLOC_CTX *mem_ctx,
1266 DATA_BLOB *new_cookie);
1267 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1268 struct smb_request *smb1req,
1269 struct smbXsrv_open *op,
1270 const DATA_BLOB old_cookie,
1271 TALLOC_CTX *mem_ctx,
1272 struct files_struct **fsp,
1273 DATA_BLOB *new_cookie);
1274 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1275 const struct smb_filename *fname,
1276 TALLOC_CTX *mem_ctx,
1277 struct readdir_attr_data **attr_data);
1279 NTSTATUS smb_register_vfs(int version, const char *name,
1280 const struct vfs_fn_pointers *fns);
1281 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1282 files_struct *fsp, size_t ext_size,
1283 void (*destroy_fn)(void *p_data));
1284 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1285 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1286 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1287 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);