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