2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
29 /* Avoid conflict with an AIX include file */
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
45 * If you change anything here, please also update modules/vfs_full_audit.c.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205 to const struct smb_filename * */
206 /* Version 37 - Change sys_acl_set_file from const char *
207 to const struct smb_filename * */
208 /* Version 37 - Change listxattr from const char *
209 to const struct smb_filename * */
210 /* Version 37 - Change removexattr from const char *
211 to const struct smb_filename * */
212 /* Version 37 - Change setxattr from const char *
213 to const struct smb_filename * */
214 /* Version 37 - Change getxattr from const char *
215 to const struct smb_filename * */
216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
217 /* Version 37 - Change chflags from const char *
218 to const struct smb_filename * */
219 /* Version 37 - Change disk_free from const char *
220 to const struct smb_filename * */
221 /* Version 37 - Change get_quota from const char *
222 to const struct smb_filename * */
223 /* Version 37 - Change link from const char *
224 to const struct smb_filename * */
225 /* Version 37 - Change statvfs from const char *
226 to const struct smb_filename * */
227 /* Version 37 - Change readlink from const char *
228 to const struct smb_filename * */
229 /* Version 37 - Change symlink from const char *
230 to const struct smb_filename * */
231 /* Version 37 - Change chdir from const char *
232 to const struct smb_filename * */
234 #define SMB_VFS_INTERFACE_VERSION 37
237 All intercepted VFS operations must be declared as static functions inside module source
238 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
239 example VFS modules for more details.
242 /* VFS operations structure */
244 struct vfs_handle_struct
;
245 struct connection_struct
;
247 struct security_descriptor
;
248 struct vfs_statvfs_struct
;
251 struct smb_file_time
;
252 struct blocking_lock_record
;
254 struct dfs_GetDFSReferral
;
256 typedef union unid_t
{
264 uint64_t position_information
;
266 uint32_t private_options
; /* NT Create options, but we only look at
267 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
268 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
269 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
270 * for print files *only*, where
271 * DELETE_ON_CLOSE is not stored in the share
274 unsigned long gen_id
;
279 struct smbd_server_connection
*sconn
;
280 struct tevent_timer
*timeout
;
281 struct smb2_lease lease
;
284 typedef struct files_struct
{
285 struct files_struct
*next
, *prev
;
287 struct smbXsrv_open
*op
;
288 struct connection_struct
*conn
;
289 struct fd_handle
*fh
;
290 unsigned int num_smb_operations
;
291 struct file_id file_id
;
292 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
294 uint64_t vuid
; /* SMB2 compat */
295 struct write_cache
*wcp
;
296 struct timeval open_time
;
297 uint32_t access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
298 uint32_t share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
300 bool kernel_share_modes_taken
;
302 bool update_write_time_triggered
;
303 struct tevent_timer
*update_write_time_event
;
304 bool update_write_time_on_close
;
305 struct timespec close_write_time
;
306 bool write_time_forced
;
309 struct fsp_lease
*lease
;
310 int sent_oplock_break
;
311 struct tevent_timer
*oplock_timeout
;
312 struct lock_struct last_lock_failure
;
313 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
320 bool aio_write_behind
;
321 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
322 bool delete_on_close
;
323 uint64_t posix_flags
;
325 bool backup_intent
; /* Handle was successfully opened with backup intent
326 and opener has privilege to do so. */
327 bool aapl_copyfile_supported
;
328 bool use_ofd_locks
; /* Are we using open file description locks ? */
329 struct smb_filename
*fsp_name
;
330 uint32_t name_hash
; /* Jenkins hash of full pathname. */
331 uint64_t mid
; /* Mid of the operation that created us. */
333 struct vfs_fsp_data
*vfs_extension
;
334 struct fake_file_handle
*fake_file_handle
;
336 struct notify_change_buf
*notify
;
338 struct files_struct
*base_fsp
; /* placeholder for delete on close */
341 * Read-only cached brlock record, thrown away when the
342 * brlock.tdb seqnum changes. This avoids fetching data from
343 * the brlock.tdb on every read/write call.
346 struct byte_range_lock
*brlock_rec
;
348 struct dptr_struct
*dptr
;
350 /* if not NULL, means this is a print file */
351 struct print_file_data
*print_file
;
353 unsigned num_aio_requests
;
354 struct tevent_req
**aio_requests
;
357 * If a close request comes in while we still have aio_requests
358 * around, we need to hold back the close. When all aio_requests are
359 * done, the aio completion routines need tevent_wait_done() on
360 * this. A bit ugly, but before we have close_file() fully async
361 * possibly the simplest approach. Thanks, Jeremy for the idea.
363 struct tevent_req
*deferred_close
;
366 #define FSP_POSIX_FLAGS_OPEN 0x01
367 #define FSP_POSIX_FLAGS_RENAME 0x02
368 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
370 #define FSP_POSIX_FLAGS_ALL \
371 (FSP_POSIX_FLAGS_OPEN | \
372 FSP_POSIX_FLAGS_PATHNAMES | \
373 FSP_POSIX_FLAGS_RENAME)
375 struct vuid_cache_entry
{
376 struct auth_session_info
*session_info
;
377 uint64_t vuid
; /* SMB2 compat */
379 uint32_t share_access
;
383 unsigned int next_entry
;
384 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
390 } name_compare_entry
;
392 struct dfree_cached_info
{
393 time_t last_dfree_time
;
400 struct share_params
{
404 typedef struct connection_struct
{
405 struct connection_struct
*next
, *prev
;
406 struct smbd_server_connection
*sconn
; /* can be NULL */
407 struct smbXsrv_tcon
*tcon
; /* can be NULL */
408 uint32_t cnum
; /* an index passed over the wire */
409 struct share_params
*params
;
411 struct vuid_cache
*vuid_cache
;
414 bool read_only
; /* Attributes for the current user of the share. */
415 uint32_t share_access
;
416 /* Does this filesystem honor
417 sub second timestamps on files
418 and directories when setting time ? */
419 enum timestamp_set_resolution ts_res
;
422 char *cwd
; /* Working directory. */
424 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
427 * This represents the user information on this connection. Depending
428 * on the vuid using this tid, this might change per SMB request.
430 struct auth_session_info
*session_info
;
433 * If the "force group" parameter is set, this is the primary gid that
434 * may be used in the users token, depending on the vuid using this tid.
436 gid_t force_group_gid
;
438 uint64_t vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
441 time_t lastused_count
;
443 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
447 /* Semantics requested by the client or forced by the server config. */
450 bool short_case_preserve
;
452 /* Semantics provided by the underlying filesystem. */
454 /* Device number of the directory of the share mount.
455 Used to ensure unique FileIndex returns. */
456 SMB_DEV_T base_share_dev
;
458 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
459 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
460 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
461 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
462 struct dfree_cached_info
*dfree_info
;
463 struct trans_state
*pending_trans
;
465 struct rpc_pipe_client
*spoolss_pipe
;
469 struct smbd_smb2_request
;
470 struct privilege_paths
;
476 uint64_t mid
; /* For compatibility with SMB2. */
478 uint64_t vuid
; /* For compatibility with SMB2. */
484 const uint8_t *inbuf
;
487 * Async handling in the main smb processing loop is directed by
488 * outbuf: reply_xxx routines indicate sync behaviour by putting their
489 * reply into "outbuf". If they leave it as NULL, they take care of it
490 * themselves, possibly later.
492 * If async handling is wanted, the reply_xxx routine must make sure
493 * that it talloc_move()s the smb_req somewhere else.
499 connection_struct
*conn
;
500 struct smbd_server_connection
*sconn
;
501 struct smbXsrv_connection
*xconn
;
502 struct smb_perfcount_data pcd
;
505 * Chained request handling
507 struct files_struct
*chain_fsp
;
510 * state information for async smb handling
515 * Back pointer to smb2 request.
517 struct smbd_smb2_request
*smb2req
;
520 * Pathnames used if request done
523 struct privilege_paths
*priv_paths
;
526 * Request list for chained requests, we're part of it.
528 struct smb_request
**chain
;
530 struct timeval request_time
;
532 bool posix_pathnames
;
536 * Info about an alternate data stream
539 struct stream_struct
{
546 struct smb_file_time
{
547 struct timespec mtime
;
548 struct timespec atime
;
549 struct timespec ctime
;
550 struct timespec create_time
;
556 struct smb_filename
{
559 char *original_lcomp
;
565 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
566 * to keep the numeric values consistent.
569 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
571 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
572 handle = handle->next; \
575 enum vfs_translate_direction
{
576 vfs_translate_to_unix
= 0,
577 vfs_translate_to_windows
580 enum vfs_fallocate_flags
{
581 VFS_FALLOCATE_FL_KEEP_SIZE
= 0x0001,
582 VFS_FALLOCATE_FL_PUNCH_HOLE
= 0x0002,
586 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
587 * be handled as a COW clone, AKA reflink.
588 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
590 enum vfs_copy_chunk_flags
{
591 VFS_COPY_CHUNK_FL_MUST_CLONE
= 0x0001,
592 VFS_COPY_CHUNK_FL_IGNORE_LOCKS
= 0x0002,
594 VFS_COPY_CHUNK_FL_MASK_ALL
=
595 (VFS_COPY_CHUNK_FL_MUST_CLONE
596 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS
),
599 struct vfs_aio_state
{
605 Available VFS operations. These values must be in sync with vfs_ops struct
606 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
607 In particular, if new operations are added to vfs_ops, appropriate constants
608 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
610 struct shadow_copy_data
;
612 struct vfs_fn_pointers
{
613 /* Disk operations */
615 int (*connect_fn
)(struct vfs_handle_struct
*handle
, const char *service
, const char *user
);
616 void (*disconnect_fn
)(struct vfs_handle_struct
*handle
);
617 uint64_t (*disk_free_fn
)(struct vfs_handle_struct
*handle
,
618 const struct smb_filename
*smb_fname
,
622 int (*get_quota_fn
)(struct vfs_handle_struct
*handle
,
623 const struct smb_filename
*smb_fname
,
624 enum SMB_QUOTA_TYPE qtype
,
627 int (*set_quota_fn
)(struct vfs_handle_struct
*handle
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*qt
);
628 int (*get_shadow_copy_data_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, struct shadow_copy_data
*shadow_copy_data
, bool labels
);
629 int (*statvfs_fn
)(struct vfs_handle_struct
*handle
,
630 const struct smb_filename
*smb_fname
,
631 struct vfs_statvfs_struct
*statbuf
);
632 uint32_t (*fs_capabilities_fn
)(struct vfs_handle_struct
*handle
, enum timestamp_set_resolution
*p_ts_res
);
635 * Note: that "struct dfs_GetDFSReferral *r"
636 * needs to be a valid TALLOC_CTX
638 NTSTATUS (*get_dfs_referrals_fn
)(struct vfs_handle_struct
*handle
,
639 struct dfs_GetDFSReferral
*r
);
641 /* Directory operations */
643 DIR *(*opendir_fn
)(struct vfs_handle_struct
*handle
,
644 const struct smb_filename
*smb_fname
,
646 uint32_t attributes
);
647 DIR *(*fdopendir_fn
)(struct vfs_handle_struct
*handle
, files_struct
*fsp
, const char *mask
, uint32_t attributes
);
648 struct dirent
*(*readdir_fn
)(struct vfs_handle_struct
*handle
,
650 SMB_STRUCT_STAT
*sbuf
);
651 void (*seekdir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
, long offset
);
652 long (*telldir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
653 void (*rewind_dir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
654 int (*mkdir_fn
)(struct vfs_handle_struct
*handle
,
655 const struct smb_filename
*smb_fname
,
657 int (*rmdir_fn
)(struct vfs_handle_struct
*handle
,
658 const struct smb_filename
*smb_fname
);
659 int (*closedir_fn
)(struct vfs_handle_struct
*handle
, DIR *dir
);
660 void (*init_search_op_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
662 /* File operations */
664 int (*open_fn
)(struct vfs_handle_struct
*handle
,
665 struct smb_filename
*smb_fname
, files_struct
*fsp
,
666 int flags
, mode_t mode
);
667 NTSTATUS (*create_file_fn
)(struct vfs_handle_struct
*handle
,
668 struct smb_request
*req
,
669 uint16_t root_dir_fid
,
670 struct smb_filename
*smb_fname
,
671 uint32_t access_mask
,
672 uint32_t share_access
,
673 uint32_t create_disposition
,
674 uint32_t create_options
,
675 uint32_t file_attributes
,
676 uint32_t oplock_request
,
677 struct smb2_lease
*lease
,
678 uint64_t allocation_size
,
679 uint32_t private_flags
,
680 struct security_descriptor
*sd
,
681 struct ea_list
*ea_list
,
682 files_struct
**result
,
684 const struct smb2_create_blobs
*in_context_blobs
,
685 struct smb2_create_blobs
*out_context_blobs
);
686 int (*close_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
687 ssize_t (*read_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, void *data
, size_t n
);
688 ssize_t (*pread_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, void *data
, size_t n
, off_t offset
);
689 struct tevent_req
*(*pread_send_fn
)(struct vfs_handle_struct
*handle
,
691 struct tevent_context
*ev
,
692 struct files_struct
*fsp
,
694 size_t n
, off_t offset
);
695 ssize_t (*pread_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
696 ssize_t (*write_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const void *data
, size_t n
);
697 ssize_t (*pwrite_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const void *data
, size_t n
, off_t offset
);
698 struct tevent_req
*(*pwrite_send_fn
)(struct vfs_handle_struct
*handle
,
700 struct tevent_context
*ev
,
701 struct files_struct
*fsp
,
703 size_t n
, off_t offset
);
704 ssize_t (*pwrite_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
705 off_t (*lseek_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t offset
, int whence
);
706 ssize_t (*sendfile_fn
)(struct vfs_handle_struct
*handle
, int tofd
, files_struct
*fromfsp
, const DATA_BLOB
*header
, off_t offset
, size_t count
);
707 ssize_t (*recvfile_fn
)(struct vfs_handle_struct
*handle
, int fromfd
, files_struct
*tofsp
, off_t offset
, size_t count
);
708 int (*rename_fn
)(struct vfs_handle_struct
*handle
,
709 const struct smb_filename
*smb_fname_src
,
710 const struct smb_filename
*smb_fname_dst
);
711 int (*fsync_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
712 struct tevent_req
*(*fsync_send_fn
)(struct vfs_handle_struct
*handle
,
714 struct tevent_context
*ev
,
715 struct files_struct
*fsp
);
716 int (*fsync_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
717 int (*stat_fn
)(struct vfs_handle_struct
*handle
, struct smb_filename
*smb_fname
);
718 int (*fstat_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, SMB_STRUCT_STAT
*sbuf
);
719 int (*lstat_fn
)(struct vfs_handle_struct
*handle
, struct smb_filename
*smb_filename
);
720 uint64_t (*get_alloc_size_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const SMB_STRUCT_STAT
*sbuf
);
721 int (*unlink_fn
)(struct vfs_handle_struct
*handle
,
722 const struct smb_filename
*smb_fname
);
723 int (*chmod_fn
)(struct vfs_handle_struct
*handle
,
724 const struct smb_filename
*smb_fname
,
726 int (*fchmod_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, mode_t mode
);
727 int (*chown_fn
)(struct vfs_handle_struct
*handle
,
728 const struct smb_filename
*smb_fname
,
731 int (*fchown_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, uid_t uid
, gid_t gid
);
732 int (*lchown_fn
)(struct vfs_handle_struct
*handle
,
733 const struct smb_filename
*smb_fname
,
736 int (*chdir_fn
)(struct vfs_handle_struct
*handle
,
737 const struct smb_filename
*smb_fname
);
738 char *(*getwd_fn
)(struct vfs_handle_struct
*handle
);
739 int (*ntimes_fn
)(struct vfs_handle_struct
*handle
,
740 const struct smb_filename
*smb_fname
,
741 struct smb_file_time
*ft
);
742 int (*ftruncate_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t offset
);
743 int (*fallocate_fn
)(struct vfs_handle_struct
*handle
,
744 struct files_struct
*fsp
,
748 bool (*lock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, int op
, off_t offset
, off_t count
, int type
);
749 int (*kernel_flock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
,
750 uint32_t share_mode
, uint32_t access_mask
);
751 int (*linux_setlease_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, int leasetype
);
752 bool (*getlock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t
*poffset
, off_t
*pcount
, int *ptype
, pid_t
*ppid
);
753 int (*symlink_fn
)(struct vfs_handle_struct
*handle
,
754 const char *link_contents
,
755 const struct smb_filename
*new_smb_fname
);
756 int (*readlink_fn
)(struct vfs_handle_struct
*handle
,
757 const struct smb_filename
*smb_fname
,
760 int (*link_fn
)(struct vfs_handle_struct
*handle
,
761 const struct smb_filename
*old_smb_fname
,
762 const struct smb_filename
*new_smb_fname
);
763 int (*mknod_fn
)(struct vfs_handle_struct
*handle
,
764 const struct smb_filename
*smb_fname
,
767 char *(*realpath_fn
)(struct vfs_handle_struct
*handle
, const char *path
);
768 int (*chflags_fn
)(struct vfs_handle_struct
*handle
,
769 const struct smb_filename
*smb_fname
,
771 struct file_id (*file_id_create_fn
)(struct vfs_handle_struct
*handle
,
772 const SMB_STRUCT_STAT
*sbuf
);
773 struct tevent_req
*(*copy_chunk_send_fn
)(struct vfs_handle_struct
*handle
,
775 struct tevent_context
*ev
,
776 struct files_struct
*src_fsp
,
778 struct files_struct
*dest_fsp
,
782 NTSTATUS (*copy_chunk_recv_fn
)(struct vfs_handle_struct
*handle
,
783 struct tevent_req
*req
,
785 NTSTATUS (*get_compression_fn
)(struct vfs_handle_struct
*handle
,
787 struct files_struct
*fsp
,
788 struct smb_filename
*smb_fname
,
789 uint16_t *_compression_fmt
);
790 NTSTATUS (*set_compression_fn
)(struct vfs_handle_struct
*handle
,
792 struct files_struct
*fsp
,
793 uint16_t compression_fmt
);
794 NTSTATUS (*snap_check_path_fn
)(struct vfs_handle_struct
*handle
,
796 const char *service_path
,
798 NTSTATUS (*snap_create_fn
)(struct vfs_handle_struct
*handle
,
800 const char *base_volume
,
805 NTSTATUS (*snap_delete_fn
)(struct vfs_handle_struct
*handle
,
810 NTSTATUS (*streaminfo_fn
)(struct vfs_handle_struct
*handle
,
811 struct files_struct
*fsp
,
812 const struct smb_filename
*smb_fname
,
814 unsigned int *num_streams
,
815 struct stream_struct
**streams
);
817 int (*get_real_filename_fn
)(struct vfs_handle_struct
*handle
,
823 const char *(*connectpath_fn
)(struct vfs_handle_struct
*handle
,
824 const char *filename
);
826 NTSTATUS (*brl_lock_windows_fn
)(struct vfs_handle_struct
*handle
,
827 struct byte_range_lock
*br_lck
,
828 struct lock_struct
*plock
,
831 bool (*brl_unlock_windows_fn
)(struct vfs_handle_struct
*handle
,
832 struct messaging_context
*msg_ctx
,
833 struct byte_range_lock
*br_lck
,
834 const struct lock_struct
*plock
);
836 bool (*brl_cancel_windows_fn
)(struct vfs_handle_struct
*handle
,
837 struct byte_range_lock
*br_lck
,
838 struct lock_struct
*plock
);
840 bool (*strict_lock_fn
)(struct vfs_handle_struct
*handle
,
841 struct files_struct
*fsp
,
842 struct lock_struct
*plock
);
844 void (*strict_unlock_fn
)(struct vfs_handle_struct
*handle
,
845 struct files_struct
*fsp
,
846 struct lock_struct
*plock
);
848 NTSTATUS (*translate_name_fn
)(struct vfs_handle_struct
*handle
,
850 enum vfs_translate_direction direction
,
854 NTSTATUS (*fsctl_fn
)(struct vfs_handle_struct
*handle
,
855 struct files_struct
*fsp
,
859 const uint8_t *_in_data
,
862 uint32_t max_out_len
,
865 NTSTATUS (*get_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
866 struct smb_filename
*smb_fname
,
869 NTSTATUS (*fget_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
870 struct files_struct
*fsp
,
873 NTSTATUS (*set_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
874 const struct smb_filename
*smb_fname
,
877 NTSTATUS (*fset_dos_attributes_fn
)(struct vfs_handle_struct
*hande
,
878 struct files_struct
*fsp
,
881 /* NT ACL operations. */
883 NTSTATUS (*fget_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
884 struct files_struct
*fsp
,
885 uint32_t security_info
,
887 struct security_descriptor
**ppdesc
);
888 NTSTATUS (*get_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
889 const struct smb_filename
*smb_fname
,
890 uint32_t security_info
,
892 struct security_descriptor
**ppdesc
);
893 NTSTATUS (*fset_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
894 struct files_struct
*fsp
,
895 uint32_t security_info_sent
,
896 const struct security_descriptor
*psd
);
898 NTSTATUS (*audit_file_fn
)(struct vfs_handle_struct
*handle
,
899 struct smb_filename
*file
,
900 struct security_acl
*sacl
,
901 uint32_t access_requested
,
902 uint32_t access_denied
);
904 /* POSIX ACL operations. */
906 int (*chmod_acl_fn
)(struct vfs_handle_struct
*handle
,
907 const struct smb_filename
*smb_fname
,
909 int (*fchmod_acl_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, mode_t mode
);
911 SMB_ACL_T (*sys_acl_get_file_fn
)(struct vfs_handle_struct
*handle
,
912 const struct smb_filename
*smb_fname
,
914 TALLOC_CTX
*mem_ctx
);
915 SMB_ACL_T (*sys_acl_get_fd_fn
)(struct vfs_handle_struct
*handle
,
916 struct files_struct
*fsp
,
917 TALLOC_CTX
*mem_ctx
);
918 int (*sys_acl_blob_get_file_fn
)(struct vfs_handle_struct
*handle
,
919 const struct smb_filename
*smb_fname
,
921 char **blob_description
,
923 int (*sys_acl_blob_get_fd_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
,
924 TALLOC_CTX
*mem_ctx
, char **blob_description
,
926 int (*sys_acl_set_file_fn
)(struct vfs_handle_struct
*handle
,
927 const struct smb_filename
*smb_fname
,
928 SMB_ACL_TYPE_T acltype
,
930 int (*sys_acl_set_fd_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, SMB_ACL_T theacl
);
931 int (*sys_acl_delete_def_file_fn
)(struct vfs_handle_struct
*handle
,
932 const struct smb_filename
*smb_fname
);
935 ssize_t (*getxattr_fn
)(struct vfs_handle_struct
*handle
,
936 const struct smb_filename
*smb_fname
,
940 ssize_t (*fgetxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
, void *value
, size_t size
);
941 ssize_t (*listxattr_fn
)(struct vfs_handle_struct
*handle
,
942 const struct smb_filename
*smb_fname
,
945 ssize_t (*flistxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, char *list
, size_t size
);
946 int (*removexattr_fn
)(struct vfs_handle_struct
*handle
,
947 const struct smb_filename
*smb_fname
,
949 int (*fremovexattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
);
950 int (*setxattr_fn
)(struct vfs_handle_struct
*handle
,
951 const struct smb_filename
*smb_fname
,
956 int (*fsetxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
, const void *value
, size_t size
, int flags
);
959 bool (*aio_force_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
961 /* durable handle operations */
962 NTSTATUS (*durable_cookie_fn
)(struct vfs_handle_struct
*handle
,
963 struct files_struct
*fsp
,
966 NTSTATUS (*durable_disconnect_fn
)(struct vfs_handle_struct
*handle
,
967 struct files_struct
*fsp
,
968 const DATA_BLOB old_cookie
,
970 DATA_BLOB
*new_cookie
);
971 NTSTATUS (*durable_reconnect_fn
)(struct vfs_handle_struct
*handle
,
972 struct smb_request
*smb1req
,
973 struct smbXsrv_open
*op
,
974 const DATA_BLOB old_cookie
,
976 struct files_struct
**fsp
,
977 DATA_BLOB
*new_cookie
);
979 NTSTATUS (*readdir_attr_fn
)(struct vfs_handle_struct
*handle
,
980 const struct smb_filename
*fname
,
982 struct readdir_attr_data
**attr_data
);
986 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
987 which describes all operations this module is willing to intercept.
988 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
989 using this information.
992 typedef struct vfs_handle_struct
{
993 struct vfs_handle_struct
*next
, *prev
;
995 struct connection_struct
*conn
;
996 const struct vfs_fn_pointers
*fns
;
998 void (*free_data
)(void **data
);
1002 typedef struct vfs_statvfs_struct
{
1003 /* For undefined recommended transfer size return -1 in that field */
1004 uint32_t OptimalTransferSize
; /* bsize on some os, iosize on other os */
1008 The next three fields are in terms of the block size.
1009 (above). If block size is unknown, 4096 would be a
1010 reasonable block size for a server to report.
1011 Note that returning the blocks/blocksavail removes need
1012 to make a second call (to QFSInfo level 0x103 to get this info.
1013 UserBlockAvail is typically less than or equal to BlocksAvail,
1014 if no distinction is made return the same value in each.
1017 uint64_t TotalBlocks
;
1018 uint64_t BlocksAvail
; /* bfree */
1019 uint64_t UserBlocksAvail
; /* bavail */
1021 /* For undefined Node fields or FSID return -1 */
1022 uint64_t TotalFileNodes
;
1023 uint64_t FreeFileNodes
;
1024 uint64_t FsIdentifier
; /* fsid */
1025 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1026 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1029 } vfs_statvfs_struct
;
1031 /* Add a new FSP extension of the given type. Returns a pointer to the
1034 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1035 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1037 /* Return a pointer to the existing FSP extension data. */
1038 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1039 vfs_fetch_fsp_extension(handle, (fsp))
1041 /* Return the talloc context associated with an FSP extension. */
1042 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1043 vfs_memctx_fsp_extension(handle, (fsp))
1045 /* Remove and destroy an FSP extension. */
1046 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1047 vfs_remove_fsp_extension((handle), (fsp))
1049 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1050 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1051 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1056 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1058 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1061 if ((handle)->free_data) { \
1062 (handle)->free_data(&(handle)->data); \
1064 (handle)->data = (void *)datap; \
1065 (handle)->free_data = free_fn; \
1069 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1070 if ((handle) && (handle)->free_data) { \
1071 (handle)->free_data(&(handle)->data); \
1075 /* Check whether module-specific data handle was already allocated or not */
1076 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1078 #define SMB_VFS_OP(x) ((void *) x)
1080 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1082 #include "vfs_macros.h"
1084 int smb_vfs_call_connect(struct vfs_handle_struct
*handle
,
1085 const char *service
, const char *user
);
1086 void smb_vfs_call_disconnect(struct vfs_handle_struct
*handle
);
1087 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct
*handle
,
1088 const struct smb_filename
*smb_filename
,
1092 int smb_vfs_call_get_quota(struct vfs_handle_struct
*handle
,
1093 const struct smb_filename
*smb_filename
,
1094 enum SMB_QUOTA_TYPE qtype
,
1096 SMB_DISK_QUOTA
*qt
);
1097 int smb_vfs_call_set_quota(struct vfs_handle_struct
*handle
,
1098 enum SMB_QUOTA_TYPE qtype
, unid_t id
,
1099 SMB_DISK_QUOTA
*qt
);
1100 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct
*handle
,
1101 struct files_struct
*fsp
,
1102 struct shadow_copy_data
*shadow_copy_data
,
1104 int smb_vfs_call_statvfs(struct vfs_handle_struct
*handle
,
1105 const struct smb_filename
*smb_fname
,
1106 struct vfs_statvfs_struct
*statbuf
);
1107 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct
*handle
,
1108 enum timestamp_set_resolution
*p_ts_res
);
1110 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1112 NTSTATUS
smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct
*handle
,
1113 struct dfs_GetDFSReferral
*r
);
1114 DIR *smb_vfs_call_opendir(struct vfs_handle_struct
*handle
,
1115 const struct smb_filename
*smb_fname
,
1117 uint32_t attributes
);
1118 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct
*handle
,
1119 struct files_struct
*fsp
,
1121 uint32_t attributes
);
1122 struct dirent
*smb_vfs_call_readdir(struct vfs_handle_struct
*handle
,
1124 SMB_STRUCT_STAT
*sbuf
);
1125 void smb_vfs_call_seekdir(struct vfs_handle_struct
*handle
,
1126 DIR *dirp
, long offset
);
1127 long smb_vfs_call_telldir(struct vfs_handle_struct
*handle
,
1129 void smb_vfs_call_rewind_dir(struct vfs_handle_struct
*handle
,
1131 int smb_vfs_call_mkdir(struct vfs_handle_struct
*handle
,
1132 const struct smb_filename
*smb_fname
,
1134 int smb_vfs_call_rmdir(struct vfs_handle_struct
*handle
,
1135 const struct smb_filename
*smb_fname
);
1136 int smb_vfs_call_closedir(struct vfs_handle_struct
*handle
,
1138 void smb_vfs_call_init_search_op(struct vfs_handle_struct
*handle
,
1140 int smb_vfs_call_open(struct vfs_handle_struct
*handle
,
1141 struct smb_filename
*smb_fname
, struct files_struct
*fsp
,
1142 int flags
, mode_t mode
);
1143 NTSTATUS
smb_vfs_call_create_file(struct vfs_handle_struct
*handle
,
1144 struct smb_request
*req
,
1145 uint16_t root_dir_fid
,
1146 struct smb_filename
*smb_fname
,
1147 uint32_t access_mask
,
1148 uint32_t share_access
,
1149 uint32_t create_disposition
,
1150 uint32_t create_options
,
1151 uint32_t file_attributes
,
1152 uint32_t oplock_request
,
1153 struct smb2_lease
*lease
,
1154 uint64_t allocation_size
,
1155 uint32_t private_flags
,
1156 struct security_descriptor
*sd
,
1157 struct ea_list
*ea_list
,
1158 files_struct
**result
,
1160 const struct smb2_create_blobs
*in_context_blobs
,
1161 struct smb2_create_blobs
*out_context_blobs
);
1162 int smb_vfs_call_close(struct vfs_handle_struct
*handle
,
1163 struct files_struct
*fsp
);
1164 ssize_t
smb_vfs_call_read(struct vfs_handle_struct
*handle
,
1165 struct files_struct
*fsp
, void *data
, size_t n
);
1166 ssize_t
smb_vfs_call_pread(struct vfs_handle_struct
*handle
,
1167 struct files_struct
*fsp
, void *data
, size_t n
,
1169 struct tevent_req
*smb_vfs_call_pread_send(struct vfs_handle_struct
*handle
,
1170 TALLOC_CTX
*mem_ctx
,
1171 struct tevent_context
*ev
,
1172 struct files_struct
*fsp
,
1174 size_t n
, off_t offset
);
1175 ssize_t
SMB_VFS_PREAD_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1177 ssize_t
smb_vfs_call_write(struct vfs_handle_struct
*handle
,
1178 struct files_struct
*fsp
, const void *data
,
1180 ssize_t
smb_vfs_call_pwrite(struct vfs_handle_struct
*handle
,
1181 struct files_struct
*fsp
, const void *data
,
1182 size_t n
, off_t offset
);
1183 struct tevent_req
*smb_vfs_call_pwrite_send(struct vfs_handle_struct
*handle
,
1184 TALLOC_CTX
*mem_ctx
,
1185 struct tevent_context
*ev
,
1186 struct files_struct
*fsp
,
1188 size_t n
, off_t offset
);
1189 ssize_t
SMB_VFS_PWRITE_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1191 off_t
smb_vfs_call_lseek(struct vfs_handle_struct
*handle
,
1192 struct files_struct
*fsp
, off_t offset
,
1194 ssize_t
smb_vfs_call_sendfile(struct vfs_handle_struct
*handle
, int tofd
,
1195 files_struct
*fromfsp
, const DATA_BLOB
*header
,
1196 off_t offset
, size_t count
);
1197 ssize_t
smb_vfs_call_recvfile(struct vfs_handle_struct
*handle
, int fromfd
,
1198 files_struct
*tofsp
, off_t offset
,
1200 int smb_vfs_call_rename(struct vfs_handle_struct
*handle
,
1201 const struct smb_filename
*smb_fname_src
,
1202 const struct smb_filename
*smb_fname_dst
);
1203 int smb_vfs_call_fsync(struct vfs_handle_struct
*handle
,
1204 struct files_struct
*fsp
);
1206 struct tevent_req
*smb_vfs_call_fsync_send(struct vfs_handle_struct
*handle
,
1207 TALLOC_CTX
*mem_ctx
,
1208 struct tevent_context
*ev
,
1209 struct files_struct
*fsp
);
1210 int SMB_VFS_FSYNC_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1212 int smb_vfs_call_stat(struct vfs_handle_struct
*handle
,
1213 struct smb_filename
*smb_fname
);
1214 int smb_vfs_call_fstat(struct vfs_handle_struct
*handle
,
1215 struct files_struct
*fsp
, SMB_STRUCT_STAT
*sbuf
);
1216 int smb_vfs_call_lstat(struct vfs_handle_struct
*handle
,
1217 struct smb_filename
*smb_filename
);
1218 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct
*handle
,
1219 struct files_struct
*fsp
,
1220 const SMB_STRUCT_STAT
*sbuf
);
1221 int smb_vfs_call_unlink(struct vfs_handle_struct
*handle
,
1222 const struct smb_filename
*smb_fname
);
1223 int smb_vfs_call_chmod(struct vfs_handle_struct
*handle
,
1224 const struct smb_filename
*smb_fname
,
1226 int smb_vfs_call_fchmod(struct vfs_handle_struct
*handle
,
1227 struct files_struct
*fsp
, mode_t mode
);
1228 int smb_vfs_call_chown(struct vfs_handle_struct
*handle
,
1229 const struct smb_filename
*smb_fname
,
1232 int smb_vfs_call_fchown(struct vfs_handle_struct
*handle
,
1233 struct files_struct
*fsp
, uid_t uid
, gid_t gid
);
1234 int smb_vfs_call_lchown(struct vfs_handle_struct
*handle
,
1235 const struct smb_filename
*smb_fname
,
1238 int smb_vfs_call_chdir(struct vfs_handle_struct
*handle
,
1239 const struct smb_filename
*smb_fname
);
1240 char *smb_vfs_call_getwd(struct vfs_handle_struct
*handle
);
1241 int smb_vfs_call_ntimes(struct vfs_handle_struct
*handle
,
1242 const struct smb_filename
*smb_fname
,
1243 struct smb_file_time
*ft
);
1244 int smb_vfs_call_ftruncate(struct vfs_handle_struct
*handle
,
1245 struct files_struct
*fsp
, off_t offset
);
1246 int smb_vfs_call_fallocate(struct vfs_handle_struct
*handle
,
1247 struct files_struct
*fsp
,
1251 bool smb_vfs_call_lock(struct vfs_handle_struct
*handle
,
1252 struct files_struct
*fsp
, int op
, off_t offset
,
1253 off_t count
, int type
);
1254 int smb_vfs_call_kernel_flock(struct vfs_handle_struct
*handle
,
1255 struct files_struct
*fsp
, uint32_t share_mode
,
1256 uint32_t access_mask
);
1257 int smb_vfs_call_linux_setlease(struct vfs_handle_struct
*handle
,
1258 struct files_struct
*fsp
, int leasetype
);
1259 bool smb_vfs_call_getlock(struct vfs_handle_struct
*handle
,
1260 struct files_struct
*fsp
, off_t
*poffset
,
1261 off_t
*pcount
, int *ptype
, pid_t
*ppid
);
1262 int smb_vfs_call_symlink(struct vfs_handle_struct
*handle
,
1263 const char *link_contents
,
1264 const struct smb_filename
*new_smb_fname
);
1265 int smb_vfs_call_readlink(struct vfs_handle_struct
*handle
,
1266 const struct smb_filename
*smb_fname
,
1269 int smb_vfs_call_link(struct vfs_handle_struct
*handle
,
1270 const struct smb_filename
*old_smb_fname
,
1271 const struct smb_filename
*new_smb_fname
);
1272 int smb_vfs_call_mknod(struct vfs_handle_struct
*handle
,
1273 const struct smb_filename
*smb_fname
,
1276 char *smb_vfs_call_realpath(struct vfs_handle_struct
*handle
, const char *path
);
1277 int smb_vfs_call_chflags(struct vfs_handle_struct
*handle
,
1278 const struct smb_filename
*smb_fname
,
1279 unsigned int flags
);
1280 struct file_id
smb_vfs_call_file_id_create(struct vfs_handle_struct
*handle
,
1281 const SMB_STRUCT_STAT
*sbuf
);
1282 NTSTATUS
smb_vfs_call_streaminfo(struct vfs_handle_struct
*handle
,
1283 struct files_struct
*fsp
,
1284 const struct smb_filename
*smb_fname
,
1285 TALLOC_CTX
*mem_ctx
,
1286 unsigned int *num_streams
,
1287 struct stream_struct
**streams
);
1288 int smb_vfs_call_get_real_filename(struct vfs_handle_struct
*handle
,
1289 const char *path
, const char *name
,
1290 TALLOC_CTX
*mem_ctx
, char **found_name
);
1291 const char *smb_vfs_call_connectpath(struct vfs_handle_struct
*handle
,
1292 const char *filename
);
1293 NTSTATUS
smb_vfs_call_brl_lock_windows(struct vfs_handle_struct
*handle
,
1294 struct byte_range_lock
*br_lck
,
1295 struct lock_struct
*plock
,
1296 bool blocking_lock
);
1297 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct
*handle
,
1298 struct messaging_context
*msg_ctx
,
1299 struct byte_range_lock
*br_lck
,
1300 const struct lock_struct
*plock
);
1301 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct
*handle
,
1302 struct byte_range_lock
*br_lck
,
1303 struct lock_struct
*plock
);
1304 bool smb_vfs_call_strict_lock(struct vfs_handle_struct
*handle
,
1305 struct files_struct
*fsp
,
1306 struct lock_struct
*plock
);
1307 void smb_vfs_call_strict_unlock(struct vfs_handle_struct
*handle
,
1308 struct files_struct
*fsp
,
1309 struct lock_struct
*plock
);
1310 NTSTATUS
smb_vfs_call_translate_name(struct vfs_handle_struct
*handle
,
1312 enum vfs_translate_direction direction
,
1313 TALLOC_CTX
*mem_ctx
,
1314 char **mapped_name
);
1315 NTSTATUS
smb_vfs_call_fsctl(struct vfs_handle_struct
*handle
,
1316 struct files_struct
*fsp
,
1320 const uint8_t *_in_data
,
1322 uint8_t **_out_data
,
1323 uint32_t max_out_len
,
1325 NTSTATUS
smb_vfs_call_get_dos_attributes(struct vfs_handle_struct
*handle
,
1326 struct smb_filename
*smb_fname
,
1328 NTSTATUS
smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct
*handle
,
1329 struct files_struct
*fsp
,
1331 NTSTATUS
smb_vfs_call_set_dos_attributes(struct vfs_handle_struct
*handle
,
1332 const struct smb_filename
*smb_fname
,
1334 NTSTATUS
smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct
*handle
,
1335 struct files_struct
*fsp
,
1337 struct tevent_req
*smb_vfs_call_copy_chunk_send(struct vfs_handle_struct
*handle
,
1338 TALLOC_CTX
*mem_ctx
,
1339 struct tevent_context
*ev
,
1340 struct files_struct
*src_fsp
,
1342 struct files_struct
*dest_fsp
,
1346 NTSTATUS
smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct
*handle
,
1347 struct tevent_req
*req
,
1349 NTSTATUS
smb_vfs_call_get_compression(struct vfs_handle_struct
*handle
,
1350 TALLOC_CTX
*mem_ctx
,
1351 struct files_struct
*fsp
,
1352 struct smb_filename
*smb_fname
,
1353 uint16_t *_compression_fmt
);
1354 NTSTATUS
smb_vfs_call_set_compression(struct vfs_handle_struct
*handle
,
1355 TALLOC_CTX
*mem_ctx
,
1356 struct files_struct
*fsp
,
1357 uint16_t compression_fmt
);
1358 NTSTATUS
smb_vfs_call_snap_check_path(vfs_handle_struct
*handle
,
1359 TALLOC_CTX
*mem_ctx
,
1360 const char *service_path
,
1361 char **base_volume
);
1362 NTSTATUS
smb_vfs_call_snap_create(struct vfs_handle_struct
*handle
,
1363 TALLOC_CTX
*mem_ctx
,
1364 const char *base_volume
,
1369 NTSTATUS
smb_vfs_call_snap_delete(struct vfs_handle_struct
*handle
,
1370 TALLOC_CTX
*mem_ctx
,
1373 NTSTATUS
smb_vfs_call_fget_nt_acl(struct vfs_handle_struct
*handle
,
1374 struct files_struct
*fsp
,
1375 uint32_t security_info
,
1376 TALLOC_CTX
*mem_ctx
,
1377 struct security_descriptor
**ppdesc
);
1378 NTSTATUS
smb_vfs_call_get_nt_acl(struct vfs_handle_struct
*handle
,
1379 const struct smb_filename
*smb_fname
,
1380 uint32_t security_info
,
1381 TALLOC_CTX
*mem_ctx
,
1382 struct security_descriptor
**ppdesc
);
1383 NTSTATUS
smb_vfs_call_fset_nt_acl(struct vfs_handle_struct
*handle
,
1384 struct files_struct
*fsp
,
1385 uint32_t security_info_sent
,
1386 const struct security_descriptor
*psd
);
1387 NTSTATUS
smb_vfs_call_audit_file(struct vfs_handle_struct
*handle
,
1388 struct smb_filename
*file
,
1389 struct security_acl
*sacl
,
1390 uint32_t access_requested
,
1391 uint32_t access_denied
);
1392 int smb_vfs_call_chmod_acl(struct vfs_handle_struct
*handle
,
1393 const struct smb_filename
*file
,
1395 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct
*handle
,
1396 struct files_struct
*fsp
, mode_t mode
);
1397 SMB_ACL_T
smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct
*handle
,
1398 const struct smb_filename
*smb_fname
,
1399 SMB_ACL_TYPE_T type
,
1400 TALLOC_CTX
*mem_ctx
);
1401 SMB_ACL_T
smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct
*handle
,
1402 struct files_struct
*fsp
,
1403 TALLOC_CTX
*mem_ctx
);
1404 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct
*handle
,
1405 const struct smb_filename
*smb_fname
,
1406 TALLOC_CTX
*mem_ctx
,
1407 char **blob_description
,
1409 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct
*handle
,
1410 struct files_struct
*fsp
,
1411 TALLOC_CTX
*mem_ctx
,
1412 char **blob_description
,
1414 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct
*handle
,
1415 const struct smb_filename
*smb_fname
,
1416 SMB_ACL_TYPE_T acltype
,
1418 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct
*handle
,
1419 struct files_struct
*fsp
, SMB_ACL_T theacl
);
1420 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct
*handle
,
1421 const struct smb_filename
*smb_fname
);
1422 ssize_t
smb_vfs_call_getxattr(struct vfs_handle_struct
*handle
,
1423 const struct smb_filename
*smb_fname
,
1427 ssize_t
smb_vfs_call_fgetxattr(struct vfs_handle_struct
*handle
,
1428 struct files_struct
*fsp
, const char *name
,
1429 void *value
, size_t size
);
1430 ssize_t
smb_vfs_call_listxattr(struct vfs_handle_struct
*handle
,
1431 const struct smb_filename
*smb_fname
,
1434 ssize_t
smb_vfs_call_flistxattr(struct vfs_handle_struct
*handle
,
1435 struct files_struct
*fsp
, char *list
,
1437 int smb_vfs_call_removexattr(struct vfs_handle_struct
*handle
,
1438 const struct smb_filename
*smb_fname
,
1440 int smb_vfs_call_fremovexattr(struct vfs_handle_struct
*handle
,
1441 struct files_struct
*fsp
, const char *name
);
1442 int smb_vfs_call_setxattr(struct vfs_handle_struct
*handle
,
1443 const struct smb_filename
*smb_fname
,
1448 int smb_vfs_call_lsetxattr(struct vfs_handle_struct
*handle
, const char *path
,
1449 const char *name
, const void *value
, size_t size
,
1451 int smb_vfs_call_fsetxattr(struct vfs_handle_struct
*handle
,
1452 struct files_struct
*fsp
, const char *name
,
1453 const void *value
, size_t size
, int flags
);
1454 bool smb_vfs_call_aio_force(struct vfs_handle_struct
*handle
,
1455 struct files_struct
*fsp
);
1456 bool smb_vfs_call_is_offline(struct vfs_handle_struct
*handle
,
1457 const struct smb_filename
*fname
,
1458 SMB_STRUCT_STAT
*sbuf
);
1459 int smb_vfs_call_set_offline(struct vfs_handle_struct
*handle
,
1460 const struct smb_filename
*fname
);
1461 NTSTATUS
smb_vfs_call_durable_cookie(struct vfs_handle_struct
*handle
,
1462 struct files_struct
*fsp
,
1463 TALLOC_CTX
*mem_ctx
,
1465 NTSTATUS
smb_vfs_call_durable_disconnect(struct vfs_handle_struct
*handle
,
1466 struct files_struct
*fsp
,
1467 const DATA_BLOB old_cookie
,
1468 TALLOC_CTX
*mem_ctx
,
1469 DATA_BLOB
*new_cookie
);
1470 NTSTATUS
smb_vfs_call_durable_reconnect(struct vfs_handle_struct
*handle
,
1471 struct smb_request
*smb1req
,
1472 struct smbXsrv_open
*op
,
1473 const DATA_BLOB old_cookie
,
1474 TALLOC_CTX
*mem_ctx
,
1475 struct files_struct
**fsp
,
1476 DATA_BLOB
*new_cookie
);
1477 NTSTATUS
smb_vfs_call_readdir_attr(struct vfs_handle_struct
*handle
,
1478 const struct smb_filename
*fname
,
1479 TALLOC_CTX
*mem_ctx
,
1480 struct readdir_attr_data
**attr_data
);
1482 NTSTATUS
smb_register_vfs(int version
, const char *name
,
1483 const struct vfs_fn_pointers
*fns
);
1484 void *vfs_add_fsp_extension_notype(vfs_handle_struct
*handle
,
1485 files_struct
*fsp
, size_t ext_size
,
1486 void (*destroy_fn
)(void *p_data
));
1487 void vfs_remove_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1488 void vfs_remove_all_fsp_extensions(struct files_struct
*fsp
);
1489 void *vfs_memctx_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1490 void *vfs_fetch_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1492 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers
* fns
,
1493 const char *module
);