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