1/*
2   Unix SMB/CIFS implementation.
3   VFS structures and parameters
4   Copyright (C) Jeremy Allison                         1999-2004
5   Copyright (C) Tim Potter				1999
6   Copyright (C) Alexander Bokovoy			2002
7   Copyright (C) Stefan (metze) Metzmacher		2003
8
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.
13
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.
18
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.
22
23   This work was sponsored by Optifacio Software Services, Inc.
24*/
25
26#ifndef _VFS_H
27#define _VFS_H
28
29/* Avoid conflict with an AIX include file */
30
31#ifdef vfs_ops
32#undef vfs_ops
33#endif
34
35/*
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...
38 */
39
40/*
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.
44 *
45 * If you change anything here, please also update modules/vfs_full_audit.c.
46 * VL.
47 */
48
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#define SMB_VFS_INTERFACE_VERSION 11
60
61
62/* to bug old modules witch are trying to compile with the old functions */
63#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 };
64#define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
65  __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
66#define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
67  __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
68
69/*
70    All intercepted VFS operations must be declared as static functions inside module source
71    in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
72    example VFS modules for more details.
73*/
74
75/* VFS operations structure */
76
77struct vfs_handle_struct;
78struct connection_struct;
79struct files_struct;
80struct security_descriptor_info;
81
82/*
83    Available VFS operations. These values must be in sync with vfs_ops struct
84    (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
85    In particular, if new operations are added to vfs_ops, appropriate constants
86    should be added to vfs_op_type so that order of them kept same as in vfs_ops.
87*/
88
89typedef enum _vfs_op_type {
90	SMB_VFS_OP_NOOP = -1,
91
92	/* Disk operations */
93
94	SMB_VFS_OP_CONNECT = 0,
95	SMB_VFS_OP_DISCONNECT,
96	SMB_VFS_OP_DISK_FREE,
97	SMB_VFS_OP_GET_QUOTA,
98	SMB_VFS_OP_SET_QUOTA,
99	SMB_VFS_OP_GET_SHADOW_COPY_DATA,
100
101
102	/* Directory operations */
103
104	SMB_VFS_OP_OPENDIR,
105	SMB_VFS_OP_READDIR,
106	SMB_VFS_OP_SEEKDIR,
107	SMB_VFS_OP_TELLDIR,
108	SMB_VFS_OP_REWINDDIR,
109	SMB_VFS_OP_MKDIR,
110	SMB_VFS_OP_RMDIR,
111	SMB_VFS_OP_CLOSEDIR,
112
113	/* File operations */
114
115	SMB_VFS_OP_OPEN,
116	SMB_VFS_OP_CLOSE,
117	SMB_VFS_OP_READ,
118	SMB_VFS_OP_PREAD,
119	SMB_VFS_OP_WRITE,
120	SMB_VFS_OP_PWRITE,
121	SMB_VFS_OP_LSEEK,
122	SMB_VFS_OP_SENDFILE,
123	SMB_VFS_OP_RENAME,
124	SMB_VFS_OP_FSYNC,
125	SMB_VFS_OP_STAT,
126	SMB_VFS_OP_FSTAT,
127	SMB_VFS_OP_LSTAT,
128	SMB_VFS_OP_UNLINK,
129	SMB_VFS_OP_CHMOD,
130	SMB_VFS_OP_FCHMOD,
131	SMB_VFS_OP_CHOWN,
132	SMB_VFS_OP_FCHOWN,
133	SMB_VFS_OP_CHDIR,
134	SMB_VFS_OP_GETWD,
135	SMB_VFS_OP_UTIME,
136	SMB_VFS_OP_FTRUNCATE,
137	SMB_VFS_OP_LOCK,
138	SMB_VFS_OP_SYMLINK,
139	SMB_VFS_OP_READLINK,
140	SMB_VFS_OP_LINK,
141	SMB_VFS_OP_MKNOD,
142	SMB_VFS_OP_REALPATH,
143
144	/* NT ACL operations. */
145
146	SMB_VFS_OP_FGET_NT_ACL,
147	SMB_VFS_OP_GET_NT_ACL,
148	SMB_VFS_OP_FSET_NT_ACL,
149	SMB_VFS_OP_SET_NT_ACL,
150
151	/* POSIX ACL operations. */
152
153	SMB_VFS_OP_CHMOD_ACL,
154	SMB_VFS_OP_FCHMOD_ACL,
155
156	SMB_VFS_OP_SYS_ACL_GET_ENTRY,
157	SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
158	SMB_VFS_OP_SYS_ACL_GET_PERMSET,
159	SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
160	SMB_VFS_OP_SYS_ACL_GET_FILE,
161	SMB_VFS_OP_SYS_ACL_GET_FD,
162	SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
163	SMB_VFS_OP_SYS_ACL_ADD_PERM,
164	SMB_VFS_OP_SYS_ACL_TO_TEXT,
165	SMB_VFS_OP_SYS_ACL_INIT,
166	SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
167	SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
168	SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
169	SMB_VFS_OP_SYS_ACL_SET_PERMSET,
170	SMB_VFS_OP_SYS_ACL_VALID,
171	SMB_VFS_OP_SYS_ACL_SET_FILE,
172	SMB_VFS_OP_SYS_ACL_SET_FD,
173	SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
174	SMB_VFS_OP_SYS_ACL_GET_PERM,
175	SMB_VFS_OP_SYS_ACL_FREE_TEXT,
176	SMB_VFS_OP_SYS_ACL_FREE_ACL,
177	SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
178
179	/* EA operations. */
180	SMB_VFS_OP_GETXATTR,
181	SMB_VFS_OP_LGETXATTR,
182	SMB_VFS_OP_FGETXATTR,
183	SMB_VFS_OP_LISTXATTR,
184	SMB_VFS_OP_LLISTXATTR,
185	SMB_VFS_OP_FLISTXATTR,
186	SMB_VFS_OP_REMOVEXATTR,
187	SMB_VFS_OP_LREMOVEXATTR,
188	SMB_VFS_OP_FREMOVEXATTR,
189	SMB_VFS_OP_SETXATTR,
190	SMB_VFS_OP_LSETXATTR,
191	SMB_VFS_OP_FSETXATTR,
192
193	/* This should always be last enum value */
194
195	SMB_VFS_OP_LAST
196} vfs_op_type;
197
198/*
199    Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
200*/
201struct vfs_ops {
202	struct vfs_fn_pointers {
203		/* Disk operations */
204
205		int (*connect)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *service, const char *user);
206		void (*disconnect)(struct vfs_handle_struct *handle, struct connection_struct *conn);
207		SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, BOOL small_query, SMB_BIG_UINT *bsize,
208			SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
209		int (*get_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
210		int (*set_quota)(struct vfs_handle_struct *handle, struct connection_struct *conn, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
211		int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, BOOL labels);
212
213		/* Directory operations */
214
215		DIR *(*opendir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname);
216		SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
217		void (*seekdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp, long offset);
218		long (*telldir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
219		void (*rewind_dir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dirp);
220		int (*mkdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
221		int (*rmdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
222		int (*closedir)(struct vfs_handle_struct *handle, struct connection_struct *conn, DIR *dir);
223
224		/* File operations */
225
226		int (*open)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, int flags, mode_t mode);
227		int (*close)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
228		ssize_t (*read)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n);
229        /* Foxconn added start pling 11/18/2009 */
230		//ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_OFF_T offset);
231		ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, void *data, size_t n, SMB_BIG_UINT offset);
232        /* Foxconn added end pling 11/18/2009 */
233		ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n);
234        /* Foxconn added start pling 11/18/2009 */
235		//ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_OFF_T offset);
236		//SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset, int whence);
237		ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, const void *data, size_t n, SMB_BIG_UINT offset);
238		SMB_BIG_UINT (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_BIG_UINT offset, int whence);
239        /* Foxconn added end pling 11/18/2009 */
240		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);
241		int (*rename)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *old, const char *new);
242		int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
243		int (*stat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf);
244		int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf);
245		int (*lstat)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf);
246		int (*unlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
247		int (*chmod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode);
248		int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
249		int (*chown)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, uid_t uid, gid_t gid);
250		int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uid_t uid, gid_t gid);
251		int (*chdir)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
252		char *(*getwd)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *buf);
253		int (*utime)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, struct utimbuf *times);
254		int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_OFF_T offset);
255		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);
256		int (*symlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
257		int (*readlink)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *buf, size_t bufsiz);
258		int (*link)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *oldpath, const char *newpath);
259		int (*mknod)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev);
260		char *(*realpath)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path, char *resolved_path);
261
262		/* NT ACL operations. */
263
264		size_t (*fget_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd,  uint32 security_info, struct security_descriptor_info **ppdesc);
265		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);
266		BOOL (*fset_nt_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd);
267		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);
268
269		/* POSIX ACL operations. */
270
271		int (*chmod_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *name, mode_t mode);
272		int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, mode_t mode);
273
274		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);
275		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);
276		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);
277		void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d);
278		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);
279		SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd);
280		int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset);
281		int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
282		char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen);
283		SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, struct connection_struct *conn, int count);
284		int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
285		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);
286		int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual);
287		int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
288		int (*sys_acl_valid)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T theacl );
289		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);
290		int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, int fd, SMB_ACL_T theacl);
291		int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, struct connection_struct *conn, const char *path);
292		int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
293		int (*sys_acl_free_text)(struct vfs_handle_struct *handle, struct connection_struct *conn, char *text);
294		int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, struct connection_struct *conn, SMB_ACL_T posix_acl);
295		int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype);
296
297		/* EA operations. */
298		ssize_t (*getxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
299		ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,struct connection_struct *conn,const char *path, const char *name, void *value, size_t size);
300		ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, const char *name, void *value, size_t size);
301		ssize_t (*listxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
302		ssize_t (*llistxattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, char *list, size_t size);
303		ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int fd, char *list, size_t size);
304		int (*removexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
305		int (*lremovexattr)(struct vfs_handle_struct *handle, struct connection_struct *conn,const char *path, const char *name);
306		int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name);
307		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);
308		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);
309		int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp,int filedes, const char *name, const void *value, size_t size, int flags);
310
311	} ops;
312
313	struct vfs_handles_pointers {
314		/* Disk operations */
315
316		struct vfs_handle_struct *connect;
317		struct vfs_handle_struct *disconnect;
318		struct vfs_handle_struct *disk_free;
319		struct vfs_handle_struct *get_quota;
320		struct vfs_handle_struct *set_quota;
321		struct vfs_handle_struct *get_shadow_copy_data;
322
323		/* Directory operations */
324
325		struct vfs_handle_struct *opendir;
326		struct vfs_handle_struct *readdir;
327		struct vfs_handle_struct *seekdir;
328		struct vfs_handle_struct *telldir;
329		struct vfs_handle_struct *rewind_dir;
330		struct vfs_handle_struct *mkdir;
331		struct vfs_handle_struct *rmdir;
332		struct vfs_handle_struct *closedir;
333
334		/* File operations */
335
336		struct vfs_handle_struct *open;
337		struct vfs_handle_struct *close;
338		struct vfs_handle_struct *read;
339		struct vfs_handle_struct *pread;
340		struct vfs_handle_struct *write;
341		struct vfs_handle_struct *pwrite;
342		struct vfs_handle_struct *lseek;
343		struct vfs_handle_struct *sendfile;
344		struct vfs_handle_struct *rename;
345		struct vfs_handle_struct *fsync;
346		struct vfs_handle_struct *stat;
347		struct vfs_handle_struct *fstat;
348		struct vfs_handle_struct *lstat;
349		struct vfs_handle_struct *unlink;
350		struct vfs_handle_struct *chmod;
351		struct vfs_handle_struct *fchmod;
352		struct vfs_handle_struct *chown;
353		struct vfs_handle_struct *fchown;
354		struct vfs_handle_struct *chdir;
355		struct vfs_handle_struct *getwd;
356		struct vfs_handle_struct *utime;
357		struct vfs_handle_struct *ftruncate;
358		struct vfs_handle_struct *lock;
359		struct vfs_handle_struct *symlink;
360		struct vfs_handle_struct *readlink;
361		struct vfs_handle_struct *link;
362		struct vfs_handle_struct *mknod;
363		struct vfs_handle_struct *realpath;
364
365		/* NT ACL operations. */
366
367		struct vfs_handle_struct *fget_nt_acl;
368		struct vfs_handle_struct *get_nt_acl;
369		struct vfs_handle_struct *fset_nt_acl;
370		struct vfs_handle_struct *set_nt_acl;
371
372		/* POSIX ACL operations. */
373
374		struct vfs_handle_struct *chmod_acl;
375		struct vfs_handle_struct *fchmod_acl;
376
377		struct vfs_handle_struct *sys_acl_get_entry;
378		struct vfs_handle_struct *sys_acl_get_tag_type;
379		struct vfs_handle_struct *sys_acl_get_permset;
380		struct vfs_handle_struct *sys_acl_get_qualifier;
381		struct vfs_handle_struct *sys_acl_get_file;
382		struct vfs_handle_struct *sys_acl_get_fd;
383		struct vfs_handle_struct *sys_acl_clear_perms;
384		struct vfs_handle_struct *sys_acl_add_perm;
385		struct vfs_handle_struct *sys_acl_to_text;
386		struct vfs_handle_struct *sys_acl_init;
387		struct vfs_handle_struct *sys_acl_create_entry;
388		struct vfs_handle_struct *sys_acl_set_tag_type;
389		struct vfs_handle_struct *sys_acl_set_qualifier;
390		struct vfs_handle_struct *sys_acl_set_permset;
391		struct vfs_handle_struct *sys_acl_valid;
392		struct vfs_handle_struct *sys_acl_set_file;
393		struct vfs_handle_struct *sys_acl_set_fd;
394		struct vfs_handle_struct *sys_acl_delete_def_file;
395		struct vfs_handle_struct *sys_acl_get_perm;
396		struct vfs_handle_struct *sys_acl_free_text;
397		struct vfs_handle_struct *sys_acl_free_acl;
398		struct vfs_handle_struct *sys_acl_free_qualifier;
399
400		/* EA operations. */
401		struct vfs_handle_struct *getxattr;
402		struct vfs_handle_struct *lgetxattr;
403		struct vfs_handle_struct *fgetxattr;
404		struct vfs_handle_struct *listxattr;
405		struct vfs_handle_struct *llistxattr;
406		struct vfs_handle_struct *flistxattr;
407		struct vfs_handle_struct *removexattr;
408		struct vfs_handle_struct *lremovexattr;
409		struct vfs_handle_struct *fremovexattr;
410		struct vfs_handle_struct *setxattr;
411		struct vfs_handle_struct *lsetxattr;
412		struct vfs_handle_struct *fsetxattr;
413
414	} handles;
415};
416
417/*
418    Possible VFS operation layers (per-operation)
419
420    These values are used by VFS subsystem when building vfs_ops for connection
421    from multiple VFS modules. Internally, Samba differentiates only opaque and
422    transparent layers at this process. Other types are used for providing better
423    diagnosing facilities.
424
425    Most modules will provide transparent layers. Opaque layer is for modules
426    which implement actual file system calls (like DB-based VFS). For example,
427    default POSIX VFS which is built in into Samba is an opaque VFS module.
428
429    Other layer types (audit, splitter, scanner) were designed to provide different
430    degree of transparency and for diagnosing VFS module behaviour.
431
432    Each module can implement several layers at the same time provided that only
433    one layer is used per each operation.
434
435*/
436
437typedef enum _vfs_op_layer {
438	SMB_VFS_LAYER_NOOP = -1,	/* - For using in VFS module to indicate end of array */
439					/*   of operations description */
440	SMB_VFS_LAYER_OPAQUE = 0,	/* - Final level, does not call anything beyond itself */
441	SMB_VFS_LAYER_TRANSPARENT,	/* - Normal operation, calls underlying layer after */
442					/*   possibly changing passed data */
443	SMB_VFS_LAYER_LOGGER,		/* - Logs data, calls underlying layer, logging may not */
444					/*   use Samba VFS */
445	SMB_VFS_LAYER_SPLITTER,		/* - Splits operation, calls underlying layer _and_ own facility, */
446					/*   then combines result */
447	SMB_VFS_LAYER_SCANNER		/* - Checks data and possibly initiates additional */
448					/*   file activity like logging to files _inside_ samba VFS */
449} vfs_op_layer;
450
451/*
452    VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
453    which describes all operations this module is willing to intercept.
454    VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
455    using this information.
456*/
457
458typedef struct _vfs_op_tuple {
459	void* op;
460	vfs_op_type type;
461	vfs_op_layer layer;
462} vfs_op_tuple;
463
464
465typedef struct vfs_handle_struct {
466	struct vfs_handle_struct  *next, *prev;
467	const char *param;
468	struct vfs_ops vfs_next;
469	struct connection_struct *conn;
470	void *data;
471	void (*free_data)(void **data);
472} vfs_handle_struct;
473
474
475#define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
476	if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
477		DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
478		ret; \
479	} \
480}
481
482#define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
483	if (!(handle)) { \
484		DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
485		ret; \
486	} else { \
487		if ((handle)->free_data) { \
488			(handle)->free_data(&(handle)->data); \
489		} \
490		(handle)->data = (void *)datap; \
491		(handle)->free_data = free_fn; \
492	} \
493}
494
495#define SMB_VFS_HANDLE_FREE_DATA(handle) { \
496	if ((handle) && (handle)->free_data) { \
497		(handle)->free_data(&(handle)->data); \
498	} \
499}
500
501/* Check whether module-specific data handle was already allocated or not */
502#define SMB_VFS_HANDLE_TEST_DATA(handle)  ( !(handle) || !(handle)->data ? False : True )
503
504#define SMB_VFS_OP(x) ((void *) x)
505
506
507#include "vfs_macros.h"
508
509#endif /* _VFS_H */
510