s4-privileges: moved privileges to private/privilege.ldb
[Samba/cd1.git] / source3 / include / vfs.h
blobf9c1f0a54f20840b39a12e17a40bc1f4decf2c83
1 /*
2 Unix SMB/CIFS implementation.
3 VFS structures and parameters
4 Copyright (C) Jeremy Allison 1999-2005
5 Copyright (C) Tim Potter 1999
6 Copyright (C) Alexander Bokovoy 2002-2005
7 Copyright (C) Stefan (metze) Metzmacher 2003
8 Copyright (C) Volker Lendecke 2009
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 This work was sponsored by Optifacio Software Services, Inc.
26 #ifndef _VFS_H
27 #define _VFS_H
29 /* Avoid conflict with an AIX include file */
31 #ifdef vfs_ops
32 #undef vfs_ops
33 #endif
36 * As we're now (thanks Andrew ! :-) using file_structs and connection
37 * structs in the vfs - then anyone writing a vfs must include includes.h...
41 * This next constant specifies the version number of the VFS interface
42 * this smbd will load. Increment this if *ANY* changes are made to the
43 * vfs_ops below. JRA.
45 * If you change anything here, please also update modules/vfs_full_audit.c.
46 * VL.
49 /* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
50 /* Changed to version 3 for POSIX acl extensions. JRA. */
51 /* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
52 /* Changed to version 5 for sendfile addition. JRA. */
53 /* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
54 /* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
55 /* Changed to version 8 includes EA calls. JRA. */
56 /* Changed to version 9 to include the get_shadow_data call. --metze */
57 /* Changed to version 10 to include pread/pwrite calls. */
58 /* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
59 /* Changed to version 12 to add mask and attributes to opendir(). JRA
60 Also include aio calls. JRA. */
61 /* Changed to version 13 as the internal structure of files_struct has changed. JRA */
62 /* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
63 /* Changed to version 15 as we added the statvfs call. JRA */
64 /* Changed to version 16 as we added the getlock call. JRA */
65 /* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
66 /* Changed to version 18 to add fsp parameter to the open call -- jpeach
67 Also include kernel_flock call - jmcd */
68 /* Changed to version 19, kernel change notify has been merged
69 Also included linux setlease call - jmcd */
70 /* Changed to version 20, use ntimes call instead of utime (greater
71 * timestamp resolition. JRA. */
72 /* Changed to version21 to add chflags operation -- jpeach */
73 /* Changed to version22 to add lchown operation -- jra */
74 /* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
75 /* Leave at 22 - not yet released. Add file_id_create operation. --metze */
76 /* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
77 /* Leave at 22 - not yet released. Added recvfile. */
78 /* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
79 /* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
80 * files_struct. - obnox.*/
81 /* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
82 /* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
83 /* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
84 /* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
85 /* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
86 /* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
87 /* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
88 /* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
89 /* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
90 /* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
91 /* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
92 /* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
93 /* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
94 /* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
95 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
96 /* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
97 /* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
98 /* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
99 /* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
100 /* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
101 /* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
102 /* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
103 /* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
104 /* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
105 /* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
106 /* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
107 /* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
108 /* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
109 /* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
110 /* Changed to version 23 - remove set_nt_acl call. This can only be done via an
111 open handle. JRA. */
112 /* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
113 /* Changed to version 25 - Jelmer's change from SMB_BIG_UINT to uint64_t. */
114 /* Leave at 25 - not yet released. Add create_file call. -- tprouty. */
115 /* Leave at 25 - not yet released. Add create time to ntimes. -- tstecher. */
116 /* Leave at 25 - not yet released. Add get_alloc_size call. -- tprouty. */
117 /* Leave at 25 - not yet released. Add SMB_STRUCT_STAT to readdir. - sdann */
118 /* Leave at 25 - not yet released. Add init_search_op call. - sdann */
119 /* Leave at 25 - not yet released. Add locking calls. -- zkirsch. */
120 /* Leave at 25 - not yet released. Add strict locking calls. -- drichards. */
121 /* Changed to version 26 - Plumb struct smb_filename to SMB_VFS_CREATE_FILE,
122 SMB_VFS_OPEN, SMB_VFS_STAT, SMB_VFS_LSTAT,
123 SMB_VFS_RENAME, SMB_VFS_UNLINK, SMB_VFS_NTIMES. */
124 /* Changed to version 27 - not yet released. Added enum timestamp_set_resolution
125 * return to fs_capabilities call. JRA. */
126 /* Leave at 27 - not yet released. Add translate_name VFS call to convert
127 UNIX names to Windows supported names -- asrinivasan. */
128 #define SMB_VFS_INTERFACE_VERSION 27
131 /* to bug old modules which are trying to compile with the old functions */
132 #define vfs_init __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore(void) { __ERROR_please_port_this_module_to_SMB_VFS_INTERFACE_VERSION_8_donot_use_vfs_init_anymore };
133 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
134 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
135 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
136 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
139 All intercepted VFS operations must be declared as static functions inside module source
140 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
141 example VFS modules for more details.
144 /* VFS operations structure */
146 struct vfs_handle_struct;
147 struct connection_struct;
148 struct files_struct;
149 struct security_descriptor;
150 struct vfs_statvfs_struct;
151 struct smb_request;
152 struct ea_list;
153 struct smb_file_time;
154 struct blocking_lock_record;
155 struct smb_filename;
157 #define VFS_FIND(__fn__) while (handle->fns->__fn__==NULL) { \
158 handle = handle->next; \
161 enum vfs_translate_direction {
162 vfs_translate_to_unix = 0,
163 vfs_translate_to_windows
167 Available VFS operations. These values must be in sync with vfs_ops struct
168 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
169 In particular, if new operations are added to vfs_ops, appropriate constants
170 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
173 struct vfs_fn_pointers {
174 /* Disk operations */
176 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
177 void (*disconnect)(struct vfs_handle_struct *handle);
178 uint64_t (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
179 uint64_t *dfree, uint64_t *dsize);
180 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
181 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
182 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
183 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
184 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res);
186 /* Directory operations */
188 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
189 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle,
190 SMB_STRUCT_DIR *dirp,
191 SMB_STRUCT_STAT *sbuf);
192 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
193 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
194 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
195 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
196 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
197 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
198 void (*init_search_op)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
200 /* File operations */
202 int (*open)(struct vfs_handle_struct *handle,
203 struct smb_filename *smb_fname, files_struct *fsp,
204 int flags, mode_t mode);
205 NTSTATUS (*create_file)(struct vfs_handle_struct *handle,
206 struct smb_request *req,
207 uint16_t root_dir_fid,
208 struct smb_filename *smb_fname,
209 uint32_t access_mask,
210 uint32_t share_access,
211 uint32_t create_disposition,
212 uint32_t create_options,
213 uint32_t file_attributes,
214 uint32_t oplock_request,
215 uint64_t allocation_size,
216 struct security_descriptor *sd,
217 struct ea_list *ea_list,
218 files_struct **result,
219 int *pinfo);
220 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
221 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
222 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
223 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
224 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
225 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
226 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
227 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
228 int (*rename)(struct vfs_handle_struct *handle,
229 const struct smb_filename *smb_fname_src,
230 const struct smb_filename *smb_fname_dst);
231 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
232 int (*stat)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
233 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
234 int (*lstat)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
235 uint64_t (*get_alloc_size)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
236 int (*unlink)(struct vfs_handle_struct *handle,
237 const struct smb_filename *smb_fname);
238 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
239 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
240 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
241 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
242 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
243 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
244 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
245 int (*ntimes)(struct vfs_handle_struct *handle,
246 const struct smb_filename *smb_fname,
247 struct smb_file_time *ft);
248 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
249 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
250 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp,
251 uint32 share_mode, uint32_t access_mask);
252 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
253 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
254 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
255 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
256 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
257 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
258 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
259 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
260 struct sys_notify_context *ctx,
261 struct notify_entry *e,
262 void (*callback)(struct sys_notify_context *ctx,
263 void *private_data,
264 struct notify_event *ev),
265 void *private_data, void *handle_p);
266 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
267 struct file_id (*file_id_create)(struct vfs_handle_struct *handle,
268 const SMB_STRUCT_STAT *sbuf);
270 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
271 struct files_struct *fsp,
272 const char *fname,
273 TALLOC_CTX *mem_ctx,
274 unsigned int *num_streams,
275 struct stream_struct **streams);
277 int (*get_real_filename)(struct vfs_handle_struct *handle,
278 const char *path,
279 const char *name,
280 TALLOC_CTX *mem_ctx,
281 char **found_name);
283 const char *(*connectpath)(struct vfs_handle_struct *handle,
284 const char *filename);
286 NTSTATUS (*brl_lock_windows)(struct vfs_handle_struct *handle,
287 struct byte_range_lock *br_lck,
288 struct lock_struct *plock,
289 bool blocking_lock,
290 struct blocking_lock_record *blr);
292 bool (*brl_unlock_windows)(struct vfs_handle_struct *handle,
293 struct messaging_context *msg_ctx,
294 struct byte_range_lock *br_lck,
295 const struct lock_struct *plock);
297 bool (*brl_cancel_windows)(struct vfs_handle_struct *handle,
298 struct byte_range_lock *br_lck,
299 struct lock_struct *plock,
300 struct blocking_lock_record *blr);
302 bool (*strict_lock)(struct vfs_handle_struct *handle,
303 struct files_struct *fsp,
304 struct lock_struct *plock);
306 void (*strict_unlock)(struct vfs_handle_struct *handle,
307 struct files_struct *fsp,
308 struct lock_struct *plock);
310 NTSTATUS (*translate_name)(struct vfs_handle_struct *handle,
311 char **mapped_name,
312 enum vfs_translate_direction direction);
314 /* NT ACL operations. */
316 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
317 struct files_struct *fsp,
318 uint32 security_info,
319 struct security_descriptor **ppdesc);
320 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
321 const char *name,
322 uint32 security_info,
323 struct security_descriptor **ppdesc);
324 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
325 struct files_struct *fsp,
326 uint32 security_info_sent,
327 const struct security_descriptor *psd);
329 /* POSIX ACL operations. */
331 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
332 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
334 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
335 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
336 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
337 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
338 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
339 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
340 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
341 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
342 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
343 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
344 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
345 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
346 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
347 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
348 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
349 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
350 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
351 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
352 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
353 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
354 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
355 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
357 /* EA operations. */
358 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
359 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
360 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
361 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
362 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
363 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
364 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
365 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
366 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
367 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
368 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
369 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
371 /* aio operations */
372 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
373 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
374 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
375 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
376 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
377 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
378 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
379 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
381 /* offline operations */
382 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
383 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
387 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
388 which describes all operations this module is willing to intercept.
389 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
390 using this information.
393 typedef struct vfs_handle_struct {
394 struct vfs_handle_struct *next, *prev;
395 const char *param;
396 struct connection_struct *conn;
397 const struct vfs_fn_pointers *fns;
398 void *data;
399 void (*free_data)(void **data);
400 } vfs_handle_struct;
403 typedef struct vfs_statvfs_struct {
404 /* For undefined recommended transfer size return -1 in that field */
405 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
406 uint32 BlockSize;
409 The next three fields are in terms of the block size.
410 (above). If block size is unknown, 4096 would be a
411 reasonable block size for a server to report.
412 Note that returning the blocks/blocksavail removes need
413 to make a second call (to QFSInfo level 0x103 to get this info.
414 UserBlockAvail is typically less than or equal to BlocksAvail,
415 if no distinction is made return the same value in each.
418 uint64_t TotalBlocks;
419 uint64_t BlocksAvail; /* bfree */
420 uint64_t UserBlocksAvail; /* bavail */
422 /* For undefined Node fields or FSID return -1 */
423 uint64_t TotalFileNodes;
424 uint64_t FreeFileNodes;
425 uint64_t FsIdentifier; /* fsid */
426 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
427 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
429 int FsCapabilities;
430 } vfs_statvfs_struct;
432 /* Add a new FSP extension of the given type. Returns a pointer to the
433 * extenstion data.
435 #define VFS_ADD_FSP_EXTENSION(handle, fsp, type, destroy_fn) \
436 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type), (destroy_fn))
438 /* Return a pointer to the existing FSP extension data. */
439 #define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
440 vfs_fetch_fsp_extension(handle, (fsp))
442 /* Return the talloc context associated with an FSP extension. */
443 #define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
444 vfs_memctx_fsp_extension(handle, (fsp))
446 /* Remove and destroy an FSP extension. */
447 #define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
448 vfs_remove_fsp_extension((handle), (fsp))
450 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
451 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
452 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
453 ret; \
457 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
458 if (!(handle)) { \
459 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
460 ret; \
461 } else { \
462 if ((handle)->free_data) { \
463 (handle)->free_data(&(handle)->data); \
465 (handle)->data = (void *)datap; \
466 (handle)->free_data = free_fn; \
470 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
471 if ((handle) && (handle)->free_data) { \
472 (handle)->free_data(&(handle)->data); \
476 /* Check whether module-specific data handle was already allocated or not */
477 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
479 #define SMB_VFS_OP(x) ((void *) x)
481 #define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
483 #include "vfs_macros.h"
485 int smb_vfs_call_connect(struct vfs_handle_struct *handle,
486 const char *service, const char *user);
487 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
488 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
489 const char *path, bool small_query,
490 uint64_t *bsize, uint64_t *dfree,
491 uint64_t *dsize);
492 int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
493 enum SMB_QUOTA_TYPE qtype, unid_t id,
494 SMB_DISK_QUOTA *qt);
495 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
496 enum SMB_QUOTA_TYPE qtype, unid_t id,
497 SMB_DISK_QUOTA *qt);
498 int smb_vfs_call_get_shadow_copy_data(struct vfs_handle_struct *handle,
499 struct files_struct *fsp,
500 SHADOW_COPY_DATA *shadow_copy_data,
501 bool labels);
502 int smb_vfs_call_statvfs(struct vfs_handle_struct *handle, const char *path,
503 struct vfs_statvfs_struct *statbuf);
504 uint32_t smb_vfs_call_fs_capabilities(struct vfs_handle_struct *handle,
505 enum timestamp_set_resolution *p_ts_res);
506 SMB_STRUCT_DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
507 const char *fname, const char *mask,
508 uint32 attributes);
509 SMB_STRUCT_DIRENT *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
510 SMB_STRUCT_DIR *dirp,
511 SMB_STRUCT_STAT *sbuf);
512 void smb_vfs_call_seekdir(struct vfs_handle_struct *handle,
513 SMB_STRUCT_DIR *dirp, long offset);
514 long smb_vfs_call_telldir(struct vfs_handle_struct *handle,
515 SMB_STRUCT_DIR *dirp);
516 void smb_vfs_call_rewind_dir(struct vfs_handle_struct *handle,
517 SMB_STRUCT_DIR *dirp);
518 int smb_vfs_call_mkdir(struct vfs_handle_struct *handle, const char *path,
519 mode_t mode);
520 int smb_vfs_call_rmdir(struct vfs_handle_struct *handle, const char *path);
521 int smb_vfs_call_closedir(struct vfs_handle_struct *handle,
522 SMB_STRUCT_DIR *dir);
523 void smb_vfs_call_init_search_op(struct vfs_handle_struct *handle,
524 SMB_STRUCT_DIR *dirp);
525 int smb_vfs_call_open(struct vfs_handle_struct *handle,
526 struct smb_filename *smb_fname, struct files_struct *fsp,
527 int flags, mode_t mode);
528 NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
529 struct smb_request *req,
530 uint16_t root_dir_fid,
531 struct smb_filename *smb_fname,
532 uint32_t access_mask,
533 uint32_t share_access,
534 uint32_t create_disposition,
535 uint32_t create_options,
536 uint32_t file_attributes,
537 uint32_t oplock_request,
538 uint64_t allocation_size,
539 struct security_descriptor *sd,
540 struct ea_list *ea_list,
541 files_struct **result,
542 int *pinfo);
543 int smb_vfs_call_close_fn(struct vfs_handle_struct *handle,
544 struct files_struct *fsp);
545 ssize_t smb_vfs_call_vfs_read(struct vfs_handle_struct *handle,
546 struct files_struct *fsp, void *data, size_t n);
547 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
548 struct files_struct *fsp, void *data, size_t n,
549 SMB_OFF_T offset);
550 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
551 struct files_struct *fsp, const void *data,
552 size_t n);
553 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
554 struct files_struct *fsp, const void *data,
555 size_t n, SMB_OFF_T offset);
556 SMB_OFF_T smb_vfs_call_lseek(struct vfs_handle_struct *handle,
557 struct files_struct *fsp, SMB_OFF_T offset,
558 int whence);
559 ssize_t smb_vfs_call_sendfile(struct vfs_handle_struct *handle, int tofd,
560 files_struct *fromfsp, const DATA_BLOB *header,
561 SMB_OFF_T offset, size_t count);
562 ssize_t smb_vfs_call_recvfile(struct vfs_handle_struct *handle, int fromfd,
563 files_struct *tofsp, SMB_OFF_T offset,
564 size_t count);
565 int smb_vfs_call_rename(struct vfs_handle_struct *handle,
566 const struct smb_filename *smb_fname_src,
567 const struct smb_filename *smb_fname_dst);
568 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
569 struct files_struct *fsp);
570 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
571 struct smb_filename *smb_fname);
572 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
573 struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
574 int smb_vfs_call_lstat(struct vfs_handle_struct *handle,
575 struct smb_filename *smb_filename);
576 uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
577 struct files_struct *fsp,
578 const SMB_STRUCT_STAT *sbuf);
579 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
580 const struct smb_filename *smb_fname);
581 int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
582 mode_t mode);
583 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
584 struct files_struct *fsp, mode_t mode);
585 int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
586 uid_t uid, gid_t gid);
587 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
588 struct files_struct *fsp, uid_t uid, gid_t gid);
589 int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
590 uid_t uid, gid_t gid);
591 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
592 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle, char *buf);
593 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
594 const struct smb_filename *smb_fname,
595 struct smb_file_time *ft);
596 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
597 struct files_struct *fsp, SMB_OFF_T offset);
598 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
599 struct files_struct *fsp, int op, SMB_OFF_T offset,
600 SMB_OFF_T count, int type);
601 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
602 struct files_struct *fsp, uint32 share_mode,
603 uint32_t access_mask);
604 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
605 struct files_struct *fsp, int leasetype);
606 bool smb_vfs_call_getlock(struct vfs_handle_struct *handle,
607 struct files_struct *fsp, SMB_OFF_T *poffset,
608 SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
609 int smb_vfs_call_symlink(struct vfs_handle_struct *handle, const char *oldpath,
610 const char *newpath);
611 int smb_vfs_call_vfs_readlink(struct vfs_handle_struct *handle,
612 const char *path, char *buf, size_t bufsiz);
613 int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
614 const char *newpath);
615 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
616 mode_t mode, SMB_DEV_T dev);
617 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle,
618 const char *path, char *resolved_path);
619 NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
620 struct sys_notify_context *ctx,
621 struct notify_entry *e,
622 void (*callback)(struct sys_notify_context *ctx,
623 void *private_data,
624 struct notify_event *ev),
625 void *private_data, void *handle_p);
626 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
627 unsigned int flags);
628 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
629 const SMB_STRUCT_STAT *sbuf);
630 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
631 struct files_struct *fsp,
632 const char *fname,
633 TALLOC_CTX *mem_ctx,
634 unsigned int *num_streams,
635 struct stream_struct **streams);
636 int smb_vfs_call_get_real_filename(struct vfs_handle_struct *handle,
637 const char *path, const char *name,
638 TALLOC_CTX *mem_ctx, char **found_name);
639 const char *smb_vfs_call_connectpath(struct vfs_handle_struct *handle,
640 const char *filename);
641 NTSTATUS smb_vfs_call_brl_lock_windows(struct vfs_handle_struct *handle,
642 struct byte_range_lock *br_lck,
643 struct lock_struct *plock,
644 bool blocking_lock,
645 struct blocking_lock_record *blr);
646 bool smb_vfs_call_brl_unlock_windows(struct vfs_handle_struct *handle,
647 struct messaging_context *msg_ctx,
648 struct byte_range_lock *br_lck,
649 const struct lock_struct *plock);
650 bool smb_vfs_call_brl_cancel_windows(struct vfs_handle_struct *handle,
651 struct byte_range_lock *br_lck,
652 struct lock_struct *plock,
653 struct blocking_lock_record *blr);
654 bool smb_vfs_call_strict_lock(struct vfs_handle_struct *handle,
655 struct files_struct *fsp,
656 struct lock_struct *plock);
657 void smb_vfs_call_strict_unlock(struct vfs_handle_struct *handle,
658 struct files_struct *fsp,
659 struct lock_struct *plock);
660 NTSTATUS smb_vfs_call_translate_name(struct vfs_handle_struct *handle,
661 char **mapped_name,
662 enum vfs_translate_direction direction);
663 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
664 struct files_struct *fsp,
665 uint32 security_info,
666 struct security_descriptor **ppdesc);
667 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
668 const char *name,
669 uint32 security_info,
670 struct security_descriptor **ppdesc);
671 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
672 struct files_struct *fsp,
673 uint32 security_info_sent,
674 const struct security_descriptor *psd);
675 int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
676 mode_t mode);
677 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
678 struct files_struct *fsp, mode_t mode);
679 int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
680 SMB_ACL_T theacl, int entry_id,
681 SMB_ACL_ENTRY_T *entry_p);
682 int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
683 SMB_ACL_ENTRY_T entry_d,
684 SMB_ACL_TAG_T *tag_type_p);
685 int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
686 SMB_ACL_ENTRY_T entry_d,
687 SMB_ACL_PERMSET_T *permset_p);
688 void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
689 SMB_ACL_ENTRY_T entry_d);
690 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
691 const char *path_p,
692 SMB_ACL_TYPE_T type);
693 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
694 struct files_struct *fsp);
695 int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
696 SMB_ACL_PERMSET_T permset);
697 int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
698 SMB_ACL_PERMSET_T permset,
699 SMB_ACL_PERM_T perm);
700 char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
701 SMB_ACL_T theacl, ssize_t *plen);
702 SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
703 int count);
704 int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
705 SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
706 int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
707 SMB_ACL_ENTRY_T entry,
708 SMB_ACL_TAG_T tagtype);
709 int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
710 SMB_ACL_ENTRY_T entry, void *qual);
711 int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
712 SMB_ACL_ENTRY_T entry,
713 SMB_ACL_PERMSET_T permset);
714 int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
715 SMB_ACL_T theacl);
716 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
717 const char *name, SMB_ACL_TYPE_T acltype,
718 SMB_ACL_T theacl);
719 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
720 struct files_struct *fsp, SMB_ACL_T theacl);
721 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
722 const char *path);
723 int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
724 SMB_ACL_PERMSET_T permset,
725 SMB_ACL_PERM_T perm);
726 int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
727 char *text);
728 int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
729 SMB_ACL_T posix_acl);
730 int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
731 void *qualifier, SMB_ACL_TAG_T tagtype);
732 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
733 const char *path, const char *name, void *value,
734 size_t size);
735 ssize_t smb_vfs_call_lgetxattr(struct vfs_handle_struct *handle,
736 const char *path, const char *name, void *value,
737 size_t size);
738 ssize_t smb_vfs_call_fgetxattr(struct vfs_handle_struct *handle,
739 struct files_struct *fsp, const char *name,
740 void *value, size_t size);
741 ssize_t smb_vfs_call_listxattr(struct vfs_handle_struct *handle,
742 const char *path, char *list, size_t size);
743 ssize_t smb_vfs_call_llistxattr(struct vfs_handle_struct *handle,
744 const char *path, char *list, size_t size);
745 ssize_t smb_vfs_call_flistxattr(struct vfs_handle_struct *handle,
746 struct files_struct *fsp, char *list,
747 size_t size);
748 int smb_vfs_call_removexattr(struct vfs_handle_struct *handle,
749 const char *path, const char *name);
750 int smb_vfs_call_lremovexattr(struct vfs_handle_struct *handle,
751 const char *path, const char *name);
752 int smb_vfs_call_fremovexattr(struct vfs_handle_struct *handle,
753 struct files_struct *fsp, const char *name);
754 int smb_vfs_call_setxattr(struct vfs_handle_struct *handle, const char *path,
755 const char *name, const void *value, size_t size,
756 int flags);
757 int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
758 const char *name, const void *value, size_t size,
759 int flags);
760 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
761 struct files_struct *fsp, const char *name,
762 const void *value, size_t size, int flags);
763 int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
764 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
765 int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
766 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
767 ssize_t smb_vfs_call_aio_return_fn(struct vfs_handle_struct *handle,
768 struct files_struct *fsp,
769 SMB_STRUCT_AIOCB *aiocb);
770 int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
771 struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
772 int smb_vfs_call_aio_error_fn(struct vfs_handle_struct *handle,
773 struct files_struct *fsp,
774 SMB_STRUCT_AIOCB *aiocb);
775 int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
776 struct files_struct *fsp, int op,
777 SMB_STRUCT_AIOCB *aiocb);
778 int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
779 struct files_struct *fsp,
780 const SMB_STRUCT_AIOCB * const aiocb[], int n,
781 const struct timespec *timeout);
782 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
783 struct files_struct *fsp);
784 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
785 const char *path, SMB_STRUCT_STAT *sbuf);
786 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
787 const char *path);
789 #endif /* _VFS_H */