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