lib/param: add some more alias for 'allow dns updates' options.
[Samba/gebeck_regimport.git] / source3 / include / vfs.h
blob8e48803fe7d3985eeebc675563d6881e53303473
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 #define SMB_VFS_INTERFACE_VERSION 30
151 All intercepted VFS operations must be declared as static functions inside module source
152 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
153 example VFS modules for more details.
156 /* VFS operations structure */
158 struct vfs_handle_struct;
159 struct connection_struct;
160 struct files_struct;
161 struct security_descriptor;
162 struct vfs_statvfs_struct;
163 struct smb_request;
164 struct ea_list;
165 struct smb_file_time;
166 struct blocking_lock_record;
167 struct smb_filename;
168 struct dfs_GetDFSReferral;
170 typedef union unid_t {
171 uid_t uid;
172 gid_t gid;
173 } unid_t;
175 struct fd_handle {
176 size_t ref_count;
177 int fd;
178 uint64_t position_information;
179 off_t pos;
180 uint32 private_options; /* NT Create options, but we only look at
181 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
182 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
183 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
184 * for print files *only*, where
185 * DELETE_ON_CLOSE is not stored in the share
186 * mode database.
188 unsigned long gen_id;
191 typedef struct files_struct {
192 struct files_struct *next, *prev;
193 uint64_t fnum;
194 struct smbXsrv_open *op;
195 struct connection_struct *conn;
196 struct fd_handle *fh;
197 unsigned int num_smb_operations;
198 struct file_id file_id;
199 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
200 uint16 file_pid;
201 uint64_t vuid; /* SMB2 compat */
202 struct write_cache *wcp;
203 struct timeval open_time;
204 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
205 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
207 bool update_write_time_triggered;
208 struct timed_event *update_write_time_event;
209 bool update_write_time_on_close;
210 struct timespec close_write_time;
211 bool write_time_forced;
213 int oplock_type;
214 int sent_oplock_break;
215 struct timed_event *oplock_timeout;
216 struct lock_struct last_lock_failure;
217 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
219 struct share_mode_entry *pending_break_messages;
220 int num_pending_break_messages;
222 bool can_lock;
223 bool can_read;
224 bool can_write;
225 bool modified;
226 bool is_directory;
227 bool aio_write_behind;
228 bool lockdb_clean;
229 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
230 bool delete_on_close;
231 bool posix_open;
232 bool is_sparse;
233 bool backup_intent; /* Handle was successfully opened with backup intent
234 and opener has privilege to do so. */
235 struct smb_filename *fsp_name;
236 uint32_t name_hash; /* Jenkins hash of full pathname. */
237 uint64_t mid; /* Mid of the operation that created us. */
239 struct vfs_fsp_data *vfs_extension;
240 struct fake_file_handle *fake_file_handle;
242 struct notify_change_buf *notify;
244 struct files_struct *base_fsp; /* placeholder for delete on close */
247 * Read-only cached brlock record, thrown away when the
248 * brlock.tdb seqnum changes. This avoids fetching data from
249 * the brlock.tdb on every read/write call.
251 int brlock_seqnum;
252 struct byte_range_lock *brlock_rec;
254 struct dptr_struct *dptr;
256 /* if not NULL, means this is a print file */
257 struct print_file_data *print_file;
259 unsigned num_aio_requests;
260 struct tevent_req **aio_requests;
263 * If a close request comes in while we still have aio_requests
264 * around, we need to hold back the close. When all aio_requests are
265 * done, the aio completion routines need tevent_wait_done() on
266 * this. A bit ugly, but before we have close_file() fully async
267 * possibly the simplest approach. Thanks, Jeremy for the idea.
269 struct tevent_req *deferred_close;
270 } files_struct;
272 struct vuid_cache_entry {
273 struct auth_session_info *session_info;
274 uint64_t vuid; /* SMB2 compat */
275 bool read_only;
278 struct vuid_cache {
279 unsigned int next_entry;
280 struct vuid_cache_entry array[VUID_CACHE_SIZE];
283 typedef struct {
284 char *name;
285 bool is_wild;
286 } name_compare_entry;
288 struct dfree_cached_info {
289 time_t last_dfree_time;
290 uint64_t dfree_ret;
291 uint64_t bsize;
292 uint64_t dfree;
293 uint64_t dsize;
296 struct share_params {
297 int service;
300 typedef struct connection_struct {
301 struct connection_struct *next, *prev;
302 struct smbd_server_connection *sconn; /* can be NULL */
303 struct smbXsrv_tcon *tcon; /* can be NULL */
304 uint32_t cnum; /* an index passed over the wire */
305 struct share_params *params;
306 bool force_user;
307 struct vuid_cache vuid_cache;
308 bool printer;
309 bool ipc;
310 bool read_only; /* Attributes for the current user of the share. */
311 uint32_t share_access;
312 /* Does this filesystem honor
313 sub second timestamps on files
314 and directories when setting time ? */
315 enum timestamp_set_resolution ts_res;
316 char *connectpath;
317 char *origpath;
319 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
322 * This represents the user information on this connection. Depending
323 * on the vuid using this tid, this might change per SMB request.
325 struct auth_session_info *session_info;
328 * If the "force group" parameter is set, this is the primary gid that
329 * may be used in the users token, depending on the vuid using this tid.
331 gid_t force_group_gid;
333 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
335 time_t lastused;
336 time_t lastused_count;
337 int num_files_open;
338 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
339 int encrypt_level;
340 bool encrypted_tid;
342 /* Semantics requested by the client or forced by the server config. */
343 bool case_sensitive;
344 bool case_preserve;
345 bool short_case_preserve;
347 /* Semantics provided by the underlying filesystem. */
348 int fs_capabilities;
349 /* Device number of the directory of the share mount.
350 Used to ensure unique FileIndex returns. */
351 SMB_DEV_T base_share_dev;
353 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
354 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
355 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
356 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
357 struct dfree_cached_info *dfree_info;
358 struct trans_state *pending_trans;
360 struct rpc_pipe_client *spoolss_pipe;
362 } connection_struct;
364 struct smbd_smb2_request;
365 struct privilege_paths;
367 struct smb_request {
368 uint8_t cmd;
369 uint16 flags2;
370 uint16 smbpid;
371 uint64_t mid; /* For compatibility with SMB2. */
372 uint32_t seqnum;
373 uint64_t vuid; /* For compatibility with SMB2. */
374 uint32_t tid;
375 uint8 wct;
376 const uint16_t *vwv;
377 uint16_t buflen;
378 const uint8_t *buf;
379 const uint8 *inbuf;
382 * Async handling in the main smb processing loop is directed by
383 * outbuf: reply_xxx routines indicate sync behaviour by putting their
384 * reply into "outbuf". If they leave it as NULL, they take care of it
385 * themselves, possibly later.
387 * If async handling is wanted, the reply_xxx routine must make sure
388 * that it talloc_move()s the smb_req somewhere else.
390 uint8 *outbuf;
392 size_t unread_bytes;
393 bool encrypted;
394 connection_struct *conn;
395 struct smbd_server_connection *sconn;
396 struct smb_perfcount_data pcd;
399 * Chained request handling
401 struct files_struct *chain_fsp;
404 * state information for async smb handling
406 void *async_priv;
409 * Back pointer to smb2 request.
411 struct smbd_smb2_request *smb2req;
414 * Pathnames used if request done
415 * under privilege.
417 struct privilege_paths *priv_paths;
420 * Request list for chained requests, we're part of it.
422 struct smb_request **chain;
424 struct timeval request_time;
428 * Info about an alternate data stream
431 struct stream_struct {
432 off_t size;
433 off_t alloc_size;
434 char *name;
437 /* time info */
438 struct smb_file_time {
439 struct timespec mtime;
440 struct timespec atime;
441 struct timespec ctime;
442 struct timespec create_time;
446 * smb_filename
448 struct smb_filename {
449 char *base_name;
450 char *stream_name;
451 char *original_lcomp;
452 SMB_STRUCT_STAT st;
455 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
456 handle = handle->next; \
459 enum vfs_translate_direction {
460 vfs_translate_to_unix = 0,
461 vfs_translate_to_windows
464 enum vfs_fallocate_mode {
465 VFS_FALLOCATE_EXTEND_SIZE = 0,
466 VFS_FALLOCATE_KEEP_SIZE = 1
470 Available VFS operations. These values must be in sync with vfs_ops struct
471 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
472 In particular, if new operations are added to vfs_ops, appropriate constants
473 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
475 struct shadow_copy_data;
477 struct vfs_fn_pointers {
478 /* Disk operations */
480 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
481 void (*disconnect_fn)(struct vfs_handle_struct *handle);
482 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
483 uint64_t *dfree, uint64_t *dsize);
484 int (*get_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
485 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
486 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
487 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
488 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
491 * Note: that "struct dfs_GetDFSReferral *r"
492 * needs to be a valid TALLOC_CTX
494 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
495 struct dfs_GetDFSReferral *r);
497 /* Directory operations */
499 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
500 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
501 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
502 DIR *dirp,
503 SMB_STRUCT_STAT *sbuf);
504 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
505 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
506 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
507 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
508 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
509 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
510 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
512 /* File operations */
514 int (*open_fn)(struct vfs_handle_struct *handle,
515 struct smb_filename *smb_fname, files_struct *fsp,
516 int flags, mode_t mode);
517 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
518 struct smb_request *req,
519 uint16_t root_dir_fid,
520 struct smb_filename *smb_fname,
521 uint32_t access_mask,
522 uint32_t share_access,
523 uint32_t create_disposition,
524 uint32_t create_options,
525 uint32_t file_attributes,
526 uint32_t oplock_request,
527 uint64_t allocation_size,
528 uint32_t private_flags,
529 struct security_descriptor *sd,
530 struct ea_list *ea_list,
531 files_struct **result,
532 int *pinfo);
533 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
534 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
535 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
536 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
537 TALLOC_CTX *mem_ctx,
538 struct tevent_context *ev,
539 struct files_struct *fsp,
540 void *data,
541 size_t n, off_t offset);
542 ssize_t (*pread_recv_fn)(struct tevent_req *req, int *err);
543 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
544 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
545 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
546 TALLOC_CTX *mem_ctx,
547 struct tevent_context *ev,
548 struct files_struct *fsp,
549 const void *data,
550 size_t n, off_t offset);
551 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, int *err);
552 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
553 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
554 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
555 int (*rename_fn)(struct vfs_handle_struct *handle,
556 const struct smb_filename *smb_fname_src,
557 const struct smb_filename *smb_fname_dst);
558 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
559 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
560 TALLOC_CTX *mem_ctx,
561 struct tevent_context *ev,
562 struct files_struct *fsp);
563 int (*fsync_recv_fn)(struct tevent_req *req, int *err);
564 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
565 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
566 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
567 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
568 int (*unlink_fn)(struct vfs_handle_struct *handle,
569 const struct smb_filename *smb_fname);
570 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
571 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
572 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
573 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
574 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
575 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
576 char *(*getwd_fn)(struct vfs_handle_struct *handle);
577 int (*ntimes_fn)(struct vfs_handle_struct *handle,
578 const struct smb_filename *smb_fname,
579 struct smb_file_time *ft);
580 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
581 int (*fallocate_fn)(struct vfs_handle_struct *handle,
582 struct files_struct *fsp,
583 enum vfs_fallocate_mode mode,
584 off_t offset,
585 off_t len);
586 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
587 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
588 uint32 share_mode, uint32_t access_mask);
589 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
590 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
591 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
592 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
593 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
594 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
595 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
596 NTSTATUS (*notify_watch_fn)(struct vfs_handle_struct *handle,
597 struct sys_notify_context *ctx,
598 const char *path,
599 uint32_t *filter,
600 uint32_t *subdir_filter,
601 void (*callback)(struct sys_notify_context *ctx,
602 void *private_data,
603 struct notify_event *ev),
604 void *private_data,
605 void *handle_p);
606 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
607 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
608 const SMB_STRUCT_STAT *sbuf);
610 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
611 struct files_struct *fsp,
612 const char *fname,
613 TALLOC_CTX *mem_ctx,
614 unsigned int *num_streams,
615 struct stream_struct **streams);
617 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
618 const char *path,
619 const char *name,
620 TALLOC_CTX *mem_ctx,
621 char **found_name);
623 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
624 const char *filename);
626 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
627 struct byte_range_lock *br_lck,
628 struct lock_struct *plock,
629 bool blocking_lock,
630 struct blocking_lock_record *blr);
632 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
633 struct messaging_context *msg_ctx,
634 struct byte_range_lock *br_lck,
635 const struct lock_struct *plock);
637 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
638 struct byte_range_lock *br_lck,
639 struct lock_struct *plock,
640 struct blocking_lock_record *blr);
642 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
643 struct files_struct *fsp,
644 struct lock_struct *plock);
646 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
647 struct files_struct *fsp,
648 struct lock_struct *plock);
650 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
651 const char *name,
652 enum vfs_translate_direction direction,
653 TALLOC_CTX *mem_ctx,
654 char **mapped_name);
656 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
657 struct files_struct *fsp,
658 TALLOC_CTX *ctx,
659 uint32_t function,
660 uint16_t req_flags,
661 const uint8_t *_in_data,
662 uint32_t in_len,
663 uint8_t **_out_data,
664 uint32_t max_out_len,
665 uint32_t *out_len);
667 /* NT ACL operations. */
669 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
670 struct files_struct *fsp,
671 uint32 security_info,
672 struct security_descriptor **ppdesc);
673 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
674 const char *name,
675 uint32 security_info,
676 struct security_descriptor **ppdesc);
677 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
678 struct files_struct *fsp,
679 uint32 security_info_sent,
680 const struct security_descriptor *psd);
682 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
683 struct smb_filename *file,
684 struct security_acl *sacl,
685 uint32_t access_requested,
686 uint32_t access_denied);
688 /* POSIX ACL operations. */
690 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
691 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
693 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
694 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
695 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type,
696 TALLOC_CTX *mem_ctx, char **blob_description,
697 DATA_BLOB *blob);
698 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
699 TALLOC_CTX *mem_ctx, char **blob_description,
700 DATA_BLOB *blob);
701 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
702 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
703 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
705 /* EA operations. */
706 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
707 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
708 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
709 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
710 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
711 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
712 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
713 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
715 /* aio operations */
716 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
718 /* offline operations */
719 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
720 const struct smb_filename *fname,
721 SMB_STRUCT_STAT *sbuf);
722 int (*set_offline_fn)(struct vfs_handle_struct *handle,
723 const struct smb_filename *fname);
725 /* durable handle operations */
726 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
727 struct files_struct *fsp,
728 TALLOC_CTX *mem_ctx,
729 DATA_BLOB *cookie);
730 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
731 struct files_struct *fsp,
732 const DATA_BLOB old_cookie,
733 TALLOC_CTX *mem_ctx,
734 DATA_BLOB *new_cookie);
735 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
736 struct smb_request *smb1req,
737 struct smbXsrv_open *op,
738 const DATA_BLOB old_cookie,
739 TALLOC_CTX *mem_ctx,
740 struct files_struct **fsp,
741 DATA_BLOB *new_cookie);
745 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
746 which describes all operations this module is willing to intercept.
747 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
748 using this information.
751 typedef struct vfs_handle_struct {
752 struct vfs_handle_struct *next, *prev;
753 const char *param;
754 struct connection_struct *conn;
755 const struct vfs_fn_pointers *fns;
756 void *data;
757 void (*free_data)(void **data);
758 } vfs_handle_struct;
761 typedef struct vfs_statvfs_struct {
762 /* For undefined recommended transfer size return -1 in that field */
763 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
764 uint32 BlockSize;
767 The next three fields are in terms of the block size.
768 (above). If block size is unknown, 4096 would be a
769 reasonable block size for a server to report.
770 Note that returning the blocks/blocksavail removes need
771 to make a second call (to QFSInfo level 0x103 to get this info.
772 UserBlockAvail is typically less than or equal to BlocksAvail,
773 if no distinction is made return the same value in each.
776 uint64_t TotalBlocks;
777 uint64_t BlocksAvail; /* bfree */
778 uint64_t UserBlocksAvail; /* bavail */
780 /* For undefined Node fields or FSID return -1 */
781 uint64_t TotalFileNodes;
782 uint64_t FreeFileNodes;
783 uint64_t FsIdentifier; /* fsid */
784 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
785 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
787 int FsCapabilities;
788 } vfs_statvfs_struct;
790 /* Add a new FSP extension of the given type. Returns a pointer to the
791 * extenstion data.
793 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
794 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
796 /* Return a pointer to the existing FSP extension data. */
797 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
798 vfs_fetch_fsp_extension(handle, (fsp))
800 /* Return the talloc context associated with an FSP extension. */
801 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
802 vfs_memctx_fsp_extension(handle, (fsp))
804 /* Remove and destroy an FSP extension. */
805 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
806 vfs_remove_fsp_extension((handle), (fsp))
808 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
809 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
810 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
811 ret; \
815 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
816 if (!(handle)) { \
817 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
818 ret; \
819 } else { \
820 if ((handle)->free_data) { \
821 (handle)->free_data(&(handle)->data); \
823 (handle)->data = (void *)datap; \
824 (handle)->free_data = free_fn; \
828 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
829 if ((handle) && (handle)->free_data) { \
830 (handle)->free_data(&(handle)->data); \
834 /* Check whether module-specific data handle was already allocated or not */
835 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
837 #define SMB_VFS_OP(x) ((void *) x)
839 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
841 #include "vfs_macros.h"
843 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
844 const char *service, const char *user);
845 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
846 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
847 const char *path, bool small_query,
848 uint64_t *bsize, uint64_t *dfree,
849 uint64_t *dsize);
850 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
851 enum SMB_QUOTA_TYPE qtype, unid_t id,
852 SMB_DISK_QUOTA *qt);
853 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
854 enum SMB_QUOTA_TYPE qtype, unid_t id,
855 SMB_DISK_QUOTA *qt);
856 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
857 struct files_struct *fsp,
858 struct shadow_copy_data *shadow_copy_data,
859 bool labels);
860 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
861 struct vfs_statvfs_struct *statbuf);
862 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
863 enum timestamp_set_resolution *p_ts_res);
865 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
867 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
868 struct dfs_GetDFSReferral *r);
869 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
870 const char *fname, const char *mask,
871 uint32 attributes);
872 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
873 struct files_struct *fsp,
874 const char *mask,
875 uint32 attributes);
876 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
877 DIR *dirp,
878 SMB_STRUCT_STAT *sbuf);
879 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
880 DIR *dirp, long offset);
881 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
882 DIR *dirp);
883 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
884 DIR *dirp);
885 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
886 mode_t mode);
887 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
888 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
889 DIR *dir);
890 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
891 DIR *dirp);
892 int smb_vfs_call_open(struct vfs_handle_struct *handle,
893 struct smb_filename *smb_fname, struct files_struct *fsp,
894 int flags, mode_t mode);
895 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
896 struct smb_request *req,
897 uint16_t root_dir_fid,
898 struct smb_filename *smb_fname,
899 uint32_t access_mask,
900 uint32_t share_access,
901 uint32_t create_disposition,
902 uint32_t create_options,
903 uint32_t file_attributes,
904 uint32_t oplock_request,
905 uint64_t allocation_size,
906 uint32_t private_flags,
907 struct security_descriptor *sd,
908 struct ea_list *ea_list,
909 files_struct **result,
910 int *pinfo);
911 int smb_vfs_call_close(struct vfs_handle_struct *handle,
912 struct files_struct *fsp);
913 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
914 struct files_struct *fsp, void *data, size_t n);
915 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
916 struct files_struct *fsp, void *data, size_t n,
917 off_t offset);
918 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
919 TALLOC_CTX *mem_ctx,
920 struct tevent_context *ev,
921 struct files_struct *fsp,
922 void *data,
923 size_t n, off_t offset);
924 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, int *perrno);
926 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
927 struct files_struct *fsp, const void *data,
928 size_t n);
929 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
930 struct files_struct *fsp, const void *data,
931 size_t n, off_t offset);
932 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
933 TALLOC_CTX *mem_ctx,
934 struct tevent_context *ev,
935 struct files_struct *fsp,
936 const void *data,
937 size_t n, off_t offset);
938 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, int *perrno);
940 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
941 struct files_struct *fsp, off_t offset,
942 int whence);
943 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
944 files_struct *fromfsp, const DATA_BLOB *header,
945 off_t offset, size_t count);
946 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
947 files_struct *tofsp, off_t offset,
948 size_t count);
949 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
950 const struct smb_filename *smb_fname_src,
951 const struct smb_filename *smb_fname_dst);
952 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
953 struct files_struct *fsp);
955 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
956 TALLOC_CTX *mem_ctx,
957 struct tevent_context *ev,
958 struct files_struct *fsp);
959 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, int *perrno);
961 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
962 struct smb_filename *smb_fname);
963 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
964 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
965 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
966 struct smb_filename *smb_filename);
967 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
968 struct files_struct *fsp,
969 const SMB_STRUCT_STAT *sbuf);
970 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
971 const struct smb_filename *smb_fname);
972 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
973 mode_t mode);
974 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
975 struct files_struct *fsp, mode_t mode);
976 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
977 uid_t uid, gid_t gid);
978 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
979 struct files_struct *fsp, uid_t uid, gid_t gid);
980 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
981 uid_t uid, gid_t gid);
982 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
983 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
984 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
985 const struct smb_filename *smb_fname,
986 struct smb_file_time *ft);
987 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
988 struct files_struct *fsp, off_t offset);
989 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
990 struct files_struct *fsp,
991 enum vfs_fallocate_mode mode,
992 off_t offset,
993 off_t len);
994 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
995 struct files_struct *fsp, int op, off_t offset,
996 off_t count, int type);
997 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
998 struct files_struct *fsp, uint32 share_mode,
999 uint32_t access_mask);
1000 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1001 struct files_struct *fsp, int leasetype);
1002 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1003 struct files_struct *fsp, off_t *poffset,
1004 off_t *pcount, int *ptype, pid_t *ppid);
1005 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1006 const char *newpath);
1007 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1008 const char *path, char *buf, size_t bufsiz);
1009 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1010 const char *newpath);
1011 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1012 mode_t mode, SMB_DEV_T dev);
1013 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1014 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
1015 struct sys_notify_context *ctx,
1016 const char *name,
1017 uint32_t *filter,
1018 uint32_t *subdir_filter,
1019 void (*callback)(struct sys_notify_context *ctx,
1020 void *private_data,
1021 struct notify_event *ev),
1022 void *private_data, void *handle_p);
1023 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1024 unsigned int flags);
1025 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1026 const SMB_STRUCT_STAT *sbuf);
1027 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1028 struct files_struct *fsp,
1029 const char *fname,
1030 TALLOC_CTX *mem_ctx,
1031 unsigned int *num_streams,
1032 struct stream_struct **streams);
1033 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1034 const char *path, const char *name,
1035 TALLOC_CTX *mem_ctx, char **found_name);
1036 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1037 const char *filename);
1038 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1039 struct byte_range_lock *br_lck,
1040 struct lock_struct *plock,
1041 bool blocking_lock,
1042 struct blocking_lock_record *blr);
1043 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1044 struct messaging_context *msg_ctx,
1045 struct byte_range_lock *br_lck,
1046 const struct lock_struct *plock);
1047 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1048 struct byte_range_lock *br_lck,
1049 struct lock_struct *plock,
1050 struct blocking_lock_record *blr);
1051 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1052 struct files_struct *fsp,
1053 struct lock_struct *plock);
1054 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1055 struct files_struct *fsp,
1056 struct lock_struct *plock);
1057 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1058 const char *name,
1059 enum vfs_translate_direction direction,
1060 TALLOC_CTX *mem_ctx,
1061 char **mapped_name);
1062 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1063 struct files_struct *fsp,
1064 TALLOC_CTX *ctx,
1065 uint32_t function,
1066 uint16_t req_flags,
1067 const uint8_t *_in_data,
1068 uint32_t in_len,
1069 uint8_t **_out_data,
1070 uint32_t max_out_len,
1071 uint32_t *out_len);
1072 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1073 struct files_struct *fsp,
1074 uint32 security_info,
1075 struct security_descriptor **ppdesc);
1076 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1077 const char *name,
1078 uint32 security_info,
1079 struct security_descriptor **ppdesc);
1080 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1081 struct files_struct *fsp,
1082 uint32 security_info_sent,
1083 const struct security_descriptor *psd);
1084 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1085 struct smb_filename *file,
1086 struct security_acl *sacl,
1087 uint32_t access_requested,
1088 uint32_t access_denied);
1089 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
1090 mode_t mode);
1091 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1092 struct files_struct *fsp, mode_t mode);
1093 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1094 const char *path_p,
1095 SMB_ACL_TYPE_T type);
1096 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1097 struct files_struct *fsp);
1098 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1099 const char *path_p,
1100 SMB_ACL_TYPE_T type,
1101 TALLOC_CTX *mem_ctx,
1102 char **blob_description,
1103 DATA_BLOB *blob);
1104 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1105 struct files_struct *fsp,
1106 TALLOC_CTX *mem_ctx,
1107 char **blob_description,
1108 DATA_BLOB *blob);
1109 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1110 const char *name, SMB_ACL_TYPE_T acltype,
1111 SMB_ACL_T theacl);
1112 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1113 struct files_struct *fsp, SMB_ACL_T theacl);
1114 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1115 const char *path);
1116 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1117 const char *path, const char *name, void *value,
1118 size_t size);
1119 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1120 struct files_struct *fsp, const char *name,
1121 void *value, size_t size);
1122 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1123 const char *path, char *list, size_t size);
1124 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1125 const char *path, char *list, size_t size);
1126 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1127 struct files_struct *fsp, char *list,
1128 size_t size);
1129 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1130 const char *path, const char *name);
1131 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1132 struct files_struct *fsp, const char *name);
1133 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1134 const char *name, const void *value, size_t size,
1135 int flags);
1136 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1137 const char *name, const void *value, size_t size,
1138 int flags);
1139 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1140 struct files_struct *fsp, const char *name,
1141 const void *value, size_t size, int flags);
1142 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1143 struct files_struct *fsp);
1144 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1145 const struct smb_filename *fname,
1146 SMB_STRUCT_STAT *sbuf);
1147 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1148 const struct smb_filename *fname);
1149 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1150 struct files_struct *fsp,
1151 TALLOC_CTX *mem_ctx,
1152 DATA_BLOB *cookie);
1153 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1154 struct files_struct *fsp,
1155 const DATA_BLOB old_cookie,
1156 TALLOC_CTX *mem_ctx,
1157 DATA_BLOB *new_cookie);
1158 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1159 struct smb_request *smb1req,
1160 struct smbXsrv_open *op,
1161 const DATA_BLOB old_cookie,
1162 TALLOC_CTX *mem_ctx,
1163 struct files_struct **fsp,
1164 DATA_BLOB *new_cookie);
1166 NTSTATUS smb_register_vfs(int version, const char *name,
1167 const struct vfs_fn_pointers *fns);
1168 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1169 files_struct *fsp, size_t ext_size,
1170 void (*destroy_fn)(void *p_data));
1171 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1172 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1173 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1174 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1176 #endif /* _VFS_H */