source: vendor/3.6.0/source3/include/vfs.h

Last change on this file was 740, checked in by Silvan Scherrer, 13 years ago

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