2 * Skeleton VFS module. Implements dummy versions of all VFS
5 * Copyright (C) Tim Potter, 1999-2000
6 * Copyright (C) Alexander Bokovoy, 2002
7 * Copyright (C) Stefan (metze) Metzmacher, 2003
8 * Copyright (C) Jeremy Allison 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/>.
26 #include "smbd/proto.h"
28 /* PLEASE,PLEASE READ THE VFS MODULES CHAPTER OF THE
29 SAMBA DEVELOPERS GUIDE!!!!!!
32 /* If you take this file as template for your module
33 * you must re-implement every function.
36 static int skel_connect(vfs_handle_struct *handle, const char *service, const char *user)
42 static void skel_disconnect(vfs_handle_struct *handle)
47 static uint64_t skel_disk_free(vfs_handle_struct *handle, const char *path,
48 bool small_query, uint64_t *bsize,
49 uint64_t *dfree, uint64_t *dsize)
57 static int skel_get_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dq)
63 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dq)
69 static int skel_get_shadow_copy_data(vfs_handle_struct *handle, files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels)
75 static int skel_statvfs(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf)
81 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res)
86 static SMB_STRUCT_DIR *skel_opendir(vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attr)
91 static SMB_STRUCT_DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attr)
96 static SMB_STRUCT_DIRENT *skel_readdir(vfs_handle_struct *handle,
98 SMB_STRUCT_STAT *sbuf)
103 static void skel_seekdir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset)
108 static long skel_telldir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
113 static void skel_rewind_dir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
118 static int skel_mkdir(vfs_handle_struct *handle, const char *path, mode_t mode)
124 static int skel_rmdir(vfs_handle_struct *handle, const char *path)
130 static int skel_closedir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dir)
136 static void skel_init_search_op(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
141 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
142 files_struct *fsp, int flags, mode_t mode)
148 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
149 struct smb_request *req,
150 uint16_t root_dir_fid,
151 struct smb_filename *smb_fname,
152 uint32_t access_mask,
153 uint32_t share_access,
154 uint32_t create_disposition,
155 uint32_t create_options,
156 uint32_t file_attributes,
157 uint32_t oplock_request,
158 uint64_t allocation_size,
159 uint32_t private_flags,
160 struct security_descriptor *sd,
161 struct ea_list *ea_list,
162 files_struct **result,
165 return NT_STATUS_NOT_IMPLEMENTED;
168 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
174 static ssize_t skel_vfs_read(vfs_handle_struct *handle, files_struct *fsp, void *data, size_t n)
180 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
186 static ssize_t skel_write(vfs_handle_struct *handle, files_struct *fsp, const void *data, size_t n)
192 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
198 static SMB_OFF_T skel_lseek(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T offset, int whence)
201 return (SMB_OFF_T)-1;
204 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *hdr, SMB_OFF_T offset, size_t n)
210 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t n)
216 static int skel_rename(vfs_handle_struct *handle,
217 const struct smb_filename *smb_fname_src,
218 const struct smb_filename *smb_fname_dst)
224 static int skel_fsync(vfs_handle_struct *handle, files_struct *fsp)
230 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
236 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp, SMB_STRUCT_STAT *sbuf)
242 static int skel_lstat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
248 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf)
254 static int skel_unlink(vfs_handle_struct *handle,
255 const struct smb_filename *smb_fname)
261 static int skel_chmod(vfs_handle_struct *handle, const char *path, mode_t mode)
267 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp, mode_t mode)
273 static int skel_chown(vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid)
279 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp, uid_t uid, gid_t gid)
285 static int skel_lchown(vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid)
291 static int skel_chdir(vfs_handle_struct *handle, const char *path)
297 static char *skel_getwd(vfs_handle_struct *handle)
303 static int skel_ntimes(vfs_handle_struct *handle,
304 const struct smb_filename *smb_fname,
305 struct smb_file_time *ft)
311 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T offset)
317 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
318 enum vfs_fallocate_mode mode,
319 SMB_OFF_T offset, SMB_OFF_T len)
325 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
331 static int skel_kernel_flock(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode, uint32 access_mask)
337 static int skel_linux_setlease(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype)
343 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
349 static int skel_symlink(vfs_handle_struct *handle, const char *oldpath, const char *newpath)
355 static int skel_vfs_readlink(vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz)
361 static int skel_link(vfs_handle_struct *handle, const char *oldpath, const char *newpath)
367 static int skel_mknod(vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev)
373 static char *skel_realpath(vfs_handle_struct *handle, const char *path)
379 static NTSTATUS skel_notify_watch(struct vfs_handle_struct *handle,
380 struct sys_notify_context *ctx, struct notify_entry *e,
381 void (*callback)(struct sys_notify_context *ctx, void *private_data, struct notify_event *ev),
382 void *private_data, void *handle_p)
384 return NT_STATUS_NOT_IMPLEMENTED;
387 static int skel_chflags(vfs_handle_struct *handle, const char *path, uint flags)
393 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
394 const SMB_STRUCT_STAT *sbuf)
402 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
403 struct files_struct *fsp,
406 unsigned int *num_streams,
407 struct stream_struct **streams)
409 return NT_STATUS_NOT_IMPLEMENTED;
412 static int skel_get_real_filename(struct vfs_handle_struct *handle,
422 static const char *skel_connectpath(struct vfs_handle_struct *handle,
423 const char *filename)
429 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
430 struct byte_range_lock *br_lck,
431 struct lock_struct *plock,
433 struct blocking_lock_record *blr)
435 return NT_STATUS_NOT_IMPLEMENTED;
438 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
439 struct messaging_context *msg_ctx,
440 struct byte_range_lock *br_lck,
441 const struct lock_struct *plock)
447 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
448 struct byte_range_lock *br_lck,
449 struct lock_struct *plock,
450 struct blocking_lock_record *blr)
456 static bool skel_strict_lock(struct vfs_handle_struct *handle,
457 struct files_struct *fsp,
458 struct lock_struct *plock)
464 static void skel_strict_unlock(struct vfs_handle_struct *handle,
465 struct files_struct *fsp,
466 struct lock_struct *plock)
471 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
472 const char *mapped_name,
473 enum vfs_translate_direction direction,
477 return NT_STATUS_NOT_IMPLEMENTED;
480 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
481 uint32 security_info, struct security_descriptor **ppdesc)
483 return NT_STATUS_NOT_IMPLEMENTED;
486 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
487 const char *name, uint32 security_info, struct security_descriptor **ppdesc)
489 return NT_STATUS_NOT_IMPLEMENTED;
492 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
493 uint32 security_info_sent, const struct security_descriptor *psd)
495 return NT_STATUS_NOT_IMPLEMENTED;
498 static int skel_chmod_acl(vfs_handle_struct *handle, const char *name, mode_t mode)
504 static int skel_fchmod_acl(vfs_handle_struct *handle, files_struct *fsp, mode_t mode)
510 static int skel_sys_acl_get_entry(vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p)
516 static int skel_sys_acl_get_tag_type(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p)
522 static int skel_sys_acl_get_permset(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p)
528 static void *skel_sys_acl_get_qualifier(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d)
534 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type)
537 return (SMB_ACL_T)NULL;
540 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
543 return (SMB_ACL_T)NULL;
546 static int skel_sys_acl_clear_perms(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset)
552 static int skel_sys_acl_add_perm(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
558 static char *skel_sys_acl_to_text(vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen)
564 static SMB_ACL_T skel_sys_acl_init(vfs_handle_struct *handle, int count)
567 return (SMB_ACL_T)NULL;
570 static int skel_sys_acl_create_entry(vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry)
576 static int skel_sys_acl_set_tag_type(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype)
582 static int skel_sys_acl_set_qualifier(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual)
588 static int skel_sys_acl_set_permset(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset)
594 static int skel_sys_acl_valid(vfs_handle_struct *handle, SMB_ACL_T theacl )
600 static int skel_sys_acl_set_file(vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl)
606 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp, SMB_ACL_T theacl)
612 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle, const char *path)
618 static int skel_sys_acl_get_perm(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
624 static int skel_sys_acl_free_text(vfs_handle_struct *handle, char *text)
630 static int skel_sys_acl_free_acl(vfs_handle_struct *handle, SMB_ACL_T posix_acl)
636 static int skel_sys_acl_free_qualifier(vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype)
642 static ssize_t skel_getxattr(vfs_handle_struct *handle, const char *path, const char *name, void *value, size_t size)
648 static ssize_t skel_lgetxattr(vfs_handle_struct *handle, const char *path, const char *name, void *value, size_t
655 static ssize_t skel_fgetxattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size)
661 static ssize_t skel_listxattr(vfs_handle_struct *handle, const char *path, char *list, size_t size)
667 static ssize_t skel_llistxattr(vfs_handle_struct *handle, const char *path, char *list, size_t size)
673 static ssize_t skel_flistxattr(vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size)
679 static int skel_removexattr(vfs_handle_struct *handle, const char *path, const char *name)
685 static int skel_lremovexattr(vfs_handle_struct *handle, const char *path, const char *name)
691 static int skel_fremovexattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name)
695 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
698 static int skel_setxattr(vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags)
704 static int skel_lsetxattr(vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags)
710 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags)
716 static int skel_aio_read(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
722 static int skel_aio_write(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
728 static ssize_t skel_aio_return_fn(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
734 static int skel_aio_cancel(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
740 static int skel_aio_error_fn(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
746 static int skel_aio_fsync(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb)
752 static int skel_aio_suspend(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *ts)
758 static bool skel_aio_force(struct vfs_handle_struct *handle, struct files_struct *fsp)
764 static bool skel_is_offline(struct vfs_handle_struct *handle, const struct smb_filename *fname, SMB_STRUCT_STAT *sbuf)
770 static int skel_set_offline(struct vfs_handle_struct *handle, const struct smb_filename *fname)
776 /* VFS operations structure */
778 struct vfs_fn_pointers skel_transparent_fns = {
779 /* Disk operations */
781 .connect_fn = skel_connect,
782 .disconnect = skel_disconnect,
783 .disk_free = skel_disk_free,
784 .get_quota = skel_get_quota,
785 .set_quota = skel_set_quota,
786 .get_shadow_copy_data = skel_get_shadow_copy_data,
787 .statvfs = skel_statvfs,
788 .fs_capabilities = skel_fs_capabilities,
790 /* Directory operations */
792 .opendir = skel_opendir,
793 .fdopendir = skel_fdopendir,
794 .readdir = skel_readdir,
795 .seekdir = skel_seekdir,
796 .telldir = skel_telldir,
797 .rewind_dir = skel_rewind_dir,
800 .closedir = skel_closedir,
801 .init_search_op = skel_init_search_op,
803 /* File operations */
805 .open_fn = skel_open,
806 .create_file = skel_create_file,
807 .close_fn = skel_close_fn,
808 .vfs_read = skel_vfs_read,
811 .pwrite = skel_pwrite,
813 .sendfile = skel_sendfile,
814 .recvfile = skel_recvfile,
815 .rename = skel_rename,
820 .get_alloc_size = skel_get_alloc_size,
821 .unlink = skel_unlink,
823 .fchmod = skel_fchmod,
825 .fchown = skel_fchown,
826 .lchown = skel_lchown,
829 .ntimes = skel_ntimes,
830 .ftruncate = skel_ftruncate,
831 .fallocate = skel_fallocate,
833 .kernel_flock = skel_kernel_flock,
834 .linux_setlease = skel_linux_setlease,
835 .getlock = skel_getlock,
836 .symlink = skel_symlink,
837 .vfs_readlink = skel_vfs_readlink,
840 .realpath = skel_realpath,
841 .notify_watch = skel_notify_watch,
842 .chflags = skel_chflags,
843 .file_id_create = skel_file_id_create,
845 .streaminfo = skel_streaminfo,
846 .get_real_filename = skel_get_real_filename,
847 .connectpath = skel_connectpath,
848 .brl_lock_windows = skel_brl_lock_windows,
849 .brl_unlock_windows = skel_brl_unlock_windows,
850 .brl_cancel_windows = skel_brl_cancel_windows,
851 .strict_lock = skel_strict_lock,
852 .strict_unlock = skel_strict_unlock,
853 .translate_name = skel_translate_name,
855 /* NT ACL operations. */
857 .fget_nt_acl = skel_fget_nt_acl,
858 .get_nt_acl = skel_get_nt_acl,
859 .fset_nt_acl = skel_fset_nt_acl,
861 /* POSIX ACL operations. */
863 .chmod_acl = skel_chmod_acl,
864 .fchmod_acl = skel_fchmod_acl,
866 .sys_acl_get_entry = skel_sys_acl_get_entry,
867 .sys_acl_get_tag_type = skel_sys_acl_get_tag_type,
868 .sys_acl_get_permset = skel_sys_acl_get_permset,
869 .sys_acl_get_qualifier = skel_sys_acl_get_qualifier,
870 .sys_acl_get_file = skel_sys_acl_get_file,
871 .sys_acl_get_fd = skel_sys_acl_get_fd,
872 .sys_acl_clear_perms = skel_sys_acl_clear_perms,
873 .sys_acl_add_perm = skel_sys_acl_add_perm,
874 .sys_acl_to_text = skel_sys_acl_to_text,
875 .sys_acl_init = skel_sys_acl_init,
876 .sys_acl_create_entry = skel_sys_acl_create_entry,
877 .sys_acl_set_tag_type = skel_sys_acl_set_tag_type,
878 .sys_acl_set_qualifier = skel_sys_acl_set_qualifier,
879 .sys_acl_set_permset = skel_sys_acl_set_permset,
880 .sys_acl_valid = skel_sys_acl_valid,
881 .sys_acl_set_file = skel_sys_acl_set_file,
882 .sys_acl_set_fd = skel_sys_acl_set_fd,
883 .sys_acl_delete_def_file = skel_sys_acl_delete_def_file,
884 .sys_acl_get_perm = skel_sys_acl_get_perm,
885 .sys_acl_free_text = skel_sys_acl_free_text,
886 .sys_acl_free_acl = skel_sys_acl_free_acl,
887 .sys_acl_free_qualifier = skel_sys_acl_free_qualifier,
890 .getxattr = skel_getxattr,
891 .lgetxattr = skel_lgetxattr,
892 .fgetxattr = skel_fgetxattr,
893 .listxattr = skel_listxattr,
894 .llistxattr = skel_llistxattr,
895 .flistxattr = skel_flistxattr,
896 .removexattr = skel_removexattr,
897 .lremovexattr = skel_lremovexattr,
898 .fremovexattr = skel_fremovexattr,
899 .setxattr = skel_setxattr,
900 .lsetxattr = skel_lsetxattr,
901 .fsetxattr = skel_fsetxattr,
904 .aio_read = skel_aio_read,
905 .aio_write = skel_aio_write,
906 .aio_return_fn = skel_aio_return_fn,
907 .aio_cancel = skel_aio_cancel,
908 .aio_error_fn = skel_aio_error_fn,
909 .aio_fsync = skel_aio_fsync,
910 .aio_suspend = skel_aio_suspend,
911 .aio_force = skel_aio_force,
913 /* offline operations */
914 .is_offline = skel_is_offline,
915 .set_offline = skel_set_offline
918 NTSTATUS vfs_skel_transparent_init(void)
920 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent", &skel_transparent_fns);