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 */
174 #define SMB_VFS_INTERFACE_VERSION 34
177 All intercepted VFS operations must be declared as static functions inside module source
178 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
179 example VFS modules for more details.
182 /* VFS operations structure */
184 struct vfs_handle_struct;
185 struct connection_struct;
187 struct security_descriptor;
188 struct vfs_statvfs_struct;
191 struct smb_file_time;
192 struct blocking_lock_record;
194 struct dfs_GetDFSReferral;
196 typedef union unid_t {
204 uint64_t position_information;
206 uint32_t private_options; /* NT Create options, but we only look at
207 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
208 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
209 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
210 * for print files *only*, where
211 * DELETE_ON_CLOSE is not stored in the share
214 unsigned long gen_id;
219 struct smbd_server_connection *sconn;
220 struct tevent_timer *timeout;
221 struct smb2_lease lease;
224 typedef struct files_struct {
225 struct files_struct *next, *prev;
227 struct smbXsrv_open *op;
228 struct connection_struct *conn;
229 struct fd_handle *fh;
230 unsigned int num_smb_operations;
231 struct file_id file_id;
232 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
234 uint64_t vuid; /* SMB2 compat */
235 struct write_cache *wcp;
236 struct timeval open_time;
237 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
238 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
240 bool update_write_time_triggered;
241 struct tevent_timer *update_write_time_event;
242 bool update_write_time_on_close;
243 struct timespec close_write_time;
244 bool write_time_forced;
247 struct fsp_lease *lease; /* Not yet used. Placeholder for leases. */
248 int sent_oplock_break;
249 struct tevent_timer *oplock_timeout;
250 struct lock_struct last_lock_failure;
251 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
258 bool aio_write_behind;
259 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
260 bool delete_on_close;
261 uint64_t posix_flags;
263 bool backup_intent; /* Handle was successfully opened with backup intent
264 and opener has privilege to do so. */
265 bool aapl_copyfile_supported;
266 struct smb_filename *fsp_name;
267 uint32_t name_hash; /* Jenkins hash of full pathname. */
268 uint64_t mid; /* Mid of the operation that created us. */
270 struct vfs_fsp_data *vfs_extension;
271 struct fake_file_handle *fake_file_handle;
273 struct notify_change_buf *notify;
275 struct files_struct *base_fsp; /* placeholder for delete on close */
278 * Read-only cached brlock record, thrown away when the
279 * brlock.tdb seqnum changes. This avoids fetching data from
280 * the brlock.tdb on every read/write call.
283 struct byte_range_lock *brlock_rec;
285 struct dptr_struct *dptr;
287 /* if not NULL, means this is a print file */
288 struct print_file_data *print_file;
290 unsigned num_aio_requests;
291 struct tevent_req **aio_requests;
294 * If a close request comes in while we still have aio_requests
295 * around, we need to hold back the close. When all aio_requests are
296 * done, the aio completion routines need tevent_wait_done() on
297 * this. A bit ugly, but before we have close_file() fully async
298 * possibly the simplest approach. Thanks, Jeremy for the idea.
300 struct tevent_req *deferred_close;
303 #define FSP_POSIX_FLAGS_OPEN 0x01
304 #define FSP_POSIX_FLAGS_RENAME 0x02
305 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
307 #define FSP_POSIX_FLAGS_ALL \
308 (FSP_POSIX_FLAGS_OPEN | \
309 FSP_POSIX_FLAGS_PATHNAMES | \
310 FSP_POSIX_FLAGS_RENAME)
312 struct vuid_cache_entry {
313 struct auth_session_info *session_info;
314 uint64_t vuid; /* SMB2 compat */
316 uint32_t share_access;
320 unsigned int next_entry;
321 struct vuid_cache_entry array[VUID_CACHE_SIZE];
327 } name_compare_entry;
329 struct dfree_cached_info {
330 time_t last_dfree_time;
337 struct share_params {
341 typedef struct connection_struct {
342 struct connection_struct *next, *prev;
343 struct smbd_server_connection *sconn; /* can be NULL */
344 struct smbXsrv_tcon *tcon; /* can be NULL */
345 uint32_t cnum; /* an index passed over the wire */
346 struct share_params *params;
348 struct vuid_cache *vuid_cache;
351 bool read_only; /* Attributes for the current user of the share. */
352 uint32_t share_access;
353 /* Does this filesystem honor
354 sub second timestamps on files
355 and directories when setting time ? */
356 enum timestamp_set_resolution ts_res;
359 char *cwd; /* Working directory. */
361 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
364 * This represents the user information on this connection. Depending
365 * on the vuid using this tid, this might change per SMB request.
367 struct auth_session_info *session_info;
370 * If the "force group" parameter is set, this is the primary gid that
371 * may be used in the users token, depending on the vuid using this tid.
373 gid_t force_group_gid;
375 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
378 time_t lastused_count;
380 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
384 /* Semantics requested by the client or forced by the server config. */
387 bool short_case_preserve;
389 /* Semantics provided by the underlying filesystem. */
391 /* Device number of the directory of the share mount.
392 Used to ensure unique FileIndex returns. */
393 SMB_DEV_T base_share_dev;
395 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
396 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
397 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
398 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
399 struct dfree_cached_info *dfree_info;
400 struct trans_state *pending_trans;
402 struct rpc_pipe_client *spoolss_pipe;
406 struct smbd_smb2_request;
407 struct privilege_paths;
413 uint64_t mid; /* For compatibility with SMB2. */
415 uint64_t vuid; /* For compatibility with SMB2. */
421 const uint8_t *inbuf;
424 * Async handling in the main smb processing loop is directed by
425 * outbuf: reply_xxx routines indicate sync behaviour by putting their
426 * reply into "outbuf". If they leave it as NULL, they take care of it
427 * themselves, possibly later.
429 * If async handling is wanted, the reply_xxx routine must make sure
430 * that it talloc_move()s the smb_req somewhere else.
436 connection_struct *conn;
437 struct smbd_server_connection *sconn;
438 struct smbXsrv_connection *xconn;
439 struct smb_perfcount_data pcd;
442 * Chained request handling
444 struct files_struct *chain_fsp;
447 * state information for async smb handling
452 * Back pointer to smb2 request.
454 struct smbd_smb2_request *smb2req;
457 * Pathnames used if request done
460 struct privilege_paths *priv_paths;
463 * Request list for chained requests, we're part of it.
465 struct smb_request **chain;
467 struct timeval request_time;
469 bool posix_pathnames;
473 * Info about an alternate data stream
476 struct stream_struct {
483 struct smb_file_time {
484 struct timespec mtime;
485 struct timespec atime;
486 struct timespec ctime;
487 struct timespec create_time;
493 struct smb_filename {
496 char *original_lcomp;
500 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
501 handle = handle->next; \
504 enum vfs_translate_direction {
505 vfs_translate_to_unix = 0,
506 vfs_translate_to_windows
509 enum vfs_fallocate_flags {
510 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
511 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
515 Available VFS operations. These values must be in sync with vfs_ops struct
516 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
517 In particular, if new operations are added to vfs_ops, appropriate constants
518 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
520 struct shadow_copy_data;
522 struct vfs_fn_pointers {
523 /* Disk operations */
525 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
526 void (*disconnect_fn)(struct vfs_handle_struct *handle);
527 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
528 uint64_t *dfree, uint64_t *dsize);
529 int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
530 enum SMB_QUOTA_TYPE qtype, unid_t id,
532 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
533 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
534 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
535 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
538 * Note: that "struct dfs_GetDFSReferral *r"
539 * needs to be a valid TALLOC_CTX
541 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
542 struct dfs_GetDFSReferral *r);
544 /* Directory operations */
546 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32_t attributes);
547 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
548 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
550 SMB_STRUCT_STAT *sbuf);
551 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
552 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
553 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
554 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
555 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
556 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
557 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
559 /* File operations */
561 int (*open_fn)(struct vfs_handle_struct *handle,
562 struct smb_filename *smb_fname, files_struct *fsp,
563 int flags, mode_t mode);
564 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
565 struct smb_request *req,
566 uint16_t root_dir_fid,
567 struct smb_filename *smb_fname,
568 uint32_t access_mask,
569 uint32_t share_access,
570 uint32_t create_disposition,
571 uint32_t create_options,
572 uint32_t file_attributes,
573 uint32_t oplock_request,
574 struct smb2_lease *lease,
575 uint64_t allocation_size,
576 uint32_t private_flags,
577 struct security_descriptor *sd,
578 struct ea_list *ea_list,
579 files_struct **result,
581 const struct smb2_create_blobs *in_context_blobs,
582 struct smb2_create_blobs *out_context_blobs);
583 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
584 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
585 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
586 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
588 struct tevent_context *ev,
589 struct files_struct *fsp,
591 size_t n, off_t offset);
592 ssize_t (*pread_recv_fn)(struct tevent_req *req, int *err);
593 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
594 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
595 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
597 struct tevent_context *ev,
598 struct files_struct *fsp,
600 size_t n, off_t offset);
601 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, int *err);
602 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
603 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
604 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
605 int (*rename_fn)(struct vfs_handle_struct *handle,
606 const struct smb_filename *smb_fname_src,
607 const struct smb_filename *smb_fname_dst);
608 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
609 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
611 struct tevent_context *ev,
612 struct files_struct *fsp);
613 int (*fsync_recv_fn)(struct tevent_req *req, int *err);
614 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
615 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
616 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
617 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
618 int (*unlink_fn)(struct vfs_handle_struct *handle,
619 const struct smb_filename *smb_fname);
620 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
621 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
622 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
623 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
624 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
625 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
626 char *(*getwd_fn)(struct vfs_handle_struct *handle);
627 int (*ntimes_fn)(struct vfs_handle_struct *handle,
628 const struct smb_filename *smb_fname,
629 struct smb_file_time *ft);
630 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
631 int (*fallocate_fn)(struct vfs_handle_struct *handle,
632 struct files_struct *fsp,
636 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
637 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
638 uint32_t share_mode, uint32_t access_mask);
639 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
640 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
641 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
642 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
643 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
644 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
645 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
646 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
647 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
648 const SMB_STRUCT_STAT *sbuf);
649 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
651 struct tevent_context *ev,
652 struct files_struct *src_fsp,
654 struct files_struct *dest_fsp,
657 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
658 struct tevent_req *req,
660 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
662 struct files_struct *fsp,
663 struct smb_filename *smb_fname,
664 uint16_t *_compression_fmt);
665 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
667 struct files_struct *fsp,
668 uint16_t compression_fmt);
669 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
671 const char *service_path,
673 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
675 const char *base_volume,
680 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
685 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
686 struct files_struct *fsp,
689 unsigned int *num_streams,
690 struct stream_struct **streams);
692 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
698 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
699 const char *filename);
701 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
702 struct byte_range_lock *br_lck,
703 struct lock_struct *plock,
706 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
707 struct messaging_context *msg_ctx,
708 struct byte_range_lock *br_lck,
709 const struct lock_struct *plock);
711 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
712 struct byte_range_lock *br_lck,
713 struct lock_struct *plock);
715 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
716 struct files_struct *fsp,
717 struct lock_struct *plock);
719 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
720 struct files_struct *fsp,
721 struct lock_struct *plock);
723 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
725 enum vfs_translate_direction direction,
729 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
730 struct files_struct *fsp,
734 const uint8_t *_in_data,
737 uint32_t max_out_len,
740 /* NT ACL operations. */
742 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
743 struct files_struct *fsp,
744 uint32_t security_info,
746 struct security_descriptor **ppdesc);
747 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
749 uint32_t security_info,
751 struct security_descriptor **ppdesc);
752 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
753 struct files_struct *fsp,
754 uint32_t security_info_sent,
755 const struct security_descriptor *psd);
757 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
758 struct smb_filename *file,
759 struct security_acl *sacl,
760 uint32_t access_requested,
761 uint32_t access_denied);
763 /* POSIX ACL operations. */
765 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
766 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
768 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
771 TALLOC_CTX *mem_ctx);
772 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
773 struct files_struct *fsp,
774 TALLOC_CTX *mem_ctx);
775 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
778 char **blob_description,
780 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
781 TALLOC_CTX *mem_ctx, char **blob_description,
783 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
784 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
785 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
788 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
789 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
790 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
791 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
792 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
793 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
794 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
795 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
798 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
800 /* offline operations */
801 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
802 const struct smb_filename *fname,
803 SMB_STRUCT_STAT *sbuf);
804 int (*set_offline_fn)(struct vfs_handle_struct *handle,
805 const struct smb_filename *fname);
807 /* durable handle operations */
808 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
809 struct files_struct *fsp,
812 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
813 struct files_struct *fsp,
814 const DATA_BLOB old_cookie,
816 DATA_BLOB *new_cookie);
817 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
818 struct smb_request *smb1req,
819 struct smbXsrv_open *op,
820 const DATA_BLOB old_cookie,
822 struct files_struct **fsp,
823 DATA_BLOB *new_cookie);
825 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
826 const struct smb_filename *fname,
828 struct readdir_attr_data **attr_data);
832 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
833 which describes all operations this module is willing to intercept.
834 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
835 using this information.
838 typedef struct vfs_handle_struct {
839 struct vfs_handle_struct *next, *prev;
841 struct connection_struct *conn;
842 const struct vfs_fn_pointers *fns;
844 void (*free_data)(void **data);
848 typedef struct vfs_statvfs_struct {
849 /* For undefined recommended transfer size return -1 in that field */
850 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
854 The next three fields are in terms of the block size.
855 (above). If block size is unknown, 4096 would be a
856 reasonable block size for a server to report.
857 Note that returning the blocks/blocksavail removes need
858 to make a second call (to QFSInfo level 0x103 to get this info.
859 UserBlockAvail is typically less than or equal to BlocksAvail,
860 if no distinction is made return the same value in each.
863 uint64_t TotalBlocks;
864 uint64_t BlocksAvail; /* bfree */
865 uint64_t UserBlocksAvail; /* bavail */
867 /* For undefined Node fields or FSID return -1 */
868 uint64_t TotalFileNodes;
869 uint64_t FreeFileNodes;
870 uint64_t FsIdentifier; /* fsid */
871 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
872 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
875 } vfs_statvfs_struct;
877 /* Add a new FSP extension of the given type. Returns a pointer to the
880 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
881 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
883 /* Return a pointer to the existing FSP extension data. */
884 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
885 vfs_fetch_fsp_extension(handle, (fsp))
887 /* Return the talloc context associated with an FSP extension. */
888 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
889 vfs_memctx_fsp_extension(handle, (fsp))
891 /* Remove and destroy an FSP extension. */
892 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
893 vfs_remove_fsp_extension((handle), (fsp))
895 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
896 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
897 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
902 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
904 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
907 if ((handle)->free_data) { \
908 (handle)->free_data(&(handle)->data); \
910 (handle)->data = (void *)datap; \
911 (handle)->free_data = free_fn; \
915 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
916 if ((handle) && (handle)->free_data) { \
917 (handle)->free_data(&(handle)->data); \
921 /* Check whether module-specific data handle was already allocated or not */
922 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
924 #define SMB_VFS_OP(x) ((void *) x)
926 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
928 #include "vfs_macros.h"
930 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
931 const char *service, const char *user);
932 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
933 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
934 const char *path, uint64_t *bsize,
935 uint64_t *dfree, uint64_t *dsize);
936 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
937 enum SMB_QUOTA_TYPE qtype, unid_t id,
939 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
940 enum SMB_QUOTA_TYPE qtype, unid_t id,
942 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
943 struct files_struct *fsp,
944 struct shadow_copy_data *shadow_copy_data,
946 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
947 struct vfs_statvfs_struct *statbuf);
948 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
949 enum timestamp_set_resolution *p_ts_res);
951 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
953 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
954 struct dfs_GetDFSReferral *r);
955 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
956 const char *fname, const char *mask,
957 uint32_t attributes);
958 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
959 struct files_struct *fsp,
961 uint32_t attributes);
962 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
964 SMB_STRUCT_STAT *sbuf);
965 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
966 DIR *dirp, long offset);
967 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
969 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
971 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
973 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
974 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
976 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
978 int smb_vfs_call_open(struct vfs_handle_struct *handle,
979 struct smb_filename *smb_fname, struct files_struct *fsp,
980 int flags, mode_t mode);
981 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
982 struct smb_request *req,
983 uint16_t root_dir_fid,
984 struct smb_filename *smb_fname,
985 uint32_t access_mask,
986 uint32_t share_access,
987 uint32_t create_disposition,
988 uint32_t create_options,
989 uint32_t file_attributes,
990 uint32_t oplock_request,
991 struct smb2_lease *lease,
992 uint64_t allocation_size,
993 uint32_t private_flags,
994 struct security_descriptor *sd,
995 struct ea_list *ea_list,
996 files_struct **result,
998 const struct smb2_create_blobs *in_context_blobs,
999 struct smb2_create_blobs *out_context_blobs);
1000 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1001 struct files_struct *fsp);
1002 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1003 struct files_struct *fsp, void *data, size_t n);
1004 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1005 struct files_struct *fsp, void *data, size_t n,
1007 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1008 TALLOC_CTX *mem_ctx,
1009 struct tevent_context *ev,
1010 struct files_struct *fsp,
1012 size_t n, off_t offset);
1013 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, int *perrno);
1015 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1016 struct files_struct *fsp, const void *data,
1018 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1019 struct files_struct *fsp, const void *data,
1020 size_t n, off_t offset);
1021 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1022 TALLOC_CTX *mem_ctx,
1023 struct tevent_context *ev,
1024 struct files_struct *fsp,
1026 size_t n, off_t offset);
1027 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, int *perrno);
1029 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1030 struct files_struct *fsp, off_t offset,
1032 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1033 files_struct *fromfsp, const DATA_BLOB *header,
1034 off_t offset, size_t count);
1035 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1036 files_struct *tofsp, off_t offset,
1038 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1039 const struct smb_filename *smb_fname_src,
1040 const struct smb_filename *smb_fname_dst);
1041 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1042 struct files_struct *fsp);
1044 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1045 TALLOC_CTX *mem_ctx,
1046 struct tevent_context *ev,
1047 struct files_struct *fsp);
1048 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, int *perrno);
1050 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1051 struct smb_filename *smb_fname);
1052 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1053 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1054 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1055 struct smb_filename *smb_filename);
1056 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1057 struct files_struct *fsp,
1058 const SMB_STRUCT_STAT *sbuf);
1059 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1060 const struct smb_filename *smb_fname);
1061 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
1063 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1064 struct files_struct *fsp, mode_t mode);
1065 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
1066 uid_t uid, gid_t gid);
1067 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1068 struct files_struct *fsp, uid_t uid, gid_t gid);
1069 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
1070 uid_t uid, gid_t gid);
1071 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1072 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1073 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1074 const struct smb_filename *smb_fname,
1075 struct smb_file_time *ft);
1076 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1077 struct files_struct *fsp, off_t offset);
1078 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1079 struct files_struct *fsp,
1083 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1084 struct files_struct *fsp, int op, off_t offset,
1085 off_t count, int type);
1086 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1087 struct files_struct *fsp, uint32_t share_mode,
1088 uint32_t access_mask);
1089 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1090 struct files_struct *fsp, int leasetype);
1091 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1092 struct files_struct *fsp, off_t *poffset,
1093 off_t *pcount, int *ptype, pid_t *ppid);
1094 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1095 const char *newpath);
1096 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1097 const char *path, char *buf, size_t bufsiz);
1098 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1099 const char *newpath);
1100 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1101 mode_t mode, SMB_DEV_T dev);
1102 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1103 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1104 unsigned int flags);
1105 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1106 const SMB_STRUCT_STAT *sbuf);
1107 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1108 struct files_struct *fsp,
1110 TALLOC_CTX *mem_ctx,
1111 unsigned int *num_streams,
1112 struct stream_struct **streams);
1113 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1114 const char *path, const char *name,
1115 TALLOC_CTX *mem_ctx, char **found_name);
1116 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1117 const char *filename);
1118 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1119 struct byte_range_lock *br_lck,
1120 struct lock_struct *plock,
1121 bool blocking_lock);
1122 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1123 struct messaging_context *msg_ctx,
1124 struct byte_range_lock *br_lck,
1125 const struct lock_struct *plock);
1126 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1127 struct byte_range_lock *br_lck,
1128 struct lock_struct *plock);
1129 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1130 struct files_struct *fsp,
1131 struct lock_struct *plock);
1132 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1133 struct files_struct *fsp,
1134 struct lock_struct *plock);
1135 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1137 enum vfs_translate_direction direction,
1138 TALLOC_CTX *mem_ctx,
1139 char **mapped_name);
1140 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1141 struct files_struct *fsp,
1145 const uint8_t *_in_data,
1147 uint8_t **_out_data,
1148 uint32_t max_out_len,
1150 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1151 TALLOC_CTX *mem_ctx,
1152 struct tevent_context *ev,
1153 struct files_struct *src_fsp,
1155 struct files_struct *dest_fsp,
1158 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1159 struct tevent_req *req,
1161 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1162 TALLOC_CTX *mem_ctx,
1163 struct files_struct *fsp,
1164 struct smb_filename *smb_fname,
1165 uint16_t *_compression_fmt);
1166 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1167 TALLOC_CTX *mem_ctx,
1168 struct files_struct *fsp,
1169 uint16_t compression_fmt);
1170 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1171 TALLOC_CTX *mem_ctx,
1172 const char *service_path,
1173 char **base_volume);
1174 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1175 TALLOC_CTX *mem_ctx,
1176 const char *base_volume,
1181 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1182 TALLOC_CTX *mem_ctx,
1185 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1186 struct files_struct *fsp,
1187 uint32_t security_info,
1188 TALLOC_CTX *mem_ctx,
1189 struct security_descriptor **ppdesc);
1190 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1192 uint32_t security_info,
1193 TALLOC_CTX *mem_ctx,
1194 struct security_descriptor **ppdesc);
1195 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1196 struct files_struct *fsp,
1197 uint32_t security_info_sent,
1198 const struct security_descriptor *psd);
1199 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1200 struct smb_filename *file,
1201 struct security_acl *sacl,
1202 uint32_t access_requested,
1203 uint32_t access_denied);
1204 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
1206 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1207 struct files_struct *fsp, mode_t mode);
1208 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1210 SMB_ACL_TYPE_T type,
1211 TALLOC_CTX *mem_ctx);
1212 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1213 struct files_struct *fsp,
1214 TALLOC_CTX *mem_ctx);
1215 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1217 TALLOC_CTX *mem_ctx,
1218 char **blob_description,
1220 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1221 struct files_struct *fsp,
1222 TALLOC_CTX *mem_ctx,
1223 char **blob_description,
1225 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1226 const char *name, SMB_ACL_TYPE_T acltype,
1228 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1229 struct files_struct *fsp, SMB_ACL_T theacl);
1230 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1232 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1233 const char *path, const char *name, void *value,
1235 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1236 struct files_struct *fsp, const char *name,
1237 void *value, size_t size);
1238 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1239 const char *path, char *list, size_t size);
1240 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1241 const char *path, char *list, size_t size);
1242 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1243 struct files_struct *fsp, char *list,
1245 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1246 const char *path, const char *name);
1247 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1248 struct files_struct *fsp, const char *name);
1249 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1250 const char *name, const void *value, size_t size,
1252 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1253 const char *name, const void *value, size_t size,
1255 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1256 struct files_struct *fsp, const char *name,
1257 const void *value, size_t size, int flags);
1258 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1259 struct files_struct *fsp);
1260 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1261 const struct smb_filename *fname,
1262 SMB_STRUCT_STAT *sbuf);
1263 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1264 const struct smb_filename *fname);
1265 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1266 struct files_struct *fsp,
1267 TALLOC_CTX *mem_ctx,
1269 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1270 struct files_struct *fsp,
1271 const DATA_BLOB old_cookie,
1272 TALLOC_CTX *mem_ctx,
1273 DATA_BLOB *new_cookie);
1274 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1275 struct smb_request *smb1req,
1276 struct smbXsrv_open *op,
1277 const DATA_BLOB old_cookie,
1278 TALLOC_CTX *mem_ctx,
1279 struct files_struct **fsp,
1280 DATA_BLOB *new_cookie);
1281 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1282 const struct smb_filename *fname,
1283 TALLOC_CTX *mem_ctx,
1284 struct readdir_attr_data **attr_data);
1286 NTSTATUS smb_register_vfs(int version, const char *name,
1287 const struct vfs_fn_pointers *fns);
1288 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1289 files_struct *fsp, size_t ext_size,
1290 void (*destroy_fn)(void *p_data));
1291 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1292 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1293 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1294 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);