gp: Fix startup scripts add not always set runonce
[Samba.git] / source3 / include / vfs.h
blob1cc3b91a9e0a3b861da7ebb7316b9180bbdb3a30
1 /*
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.
26 #ifndef _VFS_H
27 #define _VFS_H
29 /* Avoid conflict with an AIX include file */
31 #ifdef vfs_ops
32 #undef vfs_ops
33 #endif
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
43 * vfs_ops below. JRA.
45 * If you change anything here, please also update modules/vfs_full_audit.c.
46 * VL.
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
112 * open handle. JRA.
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
259 * connection struct
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
303 * bool can_lock
304 * bool can_read
305 * bool can_write
306 * bool modified
307 * bool is_directory
308 * bool aio_write_behind
309 * bool initial_delete_on_close
310 * bool delete_on_close
311 * bool is_sparse
312 * bool backup_intent
313 * bool use_ofd_locks
314 * bool closing
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
329 otherwise.
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
361 * Version 45 - Add SMB_VFS_FCHFLAGS
362 * Version 45 - Remove SMB_VFS_GETXATTR
363 * Change to Version 46 - will ship with 4.16
364 * Version 46 - Rename SMB_VFS_KERNEL_FLOCK to SMB_VFS_FILESYSTEM_SHAREMODE
365 * Version 46 - Add flags and xferlen args to SMB_VFS_OFFLOAD_READ_RECV
366 * Change to Version 47 - will ship with 4.17
367 * Version 47 - Add SMB_VFS_FSTATAT
368 * Version 47 - Change SMB_VFS_GET_REAL_FILENAME to return NTSTATUS
369 * Version 47 - remove st_ex_itime from struct stat_ex
370 * Version 47 - remove (unused) struct lock_struct last_lock_failure
371 from files_struct.
372 * Version 47 - Add SMB_VFS_GET_REAL_FILENAME_AT
373 * Version 47 - Replace SMB_VFS_GET_REAL_FILENAME with SMB_VFS_GET_REAL_FILENAME_AT
374 * Version 47 - Re-add dirfsp to CREATE_FILE
375 * Version 47 - Add fsp flag fstat_before_close
376 * Version 47 - Change SMB_VFS_OPENAT() to match the Linux openat2 prototype, add vfs_open_how
377 * Version 47 - Add VFS_OPEN_HOW_RESOLVE_NO_SYMLINKS for SMB_VFS_OPENAT()
378 * Change to Version 48 - will ship with 4.18
379 * Version 48 - Add cached_dos_attributes to struct stat_ex
380 * Version 48 - Add dirfsp to connectpath_fn()
383 #define SMB_VFS_INTERFACE_VERSION 48
386 All intercepted VFS operations must be declared as static functions inside module source
387 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
388 example VFS modules for more details.
391 /* VFS operations structure */
393 struct vfs_handle_struct;
394 struct connection_struct;
395 struct files_struct;
396 struct security_descriptor;
397 struct vfs_statvfs_struct;
398 struct smb_request;
399 struct ea_list;
400 struct smb_file_time;
401 struct smb_filename;
402 struct dfs_GetDFSReferral;
404 typedef union unid_t {
405 uid_t uid;
406 gid_t gid;
407 } unid_t;
409 struct fd_handle;
411 struct fsp_lease {
412 size_t ref_count;
413 struct smbd_server_connection *sconn;
414 struct tevent_timer *timeout;
415 struct smb2_lease lease;
418 typedef struct files_struct {
419 struct files_struct *next, *prev;
420 uint64_t fnum;
421 struct smbXsrv_open *op;
422 struct connection_struct *conn;
423 struct fd_handle *fh;
424 unsigned int num_smb_operations;
425 struct file_id file_id;
426 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
427 uint16_t file_pid;
428 uint64_t vuid; /* SMB2 compat */
429 struct timeval open_time;
430 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
431 struct {
432 bool is_pathref : 1; /* See below */
433 bool is_fsa : 1; /* See below */
434 bool have_proc_fds : 1;
435 bool kernel_share_modes_taken : 1;
436 bool update_write_time_triggered : 1;
437 bool update_write_time_on_close : 1;
438 bool write_time_forced : 1;
439 bool can_lock : 1;
440 bool can_read : 1;
441 bool can_write : 1;
442 bool modified : 1;
443 bool is_directory : 1;
444 bool is_dirfsp : 1;
445 bool aio_write_behind : 1;
446 bool initial_delete_on_close : 1;
447 bool delete_on_close : 1;
448 bool is_sparse : 1;
449 bool backup_intent : 1;
450 bool use_ofd_locks : 1;
451 bool closing : 1;
452 bool lock_failure_seen : 1;
453 bool encryption_required : 1;
454 bool fstat_before_close : 1;
455 } fsp_flags;
457 struct tevent_timer *update_write_time_event;
458 struct timespec close_write_time;
460 int oplock_type;
463 * Cache of our lease_type, stored as "current_state" in
464 * leases.tdb
466 int leases_db_seqnum;
467 uint32_t lease_type;
469 struct fsp_lease *lease;
470 int sent_oplock_break;
471 struct tevent_timer *oplock_timeout;
472 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
474 uint64_t posix_flags;
475 struct smb_filename *fsp_name;
476 uint32_t name_hash; /* Jenkins hash of full pathname. */
477 uint64_t mid; /* Mid of the operation that created us. */
479 struct vfs_fsp_data *vfs_extension;
480 struct fake_file_handle *fake_file_handle;
482 struct notify_change_buf *notify;
484 struct files_struct *base_fsp; /* placeholder for delete on close */
485 struct files_struct *stream_fsp; /* backlink from base_fsp */
488 * Cache of share_mode_data->flags
490 int share_mode_flags_seqnum;
491 uint16_t share_mode_flags;
494 * Read-only cached brlock record, thrown away when the
495 * brlock.tdb seqnum changes. This avoids fetching data from
496 * the brlock.tdb on every read/write call.
498 int brlock_seqnum;
499 struct byte_range_lock *brlock_rec;
501 struct dptr_struct *dptr;
503 /* if not NULL, means this is a print file */
504 struct print_file_data *print_file;
507 * Optimize the aio_requests array for high performance: Never
508 * shrink it, maintain num_aio_requests separately
510 unsigned num_aio_requests;
511 struct tevent_req **aio_requests;
514 * Requests waiting for smb1 byte range locks. They are
515 * generated by smbd_smb1_do_locks_send and are required here,
516 * because lock cancel operations index through reply_lockingX
517 * not based on mid but on the lock type and range.
519 struct tevent_req **blocked_smb1_lock_reqs;
522 * SMB1 remembers lock failures and delays repeated blocking
523 * lock attempts on the same offset.
525 uint64_t lock_failure_offset;
526 } files_struct;
529 * The fsp flags "is_pathref" and "is_fsa"
530 * =======================================
532 * Summary
533 * -------
535 * The flag "is_pathref" is a property of the low-level VFS-layer file
536 * handle. If "is_pathref" is true, only a subset of VFS calls are allowed
537 * on the handle and on systems that support it, the low-level fd is open
538 * with O_PATH. If "is_pathref" is false, the low-level fd is a "normal"
539 * file descriptor that can be used with all VFS calls.
541 * The flag "is_fsa" is a property of the FSA layer in Samba. The term FSA
542 * layer refers to the parts of smbd that implement Windows NTFS semantics
543 * on-top of a POSIX filesystem. If "is_fsa" is true, the fsp was
544 * processed by the SMB_VFS_CREATE_FILE() VFS call, otherwise the fsp was
545 * created by openat_pathref_fsp() which only connected the low-level
546 * handle by calling into VFS SMB_VFS_OPENAT(), but the whole FSA layer
547 * logic is skipped.
549 * Note that only three possible combinations of "is_pathref" and "is_fsa"
550 * are possible:
552 * | is_fsa \ is_pathref | + | - |
553 * |---------------------+---+---|
554 * | + | + | + |
555 * | - | + | - |
557 * So a fsp can't be a full low-level fd (is_pathref=false) and not be
558 * processed by the FSA layer.
560 * Details
561 * -------
563 * On Linux the O_PATH flag to open() can be used to open a filehandle on
564 * a file or directory with interesting properties:
566 * - the file-handle indicates a location in the filesystem tree,
567 * - no permission checks are done by the kernel and
568 * - only operations that act purely at the file descriptor level are
569 * allowed.
571 * The file itself is not opened, and other file operations (e.g.,
572 * read(2), write(2), fchmod(2), fchown(2), fgetxattr(2), ioctl(2),
573 * mmap(2)) fail with the error EBADF.
575 * The following subset of operations that is relevant to Samba is allowed:
577 * - close(2),
578 * - fchdir(2), if the file descriptor refers to a directory,
579 * - fstat(2),
580 * - fstatfs(2) and
581 * - passing the file descriptor as the dirfd argument of openat() and the
582 * other "*at()" system calls. This includes linkat(2) with
583 * AT_EMPTY_PATH (or via procfs using AT_SYMLINK_FOLLOW) even if the
584 * file is not a directory.
586 * Opening a file or directory with the O_PATH flag requires no
587 * permissions on the object itself (but does require execute permission
588 * on the directories in the path prefix). By contrast, obtaining a
589 * reference to a filesystem object by opening it with the O_RDONLY flag
590 * requires that the caller have read permission on the object, even when
591 * the subsequent operation (e.g., fchdir(2), fstat(2)) does not require
592 * read permission on the object. [1]
594 * If for example Samba receives an SMB request to open a file requesting
595 * SEC_FILE_READ_ATTRIBUTE access rights because the client wants to read
596 * the file's metadata from the handle, Samba will have to call POSIX
597 * open() with at least O_RDONLY access rights.
599 * Usecase for O_PATH in Samba
600 * ---------------------------
602 * By leveraging this Linux specific flags we can avoid permission
603 * mismatches as described above. Additionally O_PATH allows basing all
604 * filesystem accesses done by the fileserver on handle based syscalls by
605 * opening all client pathnames with O_PATH and consistently using for
606 * example fstat() instead of stat() throughout the codebase.
608 * Subsequently we will refer to Samba file-handles (fsp's) opened with
609 * O_PATH "path referencing fsp's" or "pathref" fsp's for short.
611 * Currently Samba bases the decision whether to call POSIX open() on a
612 * client pathname or whether to leave the low-level handle at -1, what we
613 * call a stat-open, in the function open_file() and it is based on the
614 * client requested SMB acccess mask.
616 * The set of rights that trigger an open() include READ_CONTROL_ACCESS,
617 * resulting in a call to open() with at least O_RDONLY. If the filesystem
618 * supports NT style ACLs natively (like GPFS or ZFS), the filesystem may
619 * grant the user requested right READ_CONTROL_ACCESS, but it may not
620 * grant READ_DATA (O_RDONLY), resulting in a permission denied error.
622 * Historically the set of access rights that triggered opening a file was:
624 * FILE_READ_DATA
625 * FILE_WRITE_DATA
626 * FILE_APPEND_DATA
627 * FILE_EXECUTE
628 * WRITE_DAC_ACCESS
629 * WRITE_OWNER_ACCESS
630 * SEC_FLAG_SYSTEM_SECURITY
631 * READ_CONTROL_ACCESS
633 * By using O_PATH this can be trimmed down to
635 * FILE_READ_DATA
636 * FILE_WRITE_DATA
637 * FILE_APPEND_DATA
638 * FILE_EXECUTE
640 * Fallback on systems without O_PATH support
641 * ------------------------------------------
643 * A fallback is needed that allows opening a file-handle with the same
644 * higher level semantics even if the system doesn't support O_PATH. This
645 * is implemented by impersonating the root user for the open()
646 * syscall. To avoid bypassing restrictive permissions on intermediate
647 * directories components of a path, the root user is only impersonated
648 * after changing directory to the parent directory of the client
649 * requested pathname.
651 * In order to avoid privilege escalation security issues with these root
652 * opened file-handles we must carefully control their usage throughout
653 * the codebase. Therefore we
655 * - tag the pathref fsp's with the flag "is_pathref" and
657 * - control access to the file-handle by making the structure private and only
658 * allowing access with accessor functions.
660 * Two functions are used to fetch the low-level system file-handle from an fsp
662 * - fsp_get_io_fd(fsp): enforces fsp is NOT a pathref file-handle and
664 * - fsp_get_pathref_fd(fsp): allows fsp to be either a pathref file-handle or a
665 * traditional POSIX file-handle opened with O_RDONLY or any other POSIX open
666 * flag.
668 * The general guideline when to use which function is:
670 * - if you do something like fstat(fd), use fsp_get_pathref_fd(fsp),
671 * - if you do something like *at(dirfd, ...), use fsp_get_pathref_fd(fsp),
672 * - if you want to print the fd for example in DEBUG messages, use
673 * fsp_get_pathref_fd(fsp),
674 * - if you want to call close(fd), use fsp_get_pathref_fd(fsp),
675 * - if you're doing a logical comparison of fd values, use
676 * fsp_get_pathref_fd().
678 * In any other case use fsp_get_io_fd().
681 #define FSP_POSIX_FLAGS_OPEN 0x01
682 #define FSP_POSIX_FLAGS_RENAME 0x02
683 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
685 #define FSP_POSIX_FLAGS_ALL \
686 (FSP_POSIX_FLAGS_OPEN | \
687 FSP_POSIX_FLAGS_PATHNAMES | \
688 FSP_POSIX_FLAGS_RENAME)
690 struct vuid_cache_entry {
691 struct auth_session_info *session_info;
692 uint64_t vuid; /* SMB2 compat */
693 bool read_only;
694 uint32_t share_access;
697 struct vuid_cache {
698 unsigned int next_entry;
699 struct vuid_cache_entry array[VUID_CACHE_SIZE];
702 typedef struct {
703 char *name;
704 bool is_wild;
705 } name_compare_entry;
707 struct share_params {
708 int service;
711 typedef struct connection_struct {
712 struct connection_struct *next, *prev;
713 struct smbd_server_connection *sconn; /* can be NULL */
714 struct smbXsrv_tcon *tcon; /* can be NULL */
715 uint32_t cnum; /* an index passed over the wire */
716 struct share_params *params;
717 bool force_user;
718 struct vuid_cache *vuid_cache;
719 bool printer;
720 bool ipc;
721 bool read_only; /* Attributes for the current user of the share. */
722 bool have_proc_fds;
723 uint64_t open_how_resolve; /* supported vfs_open_how.resolve features */
724 uint32_t share_access;
725 /* Does this filesystem honor
726 sub second timestamps on files
727 and directories when setting time ? */
728 enum timestamp_set_resolution ts_res;
729 char *connectpath;
730 struct files_struct *cwd_fsp; /* Working directory. */
731 bool tcon_done;
733 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
736 * This represents the user information on this connection. Depending
737 * on the vuid using this tid, this might change per SMB request.
739 struct auth_session_info *session_info;
742 * If the "force group" parameter is set, this is the primary gid that
743 * may be used in the users token, depending on the vuid using this tid.
745 gid_t force_group_gid;
747 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
749 time_t lastused;
750 time_t lastused_count;
751 int num_files_open;
752 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
753 int encrypt_level;
754 bool encrypted_tid;
756 /* Semantics requested by the client or forced by the server config. */
757 bool case_sensitive;
758 bool case_preserve;
759 bool short_case_preserve;
761 /* Semantics provided by the underlying filesystem. */
762 int fs_capabilities;
763 /* Device number of the directory of the share mount.
764 Used to ensure unique FileIndex returns. */
765 SMB_DEV_T base_share_dev;
767 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
768 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
769 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
770 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
771 struct trans_state *pending_trans;
773 struct rpc_pipe_client *spoolss_pipe;
775 } connection_struct;
777 struct smbd_smb2_request;
778 struct referral;
780 struct smb_request {
781 uint8_t cmd;
782 uint16_t flags2;
783 uint16_t smbpid;
784 uint64_t mid; /* For compatibility with SMB2. */
785 uint32_t seqnum;
786 uint64_t vuid; /* For compatibility with SMB2. */
787 uint32_t tid;
788 uint8_t wct;
789 const uint16_t *vwv;
790 uint16_t buflen;
791 const uint8_t *buf;
792 const uint8_t *inbuf;
795 * Async handling in the main smb processing loop is directed by
796 * outbuf: reply_xxx routines indicate sync behaviour by putting their
797 * reply into "outbuf". If they leave it as NULL, they take care of it
798 * themselves, possibly later.
800 * If async handling is wanted, the reply_xxx routine must make sure
801 * that it talloc_move()s the smb_req somewhere else.
803 uint8_t *outbuf;
805 size_t unread_bytes;
806 bool encrypted;
807 connection_struct *conn;
808 struct smbd_server_connection *sconn;
809 struct smbXsrv_connection *xconn;
812 * Pointer to session, can be NULL,
813 * eg during negprot and session setup.
815 struct smbXsrv_session *session;
817 struct smb_perfcount_data pcd;
820 * Chained request handling
822 struct files_struct *chain_fsp;
825 * state information for async smb handling
827 void *async_priv;
830 * Back pointer to smb2 request.
832 struct smbd_smb2_request *smb2req;
835 * Request list for chained requests, we're part of it.
837 struct smb_request **chain;
839 struct timeval request_time;
841 bool posix_pathnames;
845 * Info about an alternate data stream
848 struct stream_struct {
849 off_t size;
850 off_t alloc_size;
851 char *name;
854 /* time info */
855 struct smb_file_time {
856 struct timespec mtime;
857 struct timespec atime;
858 struct timespec ctime;
859 struct timespec create_time;
863 * smb_filename
865 struct smb_filename {
866 char *base_name;
867 char *stream_name;
868 uint32_t flags;
869 SMB_STRUCT_STAT st;
870 NTTIME twrp;
873 * Internal file handle, O_PATH based if available,
874 * otherwise O_RDONLY as root.
876 struct files_struct *fsp;
879 * Link between the struct smb_filename and the above
880 * fsp. fsp_link is a talloc child of the fsp. Ensures a possible
881 * talloc_free(fsp) resets the smb_fname->fsp pointer to NULL in
882 * the is fsp_link talloc destructor.
884 struct fsp_smb_fname_link *fsp_link;
888 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
889 * to keep the numeric values consistent.
892 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
894 enum vfs_translate_direction {
895 vfs_translate_to_unix = 0,
896 vfs_translate_to_windows
899 enum vfs_fallocate_flags {
900 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
901 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
904 struct vfs_aio_state {
905 int error;
906 uint64_t duration;
909 #define VFS_OPEN_HOW_RESOLVE_NO_SYMLINKS 1
911 struct vfs_open_how {
912 int flags;
913 mode_t mode;
914 uint64_t resolve;
918 Available VFS operations. These values must be in sync with vfs_ops struct
919 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
920 In particular, if new operations are added to vfs_ops, appropriate constants
921 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
923 struct shadow_copy_data;
925 struct vfs_fn_pointers {
926 /* Disk operations */
928 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
929 void (*disconnect_fn)(struct vfs_handle_struct *handle);
930 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
931 const struct smb_filename *smb_fname,
932 uint64_t *bsize,
933 uint64_t *dfree,
934 uint64_t *dsize);
935 int (*get_quota_fn)(struct vfs_handle_struct *handle,
936 const struct smb_filename *smb_fname,
937 enum SMB_QUOTA_TYPE qtype,
938 unid_t id,
939 SMB_DISK_QUOTA *qt);
940 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
941 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
942 int (*statvfs_fn)(struct vfs_handle_struct *handle,
943 const struct smb_filename *smb_fname,
944 struct vfs_statvfs_struct *statbuf);
945 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
948 * Note: that "struct dfs_GetDFSReferral *r"
949 * needs to be a valid TALLOC_CTX
951 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
952 struct dfs_GetDFSReferral *r);
953 NTSTATUS (*create_dfs_pathat_fn)(struct vfs_handle_struct *handle,
954 struct files_struct *dirfsp,
955 const struct smb_filename *smb_fname,
956 const struct referral *reflist,
957 size_t referral_count);
958 NTSTATUS (*read_dfs_pathat_fn)(struct vfs_handle_struct *handle,
959 TALLOC_CTX *mem_ctx,
960 struct files_struct *dirfsp,
961 struct smb_filename *smb_fname,
962 struct referral **ppreflist,
963 size_t *preferral_count);
965 /* Directory operations */
967 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
968 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
969 struct files_struct *dirfsp,
970 DIR *dirp,
971 SMB_STRUCT_STAT *sbuf);
972 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
973 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
974 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
975 int (*mkdirat_fn)(struct vfs_handle_struct *handle,
976 struct files_struct *dirfsp,
977 const struct smb_filename *smb_fname,
978 mode_t mode);
979 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
981 /* File operations */
983 int (*openat_fn)(struct vfs_handle_struct *handle,
984 const struct files_struct *dirfsp,
985 const struct smb_filename *smb_fname,
986 struct files_struct *fsp,
987 const struct vfs_open_how *how);
988 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
989 struct smb_request *req,
990 struct files_struct *dirfsp,
991 struct smb_filename *smb_fname,
992 uint32_t access_mask,
993 uint32_t share_access,
994 uint32_t create_disposition,
995 uint32_t create_options,
996 uint32_t file_attributes,
997 uint32_t oplock_request,
998 const struct smb2_lease *lease,
999 uint64_t allocation_size,
1000 uint32_t private_flags,
1001 struct security_descriptor *sd,
1002 struct ea_list *ea_list,
1003 files_struct **result,
1004 int *pinfo,
1005 const struct smb2_create_blobs *in_context_blobs,
1006 struct smb2_create_blobs *out_context_blobs);
1007 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
1008 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
1009 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
1010 TALLOC_CTX *mem_ctx,
1011 struct tevent_context *ev,
1012 struct files_struct *fsp,
1013 void *data,
1014 size_t n, off_t offset);
1015 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1016 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
1017 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
1018 TALLOC_CTX *mem_ctx,
1019 struct tevent_context *ev,
1020 struct files_struct *fsp,
1021 const void *data,
1022 size_t n, off_t offset);
1023 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1024 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
1025 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
1026 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
1027 int (*renameat_fn)(struct vfs_handle_struct *handle,
1028 struct files_struct *srcdir_fsp,
1029 const struct smb_filename *smb_fname_src,
1030 struct files_struct *dstdir_fsp,
1031 const struct smb_filename *smb_fname_dst);
1032 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
1033 TALLOC_CTX *mem_ctx,
1034 struct tevent_context *ev,
1035 struct files_struct *fsp);
1036 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
1037 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
1038 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1039 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
1040 int (*fstatat_fn)(
1041 struct vfs_handle_struct *handle,
1042 const struct files_struct *dirfsp,
1043 const struct smb_filename *smb_fname,
1044 SMB_STRUCT_STAT *sbuf,
1045 int flags);
1046 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
1047 int (*unlinkat_fn)(struct vfs_handle_struct *handle,
1048 struct files_struct *srcdir_fsp,
1049 const struct smb_filename *smb_fname,
1050 int flags);
1051 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
1052 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
1053 int (*lchown_fn)(struct vfs_handle_struct *handle,
1054 const struct smb_filename *smb_fname,
1055 uid_t uid,
1056 gid_t gid);
1057 int (*chdir_fn)(struct vfs_handle_struct *handle,
1058 const struct smb_filename *smb_fname);
1059 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
1060 TALLOC_CTX *mem_ctx);
1061 int (*fntimes_fn)(struct vfs_handle_struct *handle,
1062 struct files_struct *fsp,
1063 struct smb_file_time *ft);
1064 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
1065 int (*fallocate_fn)(struct vfs_handle_struct *handle,
1066 struct files_struct *fsp,
1067 uint32_t mode,
1068 off_t offset,
1069 off_t len);
1070 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
1071 int (*filesystem_sharemode_fn)(struct vfs_handle_struct *handle,
1072 struct files_struct *fsp,
1073 uint32_t share_access, uint32_t
1074 access_mask);
1075 int (*fcntl_fn)(struct vfs_handle_struct *handle,
1076 struct files_struct *fsp, int cmd, va_list cmd_arg);
1077 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
1078 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
1079 int (*symlinkat_fn)(struct vfs_handle_struct *handle,
1080 const struct smb_filename *link_contents,
1081 struct files_struct *dirfsp,
1082 const struct smb_filename *new_smb_fname);
1083 int (*readlinkat_fn)(struct vfs_handle_struct *handle,
1084 const struct files_struct *dirfsp,
1085 const struct smb_filename *smb_fname,
1086 char *buf,
1087 size_t bufsiz);
1088 int (*linkat_fn)(struct vfs_handle_struct *handle,
1089 struct files_struct *srcfsp,
1090 const struct smb_filename *old_smb_fname,
1091 struct files_struct *dstfsp,
1092 const struct smb_filename *new_smb_fname,
1093 int flags);
1094 int (*mknodat_fn)(struct vfs_handle_struct *handle,
1095 struct files_struct *dirfsp,
1096 const struct smb_filename *smb_fname,
1097 mode_t mode,
1098 SMB_DEV_T dev);
1099 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
1100 TALLOC_CTX *ctx,
1101 const struct smb_filename *smb_fname);
1102 int (*fchflags_fn)(struct vfs_handle_struct *handle,
1103 struct files_struct *fsp,
1104 unsigned int flags);
1105 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
1106 const SMB_STRUCT_STAT *sbuf);
1107 uint64_t (*fs_file_id_fn)(struct vfs_handle_struct *handle,
1108 const SMB_STRUCT_STAT *sbuf);
1109 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
1110 struct tevent_context *ev,
1111 struct vfs_handle_struct *handle,
1112 struct files_struct *fsp,
1113 uint32_t fsctl,
1114 uint32_t ttl,
1115 off_t offset,
1116 size_t to_copy);
1117 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
1118 struct vfs_handle_struct *handle,
1119 TALLOC_CTX *mem_ctx,
1120 uint32_t *flags,
1121 uint64_t *xferlen,
1122 DATA_BLOB *token_blob);
1123 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
1124 TALLOC_CTX *mem_ctx,
1125 struct tevent_context *ev,
1126 uint32_t fsctl,
1127 DATA_BLOB *token,
1128 off_t transfer_offset,
1129 struct files_struct *dest_fsp,
1130 off_t dest_off,
1131 off_t to_copy);
1132 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
1133 struct tevent_req *req,
1134 off_t *copied);
1135 NTSTATUS (*fget_compression_fn)(struct vfs_handle_struct *handle,
1136 TALLOC_CTX *mem_ctx,
1137 struct files_struct *fsp,
1138 uint16_t *_compression_fmt);
1139 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
1140 TALLOC_CTX *mem_ctx,
1141 struct files_struct *fsp,
1142 uint16_t compression_fmt);
1143 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
1144 TALLOC_CTX *mem_ctx,
1145 const char *service_path,
1146 char **base_volume);
1147 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
1148 TALLOC_CTX *mem_ctx,
1149 const char *base_volume,
1150 time_t *tstamp,
1151 bool rw,
1152 char **base_path,
1153 char **snap_path);
1154 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
1155 TALLOC_CTX *mem_ctx,
1156 char *base_path,
1157 char *snap_path);
1159 NTSTATUS (*fstreaminfo_fn)(struct vfs_handle_struct *handle,
1160 struct files_struct *fsp,
1161 TALLOC_CTX *mem_ctx,
1162 unsigned int *num_streams,
1163 struct stream_struct **streams);
1165 NTSTATUS (*get_real_filename_at_fn)(struct vfs_handle_struct *handle,
1166 struct files_struct *dirfsp,
1167 const char *name,
1168 TALLOC_CTX *mem_ctx,
1169 char **found_name);
1171 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
1172 const struct files_struct *dirfsp,
1173 const struct smb_filename *smb_fname);
1175 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
1176 struct byte_range_lock *br_lck,
1177 struct lock_struct *plock);
1179 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
1180 struct byte_range_lock *br_lck,
1181 const struct lock_struct *plock);
1183 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
1184 struct files_struct *fsp,
1185 struct lock_struct *plock);
1187 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
1188 const char *name,
1189 enum vfs_translate_direction direction,
1190 TALLOC_CTX *mem_ctx,
1191 char **mapped_name);
1193 NTSTATUS (*parent_pathname_fn)(struct vfs_handle_struct *handle,
1194 TALLOC_CTX *mem_ctx,
1195 const struct smb_filename *smb_fname_in,
1196 struct smb_filename **parent_dir_out,
1197 struct smb_filename **atname_out);
1199 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
1200 struct files_struct *fsp,
1201 TALLOC_CTX *ctx,
1202 uint32_t function,
1203 uint16_t req_flags,
1204 const uint8_t *_in_data,
1205 uint32_t in_len,
1206 uint8_t **_out_data,
1207 uint32_t max_out_len,
1208 uint32_t *out_len);
1210 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
1211 struct files_struct *fsp,
1212 uint32_t *dosmode);
1214 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
1215 struct files_struct *fsp,
1216 uint32_t dosmode);
1218 struct tevent_req *(*get_dos_attributes_send_fn)(
1219 TALLOC_CTX *mem_ctx,
1220 struct tevent_context *ev,
1221 struct vfs_handle_struct *handle,
1222 files_struct *dir_fsp,
1223 struct smb_filename *smb_fname);
1225 NTSTATUS (*get_dos_attributes_recv_fn)(
1226 struct tevent_req *req,
1227 struct vfs_aio_state *aio_state,
1228 uint32_t *dosmode);
1230 /* NT ACL operations. */
1232 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
1233 struct files_struct *fsp,
1234 uint32_t security_info,
1235 TALLOC_CTX *mem_ctx,
1236 struct security_descriptor **ppdesc);
1237 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
1238 struct files_struct *fsp,
1239 uint32_t security_info_sent,
1240 const struct security_descriptor *psd);
1242 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
1243 struct smb_filename *file,
1244 struct security_acl *sacl,
1245 uint32_t access_requested,
1246 uint32_t access_denied);
1248 /* POSIX ACL operations. */
1250 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
1251 struct files_struct *fsp,
1252 SMB_ACL_TYPE_T type,
1253 TALLOC_CTX *mem_ctx);
1254 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
1255 TALLOC_CTX *mem_ctx, char **blob_description,
1256 DATA_BLOB *blob);
1257 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle,
1258 struct files_struct *fsp,
1259 SMB_ACL_TYPE_T type,
1260 SMB_ACL_T theacl);
1261 int (*sys_acl_delete_def_fd_fn)(struct vfs_handle_struct *handle,
1262 struct files_struct *fsp);
1264 /* EA operations. */
1265 struct tevent_req *(*getxattrat_send_fn)(
1266 TALLOC_CTX *mem_ctx,
1267 struct tevent_context *ev,
1268 struct vfs_handle_struct *handle,
1269 files_struct *dir_fsp,
1270 const struct smb_filename *smb_fname,
1271 const char *xattr_name,
1272 size_t alloc_hint);
1273 ssize_t (*getxattrat_recv_fn)(struct tevent_req *req,
1274 struct vfs_aio_state *aio_state,
1275 TALLOC_CTX *mem_ctx,
1276 uint8_t **xattr_value);
1277 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
1278 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
1279 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
1280 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
1282 /* aio operations */
1283 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
1285 /* durable handle operations */
1286 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
1287 struct files_struct *fsp,
1288 TALLOC_CTX *mem_ctx,
1289 DATA_BLOB *cookie);
1290 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
1291 struct files_struct *fsp,
1292 const DATA_BLOB old_cookie,
1293 TALLOC_CTX *mem_ctx,
1294 DATA_BLOB *new_cookie);
1295 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
1296 struct smb_request *smb1req,
1297 struct smbXsrv_open *op,
1298 const DATA_BLOB old_cookie,
1299 TALLOC_CTX *mem_ctx,
1300 struct files_struct **fsp,
1301 DATA_BLOB *new_cookie);
1303 NTSTATUS (*freaddir_attr_fn)(struct vfs_handle_struct *handle,
1304 struct files_struct *fsp,
1305 TALLOC_CTX *mem_ctx,
1306 struct readdir_attr_data **attr_data);
1310 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1311 which describes all operations this module is willing to intercept.
1312 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1313 using this information.
1316 typedef struct vfs_handle_struct {
1317 struct vfs_handle_struct *next, *prev;
1318 const char *param;
1319 struct connection_struct *conn;
1320 const struct vfs_fn_pointers *fns;
1321 void *data;
1322 void (*free_data)(void **data);
1323 } vfs_handle_struct;
1326 struct vfs_statvfs_struct {
1327 /* For undefined recommended transfer size return -1 in that field */
1328 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1329 uint32_t BlockSize;
1332 The next three fields are in terms of the block size.
1333 (above). If block size is unknown, 4096 would be a
1334 reasonable block size for a server to report.
1335 Note that returning the blocks/blocksavail removes need
1336 to make a second call (to QFSInfo level 0x103 to get this info.
1337 UserBlockAvail is typically less than or equal to BlocksAvail,
1338 if no distinction is made return the same value in each.
1341 uint64_t TotalBlocks;
1342 uint64_t BlocksAvail; /* bfree */
1343 uint64_t UserBlocksAvail; /* bavail */
1345 /* For undefined Node fields or FSID return -1 */
1346 uint64_t TotalFileNodes;
1347 uint64_t FreeFileNodes;
1348 uint64_t FsIdentifier; /* fsid */
1349 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1350 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1352 int FsCapabilities;
1355 /* Add a new FSP extension of the given type. Returns a pointer to the
1356 * extenstion data.
1358 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1359 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1361 /* Return a pointer to the existing FSP extension data. */
1362 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1363 vfs_fetch_fsp_extension(handle, (fsp))
1365 /* Return the talloc context associated with an FSP extension. */
1366 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1367 vfs_memctx_fsp_extension(handle, (fsp))
1369 /* Remove and destroy an FSP extension. */
1370 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1371 vfs_remove_fsp_extension((handle), (fsp))
1373 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1374 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1375 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1376 ret; \
1380 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1381 if (!(handle)) { \
1382 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1383 ret; \
1384 } else { \
1385 if ((handle)->free_data) { \
1386 (handle)->free_data(&(handle)->data); \
1388 (handle)->data = (void *)datap; \
1389 (handle)->free_data = free_fn; \
1393 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1394 if ((handle) && (handle)->free_data) { \
1395 (handle)->free_data(&(handle)->data); \
1399 /* Check whether module-specific data handle was already allocated or not */
1400 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1402 #define SMB_VFS_OP(x) ((void *) x)
1404 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1406 #include "vfs_macros.h"
1408 struct smb_vfs_deny_state {
1409 struct smb_vfs_deny_state *parent;
1410 const char *location;
1413 void smb_vfs_assert_allowed(void);
1415 void _smb_vfs_deny_push(struct smb_vfs_deny_state *state, const char *location);
1416 #define smb_vfs_deny_push(__state) _smb_vfs_deny_push(__state, __location__);
1417 void _smb_vfs_deny_pop(struct smb_vfs_deny_state *state, const char *location);
1418 #define smb_vfs_deny_pop(__state) _smb_vfs_deny_pop(__state, __location__);
1420 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1421 const char *service, const char *user);
1422 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1423 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1424 const struct smb_filename *smb_filename,
1425 uint64_t *bsize,
1426 uint64_t *dfree,
1427 uint64_t *dsize);
1428 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1429 const struct smb_filename *smb_filename,
1430 enum SMB_QUOTA_TYPE qtype,
1431 unid_t id,
1432 SMB_DISK_QUOTA *qt);
1433 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1434 enum SMB_QUOTA_TYPE qtype, unid_t id,
1435 SMB_DISK_QUOTA *qt);
1436 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1437 struct files_struct *fsp,
1438 struct shadow_copy_data *shadow_copy_data,
1439 bool labels);
1440 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1441 const struct smb_filename *smb_fname,
1442 struct vfs_statvfs_struct *statbuf);
1443 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1444 enum timestamp_set_resolution *p_ts_res);
1446 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1448 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1449 struct dfs_GetDFSReferral *r);
1450 NTSTATUS smb_vfs_call_create_dfs_pathat(struct vfs_handle_struct *handle,
1451 struct files_struct *dirfsp,
1452 const struct smb_filename *smb_fname,
1453 const struct referral *reflist,
1454 size_t referral_count);
1455 NTSTATUS smb_vfs_call_read_dfs_pathat(struct vfs_handle_struct *handle,
1456 TALLOC_CTX *mem_ctx,
1457 struct files_struct *dirfsp,
1458 struct smb_filename *smb_fname,
1459 struct referral **ppreflist,
1460 size_t *preferral_count);
1461 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1462 struct files_struct *fsp,
1463 const char *mask,
1464 uint32_t attributes);
1465 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1466 struct files_struct *dirfsp,
1467 DIR *dirp,
1468 SMB_STRUCT_STAT *sbuf);
1469 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1470 DIR *dirp, long offset);
1471 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1472 DIR *dirp);
1473 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1474 DIR *dirp);
1475 int smb_vfs_call_mkdirat(struct vfs_handle_struct *handle,
1476 struct files_struct *dirfsp,
1477 const struct smb_filename *smb_fname,
1478 mode_t mode);
1479 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1480 DIR *dir);
1481 int smb_vfs_call_openat(struct vfs_handle_struct *handle,
1482 const struct files_struct *dirfsp,
1483 const struct smb_filename *smb_fname,
1484 struct files_struct *fsp,
1485 const struct vfs_open_how *how);
1486 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1487 struct smb_request *req,
1488 struct files_struct *dirfsp,
1489 struct smb_filename *smb_fname,
1490 uint32_t access_mask,
1491 uint32_t share_access,
1492 uint32_t create_disposition,
1493 uint32_t create_options,
1494 uint32_t file_attributes,
1495 uint32_t oplock_request,
1496 const struct smb2_lease *lease,
1497 uint64_t allocation_size,
1498 uint32_t private_flags,
1499 struct security_descriptor *sd,
1500 struct ea_list *ea_list,
1501 files_struct **result,
1502 int *pinfo,
1503 const struct smb2_create_blobs *in_context_blobs,
1504 struct smb2_create_blobs *out_context_blobs);
1505 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1506 struct files_struct *fsp);
1507 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1508 struct files_struct *fsp, void *data, size_t n,
1509 off_t offset);
1510 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1511 TALLOC_CTX *mem_ctx,
1512 struct tevent_context *ev,
1513 struct files_struct *fsp,
1514 void *data,
1515 size_t n, off_t offset);
1516 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1518 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1519 struct files_struct *fsp, const void *data,
1520 size_t n, off_t offset);
1521 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1522 TALLOC_CTX *mem_ctx,
1523 struct tevent_context *ev,
1524 struct files_struct *fsp,
1525 const void *data,
1526 size_t n, off_t offset);
1527 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1529 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1530 struct files_struct *fsp, off_t offset,
1531 int whence);
1532 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1533 files_struct *fromfsp, const DATA_BLOB *header,
1534 off_t offset, size_t count);
1535 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1536 files_struct *tofsp, off_t offset,
1537 size_t count);
1538 int smb_vfs_call_renameat(struct vfs_handle_struct *handle,
1539 struct files_struct *srcfsp,
1540 const struct smb_filename *smb_fname_src,
1541 struct files_struct *dstfsp,
1542 const struct smb_filename *smb_fname_dst);
1544 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1545 TALLOC_CTX *mem_ctx,
1546 struct tevent_context *ev,
1547 struct files_struct *fsp);
1548 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1550 int smb_vfs_fsync_sync(files_struct *fsp);
1551 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1552 struct smb_filename *smb_fname);
1553 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1554 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1555 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1556 struct smb_filename *smb_filename);
1557 int smb_vfs_call_fstatat(
1558 struct vfs_handle_struct *handle,
1559 const struct files_struct *dirfsp,
1560 const struct smb_filename *smb_fname,
1561 SMB_STRUCT_STAT *sbuf,
1562 int flags);
1563 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1564 struct files_struct *fsp,
1565 const SMB_STRUCT_STAT *sbuf);
1566 int smb_vfs_call_unlinkat(struct vfs_handle_struct *handle,
1567 struct files_struct *dirfsp,
1568 const struct smb_filename *smb_fname,
1569 int flags);
1570 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1571 struct files_struct *fsp, mode_t mode);
1572 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1573 struct files_struct *fsp, uid_t uid, gid_t gid);
1574 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1575 const struct smb_filename *smb_fname,
1576 uid_t uid,
1577 gid_t gid);
1578 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1579 const struct smb_filename *smb_fname);
1580 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1581 TALLOC_CTX *ctx);
1582 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1583 const struct smb_filename *smb_fname,
1584 struct smb_file_time *ft);
1585 int smb_vfs_call_fntimes(struct vfs_handle_struct *handle,
1586 struct files_struct *fsp,
1587 struct smb_file_time *ft);
1588 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1589 struct files_struct *fsp, off_t offset);
1590 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1591 struct files_struct *fsp,
1592 uint32_t mode,
1593 off_t offset,
1594 off_t len);
1595 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1596 struct files_struct *fsp, int op, off_t offset,
1597 off_t count, int type);
1598 int smb_vfs_call_filesystem_sharemode(struct vfs_handle_struct *handle,
1599 struct files_struct *fsp,
1600 uint32_t share_access,
1601 uint32_t access_mask);
1602 int smb_vfs_call_fcntl(struct vfs_handle_struct *handle,
1603 struct files_struct *fsp, int cmd, ...);
1604 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1605 struct files_struct *fsp, int leasetype);
1606 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1607 struct files_struct *fsp, off_t *poffset,
1608 off_t *pcount, int *ptype, pid_t *ppid);
1609 int smb_vfs_call_symlinkat(struct vfs_handle_struct *handle,
1610 const struct smb_filename *link_contents,
1611 struct files_struct *dirfsp,
1612 const struct smb_filename *new_smb_fname);
1613 int smb_vfs_call_readlinkat(struct vfs_handle_struct *handle,
1614 const struct files_struct *dirfsp,
1615 const struct smb_filename *smb_fname,
1616 char *buf,
1617 size_t bufsiz);
1618 int smb_vfs_call_linkat(struct vfs_handle_struct *handle,
1619 struct files_struct *srcfsp,
1620 const struct smb_filename *old_smb_fname,
1621 struct files_struct *dstfsp,
1622 const struct smb_filename *new_smb_fname,
1623 int flags);
1624 int smb_vfs_call_mknodat(struct vfs_handle_struct *handle,
1625 struct files_struct *dirfsp,
1626 const struct smb_filename *smb_fname,
1627 mode_t mode,
1628 SMB_DEV_T dev);
1629 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1630 TALLOC_CTX *ctx,
1631 const struct smb_filename *smb_fname);
1632 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1633 const struct smb_filename *smb_fname,
1634 unsigned int flags);
1635 int smb_vfs_call_fchflags(struct vfs_handle_struct *handle,
1636 struct files_struct *fsp,
1637 unsigned int flags);
1638 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1639 const SMB_STRUCT_STAT *sbuf);
1640 uint64_t smb_vfs_call_fs_file_id(struct vfs_handle_struct *handle,
1641 const SMB_STRUCT_STAT *sbuf);
1642 NTSTATUS smb_vfs_call_fstreaminfo(struct vfs_handle_struct *handle,
1643 struct files_struct *fsp,
1644 TALLOC_CTX *mem_ctx,
1645 unsigned int *num_streams,
1646 struct stream_struct **streams);
1647 NTSTATUS smb_vfs_call_get_real_filename_at(struct vfs_handle_struct *handle,
1648 struct files_struct *dirfsp,
1649 const char *name,
1650 TALLOC_CTX *mem_ctx,
1651 char **found_name);
1652 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1653 const struct files_struct *dirfsp,
1654 const struct smb_filename *smb_fname);
1655 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1656 struct byte_range_lock *br_lck,
1657 struct lock_struct *plock);
1658 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1659 struct byte_range_lock *br_lck,
1660 const struct lock_struct *plock);
1661 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1662 struct files_struct *fsp,
1663 struct lock_struct *plock);
1664 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1665 const char *name,
1666 enum vfs_translate_direction direction,
1667 TALLOC_CTX *mem_ctx,
1668 char **mapped_name);
1669 NTSTATUS smb_vfs_call_parent_pathname(struct vfs_handle_struct *handle,
1670 TALLOC_CTX *mem_ctx,
1671 const struct smb_filename *smb_fname_in,
1672 struct smb_filename **parent_dir_out,
1673 struct smb_filename **atname_out);
1674 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1675 struct files_struct *fsp,
1676 TALLOC_CTX *ctx,
1677 uint32_t function,
1678 uint16_t req_flags,
1679 const uint8_t *_in_data,
1680 uint32_t in_len,
1681 uint8_t **_out_data,
1682 uint32_t max_out_len,
1683 uint32_t *out_len);
1684 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1685 struct files_struct *fsp,
1686 uint32_t *dosmode);
1687 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1688 struct files_struct *fsp,
1689 uint32_t dosmode);
1690 struct tevent_req *smb_vfs_call_get_dos_attributes_send(
1691 TALLOC_CTX *mem_ctx,
1692 struct tevent_context *ev,
1693 struct vfs_handle_struct *handle,
1694 files_struct *dir_fsp,
1695 struct smb_filename *smb_fname);
1696 NTSTATUS smb_vfs_call_get_dos_attributes_recv(
1697 struct tevent_req *req,
1698 struct vfs_aio_state *aio_state,
1699 uint32_t *dosmode);
1700 struct tevent_req *smb_vfs_call_offload_read_send(
1701 TALLOC_CTX *mem_ctx,
1702 struct tevent_context *ev,
1703 struct vfs_handle_struct *handle,
1704 struct files_struct *fsp,
1705 uint32_t fsctl,
1706 uint32_t ttl,
1707 off_t offset,
1708 size_t to_copy);
1709 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1710 struct vfs_handle_struct *handle,
1711 TALLOC_CTX *mem_ctx,
1712 uint32_t *flags,
1713 uint64_t *xferlen,
1714 DATA_BLOB *token_blob);
1715 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1716 TALLOC_CTX *mem_ctx,
1717 struct tevent_context *ev,
1718 uint32_t fsctl,
1719 DATA_BLOB *token,
1720 off_t transfer_offset,
1721 struct files_struct *dest_fsp,
1722 off_t dest_off,
1723 off_t num);
1724 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1725 struct tevent_req *req,
1726 off_t *copied);
1727 NTSTATUS smb_vfs_call_fget_compression(struct vfs_handle_struct *handle,
1728 TALLOC_CTX *mem_ctx,
1729 struct files_struct *fsp,
1730 uint16_t *_compression_fmt);
1731 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1732 TALLOC_CTX *mem_ctx,
1733 struct files_struct *fsp,
1734 uint16_t compression_fmt);
1735 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1736 TALLOC_CTX *mem_ctx,
1737 const char *service_path,
1738 char **base_volume);
1739 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1740 TALLOC_CTX *mem_ctx,
1741 const char *base_volume,
1742 time_t *tstamp,
1743 bool rw,
1744 char **base_path,
1745 char **snap_path);
1746 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1747 TALLOC_CTX *mem_ctx,
1748 char *base_path,
1749 char *snap_path);
1750 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1751 struct files_struct *fsp,
1752 uint32_t security_info,
1753 TALLOC_CTX *mem_ctx,
1754 struct security_descriptor **ppdesc);
1755 NTSTATUS smb_vfs_call_get_nt_acl_at(struct vfs_handle_struct *handle,
1756 struct files_struct *dirfsp,
1757 const struct smb_filename *smb_fname,
1758 uint32_t security_info,
1759 TALLOC_CTX *mem_ctx,
1760 struct security_descriptor **ppdesc);
1761 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1762 struct files_struct *fsp,
1763 uint32_t security_info_sent,
1764 const struct security_descriptor *psd);
1765 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1766 struct smb_filename *file,
1767 struct security_acl *sacl,
1768 uint32_t access_requested,
1769 uint32_t access_denied);
1770 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1771 const struct smb_filename *file,
1772 mode_t mode);
1773 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1774 struct files_struct *fsp,
1775 SMB_ACL_TYPE_T type,
1776 TALLOC_CTX *mem_ctx);
1777 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1778 struct files_struct *fsp,
1779 TALLOC_CTX *mem_ctx,
1780 char **blob_description,
1781 DATA_BLOB *blob);
1782 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1783 struct files_struct *fsp,
1784 SMB_ACL_TYPE_T type,
1785 SMB_ACL_T theacl);
1786 int smb_vfs_call_sys_acl_delete_def_fd(struct vfs_handle_struct *handle,
1787 struct files_struct *fsp);
1788 struct tevent_req *smb_vfs_call_getxattrat_send(
1789 TALLOC_CTX *mem_ctx,
1790 struct tevent_context *ev,
1791 struct vfs_handle_struct *handle,
1792 files_struct *dir_fsp,
1793 const struct smb_filename *smb_fname,
1794 const char *xattr_name,
1795 size_t alloc_hint);
1796 ssize_t smb_vfs_call_getxattrat_recv(struct tevent_req *req,
1797 struct vfs_aio_state *aio_state,
1798 TALLOC_CTX *mem_ctx,
1799 uint8_t **xattr_value);
1800 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1801 struct files_struct *fsp, const char *name,
1802 void *value, size_t size);
1803 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1804 struct files_struct *fsp, char *list,
1805 size_t size);
1806 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1807 struct files_struct *fsp, const char *name);
1808 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1809 const char *name, const void *value, size_t size,
1810 int flags);
1811 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1812 struct files_struct *fsp, const char *name,
1813 const void *value, size_t size, int flags);
1814 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1815 struct files_struct *fsp);
1816 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1817 struct files_struct *fsp,
1818 TALLOC_CTX *mem_ctx,
1819 DATA_BLOB *cookie);
1820 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1821 struct files_struct *fsp,
1822 const DATA_BLOB old_cookie,
1823 TALLOC_CTX *mem_ctx,
1824 DATA_BLOB *new_cookie);
1825 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1826 struct smb_request *smb1req,
1827 struct smbXsrv_open *op,
1828 const DATA_BLOB old_cookie,
1829 TALLOC_CTX *mem_ctx,
1830 struct files_struct **fsp,
1831 DATA_BLOB *new_cookie);
1832 NTSTATUS smb_vfs_call_freaddir_attr(struct vfs_handle_struct *handle,
1833 struct files_struct *fsp,
1834 TALLOC_CTX *mem_ctx,
1835 struct readdir_attr_data **attr_data);
1837 NTSTATUS smb_register_vfs(int version, const char *name,
1838 const struct vfs_fn_pointers *fns);
1839 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1840 files_struct *fsp, size_t ext_size,
1841 void (*destroy_fn)(void *p_data));
1842 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1843 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1844 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle,
1845 const struct files_struct *fsp);
1846 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, const struct files_struct *fsp);
1848 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1849 const char *module);
1852 * Helper functions from source3/modules/vfs_not_implemented.c
1854 int vfs_not_implemented_connect(
1855 vfs_handle_struct *handle,
1856 const char *service,
1857 const char *user);
1858 void vfs_not_implemented_disconnect(vfs_handle_struct *handle);
1859 uint64_t vfs_not_implemented_disk_free(vfs_handle_struct *handle,
1860 const struct smb_filename *smb_fname,
1861 uint64_t *bsize,
1862 uint64_t *dfree,
1863 uint64_t *dsize);
1864 int vfs_not_implemented_get_quota(vfs_handle_struct *handle,
1865 const struct smb_filename *smb_fname,
1866 enum SMB_QUOTA_TYPE qtype,
1867 unid_t id,
1868 SMB_DISK_QUOTA *dq);
1869 int vfs_not_implemented_set_quota(vfs_handle_struct *handle,
1870 enum SMB_QUOTA_TYPE qtype,
1871 unid_t id, SMB_DISK_QUOTA *dq);
1872 int vfs_not_implemented_get_shadow_copy_data(vfs_handle_struct *handle,
1873 files_struct *fsp,
1874 struct shadow_copy_data *shadow_copy_data,
1875 bool labels);
1876 int vfs_not_implemented_statvfs(struct vfs_handle_struct *handle,
1877 const struct smb_filename *smb_fname,
1878 struct vfs_statvfs_struct *statbuf);
1879 uint32_t vfs_not_implemented_fs_capabilities(struct vfs_handle_struct *handle,
1880 enum timestamp_set_resolution *p_ts_res);
1881 NTSTATUS vfs_not_implemented_get_dfs_referrals(struct vfs_handle_struct *handle,
1882 struct dfs_GetDFSReferral *r);
1883 NTSTATUS vfs_not_implemented_create_dfs_pathat(struct vfs_handle_struct *handle,
1884 struct files_struct *dirfsp,
1885 const struct smb_filename *smb_fname,
1886 const struct referral *reflist,
1887 size_t referral_count);
1888 NTSTATUS vfs_not_implemented_read_dfs_pathat(struct vfs_handle_struct *handle,
1889 TALLOC_CTX *mem_ctx,
1890 struct files_struct *dirfsp,
1891 struct smb_filename *smb_fname,
1892 struct referral **ppreflist,
1893 size_t *preferral_count);
1894 NTSTATUS vfs_not_implemented_snap_check_path(struct vfs_handle_struct *handle,
1895 TALLOC_CTX *mem_ctx,
1896 const char *service_path,
1897 char **base_volume);
1898 NTSTATUS vfs_not_implemented_snap_create(struct vfs_handle_struct *handle,
1899 TALLOC_CTX *mem_ctx,
1900 const char *base_volume,
1901 time_t *tstamp,
1902 bool rw,
1903 char **base_path,
1904 char **snap_path);
1905 NTSTATUS vfs_not_implemented_snap_delete(struct vfs_handle_struct *handle,
1906 TALLOC_CTX *mem_ctx,
1907 char *base_path,
1908 char *snap_path);
1909 DIR *vfs_not_implemented_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
1910 const char *mask, uint32_t attr);
1911 struct dirent *vfs_not_implemented_readdir(vfs_handle_struct *handle,
1912 struct files_struct *dirfsp,
1913 DIR *dirp,
1914 SMB_STRUCT_STAT *sbuf);
1915 void vfs_not_implemented_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset);
1916 long vfs_not_implemented_telldir(vfs_handle_struct *handle, DIR *dirp);
1917 void vfs_not_implemented_rewind_dir(vfs_handle_struct *handle, DIR *dirp);
1918 int vfs_not_implemented_mkdirat(vfs_handle_struct *handle,
1919 struct files_struct *dirfsp,
1920 const struct smb_filename *smb_fname,
1921 mode_t mode);
1922 int vfs_not_implemented_closedir(vfs_handle_struct *handle, DIR *dir);
1923 int vfs_not_implemented_open(vfs_handle_struct *handle,
1924 struct smb_filename *smb_fname,
1925 files_struct *fsp, int flags, mode_t mode);
1926 int vfs_not_implemented_openat(vfs_handle_struct *handle,
1927 const struct files_struct *dirfsp,
1928 const struct smb_filename *smb_fname,
1929 struct files_struct *fsp,
1930 const struct vfs_open_how *how);
1931 NTSTATUS vfs_not_implemented_create_file(struct vfs_handle_struct *handle,
1932 struct smb_request *req,
1933 struct files_struct *dirfsp,
1934 struct smb_filename *smb_fname,
1935 uint32_t access_mask,
1936 uint32_t share_access,
1937 uint32_t create_disposition,
1938 uint32_t create_options,
1939 uint32_t file_attributes,
1940 uint32_t oplock_request,
1941 const struct smb2_lease *lease,
1942 uint64_t allocation_size,
1943 uint32_t private_flags,
1944 struct security_descriptor *sd,
1945 struct ea_list *ea_list,
1946 files_struct **result, int *pinfo,
1947 const struct smb2_create_blobs *in_context_blobs,
1948 struct smb2_create_blobs *out_context_blobs);
1949 int vfs_not_implemented_close_fn(vfs_handle_struct *handle, files_struct *fsp);
1950 ssize_t vfs_not_implemented_pread(vfs_handle_struct *handle, files_struct *fsp,
1951 void *data, size_t n, off_t offset);
1952 struct tevent_req *vfs_not_implemented_pread_send(struct vfs_handle_struct *handle,
1953 TALLOC_CTX *mem_ctx,
1954 struct tevent_context *ev,
1955 struct files_struct *fsp,
1956 void *data, size_t n, off_t offset);
1957 ssize_t vfs_not_implemented_pread_recv(struct tevent_req *req,
1958 struct vfs_aio_state *vfs_aio_state);
1959 ssize_t vfs_not_implemented_pwrite(vfs_handle_struct *handle, files_struct *fsp,
1960 const void *data, size_t n, off_t offset);
1961 struct tevent_req *vfs_not_implemented_pwrite_send(struct vfs_handle_struct *handle,
1962 TALLOC_CTX *mem_ctx,
1963 struct tevent_context *ev,
1964 struct files_struct *fsp,
1965 const void *data,
1966 size_t n, off_t offset);
1967 ssize_t vfs_not_implemented_pwrite_recv(struct tevent_req *req,
1968 struct vfs_aio_state *vfs_aio_state);
1969 off_t vfs_not_implemented_lseek(vfs_handle_struct *handle, files_struct *fsp,
1970 off_t offset, int whence);
1971 ssize_t vfs_not_implemented_sendfile(vfs_handle_struct *handle, int tofd,
1972 files_struct *fromfsp, const DATA_BLOB *hdr,
1973 off_t offset, size_t n);
1974 ssize_t vfs_not_implemented_recvfile(vfs_handle_struct *handle, int fromfd,
1975 files_struct *tofsp, off_t offset, size_t n);
1976 int vfs_not_implemented_renameat(vfs_handle_struct *handle,
1977 files_struct *srcfsp,
1978 const struct smb_filename *smb_fname_src,
1979 files_struct *dstfsp,
1980 const struct smb_filename *smb_fname_dst);
1981 struct tevent_req *vfs_not_implemented_fsync_send(struct vfs_handle_struct *handle,
1982 TALLOC_CTX *mem_ctx,
1983 struct tevent_context *ev,
1984 struct files_struct *fsp);
1985 int vfs_not_implemented_fsync_recv(struct tevent_req *req,
1986 struct vfs_aio_state *vfs_aio_state);
1987 int vfs_not_implemented_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname);
1988 int vfs_not_implemented_fstat(vfs_handle_struct *handle, files_struct *fsp,
1989 SMB_STRUCT_STAT *sbuf);
1990 int vfs_not_implemented_lstat(vfs_handle_struct *handle,
1991 struct smb_filename *smb_fname);
1992 int vfs_not_implemented_fstatat(
1993 struct vfs_handle_struct *handle,
1994 const struct files_struct *dirfsp,
1995 const struct smb_filename *smb_fname,
1996 SMB_STRUCT_STAT *sbuf,
1997 int flags);
1998 uint64_t vfs_not_implemented_get_alloc_size(struct vfs_handle_struct *handle,
1999 struct files_struct *fsp,
2000 const SMB_STRUCT_STAT *sbuf);
2001 int vfs_not_implemented_unlinkat(vfs_handle_struct *handle,
2002 struct files_struct *dirfsp,
2003 const struct smb_filename *smb_fname,
2004 int flags);
2005 int vfs_not_implemented_fchmod(vfs_handle_struct *handle, files_struct *fsp,
2006 mode_t mode);
2007 int vfs_not_implemented_fchown(vfs_handle_struct *handle, files_struct *fsp,
2008 uid_t uid, gid_t gid);
2009 int vfs_not_implemented_lchown(vfs_handle_struct *handle,
2010 const struct smb_filename *smb_fname,
2011 uid_t uid,
2012 gid_t gid);
2013 int vfs_not_implemented_chdir(vfs_handle_struct *handle,
2014 const struct smb_filename *smb_fname);
2015 struct smb_filename *vfs_not_implemented_getwd(vfs_handle_struct *handle,
2016 TALLOC_CTX *ctx);
2017 int vfs_not_implemented_ntimes(vfs_handle_struct *handle,
2018 const struct smb_filename *smb_fname,
2019 struct smb_file_time *ft);
2020 int vfs_not_implemented_fntimes(vfs_handle_struct *handle,
2021 files_struct *fsp,
2022 struct smb_file_time *ft);
2023 int vfs_not_implemented_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
2024 off_t offset);
2025 int vfs_not_implemented_fallocate(vfs_handle_struct *handle, files_struct *fsp,
2026 uint32_t mode, off_t offset, off_t len);
2027 bool vfs_not_implemented_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
2028 off_t offset, off_t count, int type);
2029 int vfs_not_implemented_filesystem_sharemode(struct vfs_handle_struct *handle,
2030 struct files_struct *fsp,
2031 uint32_t share_access,
2032 uint32_t access_mask);
2033 int vfs_not_implemented_fcntl(struct vfs_handle_struct *handle,
2034 struct files_struct *fsp, int cmd, va_list cmd_arg);
2035 int vfs_not_implemented_linux_setlease(struct vfs_handle_struct *handle,
2036 struct files_struct *fsp, int leasetype);
2037 bool vfs_not_implemented_getlock(vfs_handle_struct *handle, files_struct *fsp,
2038 off_t *poffset, off_t *pcount, int *ptype,
2039 pid_t *ppid);
2040 int vfs_not_implemented_symlinkat(vfs_handle_struct *handle,
2041 const struct smb_filename *link_contents,
2042 struct files_struct *dirfsp,
2043 const struct smb_filename *new_smb_fname);
2044 int vfs_not_implemented_vfs_readlinkat(vfs_handle_struct *handle,
2045 const struct files_struct *dirfsp,
2046 const struct smb_filename *smb_fname,
2047 char *buf,
2048 size_t bufsiz);
2049 int vfs_not_implemented_linkat(vfs_handle_struct *handle,
2050 struct files_struct *srcfsp,
2051 const struct smb_filename *old_smb_fname,
2052 struct files_struct *dstfsp,
2053 const struct smb_filename *new_smb_fname,
2054 int flags);
2055 int vfs_not_implemented_mknodat(vfs_handle_struct *handle,
2056 struct files_struct *dirfsp,
2057 const struct smb_filename *smb_fname,
2058 mode_t mode,
2059 SMB_DEV_T dev);
2060 struct smb_filename *vfs_not_implemented_realpath(vfs_handle_struct *handle,
2061 TALLOC_CTX *ctx,
2062 const struct smb_filename *smb_fname);
2063 int vfs_not_implemented_chflags(vfs_handle_struct *handle,
2064 const struct smb_filename *smb_fname,
2065 uint flags);
2066 int vfs_not_implemented_fchflags(vfs_handle_struct *handle,
2067 struct files_struct *fst,
2068 uint flags);
2069 struct file_id vfs_not_implemented_file_id_create(vfs_handle_struct *handle,
2070 const SMB_STRUCT_STAT *sbuf);
2071 uint64_t vfs_not_implemented_fs_file_id(vfs_handle_struct *handle,
2072 const SMB_STRUCT_STAT *sbuf);
2073 struct tevent_req *vfs_not_implemented_offload_read_send(
2074 TALLOC_CTX *mem_ctx,
2075 struct tevent_context *ev,
2076 struct vfs_handle_struct *handle,
2077 struct files_struct *fsp,
2078 uint32_t fsctl,
2079 uint32_t ttl,
2080 off_t offset,
2081 size_t to_copy);
2082 NTSTATUS vfs_not_implemented_offload_read_recv(struct tevent_req *req,
2083 struct vfs_handle_struct *handle,
2084 TALLOC_CTX *mem_ctx,
2085 uint32_t *flags,
2086 uint64_t *xferlen,
2087 DATA_BLOB *_token_blob);
2088 struct tevent_req *vfs_not_implemented_offload_write_send(
2089 struct vfs_handle_struct *handle,
2090 TALLOC_CTX *mem_ctx,
2091 struct tevent_context *ev,
2092 uint32_t fsctl,
2093 DATA_BLOB *token,
2094 off_t transfer_offset,
2095 struct files_struct *dest_fsp,
2096 off_t dest_off,
2097 off_t num);
2098 NTSTATUS vfs_not_implemented_offload_write_recv(struct vfs_handle_struct *handle,
2099 struct tevent_req *req,
2100 off_t *copied);
2101 NTSTATUS vfs_not_implemented_fget_compression(struct vfs_handle_struct *handle,
2102 TALLOC_CTX *mem_ctx,
2103 struct files_struct *fsp,
2104 uint16_t *_compression_fmt);
2105 NTSTATUS vfs_not_implemented_set_compression(struct vfs_handle_struct *handle,
2106 TALLOC_CTX *mem_ctx,
2107 struct files_struct *fsp,
2108 uint16_t compression_fmt);
2109 NTSTATUS vfs_not_implemented_fstreaminfo(struct vfs_handle_struct *handle,
2110 struct files_struct *fsp,
2111 TALLOC_CTX *mem_ctx,
2112 unsigned int *num_streams,
2113 struct stream_struct **streams);
2114 NTSTATUS vfs_not_implemented_get_real_filename(
2115 struct vfs_handle_struct *handle,
2116 const struct smb_filename *path,
2117 const char *name,
2118 TALLOC_CTX *mem_ctx,
2119 char **found_name);
2120 NTSTATUS vfs_not_implemented_get_real_filename_at(
2121 struct vfs_handle_struct *handle,
2122 struct files_struct *dirfsp,
2123 const char *name,
2124 TALLOC_CTX *mem_ctx,
2125 char **found_name);
2126 const char *vfs_not_implemented_connectpath(
2127 struct vfs_handle_struct *handle,
2128 const struct files_struct *dirfsp,
2129 const struct smb_filename *smb_fname);
2130 NTSTATUS vfs_not_implemented_brl_lock_windows(struct vfs_handle_struct *handle,
2131 struct byte_range_lock *br_lck,
2132 struct lock_struct *plock);
2133 bool vfs_not_implemented_brl_unlock_windows(struct vfs_handle_struct *handle,
2134 struct byte_range_lock *br_lck,
2135 const struct lock_struct *plock);
2136 bool vfs_not_implemented_strict_lock_check(struct vfs_handle_struct *handle,
2137 struct files_struct *fsp,
2138 struct lock_struct *plock);
2139 NTSTATUS vfs_not_implemented_translate_name(struct vfs_handle_struct *handle,
2140 const char *mapped_name,
2141 enum vfs_translate_direction direction,
2142 TALLOC_CTX *mem_ctx, char **pmapped_name);
2143 NTSTATUS vfs_not_implemented_parent_pathname(struct vfs_handle_struct *handle,
2144 TALLOC_CTX *mem_ctx,
2145 const struct smb_filename *smb_fname_in,
2146 struct smb_filename **parent_dir_out,
2147 struct smb_filename **atname_out);
2148 NTSTATUS vfs_not_implemented_fsctl(struct vfs_handle_struct *handle,
2149 struct files_struct *fsp,
2150 TALLOC_CTX *ctx,
2151 uint32_t function,
2152 uint16_t req_flags, /* Needed for UNICODE ... */
2153 const uint8_t *_in_data,
2154 uint32_t in_len,
2155 uint8_t **_out_data,
2156 uint32_t max_out_len, uint32_t *out_len);
2157 NTSTATUS vfs_not_implemented_freaddir_attr(struct vfs_handle_struct *handle,
2158 struct files_struct *dirfsp,
2159 TALLOC_CTX *mem_ctx,
2160 struct readdir_attr_data **pattr_data);
2161 struct tevent_req *vfs_not_implemented_get_dos_attributes_send(
2162 TALLOC_CTX *mem_ctx,
2163 struct tevent_context *ev,
2164 struct vfs_handle_struct *handle,
2165 files_struct *dir_fsp,
2166 struct smb_filename *smb_fname);
2167 NTSTATUS vfs_not_implemented_get_dos_attributes_recv(
2168 struct tevent_req *req,
2169 struct vfs_aio_state *aio_state,
2170 uint32_t *dosmode);
2171 NTSTATUS vfs_not_implemented_fget_dos_attributes(struct vfs_handle_struct *handle,
2172 struct files_struct *fsp,
2173 uint32_t *dosmode);
2174 NTSTATUS vfs_not_implemented_set_dos_attributes(struct vfs_handle_struct *handle,
2175 const struct smb_filename *smb_fname,
2176 uint32_t dosmode);
2177 NTSTATUS vfs_not_implemented_fset_dos_attributes(struct vfs_handle_struct *handle,
2178 struct files_struct *fsp,
2179 uint32_t dosmode);
2180 NTSTATUS vfs_not_implemented_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2181 uint32_t security_info,
2182 TALLOC_CTX *mem_ctx,
2183 struct security_descriptor **ppdesc);
2184 NTSTATUS vfs_not_implemented_get_nt_acl_at(vfs_handle_struct *handle,
2185 struct files_struct *dirfsp,
2186 const struct smb_filename *smb_fname,
2187 uint32_t security_info,
2188 TALLOC_CTX *mem_ctx,
2189 struct security_descriptor **ppdesc);
2190 NTSTATUS vfs_not_implemented_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
2191 uint32_t security_info_sent,
2192 const struct security_descriptor *psd);
2193 SMB_ACL_T vfs_not_implemented_sys_acl_get_fd(vfs_handle_struct *handle,
2194 files_struct *fsp,
2195 SMB_ACL_TYPE_T type,
2196 TALLOC_CTX *mem_ctx);
2197 int vfs_not_implemented_sys_acl_blob_get_fd(vfs_handle_struct *handle,
2198 files_struct *fsp, TALLOC_CTX *mem_ctx,
2199 char **blob_description, DATA_BLOB *blob);
2200 int vfs_not_implemented_sys_acl_set_fd(vfs_handle_struct *handle,
2201 struct files_struct *fsp,
2202 SMB_ACL_TYPE_T type,
2203 SMB_ACL_T theacl);
2204 int vfs_not_implemented_sys_acl_delete_def_fd(vfs_handle_struct *handle,
2205 files_struct *fsp);
2206 struct tevent_req *vfs_not_implemented_getxattrat_send(
2207 TALLOC_CTX *mem_ctx,
2208 struct tevent_context *ev,
2209 struct vfs_handle_struct *handle,
2210 files_struct *dir_fsp,
2211 const struct smb_filename *smb_fname,
2212 const char *xattr_name,
2213 size_t alloc_hint);
2214 ssize_t vfs_not_implemented_getxattrat_recv(struct tevent_req *req,
2215 struct vfs_aio_state *aio_state,
2216 TALLOC_CTX *mem_ctx,
2217 uint8_t **xattr_value);
2218 ssize_t vfs_not_implemented_fgetxattr(vfs_handle_struct *handle,
2219 struct files_struct *fsp, const char *name,
2220 void *value, size_t size);
2221 ssize_t vfs_not_implemented_listxattr(vfs_handle_struct *handle,
2222 const struct smb_filename *smb_fname,
2223 char *list,
2224 size_t size);
2225 ssize_t vfs_not_implemented_flistxattr(vfs_handle_struct *handle,
2226 struct files_struct *fsp, char *list,
2227 size_t size);
2228 int vfs_not_implemented_fremovexattr(vfs_handle_struct *handle,
2229 struct files_struct *fsp, const char *name);
2230 int vfs_not_implemented_setxattr(vfs_handle_struct *handle,
2231 const struct smb_filename *smb_fname,
2232 const char *name,
2233 const void *value,
2234 size_t size,
2235 int flags);
2236 int vfs_not_implemented_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
2237 const char *name, const void *value, size_t size,
2238 int flags);
2239 bool vfs_not_implemented_aio_force(struct vfs_handle_struct *handle,
2240 struct files_struct *fsp);
2241 NTSTATUS vfs_not_implemented_audit_file(struct vfs_handle_struct *handle,
2242 struct smb_filename *file,
2243 struct security_acl *sacl,
2244 uint32_t access_requested,
2245 uint32_t access_denied);
2246 NTSTATUS vfs_not_implemented_durable_cookie(struct vfs_handle_struct *handle,
2247 struct files_struct *fsp,
2248 TALLOC_CTX *mem_ctx,
2249 DATA_BLOB *cookie);
2250 NTSTATUS vfs_not_implemented_durable_disconnect(struct vfs_handle_struct *handle,
2251 struct files_struct *fsp,
2252 const DATA_BLOB old_cookie,
2253 TALLOC_CTX *mem_ctx,
2254 DATA_BLOB *new_cookie);
2255 NTSTATUS vfs_not_implemented_durable_reconnect(struct vfs_handle_struct *handle,
2256 struct smb_request *smb1req,
2257 struct smbXsrv_open *op,
2258 const DATA_BLOB old_cookie,
2259 TALLOC_CTX *mem_ctx,
2260 struct files_struct **fsp,
2261 DATA_BLOB *new_cookie);
2262 #endif /* _VFS_H */