mount.cifs: check access of credential files before opening
[Samba/gebeck_regimport.git] / source3 / include / vfs.h
blobed49d1fd28f490e8532009f05bce37aa67d9f825
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 #define SMB_VFS_INTERFACE_VERSION 27
131 /* to bug old modules which are trying to compile with the old functions */
132 #define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
133 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
134 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
135 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
136 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
139 All intercepted VFS operations must be declared as static functions inside module source
140 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
141 example VFS modules for more details.
144 /* VFS operations structure */
146 struct vfs_handle_struct;
147 struct connection_struct;
148 struct files_struct;
149 struct security_descriptor;
150 struct vfs_statvfs_struct;
151 struct smb_request;
152 struct ea_list;
153 struct smb_file_time;
154 struct blocking_lock_record;
155 struct smb_filename;
157 #define VFS_FIND(__fn__) while (handle->fns->__fn__==NULL) { \
158 handle = handle->next; \
161 enum vfs_translate_direction {
162 vfs_translate_to_unix = 0,
163 vfs_translate_to_windows
167 Available VFS operations. These values must be in sync with vfs_ops struct
168 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
169 In particular, if new operations are added to vfs_ops, appropriate constants
170 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
173 struct vfs_fn_pointers {
174 /* Disk operations */
176 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
177 void (*disconnect)(struct vfs_handle_struct *handle);
178 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
179 uint64_t *dfree, uint64_t *dsize);
180 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
181 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
182 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
183 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
184 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
186 /* Directory operations */
188 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
189 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle,
190 SMB_STRUCT_DIR *dirp,
191 SMB_STRUCT_STAT *sbuf);
192 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
193 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
194 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
195 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
196 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
197 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
198 void (*init_search_op)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
200 /* File operations */
202 int (*open)(struct vfs_handle_struct *handle,
203 struct smb_filename *smb_fname, files_struct *fsp,
204 int flags, mode_t mode);
205 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
206 struct smb_request *req,
207 uint16_t root_dir_fid,
208 struct smb_filename *smb_fname,
209 uint32_t access_mask,
210 uint32_t share_access,
211 uint32_t create_disposition,
212 uint32_t create_options,
213 uint32_t file_attributes,
214 uint32_t oplock_request,
215 uint64_t allocation_size,
216 struct security_descriptor *sd,
217 struct ea_list *ea_list,
218 files_struct **result,
219 int *pinfo);
220 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
221 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
222 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
223 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
224 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
225 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
226 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
227 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
228 int (*rename)(struct vfs_handle_struct *handle,
229 const struct smb_filename *smb_fname_src,
230 const struct smb_filename *smb_fname_dst);
231 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
232 int (*stat)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
233 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
234 int (*lstat)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
235 uint64_t (*get_alloc_size)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
236 int (*unlink)(struct vfs_handle_struct *handle,
237 const struct smb_filename *smb_fname);
238 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
239 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
240 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
241 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
242 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
243 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
244 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
245 int (*ntimes)(struct vfs_handle_struct *handle,
246 const struct smb_filename *smb_fname,
247 struct smb_file_time *ft);
248 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
249 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
250 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode);
251 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
252 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
253 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
254 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
255 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
256 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
257 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
258 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
259 struct sys_notify_context *ctx,
260 struct notify_entry *e,
261 void (*callback)(struct sys_notify_context *ctx,
262 void *private_data,
263 struct notify_event *ev),
264 void *private_data, void *handle_p);
265 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
266 struct file_id (*file_id_create)(struct vfs_handle_struct *handle,
267 const SMB_STRUCT_STAT *sbuf);
269 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
270 struct files_struct *fsp,
271 const char *fname,
272 TALLOC_CTX *mem_ctx,
273 unsigned int *num_streams,
274 struct stream_struct **streams);
276 int (*get_real_filename)(struct vfs_handle_struct *handle,
277 const char *path,
278 const char *name,
279 TALLOC_CTX *mem_ctx,
280 char **found_name);
282 const char *(*connectpath)(struct vfs_handle_struct *handle,
283 const char *filename);
285 NTSTATUS (*brl_lock_windows)(struct vfs_handle_struct *handle,
286 struct byte_range_lock *br_lck,
287 struct lock_struct *plock,
288 bool blocking_lock,
289 struct blocking_lock_record *blr);
291 bool (*brl_unlock_windows)(struct vfs_handle_struct *handle,
292 struct messaging_context *msg_ctx,
293 struct byte_range_lock *br_lck,
294 const struct lock_struct *plock);
296 bool (*brl_cancel_windows)(struct vfs_handle_struct *handle,
297 struct byte_range_lock *br_lck,
298 struct lock_struct *plock,
299 struct blocking_lock_record *blr);
301 bool (*strict_lock)(struct vfs_handle_struct *handle,
302 struct files_struct *fsp,
303 struct lock_struct *plock);
305 void (*strict_unlock)(struct vfs_handle_struct *handle,
306 struct files_struct *fsp,
307 struct lock_struct *plock);
309 NTSTATUS (*translate_name)(struct vfs_handle_struct *handle,
310 char **mapped_name,
311 enum vfs_translate_direction direction);
313 /* NT ACL operations. */
315 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
316 struct files_struct *fsp,
317 uint32 security_info,
318 struct security_descriptor **ppdesc);
319 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
320 const char *name,
321 uint32 security_info,
322 struct security_descriptor **ppdesc);
323 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
324 struct files_struct *fsp,
325 uint32 security_info_sent,
326 const struct security_descriptor *psd);
328 /* POSIX ACL operations. */
330 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
331 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
333 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
334 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
335 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
336 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
337 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
338 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
339 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
340 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
341 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
342 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
343 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
344 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
345 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
346 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
347 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
348 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
349 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
350 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
351 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
352 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
353 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
354 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
356 /* EA operations. */
357 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
358 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
359 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
360 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
361 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
362 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
363 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
364 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
365 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
366 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
367 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
368 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
370 /* aio operations */
371 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
372 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
373 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
374 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
375 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
376 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
377 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
378 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
380 /* offline operations */
381 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
382 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
386 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
387 which describes all operations this module is willing to intercept.
388 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
389 using this information.
392 typedef struct vfs_handle_struct {
393 struct vfs_handle_struct *next, *prev;
394 const char *param;
395 struct connection_struct *conn;
396 const struct vfs_fn_pointers *fns;
397 void *data;
398 void (*free_data)(void **data);
399 } vfs_handle_struct;
402 typedef struct vfs_statvfs_struct {
403 /* For undefined recommended transfer size return -1 in that field */
404 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
405 uint32 BlockSize;
408 The next three fields are in terms of the block size.
409 (above). If block size is unknown, 4096 would be a
410 reasonable block size for a server to report.
411 Note that returning the blocks/blocksavail removes need
412 to make a second call (to QFSInfo level 0x103 to get this info.
413 UserBlockAvail is typically less than or equal to BlocksAvail,
414 if no distinction is made return the same value in each.
417 uint64_t TotalBlocks;
418 uint64_t BlocksAvail; /* bfree */
419 uint64_t UserBlocksAvail; /* bavail */
421 /* For undefined Node fields or FSID return -1 */
422 uint64_t TotalFileNodes;
423 uint64_t FreeFileNodes;
424 uint64_t FsIdentifier; /* fsid */
425 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
426 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
428 int FsCapabilities;
429 } vfs_statvfs_struct;
431 /* Add a new FSP extension of the given type. Returns a pointer to the
432 * extenstion data.
434 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
435 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
437 /* Return a pointer to the existing FSP extension data. */
438 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
439 vfs_fetch_fsp_extension(handle, (fsp))
441 /* Return the talloc context associated with an FSP extension. */
442 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
443 vfs_memctx_fsp_extension(handle, (fsp))
445 /* Remove and destroy an FSP extension. */
446 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
447 vfs_remove_fsp_extension((handle), (fsp))
449 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
450 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
451 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
452 ret; \
456 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
457 if (!(handle)) { \
458 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
459 ret; \
460 } else { \
461 if ((handle)->free_data) { \
462 (handle)->free_data(&(handle)->data); \
464 (handle)->data = (void *)datap; \
465 (handle)->free_data = free_fn; \
469 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
470 if ((handle) && (handle)->free_data) { \
471 (handle)->free_data(&(handle)->data); \
475 /* Check whether module-specific data handle was already allocated or not */
476 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
478 #define SMB_VFS_OP(x) ((void *) x)
480 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
482 #include "vfs_macros.h"
484 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
485 const char *service, const char *user);
486 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
487 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
488 const char *path, bool small_query,
489 uint64_t *bsize, uint64_t *dfree,
490 uint64_t *dsize);
491 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
492 enum SMB_QUOTA_TYPE qtype, unid_t id,
493 SMB_DISK_QUOTA *qt);
494 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
495 enum SMB_QUOTA_TYPE qtype, unid_t id,
496 SMB_DISK_QUOTA *qt);
497 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
498 struct files_struct *fsp,
499 SHADOW_COPY_DATA *shadow_copy_data,
500 bool labels);
501 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
502 struct vfs_statvfs_struct *statbuf);
503 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
504 enum timestamp_set_resolution *p_ts_res);
505 SMB_STRUCT_DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
506 const char *fname, const char *mask,
507 uint32 attributes);
508 SMB_STRUCT_DIRENT *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
509 SMB_STRUCT_DIR *dirp,
510 SMB_STRUCT_STAT *sbuf);
511 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
512 SMB_STRUCT_DIR *dirp, long offset);
513 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
514 SMB_STRUCT_DIR *dirp);
515 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
516 SMB_STRUCT_DIR *dirp);
517 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
518 mode_t mode);
519 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
520 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
521 SMB_STRUCT_DIR *dir);
522 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
523 SMB_STRUCT_DIR *dirp);
524 int smb_vfs_call_open(struct vfs_handle_struct *handle,
525 struct smb_filename *smb_fname, struct files_struct *fsp,
526 int flags, mode_t mode);
527 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
528 struct smb_request *req,
529 uint16_t root_dir_fid,
530 struct smb_filename *smb_fname,
531 uint32_t access_mask,
532 uint32_t share_access,
533 uint32_t create_disposition,
534 uint32_t create_options,
535 uint32_t file_attributes,
536 uint32_t oplock_request,
537 uint64_t allocation_size,
538 struct security_descriptor *sd,
539 struct ea_list *ea_list,
540 files_struct **result,
541 int *pinfo);
542 int smb_vfs_call_close_fn(struct vfs_handle_struct *handle,
543 struct files_struct *fsp);
544 ssize_t smb_vfs_call_vfs_read(struct vfs_handle_struct *handle,
545 struct files_struct *fsp, void *data, size_t n);
546 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
547 struct files_struct *fsp, void *data, size_t n,
548 SMB_OFF_T offset);
549 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
550 struct files_struct *fsp, const void *data,
551 size_t n);
552 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
553 struct files_struct *fsp, const void *data,
554 size_t n, SMB_OFF_T offset);
555 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
556 struct files_struct *fsp, SMB_OFF_T offset,
557 int whence);
558 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
559 files_struct *fromfsp, const DATA_BLOB *header,
560 SMB_OFF_T offset, size_t count);
561 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
562 files_struct *tofsp, SMB_OFF_T offset,
563 size_t count);
564 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
565 const struct smb_filename *smb_fname_src,
566 const struct smb_filename *smb_fname_dst);
567 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
568 struct files_struct *fsp);
569 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
570 struct smb_filename *smb_fname);
571 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
572 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
573 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
574 struct smb_filename *smb_filename);
575 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
576 struct files_struct *fsp,
577 const SMB_STRUCT_STAT *sbuf);
578 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
579 const struct smb_filename *smb_fname);
580 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
581 mode_t mode);
582 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
583 struct files_struct *fsp, mode_t mode);
584 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
585 uid_t uid, gid_t gid);
586 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
587 struct files_struct *fsp, uid_t uid, gid_t gid);
588 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
589 uid_t uid, gid_t gid);
590 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
591 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle, char *buf);
592 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
593 const struct smb_filename *smb_fname,
594 struct smb_file_time *ft);
595 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
596 struct files_struct *fsp, SMB_OFF_T offset);
597 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
598 struct files_struct *fsp, int op, SMB_OFF_T offset,
599 SMB_OFF_T count, int type);
600 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
601 struct files_struct *fsp, uint32 share_mode);
602 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
603 struct files_struct *fsp, int leasetype);
604 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
605 struct files_struct *fsp, SMB_OFF_T *poffset,
606 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
607 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
608 const char *newpath);
609 int smb_vfs_call_vfs_readlink(struct vfs_handle_struct *handle,
610 const char *path, char *buf, size_t bufsiz);
611 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
612 const char *newpath);
613 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
614 mode_t mode, SMB_DEV_T dev);
615 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
616 const char *path, char *resolved_path);
617 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
618 struct sys_notify_context *ctx,
619 struct notify_entry *e,
620 void (*callback)(struct sys_notify_context *ctx,
621 void *private_data,
622 struct notify_event *ev),
623 void *private_data, void *handle_p);
624 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
625 unsigned int flags);
626 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
627 const SMB_STRUCT_STAT *sbuf);
628 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
629 struct files_struct *fsp,
630 const char *fname,
631 TALLOC_CTX *mem_ctx,
632 unsigned int *num_streams,
633 struct stream_struct **streams);
634 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
635 const char *path, const char *name,
636 TALLOC_CTX *mem_ctx, char **found_name);
637 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
638 const char *filename);
639 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
640 struct byte_range_lock *br_lck,
641 struct lock_struct *plock,
642 bool blocking_lock,
643 struct blocking_lock_record *blr);
644 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
645 struct messaging_context *msg_ctx,
646 struct byte_range_lock *br_lck,
647 const struct lock_struct *plock);
648 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
649 struct byte_range_lock *br_lck,
650 struct lock_struct *plock,
651 struct blocking_lock_record *blr);
652 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
653 struct files_struct *fsp,
654 struct lock_struct *plock);
655 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
656 struct files_struct *fsp,
657 struct lock_struct *plock);
658 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
659 char **mapped_name,
660 enum vfs_translate_direction direction);
661 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
662 struct files_struct *fsp,
663 uint32 security_info,
664 struct security_descriptor **ppdesc);
665 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
666 const char *name,
667 uint32 security_info,
668 struct security_descriptor **ppdesc);
669 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
670 struct files_struct *fsp,
671 uint32 security_info_sent,
672 const struct security_descriptor *psd);
673 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
674 mode_t mode);
675 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
676 struct files_struct *fsp, mode_t mode);
677 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
678 SMB_ACL_T theacl, int entry_id,
679 SMB_ACL_ENTRY_T *entry_p);
680 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
681 SMB_ACL_ENTRY_T entry_d,
682 SMB_ACL_TAG_T *tag_type_p);
683 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
684 SMB_ACL_ENTRY_T entry_d,
685 SMB_ACL_PERMSET_T *permset_p);
686 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
687 SMB_ACL_ENTRY_T entry_d);
688 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
689 const char *path_p,
690 SMB_ACL_TYPE_T type);
691 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
692 struct files_struct *fsp);
693 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
694 SMB_ACL_PERMSET_T permset);
695 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
696 SMB_ACL_PERMSET_T permset,
697 SMB_ACL_PERM_T perm);
698 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
699 SMB_ACL_T theacl, ssize_t *plen);
700 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
701 int count);
702 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
703 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
704 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
705 SMB_ACL_ENTRY_T entry,
706 SMB_ACL_TAG_T tagtype);
707 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
708 SMB_ACL_ENTRY_T entry, void *qual);
709 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
710 SMB_ACL_ENTRY_T entry,
711 SMB_ACL_PERMSET_T permset);
712 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
713 SMB_ACL_T theacl);
714 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
715 const char *name, SMB_ACL_TYPE_T acltype,
716 SMB_ACL_T theacl);
717 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
718 struct files_struct *fsp, SMB_ACL_T theacl);
719 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
720 const char *path);
721 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
722 SMB_ACL_PERMSET_T permset,
723 SMB_ACL_PERM_T perm);
724 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
725 char *text);
726 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
727 SMB_ACL_T posix_acl);
728 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
729 void *qualifier, SMB_ACL_TAG_T tagtype);
730 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
731 const char *path, const char *name, void *value,
732 size_t size);
733 ssize_t smb_vfs_call_lgetxattr(struct vfs_handle_struct *handle,
734 const char *path, const char *name, void *value,
735 size_t size);
736 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
737 struct files_struct *fsp, const char *name,
738 void *value, size_t size);
739 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
740 const char *path, char *list, size_t size);
741 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
742 const char *path, char *list, size_t size);
743 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
744 struct files_struct *fsp, char *list,
745 size_t size);
746 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
747 const char *path, const char *name);
748 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
749 const char *path, const char *name);
750 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
751 struct files_struct *fsp, const char *name);
752 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
753 const char *name, const void *value, size_t size,
754 int flags);
755 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
756 const char *name, const void *value, size_t size,
757 int flags);
758 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
759 struct files_struct *fsp, const char *name,
760 const void *value, size_t size, int flags);
761 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
762 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
763 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
764 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
765 ssize_t smb_vfs_call_aio_return_fn(struct vfs_handle_struct *handle,
766 struct files_struct *fsp,
767 SMB_STRUCT_AIOCB *aiocb);
768 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
769 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
770 int smb_vfs_call_aio_error_fn(struct vfs_handle_struct *handle,
771 struct files_struct *fsp,
772 SMB_STRUCT_AIOCB *aiocb);
773 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
774 struct files_struct *fsp, int op,
775 SMB_STRUCT_AIOCB *aiocb);
776 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
777 struct files_struct *fsp,
778 const SMB_STRUCT_AIOCB * const aiocb[], int n,
779 const struct timespec *timeout);
780 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
781 struct files_struct *fsp);
782 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
783 const char *path, SMB_STRUCT_STAT *sbuf);
784 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
785 const char *path);
787 #endif /* _VFS_H */