s4:selftest: explicitly set NSS/RESOLV_WAPPER_* in wait_for_start
[Samba.git] / source3 / include / vfs.h
blobbb4a135e41e2cda82588a7722df62e40e1a6a425
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 */
249 #define SMB_VFS_INTERFACE_VERSION 38
252 All intercepted VFS operations must be declared as static functions inside module source
253 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
254 example VFS modules for more details.
257 /* VFS operations structure */
259 struct vfs_handle_struct;
260 struct connection_struct;
261 struct files_struct;
262 struct security_descriptor;
263 struct vfs_statvfs_struct;
264 struct smb_request;
265 struct ea_list;
266 struct smb_file_time;
267 struct blocking_lock_record;
268 struct smb_filename;
269 struct dfs_GetDFSReferral;
271 typedef union unid_t {
272 uid_t uid;
273 gid_t gid;
274 } unid_t;
276 struct fd_handle {
277 size_t ref_count;
278 int fd;
279 uint64_t position_information;
280 off_t pos;
281 uint32_t private_options; /* NT Create options, but we only look at
282 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
283 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
284 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
285 * for print files *only*, where
286 * DELETE_ON_CLOSE is not stored in the share
287 * mode database.
289 unsigned long gen_id;
292 struct fsp_lease {
293 size_t ref_count;
294 struct smbd_server_connection *sconn;
295 struct tevent_timer *timeout;
296 struct smb2_lease lease;
299 typedef struct files_struct {
300 struct files_struct *next, *prev;
301 uint64_t fnum;
302 struct smbXsrv_open *op;
303 struct connection_struct *conn;
304 struct fd_handle *fh;
305 unsigned int num_smb_operations;
306 struct file_id file_id;
307 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
308 uint16_t file_pid;
309 uint64_t vuid; /* SMB2 compat */
310 struct write_cache *wcp;
311 struct timeval open_time;
312 uint32_t access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
313 uint32_t share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
315 bool kernel_share_modes_taken;
317 bool update_write_time_triggered;
318 struct tevent_timer *update_write_time_event;
319 bool update_write_time_on_close;
320 struct timespec close_write_time;
321 bool write_time_forced;
323 int oplock_type;
324 struct fsp_lease *lease;
325 int sent_oplock_break;
326 struct tevent_timer *oplock_timeout;
327 struct lock_struct last_lock_failure;
328 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
330 bool can_lock;
331 bool can_read;
332 bool can_write;
333 bool modified;
334 bool is_directory;
335 bool aio_write_behind;
336 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
337 bool delete_on_close;
338 uint64_t posix_flags;
339 bool is_sparse;
340 bool backup_intent; /* Handle was successfully opened with backup intent
341 and opener has privilege to do so. */
342 bool use_ofd_locks; /* Are we using open file description locks ? */
343 struct smb_filename *fsp_name;
344 uint32_t name_hash; /* Jenkins hash of full pathname. */
345 uint64_t mid; /* Mid of the operation that created us. */
347 struct vfs_fsp_data *vfs_extension;
348 struct fake_file_handle *fake_file_handle;
350 struct notify_change_buf *notify;
352 struct files_struct *base_fsp; /* placeholder for delete on close */
355 * Read-only cached brlock record, thrown away when the
356 * brlock.tdb seqnum changes. This avoids fetching data from
357 * the brlock.tdb on every read/write call.
359 int brlock_seqnum;
360 struct byte_range_lock *brlock_rec;
362 struct dptr_struct *dptr;
364 /* if not NULL, means this is a print file */
365 struct print_file_data *print_file;
367 unsigned num_aio_requests;
368 struct tevent_req **aio_requests;
371 * If a close request comes in while we still have aio_requests
372 * around, we need to hold back the close. When all aio_requests are
373 * done, the aio completion routines need tevent_wait_done() on
374 * this. A bit ugly, but before we have close_file() fully async
375 * possibly the simplest approach. Thanks, Jeremy for the idea.
377 struct tevent_req *deferred_close;
378 } files_struct;
380 #define FSP_POSIX_FLAGS_OPEN 0x01
381 #define FSP_POSIX_FLAGS_RENAME 0x02
382 #define FSP_POSIX_FLAGS_PATHNAMES 0x04
384 #define FSP_POSIX_FLAGS_ALL \
385 (FSP_POSIX_FLAGS_OPEN | \
386 FSP_POSIX_FLAGS_PATHNAMES | \
387 FSP_POSIX_FLAGS_RENAME)
389 struct vuid_cache_entry {
390 struct auth_session_info *session_info;
391 uint64_t vuid; /* SMB2 compat */
392 bool read_only;
393 uint32_t share_access;
396 struct vuid_cache {
397 unsigned int next_entry;
398 struct vuid_cache_entry array[VUID_CACHE_SIZE];
401 typedef struct {
402 char *name;
403 bool is_wild;
404 } name_compare_entry;
406 struct dfree_cached_info {
407 time_t last_dfree_time;
408 uint64_t dfree_ret;
409 uint64_t bsize;
410 uint64_t dfree;
411 uint64_t dsize;
414 struct share_params {
415 int service;
418 typedef struct connection_struct {
419 struct connection_struct *next, *prev;
420 struct smbd_server_connection *sconn; /* can be NULL */
421 struct smbXsrv_tcon *tcon; /* can be NULL */
422 uint32_t cnum; /* an index passed over the wire */
423 struct share_params *params;
424 bool force_user;
425 struct vuid_cache *vuid_cache;
426 bool printer;
427 bool ipc;
428 bool read_only; /* Attributes for the current user of the share. */
429 uint32_t share_access;
430 /* Does this filesystem honor
431 sub second timestamps on files
432 and directories when setting time ? */
433 enum timestamp_set_resolution ts_res;
434 char *connectpath;
435 char *origpath;
436 struct smb_filename *cwd_fname; /* Working directory. */
438 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
441 * This represents the user information on this connection. Depending
442 * on the vuid using this tid, this might change per SMB request.
444 struct auth_session_info *session_info;
447 * If the "force group" parameter is set, this is the primary gid that
448 * may be used in the users token, depending on the vuid using this tid.
450 gid_t force_group_gid;
452 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
454 time_t lastused;
455 time_t lastused_count;
456 int num_files_open;
457 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
458 int encrypt_level;
459 bool encrypted_tid;
461 /* Semantics requested by the client or forced by the server config. */
462 bool case_sensitive;
463 bool case_preserve;
464 bool short_case_preserve;
466 /* Semantics provided by the underlying filesystem. */
467 int fs_capabilities;
468 /* Device number of the directory of the share mount.
469 Used to ensure unique FileIndex returns. */
470 SMB_DEV_T base_share_dev;
472 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
473 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
474 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
475 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
476 struct dfree_cached_info *dfree_info;
477 struct trans_state *pending_trans;
479 struct rpc_pipe_client *spoolss_pipe;
481 } connection_struct;
483 struct smbd_smb2_request;
484 struct privilege_paths;
486 struct smb_request {
487 uint8_t cmd;
488 uint16_t flags2;
489 uint16_t smbpid;
490 uint64_t mid; /* For compatibility with SMB2. */
491 uint32_t seqnum;
492 uint64_t vuid; /* For compatibility with SMB2. */
493 uint32_t tid;
494 uint8_t wct;
495 const uint16_t *vwv;
496 uint16_t buflen;
497 const uint8_t *buf;
498 const uint8_t *inbuf;
501 * Async handling in the main smb processing loop is directed by
502 * outbuf: reply_xxx routines indicate sync behaviour by putting their
503 * reply into "outbuf". If they leave it as NULL, they take care of it
504 * themselves, possibly later.
506 * If async handling is wanted, the reply_xxx routine must make sure
507 * that it talloc_move()s the smb_req somewhere else.
509 uint8_t *outbuf;
511 size_t unread_bytes;
512 bool encrypted;
513 connection_struct *conn;
514 struct smbd_server_connection *sconn;
515 struct smbXsrv_connection *xconn;
516 struct smb_perfcount_data pcd;
519 * Chained request handling
521 struct files_struct *chain_fsp;
524 * state information for async smb handling
526 void *async_priv;
529 * Back pointer to smb2 request.
531 struct smbd_smb2_request *smb2req;
534 * Pathnames used if request done
535 * under privilege.
537 struct privilege_paths *priv_paths;
540 * Request list for chained requests, we're part of it.
542 struct smb_request **chain;
544 struct timeval request_time;
546 bool posix_pathnames;
550 * Info about an alternate data stream
553 struct stream_struct {
554 off_t size;
555 off_t alloc_size;
556 char *name;
559 /* time info */
560 struct smb_file_time {
561 struct timespec mtime;
562 struct timespec atime;
563 struct timespec ctime;
564 struct timespec create_time;
568 * smb_filename
570 struct smb_filename {
571 char *base_name;
572 char *stream_name;
573 char *original_lcomp;
574 uint32_t flags;
575 SMB_STRUCT_STAT st;
579 * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
580 * to keep the numeric values consistent.
583 #define SMB_FILENAME_POSIX_PATH FSP_POSIX_FLAGS_PATHNAMES
585 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
586 handle = handle->next; \
589 enum vfs_translate_direction {
590 vfs_translate_to_unix = 0,
591 vfs_translate_to_windows
594 enum vfs_fallocate_flags {
595 VFS_FALLOCATE_FL_KEEP_SIZE = 0x0001,
596 VFS_FALLOCATE_FL_PUNCH_HOLE = 0x0002,
599 struct vfs_aio_state {
600 int error;
601 uint64_t duration;
605 Available VFS operations. These values must be in sync with vfs_ops struct
606 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
607 In particular, if new operations are added to vfs_ops, appropriate constants
608 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
610 struct shadow_copy_data;
612 struct vfs_fn_pointers {
613 /* Disk operations */
615 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
616 void (*disconnect_fn)(struct vfs_handle_struct *handle);
617 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle,
618 const struct smb_filename *smb_fname,
619 uint64_t *bsize,
620 uint64_t *dfree,
621 uint64_t *dsize);
622 int (*get_quota_fn)(struct vfs_handle_struct *handle,
623 const struct smb_filename *smb_fname,
624 enum SMB_QUOTA_TYPE qtype,
625 unid_t id,
626 SMB_DISK_QUOTA *qt);
627 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
628 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
629 int (*statvfs_fn)(struct vfs_handle_struct *handle,
630 const struct smb_filename *smb_fname,
631 struct vfs_statvfs_struct *statbuf);
632 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
635 * Note: that "struct dfs_GetDFSReferral *r"
636 * needs to be a valid TALLOC_CTX
638 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
639 struct dfs_GetDFSReferral *r);
641 /* Directory operations */
643 DIR *(*opendir_fn)(struct vfs_handle_struct *handle,
644 const struct smb_filename *smb_fname,
645 const char *mask,
646 uint32_t attributes);
647 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
648 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
649 DIR *dirp,
650 SMB_STRUCT_STAT *sbuf);
651 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
652 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
653 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
654 int (*mkdir_fn)(struct vfs_handle_struct *handle,
655 const struct smb_filename *smb_fname,
656 mode_t mode);
657 int (*rmdir_fn)(struct vfs_handle_struct *handle,
658 const struct smb_filename *smb_fname);
659 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
661 /* File operations */
663 int (*open_fn)(struct vfs_handle_struct *handle,
664 struct smb_filename *smb_fname, files_struct *fsp,
665 int flags, mode_t mode);
666 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
667 struct smb_request *req,
668 uint16_t root_dir_fid,
669 struct smb_filename *smb_fname,
670 uint32_t access_mask,
671 uint32_t share_access,
672 uint32_t create_disposition,
673 uint32_t create_options,
674 uint32_t file_attributes,
675 uint32_t oplock_request,
676 struct smb2_lease *lease,
677 uint64_t allocation_size,
678 uint32_t private_flags,
679 struct security_descriptor *sd,
680 struct ea_list *ea_list,
681 files_struct **result,
682 int *pinfo,
683 const struct smb2_create_blobs *in_context_blobs,
684 struct smb2_create_blobs *out_context_blobs);
685 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
686 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
687 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
688 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
689 TALLOC_CTX *mem_ctx,
690 struct tevent_context *ev,
691 struct files_struct *fsp,
692 void *data,
693 size_t n, off_t offset);
694 ssize_t (*pread_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
695 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
696 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
697 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
698 TALLOC_CTX *mem_ctx,
699 struct tevent_context *ev,
700 struct files_struct *fsp,
701 const void *data,
702 size_t n, off_t offset);
703 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
704 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
705 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
706 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
707 int (*rename_fn)(struct vfs_handle_struct *handle,
708 const struct smb_filename *smb_fname_src,
709 const struct smb_filename *smb_fname_dst);
710 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
711 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
712 TALLOC_CTX *mem_ctx,
713 struct tevent_context *ev,
714 struct files_struct *fsp);
715 int (*fsync_recv_fn)(struct tevent_req *req, struct vfs_aio_state *state);
716 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
717 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
718 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
719 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
720 int (*unlink_fn)(struct vfs_handle_struct *handle,
721 const struct smb_filename *smb_fname);
722 int (*chmod_fn)(struct vfs_handle_struct *handle,
723 const struct smb_filename *smb_fname,
724 mode_t mode);
725 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
726 int (*chown_fn)(struct vfs_handle_struct *handle,
727 const struct smb_filename *smb_fname,
728 uid_t uid,
729 gid_t gid);
730 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
731 int (*lchown_fn)(struct vfs_handle_struct *handle,
732 const struct smb_filename *smb_fname,
733 uid_t uid,
734 gid_t gid);
735 int (*chdir_fn)(struct vfs_handle_struct *handle,
736 const struct smb_filename *smb_fname);
737 struct smb_filename *(*getwd_fn)(struct vfs_handle_struct *handle,
738 TALLOC_CTX *mem_ctx);
739 int (*ntimes_fn)(struct vfs_handle_struct *handle,
740 const struct smb_filename *smb_fname,
741 struct smb_file_time *ft);
742 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
743 int (*fallocate_fn)(struct vfs_handle_struct *handle,
744 struct files_struct *fsp,
745 uint32_t mode,
746 off_t offset,
747 off_t len);
748 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
749 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
750 uint32_t share_mode, uint32_t access_mask);
751 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
752 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
753 int (*symlink_fn)(struct vfs_handle_struct *handle,
754 const char *link_contents,
755 const struct smb_filename *new_smb_fname);
756 int (*readlink_fn)(struct vfs_handle_struct *handle,
757 const struct smb_filename *smb_fname,
758 char *buf,
759 size_t bufsiz);
760 int (*link_fn)(struct vfs_handle_struct *handle,
761 const struct smb_filename *old_smb_fname,
762 const struct smb_filename *new_smb_fname);
763 int (*mknod_fn)(struct vfs_handle_struct *handle,
764 const struct smb_filename *smb_fname,
765 mode_t mode,
766 SMB_DEV_T dev);
767 struct smb_filename *(*realpath_fn)(struct vfs_handle_struct *handle,
768 TALLOC_CTX *ctx,
769 const struct smb_filename *smb_fname);
770 int (*chflags_fn)(struct vfs_handle_struct *handle,
771 const struct smb_filename *smb_fname,
772 unsigned int flags);
773 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
774 const SMB_STRUCT_STAT *sbuf);
775 struct tevent_req *(*offload_read_send_fn)(TALLOC_CTX *mem_ctx,
776 struct tevent_context *ev,
777 struct vfs_handle_struct *handle,
778 struct files_struct *fsp,
779 uint32_t fsctl,
780 uint32_t ttl,
781 off_t offset,
782 size_t to_copy);
783 NTSTATUS (*offload_read_recv_fn)(struct tevent_req *req,
784 struct vfs_handle_struct *handle,
785 TALLOC_CTX *mem_ctx,
786 DATA_BLOB *token_blob);
787 struct tevent_req *(*offload_write_send_fn)(struct vfs_handle_struct *handle,
788 TALLOC_CTX *mem_ctx,
789 struct tevent_context *ev,
790 uint32_t fsctl,
791 DATA_BLOB *token,
792 off_t transfer_offset,
793 struct files_struct *dest_fsp,
794 off_t dest_off,
795 off_t to_copy);
796 NTSTATUS (*offload_write_recv_fn)(struct vfs_handle_struct *handle,
797 struct tevent_req *req,
798 off_t *copied);
799 NTSTATUS (*get_compression_fn)(struct vfs_handle_struct *handle,
800 TALLOC_CTX *mem_ctx,
801 struct files_struct *fsp,
802 struct smb_filename *smb_fname,
803 uint16_t *_compression_fmt);
804 NTSTATUS (*set_compression_fn)(struct vfs_handle_struct *handle,
805 TALLOC_CTX *mem_ctx,
806 struct files_struct *fsp,
807 uint16_t compression_fmt);
808 NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
809 TALLOC_CTX *mem_ctx,
810 const char *service_path,
811 char **base_volume);
812 NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
813 TALLOC_CTX *mem_ctx,
814 const char *base_volume,
815 time_t *tstamp,
816 bool rw,
817 char **base_path,
818 char **snap_path);
819 NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
820 TALLOC_CTX *mem_ctx,
821 char *base_path,
822 char *snap_path);
824 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
825 struct files_struct *fsp,
826 const struct smb_filename *smb_fname,
827 TALLOC_CTX *mem_ctx,
828 unsigned int *num_streams,
829 struct stream_struct **streams);
831 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
832 const char *path,
833 const char *name,
834 TALLOC_CTX *mem_ctx,
835 char **found_name);
837 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
838 const struct smb_filename *smb_fname);
840 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
841 struct byte_range_lock *br_lck,
842 struct lock_struct *plock,
843 bool blocking_lock);
845 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
846 struct messaging_context *msg_ctx,
847 struct byte_range_lock *br_lck,
848 const struct lock_struct *plock);
850 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
851 struct byte_range_lock *br_lck,
852 struct lock_struct *plock);
854 bool (*strict_lock_check_fn)(struct vfs_handle_struct *handle,
855 struct files_struct *fsp,
856 struct lock_struct *plock);
858 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
859 const char *name,
860 enum vfs_translate_direction direction,
861 TALLOC_CTX *mem_ctx,
862 char **mapped_name);
864 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
865 struct files_struct *fsp,
866 TALLOC_CTX *ctx,
867 uint32_t function,
868 uint16_t req_flags,
869 const uint8_t *_in_data,
870 uint32_t in_len,
871 uint8_t **_out_data,
872 uint32_t max_out_len,
873 uint32_t *out_len);
875 NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
876 struct smb_filename *smb_fname,
877 uint32_t *dosmode);
879 NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
880 struct files_struct *fsp,
881 uint32_t *dosmode);
883 NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
884 const struct smb_filename *smb_fname,
885 uint32_t dosmode);
887 NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
888 struct files_struct *fsp,
889 uint32_t dosmode);
891 /* NT ACL operations. */
893 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
894 struct files_struct *fsp,
895 uint32_t security_info,
896 TALLOC_CTX *mem_ctx,
897 struct security_descriptor **ppdesc);
898 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
899 const struct smb_filename *smb_fname,
900 uint32_t security_info,
901 TALLOC_CTX *mem_ctx,
902 struct security_descriptor **ppdesc);
903 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
904 struct files_struct *fsp,
905 uint32_t security_info_sent,
906 const struct security_descriptor *psd);
908 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
909 struct smb_filename *file,
910 struct security_acl *sacl,
911 uint32_t access_requested,
912 uint32_t access_denied);
914 /* POSIX ACL operations. */
916 int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
917 const struct smb_filename *smb_fname,
918 mode_t mode);
919 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
921 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
922 const struct smb_filename *smb_fname,
923 SMB_ACL_TYPE_T type,
924 TALLOC_CTX *mem_ctx);
925 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
926 struct files_struct *fsp,
927 TALLOC_CTX *mem_ctx);
928 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
929 const struct smb_filename *smb_fname,
930 TALLOC_CTX *mem_ctx,
931 char **blob_description,
932 DATA_BLOB *blob);
933 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
934 TALLOC_CTX *mem_ctx, char **blob_description,
935 DATA_BLOB *blob);
936 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
937 const struct smb_filename *smb_fname,
938 SMB_ACL_TYPE_T acltype,
939 SMB_ACL_T theacl);
940 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
941 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
942 const struct smb_filename *smb_fname);
944 /* EA operations. */
945 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,
946 const struct smb_filename *smb_fname,
947 const char *name,
948 void *value,
949 size_t size);
950 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
951 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle,
952 const struct smb_filename *smb_fname,
953 char *list,
954 size_t size);
955 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
956 int (*removexattr_fn)(struct vfs_handle_struct *handle,
957 const struct smb_filename *smb_fname,
958 const char *name);
959 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
960 int (*setxattr_fn)(struct vfs_handle_struct *handle,
961 const struct smb_filename *smb_fname,
962 const char *name,
963 const void *value,
964 size_t size,
965 int flags);
966 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
968 /* aio operations */
969 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
971 /* durable handle operations */
972 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
973 struct files_struct *fsp,
974 TALLOC_CTX *mem_ctx,
975 DATA_BLOB *cookie);
976 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
977 struct files_struct *fsp,
978 const DATA_BLOB old_cookie,
979 TALLOC_CTX *mem_ctx,
980 DATA_BLOB *new_cookie);
981 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
982 struct smb_request *smb1req,
983 struct smbXsrv_open *op,
984 const DATA_BLOB old_cookie,
985 TALLOC_CTX *mem_ctx,
986 struct files_struct **fsp,
987 DATA_BLOB *new_cookie);
989 NTSTATUS (*readdir_attr_fn)(struct vfs_handle_struct *handle,
990 const struct smb_filename *fname,
991 TALLOC_CTX *mem_ctx,
992 struct readdir_attr_data **attr_data);
996 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
997 which describes all operations this module is willing to intercept.
998 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
999 using this information.
1002 typedef struct vfs_handle_struct {
1003 struct vfs_handle_struct *next, *prev;
1004 const char *param;
1005 struct connection_struct *conn;
1006 const struct vfs_fn_pointers *fns;
1007 void *data;
1008 void (*free_data)(void **data);
1009 } vfs_handle_struct;
1012 typedef struct vfs_statvfs_struct {
1013 /* For undefined recommended transfer size return -1 in that field */
1014 uint32_t OptimalTransferSize; /* bsize on some os, iosize on other os */
1015 uint32_t BlockSize;
1018 The next three fields are in terms of the block size.
1019 (above). If block size is unknown, 4096 would be a
1020 reasonable block size for a server to report.
1021 Note that returning the blocks/blocksavail removes need
1022 to make a second call (to QFSInfo level 0x103 to get this info.
1023 UserBlockAvail is typically less than or equal to BlocksAvail,
1024 if no distinction is made return the same value in each.
1027 uint64_t TotalBlocks;
1028 uint64_t BlocksAvail; /* bfree */
1029 uint64_t UserBlocksAvail; /* bavail */
1031 /* For undefined Node fields or FSID return -1 */
1032 uint64_t TotalFileNodes;
1033 uint64_t FreeFileNodes;
1034 uint64_t FsIdentifier; /* fsid */
1035 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
1036 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
1038 int FsCapabilities;
1039 } vfs_statvfs_struct;
1041 /* Add a new FSP extension of the given type. Returns a pointer to the
1042 * extenstion data.
1044 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
1045 (type *)vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
1047 /* Return a pointer to the existing FSP extension data. */
1048 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
1049 vfs_fetch_fsp_extension(handle, (fsp))
1051 /* Return the talloc context associated with an FSP extension. */
1052 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
1053 vfs_memctx_fsp_extension(handle, (fsp))
1055 /* Remove and destroy an FSP extension. */
1056 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
1057 vfs_remove_fsp_extension((handle), (fsp))
1059 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
1060 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
1061 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
1062 ret; \
1066 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
1067 if (!(handle)) { \
1068 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
1069 ret; \
1070 } else { \
1071 if ((handle)->free_data) { \
1072 (handle)->free_data(&(handle)->data); \
1074 (handle)->data = (void *)datap; \
1075 (handle)->free_data = free_fn; \
1079 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
1080 if ((handle) && (handle)->free_data) { \
1081 (handle)->free_data(&(handle)->data); \
1085 /* Check whether module-specific data handle was already allocated or not */
1086 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
1088 #define SMB_VFS_OP(x) ((void *) x)
1090 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
1092 #include "vfs_macros.h"
1094 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
1095 const char *service, const char *user);
1096 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
1097 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
1098 const struct smb_filename *smb_filename,
1099 uint64_t *bsize,
1100 uint64_t *dfree,
1101 uint64_t *dsize);
1102 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
1103 const struct smb_filename *smb_filename,
1104 enum SMB_QUOTA_TYPE qtype,
1105 unid_t id,
1106 SMB_DISK_QUOTA *qt);
1107 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
1108 enum SMB_QUOTA_TYPE qtype, unid_t id,
1109 SMB_DISK_QUOTA *qt);
1110 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
1111 struct files_struct *fsp,
1112 struct shadow_copy_data *shadow_copy_data,
1113 bool labels);
1114 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle,
1115 const struct smb_filename *smb_fname,
1116 struct vfs_statvfs_struct *statbuf);
1117 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
1118 enum timestamp_set_resolution *p_ts_res);
1120 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
1122 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
1123 struct dfs_GetDFSReferral *r);
1124 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
1125 const struct smb_filename *smb_fname,
1126 const char *mask,
1127 uint32_t attributes);
1128 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
1129 struct files_struct *fsp,
1130 const char *mask,
1131 uint32_t attributes);
1132 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
1133 DIR *dirp,
1134 SMB_STRUCT_STAT *sbuf);
1135 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
1136 DIR *dirp, long offset);
1137 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
1138 DIR *dirp);
1139 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
1140 DIR *dirp);
1141 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle,
1142 const struct smb_filename *smb_fname,
1143 mode_t mode);
1144 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle,
1145 const struct smb_filename *smb_fname);
1146 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
1147 DIR *dir);
1148 int smb_vfs_call_open(struct vfs_handle_struct *handle,
1149 struct smb_filename *smb_fname, struct files_struct *fsp,
1150 int flags, mode_t mode);
1151 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
1152 struct smb_request *req,
1153 uint16_t root_dir_fid,
1154 struct smb_filename *smb_fname,
1155 uint32_t access_mask,
1156 uint32_t share_access,
1157 uint32_t create_disposition,
1158 uint32_t create_options,
1159 uint32_t file_attributes,
1160 uint32_t oplock_request,
1161 struct smb2_lease *lease,
1162 uint64_t allocation_size,
1163 uint32_t private_flags,
1164 struct security_descriptor *sd,
1165 struct ea_list *ea_list,
1166 files_struct **result,
1167 int *pinfo,
1168 const struct smb2_create_blobs *in_context_blobs,
1169 struct smb2_create_blobs *out_context_blobs);
1170 int smb_vfs_call_close(struct vfs_handle_struct *handle,
1171 struct files_struct *fsp);
1172 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
1173 struct files_struct *fsp, void *data, size_t n);
1174 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
1175 struct files_struct *fsp, void *data, size_t n,
1176 off_t offset);
1177 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
1178 TALLOC_CTX *mem_ctx,
1179 struct tevent_context *ev,
1180 struct files_struct *fsp,
1181 void *data,
1182 size_t n, off_t offset);
1183 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1185 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
1186 struct files_struct *fsp, const void *data,
1187 size_t n);
1188 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
1189 struct files_struct *fsp, const void *data,
1190 size_t n, off_t offset);
1191 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
1192 TALLOC_CTX *mem_ctx,
1193 struct tevent_context *ev,
1194 struct files_struct *fsp,
1195 const void *data,
1196 size_t n, off_t offset);
1197 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1199 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
1200 struct files_struct *fsp, off_t offset,
1201 int whence);
1202 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
1203 files_struct *fromfsp, const DATA_BLOB *header,
1204 off_t offset, size_t count);
1205 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
1206 files_struct *tofsp, off_t offset,
1207 size_t count);
1208 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
1209 const struct smb_filename *smb_fname_src,
1210 const struct smb_filename *smb_fname_dst);
1211 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
1212 struct files_struct *fsp);
1214 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
1215 TALLOC_CTX *mem_ctx,
1216 struct tevent_context *ev,
1217 struct files_struct *fsp);
1218 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, struct vfs_aio_state *state);
1220 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
1221 struct smb_filename *smb_fname);
1222 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
1223 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
1224 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
1225 struct smb_filename *smb_filename);
1226 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
1227 struct files_struct *fsp,
1228 const SMB_STRUCT_STAT *sbuf);
1229 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1230 const struct smb_filename *smb_fname);
1231 int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
1232 const struct smb_filename *smb_fname,
1233 mode_t mode);
1234 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1235 struct files_struct *fsp, mode_t mode);
1236 int smb_vfs_call_chown(struct vfs_handle_struct *handle,
1237 const struct smb_filename *smb_fname,
1238 uid_t uid,
1239 gid_t gid);
1240 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1241 struct files_struct *fsp, uid_t uid, gid_t gid);
1242 int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
1243 const struct smb_filename *smb_fname,
1244 uid_t uid,
1245 gid_t gid);
1246 int smb_vfs_call_chdir(struct vfs_handle_struct *handle,
1247 const struct smb_filename *smb_fname);
1248 struct smb_filename *smb_vfs_call_getwd(struct vfs_handle_struct *handle,
1249 TALLOC_CTX *ctx);
1250 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1251 const struct smb_filename *smb_fname,
1252 struct smb_file_time *ft);
1253 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1254 struct files_struct *fsp, off_t offset);
1255 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1256 struct files_struct *fsp,
1257 uint32_t mode,
1258 off_t offset,
1259 off_t len);
1260 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1261 struct files_struct *fsp, int op, off_t offset,
1262 off_t count, int type);
1263 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1264 struct files_struct *fsp, uint32_t share_mode,
1265 uint32_t access_mask);
1266 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1267 struct files_struct *fsp, int leasetype);
1268 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1269 struct files_struct *fsp, off_t *poffset,
1270 off_t *pcount, int *ptype, pid_t *ppid);
1271 int smb_vfs_call_symlink(struct vfs_handle_struct *handle,
1272 const char *link_contents,
1273 const struct smb_filename *new_smb_fname);
1274 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1275 const struct smb_filename *smb_fname,
1276 char *buf,
1277 size_t bufsiz);
1278 int smb_vfs_call_link(struct vfs_handle_struct *handle,
1279 const struct smb_filename *old_smb_fname,
1280 const struct smb_filename *new_smb_fname);
1281 int smb_vfs_call_mknod(struct vfs_handle_struct *handle,
1282 const struct smb_filename *smb_fname,
1283 mode_t mode,
1284 SMB_DEV_T dev);
1285 struct smb_filename *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
1286 TALLOC_CTX *ctx,
1287 const struct smb_filename *smb_fname);
1288 int smb_vfs_call_chflags(struct vfs_handle_struct *handle,
1289 const struct smb_filename *smb_fname,
1290 unsigned int flags);
1291 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1292 const SMB_STRUCT_STAT *sbuf);
1293 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1294 struct files_struct *fsp,
1295 const struct smb_filename *smb_fname,
1296 TALLOC_CTX *mem_ctx,
1297 unsigned int *num_streams,
1298 struct stream_struct **streams);
1299 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1300 const char *path, const char *name,
1301 TALLOC_CTX *mem_ctx, char **found_name);
1302 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1303 const struct smb_filename *smb_fname);
1304 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1305 struct byte_range_lock *br_lck,
1306 struct lock_struct *plock,
1307 bool blocking_lock);
1308 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1309 struct messaging_context *msg_ctx,
1310 struct byte_range_lock *br_lck,
1311 const struct lock_struct *plock);
1312 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1313 struct byte_range_lock *br_lck,
1314 struct lock_struct *plock);
1315 bool smb_vfs_call_strict_lock_check(struct vfs_handle_struct *handle,
1316 struct files_struct *fsp,
1317 struct lock_struct *plock);
1318 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1319 const char *name,
1320 enum vfs_translate_direction direction,
1321 TALLOC_CTX *mem_ctx,
1322 char **mapped_name);
1323 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1324 struct files_struct *fsp,
1325 TALLOC_CTX *ctx,
1326 uint32_t function,
1327 uint16_t req_flags,
1328 const uint8_t *_in_data,
1329 uint32_t in_len,
1330 uint8_t **_out_data,
1331 uint32_t max_out_len,
1332 uint32_t *out_len);
1333 NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
1334 struct smb_filename *smb_fname,
1335 uint32_t *dosmode);
1336 NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
1337 struct files_struct *fsp,
1338 uint32_t *dosmode);
1339 NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
1340 const struct smb_filename *smb_fname,
1341 uint32_t dosmode);
1342 NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
1343 struct files_struct *fsp,
1344 uint32_t dosmode);
1345 struct tevent_req *smb_vfs_call_offload_read_send(
1346 TALLOC_CTX *mem_ctx,
1347 struct tevent_context *ev,
1348 struct vfs_handle_struct *handle,
1349 struct files_struct *fsp,
1350 uint32_t fsctl,
1351 uint32_t ttl,
1352 off_t offset,
1353 size_t to_copy);
1354 NTSTATUS smb_vfs_call_offload_read_recv(struct tevent_req *req,
1355 struct vfs_handle_struct *handle,
1356 TALLOC_CTX *mem_ctx,
1357 DATA_BLOB *token_blob);
1358 struct tevent_req *smb_vfs_call_offload_write_send(struct vfs_handle_struct *handle,
1359 TALLOC_CTX *mem_ctx,
1360 struct tevent_context *ev,
1361 uint32_t fsctl,
1362 DATA_BLOB *token,
1363 off_t transfer_offset,
1364 struct files_struct *dest_fsp,
1365 off_t dest_off,
1366 off_t num);
1367 NTSTATUS smb_vfs_call_offload_write_recv(struct vfs_handle_struct *handle,
1368 struct tevent_req *req,
1369 off_t *copied);
1370 NTSTATUS smb_vfs_call_get_compression(struct vfs_handle_struct *handle,
1371 TALLOC_CTX *mem_ctx,
1372 struct files_struct *fsp,
1373 struct smb_filename *smb_fname,
1374 uint16_t *_compression_fmt);
1375 NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
1376 TALLOC_CTX *mem_ctx,
1377 struct files_struct *fsp,
1378 uint16_t compression_fmt);
1379 NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
1380 TALLOC_CTX *mem_ctx,
1381 const char *service_path,
1382 char **base_volume);
1383 NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
1384 TALLOC_CTX *mem_ctx,
1385 const char *base_volume,
1386 time_t *tstamp,
1387 bool rw,
1388 char **base_path,
1389 char **snap_path);
1390 NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
1391 TALLOC_CTX *mem_ctx,
1392 char *base_path,
1393 char *snap_path);
1394 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1395 struct files_struct *fsp,
1396 uint32_t security_info,
1397 TALLOC_CTX *mem_ctx,
1398 struct security_descriptor **ppdesc);
1399 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1400 const struct smb_filename *smb_fname,
1401 uint32_t security_info,
1402 TALLOC_CTX *mem_ctx,
1403 struct security_descriptor **ppdesc);
1404 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1405 struct files_struct *fsp,
1406 uint32_t security_info_sent,
1407 const struct security_descriptor *psd);
1408 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1409 struct smb_filename *file,
1410 struct security_acl *sacl,
1411 uint32_t access_requested,
1412 uint32_t access_denied);
1413 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
1414 const struct smb_filename *file,
1415 mode_t mode);
1416 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1417 struct files_struct *fsp, mode_t mode);
1418 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1419 const struct smb_filename *smb_fname,
1420 SMB_ACL_TYPE_T type,
1421 TALLOC_CTX *mem_ctx);
1422 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1423 struct files_struct *fsp,
1424 TALLOC_CTX *mem_ctx);
1425 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1426 const struct smb_filename *smb_fname,
1427 TALLOC_CTX *mem_ctx,
1428 char **blob_description,
1429 DATA_BLOB *blob);
1430 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1431 struct files_struct *fsp,
1432 TALLOC_CTX *mem_ctx,
1433 char **blob_description,
1434 DATA_BLOB *blob);
1435 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1436 const struct smb_filename *smb_fname,
1437 SMB_ACL_TYPE_T acltype,
1438 SMB_ACL_T theacl);
1439 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1440 struct files_struct *fsp, SMB_ACL_T theacl);
1441 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1442 const struct smb_filename *smb_fname);
1443 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1444 const struct smb_filename *smb_fname,
1445 const char *name,
1446 void *value,
1447 size_t size);
1448 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1449 struct files_struct *fsp, const char *name,
1450 void *value, size_t size);
1451 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1452 const struct smb_filename *smb_fname,
1453 char *list,
1454 size_t size);
1455 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1456 struct files_struct *fsp, char *list,
1457 size_t size);
1458 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1459 const struct smb_filename *smb_fname,
1460 const char *name);
1461 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1462 struct files_struct *fsp, const char *name);
1463 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle,
1464 const struct smb_filename *smb_fname,
1465 const char *name,
1466 const void *value,
1467 size_t size,
1468 int flags);
1469 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1470 const char *name, const void *value, size_t size,
1471 int flags);
1472 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1473 struct files_struct *fsp, const char *name,
1474 const void *value, size_t size, int flags);
1475 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1476 struct files_struct *fsp);
1477 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1478 struct files_struct *fsp,
1479 TALLOC_CTX *mem_ctx,
1480 DATA_BLOB *cookie);
1481 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1482 struct files_struct *fsp,
1483 const DATA_BLOB old_cookie,
1484 TALLOC_CTX *mem_ctx,
1485 DATA_BLOB *new_cookie);
1486 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1487 struct smb_request *smb1req,
1488 struct smbXsrv_open *op,
1489 const DATA_BLOB old_cookie,
1490 TALLOC_CTX *mem_ctx,
1491 struct files_struct **fsp,
1492 DATA_BLOB *new_cookie);
1493 NTSTATUS smb_vfs_call_readdir_attr(struct vfs_handle_struct *handle,
1494 const struct smb_filename *fname,
1495 TALLOC_CTX *mem_ctx,
1496 struct readdir_attr_data **attr_data);
1498 NTSTATUS smb_register_vfs(int version, const char *name,
1499 const struct vfs_fn_pointers *fns);
1500 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1501 files_struct *fsp, size_t ext_size,
1502 void (*destroy_fn)(void *p_data));
1503 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1504 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1505 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1506 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1508 void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
1509 const char *module);
1511 #endif /* _VFS_H */