r9091: Fix #2954, aix 5.1 compile. Stupid aix aio.h header defines aio_error and
[Samba/bb.git] / source / include / vfs.h
blobc7c7575d904c3299bf1d273157ed87c1e1a83a38
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
7 Copyright (C) Stefan (metze) Metzmacher 2003
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
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 #define SMB_VFS_INTERFACE_VERSION 13
65 /* to bug old modules which are trying to compile with the old functions */
66 #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 };
67 #define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
68 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
69 #define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
70 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
73 All intercepted VFS operations must be declared as static functions inside module source
74 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
75 example VFS modules for more details.
78 /* VFS operations structure */
80 struct vfs_handle_struct;
81 struct connection_struct;
82 struct files_struct;
83 struct security_descriptor_info;
86 Available VFS operations. These values must be in sync with vfs_ops struct
87 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
88 In particular, if new operations are added to vfs_ops, appropriate constants
89 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
92 typedef enum _vfs_op_type {
93 SMB_VFS_OP_NOOP = -1,
95 /* Disk operations */
97 SMB_VFS_OP_CONNECT = 0,
98 SMB_VFS_OP_DISCONNECT,
99 SMB_VFS_OP_DISK_FREE,
100 SMB_VFS_OP_GET_QUOTA,
101 SMB_VFS_OP_SET_QUOTA,
102 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
105 /* Directory operations */
107 SMB_VFS_OP_OPENDIR,
108 SMB_VFS_OP_READDIR,
109 SMB_VFS_OP_SEEKDIR,
110 SMB_VFS_OP_TELLDIR,
111 SMB_VFS_OP_REWINDDIR,
112 SMB_VFS_OP_MKDIR,
113 SMB_VFS_OP_RMDIR,
114 SMB_VFS_OP_CLOSEDIR,
116 /* File operations */
118 SMB_VFS_OP_OPEN,
119 SMB_VFS_OP_CLOSE,
120 SMB_VFS_OP_READ,
121 SMB_VFS_OP_PREAD,
122 SMB_VFS_OP_WRITE,
123 SMB_VFS_OP_PWRITE,
124 SMB_VFS_OP_LSEEK,
125 SMB_VFS_OP_SENDFILE,
126 SMB_VFS_OP_RENAME,
127 SMB_VFS_OP_FSYNC,
128 SMB_VFS_OP_STAT,
129 SMB_VFS_OP_FSTAT,
130 SMB_VFS_OP_LSTAT,
131 SMB_VFS_OP_UNLINK,
132 SMB_VFS_OP_CHMOD,
133 SMB_VFS_OP_FCHMOD,
134 SMB_VFS_OP_CHOWN,
135 SMB_VFS_OP_FCHOWN,
136 SMB_VFS_OP_CHDIR,
137 SMB_VFS_OP_GETWD,
138 SMB_VFS_OP_UTIME,
139 SMB_VFS_OP_FTRUNCATE,
140 SMB_VFS_OP_LOCK,
141 SMB_VFS_OP_SYMLINK,
142 SMB_VFS_OP_READLINK,
143 SMB_VFS_OP_LINK,
144 SMB_VFS_OP_MKNOD,
145 SMB_VFS_OP_REALPATH,
147 /* NT ACL operations. */
149 SMB_VFS_OP_FGET_NT_ACL,
150 SMB_VFS_OP_GET_NT_ACL,
151 SMB_VFS_OP_FSET_NT_ACL,
152 SMB_VFS_OP_SET_NT_ACL,
154 /* POSIX ACL operations. */
156 SMB_VFS_OP_CHMOD_ACL,
157 SMB_VFS_OP_FCHMOD_ACL,
159 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
160 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
161 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
162 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
163 SMB_VFS_OP_SYS_ACL_GET_FILE,
164 SMB_VFS_OP_SYS_ACL_GET_FD,
165 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
166 SMB_VFS_OP_SYS_ACL_ADD_PERM,
167 SMB_VFS_OP_SYS_ACL_TO_TEXT,
168 SMB_VFS_OP_SYS_ACL_INIT,
169 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
170 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
171 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
172 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
173 SMB_VFS_OP_SYS_ACL_VALID,
174 SMB_VFS_OP_SYS_ACL_SET_FILE,
175 SMB_VFS_OP_SYS_ACL_SET_FD,
176 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
177 SMB_VFS_OP_SYS_ACL_GET_PERM,
178 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
179 SMB_VFS_OP_SYS_ACL_FREE_ACL,
180 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
182 /* EA operations. */
183 SMB_VFS_OP_GETXATTR,
184 SMB_VFS_OP_LGETXATTR,
185 SMB_VFS_OP_FGETXATTR,
186 SMB_VFS_OP_LISTXATTR,
187 SMB_VFS_OP_LLISTXATTR,
188 SMB_VFS_OP_FLISTXATTR,
189 SMB_VFS_OP_REMOVEXATTR,
190 SMB_VFS_OP_LREMOVEXATTR,
191 SMB_VFS_OP_FREMOVEXATTR,
192 SMB_VFS_OP_SETXATTR,
193 SMB_VFS_OP_LSETXATTR,
194 SMB_VFS_OP_FSETXATTR,
196 /* aio operations */
197 SMB_VFS_OP_AIO_READ,
198 SMB_VFS_OP_AIO_WRITE,
199 SMB_VFS_OP_AIO_RETURN,
200 SMB_VFS_OP_AIO_CANCEL,
201 SMB_VFS_OP_AIO_ERROR,
202 SMB_VFS_OP_AIO_FSYNC,
203 SMB_VFS_OP_AIO_SUSPEND,
205 /* This should always be last enum value */
207 SMB_VFS_OP_LAST
208 } vfs_op_type;
211 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
213 struct vfs_ops {
214 struct vfs_fn_pointers {
215 /* Disk operations */
217 int (*connect_fn)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
218 void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
219 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize,
220 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
221 int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
222 int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
223 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
225 /* Directory operations */
227 DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, const char *mask, uint32 attributes);
228 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
229 void (*seekdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp, long offset);
230 long (*telldir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
231 void (*rewind_dir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
232 int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
233 int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
234 int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
236 /* File operations */
238 int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
239 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
240 ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
241 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
242 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
243 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
244 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
245 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fsp, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
246 int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldname, const char *newname);
247 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
248 int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
249 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
250 int (*lstat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf);
251 int (*unlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
252 int (*chmod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
253 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
254 int (*chown)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, uid_t uid, gid_t gid);
255 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
256 int (*chdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
257 char *(*getwd)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *buf);
258 int (*utime)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, struct utimbuf *times);
259 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
260 BOOL (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
261 int (*symlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
262 int (*readlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *buf, size_t bufsiz);
263 int (*link)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
264 int (*mknod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev);
265 char *(*realpath)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *resolved_path);
267 /* NT ACL operations. */
269 size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info, struct security_descriptor_info **ppdesc);
270 size_t (*get_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info, struct security_descriptor_info **ppdesc);
271 BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
272 BOOL (*set_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd);
274 /* POSIX ACL operations. */
276 int (*chmod_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, mode_t mode);
277 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
279 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
280 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
281 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
282 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d);
283 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path_p, SMB_ACL_TYPE_T type);
284 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
285 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset);
286 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
287 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen);
288 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, struct connection_struct *conn, int count);
289 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
290 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
291 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual);
292 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
293 int (*sys_acl_valid)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl );
294 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
295 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
296 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
297 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
298 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
299 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
300 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
302 /* EA operations. */
303 ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
304 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
305 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
306 ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
307 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
308 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
309 int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
310 int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
311 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
312 int (*setxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
313 int (*lsetxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name, const void *value, size_t size, int flags);
314 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
316 /* aio operations */
317 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
318 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
319 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
320 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_AIOCB *aiocb);
321 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
322 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
323 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
325 } ops;
327 struct vfs_handles_pointers {
328 /* Disk operations */
330 struct vfs_handle_struct *connect_hnd;
331 struct vfs_handle_struct *disconnect;
332 struct vfs_handle_struct *disk_free;
333 struct vfs_handle_struct *get_quota;
334 struct vfs_handle_struct *set_quota;
335 struct vfs_handle_struct *get_shadow_copy_data;
337 /* Directory operations */
339 struct vfs_handle_struct *opendir;
340 struct vfs_handle_struct *readdir;
341 struct vfs_handle_struct *seekdir;
342 struct vfs_handle_struct *telldir;
343 struct vfs_handle_struct *rewind_dir;
344 struct vfs_handle_struct *mkdir;
345 struct vfs_handle_struct *rmdir;
346 struct vfs_handle_struct *closedir;
348 /* File operations */
350 struct vfs_handle_struct *open;
351 struct vfs_handle_struct *close_hnd;
352 struct vfs_handle_struct *read;
353 struct vfs_handle_struct *pread;
354 struct vfs_handle_struct *write;
355 struct vfs_handle_struct *pwrite;
356 struct vfs_handle_struct *lseek;
357 struct vfs_handle_struct *sendfile;
358 struct vfs_handle_struct *rename;
359 struct vfs_handle_struct *fsync;
360 struct vfs_handle_struct *stat;
361 struct vfs_handle_struct *fstat;
362 struct vfs_handle_struct *lstat;
363 struct vfs_handle_struct *unlink;
364 struct vfs_handle_struct *chmod;
365 struct vfs_handle_struct *fchmod;
366 struct vfs_handle_struct *chown;
367 struct vfs_handle_struct *fchown;
368 struct vfs_handle_struct *chdir;
369 struct vfs_handle_struct *getwd;
370 struct vfs_handle_struct *utime;
371 struct vfs_handle_struct *ftruncate;
372 struct vfs_handle_struct *lock;
373 struct vfs_handle_struct *symlink;
374 struct vfs_handle_struct *readlink;
375 struct vfs_handle_struct *link;
376 struct vfs_handle_struct *mknod;
377 struct vfs_handle_struct *realpath;
379 /* NT ACL operations. */
381 struct vfs_handle_struct *fget_nt_acl;
382 struct vfs_handle_struct *get_nt_acl;
383 struct vfs_handle_struct *fset_nt_acl;
384 struct vfs_handle_struct *set_nt_acl;
386 /* POSIX ACL operations. */
388 struct vfs_handle_struct *chmod_acl;
389 struct vfs_handle_struct *fchmod_acl;
391 struct vfs_handle_struct *sys_acl_get_entry;
392 struct vfs_handle_struct *sys_acl_get_tag_type;
393 struct vfs_handle_struct *sys_acl_get_permset;
394 struct vfs_handle_struct *sys_acl_get_qualifier;
395 struct vfs_handle_struct *sys_acl_get_file;
396 struct vfs_handle_struct *sys_acl_get_fd;
397 struct vfs_handle_struct *sys_acl_clear_perms;
398 struct vfs_handle_struct *sys_acl_add_perm;
399 struct vfs_handle_struct *sys_acl_to_text;
400 struct vfs_handle_struct *sys_acl_init;
401 struct vfs_handle_struct *sys_acl_create_entry;
402 struct vfs_handle_struct *sys_acl_set_tag_type;
403 struct vfs_handle_struct *sys_acl_set_qualifier;
404 struct vfs_handle_struct *sys_acl_set_permset;
405 struct vfs_handle_struct *sys_acl_valid;
406 struct vfs_handle_struct *sys_acl_set_file;
407 struct vfs_handle_struct *sys_acl_set_fd;
408 struct vfs_handle_struct *sys_acl_delete_def_file;
409 struct vfs_handle_struct *sys_acl_get_perm;
410 struct vfs_handle_struct *sys_acl_free_text;
411 struct vfs_handle_struct *sys_acl_free_acl;
412 struct vfs_handle_struct *sys_acl_free_qualifier;
414 /* EA operations. */
415 struct vfs_handle_struct *getxattr;
416 struct vfs_handle_struct *lgetxattr;
417 struct vfs_handle_struct *fgetxattr;
418 struct vfs_handle_struct *listxattr;
419 struct vfs_handle_struct *llistxattr;
420 struct vfs_handle_struct *flistxattr;
421 struct vfs_handle_struct *removexattr;
422 struct vfs_handle_struct *lremovexattr;
423 struct vfs_handle_struct *fremovexattr;
424 struct vfs_handle_struct *setxattr;
425 struct vfs_handle_struct *lsetxattr;
426 struct vfs_handle_struct *fsetxattr;
428 /* aio operations */
429 struct vfs_handle_struct *aio_read;
430 struct vfs_handle_struct *aio_write;
431 struct vfs_handle_struct *aio_return;
432 struct vfs_handle_struct *aio_cancel;
433 struct vfs_handle_struct *aio_error;
434 struct vfs_handle_struct *aio_fsync;
435 struct vfs_handle_struct *aio_suspend;
436 } handles;
440 Possible VFS operation layers (per-operation)
442 These values are used by VFS subsystem when building vfs_ops for connection
443 from multiple VFS modules. Internally, Samba differentiates only opaque and
444 transparent layers at this process. Other types are used for providing better
445 diagnosing facilities.
447 Most modules will provide transparent layers. Opaque layer is for modules
448 which implement actual file system calls (like DB-based VFS). For example,
449 default POSIX VFS which is built in into Samba is an opaque VFS module.
451 Other layer types (audit, splitter, scanner) were designed to provide different
452 degree of transparency and for diagnosing VFS module behaviour.
454 Each module can implement several layers at the same time provided that only
455 one layer is used per each operation.
459 typedef enum _vfs_op_layer {
460 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
461 /* of operations description */
462 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
463 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
464 /* possibly changing passed data */
465 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
466 /* use Samba VFS */
467 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
468 /* then combines result */
469 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
470 /* file activity like logging to files _inside_ samba VFS */
471 } vfs_op_layer;
474 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
475 which describes all operations this module is willing to intercept.
476 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
477 using this information.
480 typedef struct _vfs_op_tuple {
481 void* op;
482 vfs_op_type type;
483 vfs_op_layer layer;
484 } vfs_op_tuple;
487 typedef struct vfs_handle_struct {
488 struct vfs_handle_struct *next, *prev;
489 const char *param;
490 struct vfs_ops vfs_next;
491 struct connection_struct *conn;
492 void *data;
493 void (*free_data)(void **data);
494 } vfs_handle_struct;
497 #define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
498 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
499 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
500 ret; \
504 #define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
505 if (!(handle)) { \
506 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
507 ret; \
508 } else { \
509 if ((handle)->free_data) { \
510 (handle)->free_data(&(handle)->data); \
512 (handle)->data = (void *)datap; \
513 (handle)->free_data = free_fn; \
517 #define SMB_VFS_HANDLE_FREE_DATA(handle) { \
518 if ((handle) && (handle)->free_data) { \
519 (handle)->free_data(&(handle)->data); \
523 /* Check whether module-specific data handle was already allocated or not */
524 #define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
526 #define SMB_VFS_OP(x) ((void *) x)
529 #include "vfs_macros.h"
531 #endif /* _VFS_H */