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/>.
27 /* PLEASE,PLEASE READ THE VFS MODULES CHAPTER OF THE
28 SAMBA DEVELOPERS GUIDE!!!!!!
31 /* If you take this file as template for your module
32 * you must re-implement every function.
35 static int skel_connect(vfs_handle_struct *handle, const char *service, const char *user)
41 static void skel_disconnect(vfs_handle_struct *handle)
46 static uint64_t skel_disk_free(vfs_handle_struct *handle, const char *path,
47 bool small_query, uint64_t *bsize,
48 uint64_t *dfree, uint64_t *dsize)
56 static int skel_get_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dq)
62 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *dq)
68 static int skel_get_shadow_copy_data(vfs_handle_struct *handle, files_struct *fsp, SHADOW_COPY_DATA *shadow_copy_data, bool labels)
74 static int skel_statvfs(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf)
80 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle, enum timestamp_set_resolution *p_ts_res)
85 static SMB_STRUCT_DIR *skel_opendir(vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attr)
90 static SMB_STRUCT_DIRENT *skel_readdir(vfs_handle_struct *handle,
92 SMB_STRUCT_STAT *sbuf)
97 static void skel_seekdir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp, long offset)
102 static long skel_telldir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
107 static void skel_rewind_dir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
112 static int skel_mkdir(vfs_handle_struct *handle, const char *path, mode_t mode)
118 static int skel_rmdir(vfs_handle_struct *handle, const char *path)
124 static int skel_closedir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dir)
130 static void skel_init_search_op(struct vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
135 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
136 files_struct *fsp, int flags, mode_t mode)
142 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
143 struct smb_request *req,
144 uint16_t root_dir_fid,
145 struct smb_filename *smb_fname,
146 uint32_t access_mask,
147 uint32_t share_access,
148 uint32_t create_disposition,
149 uint32_t create_options,
150 uint32_t file_attributes,
151 uint32_t oplock_request,
152 uint64_t allocation_size,
153 uint32_t private_flags,
154 struct security_descriptor *sd,
155 struct ea_list *ea_list,
156 files_struct **result,
159 return NT_STATUS_NOT_IMPLEMENTED;
162 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
168 static ssize_t skel_vfs_read(vfs_handle_struct *handle, files_struct *fsp, void *data, size_t n)
174 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp, void *data, size_t n, SMB_OFF_T offset)
180 static ssize_t skel_write(vfs_handle_struct *handle, files_struct *fsp, const void *data, size_t n)
186 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp, const void *data, size_t n, SMB_OFF_T offset)
192 static SMB_OFF_T skel_lseek(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T offset, int whence)
195 return (SMB_OFF_T)-1;
198 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)
204 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd, files_struct *tofsp, SMB_OFF_T offset, size_t n)
210 static int skel_rename(vfs_handle_struct *handle,
211 const struct smb_filename *smb_fname_src,
212 const struct smb_filename *smb_fname_dst)
218 static int skel_fsync(vfs_handle_struct *handle, files_struct *fsp)
224 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
230 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp, SMB_STRUCT_STAT *sbuf)
236 static int skel_lstat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
242 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf)
248 static int skel_unlink(vfs_handle_struct *handle,
249 const struct smb_filename *smb_fname)
255 static int skel_chmod(vfs_handle_struct *handle, const char *path, mode_t mode)
261 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp, mode_t mode)
267 static int skel_chown(vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid)
273 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp, uid_t uid, gid_t gid)
279 static int skel_lchown(vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid)
285 static int skel_chdir(vfs_handle_struct *handle, const char *path)
291 static char *skel_getwd(vfs_handle_struct *handle, char *buf)
297 static int skel_ntimes(vfs_handle_struct *handle,
298 const struct smb_filename *smb_fname,
299 struct smb_file_time *ft)
305 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T offset)
311 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op, SMB_OFF_T offset, SMB_OFF_T count, int type)
317 static int skel_kernel_flock(struct vfs_handle_struct *handle, struct files_struct *fsp, uint32 share_mode, uint32 access_mask)
323 static int skel_linux_setlease(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype)
329 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
335 static int skel_symlink(vfs_handle_struct *handle, const char *oldpath, const char *newpath)
341 static int skel_vfs_readlink(vfs_handle_struct *handle, const char *path, char *buf, size_t bufsiz)
347 static int skel_link(vfs_handle_struct *handle, const char *oldpath, const char *newpath)
353 static int skel_mknod(vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev)
359 static char *skel_realpath(vfs_handle_struct *handle, const char *path)
365 static NTSTATUS skel_notify_watch(struct vfs_handle_struct *handle,
366 struct sys_notify_context *ctx, struct notify_entry *e,
367 void (*callback)(struct sys_notify_context *ctx, void *private_data, struct notify_event *ev),
368 void *private_data, void *handle_p)
370 return NT_STATUS_NOT_IMPLEMENTED;
373 static int skel_chflags(vfs_handle_struct *handle, const char *path, uint flags)
379 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
380 const SMB_STRUCT_STAT *sbuf)
388 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
389 struct files_struct *fsp,
392 unsigned int *num_streams,
393 struct stream_struct **streams)
395 return NT_STATUS_NOT_IMPLEMENTED;
398 static int skel_get_real_filename(struct vfs_handle_struct *handle,
408 static const char *skel_connectpath(struct vfs_handle_struct *handle,
409 const char *filename)
415 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
416 struct byte_range_lock *br_lck,
417 struct lock_struct *plock,
419 struct blocking_lock_record *blr)
421 return NT_STATUS_NOT_IMPLEMENTED;
424 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
425 struct messaging_context *msg_ctx,
426 struct byte_range_lock *br_lck,
427 const struct lock_struct *plock)
433 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
434 struct byte_range_lock *br_lck,
435 struct lock_struct *plock,
436 struct blocking_lock_record *blr)
442 static bool skel_strict_lock(struct vfs_handle_struct *handle,
443 struct files_struct *fsp,
444 struct lock_struct *plock)
450 static void skel_strict_unlock(struct vfs_handle_struct *handle,
451 struct files_struct *fsp,
452 struct lock_struct *plock)
457 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
458 const char *mapped_name,
459 enum vfs_translate_direction direction,
463 return NT_STATUS_NOT_IMPLEMENTED;
466 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
467 uint32 security_info, SEC_DESC **ppdesc)
469 return NT_STATUS_NOT_IMPLEMENTED;
472 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
473 const char *name, uint32 security_info, SEC_DESC **ppdesc)
475 return NT_STATUS_NOT_IMPLEMENTED;
478 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
479 uint32 security_info_sent, const SEC_DESC *psd)
481 return NT_STATUS_NOT_IMPLEMENTED;
484 static int skel_chmod_acl(vfs_handle_struct *handle, const char *name, mode_t mode)
490 static int skel_fchmod_acl(vfs_handle_struct *handle, files_struct *fsp, mode_t mode)
496 static int skel_sys_acl_get_entry(vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p)
502 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)
508 static int skel_sys_acl_get_permset(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p)
514 static void *skel_sys_acl_get_qualifier(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d)
520 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type)
523 return (SMB_ACL_T)NULL;
526 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle, files_struct *fsp)
529 return (SMB_ACL_T)NULL;
532 static int skel_sys_acl_clear_perms(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset)
538 static int skel_sys_acl_add_perm(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
544 static char *skel_sys_acl_to_text(vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen)
550 static SMB_ACL_T skel_sys_acl_init(vfs_handle_struct *handle, int count)
553 return (SMB_ACL_T)NULL;
556 static int skel_sys_acl_create_entry(vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry)
562 static int skel_sys_acl_set_tag_type(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype)
568 static int skel_sys_acl_set_qualifier(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual)
574 static int skel_sys_acl_set_permset(vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset)
580 static int skel_sys_acl_valid(vfs_handle_struct *handle, SMB_ACL_T theacl )
586 static int skel_sys_acl_set_file(vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl)
592 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp, SMB_ACL_T theacl)
598 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle, const char *path)
604 static int skel_sys_acl_get_perm(vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm)
610 static int skel_sys_acl_free_text(vfs_handle_struct *handle, char *text)
616 static int skel_sys_acl_free_acl(vfs_handle_struct *handle, SMB_ACL_T posix_acl)
622 static int skel_sys_acl_free_qualifier(vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype)
628 static ssize_t skel_getxattr(vfs_handle_struct *handle, const char *path, const char *name, void *value, size_t size)
634 static ssize_t skel_lgetxattr(vfs_handle_struct *handle, const char *path, const char *name, void *value, size_t
641 static ssize_t skel_fgetxattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name, void *value, size_t size)
647 static ssize_t skel_listxattr(vfs_handle_struct *handle, const char *path, char *list, size_t size)
653 static ssize_t skel_llistxattr(vfs_handle_struct *handle, const char *path, char *list, size_t size)
659 static ssize_t skel_flistxattr(vfs_handle_struct *handle, struct files_struct *fsp, char *list, size_t size)
665 static int skel_removexattr(vfs_handle_struct *handle, const char *path, const char *name)
671 static int skel_lremovexattr(vfs_handle_struct *handle, const char *path, const char *name)
677 static int skel_fremovexattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name)
681 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
684 static int skel_setxattr(vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags)
690 static int skel_lsetxattr(vfs_handle_struct *handle, const char *path, const char *name, const void *value, size_t size, int flags)
696 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags)
702 static int skel_aio_read(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
708 static int skel_aio_write(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
714 static ssize_t skel_aio_return_fn(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
720 static int skel_aio_cancel(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
726 static int skel_aio_error_fn(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
732 static int skel_aio_fsync(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb)
738 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)
744 static bool skel_aio_force(struct vfs_handle_struct *handle, struct files_struct *fsp)
750 static bool skel_is_offline(struct vfs_handle_struct *handle, const char *path, SMB_STRUCT_STAT *sbuf)
756 static int skel_set_offline(struct vfs_handle_struct *handle, const char *path)
762 /* VFS operations structure */
764 struct vfs_fn_pointers skel_transparent_fns = {
765 /* Disk operations */
767 .connect_fn = skel_connect,
768 .disconnect = skel_disconnect,
769 .disk_free = skel_disk_free,
770 .get_quota = skel_get_quota,
771 .set_quota = skel_set_quota,
772 .get_shadow_copy_data = skel_get_shadow_copy_data,
773 .statvfs = skel_statvfs,
774 .fs_capabilities = skel_fs_capabilities,
776 /* Directory operations */
778 .opendir = skel_opendir,
779 .readdir = skel_readdir,
780 .seekdir = skel_seekdir,
781 .telldir = skel_telldir,
782 .rewind_dir = skel_rewind_dir,
785 .closedir = skel_closedir,
786 .init_search_op = skel_init_search_op,
788 /* File operations */
791 .create_file = skel_create_file,
792 .close_fn = skel_close_fn,
793 .vfs_read = skel_vfs_read,
796 .pwrite = skel_pwrite,
798 .sendfile = skel_sendfile,
799 .recvfile = skel_recvfile,
800 .rename = skel_rename,
805 .get_alloc_size = skel_get_alloc_size,
806 .unlink = skel_unlink,
808 .fchmod = skel_fchmod,
810 .fchown = skel_fchown,
811 .lchown = skel_lchown,
814 .ntimes = skel_ntimes,
815 .ftruncate = skel_ftruncate,
817 .kernel_flock = skel_kernel_flock,
818 .linux_setlease = skel_linux_setlease,
819 .getlock = skel_getlock,
820 .symlink = skel_symlink,
821 .vfs_readlink = skel_vfs_readlink,
824 .realpath = skel_realpath,
825 .notify_watch = skel_notify_watch,
826 .chflags = skel_chflags,
827 .file_id_create = skel_file_id_create,
829 .streaminfo = skel_streaminfo,
830 .get_real_filename = skel_get_real_filename,
831 .connectpath = skel_connectpath,
832 .brl_lock_windows = skel_brl_lock_windows,
833 .brl_unlock_windows = skel_brl_unlock_windows,
834 .brl_cancel_windows = skel_brl_cancel_windows,
835 .strict_lock = skel_strict_lock,
836 .strict_unlock = skel_strict_unlock,
837 .translate_name = skel_translate_name,
839 /* NT ACL operations. */
841 .fget_nt_acl = skel_fget_nt_acl,
842 .get_nt_acl = skel_get_nt_acl,
843 .fset_nt_acl = skel_fset_nt_acl,
845 /* POSIX ACL operations. */
847 .chmod_acl = skel_chmod_acl,
848 .fchmod_acl = skel_fchmod_acl,
850 .sys_acl_get_entry = skel_sys_acl_get_entry,
851 .sys_acl_get_tag_type = skel_sys_acl_get_tag_type,
852 .sys_acl_get_permset = skel_sys_acl_get_permset,
853 .sys_acl_get_qualifier = skel_sys_acl_get_qualifier,
854 .sys_acl_get_file = skel_sys_acl_get_file,
855 .sys_acl_get_fd = skel_sys_acl_get_fd,
856 .sys_acl_clear_perms = skel_sys_acl_clear_perms,
857 .sys_acl_add_perm = skel_sys_acl_add_perm,
858 .sys_acl_to_text = skel_sys_acl_to_text,
859 .sys_acl_init = skel_sys_acl_init,
860 .sys_acl_create_entry = skel_sys_acl_create_entry,
861 .sys_acl_set_tag_type = skel_sys_acl_set_tag_type,
862 .sys_acl_set_qualifier = skel_sys_acl_set_qualifier,
863 .sys_acl_set_permset = skel_sys_acl_set_permset,
864 .sys_acl_valid = skel_sys_acl_valid,
865 .sys_acl_set_file = skel_sys_acl_set_file,
866 .sys_acl_set_fd = skel_sys_acl_set_fd,
867 .sys_acl_delete_def_file = skel_sys_acl_delete_def_file,
868 .sys_acl_get_perm = skel_sys_acl_get_perm,
869 .sys_acl_free_text = skel_sys_acl_free_text,
870 .sys_acl_free_acl = skel_sys_acl_free_acl,
871 .sys_acl_free_qualifier = skel_sys_acl_free_qualifier,
874 .getxattr = skel_getxattr,
875 .lgetxattr = skel_lgetxattr,
876 .fgetxattr = skel_fgetxattr,
877 .listxattr = skel_listxattr,
878 .llistxattr = skel_llistxattr,
879 .flistxattr = skel_flistxattr,
880 .removexattr = skel_removexattr,
881 .lremovexattr = skel_lremovexattr,
882 .fremovexattr = skel_fremovexattr,
883 .setxattr = skel_setxattr,
884 .lsetxattr = skel_lsetxattr,
885 .fsetxattr = skel_fsetxattr,
888 .aio_read = skel_aio_read,
889 .aio_write = skel_aio_write,
890 .aio_return_fn = skel_aio_return_fn,
891 .aio_cancel = skel_aio_cancel,
892 .aio_error_fn = skel_aio_error_fn,
893 .aio_fsync = skel_aio_fsync,
894 .aio_suspend = skel_aio_suspend,
895 .aio_force = skel_aio_force,
897 /* offline operations */
898 .is_offline = skel_is_offline,
899 .set_offline = skel_set_offline
902 NTSTATUS vfs_skel_transparent_init(void)
904 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent", &skel_transparent_fns);