s3:smbd: s/struct timed_event/struct tevent_timer
[Samba/gebeck_regimport.git] / source3 / include / vfs.h
blob6d9be77bfd978d467a5df2ebb2a571dd21b6e04e
1 /*
2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
26 #ifndef _VFS_H
27 #define _VFS_H
29 /* Avoid conflict with an AIX include file */
31 #ifdef vfs_ops
32 #undef vfs_ops
33 #endif
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
43 * vfs_ops below. JRA.
45 * If you change anything here, please also update modules/vfs_full_audit.c.
46 * VL.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
111 open handle. JRA. */
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 /* Changed to version 28 - Add private_flags uint32_t to CREATE call. */
129 /* Leave at 28 - not yet released. Change realpath to assume NULL and return a
130 malloc'ed path. JRA. */
131 /* Leave at 28 - not yet released. Move posix_fallocate into the VFS
132 where it belongs. JRA. */
133 /* Leave at 28 - not yet released. Rename posix_fallocate to fallocate
134 to split out the two possible uses. JRA. */
135 /* Leave at 28 - not yet released. Add fdopendir. JRA. */
136 /* Leave at 28 - not yet released. Rename open function to open_fn. - gd */
137 /* Leave at 28 - not yet released. Make getwd function always return malloced memory. JRA. */
138 /* Bump to version 29 - Samba 3.6.0 will ship with interface version 28. */
139 /* Leave at 29 - not yet releases. Add fsctl. Richard Sharpe */
140 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
141 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
142 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
143 /* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
144 /* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
145 /* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
146 /* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
147 /* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
148 /* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
149 /* Leave at 30 - not yet released. Changed sys_acl_blob_get_file interface to remove type */
150 /* Bump to version 31 - Samba 4.1.0 will ship with interface version 31 */
151 /* Leave at 31 - not yet released. Make struct vuid_cache_entry in
152 connection_struct a pointer. */
153 /* Leave at 31 - not yet released. Add share_access to vuid_cache_entry. */
154 /* Leave at 31 - not yet released. add SMB_VFS_COPY_CHUNK() */
156 #define SMB_VFS_INTERFACE_VERSION 31
159 All intercepted VFS operations must be declared as static functions inside module source
160 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
161 example VFS modules for more details.
164 /* VFS operations structure */
166 struct vfs_handle_struct;
167 struct connection_struct;
168 struct files_struct;
169 struct security_descriptor;
170 struct vfs_statvfs_struct;
171 struct smb_request;
172 struct ea_list;
173 struct smb_file_time;
174 struct blocking_lock_record;
175 struct smb_filename;
176 struct dfs_GetDFSReferral;
178 typedef union unid_t {
179 uid_t uid;
180 gid_t gid;
181 } unid_t;
183 struct fd_handle {
184 size_t ref_count;
185 int fd;
186 uint64_t position_information;
187 off_t pos;
188 uint32 private_options; /* NT Create options, but we only look at
189 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
190 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
191 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
192 * for print files *only*, where
193 * DELETE_ON_CLOSE is not stored in the share
194 * mode database.
196 unsigned long gen_id;
199 typedef struct files_struct {
200 struct files_struct *next, *prev;
201 uint64_t fnum;
202 struct smbXsrv_open *op;
203 struct connection_struct *conn;
204 struct fd_handle *fh;
205 unsigned int num_smb_operations;
206 struct file_id file_id;
207 uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
208 uint16 file_pid;
209 uint64_t vuid; /* SMB2 compat */
210 struct write_cache *wcp;
211 struct timeval open_time;
212 uint32 access_mask; /* NTCreateX access bits (FILE_READ_DATA etc.) */
213 uint32 share_access; /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
215 bool update_write_time_triggered;
216 struct tevent_timer *update_write_time_event;
217 bool update_write_time_on_close;
218 struct timespec close_write_time;
219 bool write_time_forced;
221 int oplock_type;
222 int sent_oplock_break;
223 struct tevent_timer *oplock_timeout;
224 struct lock_struct last_lock_failure;
225 int current_lock_count; /* Count the number of outstanding locks and pending locks. */
227 struct share_mode_entry *pending_break_messages;
228 int num_pending_break_messages;
230 bool can_lock;
231 bool can_read;
232 bool can_write;
233 bool modified;
234 bool is_directory;
235 bool aio_write_behind;
236 bool lockdb_clean;
237 bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
238 bool delete_on_close;
239 bool posix_open;
240 bool is_sparse;
241 bool backup_intent; /* Handle was successfully opened with backup intent
242 and opener has privilege to do so. */
243 struct smb_filename *fsp_name;
244 uint32_t name_hash; /* Jenkins hash of full pathname. */
245 uint64_t mid; /* Mid of the operation that created us. */
247 struct vfs_fsp_data *vfs_extension;
248 struct fake_file_handle *fake_file_handle;
250 struct notify_change_buf *notify;
252 struct files_struct *base_fsp; /* placeholder for delete on close */
255 * Read-only cached brlock record, thrown away when the
256 * brlock.tdb seqnum changes. This avoids fetching data from
257 * the brlock.tdb on every read/write call.
259 int brlock_seqnum;
260 struct byte_range_lock *brlock_rec;
262 struct dptr_struct *dptr;
264 /* if not NULL, means this is a print file */
265 struct print_file_data *print_file;
267 unsigned num_aio_requests;
268 struct tevent_req **aio_requests;
271 * If a close request comes in while we still have aio_requests
272 * around, we need to hold back the close. When all aio_requests are
273 * done, the aio completion routines need tevent_wait_done() on
274 * this. A bit ugly, but before we have close_file() fully async
275 * possibly the simplest approach. Thanks, Jeremy for the idea.
277 struct tevent_req *deferred_close;
278 } files_struct;
280 struct vuid_cache_entry {
281 struct auth_session_info *session_info;
282 uint64_t vuid; /* SMB2 compat */
283 bool read_only;
284 uint32_t share_access;
287 struct vuid_cache {
288 unsigned int next_entry;
289 struct vuid_cache_entry array[VUID_CACHE_SIZE];
292 typedef struct {
293 char *name;
294 bool is_wild;
295 } name_compare_entry;
297 struct dfree_cached_info {
298 time_t last_dfree_time;
299 uint64_t dfree_ret;
300 uint64_t bsize;
301 uint64_t dfree;
302 uint64_t dsize;
305 struct share_params {
306 int service;
309 typedef struct connection_struct {
310 struct connection_struct *next, *prev;
311 struct smbd_server_connection *sconn; /* can be NULL */
312 struct smbXsrv_tcon *tcon; /* can be NULL */
313 uint32_t cnum; /* an index passed over the wire */
314 struct share_params *params;
315 bool force_user;
316 struct vuid_cache *vuid_cache;
317 bool printer;
318 bool ipc;
319 bool read_only; /* Attributes for the current user of the share. */
320 uint32_t share_access;
321 /* Does this filesystem honor
322 sub second timestamps on files
323 and directories when setting time ? */
324 enum timestamp_set_resolution ts_res;
325 char *connectpath;
326 char *origpath;
327 char *cwd; /* Working directory. */
329 struct vfs_handle_struct *vfs_handles; /* for the new plugins */
332 * This represents the user information on this connection. Depending
333 * on the vuid using this tid, this might change per SMB request.
335 struct auth_session_info *session_info;
338 * If the "force group" parameter is set, this is the primary gid that
339 * may be used in the users token, depending on the vuid using this tid.
341 gid_t force_group_gid;
343 uint64_t vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
345 time_t lastused;
346 time_t lastused_count;
347 int num_files_open;
348 unsigned int num_smb_operations; /* Count of smb operations on this tree. */
349 int encrypt_level;
350 bool encrypted_tid;
352 /* Semantics requested by the client or forced by the server config. */
353 bool case_sensitive;
354 bool case_preserve;
355 bool short_case_preserve;
357 /* Semantics provided by the underlying filesystem. */
358 int fs_capabilities;
359 /* Device number of the directory of the share mount.
360 Used to ensure unique FileIndex returns. */
361 SMB_DEV_T base_share_dev;
363 name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
364 name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
365 name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
366 name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
367 struct dfree_cached_info *dfree_info;
368 struct trans_state *pending_trans;
370 struct rpc_pipe_client *spoolss_pipe;
372 } connection_struct;
374 struct smbd_smb2_request;
375 struct privilege_paths;
377 struct smb_request {
378 uint8_t cmd;
379 uint16 flags2;
380 uint16 smbpid;
381 uint64_t mid; /* For compatibility with SMB2. */
382 uint32_t seqnum;
383 uint64_t vuid; /* For compatibility with SMB2. */
384 uint32_t tid;
385 uint8 wct;
386 const uint16_t *vwv;
387 uint16_t buflen;
388 const uint8_t *buf;
389 const uint8 *inbuf;
392 * Async handling in the main smb processing loop is directed by
393 * outbuf: reply_xxx routines indicate sync behaviour by putting their
394 * reply into "outbuf". If they leave it as NULL, they take care of it
395 * themselves, possibly later.
397 * If async handling is wanted, the reply_xxx routine must make sure
398 * that it talloc_move()s the smb_req somewhere else.
400 uint8 *outbuf;
402 size_t unread_bytes;
403 bool encrypted;
404 connection_struct *conn;
405 struct smbd_server_connection *sconn;
406 struct smb_perfcount_data pcd;
409 * Chained request handling
411 struct files_struct *chain_fsp;
414 * state information for async smb handling
416 void *async_priv;
419 * Back pointer to smb2 request.
421 struct smbd_smb2_request *smb2req;
424 * Pathnames used if request done
425 * under privilege.
427 struct privilege_paths *priv_paths;
430 * Request list for chained requests, we're part of it.
432 struct smb_request **chain;
434 struct timeval request_time;
438 * Info about an alternate data stream
441 struct stream_struct {
442 off_t size;
443 off_t alloc_size;
444 char *name;
447 /* time info */
448 struct smb_file_time {
449 struct timespec mtime;
450 struct timespec atime;
451 struct timespec ctime;
452 struct timespec create_time;
456 * smb_filename
458 struct smb_filename {
459 char *base_name;
460 char *stream_name;
461 char *original_lcomp;
462 SMB_STRUCT_STAT st;
465 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
466 handle = handle->next; \
469 enum vfs_translate_direction {
470 vfs_translate_to_unix = 0,
471 vfs_translate_to_windows
474 enum vfs_fallocate_mode {
475 VFS_FALLOCATE_EXTEND_SIZE = 0,
476 VFS_FALLOCATE_KEEP_SIZE = 1
480 Available VFS operations. These values must be in sync with vfs_ops struct
481 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
482 In particular, if new operations are added to vfs_ops, appropriate constants
483 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
485 struct shadow_copy_data;
487 struct vfs_fn_pointers {
488 /* Disk operations */
490 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
491 void (*disconnect_fn)(struct vfs_handle_struct *handle);
492 uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
493 uint64_t *dfree, uint64_t *dsize);
494 int (*get_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
495 int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
496 int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
497 int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
498 uint32_t (*fs_capabilities_fn)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
501 * Note: that "struct dfs_GetDFSReferral *r"
502 * needs to be a valid TALLOC_CTX
504 NTSTATUS (*get_dfs_referrals_fn)(struct vfs_handle_struct *handle,
505 struct dfs_GetDFSReferral *r);
507 /* Directory operations */
509 DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
510 DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
511 struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
512 DIR *dirp,
513 SMB_STRUCT_STAT *sbuf);
514 void (*seekdir_fn)(struct vfs_handle_struct *handle, DIR *dirp, long offset);
515 long (*telldir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
516 void (*rewind_dir_fn)(struct vfs_handle_struct *handle, DIR *dirp);
517 int (*mkdir_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
518 int (*rmdir_fn)(struct vfs_handle_struct *handle, const char *path);
519 int (*closedir_fn)(struct vfs_handle_struct *handle, DIR *dir);
520 void (*init_search_op_fn)(struct vfs_handle_struct *handle, DIR *dirp);
522 /* File operations */
524 int (*open_fn)(struct vfs_handle_struct *handle,
525 struct smb_filename *smb_fname, files_struct *fsp,
526 int flags, mode_t mode);
527 NTSTATUS (*create_file_fn)(struct vfs_handle_struct *handle,
528 struct smb_request *req,
529 uint16_t root_dir_fid,
530 struct smb_filename *smb_fname,
531 uint32_t access_mask,
532 uint32_t share_access,
533 uint32_t create_disposition,
534 uint32_t create_options,
535 uint32_t file_attributes,
536 uint32_t oplock_request,
537 uint64_t allocation_size,
538 uint32_t private_flags,
539 struct security_descriptor *sd,
540 struct ea_list *ea_list,
541 files_struct **result,
542 int *pinfo);
543 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
544 ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
545 ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
546 struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
547 TALLOC_CTX *mem_ctx,
548 struct tevent_context *ev,
549 struct files_struct *fsp,
550 void *data,
551 size_t n, off_t offset);
552 ssize_t (*pread_recv_fn)(struct tevent_req *req, int *err);
553 ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
554 ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
555 struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
556 TALLOC_CTX *mem_ctx,
557 struct tevent_context *ev,
558 struct files_struct *fsp,
559 const void *data,
560 size_t n, off_t offset);
561 ssize_t (*pwrite_recv_fn)(struct tevent_req *req, int *err);
562 off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
563 ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
564 ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
565 int (*rename_fn)(struct vfs_handle_struct *handle,
566 const struct smb_filename *smb_fname_src,
567 const struct smb_filename *smb_fname_dst);
568 int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
569 struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
570 TALLOC_CTX *mem_ctx,
571 struct tevent_context *ev,
572 struct files_struct *fsp);
573 int (*fsync_recv_fn)(struct tevent_req *req, int *err);
574 int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
575 int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
576 int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
577 uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
578 int (*unlink_fn)(struct vfs_handle_struct *handle,
579 const struct smb_filename *smb_fname);
580 int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
581 int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
582 int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
583 int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
584 int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
585 int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
586 char *(*getwd_fn)(struct vfs_handle_struct *handle);
587 int (*ntimes_fn)(struct vfs_handle_struct *handle,
588 const struct smb_filename *smb_fname,
589 struct smb_file_time *ft);
590 int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
591 int (*fallocate_fn)(struct vfs_handle_struct *handle,
592 struct files_struct *fsp,
593 enum vfs_fallocate_mode mode,
594 off_t offset,
595 off_t len);
596 bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
597 int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
598 uint32 share_mode, uint32_t access_mask);
599 int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
600 bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
601 int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
602 int (*readlink_fn)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
603 int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
604 int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
605 char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
606 NTSTATUS (*notify_watch_fn)(struct vfs_handle_struct *handle,
607 struct sys_notify_context *ctx,
608 const char *path,
609 uint32_t *filter,
610 uint32_t *subdir_filter,
611 void (*callback)(struct sys_notify_context *ctx,
612 void *private_data,
613 struct notify_event *ev),
614 void *private_data,
615 void *handle_p);
616 int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
617 struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
618 const SMB_STRUCT_STAT *sbuf);
619 struct tevent_req *(*copy_chunk_send_fn)(struct vfs_handle_struct *handle,
620 TALLOC_CTX *mem_ctx,
621 struct tevent_context *ev,
622 struct files_struct *src_fsp,
623 off_t src_off,
624 struct files_struct *dest_fsp,
625 off_t dest_off,
626 off_t num);
627 NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
628 struct tevent_req *req,
629 off_t *copied);
631 NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
632 struct files_struct *fsp,
633 const char *fname,
634 TALLOC_CTX *mem_ctx,
635 unsigned int *num_streams,
636 struct stream_struct **streams);
638 int (*get_real_filename_fn)(struct vfs_handle_struct *handle,
639 const char *path,
640 const char *name,
641 TALLOC_CTX *mem_ctx,
642 char **found_name);
644 const char *(*connectpath_fn)(struct vfs_handle_struct *handle,
645 const char *filename);
647 NTSTATUS (*brl_lock_windows_fn)(struct vfs_handle_struct *handle,
648 struct byte_range_lock *br_lck,
649 struct lock_struct *plock,
650 bool blocking_lock,
651 struct blocking_lock_record *blr);
653 bool (*brl_unlock_windows_fn)(struct vfs_handle_struct *handle,
654 struct messaging_context *msg_ctx,
655 struct byte_range_lock *br_lck,
656 const struct lock_struct *plock);
658 bool (*brl_cancel_windows_fn)(struct vfs_handle_struct *handle,
659 struct byte_range_lock *br_lck,
660 struct lock_struct *plock,
661 struct blocking_lock_record *blr);
663 bool (*strict_lock_fn)(struct vfs_handle_struct *handle,
664 struct files_struct *fsp,
665 struct lock_struct *plock);
667 void (*strict_unlock_fn)(struct vfs_handle_struct *handle,
668 struct files_struct *fsp,
669 struct lock_struct *plock);
671 NTSTATUS (*translate_name_fn)(struct vfs_handle_struct *handle,
672 const char *name,
673 enum vfs_translate_direction direction,
674 TALLOC_CTX *mem_ctx,
675 char **mapped_name);
677 NTSTATUS (*fsctl_fn)(struct vfs_handle_struct *handle,
678 struct files_struct *fsp,
679 TALLOC_CTX *ctx,
680 uint32_t function,
681 uint16_t req_flags,
682 const uint8_t *_in_data,
683 uint32_t in_len,
684 uint8_t **_out_data,
685 uint32_t max_out_len,
686 uint32_t *out_len);
688 /* NT ACL operations. */
690 NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
691 struct files_struct *fsp,
692 uint32 security_info,
693 TALLOC_CTX *mem_ctx,
694 struct security_descriptor **ppdesc);
695 NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
696 const char *name,
697 uint32 security_info,
698 TALLOC_CTX *mem_ctx,
699 struct security_descriptor **ppdesc);
700 NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
701 struct files_struct *fsp,
702 uint32 security_info_sent,
703 const struct security_descriptor *psd);
705 NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
706 struct smb_filename *file,
707 struct security_acl *sacl,
708 uint32_t access_requested,
709 uint32_t access_denied);
711 /* POSIX ACL operations. */
713 int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
714 int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
716 SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
717 const char *path_p,
718 SMB_ACL_TYPE_T type,
719 TALLOC_CTX *mem_ctx);
720 SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
721 struct files_struct *fsp,
722 TALLOC_CTX *mem_ctx);
723 int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
724 const char *path_p,
725 TALLOC_CTX *mem_ctx,
726 char **blob_description,
727 DATA_BLOB *blob);
728 int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
729 TALLOC_CTX *mem_ctx, char **blob_description,
730 DATA_BLOB *blob);
731 int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
732 int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
733 int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
735 /* EA operations. */
736 ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
737 ssize_t (*fgetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
738 ssize_t (*listxattr_fn)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
739 ssize_t (*flistxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
740 int (*removexattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name);
741 int (*fremovexattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
742 int (*setxattr_fn)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
743 int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
745 /* aio operations */
746 bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
748 /* offline operations */
749 bool (*is_offline_fn)(struct vfs_handle_struct *handle,
750 const struct smb_filename *fname,
751 SMB_STRUCT_STAT *sbuf);
752 int (*set_offline_fn)(struct vfs_handle_struct *handle,
753 const struct smb_filename *fname);
755 /* durable handle operations */
756 NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
757 struct files_struct *fsp,
758 TALLOC_CTX *mem_ctx,
759 DATA_BLOB *cookie);
760 NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
761 struct files_struct *fsp,
762 const DATA_BLOB old_cookie,
763 TALLOC_CTX *mem_ctx,
764 DATA_BLOB *new_cookie);
765 NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
766 struct smb_request *smb1req,
767 struct smbXsrv_open *op,
768 const DATA_BLOB old_cookie,
769 TALLOC_CTX *mem_ctx,
770 struct files_struct **fsp,
771 DATA_BLOB *new_cookie);
775 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
776 which describes all operations this module is willing to intercept.
777 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
778 using this information.
781 typedef struct vfs_handle_struct {
782 struct vfs_handle_struct *next, *prev;
783 const char *param;
784 struct connection_struct *conn;
785 const struct vfs_fn_pointers *fns;
786 void *data;
787 void (*free_data)(void **data);
788 } vfs_handle_struct;
791 typedef struct vfs_statvfs_struct {
792 /* For undefined recommended transfer size return -1 in that field */
793 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
794 uint32 BlockSize;
797 The next three fields are in terms of the block size.
798 (above). If block size is unknown, 4096 would be a
799 reasonable block size for a server to report.
800 Note that returning the blocks/blocksavail removes need
801 to make a second call (to QFSInfo level 0x103 to get this info.
802 UserBlockAvail is typically less than or equal to BlocksAvail,
803 if no distinction is made return the same value in each.
806 uint64_t TotalBlocks;
807 uint64_t BlocksAvail; /* bfree */
808 uint64_t UserBlocksAvail; /* bavail */
810 /* For undefined Node fields or FSID return -1 */
811 uint64_t TotalFileNodes;
812 uint64_t FreeFileNodes;
813 uint64_t FsIdentifier; /* fsid */
814 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
815 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
817 int FsCapabilities;
818 } vfs_statvfs_struct;
820 /* Add a new FSP extension of the given type. Returns a pointer to the
821 * extenstion data.
823 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
824 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
826 /* Return a pointer to the existing FSP extension data. */
827 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
828 vfs_fetch_fsp_extension(handle, (fsp))
830 /* Return the talloc context associated with an FSP extension. */
831 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
832 vfs_memctx_fsp_extension(handle, (fsp))
834 /* Remove and destroy an FSP extension. */
835 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
836 vfs_remove_fsp_extension((handle), (fsp))
838 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
839 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
840 DEBUG(0,("%s() failed to get vfs_handle->data!\n",__FUNCTION__)); \
841 ret; \
845 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
846 if (!(handle)) { \
847 DEBUG(0,("%s() failed to set handle->data!\n",__FUNCTION__)); \
848 ret; \
849 } else { \
850 if ((handle)->free_data) { \
851 (handle)->free_data(&(handle)->data); \
853 (handle)->data = (void *)datap; \
854 (handle)->free_data = free_fn; \
858 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
859 if ((handle) && (handle)->free_data) { \
860 (handle)->free_data(&(handle)->data); \
864 /* Check whether module-specific data handle was already allocated or not */
865 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
867 #define SMB_VFS_OP(x) ((void *) x)
869 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
871 #include "vfs_macros.h"
873 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
874 const char *service, const char *user);
875 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
876 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
877 const char *path, bool small_query,
878 uint64_t *bsize, uint64_t *dfree,
879 uint64_t *dsize);
880 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
881 enum SMB_QUOTA_TYPE qtype, unid_t id,
882 SMB_DISK_QUOTA *qt);
883 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
884 enum SMB_QUOTA_TYPE qtype, unid_t id,
885 SMB_DISK_QUOTA *qt);
886 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
887 struct files_struct *fsp,
888 struct shadow_copy_data *shadow_copy_data,
889 bool labels);
890 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
891 struct vfs_statvfs_struct *statbuf);
892 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
893 enum timestamp_set_resolution *p_ts_res);
895 * Note: that "struct dfs_GetDFSReferral *r" needs to be a valid TALLOC_CTX
897 NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
898 struct dfs_GetDFSReferral *r);
899 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
900 const char *fname, const char *mask,
901 uint32 attributes);
902 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
903 struct files_struct *fsp,
904 const char *mask,
905 uint32 attributes);
906 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
907 DIR *dirp,
908 SMB_STRUCT_STAT *sbuf);
909 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
910 DIR *dirp, long offset);
911 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
912 DIR *dirp);
913 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
914 DIR *dirp);
915 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
916 mode_t mode);
917 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
918 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
919 DIR *dir);
920 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
921 DIR *dirp);
922 int smb_vfs_call_open(struct vfs_handle_struct *handle,
923 struct smb_filename *smb_fname, struct files_struct *fsp,
924 int flags, mode_t mode);
925 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
926 struct smb_request *req,
927 uint16_t root_dir_fid,
928 struct smb_filename *smb_fname,
929 uint32_t access_mask,
930 uint32_t share_access,
931 uint32_t create_disposition,
932 uint32_t create_options,
933 uint32_t file_attributes,
934 uint32_t oplock_request,
935 uint64_t allocation_size,
936 uint32_t private_flags,
937 struct security_descriptor *sd,
938 struct ea_list *ea_list,
939 files_struct **result,
940 int *pinfo);
941 int smb_vfs_call_close(struct vfs_handle_struct *handle,
942 struct files_struct *fsp);
943 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
944 struct files_struct *fsp, void *data, size_t n);
945 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
946 struct files_struct *fsp, void *data, size_t n,
947 off_t offset);
948 struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
949 TALLOC_CTX *mem_ctx,
950 struct tevent_context *ev,
951 struct files_struct *fsp,
952 void *data,
953 size_t n, off_t offset);
954 ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, int *perrno);
956 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
957 struct files_struct *fsp, const void *data,
958 size_t n);
959 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
960 struct files_struct *fsp, const void *data,
961 size_t n, off_t offset);
962 struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
963 TALLOC_CTX *mem_ctx,
964 struct tevent_context *ev,
965 struct files_struct *fsp,
966 const void *data,
967 size_t n, off_t offset);
968 ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, int *perrno);
970 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
971 struct files_struct *fsp, off_t offset,
972 int whence);
973 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
974 files_struct *fromfsp, const DATA_BLOB *header,
975 off_t offset, size_t count);
976 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
977 files_struct *tofsp, off_t offset,
978 size_t count);
979 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
980 const struct smb_filename *smb_fname_src,
981 const struct smb_filename *smb_fname_dst);
982 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
983 struct files_struct *fsp);
985 struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
986 TALLOC_CTX *mem_ctx,
987 struct tevent_context *ev,
988 struct files_struct *fsp);
989 int SMB_VFS_FSYNC_RECV(struct tevent_req *req, int *perrno);
991 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
992 struct smb_filename *smb_fname);
993 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
994 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
995 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
996 struct smb_filename *smb_filename);
997 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
998 struct files_struct *fsp,
999 const SMB_STRUCT_STAT *sbuf);
1000 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
1001 const struct smb_filename *smb_fname);
1002 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
1003 mode_t mode);
1004 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
1005 struct files_struct *fsp, mode_t mode);
1006 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
1007 uid_t uid, gid_t gid);
1008 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
1009 struct files_struct *fsp, uid_t uid, gid_t gid);
1010 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
1011 uid_t uid, gid_t gid);
1012 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
1013 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
1014 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
1015 const struct smb_filename *smb_fname,
1016 struct smb_file_time *ft);
1017 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
1018 struct files_struct *fsp, off_t offset);
1019 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
1020 struct files_struct *fsp,
1021 enum vfs_fallocate_mode mode,
1022 off_t offset,
1023 off_t len);
1024 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
1025 struct files_struct *fsp, int op, off_t offset,
1026 off_t count, int type);
1027 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
1028 struct files_struct *fsp, uint32 share_mode,
1029 uint32_t access_mask);
1030 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
1031 struct files_struct *fsp, int leasetype);
1032 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
1033 struct files_struct *fsp, off_t *poffset,
1034 off_t *pcount, int *ptype, pid_t *ppid);
1035 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
1036 const char *newpath);
1037 int smb_vfs_call_readlink(struct vfs_handle_struct *handle,
1038 const char *path, char *buf, size_t bufsiz);
1039 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
1040 const char *newpath);
1041 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
1042 mode_t mode, SMB_DEV_T dev);
1043 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
1044 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
1045 struct sys_notify_context *ctx,
1046 const char *name,
1047 uint32_t *filter,
1048 uint32_t *subdir_filter,
1049 void (*callback)(struct sys_notify_context *ctx,
1050 void *private_data,
1051 struct notify_event *ev),
1052 void *private_data, void *handle_p);
1053 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
1054 unsigned int flags);
1055 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
1056 const SMB_STRUCT_STAT *sbuf);
1057 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
1058 struct files_struct *fsp,
1059 const char *fname,
1060 TALLOC_CTX *mem_ctx,
1061 unsigned int *num_streams,
1062 struct stream_struct **streams);
1063 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
1064 const char *path, const char *name,
1065 TALLOC_CTX *mem_ctx, char **found_name);
1066 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
1067 const char *filename);
1068 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
1069 struct byte_range_lock *br_lck,
1070 struct lock_struct *plock,
1071 bool blocking_lock,
1072 struct blocking_lock_record *blr);
1073 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
1074 struct messaging_context *msg_ctx,
1075 struct byte_range_lock *br_lck,
1076 const struct lock_struct *plock);
1077 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
1078 struct byte_range_lock *br_lck,
1079 struct lock_struct *plock,
1080 struct blocking_lock_record *blr);
1081 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
1082 struct files_struct *fsp,
1083 struct lock_struct *plock);
1084 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
1085 struct files_struct *fsp,
1086 struct lock_struct *plock);
1087 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
1088 const char *name,
1089 enum vfs_translate_direction direction,
1090 TALLOC_CTX *mem_ctx,
1091 char **mapped_name);
1092 NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
1093 struct files_struct *fsp,
1094 TALLOC_CTX *ctx,
1095 uint32_t function,
1096 uint16_t req_flags,
1097 const uint8_t *_in_data,
1098 uint32_t in_len,
1099 uint8_t **_out_data,
1100 uint32_t max_out_len,
1101 uint32_t *out_len);
1102 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
1103 TALLOC_CTX *mem_ctx,
1104 struct tevent_context *ev,
1105 struct files_struct *src_fsp,
1106 off_t src_off,
1107 struct files_struct *dest_fsp,
1108 off_t dest_off,
1109 off_t num);
1110 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
1111 struct tevent_req *req,
1112 off_t *copied);
1113 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
1114 struct files_struct *fsp,
1115 uint32 security_info,
1116 TALLOC_CTX *mem_ctx,
1117 struct security_descriptor **ppdesc);
1118 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
1119 const char *name,
1120 uint32 security_info,
1121 TALLOC_CTX *mem_ctx,
1122 struct security_descriptor **ppdesc);
1123 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
1124 struct files_struct *fsp,
1125 uint32 security_info_sent,
1126 const struct security_descriptor *psd);
1127 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
1128 struct smb_filename *file,
1129 struct security_acl *sacl,
1130 uint32_t access_requested,
1131 uint32_t access_denied);
1132 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
1133 mode_t mode);
1134 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
1135 struct files_struct *fsp, mode_t mode);
1136 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
1137 const char *path_p,
1138 SMB_ACL_TYPE_T type,
1139 TALLOC_CTX *mem_ctx);
1140 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
1141 struct files_struct *fsp,
1142 TALLOC_CTX *mem_ctx);
1143 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
1144 const char *path_p,
1145 TALLOC_CTX *mem_ctx,
1146 char **blob_description,
1147 DATA_BLOB *blob);
1148 int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
1149 struct files_struct *fsp,
1150 TALLOC_CTX *mem_ctx,
1151 char **blob_description,
1152 DATA_BLOB *blob);
1153 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
1154 const char *name, SMB_ACL_TYPE_T acltype,
1155 SMB_ACL_T theacl);
1156 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
1157 struct files_struct *fsp, SMB_ACL_T theacl);
1158 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
1159 const char *path);
1160 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
1161 const char *path, const char *name, void *value,
1162 size_t size);
1163 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
1164 struct files_struct *fsp, const char *name,
1165 void *value, size_t size);
1166 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
1167 const char *path, char *list, size_t size);
1168 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
1169 const char *path, char *list, size_t size);
1170 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
1171 struct files_struct *fsp, char *list,
1172 size_t size);
1173 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
1174 const char *path, const char *name);
1175 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
1176 struct files_struct *fsp, const char *name);
1177 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
1178 const char *name, const void *value, size_t size,
1179 int flags);
1180 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
1181 const char *name, const void *value, size_t size,
1182 int flags);
1183 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
1184 struct files_struct *fsp, const char *name,
1185 const void *value, size_t size, int flags);
1186 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
1187 struct files_struct *fsp);
1188 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
1189 const struct smb_filename *fname,
1190 SMB_STRUCT_STAT *sbuf);
1191 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
1192 const struct smb_filename *fname);
1193 NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
1194 struct files_struct *fsp,
1195 TALLOC_CTX *mem_ctx,
1196 DATA_BLOB *cookie);
1197 NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
1198 struct files_struct *fsp,
1199 const DATA_BLOB old_cookie,
1200 TALLOC_CTX *mem_ctx,
1201 DATA_BLOB *new_cookie);
1202 NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
1203 struct smb_request *smb1req,
1204 struct smbXsrv_open *op,
1205 const DATA_BLOB old_cookie,
1206 TALLOC_CTX *mem_ctx,
1207 struct files_struct **fsp,
1208 DATA_BLOB *new_cookie);
1210 NTSTATUS smb_register_vfs(int version, const char *name,
1211 const struct vfs_fn_pointers *fns);
1212 void *vfs_add_fsp_extension_notype(vfs_handle_struct *handle,
1213 files_struct *fsp, size_t ext_size,
1214 void (*destroy_fn)(void *p_data));
1215 void vfs_remove_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1216 void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
1217 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1218 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
1220 #endif /* _VFS_H */