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