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 * */
232 #define SMB_VFS_INTERFACE_VERSION 37
235 All intercepted VFS operations must be declared as static functions inside module source
236 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
237 example VFS modules for more details.
240 /* VFS operations structure */
242 struct vfs_handle_struct
;
243 struct connection_struct
;
245 struct security_descriptor
;
246 struct vfs_statvfs_struct
;
249 struct smb_file_time
;
250 struct blocking_lock_record
;
252 struct dfs_GetDFSReferral
;
254 typedef union unid_t
{
262 uint64_t position_information
;
264 uint32_t private_options
; /* NT Create options, but we only look at
265 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
266 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
267 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
268 * for print files *only*, where
269 * DELETE_ON_CLOSE is not stored in the share
272 unsigned long gen_id
;
277 struct smbd_server_connection
*sconn
;
278 struct tevent_timer
*timeout
;
279 struct smb2_lease lease
;
282 typedef struct files_struct
{
283 struct files_struct
*next
, *prev
;
285 struct smbXsrv_open
*op
;
286 struct connection_struct
*conn
;
287 struct fd_handle
*fh
;
288 unsigned int num_smb_operations
;
289 struct file_id file_id
;
290 uint64_t initial_allocation_size
; /* Faked up initial allocation on disk. */
292 uint64_t vuid
; /* SMB2 compat */
293 struct write_cache
*wcp
;
294 struct timeval open_time
;
295 uint32_t access_mask
; /* NTCreateX access bits (FILE_READ_DATA etc.) */
296 uint32_t share_access
; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
298 bool kernel_share_modes_taken
;
300 bool update_write_time_triggered
;
301 struct tevent_timer
*update_write_time_event
;
302 bool update_write_time_on_close
;
303 struct timespec close_write_time
;
304 bool write_time_forced
;
307 struct fsp_lease
*lease
;
308 int sent_oplock_break
;
309 struct tevent_timer
*oplock_timeout
;
310 struct lock_struct last_lock_failure
;
311 int current_lock_count
; /* Count the number of outstanding locks and pending locks. */
318 bool aio_write_behind
;
319 bool initial_delete_on_close
; /* Only set at NTCreateX if file was created. */
320 bool delete_on_close
;
321 uint64_t posix_flags
;
323 bool backup_intent
; /* Handle was successfully opened with backup intent
324 and opener has privilege to do so. */
325 bool aapl_copyfile_supported
;
326 bool use_ofd_locks
; /* Are we using open file description locks ? */
327 struct smb_filename
*fsp_name
;
328 uint32_t name_hash
; /* Jenkins hash of full pathname. */
329 uint64_t mid
; /* Mid of the operation that created us. */
331 struct vfs_fsp_data
*vfs_extension
;
332 struct fake_file_handle
*fake_file_handle
;
334 struct notify_change_buf
*notify
;
336 struct files_struct
*base_fsp
; /* placeholder for delete on close */
339 * Read-only cached brlock record, thrown away when the
340 * brlock.tdb seqnum changes. This avoids fetching data from
341 * the brlock.tdb on every read/write call.
344 struct byte_range_lock
*brlock_rec
;
346 struct dptr_struct
*dptr
;
348 /* if not NULL, means this is a print file */
349 struct print_file_data
*print_file
;
351 unsigned num_aio_requests
;
352 struct tevent_req
**aio_requests
;
355 * If a close request comes in while we still have aio_requests
356 * around, we need to hold back the close. When all aio_requests are
357 * done, the aio completion routines need tevent_wait_done() on
358 * this. A bit ugly, but before we have close_file() fully async
359 * possibly the simplest approach. Thanks, Jeremy for the idea.
361 struct tevent_req
*deferred_close
;
364 #define FSP_POSIX_FLAGS_OPEN 0x01
365 #define FSP_POSIX_FLAGS_RENAME 0x02
366 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
368 #define FSP_POSIX_FLAGS_ALL \
369 (FSP_POSIX_FLAGS_OPEN | \
370 FSP_POSIX_FLAGS_PATHNAMES | \
371 FSP_POSIX_FLAGS_RENAME)
373 struct vuid_cache_entry
{
374 struct auth_session_info
*session_info
;
375 uint64_t vuid
; /* SMB2 compat */
377 uint32_t share_access
;
381 unsigned int next_entry
;
382 struct vuid_cache_entry array
[VUID_CACHE_SIZE
];
388 } name_compare_entry
;
390 struct dfree_cached_info
{
391 time_t last_dfree_time
;
398 struct share_params
{
402 typedef struct connection_struct
{
403 struct connection_struct
*next
, *prev
;
404 struct smbd_server_connection
*sconn
; /* can be NULL */
405 struct smbXsrv_tcon
*tcon
; /* can be NULL */
406 uint32_t cnum
; /* an index passed over the wire */
407 struct share_params
*params
;
409 struct vuid_cache
*vuid_cache
;
412 bool read_only
; /* Attributes for the current user of the share. */
413 uint32_t share_access
;
414 /* Does this filesystem honor
415 sub second timestamps on files
416 and directories when setting time ? */
417 enum timestamp_set_resolution ts_res
;
420 char *cwd
; /* Working directory. */
422 struct vfs_handle_struct
*vfs_handles
; /* for the new plugins */
425 * This represents the user information on this connection. Depending
426 * on the vuid using this tid, this might change per SMB request.
428 struct auth_session_info
*session_info
;
431 * If the "force group" parameter is set, this is the primary gid that
432 * may be used in the users token, depending on the vuid using this tid.
434 gid_t force_group_gid
;
436 uint64_t vuid
; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
439 time_t lastused_count
;
441 unsigned int num_smb_operations
; /* Count of smb operations on this tree. */
445 /* Semantics requested by the client or forced by the server config. */
448 bool short_case_preserve
;
450 /* Semantics provided by the underlying filesystem. */
452 /* Device number of the directory of the share mount.
453 Used to ensure unique FileIndex returns. */
454 SMB_DEV_T base_share_dev
;
456 name_compare_entry
*hide_list
; /* Per-share list of files to return as hidden. */
457 name_compare_entry
*veto_list
; /* Per-share list of files to veto (never show). */
458 name_compare_entry
*veto_oplock_list
; /* Per-share list of files to refuse oplocks on. */
459 name_compare_entry
*aio_write_behind_list
; /* Per-share list of files to use aio write behind on. */
460 struct dfree_cached_info
*dfree_info
;
461 struct trans_state
*pending_trans
;
463 struct rpc_pipe_client
*spoolss_pipe
;
467 struct smbd_smb2_request
;
468 struct privilege_paths
;
474 uint64_t mid
; /* For compatibility with SMB2. */
476 uint64_t vuid
; /* For compatibility with SMB2. */
482 const uint8_t *inbuf
;
485 * Async handling in the main smb processing loop is directed by
486 * outbuf: reply_xxx routines indicate sync behaviour by putting their
487 * reply into "outbuf". If they leave it as NULL, they take care of it
488 * themselves, possibly later.
490 * If async handling is wanted, the reply_xxx routine must make sure
491 * that it talloc_move()s the smb_req somewhere else.
497 connection_struct
*conn
;
498 struct smbd_server_connection
*sconn
;
499 struct smbXsrv_connection
*xconn
;
500 struct smb_perfcount_data pcd
;
503 * Chained request handling
505 struct files_struct
*chain_fsp
;
508 * state information for async smb handling
513 * Back pointer to smb2 request.
515 struct smbd_smb2_request
*smb2req
;
518 * Pathnames used if request done
521 struct privilege_paths
*priv_paths
;
524 * Request list for chained requests, we're part of it.
526 struct smb_request
**chain
;
528 struct timeval request_time
;
530 bool posix_pathnames
;
534 * Info about an alternate data stream
537 struct stream_struct
{
544 struct smb_file_time
{
545 struct timespec mtime
;
546 struct timespec atime
;
547 struct timespec ctime
;
548 struct timespec create_time
;
554 struct smb_filename
{
557 char *original_lcomp
;
563 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
564 * to keep the numeric values consistent.
567 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
569 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
570 handle = handle->next; \
573 enum vfs_translate_direction
{
574 vfs_translate_to_unix
= 0,
575 vfs_translate_to_windows
578 enum vfs_fallocate_flags
{
579 VFS_FALLOCATE_FL_KEEP_SIZE
= 0x0001,
580 VFS_FALLOCATE_FL_PUNCH_HOLE
= 0x0002,
584 * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
585 * be handled as a COW clone, AKA reflink.
586 * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
588 enum vfs_copy_chunk_flags
{
589 VFS_COPY_CHUNK_FL_MUST_CLONE
= 0x0001,
590 VFS_COPY_CHUNK_FL_IGNORE_LOCKS
= 0x0002,
592 VFS_COPY_CHUNK_FL_MASK_ALL
=
593 (VFS_COPY_CHUNK_FL_MUST_CLONE
594 | VFS_COPY_CHUNK_FL_IGNORE_LOCKS
),
597 struct vfs_aio_state
{
603 Available VFS operations. These values must be in sync with vfs_ops struct
604 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
605 In particular, if new operations are added to vfs_ops, appropriate constants
606 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
608 struct shadow_copy_data
;
610 struct vfs_fn_pointers
{
611 /* Disk operations */
613 int (*connect_fn
)(struct vfs_handle_struct
*handle
, const char *service
, const char *user
);
614 void (*disconnect_fn
)(struct vfs_handle_struct
*handle
);
615 uint64_t (*disk_free_fn
)(struct vfs_handle_struct
*handle
,
616 const struct smb_filename
*smb_fname
,
620 int (*get_quota_fn
)(struct vfs_handle_struct
*handle
,
621 const struct smb_filename
*smb_fname
,
622 enum SMB_QUOTA_TYPE qtype
,
625 int (*set_quota_fn
)(struct vfs_handle_struct
*handle
, enum SMB_QUOTA_TYPE qtype
, unid_t id
, SMB_DISK_QUOTA
*qt
);
626 int (*get_shadow_copy_data_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, struct shadow_copy_data
*shadow_copy_data
, bool labels
);
627 int (*statvfs_fn
)(struct vfs_handle_struct
*handle
,
628 const struct smb_filename
*smb_fname
,
629 struct vfs_statvfs_struct
*statbuf
);
630 uint32_t (*fs_capabilities_fn
)(struct vfs_handle_struct
*handle
, enum timestamp_set_resolution
*p_ts_res
);
633 * Note: that "struct dfs_GetDFSReferral *r"
634 * needs to be a valid TALLOC_CTX
636 NTSTATUS (*get_dfs_referrals_fn
)(struct vfs_handle_struct
*handle
,
637 struct dfs_GetDFSReferral
*r
);
639 /* Directory operations */
641 DIR *(*opendir_fn
)(struct vfs_handle_struct
*handle
,
642 const struct smb_filename
*smb_fname
,
644 uint32_t attributes
);
645 DIR *(*fdopendir_fn
)(struct vfs_handle_struct
*handle
, files_struct
*fsp
, const char *mask
, uint32_t attributes
);
646 struct dirent
*(*readdir_fn
)(struct vfs_handle_struct
*handle
,
648 SMB_STRUCT_STAT
*sbuf
);
649 void (*seekdir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
, long offset
);
650 long (*telldir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
651 void (*rewind_dir_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
652 int (*mkdir_fn
)(struct vfs_handle_struct
*handle
,
653 const struct smb_filename
*smb_fname
,
655 int (*rmdir_fn
)(struct vfs_handle_struct
*handle
,
656 const struct smb_filename
*smb_fname
);
657 int (*closedir_fn
)(struct vfs_handle_struct
*handle
, DIR *dir
);
658 void (*init_search_op_fn
)(struct vfs_handle_struct
*handle
, DIR *dirp
);
660 /* File operations */
662 int (*open_fn
)(struct vfs_handle_struct
*handle
,
663 struct smb_filename
*smb_fname
, files_struct
*fsp
,
664 int flags
, mode_t mode
);
665 NTSTATUS (*create_file_fn
)(struct vfs_handle_struct
*handle
,
666 struct smb_request
*req
,
667 uint16_t root_dir_fid
,
668 struct smb_filename
*smb_fname
,
669 uint32_t access_mask
,
670 uint32_t share_access
,
671 uint32_t create_disposition
,
672 uint32_t create_options
,
673 uint32_t file_attributes
,
674 uint32_t oplock_request
,
675 struct smb2_lease
*lease
,
676 uint64_t allocation_size
,
677 uint32_t private_flags
,
678 struct security_descriptor
*sd
,
679 struct ea_list
*ea_list
,
680 files_struct
**result
,
682 const struct smb2_create_blobs
*in_context_blobs
,
683 struct smb2_create_blobs
*out_context_blobs
);
684 int (*close_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
685 ssize_t (*read_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, void *data
, size_t n
);
686 ssize_t (*pread_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, void *data
, size_t n
, off_t offset
);
687 struct tevent_req
*(*pread_send_fn
)(struct vfs_handle_struct
*handle
,
689 struct tevent_context
*ev
,
690 struct files_struct
*fsp
,
692 size_t n
, off_t offset
);
693 ssize_t (*pread_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
694 ssize_t (*write_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const void *data
, size_t n
);
695 ssize_t (*pwrite_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const void *data
, size_t n
, off_t offset
);
696 struct tevent_req
*(*pwrite_send_fn
)(struct vfs_handle_struct
*handle
,
698 struct tevent_context
*ev
,
699 struct files_struct
*fsp
,
701 size_t n
, off_t offset
);
702 ssize_t (*pwrite_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
703 off_t (*lseek_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t offset
, int whence
);
704 ssize_t (*sendfile_fn
)(struct vfs_handle_struct
*handle
, int tofd
, files_struct
*fromfsp
, const DATA_BLOB
*header
, off_t offset
, size_t count
);
705 ssize_t (*recvfile_fn
)(struct vfs_handle_struct
*handle
, int fromfd
, files_struct
*tofsp
, off_t offset
, size_t count
);
706 int (*rename_fn
)(struct vfs_handle_struct
*handle
,
707 const struct smb_filename
*smb_fname_src
,
708 const struct smb_filename
*smb_fname_dst
);
709 int (*fsync_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
710 struct tevent_req
*(*fsync_send_fn
)(struct vfs_handle_struct
*handle
,
712 struct tevent_context
*ev
,
713 struct files_struct
*fsp
);
714 int (*fsync_recv_fn
)(struct tevent_req
*req
, struct vfs_aio_state
*state
);
715 int (*stat_fn
)(struct vfs_handle_struct
*handle
, struct smb_filename
*smb_fname
);
716 int (*fstat_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, SMB_STRUCT_STAT
*sbuf
);
717 int (*lstat_fn
)(struct vfs_handle_struct
*handle
, struct smb_filename
*smb_filename
);
718 uint64_t (*get_alloc_size_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const SMB_STRUCT_STAT
*sbuf
);
719 int (*unlink_fn
)(struct vfs_handle_struct
*handle
,
720 const struct smb_filename
*smb_fname
);
721 int (*chmod_fn
)(struct vfs_handle_struct
*handle
,
722 const struct smb_filename
*smb_fname
,
724 int (*fchmod_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, mode_t mode
);
725 int (*chown_fn
)(struct vfs_handle_struct
*handle
,
726 const struct smb_filename
*smb_fname
,
729 int (*fchown_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, uid_t uid
, gid_t gid
);
730 int (*lchown_fn
)(struct vfs_handle_struct
*handle
,
731 const struct smb_filename
*smb_fname
,
734 int (*chdir_fn
)(struct vfs_handle_struct
*handle
, const char *path
);
735 char *(*getwd_fn
)(struct vfs_handle_struct
*handle
);
736 int (*ntimes_fn
)(struct vfs_handle_struct
*handle
,
737 const struct smb_filename
*smb_fname
,
738 struct smb_file_time
*ft
);
739 int (*ftruncate_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t offset
);
740 int (*fallocate_fn
)(struct vfs_handle_struct
*handle
,
741 struct files_struct
*fsp
,
745 bool (*lock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, int op
, off_t offset
, off_t count
, int type
);
746 int (*kernel_flock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
,
747 uint32_t share_mode
, uint32_t access_mask
);
748 int (*linux_setlease_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, int leasetype
);
749 bool (*getlock_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, off_t
*poffset
, off_t
*pcount
, int *ptype
, pid_t
*ppid
);
750 int (*symlink_fn
)(struct vfs_handle_struct
*handle
,
751 const char *link_contents
,
752 const struct smb_filename
*new_smb_fname
);
753 int (*readlink_fn
)(struct vfs_handle_struct
*handle
,
754 const struct smb_filename
*smb_fname
,
757 int (*link_fn
)(struct vfs_handle_struct
*handle
,
758 const struct smb_filename
*old_smb_fname
,
759 const struct smb_filename
*new_smb_fname
);
760 int (*mknod_fn
)(struct vfs_handle_struct
*handle
,
761 const struct smb_filename
*smb_fname
,
764 char *(*realpath_fn
)(struct vfs_handle_struct
*handle
, const char *path
);
765 int (*chflags_fn
)(struct vfs_handle_struct
*handle
,
766 const struct smb_filename
*smb_fname
,
768 struct file_id (*file_id_create_fn
)(struct vfs_handle_struct
*handle
,
769 const SMB_STRUCT_STAT
*sbuf
);
770 struct tevent_req
*(*copy_chunk_send_fn
)(struct vfs_handle_struct
*handle
,
772 struct tevent_context
*ev
,
773 struct files_struct
*src_fsp
,
775 struct files_struct
*dest_fsp
,
779 NTSTATUS (*copy_chunk_recv_fn
)(struct vfs_handle_struct
*handle
,
780 struct tevent_req
*req
,
782 NTSTATUS (*get_compression_fn
)(struct vfs_handle_struct
*handle
,
784 struct files_struct
*fsp
,
785 struct smb_filename
*smb_fname
,
786 uint16_t *_compression_fmt
);
787 NTSTATUS (*set_compression_fn
)(struct vfs_handle_struct
*handle
,
789 struct files_struct
*fsp
,
790 uint16_t compression_fmt
);
791 NTSTATUS (*snap_check_path_fn
)(struct vfs_handle_struct
*handle
,
793 const char *service_path
,
795 NTSTATUS (*snap_create_fn
)(struct vfs_handle_struct
*handle
,
797 const char *base_volume
,
802 NTSTATUS (*snap_delete_fn
)(struct vfs_handle_struct
*handle
,
807 NTSTATUS (*streaminfo_fn
)(struct vfs_handle_struct
*handle
,
808 struct files_struct
*fsp
,
809 const struct smb_filename
*smb_fname
,
811 unsigned int *num_streams
,
812 struct stream_struct
**streams
);
814 int (*get_real_filename_fn
)(struct vfs_handle_struct
*handle
,
820 const char *(*connectpath_fn
)(struct vfs_handle_struct
*handle
,
821 const char *filename
);
823 NTSTATUS (*brl_lock_windows_fn
)(struct vfs_handle_struct
*handle
,
824 struct byte_range_lock
*br_lck
,
825 struct lock_struct
*plock
,
828 bool (*brl_unlock_windows_fn
)(struct vfs_handle_struct
*handle
,
829 struct messaging_context
*msg_ctx
,
830 struct byte_range_lock
*br_lck
,
831 const struct lock_struct
*plock
);
833 bool (*brl_cancel_windows_fn
)(struct vfs_handle_struct
*handle
,
834 struct byte_range_lock
*br_lck
,
835 struct lock_struct
*plock
);
837 bool (*strict_lock_fn
)(struct vfs_handle_struct
*handle
,
838 struct files_struct
*fsp
,
839 struct lock_struct
*plock
);
841 void (*strict_unlock_fn
)(struct vfs_handle_struct
*handle
,
842 struct files_struct
*fsp
,
843 struct lock_struct
*plock
);
845 NTSTATUS (*translate_name_fn
)(struct vfs_handle_struct
*handle
,
847 enum vfs_translate_direction direction
,
851 NTSTATUS (*fsctl_fn
)(struct vfs_handle_struct
*handle
,
852 struct files_struct
*fsp
,
856 const uint8_t *_in_data
,
859 uint32_t max_out_len
,
862 NTSTATUS (*get_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
863 struct smb_filename
*smb_fname
,
866 NTSTATUS (*fget_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
867 struct files_struct
*fsp
,
870 NTSTATUS (*set_dos_attributes_fn
)(struct vfs_handle_struct
*handle
,
871 const struct smb_filename
*smb_fname
,
874 NTSTATUS (*fset_dos_attributes_fn
)(struct vfs_handle_struct
*hande
,
875 struct files_struct
*fsp
,
878 /* NT ACL operations. */
880 NTSTATUS (*fget_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
881 struct files_struct
*fsp
,
882 uint32_t security_info
,
884 struct security_descriptor
**ppdesc
);
885 NTSTATUS (*get_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
886 const struct smb_filename
*smb_fname
,
887 uint32_t security_info
,
889 struct security_descriptor
**ppdesc
);
890 NTSTATUS (*fset_nt_acl_fn
)(struct vfs_handle_struct
*handle
,
891 struct files_struct
*fsp
,
892 uint32_t security_info_sent
,
893 const struct security_descriptor
*psd
);
895 NTSTATUS (*audit_file_fn
)(struct vfs_handle_struct
*handle
,
896 struct smb_filename
*file
,
897 struct security_acl
*sacl
,
898 uint32_t access_requested
,
899 uint32_t access_denied
);
901 /* POSIX ACL operations. */
903 int (*chmod_acl_fn
)(struct vfs_handle_struct
*handle
,
904 const struct smb_filename
*smb_fname
,
906 int (*fchmod_acl_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, mode_t mode
);
908 SMB_ACL_T (*sys_acl_get_file_fn
)(struct vfs_handle_struct
*handle
,
909 const struct smb_filename
*smb_fname
,
911 TALLOC_CTX
*mem_ctx
);
912 SMB_ACL_T (*sys_acl_get_fd_fn
)(struct vfs_handle_struct
*handle
,
913 struct files_struct
*fsp
,
914 TALLOC_CTX
*mem_ctx
);
915 int (*sys_acl_blob_get_file_fn
)(struct vfs_handle_struct
*handle
,
916 const struct smb_filename
*smb_fname
,
918 char **blob_description
,
920 int (*sys_acl_blob_get_fd_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
,
921 TALLOC_CTX
*mem_ctx
, char **blob_description
,
923 int (*sys_acl_set_file_fn
)(struct vfs_handle_struct
*handle
,
924 const struct smb_filename
*smb_fname
,
925 SMB_ACL_TYPE_T acltype
,
927 int (*sys_acl_set_fd_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, SMB_ACL_T theacl
);
928 int (*sys_acl_delete_def_file_fn
)(struct vfs_handle_struct
*handle
,
929 const struct smb_filename
*smb_fname
);
932 ssize_t (*getxattr_fn
)(struct vfs_handle_struct
*handle
,
933 const struct smb_filename
*smb_fname
,
937 ssize_t (*fgetxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
, void *value
, size_t size
);
938 ssize_t (*listxattr_fn
)(struct vfs_handle_struct
*handle
,
939 const struct smb_filename
*smb_fname
,
942 ssize_t (*flistxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, char *list
, size_t size
);
943 int (*removexattr_fn
)(struct vfs_handle_struct
*handle
,
944 const struct smb_filename
*smb_fname
,
946 int (*fremovexattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
);
947 int (*setxattr_fn
)(struct vfs_handle_struct
*handle
,
948 const struct smb_filename
*smb_fname
,
953 int (*fsetxattr_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
, const char *name
, const void *value
, size_t size
, int flags
);
956 bool (*aio_force_fn
)(struct vfs_handle_struct
*handle
, struct files_struct
*fsp
);
958 /* durable handle operations */
959 NTSTATUS (*durable_cookie_fn
)(struct vfs_handle_struct
*handle
,
960 struct files_struct
*fsp
,
963 NTSTATUS (*durable_disconnect_fn
)(struct vfs_handle_struct
*handle
,
964 struct files_struct
*fsp
,
965 const DATA_BLOB old_cookie
,
967 DATA_BLOB
*new_cookie
);
968 NTSTATUS (*durable_reconnect_fn
)(struct vfs_handle_struct
*handle
,
969 struct smb_request
*smb1req
,
970 struct smbXsrv_open
*op
,
971 const DATA_BLOB old_cookie
,
973 struct files_struct
**fsp
,
974 DATA_BLOB
*new_cookie
);
976 NTSTATUS (*readdir_attr_fn
)(struct vfs_handle_struct
*handle
,
977 const struct smb_filename
*fname
,
979 struct readdir_attr_data
**attr_data
);
983 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
984 which describes all operations this module is willing to intercept.
985 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
986 using this information.
989 typedef struct vfs_handle_struct
{
990 struct vfs_handle_struct
*next
, *prev
;
992 struct connection_struct
*conn
;
993 const struct vfs_fn_pointers
*fns
;
995 void (*free_data
)(void **data
);
999 typedef struct vfs_statvfs_struct
{
1000 /* For undefined recommended transfer size return -1 in that field */
1001 uint32_t OptimalTransferSize
; /* bsize on some os, iosize on other os */
1005 The next three fields are in terms of the block size.
1006 (above). If block size is unknown, 4096 would be a
1007 reasonable block size for a server to report.
1008 Note that returning the blocks/blocksavail removes need
1009 to make a second call (to QFSInfo level 0x103 to get this info.
1010 UserBlockAvail is typically less than or equal to BlocksAvail,
1011 if no distinction is made return the same value in each.
1014 uint64_t TotalBlocks
;
1015 uint64_t BlocksAvail
; /* bfree */
1016 uint64_t UserBlocksAvail
; /* bavail */
1018 /* For undefined Node fields or FSID return -1 */
1019 uint64_t TotalFileNodes
;
1020 uint64_t FreeFileNodes
;
1021 uint64_t FsIdentifier
; /* fsid */
1022 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1023 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1026 } vfs_statvfs_struct
;
1028 /* Add a new FSP extension of the given type. Returns a pointer to the
1031 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1032 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1034 /* Return a pointer to the existing FSP extension data. */
1035 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1036 vfs_fetch_fsp_extension(handle, (fsp))
1038 /* Return the talloc context associated with an FSP extension. */
1039 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1040 vfs_memctx_fsp_extension(handle, (fsp))
1042 /* Remove and destroy an FSP extension. */
1043 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1044 vfs_remove_fsp_extension((handle), (fsp))
1046 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1047 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1048 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1053 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1055 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1058 if ((handle)->free_data) { \
1059 (handle)->free_data(&(handle)->data); \
1061 (handle)->data = (void *)datap; \
1062 (handle)->free_data = free_fn; \
1066 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1067 if ((handle) && (handle)->free_data) { \
1068 (handle)->free_data(&(handle)->data); \
1072 /* Check whether module-specific data handle was already allocated or not */
1073 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1075 #define SMB_VFS_OP(x) ((void *) x)
1077 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1079 #include "vfs_macros.h"
1081 int smb_vfs_call_connect(struct vfs_handle_struct
*handle
,
1082 const char *service
, const char *user
);
1083 void smb_vfs_call_disconnect(struct vfs_handle_struct
*handle
);
1084 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct
*handle
,
1085 const struct smb_filename
*smb_filename
,
1089 int smb_vfs_call_get_quota(struct vfs_handle_struct
*handle
,
1090 const struct smb_filename
*smb_filename
,
1091 enum SMB_QUOTA_TYPE qtype
,
1093 SMB_DISK_QUOTA
*qt
);
1094 int smb_vfs_call_set_quota(struct vfs_handle_struct
*handle
,
1095 enum SMB_QUOTA_TYPE qtype
, unid_t id
,
1096 SMB_DISK_QUOTA
*qt
);
1097 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct
*handle
,
1098 struct files_struct
*fsp
,
1099 struct shadow_copy_data
*shadow_copy_data
,
1101 int smb_vfs_call_statvfs(struct vfs_handle_struct
*handle
,
1102 const struct smb_filename
*smb_fname
,
1103 struct vfs_statvfs_struct
*statbuf
);
1104 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct
*handle
,
1105 enum timestamp_set_resolution
*p_ts_res
);
1107 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1109 NTSTATUS
smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct
*handle
,
1110 struct dfs_GetDFSReferral
*r
);
1111 DIR *smb_vfs_call_opendir(struct vfs_handle_struct
*handle
,
1112 const struct smb_filename
*smb_fname
,
1114 uint32_t attributes
);
1115 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct
*handle
,
1116 struct files_struct
*fsp
,
1118 uint32_t attributes
);
1119 struct dirent
*smb_vfs_call_readdir(struct vfs_handle_struct
*handle
,
1121 SMB_STRUCT_STAT
*sbuf
);
1122 void smb_vfs_call_seekdir(struct vfs_handle_struct
*handle
,
1123 DIR *dirp
, long offset
);
1124 long smb_vfs_call_telldir(struct vfs_handle_struct
*handle
,
1126 void smb_vfs_call_rewind_dir(struct vfs_handle_struct
*handle
,
1128 int smb_vfs_call_mkdir(struct vfs_handle_struct
*handle
,
1129 const struct smb_filename
*smb_fname
,
1131 int smb_vfs_call_rmdir(struct vfs_handle_struct
*handle
,
1132 const struct smb_filename
*smb_fname
);
1133 int smb_vfs_call_closedir(struct vfs_handle_struct
*handle
,
1135 void smb_vfs_call_init_search_op(struct vfs_handle_struct
*handle
,
1137 int smb_vfs_call_open(struct vfs_handle_struct
*handle
,
1138 struct smb_filename
*smb_fname
, struct files_struct
*fsp
,
1139 int flags
, mode_t mode
);
1140 NTSTATUS
smb_vfs_call_create_file(struct vfs_handle_struct
*handle
,
1141 struct smb_request
*req
,
1142 uint16_t root_dir_fid
,
1143 struct smb_filename
*smb_fname
,
1144 uint32_t access_mask
,
1145 uint32_t share_access
,
1146 uint32_t create_disposition
,
1147 uint32_t create_options
,
1148 uint32_t file_attributes
,
1149 uint32_t oplock_request
,
1150 struct smb2_lease
*lease
,
1151 uint64_t allocation_size
,
1152 uint32_t private_flags
,
1153 struct security_descriptor
*sd
,
1154 struct ea_list
*ea_list
,
1155 files_struct
**result
,
1157 const struct smb2_create_blobs
*in_context_blobs
,
1158 struct smb2_create_blobs
*out_context_blobs
);
1159 int smb_vfs_call_close(struct vfs_handle_struct
*handle
,
1160 struct files_struct
*fsp
);
1161 ssize_t
smb_vfs_call_read(struct vfs_handle_struct
*handle
,
1162 struct files_struct
*fsp
, void *data
, size_t n
);
1163 ssize_t
smb_vfs_call_pread(struct vfs_handle_struct
*handle
,
1164 struct files_struct
*fsp
, void *data
, size_t n
,
1166 struct tevent_req
*smb_vfs_call_pread_send(struct vfs_handle_struct
*handle
,
1167 TALLOC_CTX
*mem_ctx
,
1168 struct tevent_context
*ev
,
1169 struct files_struct
*fsp
,
1171 size_t n
, off_t offset
);
1172 ssize_t
SMB_VFS_PREAD_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1174 ssize_t
smb_vfs_call_write(struct vfs_handle_struct
*handle
,
1175 struct files_struct
*fsp
, const void *data
,
1177 ssize_t
smb_vfs_call_pwrite(struct vfs_handle_struct
*handle
,
1178 struct files_struct
*fsp
, const void *data
,
1179 size_t n
, off_t offset
);
1180 struct tevent_req
*smb_vfs_call_pwrite_send(struct vfs_handle_struct
*handle
,
1181 TALLOC_CTX
*mem_ctx
,
1182 struct tevent_context
*ev
,
1183 struct files_struct
*fsp
,
1185 size_t n
, off_t offset
);
1186 ssize_t
SMB_VFS_PWRITE_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1188 off_t
smb_vfs_call_lseek(struct vfs_handle_struct
*handle
,
1189 struct files_struct
*fsp
, off_t offset
,
1191 ssize_t
smb_vfs_call_sendfile(struct vfs_handle_struct
*handle
, int tofd
,
1192 files_struct
*fromfsp
, const DATA_BLOB
*header
,
1193 off_t offset
, size_t count
);
1194 ssize_t
smb_vfs_call_recvfile(struct vfs_handle_struct
*handle
, int fromfd
,
1195 files_struct
*tofsp
, off_t offset
,
1197 int smb_vfs_call_rename(struct vfs_handle_struct
*handle
,
1198 const struct smb_filename
*smb_fname_src
,
1199 const struct smb_filename
*smb_fname_dst
);
1200 int smb_vfs_call_fsync(struct vfs_handle_struct
*handle
,
1201 struct files_struct
*fsp
);
1203 struct tevent_req
*smb_vfs_call_fsync_send(struct vfs_handle_struct
*handle
,
1204 TALLOC_CTX
*mem_ctx
,
1205 struct tevent_context
*ev
,
1206 struct files_struct
*fsp
);
1207 int SMB_VFS_FSYNC_RECV(struct tevent_req
*req
, struct vfs_aio_state
*state
);
1209 int smb_vfs_call_stat(struct vfs_handle_struct
*handle
,
1210 struct smb_filename
*smb_fname
);
1211 int smb_vfs_call_fstat(struct vfs_handle_struct
*handle
,
1212 struct files_struct
*fsp
, SMB_STRUCT_STAT
*sbuf
);
1213 int smb_vfs_call_lstat(struct vfs_handle_struct
*handle
,
1214 struct smb_filename
*smb_filename
);
1215 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct
*handle
,
1216 struct files_struct
*fsp
,
1217 const SMB_STRUCT_STAT
*sbuf
);
1218 int smb_vfs_call_unlink(struct vfs_handle_struct
*handle
,
1219 const struct smb_filename
*smb_fname
);
1220 int smb_vfs_call_chmod(struct vfs_handle_struct
*handle
,
1221 const struct smb_filename
*smb_fname
,
1223 int smb_vfs_call_fchmod(struct vfs_handle_struct
*handle
,
1224 struct files_struct
*fsp
, mode_t mode
);
1225 int smb_vfs_call_chown(struct vfs_handle_struct
*handle
,
1226 const struct smb_filename
*smb_fname
,
1229 int smb_vfs_call_fchown(struct vfs_handle_struct
*handle
,
1230 struct files_struct
*fsp
, uid_t uid
, gid_t gid
);
1231 int smb_vfs_call_lchown(struct vfs_handle_struct
*handle
,
1232 const struct smb_filename
*smb_fname
,
1235 int smb_vfs_call_chdir(struct vfs_handle_struct
*handle
, const char *path
);
1236 char *smb_vfs_call_getwd(struct vfs_handle_struct
*handle
);
1237 int smb_vfs_call_ntimes(struct vfs_handle_struct
*handle
,
1238 const struct smb_filename
*smb_fname
,
1239 struct smb_file_time
*ft
);
1240 int smb_vfs_call_ftruncate(struct vfs_handle_struct
*handle
,
1241 struct files_struct
*fsp
, off_t offset
);
1242 int smb_vfs_call_fallocate(struct vfs_handle_struct
*handle
,
1243 struct files_struct
*fsp
,
1247 bool smb_vfs_call_lock(struct vfs_handle_struct
*handle
,
1248 struct files_struct
*fsp
, int op
, off_t offset
,
1249 off_t count
, int type
);
1250 int smb_vfs_call_kernel_flock(struct vfs_handle_struct
*handle
,
1251 struct files_struct
*fsp
, uint32_t share_mode
,
1252 uint32_t access_mask
);
1253 int smb_vfs_call_linux_setlease(struct vfs_handle_struct
*handle
,
1254 struct files_struct
*fsp
, int leasetype
);
1255 bool smb_vfs_call_getlock(struct vfs_handle_struct
*handle
,
1256 struct files_struct
*fsp
, off_t
*poffset
,
1257 off_t
*pcount
, int *ptype
, pid_t
*ppid
);
1258 int smb_vfs_call_symlink(struct vfs_handle_struct
*handle
,
1259 const char *link_contents
,
1260 const struct smb_filename
*new_smb_fname
);
1261 int smb_vfs_call_readlink(struct vfs_handle_struct
*handle
,
1262 const struct smb_filename
*smb_fname
,
1265 int smb_vfs_call_link(struct vfs_handle_struct
*handle
,
1266 const struct smb_filename
*old_smb_fname
,
1267 const struct smb_filename
*new_smb_fname
);
1268 int smb_vfs_call_mknod(struct vfs_handle_struct
*handle
,
1269 const struct smb_filename
*smb_fname
,
1272 char *smb_vfs_call_realpath(struct vfs_handle_struct
*handle
, const char *path
);
1273 int smb_vfs_call_chflags(struct vfs_handle_struct
*handle
,
1274 const struct smb_filename
*smb_fname
,
1275 unsigned int flags
);
1276 struct file_id
smb_vfs_call_file_id_create(struct vfs_handle_struct
*handle
,
1277 const SMB_STRUCT_STAT
*sbuf
);
1278 NTSTATUS
smb_vfs_call_streaminfo(struct vfs_handle_struct
*handle
,
1279 struct files_struct
*fsp
,
1280 const struct smb_filename
*smb_fname
,
1281 TALLOC_CTX
*mem_ctx
,
1282 unsigned int *num_streams
,
1283 struct stream_struct
**streams
);
1284 int smb_vfs_call_get_real_filename(struct vfs_handle_struct
*handle
,
1285 const char *path
, const char *name
,
1286 TALLOC_CTX
*mem_ctx
, char **found_name
);
1287 const char *smb_vfs_call_connectpath(struct vfs_handle_struct
*handle
,
1288 const char *filename
);
1289 NTSTATUS
smb_vfs_call_brl_lock_windows(struct vfs_handle_struct
*handle
,
1290 struct byte_range_lock
*br_lck
,
1291 struct lock_struct
*plock
,
1292 bool blocking_lock
);
1293 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct
*handle
,
1294 struct messaging_context
*msg_ctx
,
1295 struct byte_range_lock
*br_lck
,
1296 const struct lock_struct
*plock
);
1297 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct
*handle
,
1298 struct byte_range_lock
*br_lck
,
1299 struct lock_struct
*plock
);
1300 bool smb_vfs_call_strict_lock(struct vfs_handle_struct
*handle
,
1301 struct files_struct
*fsp
,
1302 struct lock_struct
*plock
);
1303 void smb_vfs_call_strict_unlock(struct vfs_handle_struct
*handle
,
1304 struct files_struct
*fsp
,
1305 struct lock_struct
*plock
);
1306 NTSTATUS
smb_vfs_call_translate_name(struct vfs_handle_struct
*handle
,
1308 enum vfs_translate_direction direction
,
1309 TALLOC_CTX
*mem_ctx
,
1310 char **mapped_name
);
1311 NTSTATUS
smb_vfs_call_fsctl(struct vfs_handle_struct
*handle
,
1312 struct files_struct
*fsp
,
1316 const uint8_t *_in_data
,
1318 uint8_t **_out_data
,
1319 uint32_t max_out_len
,
1321 NTSTATUS
smb_vfs_call_get_dos_attributes(struct vfs_handle_struct
*handle
,
1322 struct smb_filename
*smb_fname
,
1324 NTSTATUS
smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct
*handle
,
1325 struct files_struct
*fsp
,
1327 NTSTATUS
smb_vfs_call_set_dos_attributes(struct vfs_handle_struct
*handle
,
1328 const struct smb_filename
*smb_fname
,
1330 NTSTATUS
smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct
*handle
,
1331 struct files_struct
*fsp
,
1333 struct tevent_req
*smb_vfs_call_copy_chunk_send(struct vfs_handle_struct
*handle
,
1334 TALLOC_CTX
*mem_ctx
,
1335 struct tevent_context
*ev
,
1336 struct files_struct
*src_fsp
,
1338 struct files_struct
*dest_fsp
,
1342 NTSTATUS
smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct
*handle
,
1343 struct tevent_req
*req
,
1345 NTSTATUS
smb_vfs_call_get_compression(struct vfs_handle_struct
*handle
,
1346 TALLOC_CTX
*mem_ctx
,
1347 struct files_struct
*fsp
,
1348 struct smb_filename
*smb_fname
,
1349 uint16_t *_compression_fmt
);
1350 NTSTATUS
smb_vfs_call_set_compression(struct vfs_handle_struct
*handle
,
1351 TALLOC_CTX
*mem_ctx
,
1352 struct files_struct
*fsp
,
1353 uint16_t compression_fmt
);
1354 NTSTATUS
smb_vfs_call_snap_check_path(vfs_handle_struct
*handle
,
1355 TALLOC_CTX
*mem_ctx
,
1356 const char *service_path
,
1357 char **base_volume
);
1358 NTSTATUS
smb_vfs_call_snap_create(struct vfs_handle_struct
*handle
,
1359 TALLOC_CTX
*mem_ctx
,
1360 const char *base_volume
,
1365 NTSTATUS
smb_vfs_call_snap_delete(struct vfs_handle_struct
*handle
,
1366 TALLOC_CTX
*mem_ctx
,
1369 NTSTATUS
smb_vfs_call_fget_nt_acl(struct vfs_handle_struct
*handle
,
1370 struct files_struct
*fsp
,
1371 uint32_t security_info
,
1372 TALLOC_CTX
*mem_ctx
,
1373 struct security_descriptor
**ppdesc
);
1374 NTSTATUS
smb_vfs_call_get_nt_acl(struct vfs_handle_struct
*handle
,
1375 const struct smb_filename
*smb_fname
,
1376 uint32_t security_info
,
1377 TALLOC_CTX
*mem_ctx
,
1378 struct security_descriptor
**ppdesc
);
1379 NTSTATUS
smb_vfs_call_fset_nt_acl(struct vfs_handle_struct
*handle
,
1380 struct files_struct
*fsp
,
1381 uint32_t security_info_sent
,
1382 const struct security_descriptor
*psd
);
1383 NTSTATUS
smb_vfs_call_audit_file(struct vfs_handle_struct
*handle
,
1384 struct smb_filename
*file
,
1385 struct security_acl
*sacl
,
1386 uint32_t access_requested
,
1387 uint32_t access_denied
);
1388 int smb_vfs_call_chmod_acl(struct vfs_handle_struct
*handle
,
1389 const struct smb_filename
*file
,
1391 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct
*handle
,
1392 struct files_struct
*fsp
, mode_t mode
);
1393 SMB_ACL_T
smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct
*handle
,
1394 const struct smb_filename
*smb_fname
,
1395 SMB_ACL_TYPE_T type
,
1396 TALLOC_CTX
*mem_ctx
);
1397 SMB_ACL_T
smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct
*handle
,
1398 struct files_struct
*fsp
,
1399 TALLOC_CTX
*mem_ctx
);
1400 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct
*handle
,
1401 const struct smb_filename
*smb_fname
,
1402 TALLOC_CTX
*mem_ctx
,
1403 char **blob_description
,
1405 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct
*handle
,
1406 struct files_struct
*fsp
,
1407 TALLOC_CTX
*mem_ctx
,
1408 char **blob_description
,
1410 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct
*handle
,
1411 const struct smb_filename
*smb_fname
,
1412 SMB_ACL_TYPE_T acltype
,
1414 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct
*handle
,
1415 struct files_struct
*fsp
, SMB_ACL_T theacl
);
1416 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct
*handle
,
1417 const struct smb_filename
*smb_fname
);
1418 ssize_t
smb_vfs_call_getxattr(struct vfs_handle_struct
*handle
,
1419 const struct smb_filename
*smb_fname
,
1423 ssize_t
smb_vfs_call_fgetxattr(struct vfs_handle_struct
*handle
,
1424 struct files_struct
*fsp
, const char *name
,
1425 void *value
, size_t size
);
1426 ssize_t
smb_vfs_call_listxattr(struct vfs_handle_struct
*handle
,
1427 const struct smb_filename
*smb_fname
,
1430 ssize_t
smb_vfs_call_flistxattr(struct vfs_handle_struct
*handle
,
1431 struct files_struct
*fsp
, char *list
,
1433 int smb_vfs_call_removexattr(struct vfs_handle_struct
*handle
,
1434 const struct smb_filename
*smb_fname
,
1436 int smb_vfs_call_fremovexattr(struct vfs_handle_struct
*handle
,
1437 struct files_struct
*fsp
, const char *name
);
1438 int smb_vfs_call_setxattr(struct vfs_handle_struct
*handle
,
1439 const struct smb_filename
*smb_fname
,
1444 int smb_vfs_call_lsetxattr(struct vfs_handle_struct
*handle
, const char *path
,
1445 const char *name
, const void *value
, size_t size
,
1447 int smb_vfs_call_fsetxattr(struct vfs_handle_struct
*handle
,
1448 struct files_struct
*fsp
, const char *name
,
1449 const void *value
, size_t size
, int flags
);
1450 bool smb_vfs_call_aio_force(struct vfs_handle_struct
*handle
,
1451 struct files_struct
*fsp
);
1452 bool smb_vfs_call_is_offline(struct vfs_handle_struct
*handle
,
1453 const struct smb_filename
*fname
,
1454 SMB_STRUCT_STAT
*sbuf
);
1455 int smb_vfs_call_set_offline(struct vfs_handle_struct
*handle
,
1456 const struct smb_filename
*fname
);
1457 NTSTATUS
smb_vfs_call_durable_cookie(struct vfs_handle_struct
*handle
,
1458 struct files_struct
*fsp
,
1459 TALLOC_CTX
*mem_ctx
,
1461 NTSTATUS
smb_vfs_call_durable_disconnect(struct vfs_handle_struct
*handle
,
1462 struct files_struct
*fsp
,
1463 const DATA_BLOB old_cookie
,
1464 TALLOC_CTX
*mem_ctx
,
1465 DATA_BLOB
*new_cookie
);
1466 NTSTATUS
smb_vfs_call_durable_reconnect(struct vfs_handle_struct
*handle
,
1467 struct smb_request
*smb1req
,
1468 struct smbXsrv_open
*op
,
1469 const DATA_BLOB old_cookie
,
1470 TALLOC_CTX
*mem_ctx
,
1471 struct files_struct
**fsp
,
1472 DATA_BLOB
*new_cookie
);
1473 NTSTATUS
smb_vfs_call_readdir_attr(struct vfs_handle_struct
*handle
,
1474 const struct smb_filename
*fname
,
1475 TALLOC_CTX
*mem_ctx
,
1476 struct readdir_attr_data
**attr_data
);
1478 NTSTATUS
smb_register_vfs(int version
, const char *name
,
1479 const struct vfs_fn_pointers
*fns
);
1480 void *vfs_add_fsp_extension_notype(vfs_handle_struct
*handle
,
1481 files_struct
*fsp
, size_t ext_size
,
1482 void (*destroy_fn
)(void *p_data
));
1483 void vfs_remove_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1484 void vfs_remove_all_fsp_extensions(struct files_struct
*fsp
);
1485 void *vfs_memctx_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1486 void *vfs_fetch_fsp_extension(vfs_handle_struct
*handle
, files_struct
*fsp
);
1488 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers
* fns
,
1489 const char *module
);