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