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