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.
50 * Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA.
51 * Changed to version 3 for POSIX acl extensions. JRA.
52 * Changed to version 4 for cascaded VFS interface. Alexander Bokovoy.
53 * Changed to version 5 for sendfile addition. JRA.
54 * Changed to version 6 for the new module system, fixed cascading and quota functions. --metze
55 * Changed to version 7 to include the get_nt_acl info parameter. JRA.
56 * Changed to version 8 includes EA calls. JRA.
57 * Changed to version 9 to include the get_shadow_data call. --metze
58 * Changed to version 10 to include pread pwrite calls.
59 * Changed to version 11 to include seekdir telldir rewinddir calls. JRA
60 * Changed to version 12 to add mask and attributes to opendir(). JRA
61 * Also include aio calls. JRA.
62 * Changed to version 13 as the internal structure of files_struct has changed. JRA
63 * Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA
64 * Changed to version 15 as we added the statvfs call. JRA
65 * Changed to version 16 as we added the getlock call. JRA
66 * Changed to version 17 as we removed redundant connection_struct parameters. --jpeach
67 * Changed to version 18 to add fsp parameter to the open call -- jpeach
68 * Also include kernel_flock call - jmcd
69 * Changed to version 19, kernel change notify has been merged
70 * Also included linux setlease call - jmcd
71 * Changed to version 20, use ntimes call instead of utime (greater
72 * timestamp resolition. JRA.
73 * Changed to version21 to add chflags operation -- jpeach
74 * Changed to version22 to add lchown operation -- jra
75 * Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra.
76 * Leave at 22 - not yet released. Add file_id_create operation. --metze
77 * Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra.
78 * Leave at 22 - not yet released. Added recvfile.
79 * Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl
80 * Leave at 22 - not yet released. Change get_nt_acl to *not* take a
81 * files_struct. - obnox.
82 * Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox
83 * Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox
84 * Leave at 22 - not yet released. Remove parameter fd from pread. - obnox
85 * Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox
86 * Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox
87 * Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox
88 * Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox
89 * Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox
90 * Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox
91 * Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox
92 * Leave at 22 - not yet released. Remove parameter fd from lock. - obnox
93 * Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox
94 * Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox
95 * Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox
96 * Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox
97 * Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox
98 * Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox
99 * Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox
100 * Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox
101 * Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox
102 * Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox
103 * Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox
104 * Leave at 22 - not yet released. Remove parameter fd from read. - obnox
105 * Leave at 22 - not yet released. Remove parameter fd from write. - obnox
106 * Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox
107 * Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox
108 * Leave at 22 - not yet released. Additional change: add operations for offline files -- ab
109 * Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl
110 * Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox
111 * Changed to version 23 - remove set_nt_acl call. This can only be done via an
113 * Changed to version 24 - make security descriptor const in fset_nt_acl. JRA.
114 * Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t.
115 * Leave at 25 - not yet released. Add create_file call. -- tprouty.
116 * Leave at 25 - not yet released. Add create time to ntimes. -- tstecher.
117 * Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty.
118 * Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann
119 * Leave at 25 - not yet released. Add init_search_op call. - sdann
120 * Leave at 25 - not yet released. Add locking calls. -- zkirsch.
121 * Leave at 25 - not yet released. Add strict locking calls. -- drichards.
122 * Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
123 * SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
124 * SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES.
125 * Changed to version 27 - not yet released. Added enum timestamp_set_resolution
126 * return to fs_capabilities call. JRA.
127 * Leave at 27 - not yet released. Add translate_name VFS call to convert
128 * UNIX names to Windows supported names -- asrinivasan.
129 * Changed to version 28 - Add private_flags uint32_t to CREATE call.
130 * Leave at 28 - not yet released. Change realpath to assume NULL and return a
131 * malloc'ed path. JRA.
132 * Leave at 28 - not yet released. Move posix_fallocate into the VFS
133 * where it belongs. JRA.
134 * Leave at 28 - not yet released. Rename posix_fallocate to fallocate
135 * to split out the two possible uses. JRA.
136 * Leave at 28 - not yet released. Add fdopendir. JRA.
137 * Leave at 28 - not yet released. Rename open function to open_fn. - gd
138 * Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA.
139 * Bump to version 29 - Samba 3.6.0 will ship with interface version 28.
140 * Leave at 29 - not yet releases. Add fsctl. Richard Sharpe
141 * Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze
142 * Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet
143 * Leave at 29 - not yet released. move to plain off_t - abartlet
144 * Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet
145 * Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA
146 * Leave at 29 - not yet released. Add durable handle functions - metze obnox
147 * Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd
148 * Bump to version 30 - Samba 4.0.0 will ship with interface version 30
149 * Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls.
150 * Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type
151 * Bump to version 31 - Samba 4.1.0 will ship with interface version 31
152 * Leave at 31 - not yet released. Make struct vuid_cache_entry in
153 * connection_struct a pointer.
154 * Leave at 31 - not yet released. Add share_access to vuid_cache_entry.
155 * Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK()
156 * Leave at 31 - not yet released. Remove the unused
157 * fsp->pending_break_messages array
158 * Leave at 31 - not yet released. add SMB_VFS_[GET SET]_COMPRESSION()
160 * Bump to version 32 - Samba 4.2 will ship with that.
161 * Version 32 - Add "lease" to CREATE_FILE operation
162 * Version 32 - Add "lease" to struct files_struct
163 * Version 32 - Add SMB_VFS_READDIR_ATTR()
164 * Version 32 - Add in and out create context blobs to create_file
165 * Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter
166 * Bump to version 33 - Samba 4.3 will ship with that.
167 * Version 33 - change fallocate mode flags param from enum->uint32_t
168 * Version 33 - Add snapshot create delete calls
169 * Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp
170 * Version 33 - Remove notify_watch_fn
171 * Bump to version 34 - Samba 4.4 will ship with that
172 * Version 34 - Remove bool posix_open, add uint64_t posix_flags
173 * Version 34 - Added bool posix_pathnames to struct smb_request
174 * Bump to version 35 - Samba 4.5 will ship with that
175 * Version 35 - Change get_nt_acl_fn from const char *, to
176 * const struct smb_filename *
177 * Version 35 - Change mkdir from const char *, to
178 * const struct smb_filename *
179 * Version 35 - Change rmdir from const char *, to
180 * const struct smb_filename *
181 * Version 35 - Change opendir from const char *, to
182 * const struct smb_filename *
183 * Version 35 - Wrap aio async funtions args in a struct vfs_aio_state
184 * Version 35 - Change chmod from const char *, to
185 * const struct smb_filename *
186 * Version 35 - Change chmod_acl from const char *, to
187 * const struct smb_filename *
188 * Version 35 - Change chown from const char *, to
189 * const struct smb_filename *
190 * Version 35 - Change lchown from const char *, to
191 * const struct smb_filename *
192 * Version 35 - Change streaminfo from const char *, to
193 * const struct smb_filename *
194 * Version 35 - Add uint32_t flags to struct smb_filename
195 * Version 35 - Add get set fget fset dos attribute functions.
196 * Version 35 - Add bool use_ofd_locks to struct files_struct
197 * Bump to version 36 - Samba 4.6 will ship with that
198 * Version 36 - Remove is_offline and set_offline
199 * Version 37 - Module init functions now take a TALLOC_CTX * parameter.
200 * Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE
201 * Version 37 - Change sys_acl_delete_def_file from const char *
202 * to const struct smb_filename *
203 * Version 37 - Change sys_acl_get_file from const char *
204 * to const struct smb_filename *
205 * Version 37 - Change sys_acl_blob_get_file from const char *
206 * to const struct smb_filename *
207 * Version 37 - Change sys_acl_set_file from const char *
208 * to const struct smb_filename *
209 * Version 37 - Change listxattr from const char *
210 * to const struct smb_filename *
211 * Version 37 - Change removexattr from const char *
212 * to const struct smb_filename *
213 * Version 37 - Change setxattr from const char *
214 * to const struct smb_filename *
215 * Version 37 - Change getxattr from const char *
216 * to const struct smb_filename *
217 * Version 37 - Change mknod from const char * to const struct smb_filename *
218 * Version 37 - Change chflags from const char *
219 * to const struct smb_filename *
220 * Version 37 - Change disk_free from const char *
221 * to const struct smb_filename *
222 * Version 37 - Change get_quota from const char *
223 * to const struct smb_filename *
224 * Version 37 - Change link from const char *
225 * to const struct smb_filename *
226 * Version 37 - Change statvfs from const char *
227 * to const struct smb_filename *
228 * Version 37 - Change readlink from const char *
229 * to const struct smb_filename *
230 * Version 37 - Change symlink from const char *
231 * to const struct smb_filename *
232 * Version 37 - Change chdir from const char *
233 * to const struct smb_filename *
234 * Version 37 - Change getwd from char *
235 * to const struct smb_filename *
236 * Version 37 - Change conn->cwd from char *
237 * to struct smb_filename *
238 * Version 37 - Change realpath from char *
239 * to struct smb_filename *
240 * Version 37 - Change connectpath from char *
241 * to struct smb_filename *
242 * Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND RECV
243 * Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND RECV to
244 * SMB_VFS_OFFLOAD_READ_SEND RECV
245 * Version 37 - Remove SMB_VFS_STRICT_UNLOCK
246 * Version 37 - Rename SMB_VFS_STRICT_LOCK to
247 * SMB_VFS_STRICT_LOCK_CHECK
248 * Version 38 - Remove SMB_VFS_INIT_SEARCH_OP
249 * Bump to version 39, Samba 4.9 will ship with that
250 * Version 39 - Remove SMB_VFS_FSYNC
251 * Only implement async versions.
252 * Version 39 - Remove SMB_VFS_READ
253 * All users are now pread or async versions.
254 * Version 39 - Remove SMB_VFS_WRITE
255 * All users are now pwrite or async versions.
256 * Version 39 - Remove SMB_VFS_CHMOD_ACL - no longer used.
257 * Version 39 - Remove SMB_VFS_FCHMOD_ACL - no longer used.
258 * Version 39 - Remove struct dfree_cached_info pointer from
260 * Bump to version 40, Samba 4.10 will ship with that
261 * Version 40 - Add SMB_VFS_GETXATTRAT_SEND RECV
262 * Version 40 - Add SMB_VFS_GET_DOS_ATTRIBUTES_SEND RECV
263 * Bump to version 41, Samba 4.11 will ship with that
264 * Version 41 - Remove SMB_VFS_BRL_CANCEL_WINDOWS
265 * Version 41 - Remove unused st_ex_mask from struct stat_ex
266 * Version 41 - convert struct stat_ex.st_ex_calculated_birthtime to flags
267 * Version 41 - add st_ex_itime to struct stat_ex
268 * Version 41 - add st_ex_file_id to struct stat_ex
269 * Version 41 - add SMB_VFS_FS_FILE_ID
270 * Version 41 - Remove "blocking_lock" parameter from
271 * SMB_VFS_BRL_LOCK_WINDOWS
272 * Version 41 - Remove "msg_ctx" parameter from SMB_VFS_BRL_UNLOCK_WINDOWS
273 * Bump to version 42, Samba 4.12 will ship with that
274 * Version 42 - Remove share_access member from struct files_struct
275 * Version 42 - Make "lease" a const* in create_file_fn
276 * Version 42 - Move SMB_VFS_RENAME -> SMB_VFS_RENAMEAT
277 * Version 42 - Move SMB_VFS_LINK -> SMB_VFS_LINKAT.
278 * Version 42 - Move SMB_VFS_MKNOD -> SMB_VFS_MKDNODAT.
279 * Version 42 - Move SMB_VFS_READLINK -> SMB_VFS_READLINKAT.
280 * Version 42 - Move SMB_VFS_SYMLINK -> SMB_VFS_SYMLINKAT.
281 * Version 42 - Move SMB_VFS_MKDIR -> SMB_VFS_MKDIRAT.
282 * Version 42 - Move change_to_user() -> change_to_user_and_service()
283 * Version 42 - Move change_to_user_by_fsp() -> change_to_user_and_service_by_fsp()
284 * Version 42 - Move [un]become_user*() -> [un]become_user_without_service*()
285 * Version 42 - Move SMB_VFS_UNLINK -> SMB_VFS_UNLINKAT.
286 * Version 42 - Add SMB_VFS_FCNTL
287 * Version 42 - Remove SMB_VFS_RMDIR.
288 * Use SMB_VFS_UNLINKAT(.., AT_REMOVEDIR) instead.
289 * Version 42 - Remove SMB_VFS_CHOWN
290 * Version 42 - Remove struct write_cache *wcp from files_struct
291 * Version 42 - SMB_VFS_NTIMES() receives null times based on UTIMES_OMIT
292 * Version 42 - Add SMB_VFS_CREATE_DFS_PATHAT()
293 * Version 42 - Add SMB_VFS_READ_DFS_PATHAT()
294 * Change to Version 43 - will ship with 4.13.
295 * Version 43 - Remove deferred_close from struct files_struct
296 * Version 43 - Remove SMB_VFS_OPENDIR()
297 * Version 43 - Remove original_lcomp from struct smb_filename
298 * Version 43 - files_struct flags:
299 * bool kernel_share_modes_taken
300 * bool update_write_time_triggered
301 * bool update_write_time_on_close
302 * bool write_time_forced
308 * bool aio_write_behind
309 * bool initial_delete_on_close
310 * bool delete_on_close
315 * bool lock_failure_seen
316 * changed to bitfields.
317 * Version 43 - convert SMB_VFS_GET_REAL_FILENAME() arg path
318 * to be a struct smb_filename
319 * Version 43 - convert link_contents arg of SMB_VFS_SYMLINKAT()
320 * to struct smb_filename
321 * Version 43 - Move SMB_VFS_GET_NT_ACL() -> SMB_VFS_GET_NT_ACL_AT().
322 * Version 43 - Remove root_dir_fid from SMB_VFS_CREATE_FILE().
323 * Version 43 - Add dirfsp to struct files_struct
324 * Version 43 - Add dirfsp args to SMB_VFS_CREATE_FILE()
325 * Version 43 - Add SMB_VFS_OPENAT()
326 * Version 43 - Remove SMB_VFS_OPEN()
327 * Version 43 - SMB_VFS_READ_DFS_PATHAT() should take a non-const name.
328 There's no easy way to return stat info for a DFS link
330 * Change to Version 44 - will ship with 4.14.
331 * Version 44 - Remove dirfsp arg from struct files_struct
332 * Version 44 - Remove dirfsp arg to SMB_VFS_CREATE_FILE()
333 * Version 44 - Make dirfsp arg to SMB_VFS_READLINKAT() const
334 * Version 44 - Add a flag 'encryption_required' to files_struct that that
335 * prevents that encrypted connections can be downgraded.
336 * Version 44 - Add a flag 'is_pathref' to struct files_struct.
337 * Version 44 - Add 'is_fsa' flag to struct files_struct.
338 * Version 44 - Add 'have_proc_fds' flag to struct connection_struct.
339 * Version 44 - Add 'have_proc_fds' flag to struct files_struct.
340 * Version 44 - Add dirfsp arg to SMB_VFS_READDIR()
341 * Version 44 - Replace SMB_VFS_GET_COMPRESSION() with SMB_VFS_FGET_COMPRESSION()
342 * Version 44 - Add type argument to SMB_VFS_SYS_ACL_SET_FD()
343 * Version 44 - Remove SMB_VFS_SYS_ACL_SET_FILE()
344 * Change to Version 45 - will ship with 4.15
345 * Version 45 - Remove SMB_VFS_LISTXATTR
346 * Version 45 - Remove SMB_VFS_SETXATTR
347 * Version 45 - Remove SMB_VFS_REMOVEXATTR
348 * Version 45 - Remove SMB_VFS_GET_DOS_ATTRIBUTES()
349 * Version 45 - Remove SMB_VFS_CHMOD
350 * Version 45 - Add SMB_VFS_FNTIMES
351 * Version 45 - Remove SMB_VFS_NTIMES
352 * Version 45 - ADD SMB_VFS_FSTREAMINFO
353 * Version 45 - Add SMB_VFS_FREADDIR_ATTR
354 * Version 45 - Remove SMB_VFS_READDIR_ATTR
355 * Version 45 - Add SMB_VFS_SYS_ACL_DELETE_DEF_FD
356 * Version 45 - Remove SMB_VFS_SYS_ACL_DELETE_DEF_FILE
357 * Version 45 - Add SMB_VFS_PARENT_PATHNAME
358 * Version 45 - Remove SMB_VFS_GET_NT_ACL_AT
359 * Version 45 - Remove SYS_ACL_GET_FILE
360 * Version 45 - Remove SYS_ACL_BLOB_GET_FILE
363 #define SMB_VFS_INTERFACE_VERSION 45
366 All intercepted VFS operations must be declared as static functions inside module source
367 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
368 example VFS modules for more details.
371 /* VFS operations structure */
373 struct vfs_handle_struct;
374 struct connection_struct;
376 struct security_descriptor;
377 struct vfs_statvfs_struct;
380 struct smb_file_time;
382 struct dfs_GetDFSReferral;
384 typedef union unid_t {
393 struct smbd_server_connection *sconn;
394 struct tevent_timer *timeout;
395 struct smb2_lease lease;
398 typedef struct files_struct {
399 struct files_struct *next, *prev;
401 struct smbXsrv_open *op;
402 struct connection_struct *conn;
403 struct fd_handle *fh;
404 unsigned int num_smb_operations;
405 struct file_id file_id;
406 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
408 uint64_t vuid; /* SMB2 compat */
409 struct timeval open_time;
410 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
412 bool is_pathref : 1; /* See below */
413 bool is_fsa : 1; /* See below */
414 bool have_proc_fds : 1;
415 bool kernel_share_modes_taken : 1;
416 bool update_write_time_triggered : 1;
417 bool update_write_time_on_close : 1;
418 bool write_time_forced : 1;
423 bool is_directory : 1;
425 bool aio_write_behind : 1;
426 bool initial_delete_on_close : 1;
427 bool delete_on_close : 1;
429 bool backup_intent : 1;
430 bool use_ofd_locks : 1;
432 bool lock_failure_seen : 1;
433 bool encryption_required : 1;
436 struct tevent_timer *update_write_time_event;
437 struct timespec close_write_time;
442 * Cache of our lease_type, stored as "current_state" in
445 int leases_db_seqnum;
448 struct fsp_lease *lease;
449 int sent_oplock_break;
450 struct tevent_timer *oplock_timeout;
451 struct lock_struct last_lock_failure;
452 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
454 uint64_t posix_flags;
455 struct smb_filename *fsp_name;
456 uint32_t name_hash; /* Jenkins hash of full pathname. */
457 uint64_t mid; /* Mid of the operation that created us. */
459 struct vfs_fsp_data *vfs_extension;
460 struct fake_file_handle *fake_file_handle;
462 struct notify_change_buf *notify;
464 struct files_struct *base_fsp; /* placeholder for delete on close */
465 struct files_struct *stream_fsp; /* backlink from base_fsp */
468 * Cache of share_mode_data->flags
470 int share_mode_flags_seqnum;
471 uint16_t share_mode_flags;
474 * Read-only cached brlock record, thrown away when the
475 * brlock.tdb seqnum changes. This avoids fetching data from
476 * the brlock.tdb on every read/write call.
479 struct byte_range_lock *brlock_rec;
481 struct dptr_struct *dptr;
483 /* if not NULL, means this is a print file */
484 struct print_file_data *print_file;
487 * Optimize the aio_requests array for high performance: Never
488 * shrink it, maintain num_aio_requests separately
490 unsigned num_aio_requests;
491 struct tevent_req **aio_requests;
494 * Requests waiting for smb1 byte range locks. They are
495 * generated by smbd_smb1_do_locks_send and are required here,
496 * because lock cancel operations index through reply_lockingX
497 * not based on mid but on the lock type and range.
499 struct tevent_req **blocked_smb1_lock_reqs;
502 * SMB1 remembers lock failures and delays repeated blocking
503 * lock attempts on the same offset.
505 uint64_t lock_failure_offset;
509 * The fsp flags "is_pathref" and "is_fsa"
510 * =======================================
515 * The flag "is_pathref" is a property of the low-level VFS-layer file
516 * handle. If "is_pathref" is true, only a subset of VFS calls are allowed
517 * on the handle and on systems that support it, the low-level fd is open
518 * with O_PATH. If "is_pathref" is false, the low-level fd is a "normal"
519 * file descriptor that can be used with all VFS calls.
521 * The flag "is_fsa" is a property of the FSA layer in Samba. The term FSA
522 * layer refers to the parts of smbs that implement Windows NTFS semantics
523 * on-top of a POSIX filesystem. If "is_fsa" is true, the fsp was
524 * processed by the SMB_VFS_CREATE_FILE() VFS call, otherwise the fsp was
525 * created by openat_pathref_fsp() which only connected the low-level
526 * handle by calling into VFS SMB_VFS_OPENAT(), but the whole FSA layer
529 * Note that only three possible combinations of "is_pathref" and "is_fsa"
532 * | is_fsa \ is_pathref | + | - |
533 * |---------------------+---+---|
537 * So a fsp can't be a full low-level fd (is_pathref=false) and not be
538 * processed by the FSA layer.
543 * On Linux the O_PATH flag to open() can be used to open a filehandle on
544 * a file or directory with interesting properties:
546 * - the file-handle indicates a location in the filesystem tree,
547 * - no permission checks are done by the kernel and
548 * - only operations that act purely at the file descriptor level are
551 * The file itself is not opened, and other file operations (e.g.,
552 * read(2), write(2), fchmod(2), fchown(2), fgetxattr(2), ioctl(2),
553 * mmap(2)) fail with the error EBADF.
555 * The following subset of operations that is relevant to Samba is allowed:
558 * - fchdir(2), if the file descriptor refers to a directory,
561 * - passing the file descriptor as the dirfd argument of openat() and the
562 * other "*at()" system calls. This includes linkat(2) with
563 * AT_EMPTY_PATH (or via procfs using AT_SYMLINK_FOLLOW) even if the
564 * file is not a directory.
566 * Opening a file or directory with the O_PATH flag requires no
567 * permissions on the object itself (but does require execute permission
568 * on the directories in the path prefix). By contrast, obtaining a
569 * reference to a filesystem object by opening it with the O_RDONLY flag
570 * requires that the caller have read permission on the object, even when
571 * the subsequent operation (e.g., fchdir(2), fstat(2)) does not require
572 * read permis‐ sion on the object. [1]
574 * If for example Samba receives an SMB request to open a file requesting
575 * SEC_FILE_READ_ATTRIBUTE access rights because the client wants to read
576 * the file's metadata from the handle, Samba will have to call POSIX
577 * open() with at least O_RDONLY access rights.
579 * Usecase for O_PATH in Samba
580 * ---------------------------
582 * By leveraging this Linux specific flags we can avoid permission
583 * mismatches as described above. Additionally O_PATH allows basing all
584 * filesystem accesses done by the fileserver on handle based syscalls by
585 * opening all client pathnames with O_PATH and consistently using for
586 * example fstat() instead of stat() throughout the codebase.
588 * Subsequently we will refer to Samba file-handles (fsp's) opened with
589 * O_PATH "path referencing fsp's" or "pathref" fsp's for short.
591 * Currently Samba bases the decision whether to call POSIX open() on a
592 * client pathname or whether to leave the low-level handle at -1, what we
593 * call a stat-open, in the function open_file() and it is based on the
594 * client requested SMB acccess mask.
596 * The set of rights that trigger an open() include READ_CONTROL_ACCESS,
597 * resulting in a call to open() with at least O_RDONLY. If the filesystem
598 * supports NT style ACLs natively (like GPFS or ZFS), the filesystem may
599 * grant the user requested right READ_CONTROL_ACCESS, but it may not
600 * grant READ_DATA (O_RDONLY), resulting in a permission denied error.
602 * Historically the set of access rights that triggered opening a file was:
610 * SEC_FLAG_SYSTEM_SECURITY
611 * READ_CONTROL_ACCESS
613 * By using O_PATH this can be trimmed down to
620 * Fallback on systems without O_PATH support
621 * ------------------------------------------
623 * A fallback is needed that allows opening a file-handle with the same
624 * higher level semantics even if the system doesn't support O_PATH. This
625 * is implemented by qimpersonating the root user for the open()
626 * syscall. To avoid bypassing restrictive permissions on intermediate
627 * directories components of a path, the root user is only impersonated
628 * after changing directory to the parent directory of the client
629 * requested pathname.
631 * In order to avoid privilege escalation security issues with these root
632 * opened file-handles we must carefully control their usage throughout
633 * the codebase. Therefor we
635 * - tag the pathref fsp's with the flag "is_pathref" and
637 * - control access to the file-handle by making the structure private and only
638 * allowing access with accessor functions.
640 * Two functions are used to fetch the low-level system file-handle from an fsp
642 * - fsp_get_io_fd(fsp): enforces fsp is NOT a pathref file-handle and
644 * - fsp_get_pathref_fd(fsp): allows fsp to be either a pathref file-handle or a
645 * traditional POSIX file-handle opened with O_RDONLY or any other POSIX open
648 * The general guideline when to use which function is:
650 * - if you do something like fstat(fd), use fsp_get_pathref_fd(fsp),
651 * - if you do something like *at(dirfd, ...), use fsp_get_pathref_fd(fsp),
652 * - if you want to print the fd for example in DEBUG messages, use
653 * fsp_get_pathref_fd(fsp),
654 * - if you want to call close(fd), use fsp_get_pathref_fd(fsp),
655 * - if you're doing a logical comparison of fd values, use
656 * fsp_get_pathref_fd().
658 * In any other case use fsp_get_io_fd().
661 #define FSP_POSIX_FLAGS_OPEN 0x01
662 #define FSP_POSIX_FLAGS_RENAME 0x02
663 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
665 #define FSP_POSIX_FLAGS_ALL \
666 (FSP_POSIX_FLAGS_OPEN | \
667 FSP_POSIX_FLAGS_PATHNAMES | \
668 FSP_POSIX_FLAGS_RENAME)
670 struct vuid_cache_entry {
671 struct auth_session_info *session_info;
672 uint64_t vuid; /* SMB2 compat */
674 uint32_t share_access;
678 unsigned int next_entry;
679 struct vuid_cache_entry array[VUID_CACHE_SIZE];
685 } name_compare_entry;
687 struct share_params {
691 typedef struct connection_struct {
692 struct connection_struct *next, *prev;
693 struct smbd_server_connection *sconn; /* can be NULL */
694 struct smbXsrv_tcon *tcon; /* can be NULL */
695 uint32_t cnum; /* an index passed over the wire */
696 struct share_params *params;
698 struct vuid_cache *vuid_cache;
701 bool read_only; /* Attributes for the current user of the share. */
703 uint32_t share_access;
704 /* Does this filesystem honor
705 sub second timestamps on files
706 and directories when setting time ? */
707 enum timestamp_set_resolution ts_res;
709 struct files_struct *cwd_fsp; /* Working directory. */
712 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
715 * This represents the user information on this connection. Depending
716 * on the vuid using this tid, this might change per SMB request.
718 struct auth_session_info *session_info;
721 * If the "force group" parameter is set, this is the primary gid that
722 * may be used in the users token, depending on the vuid using this tid.
724 gid_t force_group_gid;
726 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
729 time_t lastused_count;
731 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
735 /* Semantics requested by the client or forced by the server config. */
738 bool short_case_preserve;
740 /* Semantics provided by the underlying filesystem. */
742 /* Device number of the directory of the share mount.
743 Used to ensure unique FileIndex returns. */
744 SMB_DEV_T base_share_dev;
746 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
747 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
748 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
749 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
750 struct trans_state *pending_trans;
752 struct rpc_pipe_client *spoolss_pipe;
756 struct smbd_smb2_request;
763 uint64_t mid; /* For compatibility with SMB2. */
765 uint64_t vuid; /* For compatibility with SMB2. */
771 const uint8_t *inbuf;
774 * Async handling in the main smb processing loop is directed by
775 * outbuf: reply_xxx routines indicate sync behaviour by putting their
776 * reply into "outbuf". If they leave it as NULL, they take care of it
777 * themselves, possibly later.
779 * If async handling is wanted, the reply_xxx routine must make sure
780 * that it talloc_move()s the smb_req somewhere else.
786 connection_struct *conn;
787 struct smbd_server_connection *sconn;
788 struct smbXsrv_connection *xconn;
791 * Pointer to session, can be NULL,
792 * eg during negprot and session setup.
794 struct smbXsrv_session *session;
796 struct smb_perfcount_data pcd;
799 * Chained request handling
801 struct files_struct *chain_fsp;
804 * state information for async smb handling
809 * Back pointer to smb2 request.
811 struct smbd_smb2_request *smb2req;
814 * Request list for chained requests, we're part of it.
816 struct smb_request **chain;
818 struct timeval request_time;
820 bool posix_pathnames;
824 * Info about an alternate data stream
827 struct stream_struct {
834 struct smb_file_time {
835 struct timespec mtime;
836 struct timespec atime;
837 struct timespec ctime;
838 struct timespec create_time;
844 struct smb_filename {
852 * Internal file handle, O_PATH based if available,
853 * otherwise O_RDONLY as root.
855 struct files_struct *fsp;
858 * Link between the struct smb_filename and the above
859 * fsp. fsp_link is a talloc child of the fsp. Ensures a possible
860 * talloc_free(fsp) resets the smb_fname->fsp pointer to NULL in
861 * the is fsp_link talloc destructor.
863 struct fsp_smb_fname_link *fsp_link;
867 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
868 * to keep the numeric values consistent.
871 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
873 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
874 handle = handle->next; \
877 enum vfs_translate_direction {
878 vfs_translate_to_unix = 0,
879 vfs_translate_to_windows
882 enum vfs_fallocate_flags {
883 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
884 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
887 struct vfs_aio_state {
893 Available VFS operations. These values must be in sync with vfs_ops struct
894 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
895 In particular, if new operations are added to vfs_ops, appropriate constants
896 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
898 struct shadow_copy_data;
900 struct vfs_fn_pointers {
901 /* Disk operations */
903 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
904 void (*disconnect_fn)(struct vfs_handle_struct *handle);
905 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
906 const struct smb_filename *smb_fname,
910 int (*get_quota_fn)(struct vfs_handle_struct *handle,
911 const struct smb_filename *smb_fname,
912 enum SMB_QUOTA_TYPE qtype,
915 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
916 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
917 int (*statvfs_fn)(struct vfs_handle_struct *handle,
918 const struct smb_filename *smb_fname,
919 struct vfs_statvfs_struct *statbuf);
920 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
923 * Note: that "struct dfs_GetDFSReferral *r"
924 * needs to be a valid TALLOC_CTX
926 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
927 struct dfs_GetDFSReferral *r);
928 NTSTATUS (*create_dfs_pathat_fn)(struct vfs_handle_struct *handle,
929 struct files_struct *dirfsp,
930 const struct smb_filename *smb_fname,
931 const struct referral *reflist,
932 size_t referral_count);
933 NTSTATUS (*read_dfs_pathat_fn)(struct vfs_handle_struct *handle,
935 struct files_struct *dirfsp,
936 struct smb_filename *smb_fname,
937 struct referral **ppreflist,
938 size_t *preferral_count);
940 /* Directory operations */
942 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
943 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
944 struct files_struct *dirfsp,
946 SMB_STRUCT_STAT *sbuf);
947 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
948 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
949 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
950 int (*mkdirat_fn)(struct vfs_handle_struct *handle,
951 struct files_struct *dirfsp,
952 const struct smb_filename *smb_fname,
954 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
956 /* File operations */
958 int (*openat_fn)(struct vfs_handle_struct *handle,
959 const struct files_struct *dirfsp,
960 const struct smb_filename *smb_fname,
961 struct files_struct *fsp,
964 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
965 struct smb_request *req,
966 struct smb_filename *smb_fname,
967 uint32_t access_mask,
968 uint32_t share_access,
969 uint32_t create_disposition,
970 uint32_t create_options,
971 uint32_t file_attributes,
972 uint32_t oplock_request,
973 const struct smb2_lease *lease,
974 uint64_t allocation_size,
975 uint32_t private_flags,
976 struct security_descriptor *sd,
977 struct ea_list *ea_list,
978 files_struct **result,
980 const struct smb2_create_blobs *in_context_blobs,
981 struct smb2_create_blobs *out_context_blobs);
982 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
983 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
984 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
986 struct tevent_context *ev,
987 struct files_struct *fsp,
989 size_t n, off_t offset);
990 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
991 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
992 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
994 struct tevent_context *ev,
995 struct files_struct *fsp,
997 size_t n, off_t offset);
998 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
999 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
1000 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
1001 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
1002 int (*renameat_fn)(struct vfs_handle_struct *handle,
1003 struct files_struct *srcdir_fsp,
1004 const struct smb_filename *smb_fname_src,
1005 struct files_struct *dstdir_fsp,
1006 const struct smb_filename *smb_fname_dst);
1007 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
1008 TALLOC_CTX *mem_ctx,
1009 struct tevent_context *ev,
1010 struct files_struct *fsp);
1011 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1012 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
1013 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1014 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
1015 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
1016 int (*unlinkat_fn)(struct vfs_handle_struct *handle,
1017 struct files_struct *srcdir_fsp,
1018 const struct smb_filename *smb_fname,
1020 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
1021 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
1022 int (*lchown_fn)(struct vfs_handle_struct *handle,
1023 const struct smb_filename *smb_fname,
1026 int (*chdir_fn)(struct vfs_handle_struct *handle,
1027 const struct smb_filename *smb_fname);
1028 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
1029 TALLOC_CTX *mem_ctx);
1030 int (*fntimes_fn)(struct vfs_handle_struct *handle,
1031 struct files_struct *fsp,
1032 struct smb_file_time *ft);
1033 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
1034 int (*fallocate_fn)(struct vfs_handle_struct *handle,
1035 struct files_struct *fsp,
1039 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
1040 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
1041 uint32_t share_access, uint32_t access_mask);
1042 int (*fcntl_fn)(struct vfs_handle_struct *handle,
1043 struct files_struct *fsp, int cmd, va_list cmd_arg);
1044 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
1045 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
1046 int (*symlinkat_fn)(struct vfs_handle_struct *handle,
1047 const struct smb_filename *link_contents,
1048 struct files_struct *dirfsp,
1049 const struct smb_filename *new_smb_fname);
1050 int (*readlinkat_fn)(struct vfs_handle_struct *handle,
1051 const struct files_struct *dirfsp,
1052 const struct smb_filename *smb_fname,
1055 int (*linkat_fn)(struct vfs_handle_struct *handle,
1056 struct files_struct *srcfsp,
1057 const struct smb_filename *old_smb_fname,
1058 struct files_struct *dstfsp,
1059 const struct smb_filename *new_smb_fname,
1061 int (*mknodat_fn)(struct vfs_handle_struct *handle,
1062 struct files_struct *dirfsp,
1063 const struct smb_filename *smb_fname,
1066 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
1068 const struct smb_filename *smb_fname);
1069 int (*chflags_fn)(struct vfs_handle_struct *handle,
1070 const struct smb_filename *smb_fname,
1071 unsigned int flags);
1072 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
1073 const SMB_STRUCT_STAT *sbuf);
1074 uint64_t (*fs_file_id_fn)(struct vfs_handle_struct *handle,
1075 const SMB_STRUCT_STAT *sbuf);
1076 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
1077 struct tevent_context *ev,
1078 struct vfs_handle_struct *handle,
1079 struct files_struct *fsp,
1084 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
1085 struct vfs_handle_struct *handle,
1086 TALLOC_CTX *mem_ctx,
1087 DATA_BLOB *token_blob);
1088 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
1089 TALLOC_CTX *mem_ctx,
1090 struct tevent_context *ev,
1093 off_t transfer_offset,
1094 struct files_struct *dest_fsp,
1097 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
1098 struct tevent_req *req,
1100 NTSTATUS (*fget_compression_fn)(struct vfs_handle_struct *handle,
1101 TALLOC_CTX *mem_ctx,
1102 struct files_struct *fsp,
1103 uint16_t *_compression_fmt);
1104 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
1105 TALLOC_CTX *mem_ctx,
1106 struct files_struct *fsp,
1107 uint16_t compression_fmt);
1108 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
1109 TALLOC_CTX *mem_ctx,
1110 const char *service_path,
1111 char **base_volume);
1112 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
1113 TALLOC_CTX *mem_ctx,
1114 const char *base_volume,
1119 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
1120 TALLOC_CTX *mem_ctx,
1124 NTSTATUS (*fstreaminfo_fn)(struct vfs_handle_struct *handle,
1125 struct files_struct *fsp,
1126 TALLOC_CTX *mem_ctx,
1127 unsigned int *num_streams,
1128 struct stream_struct **streams);
1130 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
1131 const struct smb_filename *path,
1133 TALLOC_CTX *mem_ctx,
1136 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
1137 const struct smb_filename *smb_fname);
1139 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
1140 struct byte_range_lock *br_lck,
1141 struct lock_struct *plock);
1143 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
1144 struct byte_range_lock *br_lck,
1145 const struct lock_struct *plock);
1147 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
1148 struct files_struct *fsp,
1149 struct lock_struct *plock);
1151 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
1153 enum vfs_translate_direction direction,
1154 TALLOC_CTX *mem_ctx,
1155 char **mapped_name);
1157 NTSTATUS (*parent_pathname_fn)(struct vfs_handle_struct *handle,
1158 TALLOC_CTX *mem_ctx,
1159 const struct smb_filename *smb_fname_in,
1160 struct smb_filename **parent_dir_out,
1161 struct smb_filename **atname_out);
1163 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
1164 struct files_struct *fsp,
1168 const uint8_t *_in_data,
1170 uint8_t **_out_data,
1171 uint32_t max_out_len,
1174 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
1175 struct files_struct *fsp,
1178 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
1179 struct files_struct *fsp,
1182 struct tevent_req *(*get_dos_attributes_send_fn)(
1183 TALLOC_CTX *mem_ctx,
1184 struct tevent_context *ev,
1185 struct vfs_handle_struct *handle,
1186 files_struct *dir_fsp,
1187 struct smb_filename *smb_fname);
1189 NTSTATUS (*get_dos_attributes_recv_fn)(
1190 struct tevent_req *req,
1191 struct vfs_aio_state *aio_state,
1194 /* NT ACL operations. */
1196 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
1197 struct files_struct *fsp,
1198 uint32_t security_info,
1199 TALLOC_CTX *mem_ctx,
1200 struct security_descriptor **ppdesc);
1201 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
1202 struct files_struct *fsp,
1203 uint32_t security_info_sent,
1204 const struct security_descriptor *psd);
1206 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
1207 struct smb_filename *file,
1208 struct security_acl *sacl,
1209 uint32_t access_requested,
1210 uint32_t access_denied);
1212 /* POSIX ACL operations. */
1214 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
1215 struct files_struct *fsp,
1216 SMB_ACL_TYPE_T type,
1217 TALLOC_CTX *mem_ctx);
1218 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
1219 TALLOC_CTX *mem_ctx, char **blob_description,
1221 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle,
1222 struct files_struct *fsp,
1223 SMB_ACL_TYPE_T type,
1225 int (*sys_acl_delete_def_fd_fn)(struct vfs_handle_struct *handle,
1226 struct files_struct *fsp);
1228 /* EA operations. */
1229 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
1230 const struct smb_filename *smb_fname,
1234 struct tevent_req *(*getxattrat_send_fn)(
1235 TALLOC_CTX *mem_ctx,
1236 struct tevent_context *ev,
1237 struct vfs_handle_struct *handle,
1238 files_struct *dir_fsp,
1239 const struct smb_filename *smb_fname,
1240 const char *xattr_name,
1242 ssize_t (*getxattrat_recv_fn)(struct tevent_req *req,
1243 struct vfs_aio_state *aio_state,
1244 TALLOC_CTX *mem_ctx,
1245 uint8_t **xattr_value);
1246 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
1247 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
1248 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
1249 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
1251 /* aio operations */
1252 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
1254 /* durable handle operations */
1255 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
1256 struct files_struct *fsp,
1257 TALLOC_CTX *mem_ctx,
1259 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
1260 struct files_struct *fsp,
1261 const DATA_BLOB old_cookie,
1262 TALLOC_CTX *mem_ctx,
1263 DATA_BLOB *new_cookie);
1264 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
1265 struct smb_request *smb1req,
1266 struct smbXsrv_open *op,
1267 const DATA_BLOB old_cookie,
1268 TALLOC_CTX *mem_ctx,
1269 struct files_struct **fsp,
1270 DATA_BLOB *new_cookie);
1272 NTSTATUS (*freaddir_attr_fn)(struct vfs_handle_struct *handle,
1273 struct files_struct *fsp,
1274 TALLOC_CTX *mem_ctx,
1275 struct readdir_attr_data **attr_data);
1279 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1280 which describes all operations this module is willing to intercept.
1281 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1282 using this information.
1285 typedef struct vfs_handle_struct {
1286 struct vfs_handle_struct *next, *prev;
1288 struct connection_struct *conn;
1289 const struct vfs_fn_pointers *fns;
1291 void (*free_data)(void **data);
1292 } vfs_handle_struct;
1295 typedef struct vfs_statvfs_struct {
1296 /* For undefined recommended transfer size return -1 in that field */
1297 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1301 The next three fields are in terms of the block size.
1302 (above). If block size is unknown, 4096 would be a
1303 reasonable block size for a server to report.
1304 Note that returning the blocks/blocksavail removes need
1305 to make a second call (to QFSInfo level 0x103 to get this info.
1306 UserBlockAvail is typically less than or equal to BlocksAvail,
1307 if no distinction is made return the same value in each.
1310 uint64_t TotalBlocks;
1311 uint64_t BlocksAvail; /* bfree */
1312 uint64_t UserBlocksAvail; /* bavail */
1314 /* For undefined Node fields or FSID return -1 */
1315 uint64_t TotalFileNodes;
1316 uint64_t FreeFileNodes;
1317 uint64_t FsIdentifier; /* fsid */
1318 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1319 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1322 } vfs_statvfs_struct;
1324 /* Add a new FSP extension of the given type. Returns a pointer to the
1327 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1328 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1330 /* Return a pointer to the existing FSP extension data. */
1331 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1332 vfs_fetch_fsp_extension(handle, (fsp))
1334 /* Return the talloc context associated with an FSP extension. */
1335 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1336 vfs_memctx_fsp_extension(handle, (fsp))
1338 /* Remove and destroy an FSP extension. */
1339 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1340 vfs_remove_fsp_extension((handle), (fsp))
1342 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1343 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1344 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1349 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1351 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1354 if ((handle)->free_data) { \
1355 (handle)->free_data(&(handle)->data); \
1357 (handle)->data = (void *)datap; \
1358 (handle)->free_data = free_fn; \
1362 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1363 if ((handle) && (handle)->free_data) { \
1364 (handle)->free_data(&(handle)->data); \
1368 /* Check whether module-specific data handle was already allocated or not */
1369 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1371 #define SMB_VFS_OP(x) ((void *) x)
1373 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1375 #include "vfs_macros.h"
1377 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1378 const char *service, const char *user);
1379 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1380 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1381 const struct smb_filename *smb_filename,
1385 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1386 const struct smb_filename *smb_filename,
1387 enum SMB_QUOTA_TYPE qtype,
1389 SMB_DISK_QUOTA *qt);
1390 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1391 enum SMB_QUOTA_TYPE qtype, unid_t id,
1392 SMB_DISK_QUOTA *qt);
1393 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1394 struct files_struct *fsp,
1395 struct shadow_copy_data *shadow_copy_data,
1397 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1398 const struct smb_filename *smb_fname,
1399 struct vfs_statvfs_struct *statbuf);
1400 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1401 enum timestamp_set_resolution *p_ts_res);
1403 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1405 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1406 struct dfs_GetDFSReferral *r);
1407 NTSTATUS smb_vfs_call_create_dfs_pathat(struct vfs_handle_struct *handle,
1408 struct files_struct *dirfsp,
1409 const struct smb_filename *smb_fname,
1410 const struct referral *reflist,
1411 size_t referral_count);
1412 NTSTATUS smb_vfs_call_read_dfs_pathat(struct vfs_handle_struct *handle,
1413 TALLOC_CTX *mem_ctx,
1414 struct files_struct *dirfsp,
1415 struct smb_filename *smb_fname,
1416 struct referral **ppreflist,
1417 size_t *preferral_count);
1418 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1419 struct files_struct *fsp,
1421 uint32_t attributes);
1422 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1423 struct files_struct *dirfsp,
1425 SMB_STRUCT_STAT *sbuf);
1426 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1427 DIR *dirp, long offset);
1428 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1430 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1432 int smb_vfs_call_mkdirat(struct vfs_handle_struct *handle,
1433 struct files_struct *dirfsp,
1434 const struct smb_filename *smb_fname,
1436 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1438 int smb_vfs_call_openat(struct vfs_handle_struct *handle,
1439 const struct files_struct *dirfsp,
1440 const struct smb_filename *smb_fname,
1441 struct files_struct *fsp,
1444 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1445 struct smb_request *req,
1446 struct smb_filename *smb_fname,
1447 uint32_t access_mask,
1448 uint32_t share_access,
1449 uint32_t create_disposition,
1450 uint32_t create_options,
1451 uint32_t file_attributes,
1452 uint32_t oplock_request,
1453 const struct smb2_lease *lease,
1454 uint64_t allocation_size,
1455 uint32_t private_flags,
1456 struct security_descriptor *sd,
1457 struct ea_list *ea_list,
1458 files_struct **result,
1460 const struct smb2_create_blobs *in_context_blobs,
1461 struct smb2_create_blobs *out_context_blobs);
1462 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1463 struct files_struct *fsp);
1464 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1465 struct files_struct *fsp, void *data, size_t n,
1467 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1468 TALLOC_CTX *mem_ctx,
1469 struct tevent_context *ev,
1470 struct files_struct *fsp,
1472 size_t n, off_t offset);
1473 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1475 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1476 struct files_struct *fsp, const void *data,
1477 size_t n, off_t offset);
1478 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1479 TALLOC_CTX *mem_ctx,
1480 struct tevent_context *ev,
1481 struct files_struct *fsp,
1483 size_t n, off_t offset);
1484 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1486 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1487 struct files_struct *fsp, off_t offset,
1489 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1490 files_struct *fromfsp, const DATA_BLOB *header,
1491 off_t offset, size_t count);
1492 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1493 files_struct *tofsp, off_t offset,
1495 int smb_vfs_call_renameat(struct vfs_handle_struct *handle,
1496 struct files_struct *srcfsp,
1497 const struct smb_filename *smb_fname_src,
1498 struct files_struct *dstfsp,
1499 const struct smb_filename *smb_fname_dst);
1501 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1502 TALLOC_CTX *mem_ctx,
1503 struct tevent_context *ev,
1504 struct files_struct *fsp);
1505 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1507 int smb_vfs_fsync_sync(files_struct *fsp);
1508 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1509 struct smb_filename *smb_fname);
1510 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1511 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1512 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1513 struct smb_filename *smb_filename);
1514 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1515 struct files_struct *fsp,
1516 const SMB_STRUCT_STAT *sbuf);
1517 int smb_vfs_call_unlinkat(struct vfs_handle_struct *handle,
1518 struct files_struct *dirfsp,
1519 const struct smb_filename *smb_fname,
1521 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1522 struct files_struct *fsp, mode_t mode);
1523 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1524 struct files_struct *fsp, uid_t uid, gid_t gid);
1525 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1526 const struct smb_filename *smb_fname,
1529 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1530 const struct smb_filename *smb_fname);
1531 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1533 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1534 const struct smb_filename *smb_fname,
1535 struct smb_file_time *ft);
1536 int smb_vfs_call_fntimes(struct vfs_handle_struct *handle,
1537 struct files_struct *fsp,
1538 struct smb_file_time *ft);
1539 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1540 struct files_struct *fsp, off_t offset);
1541 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1542 struct files_struct *fsp,
1546 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1547 struct files_struct *fsp, int op, off_t offset,
1548 off_t count, int type);
1549 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1550 struct files_struct *fsp, uint32_t share_access,
1551 uint32_t access_mask);
1552 int smb_vfs_call_fcntl(struct vfs_handle_struct *handle,
1553 struct files_struct *fsp, int cmd, ...);
1554 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1555 struct files_struct *fsp, int leasetype);
1556 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1557 struct files_struct *fsp, off_t *poffset,
1558 off_t *pcount, int *ptype, pid_t *ppid);
1559 int smb_vfs_call_symlinkat(struct vfs_handle_struct *handle,
1560 const struct smb_filename *link_contents,
1561 struct files_struct *dirfsp,
1562 const struct smb_filename *new_smb_fname);
1563 int smb_vfs_call_readlinkat(struct vfs_handle_struct *handle,
1564 const struct files_struct *dirfsp,
1565 const struct smb_filename *smb_fname,
1568 int smb_vfs_call_linkat(struct vfs_handle_struct *handle,
1569 struct files_struct *srcfsp,
1570 const struct smb_filename *old_smb_fname,
1571 struct files_struct *dstfsp,
1572 const struct smb_filename *new_smb_fname,
1574 int smb_vfs_call_mknodat(struct vfs_handle_struct *handle,
1575 struct files_struct *dirfsp,
1576 const struct smb_filename *smb_fname,
1579 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1581 const struct smb_filename *smb_fname);
1582 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1583 const struct smb_filename *smb_fname,
1584 unsigned int flags);
1585 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1586 const SMB_STRUCT_STAT *sbuf);
1587 uint64_t smb_vfs_call_fs_file_id(struct vfs_handle_struct *handle,
1588 const SMB_STRUCT_STAT *sbuf);
1589 NTSTATUS smb_vfs_call_fstreaminfo(struct vfs_handle_struct *handle,
1590 struct files_struct *fsp,
1591 TALLOC_CTX *mem_ctx,
1592 unsigned int *num_streams,
1593 struct stream_struct **streams);
1594 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1595 const struct smb_filename *path,
1597 TALLOC_CTX *mem_ctx,
1599 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1600 const struct smb_filename *smb_fname);
1601 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1602 struct byte_range_lock *br_lck,
1603 struct lock_struct *plock);
1604 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1605 struct byte_range_lock *br_lck,
1606 const struct lock_struct *plock);
1607 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1608 struct files_struct *fsp,
1609 struct lock_struct *plock);
1610 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1612 enum vfs_translate_direction direction,
1613 TALLOC_CTX *mem_ctx,
1614 char **mapped_name);
1615 NTSTATUS smb_vfs_call_parent_pathname(struct vfs_handle_struct *handle,
1616 TALLOC_CTX *mem_ctx,
1617 const struct smb_filename *smb_fname_in,
1618 struct smb_filename **parent_dir_out,
1619 struct smb_filename **atname_out);
1620 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1621 struct files_struct *fsp,
1625 const uint8_t *_in_data,
1627 uint8_t **_out_data,
1628 uint32_t max_out_len,
1630 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1631 struct files_struct *fsp,
1633 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1634 struct files_struct *fsp,
1636 struct tevent_req *smb_vfs_call_get_dos_attributes_send(
1637 TALLOC_CTX *mem_ctx,
1638 struct tevent_context *ev,
1639 struct vfs_handle_struct *handle,
1640 files_struct *dir_fsp,
1641 struct smb_filename *smb_fname);
1642 NTSTATUS smb_vfs_call_get_dos_attributes_recv(
1643 struct tevent_req *req,
1644 struct vfs_aio_state *aio_state,
1646 struct tevent_req *smb_vfs_call_offload_read_send(
1647 TALLOC_CTX *mem_ctx,
1648 struct tevent_context *ev,
1649 struct vfs_handle_struct *handle,
1650 struct files_struct *fsp,
1655 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1656 struct vfs_handle_struct *handle,
1657 TALLOC_CTX *mem_ctx,
1658 DATA_BLOB *token_blob);
1659 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1660 TALLOC_CTX *mem_ctx,
1661 struct tevent_context *ev,
1664 off_t transfer_offset,
1665 struct files_struct *dest_fsp,
1668 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1669 struct tevent_req *req,
1671 NTSTATUS smb_vfs_call_fget_compression(struct vfs_handle_struct *handle,
1672 TALLOC_CTX *mem_ctx,
1673 struct files_struct *fsp,
1674 uint16_t *_compression_fmt);
1675 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1676 TALLOC_CTX *mem_ctx,
1677 struct files_struct *fsp,
1678 uint16_t compression_fmt);
1679 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1680 TALLOC_CTX *mem_ctx,
1681 const char *service_path,
1682 char **base_volume);
1683 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1684 TALLOC_CTX *mem_ctx,
1685 const char *base_volume,
1690 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1691 TALLOC_CTX *mem_ctx,
1694 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1695 struct files_struct *fsp,
1696 uint32_t security_info,
1697 TALLOC_CTX *mem_ctx,
1698 struct security_descriptor **ppdesc);
1699 NTSTATUS smb_vfs_call_get_nt_acl_at(struct vfs_handle_struct *handle,
1700 struct files_struct *dirfsp,
1701 const struct smb_filename *smb_fname,
1702 uint32_t security_info,
1703 TALLOC_CTX *mem_ctx,
1704 struct security_descriptor **ppdesc);
1705 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1706 struct files_struct *fsp,
1707 uint32_t security_info_sent,
1708 const struct security_descriptor *psd);
1709 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1710 struct smb_filename *file,
1711 struct security_acl *sacl,
1712 uint32_t access_requested,
1713 uint32_t access_denied);
1714 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1715 const struct smb_filename *file,
1717 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1718 struct files_struct *fsp,
1719 SMB_ACL_TYPE_T type,
1720 TALLOC_CTX *mem_ctx);
1721 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1722 struct files_struct *fsp,
1723 TALLOC_CTX *mem_ctx,
1724 char **blob_description,
1726 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1727 struct files_struct *fsp,
1728 SMB_ACL_TYPE_T type,
1730 int smb_vfs_call_sys_acl_delete_def_fd(struct vfs_handle_struct *handle,
1731 struct files_struct *fsp);
1732 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1733 const struct smb_filename *smb_fname,
1737 struct tevent_req *smb_vfs_call_getxattrat_send(
1738 TALLOC_CTX *mem_ctx,
1739 struct tevent_context *ev,
1740 struct vfs_handle_struct *handle,
1741 files_struct *dir_fsp,
1742 const struct smb_filename *smb_fname,
1743 const char *xattr_name,
1745 ssize_t smb_vfs_call_getxattrat_recv(struct tevent_req *req,
1746 struct vfs_aio_state *aio_state,
1747 TALLOC_CTX *mem_ctx,
1748 uint8_t **xattr_value);
1749 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1750 struct files_struct *fsp, const char *name,
1751 void *value, size_t size);
1752 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1753 struct files_struct *fsp, char *list,
1755 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1756 struct files_struct *fsp, const char *name);
1757 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1758 const char *name, const void *value, size_t size,
1760 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1761 struct files_struct *fsp, const char *name,
1762 const void *value, size_t size, int flags);
1763 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1764 struct files_struct *fsp);
1765 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1766 struct files_struct *fsp,
1767 TALLOC_CTX *mem_ctx,
1769 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1770 struct files_struct *fsp,
1771 const DATA_BLOB old_cookie,
1772 TALLOC_CTX *mem_ctx,
1773 DATA_BLOB *new_cookie);
1774 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1775 struct smb_request *smb1req,
1776 struct smbXsrv_open *op,
1777 const DATA_BLOB old_cookie,
1778 TALLOC_CTX *mem_ctx,
1779 struct files_struct **fsp,
1780 DATA_BLOB *new_cookie);
1781 NTSTATUS smb_vfs_call_freaddir_attr(struct vfs_handle_struct *handle,
1782 struct files_struct *fsp,
1783 TALLOC_CTX *mem_ctx,
1784 struct readdir_attr_data **attr_data);
1786 NTSTATUS smb_register_vfs(int version, const char *name,
1787 const struct vfs_fn_pointers *fns);
1788 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1789 files_struct *fsp, size_t ext_size,
1790 void (*destroy_fn)(void *p_data));
1791 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1792 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1793 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle,
1794 const struct files_struct *fsp);
1795 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, const struct files_struct *fsp);
1797 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1798 const char *module);
1801 * Helper functions from source3/modules/vfs_not_implemented.c
1803 int vfs_not_implemented_connect(
1804 vfs_handle_struct *handle,
1805 const char *service,
1807 void vfs_not_implemented_disconnect(vfs_handle_struct *handle);
1808 uint64_t vfs_not_implemented_disk_free(vfs_handle_struct *handle,
1809 const struct smb_filename *smb_fname,
1813 int vfs_not_implemented_get_quota(vfs_handle_struct *handle,
1814 const struct smb_filename *smb_fname,
1815 enum SMB_QUOTA_TYPE qtype,
1817 SMB_DISK_QUOTA *dq);
1818 int vfs_not_implemented_set_quota(vfs_handle_struct *handle,
1819 enum SMB_QUOTA_TYPE qtype,
1820 unid_t id, SMB_DISK_QUOTA *dq);
1821 int vfs_not_implemented_get_shadow_copy_data(vfs_handle_struct *handle,
1823 struct shadow_copy_data *shadow_copy_data,
1825 int vfs_not_implemented_statvfs(struct vfs_handle_struct *handle,
1826 const struct smb_filename *smb_fname,
1827 struct vfs_statvfs_struct *statbuf);
1828 uint32_t vfs_not_implemented_fs_capabilities(struct vfs_handle_struct *handle,
1829 enum timestamp_set_resolution *p_ts_res);
1830 NTSTATUS vfs_not_implemented_get_dfs_referrals(struct vfs_handle_struct *handle,
1831 struct dfs_GetDFSReferral *r);
1832 NTSTATUS vfs_not_implemented_create_dfs_pathat(struct vfs_handle_struct *handle,
1833 struct files_struct *dirfsp,
1834 const struct smb_filename *smb_fname,
1835 const struct referral *reflist,
1836 size_t referral_count);
1837 NTSTATUS vfs_not_implemented_read_dfs_pathat(struct vfs_handle_struct *handle,
1838 TALLOC_CTX *mem_ctx,
1839 struct files_struct *dirfsp,
1840 struct smb_filename *smb_fname,
1841 struct referral **ppreflist,
1842 size_t *preferral_count);
1843 NTSTATUS vfs_not_implemented_snap_check_path(struct vfs_handle_struct *handle,
1844 TALLOC_CTX *mem_ctx,
1845 const char *service_path,
1846 char **base_volume);
1847 NTSTATUS vfs_not_implemented_snap_create(struct vfs_handle_struct *handle,
1848 TALLOC_CTX *mem_ctx,
1849 const char *base_volume,
1854 NTSTATUS vfs_not_implemented_snap_delete(struct vfs_handle_struct *handle,
1855 TALLOC_CTX *mem_ctx,
1858 DIR *vfs_not_implemented_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
1859 const char *mask, uint32_t attr);
1860 struct dirent *vfs_not_implemented_readdir(vfs_handle_struct *handle,
1861 struct files_struct *dirfsp,
1863 SMB_STRUCT_STAT *sbuf);
1864 void vfs_not_implemented_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset);
1865 long vfs_not_implemented_telldir(vfs_handle_struct *handle, DIR *dirp);
1866 void vfs_not_implemented_rewind_dir(vfs_handle_struct *handle, DIR *dirp);
1867 int vfs_not_implemented_mkdirat(vfs_handle_struct *handle,
1868 struct files_struct *dirfsp,
1869 const struct smb_filename *smb_fname,
1871 int vfs_not_implemented_closedir(vfs_handle_struct *handle, DIR *dir);
1872 int vfs_not_implemented_open(vfs_handle_struct *handle,
1873 struct smb_filename *smb_fname,
1874 files_struct *fsp, int flags, mode_t mode);
1875 int vfs_not_implemented_openat(vfs_handle_struct *handle,
1876 const struct files_struct *dirfsp,
1877 const struct smb_filename *smb_fname,
1878 struct files_struct *fsp,
1881 NTSTATUS vfs_not_implemented_create_file(struct vfs_handle_struct *handle,
1882 struct smb_request *req,
1883 struct smb_filename *smb_fname,
1884 uint32_t access_mask,
1885 uint32_t share_access,
1886 uint32_t create_disposition,
1887 uint32_t create_options,
1888 uint32_t file_attributes,
1889 uint32_t oplock_request,
1890 const struct smb2_lease *lease,
1891 uint64_t allocation_size,
1892 uint32_t private_flags,
1893 struct security_descriptor *sd,
1894 struct ea_list *ea_list,
1895 files_struct **result, int *pinfo,
1896 const struct smb2_create_blobs *in_context_blobs,
1897 struct smb2_create_blobs *out_context_blobs);
1898 int vfs_not_implemented_close_fn(vfs_handle_struct *handle, files_struct *fsp);
1899 ssize_t vfs_not_implemented_pread(vfs_handle_struct *handle, files_struct *fsp,
1900 void *data, size_t n, off_t offset);
1901 struct tevent_req *vfs_not_implemented_pread_send(struct vfs_handle_struct *handle,
1902 TALLOC_CTX *mem_ctx,
1903 struct tevent_context *ev,
1904 struct files_struct *fsp,
1905 void *data, size_t n, off_t offset);
1906 ssize_t vfs_not_implemented_pread_recv(struct tevent_req *req,
1907 struct vfs_aio_state *vfs_aio_state);
1908 ssize_t vfs_not_implemented_pwrite(vfs_handle_struct *handle, files_struct *fsp,
1909 const void *data, size_t n, off_t offset);
1910 struct tevent_req *vfs_not_implemented_pwrite_send(struct vfs_handle_struct *handle,
1911 TALLOC_CTX *mem_ctx,
1912 struct tevent_context *ev,
1913 struct files_struct *fsp,
1915 size_t n, off_t offset);
1916 ssize_t vfs_not_implemented_pwrite_recv(struct tevent_req *req,
1917 struct vfs_aio_state *vfs_aio_state);
1918 off_t vfs_not_implemented_lseek(vfs_handle_struct *handle, files_struct *fsp,
1919 off_t offset, int whence);
1920 ssize_t vfs_not_implemented_sendfile(vfs_handle_struct *handle, int tofd,
1921 files_struct *fromfsp, const DATA_BLOB *hdr,
1922 off_t offset, size_t n);
1923 ssize_t vfs_not_implemented_recvfile(vfs_handle_struct *handle, int fromfd,
1924 files_struct *tofsp, off_t offset, size_t n);
1925 int vfs_not_implemented_renameat(vfs_handle_struct *handle,
1926 files_struct *srcfsp,
1927 const struct smb_filename *smb_fname_src,
1928 files_struct *dstfsp,
1929 const struct smb_filename *smb_fname_dst);
1930 struct tevent_req *vfs_not_implemented_fsync_send(struct vfs_handle_struct *handle,
1931 TALLOC_CTX *mem_ctx,
1932 struct tevent_context *ev,
1933 struct files_struct *fsp);
1934 int vfs_not_implemented_fsync_recv(struct tevent_req *req,
1935 struct vfs_aio_state *vfs_aio_state);
1936 int vfs_not_implemented_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname);
1937 int vfs_not_implemented_fstat(vfs_handle_struct *handle, files_struct *fsp,
1938 SMB_STRUCT_STAT *sbuf);
1939 int vfs_not_implemented_lstat(vfs_handle_struct *handle,
1940 struct smb_filename *smb_fname);
1941 uint64_t vfs_not_implemented_get_alloc_size(struct vfs_handle_struct *handle,
1942 struct files_struct *fsp,
1943 const SMB_STRUCT_STAT *sbuf);
1944 int vfs_not_implemented_unlinkat(vfs_handle_struct *handle,
1945 struct files_struct *dirfsp,
1946 const struct smb_filename *smb_fname,
1948 int vfs_not_implemented_fchmod(vfs_handle_struct *handle, files_struct *fsp,
1950 int vfs_not_implemented_fchown(vfs_handle_struct *handle, files_struct *fsp,
1951 uid_t uid, gid_t gid);
1952 int vfs_not_implemented_lchown(vfs_handle_struct *handle,
1953 const struct smb_filename *smb_fname,
1956 int vfs_not_implemented_chdir(vfs_handle_struct *handle,
1957 const struct smb_filename *smb_fname);
1958 struct smb_filename *vfs_not_implemented_getwd(vfs_handle_struct *handle,
1960 int vfs_not_implemented_ntimes(vfs_handle_struct *handle,
1961 const struct smb_filename *smb_fname,
1962 struct smb_file_time *ft);
1963 int vfs_not_implemented_fntimes(vfs_handle_struct *handle,
1965 struct smb_file_time *ft);
1966 int vfs_not_implemented_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
1968 int vfs_not_implemented_fallocate(vfs_handle_struct *handle, files_struct *fsp,
1969 uint32_t mode, off_t offset, off_t len);
1970 bool vfs_not_implemented_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
1971 off_t offset, off_t count, int type);
1972 int vfs_not_implemented_kernel_flock(struct vfs_handle_struct *handle,
1973 struct files_struct *fsp,
1974 uint32_t share_access, uint32_t access_mask);
1975 int vfs_not_implemented_fcntl(struct vfs_handle_struct *handle,
1976 struct files_struct *fsp, int cmd, va_list cmd_arg);
1977 int vfs_not_implemented_linux_setlease(struct vfs_handle_struct *handle,
1978 struct files_struct *fsp, int leasetype);
1979 bool vfs_not_implemented_getlock(vfs_handle_struct *handle, files_struct *fsp,
1980 off_t *poffset, off_t *pcount, int *ptype,
1982 int vfs_not_implemented_symlinkat(vfs_handle_struct *handle,
1983 const struct smb_filename *link_contents,
1984 struct files_struct *dirfsp,
1985 const struct smb_filename *new_smb_fname);
1986 int vfs_not_implemented_vfs_readlinkat(vfs_handle_struct *handle,
1987 const struct files_struct *dirfsp,
1988 const struct smb_filename *smb_fname,
1991 int vfs_not_implemented_linkat(vfs_handle_struct *handle,
1992 struct files_struct *srcfsp,
1993 const struct smb_filename *old_smb_fname,
1994 struct files_struct *dstfsp,
1995 const struct smb_filename *new_smb_fname,
1997 int vfs_not_implemented_mknodat(vfs_handle_struct *handle,
1998 struct files_struct *dirfsp,
1999 const struct smb_filename *smb_fname,
2002 struct smb_filename *vfs_not_implemented_realpath(vfs_handle_struct *handle,
2004 const struct smb_filename *smb_fname);
2005 int vfs_not_implemented_chflags(vfs_handle_struct *handle,
2006 const struct smb_filename *smb_fname,
2008 struct file_id vfs_not_implemented_file_id_create(vfs_handle_struct *handle,
2009 const SMB_STRUCT_STAT *sbuf);
2010 uint64_t vfs_not_implemented_fs_file_id(vfs_handle_struct *handle,
2011 const SMB_STRUCT_STAT *sbuf);
2012 struct tevent_req *vfs_not_implemented_offload_read_send(
2013 TALLOC_CTX *mem_ctx,
2014 struct tevent_context *ev,
2015 struct vfs_handle_struct *handle,
2016 struct files_struct *fsp,
2021 NTSTATUS vfs_not_implemented_offload_read_recv(struct tevent_req *req,
2022 struct vfs_handle_struct *handle,
2023 TALLOC_CTX *mem_ctx,
2024 DATA_BLOB *_token_blob);
2025 struct tevent_req *vfs_not_implemented_offload_write_send(
2026 struct vfs_handle_struct *handle,
2027 TALLOC_CTX *mem_ctx,
2028 struct tevent_context *ev,
2031 off_t transfer_offset,
2032 struct files_struct *dest_fsp,
2035 NTSTATUS vfs_not_implemented_offload_write_recv(struct vfs_handle_struct *handle,
2036 struct tevent_req *req,
2038 NTSTATUS vfs_not_implemented_fget_compression(struct vfs_handle_struct *handle,
2039 TALLOC_CTX *mem_ctx,
2040 struct files_struct *fsp,
2041 uint16_t *_compression_fmt);
2042 NTSTATUS vfs_not_implemented_set_compression(struct vfs_handle_struct *handle,
2043 TALLOC_CTX *mem_ctx,
2044 struct files_struct *fsp,
2045 uint16_t compression_fmt);
2046 NTSTATUS vfs_not_implemented_fstreaminfo(struct vfs_handle_struct *handle,
2047 struct files_struct *fsp,
2048 TALLOC_CTX *mem_ctx,
2049 unsigned int *num_streams,
2050 struct stream_struct **streams);
2051 int vfs_not_implemented_get_real_filename(struct vfs_handle_struct *handle,
2052 const struct smb_filename *path,
2054 TALLOC_CTX *mem_ctx,
2056 const char *vfs_not_implemented_connectpath(struct vfs_handle_struct *handle,
2057 const struct smb_filename *smb_fname);
2058 NTSTATUS vfs_not_implemented_brl_lock_windows(struct vfs_handle_struct *handle,
2059 struct byte_range_lock *br_lck,
2060 struct lock_struct *plock);
2061 bool vfs_not_implemented_brl_unlock_windows(struct vfs_handle_struct *handle,
2062 struct byte_range_lock *br_lck,
2063 const struct lock_struct *plock);
2064 bool vfs_not_implemented_strict_lock_check(struct vfs_handle_struct *handle,
2065 struct files_struct *fsp,
2066 struct lock_struct *plock);
2067 NTSTATUS vfs_not_implemented_translate_name(struct vfs_handle_struct *handle,
2068 const char *mapped_name,
2069 enum vfs_translate_direction direction,
2070 TALLOC_CTX *mem_ctx, char **pmapped_name);
2071 NTSTATUS vfs_not_implemented_parent_pathname(struct vfs_handle_struct *handle,
2072 TALLOC_CTX *mem_ctx,
2073 const struct smb_filename *smb_fname_in,
2074 struct smb_filename **parent_dir_out,
2075 struct smb_filename **atname_out);
2076 NTSTATUS vfs_not_implemented_fsctl(struct vfs_handle_struct *handle,
2077 struct files_struct *fsp,
2080 uint16_t req_flags, /* Needed for UNICODE ... */
2081 const uint8_t *_in_data,
2083 uint8_t **_out_data,
2084 uint32_t max_out_len, uint32_t *out_len);
2085 NTSTATUS vfs_not_implemented_freaddir_attr(struct vfs_handle_struct *handle,
2086 struct files_struct *dirfsp,
2087 TALLOC_CTX *mem_ctx,
2088 struct readdir_attr_data **pattr_data);
2089 struct tevent_req *vfs_not_implemented_get_dos_attributes_send(
2090 TALLOC_CTX *mem_ctx,
2091 struct tevent_context *ev,
2092 struct vfs_handle_struct *handle,
2093 files_struct *dir_fsp,
2094 struct smb_filename *smb_fname);
2095 NTSTATUS vfs_not_implemented_get_dos_attributes_recv(
2096 struct tevent_req *req,
2097 struct vfs_aio_state *aio_state,
2099 NTSTATUS vfs_not_implemented_fget_dos_attributes(struct vfs_handle_struct *handle,
2100 struct files_struct *fsp,
2102 NTSTATUS vfs_not_implemented_set_dos_attributes(struct vfs_handle_struct *handle,
2103 const struct smb_filename *smb_fname,
2105 NTSTATUS vfs_not_implemented_fset_dos_attributes(struct vfs_handle_struct *handle,
2106 struct files_struct *fsp,
2108 NTSTATUS vfs_not_implemented_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2109 uint32_t security_info,
2110 TALLOC_CTX *mem_ctx,
2111 struct security_descriptor **ppdesc);
2112 NTSTATUS vfs_not_implemented_get_nt_acl_at(vfs_handle_struct *handle,
2113 struct files_struct *dirfsp,
2114 const struct smb_filename *smb_fname,
2115 uint32_t security_info,
2116 TALLOC_CTX *mem_ctx,
2117 struct security_descriptor **ppdesc);
2118 NTSTATUS vfs_not_implemented_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2119 uint32_t security_info_sent,
2120 const struct security_descriptor *psd);
2121 SMB_ACL_T vfs_not_implemented_sys_acl_get_fd(vfs_handle_struct *handle,
2123 SMB_ACL_TYPE_T type,
2124 TALLOC_CTX *mem_ctx);
2125 int vfs_not_implemented_sys_acl_blob_get_fd(vfs_handle_struct *handle,
2126 files_struct *fsp, TALLOC_CTX *mem_ctx,
2127 char **blob_description, DATA_BLOB *blob);
2128 int vfs_not_implemented_sys_acl_set_fd(vfs_handle_struct *handle,
2129 struct files_struct *fsp,
2130 SMB_ACL_TYPE_T type,
2132 int vfs_not_implemented_sys_acl_delete_def_fd(vfs_handle_struct *handle,
2134 ssize_t vfs_not_implemented_getxattr(vfs_handle_struct *handle,
2135 const struct smb_filename *smb_fname,
2139 struct tevent_req *vfs_not_implemented_getxattrat_send(
2140 TALLOC_CTX *mem_ctx,
2141 struct tevent_context *ev,
2142 struct vfs_handle_struct *handle,
2143 files_struct *dir_fsp,
2144 const struct smb_filename *smb_fname,
2145 const char *xattr_name,
2147 ssize_t vfs_not_implemented_getxattrat_recv(struct tevent_req *req,
2148 struct vfs_aio_state *aio_state,
2149 TALLOC_CTX *mem_ctx,
2150 uint8_t **xattr_value);
2151 ssize_t vfs_not_implemented_fgetxattr(vfs_handle_struct *handle,
2152 struct files_struct *fsp, const char *name,
2153 void *value, size_t size);
2154 ssize_t vfs_not_implemented_listxattr(vfs_handle_struct *handle,
2155 const struct smb_filename *smb_fname,
2158 ssize_t vfs_not_implemented_flistxattr(vfs_handle_struct *handle,
2159 struct files_struct *fsp, char *list,
2161 int vfs_not_implemented_fremovexattr(vfs_handle_struct *handle,
2162 struct files_struct *fsp, const char *name);
2163 int vfs_not_implemented_setxattr(vfs_handle_struct *handle,
2164 const struct smb_filename *smb_fname,
2169 int vfs_not_implemented_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
2170 const char *name, const void *value, size_t size,
2172 bool vfs_not_implemented_aio_force(struct vfs_handle_struct *handle,
2173 struct files_struct *fsp);
2174 NTSTATUS vfs_not_implemented_audit_file(struct vfs_handle_struct *handle,
2175 struct smb_filename *file,
2176 struct security_acl *sacl,
2177 uint32_t access_requested,
2178 uint32_t access_denied);
2179 NTSTATUS vfs_not_implemented_durable_cookie(struct vfs_handle_struct *handle,
2180 struct files_struct *fsp,
2181 TALLOC_CTX *mem_ctx,
2183 NTSTATUS vfs_not_implemented_durable_disconnect(struct vfs_handle_struct *handle,
2184 struct files_struct *fsp,
2185 const DATA_BLOB old_cookie,
2186 TALLOC_CTX *mem_ctx,
2187 DATA_BLOB *new_cookie);
2188 NTSTATUS vfs_not_implemented_durable_reconnect(struct vfs_handle_struct *handle,
2189 struct smb_request *smb1req,
2190 struct smbXsrv_open *op,
2191 const DATA_BLOB old_cookie,
2192 TALLOC_CTX *mem_ctx,
2193 struct files_struct **fsp,
2194 DATA_BLOB *new_cookie);