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