2 * Skeleton VFS module. Implements passthrough operation of all VFS
3 * calls to disk functions.
5 * Copyright (C) Tim Potter, 1999-2000
6 * Copyright (C) Alexander Bokovoy, 2002
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
42 static struct vfs_ops default_vfs_ops; /* For passthrough operation */
43 static struct smb_vfs_handle_struct *skel_handle; /* use skel_handle->data for storing per-instance private data */
45 static int skel_connect(struct connection_struct *conn, const char *service, const char *user)
47 return default_vfs_ops.connect(conn, service, user);
50 static void skel_disconnect(struct connection_struct *conn)
52 default_vfs_ops.disconnect(conn);
55 static SMB_BIG_UINT skel_disk_free(struct connection_struct *conn, const char *path,
56 BOOL small_query, SMB_BIG_UINT *bsize,
57 SMB_BIG_UINT *dfree, SMB_BIG_UINT *dsize)
59 return default_vfs_ops.disk_free(conn, path, small_query, bsize,
63 static DIR *skel_opendir(struct connection_struct *conn, const char *fname)
65 return default_vfs_ops.opendir(conn, fname);
68 static struct dirent *skel_readdir(struct connection_struct *conn, DIR *dirp)
70 return default_vfs_ops.readdir(conn, dirp);
73 static int skel_mkdir(struct connection_struct *conn, const char *path, mode_t mode)
75 return default_vfs_ops.mkdir(conn, path, mode);
78 static int skel_rmdir(struct connection_struct *conn, const char *path)
80 return default_vfs_ops.rmdir(conn, path);
83 static int skel_closedir(struct connection_struct *conn, DIR *dir)
85 return default_vfs_ops.closedir(conn, dir);
88 static int skel_open(struct connection_struct *conn, const char *fname, int flags, mode_t mode)
90 return default_vfs_ops.open(conn, fname, flags, mode);
93 static int skel_close(struct files_struct *fsp, int fd)
95 return default_vfs_ops.close(fsp, fd);
98 static ssize_t skel_read(struct files_struct *fsp, int fd, void *data, size_t n)
100 return default_vfs_ops.read(fsp, fd, data, n);
103 static ssize_t skel_write(struct files_struct *fsp, int fd, const void *data, size_t n)
105 return default_vfs_ops.write(fsp, fd, data, n);
108 static SMB_OFF_T skel_lseek(struct files_struct *fsp, int filedes, SMB_OFF_T offset, int whence)
110 return default_vfs_ops.lseek(fsp, filedes, offset, whence);
113 static int skel_rename(struct connection_struct *conn, const char *old, const char *new)
115 return default_vfs_ops.rename(conn, old, new);
118 static int skel_fsync(struct files_struct *fsp, int fd)
120 return default_vfs_ops.fsync(fsp, fd);
123 static int skel_stat(struct connection_struct *conn, const char *fname, SMB_STRUCT_STAT *sbuf)
125 return default_vfs_ops.stat(conn, fname, sbuf);
128 static int skel_fstat(struct files_struct *fsp, int fd, SMB_STRUCT_STAT *sbuf)
130 return default_vfs_ops.fstat(fsp, fd, sbuf);
133 static int skel_lstat(struct connection_struct *conn, const char *path, SMB_STRUCT_STAT *sbuf)
135 return default_vfs_ops.lstat(conn, path, sbuf);
138 static int skel_unlink(struct connection_struct *conn, const char *path)
140 return default_vfs_ops.unlink(conn, path);
143 static int skel_chmod(struct connection_struct *conn, const char *path, mode_t mode)
145 return default_vfs_ops.chmod(conn, path, mode);
148 static int skel_fchmod(struct files_struct *fsp, int fd, mode_t mode)
150 return default_vfs_ops.fchmod(fsp, fd, mode);
153 static int skel_chown(struct connection_struct *conn, const char *path, uid_t uid, gid_t gid)
155 return default_vfs_ops.chown(conn, path, uid, gid);
158 static int skel_fchown(struct files_struct *fsp, int fd, uid_t uid, gid_t gid)
160 return default_vfs_ops.fchown(fsp, fd, uid, gid);
163 static int skel_chdir(struct connection_struct *conn, const char *path)
165 return default_vfs_ops.chdir(conn, path);
168 static char *skel_getwd(struct connection_struct *conn, char *buf)
170 return default_vfs_ops.getwd(conn, buf);
173 static int skel_utime(struct connection_struct *conn, const char *path, struct utimbuf *times)
175 return default_vfs_ops.utime(conn, path, times);
178 static int skel_ftruncate(struct files_struct *fsp, int fd, SMB_OFF_T offset)
180 return default_vfs_ops.ftruncate(fsp, fd, offset);
183 static BOOL skel_lock(struct files_struct *fsp, int fd, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
185 return default_vfs_ops.lock(fsp, fd, op, offset, count, type);
188 static BOOL skel_symlink(struct connection_struct *conn, const char *oldpath, const char *newpath)
190 return default_vfs_ops.symlink(conn, oldpath, newpath);
193 static BOOL skel_readlink(struct connection_struct *conn, const char *path, char *buf, size_t bufsiz)
195 return default_vfs_ops.readlink(conn, path, buf, bufsiz);
198 static int skel_link(struct connection_struct *conn, const char *oldpath, const char *newpath)
200 return default_vfs_ops.link(conn, oldpath, newpath);
203 static int skel_mknod(struct connection_struct *conn, const char *path, mode_t mode, SMB_DEV_T dev)
205 return default_vfs_ops.mknod(conn, path, mode, dev);
208 static char *skel_realpath(struct connection_struct *conn, const char *path, char *resolved_path)
210 return default_vfs_ops.realpath(conn, path, resolved_path);
213 static size_t skel_fget_nt_acl(struct files_struct *fsp, int fd, struct security_descriptor_info **ppdesc)
215 return default_vfs_ops.fget_nt_acl(fsp, fd, ppdesc);
218 static size_t skel_get_nt_acl(struct files_struct *fsp, const char *name, struct security_descriptor_info **ppdesc)
220 return default_vfs_ops.get_nt_acl(fsp, name, ppdesc);
223 static BOOL skel_fset_nt_acl(struct files_struct *fsp, int fd, uint32 security_info_sent, struct security_descriptor_info *psd)
225 return default_vfs_ops.fset_nt_acl(fsp, fd, security_info_sent, psd);
228 static BOOL skel_set_nt_acl(struct files_struct *fsp, const char *name, uint32 security_info_sent, struct security_descriptor_info *psd)
230 return default_vfs_ops.set_nt_acl(fsp, name, security_info_sent, psd);
233 static BOOL skel_chmod_acl(struct connection_struct *conn, const char *name, mode_t mode)
235 /* If the underlying VFS doesn't have ACL support... */
236 if (!default_vfs_ops.chmod_acl) {
240 return default_vfs_ops.chmod_acl(conn, name, mode);
243 static BOOL skel_fchmod_acl(struct files_struct *fsp, int fd, mode_t mode)
245 /* If the underlying VFS doesn't have ACL support... */
246 if (!default_vfs_ops.fchmod_acl) {
250 return default_vfs_ops.fchmod_acl(fsp, fd, mode);
253 static int skel_sys_acl_get_entry(struct connection_struct *conn, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p)
255 return default_vfs_ops.sys_acl_get_entry(conn, theacl, entry_id, entry_p);
258 static int skel_sys_acl_get_tag_type(struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p)
260 return default_vfs_ops.sys_acl_get_tag_type(conn, entry_d, tag_type_p);
263 static int skel_sys_acl_get_permset(struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p)
265 return default_vfs_ops.sys_acl_get_permset(conn, entry_d, permset_p);
268 static void *skel_sys_acl_get_qualifier(struct connection_struct *conn, SMB_ACL_ENTRY_T entry_d)
270 return default_vfs_ops.sys_acl_get_qualifier(conn, entry_d);
273 static SMB_ACL_T skel_sys_acl_get_file(struct connection_struct *conn, const char *path_p, SMB_ACL_TYPE_T type)
275 return default_vfs_ops.sys_acl_get_file(conn, path_p, type);
278 static SMB_ACL_T skel_sys_acl_get_fd(struct files_struct *fsp, int fd)
280 return default_vfs_ops.sys_acl_get_fd(fsp, fd);
283 static int skel_sys_acl_clear_perms(struct connection_struct *conn, SMB_ACL_PERMSET_T permset)
285 return default_vfs_ops.sys_acl_clear_perms(conn, permset);
288 static int skel_sys_acl_add_perm(struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
290 return default_vfs_ops.sys_acl_add_perm(conn, permset, perm);
293 static char *skel_sys_acl_to_text(struct connection_struct *conn, SMB_ACL_T theacl, ssize_t *plen)
295 return default_vfs_ops.sys_acl_to_text(conn, theacl, plen);
298 static SMB_ACL_T skel_sys_acl_init(struct connection_struct *conn, int count)
300 return default_vfs_ops.sys_acl_init(conn, count);
303 static int skel_sys_acl_create_entry(struct connection_struct *conn, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry)
305 return default_vfs_ops.sys_acl_create_entry(conn, pacl, pentry);
308 static int skel_sys_acl_set_tag_type(struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype)
310 return default_vfs_ops.sys_acl_set_tag_type(conn, entry, tagtype);
313 static int skel_sys_acl_set_qualifier(struct connection_struct *conn, SMB_ACL_ENTRY_T entry, void *qual)
315 return default_vfs_ops.sys_acl_set_qualifier(conn, entry, qual);
318 static int skel_sys_acl_set_permset(struct connection_struct *conn, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset)
320 return default_vfs_ops.sys_acl_set_permset(conn, entry, permset);
323 static int skel_sys_acl_valid(struct connection_struct *conn, SMB_ACL_T theacl )
325 return default_vfs_ops.sys_acl_valid(conn, theacl );
328 static int skel_sys_acl_set_file(struct connection_struct *conn, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl)
330 return default_vfs_ops.sys_acl_set_file(conn, name, acltype, theacl);
333 static int skel_sys_acl_set_fd(struct files_struct *fsp, int fd, SMB_ACL_T theacl)
335 return default_vfs_ops.sys_acl_set_fd(fsp, fd, theacl);
338 static int skel_sys_acl_delete_def_file(struct connection_struct *conn, const char *path)
340 return default_vfs_ops.sys_acl_delete_def_file(conn, path);
343 static int skel_sys_acl_get_perm(struct connection_struct *conn, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
345 return default_vfs_ops.sys_acl_get_perm(conn, permset, perm);
348 static int skel_sys_acl_free_text(struct connection_struct *conn, char *text)
350 return default_vfs_ops.sys_acl_free_text(conn, text);
353 static int skel_sys_acl_free_acl(struct connection_struct *conn, SMB_ACL_T posix_acl)
355 return default_vfs_ops.sys_acl_free_acl(conn, posix_acl);
358 static int skel_sys_acl_free_qualifier(struct connection_struct *conn, void *qualifier, SMB_ACL_TAG_T tagtype)
360 return default_vfs_ops.sys_acl_free_qualifier(conn, qualifier, tagtype);
364 /* VFS operations structure */
366 static vfs_op_tuple skel_ops[] = {
368 /* Disk operations */
370 {skel_connect, SMB_VFS_OP_CONNECT, SMB_VFS_LAYER_TRANSPARENT},
371 {skel_disconnect, SMB_VFS_OP_DISCONNECT, SMB_VFS_LAYER_TRANSPARENT},
372 {skel_disk_free, SMB_VFS_OP_DISK_FREE, SMB_VFS_LAYER_TRANSPARENT},
374 /* Directory operations */
376 {skel_opendir, SMB_VFS_OP_OPENDIR, SMB_VFS_LAYER_TRANSPARENT},
377 {skel_readdir, SMB_VFS_OP_READDIR, SMB_VFS_LAYER_TRANSPARENT},
378 {skel_mkdir, SMB_VFS_OP_MKDIR, SMB_VFS_LAYER_TRANSPARENT},
379 {skel_rmdir, SMB_VFS_OP_RMDIR, SMB_VFS_LAYER_TRANSPARENT},
380 {skel_closedir, SMB_VFS_OP_CLOSEDIR, SMB_VFS_LAYER_TRANSPARENT},
382 /* File operations */
384 {skel_open, SMB_VFS_OP_OPEN, SMB_VFS_LAYER_TRANSPARENT},
385 {skel_close, SMB_VFS_OP_CLOSE, SMB_VFS_LAYER_TRANSPARENT},
386 {skel_read, SMB_VFS_OP_READ, SMB_VFS_LAYER_TRANSPARENT},
387 {skel_write, SMB_VFS_OP_WRITE, SMB_VFS_LAYER_TRANSPARENT},
388 {skel_lseek, SMB_VFS_OP_LSEEK, SMB_VFS_LAYER_TRANSPARENT},
389 {skel_rename, SMB_VFS_OP_RENAME, SMB_VFS_LAYER_TRANSPARENT},
390 {skel_fsync, SMB_VFS_OP_FSYNC, SMB_VFS_LAYER_TRANSPARENT},
391 {skel_stat, SMB_VFS_OP_STAT, SMB_VFS_LAYER_TRANSPARENT},
392 {skel_fstat, SMB_VFS_OP_FSTAT, SMB_VFS_LAYER_TRANSPARENT},
393 {skel_lstat, SMB_VFS_OP_LSTAT, SMB_VFS_LAYER_TRANSPARENT},
394 {skel_unlink, SMB_VFS_OP_UNLINK, SMB_VFS_LAYER_TRANSPARENT},
395 {skel_chmod, SMB_VFS_OP_CHMOD, SMB_VFS_LAYER_TRANSPARENT},
396 {skel_fchmod, SMB_VFS_OP_FCHMOD, SMB_VFS_LAYER_TRANSPARENT},
397 {skel_chown, SMB_VFS_OP_CHOWN, SMB_VFS_LAYER_TRANSPARENT},
398 {skel_fchown, SMB_VFS_OP_FCHOWN, SMB_VFS_LAYER_TRANSPARENT},
399 {skel_chdir, SMB_VFS_OP_CHDIR, SMB_VFS_LAYER_TRANSPARENT},
400 {skel_getwd, SMB_VFS_OP_GETWD, SMB_VFS_LAYER_TRANSPARENT},
401 {skel_utime, SMB_VFS_OP_UTIME, SMB_VFS_LAYER_TRANSPARENT},
402 {skel_ftruncate, SMB_VFS_OP_FTRUNCATE, SMB_VFS_LAYER_TRANSPARENT},
403 {skel_lock, SMB_VFS_OP_LOCK, SMB_VFS_LAYER_TRANSPARENT},
404 {skel_symlink, SMB_VFS_OP_SYMLINK, SMB_VFS_LAYER_TRANSPARENT},
405 {skel_readlink, SMB_VFS_OP_READLINK, SMB_VFS_LAYER_TRANSPARENT},
406 {skel_link, SMB_VFS_OP_LINK, SMB_VFS_LAYER_TRANSPARENT},
407 {skel_mknod, SMB_VFS_OP_MKNOD, SMB_VFS_LAYER_TRANSPARENT},
408 {skel_realpath, SMB_VFS_OP_REALPATH, SMB_VFS_LAYER_TRANSPARENT},
410 /* NT File ACL operations */
412 {skel_fget_nt_acl, SMB_VFS_OP_FGET_NT_ACL, SMB_VFS_LAYER_TRANSPARENT},
413 {skel_get_nt_acl, SMB_VFS_OP_GET_NT_ACL, SMB_VFS_LAYER_TRANSPARENT},
414 {skel_fset_nt_acl, SMB_VFS_OP_FSET_NT_ACL, SMB_VFS_LAYER_TRANSPARENT},
415 {skel_set_nt_acl, SMB_VFS_OP_SET_NT_ACL, SMB_VFS_LAYER_TRANSPARENT},
417 /* POSIX ACL operations */
419 {skel_chmod_acl, SMB_VFS_OP_CHMOD_ACL, SMB_VFS_LAYER_TRANSPARENT},
420 {skel_fchmod_acl, SMB_VFS_OP_FCHMOD_ACL, SMB_VFS_LAYER_TRANSPARENT},
422 {skel_sys_acl_get_entry, SMB_VFS_OP_SYS_ACL_GET_ENTRY, SMB_VFS_LAYER_TRANSPARENT},
423 {skel_sys_acl_get_tag_type, SMB_VFS_OP_SYS_ACL_GET_TAG_TYPE, SMB_VFS_LAYER_TRANSPARENT},
424 {skel_sys_acl_get_permset, SMB_VFS_OP_SYS_ACL_GET_PERMSET, SMB_VFS_LAYER_TRANSPARENT},
425 {skel_sys_acl_get_qualifier, SMB_VFS_OP_SYS_ACL_GET_QUALIFIER, SMB_VFS_LAYER_TRANSPARENT},
426 {skel_sys_acl_get_file, SMB_VFS_OP_SYS_ACL_GET_FILE, SMB_VFS_LAYER_TRANSPARENT},
427 {skel_sys_acl_get_fd, SMB_VFS_OP_SYS_ACL_GET_FD, SMB_VFS_LAYER_TRANSPARENT},
428 {skel_sys_acl_clear_perms, SMB_VFS_OP_SYS_ACL_CLEAR_PERMS, SMB_VFS_LAYER_TRANSPARENT},
429 {skel_sys_acl_add_perm, SMB_VFS_OP_SYS_ACL_ADD_PERM, SMB_VFS_LAYER_TRANSPARENT},
430 {skel_sys_acl_to_text, SMB_VFS_OP_SYS_ACL_TO_TEXT, SMB_VFS_LAYER_TRANSPARENT},
431 {skel_sys_acl_init, SMB_VFS_OP_SYS_ACL_INIT, SMB_VFS_LAYER_TRANSPARENT},
432 {skel_sys_acl_create_entry, SMB_VFS_OP_SYS_ACL_CREATE_ENTRY, SMB_VFS_LAYER_TRANSPARENT},
433 {skel_sys_acl_set_tag_type, SMB_VFS_OP_SYS_ACL_SET_TAG_TYPE, SMB_VFS_LAYER_TRANSPARENT},
434 {skel_sys_acl_set_qualifier, SMB_VFS_OP_SYS_ACL_SET_QUALIFIER, SMB_VFS_LAYER_TRANSPARENT},
435 {skel_sys_acl_set_permset, SMB_VFS_OP_SYS_ACL_SET_PERMSET, SMB_VFS_LAYER_TRANSPARENT},
436 {skel_sys_acl_valid, SMB_VFS_OP_SYS_ACL_VALID, SMB_VFS_LAYER_TRANSPARENT},
437 {skel_sys_acl_set_file, SMB_VFS_OP_SYS_ACL_SET_FILE, SMB_VFS_LAYER_TRANSPARENT},
438 {skel_sys_acl_set_fd, SMB_VFS_OP_SYS_ACL_SET_FD, SMB_VFS_LAYER_TRANSPARENT},
439 {skel_sys_acl_delete_def_file, SMB_VFS_OP_SYS_ACL_DELETE_DEF_FILE, SMB_VFS_LAYER_TRANSPARENT},
440 {skel_sys_acl_get_perm, SMB_VFS_OP_SYS_ACL_GET_PERM, SMB_VFS_LAYER_TRANSPARENT},
441 {skel_sys_acl_free_text, SMB_VFS_OP_SYS_ACL_FREE_TEXT, SMB_VFS_LAYER_TRANSPARENT},
442 {skel_sys_acl_free_acl, SMB_VFS_OP_SYS_ACL_FREE_ACL, SMB_VFS_LAYER_TRANSPARENT},
443 {skel_sys_acl_free_qualifier, SMB_VFS_OP_SYS_ACL_FREE_QUALIFIER, SMB_VFS_LAYER_TRANSPARENT},
445 {NULL, SMB_VFS_OP_NOOP, SMB_VFS_LAYER_NOOP}
448 /* VFS initialisation - return initialized vfs_op_tuple array back to Samba */
450 static vfs_op_tuple *skel_init(const struct vfs_ops *def_vfs_ops,
451 struct smb_vfs_handle_struct *vfs_handle)
453 DEBUG(3, ("Initialising default vfs hooks\n"));
455 memcpy(&default_vfs_ops, def_vfs_ops, sizeof(struct vfs_ops));
457 /* Remember vfs_handle for further allocation and referencing of private
458 information in vfs_handle->data
460 skel_handle = vfs_handle;
464 NTSTATUS init_module(void)
466 return smb_register_vfs("skel", skel_init, SMB_VFS_INTERFACE_VERSION);