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