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