selftest:Samba4: report when samba is started and ready
[Samba.git] / source3 / include / vfs.h
blob8c35fa5ecc7aa8cb0d3a22d54f5121208d0eddc1
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.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
111 open handle. JRA. */
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
155 /* Leave at 31 - not yet released. Remove the unused
156 fsp->pending_break_messages array */
157 /* Leave at 31 - not yet released. add SMB_VFS_[GET/SET]_COMPRESSION() */
159 /* Bump to version 32 - Samba 4.2 will ship with that. */
160 /* Version 32 - Add "lease" to CREATE_FILE operation */
161 /* Version 32 - Add "lease" to struct files_struct */
162 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
163 /* Version 32 - Add in and out create context blobs to create_file */
164 /* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
165 /* Bump to version 33 - Samba 4.3 will ship with that. */
166 /* Version 33 - change fallocate mode flags param from enum->uint32_t */
167 /* Version 33 - Add snapshot create/delete calls */
168 /* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
169 /* Version 33 - Remove notify_watch_fn */
170 /* Bump to version 34 - Samba 4.4 will ship with that */
171 /* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
172 /* Version 34 - Added bool posix_pathnames to struct smb_request */
173 /* Bump to version 35 - Samba 4.5 will ship with that */
174 /* Version 35 - Change get_nt_acl_fn from const char *, to
175 const struct smb_filename * */
176 /* Version 35 - Change mkdir from const char *, to
177 const struct smb_filename * */
178 /* Version 35 - Change rmdir from const char *, to
179 const struct smb_filename * */
180 /* Version 35 - Change opendir from const char *, to
181 const struct smb_filename * */
182 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
183 /* Version 35 - Change chmod from const char *, to
184 const struct smb_filename * */
185 /* Version 35 - Change chmod_acl from const char *, to
186 const struct smb_filename * */
187 /* Version 35 - Change chown from const char *, to
188 const struct smb_filename * */
189 /* Version 35 - Change lchown from const char *, to
190 const struct smb_filename * */
191 /* Version 35 - Change streaminfo from const char *, to
192 const struct smb_filename * */
193 /* Version 35 - Add uint32_t flags to struct smb_filename */
194 /* Version 35 - Add get/set/fget/fset dos attribute functions. */
195 /* Version 35 - Add bool use_ofd_locks to struct files_struct */
196 /* Bump to version 36 - Samba 4.6 will ship with that */
197 /* Version 36 - Remove is_offline and set_offline */
198 /* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
199 /* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
200 /* Version 37 - Change sys_acl_delete_def_file from const char *
201 to const struct smb_filename * */
202 /* Version 37 - Change sys_acl_get_file from const char *
203 to const struct smb_filename * */
204 /* Version 37 - Change sys_acl_blob_get_file from const char *
205 to const struct smb_filename * */
206 /* Version 37 - Change sys_acl_set_file from const char *
207 to const struct smb_filename * */
208 /* Version 37 - Change listxattr from const char *
209 to const struct smb_filename * */
210 /* Version 37 - Change removexattr from const char *
211 to const struct smb_filename * */
212 /* Version 37 - Change setxattr from const char *
213 to const struct smb_filename * */
214 /* Version 37 - Change getxattr from const char *
215 to const struct smb_filename * */
216 /* Version 37 - Change mknod from const char * to const struct smb_filename * */
217 /* Version 37 - Change chflags from const char *
218 to const struct smb_filename * */
219 /* Version 37 - Change disk_free from const char *
220 to const struct smb_filename * */
221 /* Version 37 - Change get_quota from const char *
222 to const struct smb_filename * */
223 /* Version 37 - Change link from const char *
224 to const struct smb_filename * */
225 /* Version 37 - Change statvfs from const char *
226 to const struct smb_filename * */
227 /* Version 37 - Change readlink from const char *
228 to const struct smb_filename * */
229 /* Version 37 - Change symlink from const char *
230 to const struct smb_filename * */
231 /* Version 37 - Change chdir from const char *
232 to const struct smb_filename * */
233 /* Version 37 - Change getwd from char *
234 to const struct smb_filename * */
235 /* Version 37 - Change conn->cwd from char *
236 to struct smb_filename * */
237 /* Version 37 - Change realpath from char *
238 to struct smb_filename * */
239 /* Version 37 - Change connectpath from char *
240 to struct smb_filename * */
241 /* Version 37 - Add SMB_VFS_OFFLOAD_READ_SEND/RECV */
242 /* Version 37 - Rename SMB_VFS_COPY_CHUNK_SEND/RECV to
243 SMB_VFS_OFFLOAD_READ_SEND/RECV */
244 /* Version 37 - Remove SMB_VFS_STRICT_UNLOCK */
245 /* Version 37 - Rename SMB_VFS_STRICT_LOCK to
246 SMB_VFS_STRICT_LOCK_CHECK */
247 /* Version 38 - Remove SMB_VFS_INIT_SEARCH_OP */
248 /* Bump to version 39, Samba 4.9 will ship with that */
249 /* Version 39 - Remove SMB_VFS_FSYNC
250 Only implement async versions. */
251 /* Version 39 - Remove SMB_VFS_READ
252 All users are now pread or async versions. */
253 /* Version 39 - Remove SMB_VFS_WRITE
254 All users are now pwrite or async versions. */
255 /* Version 39 - Remove SMB_VFS_CHMOD_ACL - no longer used. */
256 /* Version 39 - Remove SMB_VFS_FCHMOD_ACL - no longer used. */
257 /* Version 39 - Remove struct dfree_cached_info pointer from
258 connection struct */
259 /* Bump to version 40, Samba 4.10 will ship with that */
260 /* Version 40 - Add SMB_VFS_GETXATTRAT_SEND/RECV */
261 /* Version 40 - Add SMB_VFS_GET_DOS_ATTRIBUTES_SEND/RECV */
263 #define SMB_VFS_INTERFACE_VERSION 40
266 All intercepted VFS operations must be declared as static functions inside module source
267 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
268 example VFS modules for more details.
271 /* VFS operations structure */
273 struct vfs_handle_struct;
274 struct connection_struct;
275 struct files_struct;
276 struct security_descriptor;
277 struct vfs_statvfs_struct;
278 struct smb_request;
279 struct ea_list;
280 struct smb_file_time;
281 struct blocking_lock_record;
282 struct smb_filename;
283 struct dfs_GetDFSReferral;
285 typedef union unid_t {
286 uid_t uid;
287 gid_t gid;
288 } unid_t;
290 struct fd_handle {
291 size_t ref_count;
292 int fd;
293 uint64_t position_information;
294 off_t pos;
295 uint32_t private_options; /* NT Create options, but we only look at
296 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
297 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
298 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
299 * for print files *only*, where
300 * DELETE_ON_CLOSE is not stored in the share
301 * mode database.
303 unsigned long gen_id;
306 struct fsp_lease {
307 size_t ref_count;
308 struct smbd_server_connection *sconn;
309 struct tevent_timer *timeout;
310 struct smb2_lease lease;
313 typedef struct files_struct {
314 struct files_struct *next, *prev;
315 uint64_t fnum;
316 struct smbXsrv_open *op;
317 struct connection_struct *conn;
318 struct fd_handle *fh;
319 unsigned int num_smb_operations;
320 struct file_id file_id;
321 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
322 uint16_t file_pid;
323 uint64_t vuid; /* SMB2 compat */
324 struct write_cache *wcp;
325 struct timeval open_time;
326 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
327 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
329 bool kernel_share_modes_taken;
331 bool update_write_time_triggered;
332 struct tevent_timer *update_write_time_event;
333 bool update_write_time_on_close;
334 struct timespec close_write_time;
335 bool write_time_forced;
337 int oplock_type;
338 struct fsp_lease *lease;
339 int sent_oplock_break;
340 struct tevent_timer *oplock_timeout;
341 struct lock_struct last_lock_failure;
342 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
344 bool can_lock;
345 bool can_read;
346 bool can_write;
347 bool modified;
348 bool is_directory;
349 bool aio_write_behind;
350 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
351 bool delete_on_close;
352 uint64_t posix_flags;
353 bool is_sparse;
354 bool backup_intent; /* Handle was successfully opened with backup intent
355 and opener has privilege to do so. */
356 bool use_ofd_locks; /* Are we using open file description locks ? */
357 struct smb_filename *fsp_name;
358 uint32_t name_hash; /* Jenkins hash of full pathname. */
359 uint64_t mid; /* Mid of the operation that created us. */
361 struct vfs_fsp_data *vfs_extension;
362 struct fake_file_handle *fake_file_handle;
364 struct notify_change_buf *notify;
366 struct files_struct *base_fsp; /* placeholder for delete on close */
369 * Read-only cached brlock record, thrown away when the
370 * brlock.tdb seqnum changes. This avoids fetching data from
371 * the brlock.tdb on every read/write call.
373 int brlock_seqnum;
374 struct byte_range_lock *brlock_rec;
376 struct dptr_struct *dptr;
378 /* if not NULL, means this is a print file */
379 struct print_file_data *print_file;
381 unsigned num_aio_requests;
382 struct tevent_req **aio_requests;
385 * If a close request comes in while we still have aio_requests
386 * around, we need to hold back the close. When all aio_requests are
387 * done, the aio completion routines need tevent_wait_done() on
388 * this. A bit ugly, but before we have close_file() fully async
389 * possibly the simplest approach. Thanks, Jeremy for the idea.
391 struct tevent_req *deferred_close;
392 } files_struct;
394 #define FSP_POSIX_FLAGS_OPEN 0x01
395 #define FSP_POSIX_FLAGS_RENAME 0x02
396 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
398 #define FSP_POSIX_FLAGS_ALL \
399 (FSP_POSIX_FLAGS_OPEN | \
400 FSP_POSIX_FLAGS_PATHNAMES | \
401 FSP_POSIX_FLAGS_RENAME)
403 struct vuid_cache_entry {
404 struct auth_session_info *session_info;
405 uint64_t vuid; /* SMB2 compat */
406 bool read_only;
407 uint32_t share_access;
410 struct vuid_cache {
411 unsigned int next_entry;
412 struct vuid_cache_entry array[VUID_CACHE_SIZE];
415 typedef struct {
416 char *name;
417 bool is_wild;
418 } name_compare_entry;
420 struct share_params {
421 int service;
424 typedef struct connection_struct {
425 struct connection_struct *next, *prev;
426 struct smbd_server_connection *sconn; /* can be NULL */
427 struct smbXsrv_tcon *tcon; /* can be NULL */
428 uint32_t cnum; /* an index passed over the wire */
429 struct share_params *params;
430 bool force_user;
431 struct vuid_cache *vuid_cache;
432 bool printer;
433 bool ipc;
434 bool read_only; /* Attributes for the current user of the share. */
435 uint32_t share_access;
436 /* Does this filesystem honor
437 sub second timestamps on files
438 and directories when setting time ? */
439 enum timestamp_set_resolution ts_res;
440 char *connectpath;
441 char *origpath;
442 struct smb_filename *cwd_fname; /* Working directory. */
443 bool tcon_done;
445 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
448 * This represents the user information on this connection. Depending
449 * on the vuid using this tid, this might change per SMB request.
451 struct auth_session_info *session_info;
454 * If the "force group" parameter is set, this is the primary gid that
455 * may be used in the users token, depending on the vuid using this tid.
457 gid_t force_group_gid;
459 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
461 time_t lastused;
462 time_t lastused_count;
463 int num_files_open;
464 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
465 int encrypt_level;
466 bool encrypted_tid;
468 /* Semantics requested by the client or forced by the server config. */
469 bool case_sensitive;
470 bool case_preserve;
471 bool short_case_preserve;
473 /* Semantics provided by the underlying filesystem. */
474 int fs_capabilities;
475 /* Device number of the directory of the share mount.
476 Used to ensure unique FileIndex returns. */
477 SMB_DEV_T base_share_dev;
479 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
480 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
481 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
482 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
483 struct trans_state *pending_trans;
485 struct rpc_pipe_client *spoolss_pipe;
487 } connection_struct;
489 struct smbd_smb2_request;
490 struct privilege_paths;
492 struct smb_request {
493 uint8_t cmd;
494 uint16_t flags2;
495 uint16_t smbpid;
496 uint64_t mid; /* For compatibility with SMB2. */
497 uint32_t seqnum;
498 uint64_t vuid; /* For compatibility with SMB2. */
499 uint32_t tid;
500 uint8_t wct;
501 const uint16_t *vwv;
502 uint16_t buflen;
503 const uint8_t *buf;
504 const uint8_t *inbuf;
507 * Async handling in the main smb processing loop is directed by
508 * outbuf: reply_xxx routines indicate sync behaviour by putting their
509 * reply into "outbuf". If they leave it as NULL, they take care of it
510 * themselves, possibly later.
512 * If async handling is wanted, the reply_xxx routine must make sure
513 * that it talloc_move()s the smb_req somewhere else.
515 uint8_t *outbuf;
517 size_t unread_bytes;
518 bool encrypted;
519 connection_struct *conn;
520 struct smbd_server_connection *sconn;
521 struct smbXsrv_connection *xconn;
522 struct smb_perfcount_data pcd;
525 * Chained request handling
527 struct files_struct *chain_fsp;
530 * state information for async smb handling
532 void *async_priv;
535 * Back pointer to smb2 request.
537 struct smbd_smb2_request *smb2req;
540 * Pathnames used if request done
541 * under privilege.
543 struct privilege_paths *priv_paths;
546 * Request list for chained requests, we're part of it.
548 struct smb_request **chain;
550 struct timeval request_time;
552 bool posix_pathnames;
556 * Info about an alternate data stream
559 struct stream_struct {
560 off_t size;
561 off_t alloc_size;
562 char *name;
565 /* time info */
566 struct smb_file_time {
567 struct timespec mtime;
568 struct timespec atime;
569 struct timespec ctime;
570 struct timespec create_time;
574 * smb_filename
576 struct smb_filename {
577 char *base_name;
578 char *stream_name;
579 char *original_lcomp;
580 uint32_t flags;
581 SMB_STRUCT_STAT st;
585 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
586 * to keep the numeric values consistent.
589 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
591 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
592 handle = handle->next; \
595 enum vfs_translate_direction {
596 vfs_translate_to_unix = 0,
597 vfs_translate_to_windows
600 enum vfs_fallocate_flags {
601 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
602 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
605 struct vfs_aio_state {
606 int error;
607 uint64_t duration;
611 Available VFS operations. These values must be in sync with vfs_ops struct
612 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
613 In particular, if new operations are added to vfs_ops, appropriate constants
614 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
616 struct shadow_copy_data;
618 struct vfs_fn_pointers {
619 /* Disk operations */
621 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
622 void (*disconnect_fn)(struct vfs_handle_struct *handle);
623 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
624 const struct smb_filename *smb_fname,
625 uint64_t *bsize,
626 uint64_t *dfree,
627 uint64_t *dsize);
628 int (*get_quota_fn)(struct vfs_handle_struct *handle,
629 const struct smb_filename *smb_fname,
630 enum SMB_QUOTA_TYPE qtype,
631 unid_t id,
632 SMB_DISK_QUOTA *qt);
633 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
634 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
635 int (*statvfs_fn)(struct vfs_handle_struct *handle,
636 const struct smb_filename *smb_fname,
637 struct vfs_statvfs_struct *statbuf);
638 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
641 * Note: that "struct dfs_GetDFSReferral *r"
642 * needs to be a valid TALLOC_CTX
644 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
645 struct dfs_GetDFSReferral *r);
647 /* Directory operations */
649 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
650 const struct smb_filename *smb_fname,
651 const char *mask,
652 uint32_t attributes);
653 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
654 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
655 DIR *dirp,
656 SMB_STRUCT_STAT *sbuf);
657 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
658 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
659 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
660 int (*mkdir_fn)(struct vfs_handle_struct *handle,
661 const struct smb_filename *smb_fname,
662 mode_t mode);
663 int (*rmdir_fn)(struct vfs_handle_struct *handle,
664 const struct smb_filename *smb_fname);
665 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
667 /* File operations */
669 int (*open_fn)(struct vfs_handle_struct *handle,
670 struct smb_filename *smb_fname, files_struct *fsp,
671 int flags, mode_t mode);
672 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
673 struct smb_request *req,
674 uint16_t root_dir_fid,
675 struct smb_filename *smb_fname,
676 uint32_t access_mask,
677 uint32_t share_access,
678 uint32_t create_disposition,
679 uint32_t create_options,
680 uint32_t file_attributes,
681 uint32_t oplock_request,
682 struct smb2_lease *lease,
683 uint64_t allocation_size,
684 uint32_t private_flags,
685 struct security_descriptor *sd,
686 struct ea_list *ea_list,
687 files_struct **result,
688 int *pinfo,
689 const struct smb2_create_blobs *in_context_blobs,
690 struct smb2_create_blobs *out_context_blobs);
691 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
692 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
693 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
694 TALLOC_CTX *mem_ctx,
695 struct tevent_context *ev,
696 struct files_struct *fsp,
697 void *data,
698 size_t n, off_t offset);
699 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
700 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
701 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
702 TALLOC_CTX *mem_ctx,
703 struct tevent_context *ev,
704 struct files_struct *fsp,
705 const void *data,
706 size_t n, off_t offset);
707 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
708 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
709 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
710 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
711 int (*rename_fn)(struct vfs_handle_struct *handle,
712 const struct smb_filename *smb_fname_src,
713 const struct smb_filename *smb_fname_dst);
714 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
715 TALLOC_CTX *mem_ctx,
716 struct tevent_context *ev,
717 struct files_struct *fsp);
718 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
719 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
720 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
721 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
722 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
723 int (*unlink_fn)(struct vfs_handle_struct *handle,
724 const struct smb_filename *smb_fname);
725 int (*chmod_fn)(struct vfs_handle_struct *handle,
726 const struct smb_filename *smb_fname,
727 mode_t mode);
728 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
729 int (*chown_fn)(struct vfs_handle_struct *handle,
730 const struct smb_filename *smb_fname,
731 uid_t uid,
732 gid_t gid);
733 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
734 int (*lchown_fn)(struct vfs_handle_struct *handle,
735 const struct smb_filename *smb_fname,
736 uid_t uid,
737 gid_t gid);
738 int (*chdir_fn)(struct vfs_handle_struct *handle,
739 const struct smb_filename *smb_fname);
740 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
741 TALLOC_CTX *mem_ctx);
742 int (*ntimes_fn)(struct vfs_handle_struct *handle,
743 const struct smb_filename *smb_fname,
744 struct smb_file_time *ft);
745 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
746 int (*fallocate_fn)(struct vfs_handle_struct *handle,
747 struct files_struct *fsp,
748 uint32_t mode,
749 off_t offset,
750 off_t len);
751 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
752 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
753 uint32_t share_mode, uint32_t access_mask);
754 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
755 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
756 int (*symlink_fn)(struct vfs_handle_struct *handle,
757 const char *link_contents,
758 const struct smb_filename *new_smb_fname);
759 int (*readlink_fn)(struct vfs_handle_struct *handle,
760 const struct smb_filename *smb_fname,
761 char *buf,
762 size_t bufsiz);
763 int (*link_fn)(struct vfs_handle_struct *handle,
764 const struct smb_filename *old_smb_fname,
765 const struct smb_filename *new_smb_fname);
766 int (*mknod_fn)(struct vfs_handle_struct *handle,
767 const struct smb_filename *smb_fname,
768 mode_t mode,
769 SMB_DEV_T dev);
770 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
771 TALLOC_CTX *ctx,
772 const struct smb_filename *smb_fname);
773 int (*chflags_fn)(struct vfs_handle_struct *handle,
774 const struct smb_filename *smb_fname,
775 unsigned int flags);
776 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
777 const SMB_STRUCT_STAT *sbuf);
778 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
779 struct tevent_context *ev,
780 struct vfs_handle_struct *handle,
781 struct files_struct *fsp,
782 uint32_t fsctl,
783 uint32_t ttl,
784 off_t offset,
785 size_t to_copy);
786 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
787 struct vfs_handle_struct *handle,
788 TALLOC_CTX *mem_ctx,
789 DATA_BLOB *token_blob);
790 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
791 TALLOC_CTX *mem_ctx,
792 struct tevent_context *ev,
793 uint32_t fsctl,
794 DATA_BLOB *token,
795 off_t transfer_offset,
796 struct files_struct *dest_fsp,
797 off_t dest_off,
798 off_t to_copy);
799 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
800 struct tevent_req *req,
801 off_t *copied);
802 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
803 TALLOC_CTX *mem_ctx,
804 struct files_struct *fsp,
805 struct smb_filename *smb_fname,
806 uint16_t *_compression_fmt);
807 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
808 TALLOC_CTX *mem_ctx,
809 struct files_struct *fsp,
810 uint16_t compression_fmt);
811 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
812 TALLOC_CTX *mem_ctx,
813 const char *service_path,
814 char **base_volume);
815 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
816 TALLOC_CTX *mem_ctx,
817 const char *base_volume,
818 time_t *tstamp,
819 bool rw,
820 char **base_path,
821 char **snap_path);
822 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
823 TALLOC_CTX *mem_ctx,
824 char *base_path,
825 char *snap_path);
827 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
828 struct files_struct *fsp,
829 const struct smb_filename *smb_fname,
830 TALLOC_CTX *mem_ctx,
831 unsigned int *num_streams,
832 struct stream_struct **streams);
834 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
835 const char *path,
836 const char *name,
837 TALLOC_CTX *mem_ctx,
838 char **found_name);
840 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
841 const struct smb_filename *smb_fname);
843 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
844 struct byte_range_lock *br_lck,
845 struct lock_struct *plock,
846 bool blocking_lock);
848 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
849 struct messaging_context *msg_ctx,
850 struct byte_range_lock *br_lck,
851 const struct lock_struct *plock);
853 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
854 struct byte_range_lock *br_lck,
855 struct lock_struct *plock);
857 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
858 struct files_struct *fsp,
859 struct lock_struct *plock);
861 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
862 const char *name,
863 enum vfs_translate_direction direction,
864 TALLOC_CTX *mem_ctx,
865 char **mapped_name);
867 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
868 struct files_struct *fsp,
869 TALLOC_CTX *ctx,
870 uint32_t function,
871 uint16_t req_flags,
872 const uint8_t *_in_data,
873 uint32_t in_len,
874 uint8_t **_out_data,
875 uint32_t max_out_len,
876 uint32_t *out_len);
878 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
879 struct smb_filename *smb_fname,
880 uint32_t *dosmode);
882 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
883 struct files_struct *fsp,
884 uint32_t *dosmode);
886 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
887 const struct smb_filename *smb_fname,
888 uint32_t dosmode);
890 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
891 struct files_struct *fsp,
892 uint32_t dosmode);
894 struct tevent_req *(*get_dos_attributes_send_fn)(
895 TALLOC_CTX *mem_ctx,
896 struct tevent_context *ev,
897 struct vfs_handle_struct *handle,
898 files_struct *dir_fsp,
899 struct smb_filename *smb_fname);
901 NTSTATUS (*get_dos_attributes_recv_fn)(
902 struct tevent_req *req,
903 struct vfs_aio_state *aio_state,
904 uint32_t *dosmode);
906 /* NT ACL operations. */
908 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
909 struct files_struct *fsp,
910 uint32_t security_info,
911 TALLOC_CTX *mem_ctx,
912 struct security_descriptor **ppdesc);
913 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
914 const struct smb_filename *smb_fname,
915 uint32_t security_info,
916 TALLOC_CTX *mem_ctx,
917 struct security_descriptor **ppdesc);
918 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
919 struct files_struct *fsp,
920 uint32_t security_info_sent,
921 const struct security_descriptor *psd);
923 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
924 struct smb_filename *file,
925 struct security_acl *sacl,
926 uint32_t access_requested,
927 uint32_t access_denied);
929 /* POSIX ACL operations. */
931 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
932 const struct smb_filename *smb_fname,
933 SMB_ACL_TYPE_T type,
934 TALLOC_CTX *mem_ctx);
935 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
936 struct files_struct *fsp,
937 TALLOC_CTX *mem_ctx);
938 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
939 const struct smb_filename *smb_fname,
940 TALLOC_CTX *mem_ctx,
941 char **blob_description,
942 DATA_BLOB *blob);
943 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
944 TALLOC_CTX *mem_ctx, char **blob_description,
945 DATA_BLOB *blob);
946 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
947 const struct smb_filename *smb_fname,
948 SMB_ACL_TYPE_T acltype,
949 SMB_ACL_T theacl);
950 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
951 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
952 const struct smb_filename *smb_fname);
954 /* EA operations. */
955 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
956 const struct smb_filename *smb_fname,
957 const char *name,
958 void *value,
959 size_t size);
960 struct tevent_req *(*getxattrat_send_fn)(
961 TALLOC_CTX *mem_ctx,
962 struct tevent_context *ev,
963 struct vfs_handle_struct *handle,
964 files_struct *dir_fsp,
965 const struct smb_filename *smb_fname,
966 const char *xattr_name,
967 size_t alloc_hint);
968 ssize_t (*getxattrat_recv_fn)(struct tevent_req *req,
969 struct vfs_aio_state *aio_state,
970 TALLOC_CTX *mem_ctx,
971 uint8_t **xattr_value);
972 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
973 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
974 const struct smb_filename *smb_fname,
975 char *list,
976 size_t size);
977 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
978 int (*removexattr_fn)(struct vfs_handle_struct *handle,
979 const struct smb_filename *smb_fname,
980 const char *name);
981 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
982 int (*setxattr_fn)(struct vfs_handle_struct *handle,
983 const struct smb_filename *smb_fname,
984 const char *name,
985 const void *value,
986 size_t size,
987 int flags);
988 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
990 /* aio operations */
991 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
993 /* durable handle operations */
994 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
995 struct files_struct *fsp,
996 TALLOC_CTX *mem_ctx,
997 DATA_BLOB *cookie);
998 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
999 struct files_struct *fsp,
1000 const DATA_BLOB old_cookie,
1001 TALLOC_CTX *mem_ctx,
1002 DATA_BLOB *new_cookie);
1003 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
1004 struct smb_request *smb1req,
1005 struct smbXsrv_open *op,
1006 const DATA_BLOB old_cookie,
1007 TALLOC_CTX *mem_ctx,
1008 struct files_struct **fsp,
1009 DATA_BLOB *new_cookie);
1011 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
1012 const struct smb_filename *fname,
1013 TALLOC_CTX *mem_ctx,
1014 struct readdir_attr_data **attr_data);
1018 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
1019 which describes all operations this module is willing to intercept.
1020 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
1021 using this information.
1024 typedef struct vfs_handle_struct {
1025 struct vfs_handle_struct *next, *prev;
1026 const char *param;
1027 struct connection_struct *conn;
1028 const struct vfs_fn_pointers *fns;
1029 void *data;
1030 void (*free_data)(void **data);
1031 } vfs_handle_struct;
1034 typedef struct vfs_statvfs_struct {
1035 /* For undefined recommended transfer size return -1 in that field */
1036 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1037 uint32_t BlockSize;
1040 The next three fields are in terms of the block size.
1041 (above). If block size is unknown, 4096 would be a
1042 reasonable block size for a server to report.
1043 Note that returning the blocks/blocksavail removes need
1044 to make a second call (to QFSInfo level 0x103 to get this info.
1045 UserBlockAvail is typically less than or equal to BlocksAvail,
1046 if no distinction is made return the same value in each.
1049 uint64_t TotalBlocks;
1050 uint64_t BlocksAvail; /* bfree */
1051 uint64_t UserBlocksAvail; /* bavail */
1053 /* For undefined Node fields or FSID return -1 */
1054 uint64_t TotalFileNodes;
1055 uint64_t FreeFileNodes;
1056 uint64_t FsIdentifier; /* fsid */
1057 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1058 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1060 int FsCapabilities;
1061 } vfs_statvfs_struct;
1063 /* Add a new FSP extension of the given type. Returns a pointer to the
1064 * extenstion data.
1066 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1067 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1069 /* Return a pointer to the existing FSP extension data. */
1070 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1071 vfs_fetch_fsp_extension(handle, (fsp))
1073 /* Return the talloc context associated with an FSP extension. */
1074 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1075 vfs_memctx_fsp_extension(handle, (fsp))
1077 /* Remove and destroy an FSP extension. */
1078 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1079 vfs_remove_fsp_extension((handle), (fsp))
1081 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1082 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1083 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1084 ret; \
1088 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1089 if (!(handle)) { \
1090 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1091 ret; \
1092 } else { \
1093 if ((handle)->free_data) { \
1094 (handle)->free_data(&(handle)->data); \
1096 (handle)->data = (void *)datap; \
1097 (handle)->free_data = free_fn; \
1101 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1102 if ((handle) && (handle)->free_data) { \
1103 (handle)->free_data(&(handle)->data); \
1107 /* Check whether module-specific data handle was already allocated or not */
1108 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1110 #define SMB_VFS_OP(x) ((void *) x)
1112 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1114 #include "vfs_macros.h"
1116 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1117 const char *service, const char *user);
1118 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1119 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1120 const struct smb_filename *smb_filename,
1121 uint64_t *bsize,
1122 uint64_t *dfree,
1123 uint64_t *dsize);
1124 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1125 const struct smb_filename *smb_filename,
1126 enum SMB_QUOTA_TYPE qtype,
1127 unid_t id,
1128 SMB_DISK_QUOTA *qt);
1129 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1130 enum SMB_QUOTA_TYPE qtype, unid_t id,
1131 SMB_DISK_QUOTA *qt);
1132 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1133 struct files_struct *fsp,
1134 struct shadow_copy_data *shadow_copy_data,
1135 bool labels);
1136 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1137 const struct smb_filename *smb_fname,
1138 struct vfs_statvfs_struct *statbuf);
1139 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1140 enum timestamp_set_resolution *p_ts_res);
1142 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1144 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1145 struct dfs_GetDFSReferral *r);
1146 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1147 const struct smb_filename *smb_fname,
1148 const char *mask,
1149 uint32_t attributes);
1150 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1151 struct files_struct *fsp,
1152 const char *mask,
1153 uint32_t attributes);
1154 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1155 DIR *dirp,
1156 SMB_STRUCT_STAT *sbuf);
1157 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1158 DIR *dirp, long offset);
1159 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1160 DIR *dirp);
1161 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1162 DIR *dirp);
1163 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1164 const struct smb_filename *smb_fname,
1165 mode_t mode);
1166 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1167 const struct smb_filename *smb_fname);
1168 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1169 DIR *dir);
1170 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1171 struct smb_filename *smb_fname, struct files_struct *fsp,
1172 int flags, mode_t mode);
1173 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1174 struct smb_request *req,
1175 uint16_t root_dir_fid,
1176 struct smb_filename *smb_fname,
1177 uint32_t access_mask,
1178 uint32_t share_access,
1179 uint32_t create_disposition,
1180 uint32_t create_options,
1181 uint32_t file_attributes,
1182 uint32_t oplock_request,
1183 struct smb2_lease *lease,
1184 uint64_t allocation_size,
1185 uint32_t private_flags,
1186 struct security_descriptor *sd,
1187 struct ea_list *ea_list,
1188 files_struct **result,
1189 int *pinfo,
1190 const struct smb2_create_blobs *in_context_blobs,
1191 struct smb2_create_blobs *out_context_blobs);
1192 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1193 struct files_struct *fsp);
1194 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1195 struct files_struct *fsp, void *data, size_t n,
1196 off_t offset);
1197 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1198 TALLOC_CTX *mem_ctx,
1199 struct tevent_context *ev,
1200 struct files_struct *fsp,
1201 void *data,
1202 size_t n, off_t offset);
1203 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1205 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1206 struct files_struct *fsp, const void *data,
1207 size_t n, off_t offset);
1208 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1209 TALLOC_CTX *mem_ctx,
1210 struct tevent_context *ev,
1211 struct files_struct *fsp,
1212 const void *data,
1213 size_t n, off_t offset);
1214 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1216 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1217 struct files_struct *fsp, off_t offset,
1218 int whence);
1219 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1220 files_struct *fromfsp, const DATA_BLOB *header,
1221 off_t offset, size_t count);
1222 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1223 files_struct *tofsp, off_t offset,
1224 size_t count);
1225 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1226 const struct smb_filename *smb_fname_src,
1227 const struct smb_filename *smb_fname_dst);
1229 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1230 TALLOC_CTX *mem_ctx,
1231 struct tevent_context *ev,
1232 struct files_struct *fsp);
1233 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1235 int smb_vfs_fsync_sync(files_struct *fsp);
1236 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1237 struct smb_filename *smb_fname);
1238 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1239 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1240 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1241 struct smb_filename *smb_filename);
1242 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1243 struct files_struct *fsp,
1244 const SMB_STRUCT_STAT *sbuf);
1245 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1246 const struct smb_filename *smb_fname);
1247 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1248 const struct smb_filename *smb_fname,
1249 mode_t mode);
1250 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1251 struct files_struct *fsp, mode_t mode);
1252 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1253 const struct smb_filename *smb_fname,
1254 uid_t uid,
1255 gid_t gid);
1256 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1257 struct files_struct *fsp, uid_t uid, gid_t gid);
1258 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1259 const struct smb_filename *smb_fname,
1260 uid_t uid,
1261 gid_t gid);
1262 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1263 const struct smb_filename *smb_fname);
1264 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1265 TALLOC_CTX *ctx);
1266 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1267 const struct smb_filename *smb_fname,
1268 struct smb_file_time *ft);
1269 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1270 struct files_struct *fsp, off_t offset);
1271 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1272 struct files_struct *fsp,
1273 uint32_t mode,
1274 off_t offset,
1275 off_t len);
1276 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1277 struct files_struct *fsp, int op, off_t offset,
1278 off_t count, int type);
1279 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1280 struct files_struct *fsp, uint32_t share_mode,
1281 uint32_t access_mask);
1282 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1283 struct files_struct *fsp, int leasetype);
1284 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1285 struct files_struct *fsp, off_t *poffset,
1286 off_t *pcount, int *ptype, pid_t *ppid);
1287 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1288 const char *link_contents,
1289 const struct smb_filename *new_smb_fname);
1290 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1291 const struct smb_filename *smb_fname,
1292 char *buf,
1293 size_t bufsiz);
1294 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1295 const struct smb_filename *old_smb_fname,
1296 const struct smb_filename *new_smb_fname);
1297 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1298 const struct smb_filename *smb_fname,
1299 mode_t mode,
1300 SMB_DEV_T dev);
1301 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1302 TALLOC_CTX *ctx,
1303 const struct smb_filename *smb_fname);
1304 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1305 const struct smb_filename *smb_fname,
1306 unsigned int flags);
1307 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1308 const SMB_STRUCT_STAT *sbuf);
1309 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1310 struct files_struct *fsp,
1311 const struct smb_filename *smb_fname,
1312 TALLOC_CTX *mem_ctx,
1313 unsigned int *num_streams,
1314 struct stream_struct **streams);
1315 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1316 const char *path, const char *name,
1317 TALLOC_CTX *mem_ctx, char **found_name);
1318 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1319 const struct smb_filename *smb_fname);
1320 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1321 struct byte_range_lock *br_lck,
1322 struct lock_struct *plock,
1323 bool blocking_lock);
1324 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1325 struct messaging_context *msg_ctx,
1326 struct byte_range_lock *br_lck,
1327 const struct lock_struct *plock);
1328 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1329 struct byte_range_lock *br_lck,
1330 struct lock_struct *plock);
1331 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1332 struct files_struct *fsp,
1333 struct lock_struct *plock);
1334 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1335 const char *name,
1336 enum vfs_translate_direction direction,
1337 TALLOC_CTX *mem_ctx,
1338 char **mapped_name);
1339 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1340 struct files_struct *fsp,
1341 TALLOC_CTX *ctx,
1342 uint32_t function,
1343 uint16_t req_flags,
1344 const uint8_t *_in_data,
1345 uint32_t in_len,
1346 uint8_t **_out_data,
1347 uint32_t max_out_len,
1348 uint32_t *out_len);
1349 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1350 struct smb_filename *smb_fname,
1351 uint32_t *dosmode);
1352 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1353 struct files_struct *fsp,
1354 uint32_t *dosmode);
1355 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1356 const struct smb_filename *smb_fname,
1357 uint32_t dosmode);
1358 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1359 struct files_struct *fsp,
1360 uint32_t dosmode);
1361 struct tevent_req *smb_vfs_call_get_dos_attributes_send(
1362 TALLOC_CTX *mem_ctx,
1363 struct tevent_context *ev,
1364 struct vfs_handle_struct *handle,
1365 files_struct *dir_fsp,
1366 struct smb_filename *smb_fname);
1367 NTSTATUS smb_vfs_call_get_dos_attributes_recv(
1368 struct tevent_req *req,
1369 struct vfs_aio_state *aio_state,
1370 uint32_t *dosmode);
1371 struct tevent_req *smb_vfs_call_offload_read_send(
1372 TALLOC_CTX *mem_ctx,
1373 struct tevent_context *ev,
1374 struct vfs_handle_struct *handle,
1375 struct files_struct *fsp,
1376 uint32_t fsctl,
1377 uint32_t ttl,
1378 off_t offset,
1379 size_t to_copy);
1380 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1381 struct vfs_handle_struct *handle,
1382 TALLOC_CTX *mem_ctx,
1383 DATA_BLOB *token_blob);
1384 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1385 TALLOC_CTX *mem_ctx,
1386 struct tevent_context *ev,
1387 uint32_t fsctl,
1388 DATA_BLOB *token,
1389 off_t transfer_offset,
1390 struct files_struct *dest_fsp,
1391 off_t dest_off,
1392 off_t num);
1393 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1394 struct tevent_req *req,
1395 off_t *copied);
1396 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1397 TALLOC_CTX *mem_ctx,
1398 struct files_struct *fsp,
1399 struct smb_filename *smb_fname,
1400 uint16_t *_compression_fmt);
1401 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1402 TALLOC_CTX *mem_ctx,
1403 struct files_struct *fsp,
1404 uint16_t compression_fmt);
1405 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1406 TALLOC_CTX *mem_ctx,
1407 const char *service_path,
1408 char **base_volume);
1409 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1410 TALLOC_CTX *mem_ctx,
1411 const char *base_volume,
1412 time_t *tstamp,
1413 bool rw,
1414 char **base_path,
1415 char **snap_path);
1416 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1417 TALLOC_CTX *mem_ctx,
1418 char *base_path,
1419 char *snap_path);
1420 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1421 struct files_struct *fsp,
1422 uint32_t security_info,
1423 TALLOC_CTX *mem_ctx,
1424 struct security_descriptor **ppdesc);
1425 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1426 const struct smb_filename *smb_fname,
1427 uint32_t security_info,
1428 TALLOC_CTX *mem_ctx,
1429 struct security_descriptor **ppdesc);
1430 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1431 struct files_struct *fsp,
1432 uint32_t security_info_sent,
1433 const struct security_descriptor *psd);
1434 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1435 struct smb_filename *file,
1436 struct security_acl *sacl,
1437 uint32_t access_requested,
1438 uint32_t access_denied);
1439 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1440 const struct smb_filename *file,
1441 mode_t mode);
1442 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1443 const struct smb_filename *smb_fname,
1444 SMB_ACL_TYPE_T type,
1445 TALLOC_CTX *mem_ctx);
1446 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1447 struct files_struct *fsp,
1448 TALLOC_CTX *mem_ctx);
1449 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1450 const struct smb_filename *smb_fname,
1451 TALLOC_CTX *mem_ctx,
1452 char **blob_description,
1453 DATA_BLOB *blob);
1454 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1455 struct files_struct *fsp,
1456 TALLOC_CTX *mem_ctx,
1457 char **blob_description,
1458 DATA_BLOB *blob);
1459 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1460 const struct smb_filename *smb_fname,
1461 SMB_ACL_TYPE_T acltype,
1462 SMB_ACL_T theacl);
1463 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1464 struct files_struct *fsp, SMB_ACL_T theacl);
1465 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1466 const struct smb_filename *smb_fname);
1467 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1468 const struct smb_filename *smb_fname,
1469 const char *name,
1470 void *value,
1471 size_t size);
1472 struct tevent_req *smb_vfs_call_getxattrat_send(
1473 TALLOC_CTX *mem_ctx,
1474 struct tevent_context *ev,
1475 struct vfs_handle_struct *handle,
1476 files_struct *dir_fsp,
1477 const struct smb_filename *smb_fname,
1478 const char *xattr_name,
1479 size_t alloc_hint);
1480 ssize_t smb_vfs_call_getxattrat_recv(struct tevent_req *req,
1481 struct vfs_aio_state *aio_state,
1482 TALLOC_CTX *mem_ctx,
1483 uint8_t **xattr_value);
1484 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1485 struct files_struct *fsp, const char *name,
1486 void *value, size_t size);
1487 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1488 const struct smb_filename *smb_fname,
1489 char *list,
1490 size_t size);
1491 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1492 struct files_struct *fsp, char *list,
1493 size_t size);
1494 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1495 const struct smb_filename *smb_fname,
1496 const char *name);
1497 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1498 struct files_struct *fsp, const char *name);
1499 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1500 const struct smb_filename *smb_fname,
1501 const char *name,
1502 const void *value,
1503 size_t size,
1504 int flags);
1505 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1506 const char *name, const void *value, size_t size,
1507 int flags);
1508 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1509 struct files_struct *fsp, const char *name,
1510 const void *value, size_t size, int flags);
1511 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1512 struct files_struct *fsp);
1513 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1514 struct files_struct *fsp,
1515 TALLOC_CTX *mem_ctx,
1516 DATA_BLOB *cookie);
1517 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1518 struct files_struct *fsp,
1519 const DATA_BLOB old_cookie,
1520 TALLOC_CTX *mem_ctx,
1521 DATA_BLOB *new_cookie);
1522 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1523 struct smb_request *smb1req,
1524 struct smbXsrv_open *op,
1525 const DATA_BLOB old_cookie,
1526 TALLOC_CTX *mem_ctx,
1527 struct files_struct **fsp,
1528 DATA_BLOB *new_cookie);
1529 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1530 const struct smb_filename *fname,
1531 TALLOC_CTX *mem_ctx,
1532 struct readdir_attr_data **attr_data);
1534 NTSTATUS smb_register_vfs(int version, const char *name,
1535 const struct vfs_fn_pointers *fns);
1536 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1537 files_struct *fsp, size_t ext_size,
1538 void (*destroy_fn)(void *p_data));
1539 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1540 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1541 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1542 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1544 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1545 const char *module);
1548 * Helper functions from source3/modules/vfs_not_implemented.c
1550 int vfs_not_implemented_connect(
1551 vfs_handle_struct *handle,
1552 const char *service,
1553 const char *user);
1554 void vfs_not_implemented_disconnect(vfs_handle_struct *handle);
1555 uint64_t vfs_not_implemented_disk_free(vfs_handle_struct *handle,
1556 const struct smb_filename *smb_fname,
1557 uint64_t *bsize,
1558 uint64_t *dfree,
1559 uint64_t *dsize);
1560 int vfs_not_implemented_get_quota(vfs_handle_struct *handle,
1561 const struct smb_filename *smb_fname,
1562 enum SMB_QUOTA_TYPE qtype,
1563 unid_t id,
1564 SMB_DISK_QUOTA *dq);
1565 int vfs_not_implemented_set_quota(vfs_handle_struct *handle,
1566 enum SMB_QUOTA_TYPE qtype,
1567 unid_t id, SMB_DISK_QUOTA *dq);
1568 int vfs_not_implemented_get_shadow_copy_data(vfs_handle_struct *handle,
1569 files_struct *fsp,
1570 struct shadow_copy_data *shadow_copy_data,
1571 bool labels);
1572 int vfs_not_implemented_statvfs(struct vfs_handle_struct *handle,
1573 const struct smb_filename *smb_fname,
1574 struct vfs_statvfs_struct *statbuf);
1575 uint32_t vfs_not_implemented_fs_capabilities(struct vfs_handle_struct *handle,
1576 enum timestamp_set_resolution *p_ts_res);
1577 NTSTATUS vfs_not_implemented_get_dfs_referrals(struct vfs_handle_struct *handle,
1578 struct dfs_GetDFSReferral *r);
1579 DIR *vfs_not_implemented_opendir(vfs_handle_struct *handle,
1580 const struct smb_filename *smb_fname,
1581 const char *mask,
1582 uint32_t attr);
1583 NTSTATUS vfs_not_implemented_snap_check_path(struct vfs_handle_struct *handle,
1584 TALLOC_CTX *mem_ctx,
1585 const char *service_path,
1586 char **base_volume);
1587 NTSTATUS vfs_not_implemented_snap_create(struct vfs_handle_struct *handle,
1588 TALLOC_CTX *mem_ctx,
1589 const char *base_volume,
1590 time_t *tstamp,
1591 bool rw,
1592 char **base_path,
1593 char **snap_path);
1594 NTSTATUS vfs_not_implemented_snap_delete(struct vfs_handle_struct *handle,
1595 TALLOC_CTX *mem_ctx,
1596 char *base_path,
1597 char *snap_path);
1598 DIR *vfs_not_implemented_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
1599 const char *mask, uint32_t attr);
1600 struct dirent *vfs_not_implemented_readdir(vfs_handle_struct *handle,
1601 DIR *dirp, SMB_STRUCT_STAT *sbuf);
1602 void vfs_not_implemented_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset);
1603 long vfs_not_implemented_telldir(vfs_handle_struct *handle, DIR *dirp);
1604 void vfs_not_implemented_rewind_dir(vfs_handle_struct *handle, DIR *dirp);
1605 int vfs_not_implemented_mkdir(vfs_handle_struct *handle,
1606 const struct smb_filename *smb_fname,
1607 mode_t mode);
1608 int vfs_not_implemented_rmdir(vfs_handle_struct *handle,
1609 const struct smb_filename *smb_fname);
1610 int vfs_not_implemented_closedir(vfs_handle_struct *handle, DIR *dir);
1611 int vfs_not_implemented_open(vfs_handle_struct *handle,
1612 struct smb_filename *smb_fname,
1613 files_struct *fsp, int flags, mode_t mode);
1614 NTSTATUS vfs_not_implemented_create_file(struct vfs_handle_struct *handle,
1615 struct smb_request *req,
1616 uint16_t root_dir_fid,
1617 struct smb_filename *smb_fname,
1618 uint32_t access_mask,
1619 uint32_t share_access,
1620 uint32_t create_disposition,
1621 uint32_t create_options,
1622 uint32_t file_attributes,
1623 uint32_t oplock_request,
1624 struct smb2_lease *lease,
1625 uint64_t allocation_size,
1626 uint32_t private_flags,
1627 struct security_descriptor *sd,
1628 struct ea_list *ea_list,
1629 files_struct **result, int *pinfo,
1630 const struct smb2_create_blobs *in_context_blobs,
1631 struct smb2_create_blobs *out_context_blobs);
1632 int vfs_not_implemented_close_fn(vfs_handle_struct *handle, files_struct *fsp);
1633 ssize_t vfs_not_implemented_pread(vfs_handle_struct *handle, files_struct *fsp,
1634 void *data, size_t n, off_t offset);
1635 struct tevent_req *vfs_not_implemented_pread_send(struct vfs_handle_struct *handle,
1636 TALLOC_CTX *mem_ctx,
1637 struct tevent_context *ev,
1638 struct files_struct *fsp,
1639 void *data, size_t n, off_t offset);
1640 ssize_t vfs_not_implemented_pread_recv(struct tevent_req *req,
1641 struct vfs_aio_state *vfs_aio_state);
1642 ssize_t vfs_not_implemented_pwrite(vfs_handle_struct *handle, files_struct *fsp,
1643 const void *data, size_t n, off_t offset);
1644 struct tevent_req *vfs_not_implemented_pwrite_send(struct vfs_handle_struct *handle,
1645 TALLOC_CTX *mem_ctx,
1646 struct tevent_context *ev,
1647 struct files_struct *fsp,
1648 const void *data,
1649 size_t n, off_t offset);
1650 ssize_t vfs_not_implemented_pwrite_recv(struct tevent_req *req,
1651 struct vfs_aio_state *vfs_aio_state);
1652 off_t vfs_not_implemented_lseek(vfs_handle_struct *handle, files_struct *fsp,
1653 off_t offset, int whence);
1654 ssize_t vfs_not_implemented_sendfile(vfs_handle_struct *handle, int tofd,
1655 files_struct *fromfsp, const DATA_BLOB *hdr,
1656 off_t offset, size_t n);
1657 ssize_t vfs_not_implemented_recvfile(vfs_handle_struct *handle, int fromfd,
1658 files_struct *tofsp, off_t offset, size_t n);
1659 int vfs_not_implemented_rename(vfs_handle_struct *handle,
1660 const struct smb_filename *smb_fname_src,
1661 const struct smb_filename *smb_fname_dst);
1662 struct tevent_req *vfs_not_implemented_fsync_send(struct vfs_handle_struct *handle,
1663 TALLOC_CTX *mem_ctx,
1664 struct tevent_context *ev,
1665 struct files_struct *fsp);
1666 int vfs_not_implemented_fsync_recv(struct tevent_req *req,
1667 struct vfs_aio_state *vfs_aio_state);
1668 int vfs_not_implemented_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname);
1669 int vfs_not_implemented_fstat(vfs_handle_struct *handle, files_struct *fsp,
1670 SMB_STRUCT_STAT *sbuf);
1671 int vfs_not_implemented_lstat(vfs_handle_struct *handle,
1672 struct smb_filename *smb_fname);
1673 uint64_t vfs_not_implemented_get_alloc_size(struct vfs_handle_struct *handle,
1674 struct files_struct *fsp,
1675 const SMB_STRUCT_STAT *sbuf);
1676 int vfs_not_implemented_unlink(vfs_handle_struct *handle,
1677 const struct smb_filename *smb_fname);
1678 int vfs_not_implemented_chmod(vfs_handle_struct *handle,
1679 const struct smb_filename *smb_fname,
1680 mode_t mode);
1681 int vfs_not_implemented_fchmod(vfs_handle_struct *handle, files_struct *fsp,
1682 mode_t mode);
1683 int vfs_not_implemented_chown(vfs_handle_struct *handle,
1684 const struct smb_filename *smb_fname,
1685 uid_t uid,
1686 gid_t gid);
1687 int vfs_not_implemented_fchown(vfs_handle_struct *handle, files_struct *fsp,
1688 uid_t uid, gid_t gid);
1689 int vfs_not_implemented_lchown(vfs_handle_struct *handle,
1690 const struct smb_filename *smb_fname,
1691 uid_t uid,
1692 gid_t gid);
1693 int vfs_not_implemented_chdir(vfs_handle_struct *handle,
1694 const struct smb_filename *smb_fname);
1695 struct smb_filename *vfs_not_implemented_getwd(vfs_handle_struct *handle,
1696 TALLOC_CTX *ctx);
1697 int vfs_not_implemented_ntimes(vfs_handle_struct *handle,
1698 const struct smb_filename *smb_fname,
1699 struct smb_file_time *ft);
1700 int vfs_not_implemented_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
1701 off_t offset);
1702 int vfs_not_implemented_fallocate(vfs_handle_struct *handle, files_struct *fsp,
1703 uint32_t mode, off_t offset, off_t len);
1704 bool vfs_not_implemented_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
1705 off_t offset, off_t count, int type);
1706 int vfs_not_implemented_kernel_flock(struct vfs_handle_struct *handle,
1707 struct files_struct *fsp,
1708 uint32_t share_mode, uint32_t access_mask);
1709 int vfs_not_implemented_linux_setlease(struct vfs_handle_struct *handle,
1710 struct files_struct *fsp, int leasetype);
1711 bool vfs_not_implemented_getlock(vfs_handle_struct *handle, files_struct *fsp,
1712 off_t *poffset, off_t *pcount, int *ptype,
1713 pid_t *ppid);
1714 int vfs_not_implemented_symlink(vfs_handle_struct *handle,
1715 const char *link_contents,
1716 const struct smb_filename *new_smb_fname);
1717 int vfs_not_implemented_vfs_readlink(vfs_handle_struct *handle,
1718 const struct smb_filename *smb_fname,
1719 char *buf,
1720 size_t bufsiz);
1721 int vfs_not_implemented_link(vfs_handle_struct *handle,
1722 const struct smb_filename *old_smb_fname,
1723 const struct smb_filename *new_smb_fname);
1724 int vfs_not_implemented_mknod(vfs_handle_struct *handle,
1725 const struct smb_filename *smb_fname,
1726 mode_t mode,
1727 SMB_DEV_T dev);
1728 struct smb_filename *vfs_not_implemented_realpath(vfs_handle_struct *handle,
1729 TALLOC_CTX *ctx,
1730 const struct smb_filename *smb_fname);
1731 int vfs_not_implemented_chflags(vfs_handle_struct *handle,
1732 const struct smb_filename *smb_fname,
1733 uint flags);
1734 struct file_id vfs_not_implemented_file_id_create(vfs_handle_struct *handle,
1735 const SMB_STRUCT_STAT *sbuf);
1736 struct tevent_req *vfs_not_implemented_offload_read_send(
1737 TALLOC_CTX *mem_ctx,
1738 struct tevent_context *ev,
1739 struct vfs_handle_struct *handle,
1740 struct files_struct *fsp,
1741 uint32_t fsctl,
1742 uint32_t ttl,
1743 off_t offset,
1744 size_t to_copy);
1745 NTSTATUS vfs_not_implemented_offload_read_recv(struct tevent_req *req,
1746 struct vfs_handle_struct *handle,
1747 TALLOC_CTX *mem_ctx,
1748 DATA_BLOB *_token_blob);
1749 struct tevent_req *vfs_not_implemented_offload_write_send(
1750 struct vfs_handle_struct *handle,
1751 TALLOC_CTX *mem_ctx,
1752 struct tevent_context *ev,
1753 uint32_t fsctl,
1754 DATA_BLOB *token,
1755 off_t transfer_offset,
1756 struct files_struct *dest_fsp,
1757 off_t dest_off,
1758 off_t num);
1759 NTSTATUS vfs_not_implemented_offload_write_recv(struct vfs_handle_struct *handle,
1760 struct tevent_req *req,
1761 off_t *copied);
1762 NTSTATUS vfs_not_implemented_get_compression(struct vfs_handle_struct *handle,
1763 TALLOC_CTX *mem_ctx,
1764 struct files_struct *fsp,
1765 struct smb_filename *smb_fname,
1766 uint16_t *_compression_fmt);
1767 NTSTATUS vfs_not_implemented_set_compression(struct vfs_handle_struct *handle,
1768 TALLOC_CTX *mem_ctx,
1769 struct files_struct *fsp,
1770 uint16_t compression_fmt);
1771 NTSTATUS vfs_not_implemented_streaminfo(struct vfs_handle_struct *handle,
1772 struct files_struct *fsp,
1773 const struct smb_filename *smb_fname,
1774 TALLOC_CTX *mem_ctx,
1775 unsigned int *num_streams,
1776 struct stream_struct **streams);
1777 int vfs_not_implemented_get_real_filename(struct vfs_handle_struct *handle,
1778 const char *path,
1779 const char *name,
1780 TALLOC_CTX *mem_ctx,
1781 char **found_name);
1782 const char *vfs_not_implemented_connectpath(struct vfs_handle_struct *handle,
1783 const struct smb_filename *smb_fname);
1784 NTSTATUS vfs_not_implemented_brl_lock_windows(struct vfs_handle_struct *handle,
1785 struct byte_range_lock *br_lck,
1786 struct lock_struct *plock,
1787 bool blocking_lock);
1788 bool vfs_not_implemented_brl_unlock_windows(struct vfs_handle_struct *handle,
1789 struct messaging_context *msg_ctx,
1790 struct byte_range_lock *br_lck,
1791 const struct lock_struct *plock);
1792 bool vfs_not_implemented_brl_cancel_windows(struct vfs_handle_struct *handle,
1793 struct byte_range_lock *br_lck,
1794 struct lock_struct *plock);
1795 bool vfs_not_implemented_strict_lock_check(struct vfs_handle_struct *handle,
1796 struct files_struct *fsp,
1797 struct lock_struct *plock);
1798 NTSTATUS vfs_not_implemented_translate_name(struct vfs_handle_struct *handle,
1799 const char *mapped_name,
1800 enum vfs_translate_direction direction,
1801 TALLOC_CTX *mem_ctx, char **pmapped_name);
1802 NTSTATUS vfs_not_implemented_fsctl(struct vfs_handle_struct *handle,
1803 struct files_struct *fsp,
1804 TALLOC_CTX *ctx,
1805 uint32_t function,
1806 uint16_t req_flags, /* Needed for UNICODE ... */
1807 const uint8_t *_in_data,
1808 uint32_t in_len,
1809 uint8_t **_out_data,
1810 uint32_t max_out_len, uint32_t *out_len);
1811 NTSTATUS vfs_not_implemented_readdir_attr(struct vfs_handle_struct *handle,
1812 const struct smb_filename *fname,
1813 TALLOC_CTX *mem_ctx,
1814 struct readdir_attr_data **pattr_data);
1815 NTSTATUS vfs_not_implemented_get_dos_attributes(struct vfs_handle_struct *handle,
1816 struct smb_filename *smb_fname,
1817 uint32_t *dosmode);
1818 struct tevent_req *vfs_not_implemented_get_dos_attributes_send(
1819 TALLOC_CTX *mem_ctx,
1820 struct tevent_context *ev,
1821 struct vfs_handle_struct *handle,
1822 files_struct *dir_fsp,
1823 struct smb_filename *smb_fname);
1824 NTSTATUS vfs_not_implemented_get_dos_attributes_recv(
1825 struct tevent_req *req,
1826 struct vfs_aio_state *aio_state,
1827 uint32_t *dosmode);
1828 NTSTATUS vfs_not_implemented_fget_dos_attributes(struct vfs_handle_struct *handle,
1829 struct files_struct *fsp,
1830 uint32_t *dosmode);
1831 NTSTATUS vfs_not_implemented_set_dos_attributes(struct vfs_handle_struct *handle,
1832 const struct smb_filename *smb_fname,
1833 uint32_t dosmode);
1834 NTSTATUS vfs_not_implemented_fset_dos_attributes(struct vfs_handle_struct *handle,
1835 struct files_struct *fsp,
1836 uint32_t dosmode);
1837 NTSTATUS vfs_not_implemented_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1838 uint32_t security_info,
1839 TALLOC_CTX *mem_ctx,
1840 struct security_descriptor **ppdesc);
1841 NTSTATUS vfs_not_implemented_get_nt_acl(vfs_handle_struct *handle,
1842 const struct smb_filename *smb_fname,
1843 uint32_t security_info,
1844 TALLOC_CTX *mem_ctx,
1845 struct security_descriptor **ppdesc);
1846 NTSTATUS vfs_not_implemented_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1847 uint32_t security_info_sent,
1848 const struct security_descriptor *psd);
1849 SMB_ACL_T vfs_not_implemented_sys_acl_get_file(vfs_handle_struct *handle,
1850 const struct smb_filename *smb_fname,
1851 SMB_ACL_TYPE_T type,
1852 TALLOC_CTX *mem_ctx);
1853 SMB_ACL_T vfs_not_implemented_sys_acl_get_fd(vfs_handle_struct *handle,
1854 files_struct *fsp, TALLOC_CTX *mem_ctx);
1855 int vfs_not_implemented_sys_acl_blob_get_file(vfs_handle_struct *handle,
1856 const struct smb_filename *smb_fname,
1857 TALLOC_CTX *mem_ctx,
1858 char **blob_description,
1859 DATA_BLOB *blob);
1860 int vfs_not_implemented_sys_acl_blob_get_fd(vfs_handle_struct *handle,
1861 files_struct *fsp, TALLOC_CTX *mem_ctx,
1862 char **blob_description, DATA_BLOB *blob);
1863 int vfs_not_implemented_sys_acl_set_file(vfs_handle_struct *handle,
1864 const struct smb_filename *smb_fname,
1865 SMB_ACL_TYPE_T acltype,
1866 SMB_ACL_T theacl);
1867 int vfs_not_implemented_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
1868 SMB_ACL_T theacl);
1869 int vfs_not_implemented_sys_acl_delete_def_file(vfs_handle_struct *handle,
1870 const struct smb_filename *smb_fname);
1871 ssize_t vfs_not_implemented_getxattr(vfs_handle_struct *handle,
1872 const struct smb_filename *smb_fname,
1873 const char *name,
1874 void *value,
1875 size_t size);
1876 struct tevent_req *vfs_not_implemented_getxattrat_send(
1877 TALLOC_CTX *mem_ctx,
1878 struct tevent_context *ev,
1879 struct vfs_handle_struct *handle,
1880 files_struct *dir_fsp,
1881 const struct smb_filename *smb_fname,
1882 const char *xattr_name,
1883 size_t alloc_hint);
1884 ssize_t vfs_not_implemented_getxattrat_recv(struct tevent_req *req,
1885 struct vfs_aio_state *aio_state,
1886 TALLOC_CTX *mem_ctx,
1887 uint8_t **xattr_value);
1888 ssize_t vfs_not_implemented_fgetxattr(vfs_handle_struct *handle,
1889 struct files_struct *fsp, const char *name,
1890 void *value, size_t size);
1891 ssize_t vfs_not_implemented_listxattr(vfs_handle_struct *handle,
1892 const struct smb_filename *smb_fname,
1893 char *list,
1894 size_t size);
1895 ssize_t vfs_not_implemented_flistxattr(vfs_handle_struct *handle,
1896 struct files_struct *fsp, char *list,
1897 size_t size);
1898 int vfs_not_implemented_removexattr(vfs_handle_struct *handle,
1899 const struct smb_filename *smb_fname,
1900 const char *name);
1901 int vfs_not_implemented_fremovexattr(vfs_handle_struct *handle,
1902 struct files_struct *fsp, const char *name);
1903 int vfs_not_implemented_setxattr(vfs_handle_struct *handle,
1904 const struct smb_filename *smb_fname,
1905 const char *name,
1906 const void *value,
1907 size_t size,
1908 int flags);
1909 int vfs_not_implemented_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
1910 const char *name, const void *value, size_t size,
1911 int flags);
1912 bool vfs_not_implemented_aio_force(struct vfs_handle_struct *handle,
1913 struct files_struct *fsp);
1914 NTSTATUS vfs_not_implemented_audit_file(struct vfs_handle_struct *handle,
1915 struct smb_filename *file,
1916 struct security_acl *sacl,
1917 uint32_t access_requested,
1918 uint32_t access_denied);
1919 NTSTATUS vfs_not_implemented_durable_cookie(struct vfs_handle_struct *handle,
1920 struct files_struct *fsp,
1921 TALLOC_CTX *mem_ctx,
1922 DATA_BLOB *cookie);
1923 NTSTATUS vfs_not_implemented_durable_disconnect(struct vfs_handle_struct *handle,
1924 struct files_struct *fsp,
1925 const DATA_BLOB old_cookie,
1926 TALLOC_CTX *mem_ctx,
1927 DATA_BLOB *new_cookie);
1928 NTSTATUS vfs_not_implemented_durable_reconnect(struct vfs_handle_struct *handle,
1929 struct smb_request *smb1req,
1930 struct smbXsrv_open *op,
1931 const DATA_BLOB old_cookie,
1932 TALLOC_CTX *mem_ctx,
1933 struct files_struct **fsp,
1934 DATA_BLOB *new_cookie);
1935 #endif /* _VFS_H */