source: branches/samba-3.3.x/source/include/vfs.h@ 317

Last change on this file since 317 was 206, checked in by Herwig Bauernfeind, 16 years ago

Import Samba 3.3 branch at 3.0.0 level (psmedley's port)
File size: 30.5 KB
Line 
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
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 3 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, see <http://www.gnu.org/licenses/>.
21
22 This work was sponsored by Optifacio Software Services, Inc.
23*/
24
25#ifndef _VFS_H
26#define _VFS_H
27
28/* Avoid conflict with an AIX include file */
29
30#ifdef vfs_ops
31#undef vfs_ops
32#endif
33
34/*
35 * As we're now (thanks Andrew ! :-) using file_structs and connection
36 * structs in the vfs - then anyone writing a vfs must include includes.h...
37 */
38
39/*
40 * This next constant specifies the version number of the VFS interface
41 * this smbd will load. Increment this if *ANY* changes are made to the
42 * vfs_ops below. JRA.
43 *
44 * If you change anything here, please also update modules/vfs_full_audit.c.
45 * VL.
46 */
47
48/* Changed to version 2 for CIFS UNIX extensions (mknod and link added). JRA. */
49/* Changed to version 3 for POSIX acl extensions. JRA. */
50/* Changed to version 4 for cascaded VFS interface. Alexander Bokovoy. */
51/* Changed to version 5 for sendfile addition. JRA. */
52/* Changed to version 6 for the new module system, fixed cascading and quota functions. --metze */
53/* Changed to version 7 to include the get_nt_acl info parameter. JRA. */
54/* Changed to version 8 includes EA calls. JRA. */
55/* Changed to version 9 to include the get_shadow_data call. --metze */
56/* Changed to version 10 to include pread/pwrite calls. */
57/* Changed to version 11 to include seekdir/telldir/rewinddir calls. JRA */
58/* Changed to version 12 to add mask and attributes to opendir(). JRA
59 Also include aio calls. JRA. */
60/* Changed to version 13 as the internal structure of files_struct has changed. JRA */
61/* Changed to version 14 as we had to change DIR to SMB_STRUCT_DIR. JRA */
62/* Changed to version 15 as we added the statvfs call. JRA */
63/* Changed to version 16 as we added the getlock call. JRA */
64/* Changed to version 17 as we removed redundant connection_struct parameters. --jpeach */
65/* Changed to version 18 to add fsp parameter to the open call -- jpeach
66 Also include kernel_flock call - jmcd */
67/* Changed to version 19, kernel change notify has been merged
68 Also included linux setlease call - jmcd */
69/* Changed to version 20, use ntimes call instead of utime (greater
70 * timestamp resolition. JRA. */
71/* Changed to version21 to add chflags operation -- jpeach */
72/* Changed to version22 to add lchown operation -- jra */
73/* Leave at 22 - not yet released. But change set_nt_acl to return an NTSTATUS. jra. */
74/* Leave at 22 - not yet released. Add file_id_create operation. --metze */
75/* Leave at 22 - not yet released. Change all BOOL parameters (int) to bool. jra. */
76/* Leave at 22 - not yet released. Added recvfile. */
77/* Leave at 22 - not yet released. Change get_nt_acl to return NTSTATUS - vl */
78/* Leave at 22 - not yet released. Change get_nt_acl to *not* take a
79 * files_struct. - obnox.*/
80/* Leave at 22 - not yet released. Remove parameter fd from fget_nt_acl. - obnox */
81/* Leave at 22 - not yet released. Remove parameter fd from gset_nt_acl. - obnox */
82/* Leave at 22 - not yet released. Remove parameter fd from pread. - obnox */
83/* Leave at 22 - not yet released. Remove parameter fd from pwrite. - obnox */
84/* Leave at 22 - not yet released. Remove parameter fd from lseek. - obnox */
85/* Leave at 22 - not yet released. Remove parameter fd from fsync. - obnox */
86/* Leave at 22 - not yet released. Remove parameter fd from fstat. - obnox */
87/* Leave at 22 - not yet released. Remove parameter fd from fchmod. - obnox */
88/* Leave at 22 - not yet released. Remove parameter fd from fchown. - obnox */
89/* Leave at 22 - not yet released. Remove parameter fd from ftruncate. - obnox */
90/* Leave at 22 - not yet released. Remove parameter fd from lock. - obnox */
91/* Leave at 22 - not yet released. Remove parameter fd from kernel_flock. - obnox */
92/* Leave at 22 - not yet released. Remove parameter fd from linux_setlease. - obnox */
93/* Leave at 22 - not yet released. Remove parameter fd from getlock. - obnox */
94/* Leave at 22 - not yet released. Remove parameter fd from sys_acl_get_fd. - obnox */
95/* Leave at 22 - not yet released. Remove parameter fd from fchmod_acl. - obnox */
96/* Leave at 22 - not yet released. Remove parameter fd from sys_acl_set_fd. - obnox */
97/* Leave at 22 - not yet released. Remove parameter fd from fgetxattr. - obnox */
98/* Leave at 22 - not yet released. Remove parameter fd from flistxattr. - obnox */
99/* Leave at 22 - not yet released. Remove parameter fd from fremovexattr. - obnox */
100/* Leave at 22 - not yet released. Remove parameter fd from fsetxattr. - obnox */
101/* Leave at 22 - not yet released. Remove parameter fd from aio_cancel. - obnox */
102/* Leave at 22 - not yet released. Remove parameter fd from read. - obnox */
103/* Leave at 22 - not yet released. Remove parameter fd from write. - obnox */
104/* Leave at 22 - not yet released. Remove parameter fromfd from sendfile. - obnox */
105/* Leave at 22 - not yet released. Remove parameter fromfd from recvfile. - obnox */
106/* Leave at 22 - not yet released. Additional change: add operations for offline files -- ab */
107/* Leave at 22 - not yet released. Add the streaminfo call. -- jpeach, vl */
108/* Leave at 22 - not yet released. Remove parameter fd from close_fn. - obnox */
109/* Changed to version 23 - remove set_nt_acl call. This can only be done via an
110 open handle. JRA. */
111/* Changed to version 24 - make security descriptor const in fset_nt_acl. JRA. */
112
113#define SMB_VFS_INTERFACE_VERSION 24
114
115
116/* to bug old modules which are trying to compile with the old functions */
117#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 };
118#define lp_parm_string __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string { \
119 __ERROR_please_port_lp_parm_string_to_lp_parm_const_string_or_lp_parm_talloc_string };
120#define lp_vfs_options __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead { \
121 __ERROR_please_donot_use_lp_vfs_options_anymore_use_lp_parm_xxxx_functions_instead };
122
123/*
124 All intercepted VFS operations must be declared as static functions inside module source
125 in order to keep smbd namespace unpolluted. See source of audit, extd_audit, fake_perms and recycle
126 example VFS modules for more details.
127*/
128
129/* VFS operations structure */
130
131struct vfs_handle_struct;
132struct connection_struct;
133struct files_struct;
134struct security_descriptor;
135struct vfs_statvfs_struct;
136
137/*
138 Available VFS operations. These values must be in sync with vfs_ops struct
139 (struct vfs_fn_pointers and struct vfs_handle_pointers inside of struct vfs_ops).
140 In particular, if new operations are added to vfs_ops, appropriate constants
141 should be added to vfs_op_type so that order of them kept same as in vfs_ops.
142*/
143
144typedef enum _vfs_op_type {
145 SMB_VFS_OP_NOOP = -1,
146
147 /* Disk operations */
148
149 SMB_VFS_OP_CONNECT = 0,
150 SMB_VFS_OP_DISCONNECT,
151 SMB_VFS_OP_DISK_FREE,
152 SMB_VFS_OP_GET_QUOTA,
153 SMB_VFS_OP_SET_QUOTA,
154 SMB_VFS_OP_GET_SHADOW_COPY_DATA,
155 SMB_VFS_OP_STATVFS,
156 SMB_VFS_OP_FS_CAPABILITIES,
157
158 /* Directory operations */
159
160 SMB_VFS_OP_OPENDIR,
161 SMB_VFS_OP_READDIR,
162 SMB_VFS_OP_SEEKDIR,
163 SMB_VFS_OP_TELLDIR,
164 SMB_VFS_OP_REWINDDIR,
165 SMB_VFS_OP_MKDIR,
166 SMB_VFS_OP_RMDIR,
167 SMB_VFS_OP_CLOSEDIR,
168
169 /* File operations */
170
171 SMB_VFS_OP_OPEN,
172 SMB_VFS_OP_CLOSE,
173 SMB_VFS_OP_READ,
174 SMB_VFS_OP_PREAD,
175 SMB_VFS_OP_WRITE,
176 SMB_VFS_OP_PWRITE,
177 SMB_VFS_OP_LSEEK,
178 SMB_VFS_OP_SENDFILE,
179 SMB_VFS_OP_RECVFILE,
180 SMB_VFS_OP_RENAME,
181 SMB_VFS_OP_FSYNC,
182 SMB_VFS_OP_STAT,
183 SMB_VFS_OP_FSTAT,
184 SMB_VFS_OP_LSTAT,
185 SMB_VFS_OP_UNLINK,
186 SMB_VFS_OP_CHMOD,
187 SMB_VFS_OP_FCHMOD,
188 SMB_VFS_OP_CHOWN,
189 SMB_VFS_OP_FCHOWN,
190 SMB_VFS_OP_LCHOWN,
191 SMB_VFS_OP_CHDIR,
192 SMB_VFS_OP_GETWD,
193 SMB_VFS_OP_NTIMES,
194 SMB_VFS_OP_FTRUNCATE,
195 SMB_VFS_OP_LOCK,
196 SMB_VFS_OP_KERNEL_FLOCK,
197 SMB_VFS_OP_LINUX_SETLEASE,
198 SMB_VFS_OP_GETLOCK,
199 SMB_VFS_OP_SYMLINK,
200 SMB_VFS_OP_READLINK,
201 SMB_VFS_OP_LINK,
202 SMB_VFS_OP_MKNOD,
203 SMB_VFS_OP_REALPATH,
204 SMB_VFS_OP_NOTIFY_WATCH,
205 SMB_VFS_OP_CHFLAGS,
206 SMB_VFS_OP_FILE_ID_CREATE,
207 SMB_VFS_OP_STREAMINFO,
208 SMB_VFS_OP_GET_REAL_FILENAME,
209
210 /* NT ACL operations. */
211
212 SMB_VFS_OP_FGET_NT_ACL,
213 SMB_VFS_OP_GET_NT_ACL,
214 SMB_VFS_OP_FSET_NT_ACL,
215
216 /* POSIX ACL operations. */
217
218 SMB_VFS_OP_CHMOD_ACL,
219 SMB_VFS_OP_FCHMOD_ACL,
220
221 SMB_VFS_OP_SYS_ACL_GET_ENTRY,
222 SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE,
223 SMB_VFS_OP_SYS_ACL_GET_PERMSET,
224 SMB_VFS_OP_SYS_ACL_GET_QUALIFIER,
225 SMB_VFS_OP_SYS_ACL_GET_FILE,
226 SMB_VFS_OP_SYS_ACL_GET_FD,
227 SMB_VFS_OP_SYS_ACL_CLEAR_PERMS,
228 SMB_VFS_OP_SYS_ACL_ADD_PERM,
229 SMB_VFS_OP_SYS_ACL_TO_TEXT,
230 SMB_VFS_OP_SYS_ACL_INIT,
231 SMB_VFS_OP_SYS_ACL_CREATE_ENTRY,
232 SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE,
233 SMB_VFS_OP_SYS_ACL_SET_QUALIFIER,
234 SMB_VFS_OP_SYS_ACL_SET_PERMSET,
235 SMB_VFS_OP_SYS_ACL_VALID,
236 SMB_VFS_OP_SYS_ACL_SET_FILE,
237 SMB_VFS_OP_SYS_ACL_SET_FD,
238 SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE,
239 SMB_VFS_OP_SYS_ACL_GET_PERM,
240 SMB_VFS_OP_SYS_ACL_FREE_TEXT,
241 SMB_VFS_OP_SYS_ACL_FREE_ACL,
242 SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER,
243
244 /* EA operations. */
245 SMB_VFS_OP_GETXATTR,
246 SMB_VFS_OP_LGETXATTR,
247 SMB_VFS_OP_FGETXATTR,
248 SMB_VFS_OP_LISTXATTR,
249 SMB_VFS_OP_LLISTXATTR,
250 SMB_VFS_OP_FLISTXATTR,
251 SMB_VFS_OP_REMOVEXATTR,
252 SMB_VFS_OP_LREMOVEXATTR,
253 SMB_VFS_OP_FREMOVEXATTR,
254 SMB_VFS_OP_SETXATTR,
255 SMB_VFS_OP_LSETXATTR,
256 SMB_VFS_OP_FSETXATTR,
257
258 /* aio operations */
259 SMB_VFS_OP_AIO_READ,
260 SMB_VFS_OP_AIO_WRITE,
261 SMB_VFS_OP_AIO_RETURN,
262 SMB_VFS_OP_AIO_CANCEL,
263 SMB_VFS_OP_AIO_ERROR,
264 SMB_VFS_OP_AIO_FSYNC,
265 SMB_VFS_OP_AIO_SUSPEND,
266 SMB_VFS_OP_AIO_FORCE,
267
268 /* offline operations */
269 SMB_VFS_OP_IS_OFFLINE,
270 SMB_VFS_OP_SET_OFFLINE,
271
272 /* This should always be last enum value */
273
274 SMB_VFS_OP_LAST
275} vfs_op_type;
276
277/*
278 Please keep vfs_op_type, struct vfs_fn_pointers and struct vfs_handles_pointers in sync.
279*/
280struct vfs_ops {
281 struct vfs_fn_pointers {
282 /* Disk operations */
283
284 int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
285 void (*disconnect)(struct vfs_handle_struct *handle);
286 SMB_BIG_UINT (*disk_free)(struct vfs_handle_struct *handle, const char *path, bool small_query, SMB_BIG_UINT *bsize,
287 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize);
288 int (*get_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
289 int (*set_quota)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
290 int (*get_shadow_copy_data)(struct vfs_handle_struct *handle, struct files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels);
291 int (*statvfs)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
292 uint32_t (*fs_capabilities)(struct vfs_handle_struct *handle);
293
294 /* Directory operations */
295
296 SMB_STRUCT_DIR *(*opendir)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
297 SMB_STRUCT_DIRENT *(*readdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
298 void (*seekdir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset);
299 long (*telldir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
300 void (*rewind_dir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp);
301 int (*mkdir)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
302 int (*rmdir)(struct vfs_handle_struct *handle, const char *path);
303 int (*closedir)(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dir);
304
305 /* File operations */
306
307 int (*open)(struct vfs_handle_struct *handle, const char *fname, files_struct *fsp, int flags, mode_t mode);
308 int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
309 ssize_t (*vfs_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
310 ssize_t (*pread)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, SMB_OFF_T offset);
311 ssize_t (*write)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
312 ssize_t (*pwrite)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset);
313 SMB_OFF_T (*lseek)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset, int whence);
314 ssize_t (*sendfile)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, SMB_OFF_T offset, size_t count);
315 ssize_t (*recvfile)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t count);
316 int (*rename)(struct vfs_handle_struct *handle, const char *oldname, const char *newname);
317 int (*fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp);
318 int (*stat)(struct vfs_handle_struct *handle, const char *fname, SMB_STRUCT_STAT *sbuf);
319 int (*fstat)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
320 int (*lstat)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
321 int (*unlink)(struct vfs_handle_struct *handle, const char *path);
322 int (*chmod)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
323 int (*fchmod)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
324 int (*chown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
325 int (*fchown)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
326 int (*lchown)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
327 int (*chdir)(struct vfs_handle_struct *handle, const char *path);
328 char *(*getwd)(struct vfs_handle_struct *handle, char *buf);
329 int (*ntimes)(struct vfs_handle_struct *handle, const char *path, const struct timespec ts[2]);
330 int (*ftruncate)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T offset);
331 bool (*lock)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type);
332 int (*kernel_flock)(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode);
333 int (*linux_setlease)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
334 bool (*getlock)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid);
335 int (*symlink)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
336 int (*vfs_readlink)(struct vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz);
337 int (*link)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
338 int (*mknod)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
339 char *(*realpath)(struct vfs_handle_struct *handle, const char *path, char *resolved_path);
340 NTSTATUS (*notify_watch)(struct vfs_handle_struct *handle,
341 struct sys_notify_context *ctx,
342 struct notify_entry *e,
343 void (*callback)(struct sys_notify_context *ctx,
344 void *private_data,
345 struct notify_event *ev),
346 void *private_data, void *handle_p);
347 int (*chflags)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
348 struct file_id (*file_id_create)(struct vfs_handle_struct *handle, SMB_DEV_T dev, SMB_INO_T inode);
349
350 NTSTATUS (*streaminfo)(struct vfs_handle_struct *handle,
351 struct files_struct *fsp,
352 const char *fname,
353 TALLOC_CTX *mem_ctx,
354 unsigned int *num_streams,
355 struct stream_struct **streams);
356
357 int (*get_real_filename)(struct vfs_handle_struct *handle,
358 const char *path,
359 const char *name,
360 TALLOC_CTX *mem_ctx,
361 char **found_name);
362
363 /* NT ACL operations. */
364
365 NTSTATUS (*fget_nt_acl)(struct vfs_handle_struct *handle,
366 struct files_struct *fsp,
367 uint32 security_info,
368 struct security_descriptor **ppdesc);
369 NTSTATUS (*get_nt_acl)(struct vfs_handle_struct *handle,
370 const char *name,
371 uint32 security_info,
372 struct security_descriptor **ppdesc);
373 NTSTATUS (*fset_nt_acl)(struct vfs_handle_struct *handle,
374 struct files_struct *fsp,
375 uint32 security_info_sent,
376 const struct security_descriptor *psd);
377
378 /* POSIX ACL operations. */
379
380 int (*chmod_acl)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
381 int (*fchmod_acl)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
382
383 int (*sys_acl_get_entry)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
384 int (*sys_acl_get_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
385 int (*sys_acl_get_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
386 void * (*sys_acl_get_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
387 SMB_ACL_T (*sys_acl_get_file)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
388 SMB_ACL_T (*sys_acl_get_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp);
389 int (*sys_acl_clear_perms)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
390 int (*sys_acl_add_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
391 char * (*sys_acl_to_text)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
392 SMB_ACL_T (*sys_acl_init)(struct vfs_handle_struct *handle, int count);
393 int (*sys_acl_create_entry)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
394 int (*sys_acl_set_tag_type)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
395 int (*sys_acl_set_qualifier)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
396 int (*sys_acl_set_permset)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
397 int (*sys_acl_valid)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
398 int (*sys_acl_set_file)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
399 int (*sys_acl_set_fd)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
400 int (*sys_acl_delete_def_file)(struct vfs_handle_struct *handle, const char *path);
401 int (*sys_acl_get_perm)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
402 int (*sys_acl_free_text)(struct vfs_handle_struct *handle, char *text);
403 int (*sys_acl_free_acl)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
404 int (*sys_acl_free_qualifier)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
405
406 /* EA operations. */
407 ssize_t (*getxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
408 ssize_t (*lgetxattr)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
409 ssize_t (*fgetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size);
410 ssize_t (*listxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
411 ssize_t (*llistxattr)(struct vfs_handle_struct *handle, const char *path, char *list, size_t size);
412 ssize_t (*flistxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size);
413 int (*removexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
414 int (*lremovexattr)(struct vfs_handle_struct *handle, const char *path, const char *name);
415 int (*fremovexattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name);
416 int (*setxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
417 int (*lsetxattr)(struct vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags);
418 int (*fsetxattr)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
419
420 /* aio operations */
421 int (*aio_read)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
422 int (*aio_write)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
423 ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
424 int (*aio_cancel)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
425 int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
426 int (*aio_fsync)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
427 int (*aio_suspend)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
428 bool (*aio_force)(struct vfs_handle_struct *handle, struct files_struct *fsp);
429
430 /* offline operations */
431 bool (*is_offline)(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf);
432 int (*set_offline)(struct vfs_handle_struct *handle, const char *path);
433 } ops;
434
435 struct vfs_handles_pointers {
436 /* Disk operations */
437
438 struct vfs_handle_struct *connect_hnd;
439 struct vfs_handle_struct *disconnect;
440 struct vfs_handle_struct *disk_free;
441 struct vfs_handle_struct *get_quota;
442 struct vfs_handle_struct *set_quota;
443 struct vfs_handle_struct *get_shadow_copy_data;
444 struct vfs_handle_struct *statvfs;
445 struct vfs_handle_struct *fs_capabilities;
446
447 /* Directory operations */
448
449 struct vfs_handle_struct *opendir;
450 struct vfs_handle_struct *readdir;
451 struct vfs_handle_struct *seekdir;
452 struct vfs_handle_struct *telldir;
453 struct vfs_handle_struct *rewind_dir;
454 struct vfs_handle_struct *mkdir;
455 struct vfs_handle_struct *rmdir;
456 struct vfs_handle_struct *closedir;
457
458 /* File operations */
459
460 struct vfs_handle_struct *open;
461 struct vfs_handle_struct *close_hnd;
462 struct vfs_handle_struct *vfs_read;
463 struct vfs_handle_struct *pread;
464 struct vfs_handle_struct *write;
465 struct vfs_handle_struct *pwrite;
466 struct vfs_handle_struct *lseek;
467 struct vfs_handle_struct *sendfile;
468 struct vfs_handle_struct *recvfile;
469 struct vfs_handle_struct *rename;
470 struct vfs_handle_struct *fsync;
471 struct vfs_handle_struct *stat;
472 struct vfs_handle_struct *fstat;
473 struct vfs_handle_struct *lstat;
474 struct vfs_handle_struct *unlink;
475 struct vfs_handle_struct *chmod;
476 struct vfs_handle_struct *fchmod;
477 struct vfs_handle_struct *chown;
478 struct vfs_handle_struct *fchown;
479 struct vfs_handle_struct *lchown;
480 struct vfs_handle_struct *chdir;
481 struct vfs_handle_struct *getwd;
482 struct vfs_handle_struct *ntimes;
483 struct vfs_handle_struct *ftruncate;
484 struct vfs_handle_struct *lock;
485 struct vfs_handle_struct *kernel_flock;
486 struct vfs_handle_struct *linux_setlease;
487 struct vfs_handle_struct *getlock;
488 struct vfs_handle_struct *symlink;
489 struct vfs_handle_struct *vfs_readlink;
490 struct vfs_handle_struct *link;
491 struct vfs_handle_struct *mknod;
492 struct vfs_handle_struct *realpath;
493 struct vfs_handle_struct *notify_watch;
494 struct vfs_handle_struct *chflags;
495 struct vfs_handle_struct *file_id_create;
496 struct vfs_handle_struct *streaminfo;
497 struct vfs_handle_struct *get_real_filename;
498
499 /* NT ACL operations. */
500
501 struct vfs_handle_struct *fget_nt_acl;
502 struct vfs_handle_struct *get_nt_acl;
503 struct vfs_handle_struct *fset_nt_acl;
504
505 /* POSIX ACL operations. */
506
507 struct vfs_handle_struct *chmod_acl;
508 struct vfs_handle_struct *fchmod_acl;
509
510 struct vfs_handle_struct *sys_acl_get_entry;
511 struct vfs_handle_struct *sys_acl_get_tag_type;
512 struct vfs_handle_struct *sys_acl_get_permset;
513 struct vfs_handle_struct *sys_acl_get_qualifier;
514 struct vfs_handle_struct *sys_acl_get_file;
515 struct vfs_handle_struct *sys_acl_get_fd;
516 struct vfs_handle_struct *sys_acl_clear_perms;
517 struct vfs_handle_struct *sys_acl_add_perm;
518 struct vfs_handle_struct *sys_acl_to_text;
519 struct vfs_handle_struct *sys_acl_init;
520 struct vfs_handle_struct *sys_acl_create_entry;
521 struct vfs_handle_struct *sys_acl_set_tag_type;
522 struct vfs_handle_struct *sys_acl_set_qualifier;
523 struct vfs_handle_struct *sys_acl_set_permset;
524 struct vfs_handle_struct *sys_acl_valid;
525 struct vfs_handle_struct *sys_acl_set_file;
526 struct vfs_handle_struct *sys_acl_set_fd;
527 struct vfs_handle_struct *sys_acl_delete_def_file;
528 struct vfs_handle_struct *sys_acl_get_perm;
529 struct vfs_handle_struct *sys_acl_free_text;
530 struct vfs_handle_struct *sys_acl_free_acl;
531 struct vfs_handle_struct *sys_acl_free_qualifier;
532
533 /* EA operations. */
534 struct vfs_handle_struct *getxattr;
535 struct vfs_handle_struct *lgetxattr;
536 struct vfs_handle_struct *fgetxattr;
537 struct vfs_handle_struct *listxattr;
538 struct vfs_handle_struct *llistxattr;
539 struct vfs_handle_struct *flistxattr;
540 struct vfs_handle_struct *removexattr;
541 struct vfs_handle_struct *lremovexattr;
542 struct vfs_handle_struct *fremovexattr;
543 struct vfs_handle_struct *setxattr;
544 struct vfs_handle_struct *lsetxattr;
545 struct vfs_handle_struct *fsetxattr;
546
547 /* aio operations */
548 struct vfs_handle_struct *aio_read;
549 struct vfs_handle_struct *aio_write;
550 struct vfs_handle_struct *aio_return;
551 struct vfs_handle_struct *aio_cancel;
552 struct vfs_handle_struct *aio_error;
553 struct vfs_handle_struct *aio_fsync;
554 struct vfs_handle_struct *aio_suspend;
555 struct vfs_handle_struct *aio_force;
556
557 /* offline operations */
558 struct vfs_handle_struct *is_offline;
559 struct vfs_handle_struct *set_offline;
560 } handles;
561};
562
563/*
564 Possible VFS operation layers (per-operation)
565
566 These values are used by VFS subsystem when building vfs_ops for connection
567 from multiple VFS modules. Internally, Samba differentiates only opaque and
568 transparent layers at this process. Other types are used for providing better
569 diagnosing facilities.
570
571 Most modules will provide transparent layers. Opaque layer is for modules
572 which implement actual file system calls (like DB-based VFS). For example,
573 default POSIX VFS which is built in into Samba is an opaque VFS module.
574
575 Other layer types (audit, splitter, scanner) were designed to provide different
576 degree of transparency and for diagnosing VFS module behaviour.
577
578 Each module can implement several layers at the same time provided that only
579 one layer is used per each operation.
580
581*/
582
583typedef enum _vfs_op_layer {
584 SMB_VFS_LAYER_NOOP = -1, /* - For using in VFS module to indicate end of array */
585 /* of operations description */
586 SMB_VFS_LAYER_OPAQUE = 0, /* - Final level, does not call anything beyond itself */
587 SMB_VFS_LAYER_TRANSPARENT, /* - Normal operation, calls underlying layer after */
588 /* possibly changing passed data */
589 SMB_VFS_LAYER_LOGGER, /* - Logs data, calls underlying layer, logging may not */
590 /* use Samba VFS */
591 SMB_VFS_LAYER_SPLITTER, /* - Splits operation, calls underlying layer _and_ own facility, */
592 /* then combines result */
593 SMB_VFS_LAYER_SCANNER /* - Checks data and possibly initiates additional */
594 /* file activity like logging to files _inside_ samba VFS */
595} vfs_op_layer;
596
597/*
598 VFS operation description. Each VFS module registers an array of vfs_op_tuple to VFS subsystem,
599 which describes all operations this module is willing to intercept.
600 VFS subsystem initializes then the conn->vfs_ops and conn->vfs_opaque_ops structs
601 using this information.
602*/
603
604typedef struct vfs_op_tuple {
605 void* op;
606 vfs_op_type type;
607 vfs_op_layer layer;
608} vfs_op_tuple;
609
610
611typedef struct vfs_handle_struct {
612 struct vfs_handle_struct *next, *prev;
613 const char *param;
614 struct vfs_ops vfs_next;
615 struct connection_struct *conn;
616 void *data;
617 void (*free_data)(void **data);
618} vfs_handle_struct;
619
620
621typedef struct vfs_statvfs_struct {
622 /* For undefined recommended transfer size return -1 in that field */
623 uint32 OptimalTransferSize; /* bsize on some os, iosize on other os */
624 uint32 BlockSize;
625
626 /*
627 The next three fields are in terms of the block size.
628 (above). If block size is unknown, 4096 would be a
629 reasonable block size for a server to report.
630 Note that returning the blocks/blocksavail removes need
631 to make a second call (to QFSInfo level 0x103 to get this info.
632 UserBlockAvail is typically less than or equal to BlocksAvail,
633 if no distinction is made return the same value in each.
634 */
635
636 SMB_BIG_UINT TotalBlocks;
637 SMB_BIG_UINT BlocksAvail; /* bfree */
638 SMB_BIG_UINT UserBlocksAvail; /* bavail */
639
640 /* For undefined Node fields or FSID return -1 */
641 SMB_BIG_UINT TotalFileNodes;
642 SMB_BIG_UINT FreeFileNodes;
643 SMB_BIG_UINT FsIdentifier; /* fsid */
644 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
645 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
646
647 int FsCapabilities;
648} vfs_statvfs_struct;
649
650/* Add a new FSP extension of the given type. Returns a pointer to the
651 * extenstion data.
652 */
653#define VFS_ADD_FSP_EXTENSION(handle, fsp, type) \
654 vfs_add_fsp_extension_notype(handle, (fsp), sizeof(type))
655
656/* Return a pointer to the existing FSP extension data. */
657#define VFS_FETCH_FSP_EXTENSION(handle, fsp) \
658 vfs_fetch_fsp_extension(handle, (fsp))
659
660/* Return the talloc context associated with an FSP extension. */
661#define VFS_MEMCTX_FSP_EXTENSION(handle, fsp) \
662 vfs_memctx_fsp_extension(handle, (fsp))
663
664/* Remove and destroy an FSP extension. */
665#define VFS_REMOVE_FSP_EXTENSION(handle, fsp) \
666 vfs_remove_fsp_extension((handle), (fsp))
667
668#define SMB_VFS_HANDLE_GET_DATA(handle, datap, type, ret) { \
669 if (!(handle)||((datap=(type *)(handle)->data)==NULL)) { \
670 DEBUG(0,("%s() failed to get vfs_handle->data!\n",FUNCTION_MACRO)); \
671 ret; \
672 } \
673}
674
675#define SMB_VFS_HANDLE_SET_DATA(handle, datap, free_fn, type, ret) { \
676 if (!(handle)) { \
677 DEBUG(0,("%s() failed to set handle->data!\n",FUNCTION_MACRO)); \
678 ret; \
679 } else { \
680 if ((handle)->free_data) { \
681 (handle)->free_data(&(handle)->data); \
682 } \
683 (handle)->data = (void *)datap; \
684 (handle)->free_data = free_fn; \
685 } \
686}
687
688#define SMB_VFS_HANDLE_FREE_DATA(handle) { \
689 if ((handle) && (handle)->free_data) { \
690 (handle)->free_data(&(handle)->data); \
691 } \
692}
693
694/* Check whether module-specific data handle was already allocated or not */
695#define SMB_VFS_HANDLE_TEST_DATA(handle) ( !(handle) || !(handle)->data ? False : True )
696
697#define SMB_VFS_OP(x) ((void *) x)
698
699#define DEFAULT_VFS_MODULE_NAME "/[Default VFS]/"
700
701#include "vfs_macros.h"
702
703#endif /* _VFS_H */
Note: See TracBrowser for help on using the repository browser.