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