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/>.
24 #include "../source3/include/includes.h"
25 #include "lib/util/tevent_ntstatus.h"
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,
42 static void skel_disconnect(vfs_handle_struct *handle)
47 static uint64_t skel_disk_free(vfs_handle_struct *handle,
48 const struct smb_filename *smb_fname,
59 static int skel_get_quota(vfs_handle_struct *handle, const char *path,
60 enum SMB_QUOTA_TYPE qtype, unid_t id,
67 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype,
68 unid_t id, SMB_DISK_QUOTA *dq)
74 static int skel_get_shadow_copy_data(vfs_handle_struct *handle,
76 struct shadow_copy_data *shadow_copy_data,
83 static int skel_statvfs(struct vfs_handle_struct *handle,
84 const char *path, struct vfs_statvfs_struct *statbuf)
90 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle,
91 enum timestamp_set_resolution *p_ts_res)
96 static NTSTATUS skel_get_dfs_referrals(struct vfs_handle_struct *handle,
97 struct dfs_GetDFSReferral *r)
99 return NT_STATUS_NOT_IMPLEMENTED;
102 static DIR *skel_opendir(vfs_handle_struct *handle,
103 const struct smb_filename *smb_fname,
110 static NTSTATUS skel_snap_check_path(struct vfs_handle_struct *handle,
112 const char *service_path,
115 return NT_STATUS_NOT_SUPPORTED;
118 static NTSTATUS skel_snap_create(struct vfs_handle_struct *handle,
120 const char *base_volume,
126 return NT_STATUS_NOT_SUPPORTED;
129 static NTSTATUS skel_snap_delete(struct vfs_handle_struct *handle,
134 return NT_STATUS_NOT_SUPPORTED;
137 static DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
138 const char *mask, uint32_t attr)
143 static struct dirent *skel_readdir(vfs_handle_struct *handle,
144 DIR *dirp, SMB_STRUCT_STAT *sbuf)
149 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
154 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
159 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
164 static int skel_mkdir(vfs_handle_struct *handle,
165 const struct smb_filename *smb_fname,
172 static int skel_rmdir(vfs_handle_struct *handle,
173 const struct smb_filename *smb_fname)
179 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
185 static void skel_init_search_op(struct vfs_handle_struct *handle, DIR *dirp)
190 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
191 files_struct *fsp, int flags, mode_t mode)
197 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
198 struct smb_request *req,
199 uint16_t root_dir_fid,
200 struct smb_filename *smb_fname,
201 uint32_t access_mask,
202 uint32_t share_access,
203 uint32_t create_disposition,
204 uint32_t create_options,
205 uint32_t file_attributes,
206 uint32_t oplock_request,
207 struct smb2_lease *lease,
208 uint64_t allocation_size,
209 uint32_t private_flags,
210 struct security_descriptor *sd,
211 struct ea_list *ea_list,
212 files_struct **result, int *pinfo,
213 const struct smb2_create_blobs *in_context_blobs,
214 struct smb2_create_blobs *out_context_blobs)
216 return NT_STATUS_NOT_IMPLEMENTED;
219 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
225 static ssize_t skel_vfs_read(vfs_handle_struct *handle, files_struct *fsp,
226 void *data, size_t n)
232 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
233 void *data, size_t n, off_t offset)
239 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
241 struct tevent_context *ev,
242 struct files_struct *fsp,
243 void *data, size_t n, off_t offset)
248 static ssize_t skel_pread_recv(struct tevent_req *req,
249 struct vfs_aio_state *vfs_aio_state)
251 vfs_aio_state->error = ENOSYS;
255 static ssize_t skel_write(vfs_handle_struct *handle, files_struct *fsp,
256 const void *data, size_t n)
262 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
263 const void *data, size_t n, off_t offset)
269 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
271 struct tevent_context *ev,
272 struct files_struct *fsp,
274 size_t n, off_t offset)
279 static ssize_t skel_pwrite_recv(struct tevent_req *req,
280 struct vfs_aio_state *vfs_aio_state)
282 vfs_aio_state->error = ENOSYS;
286 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
287 off_t offset, int whence)
293 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
294 files_struct *fromfsp, const DATA_BLOB *hdr,
295 off_t offset, size_t n)
301 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
302 files_struct *tofsp, off_t offset, size_t n)
308 static int skel_rename(vfs_handle_struct *handle,
309 const struct smb_filename *smb_fname_src,
310 const struct smb_filename *smb_fname_dst)
316 static int skel_fsync(vfs_handle_struct *handle, files_struct *fsp)
322 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
324 struct tevent_context *ev,
325 struct files_struct *fsp)
330 static int skel_fsync_recv(struct tevent_req *req,
331 struct vfs_aio_state *vfs_aio_state)
333 vfs_aio_state->error = ENOSYS;
337 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
343 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
344 SMB_STRUCT_STAT *sbuf)
350 static int skel_lstat(vfs_handle_struct *handle,
351 struct smb_filename *smb_fname)
357 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
358 struct files_struct *fsp,
359 const SMB_STRUCT_STAT *sbuf)
365 static int skel_unlink(vfs_handle_struct *handle,
366 const struct smb_filename *smb_fname)
372 static int skel_chmod(vfs_handle_struct *handle,
373 const struct smb_filename *smb_fname,
380 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
387 static int skel_chown(vfs_handle_struct *handle,
388 const struct smb_filename *smb_fname,
396 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
397 uid_t uid, gid_t gid)
403 static int skel_lchown(vfs_handle_struct *handle,
404 const struct smb_filename *smb_fname,
412 static int skel_chdir(vfs_handle_struct *handle, const char *path)
418 static char *skel_getwd(vfs_handle_struct *handle)
424 static int skel_ntimes(vfs_handle_struct *handle,
425 const struct smb_filename *smb_fname,
426 struct smb_file_time *ft)
432 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
439 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
440 uint32_t mode, off_t offset, off_t len)
446 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
447 off_t offset, off_t count, int type)
453 static int skel_kernel_flock(struct vfs_handle_struct *handle,
454 struct files_struct *fsp,
455 uint32_t share_mode, uint32_t access_mask)
461 static int skel_linux_setlease(struct vfs_handle_struct *handle,
462 struct files_struct *fsp, int leasetype)
468 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
469 off_t *poffset, off_t *pcount, int *ptype,
476 static int skel_symlink(vfs_handle_struct *handle, const char *oldpath,
483 static int skel_vfs_readlink(vfs_handle_struct *handle, const char *path,
484 char *buf, size_t bufsiz)
490 static int skel_link(vfs_handle_struct *handle, const char *oldpath,
497 static int skel_mknod(vfs_handle_struct *handle,
498 const struct smb_filename *smb_fname,
506 static char *skel_realpath(vfs_handle_struct *handle, const char *path)
512 static int skel_chflags(vfs_handle_struct *handle,
513 const struct smb_filename *smb_fname,
520 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
521 const SMB_STRUCT_STAT *sbuf)
529 struct skel_cc_state {
532 static struct tevent_req *skel_copy_chunk_send(struct vfs_handle_struct *handle,
534 struct tevent_context *ev,
535 struct files_struct *src_fsp,
537 struct files_struct *dest_fsp,
542 struct tevent_req *req;
543 struct skel_cc_state *cc_state;
545 req = tevent_req_create(mem_ctx, &cc_state, struct skel_cc_state);
550 tevent_req_nterror(req, NT_STATUS_NOT_IMPLEMENTED);
551 return tevent_req_post(req, ev);
554 static NTSTATUS skel_copy_chunk_recv(struct vfs_handle_struct *handle,
555 struct tevent_req *req,
560 if (tevent_req_is_nterror(req, &status)) {
561 tevent_req_received(req);
564 tevent_req_received(req);
569 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
571 struct files_struct *fsp,
572 struct smb_filename *smb_fname,
573 uint16_t *_compression_fmt)
575 return NT_STATUS_INVALID_DEVICE_REQUEST;
578 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
580 struct files_struct *fsp,
581 uint16_t compression_fmt)
583 return NT_STATUS_INVALID_DEVICE_REQUEST;
586 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
587 struct files_struct *fsp,
588 const struct smb_filename *smb_fname,
590 unsigned int *num_streams,
591 struct stream_struct **streams)
593 return NT_STATUS_NOT_IMPLEMENTED;
596 static int skel_get_real_filename(struct vfs_handle_struct *handle,
599 TALLOC_CTX *mem_ctx, char **found_name)
605 static const char *skel_connectpath(struct vfs_handle_struct *handle,
606 const char *filename)
612 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
613 struct byte_range_lock *br_lck,
614 struct lock_struct *plock,
617 return NT_STATUS_NOT_IMPLEMENTED;
620 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
621 struct messaging_context *msg_ctx,
622 struct byte_range_lock *br_lck,
623 const struct lock_struct *plock)
629 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
630 struct byte_range_lock *br_lck,
631 struct lock_struct *plock)
637 static bool skel_strict_lock(struct vfs_handle_struct *handle,
638 struct files_struct *fsp,
639 struct lock_struct *plock)
645 static void skel_strict_unlock(struct vfs_handle_struct *handle,
646 struct files_struct *fsp,
647 struct lock_struct *plock)
652 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
653 const char *mapped_name,
654 enum vfs_translate_direction direction,
655 TALLOC_CTX *mem_ctx, char **pmapped_name)
657 return NT_STATUS_NOT_IMPLEMENTED;
660 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
661 struct files_struct *fsp,
664 uint16_t req_flags, /* Needed for UNICODE ... */
665 const uint8_t *_in_data,
668 uint32_t max_out_len, uint32_t *out_len)
670 return NT_STATUS_NOT_IMPLEMENTED;
673 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
674 const struct smb_filename *fname,
676 struct readdir_attr_data **pattr_data)
678 return NT_STATUS_NOT_IMPLEMENTED;
681 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
682 struct smb_filename *smb_fname,
685 return NT_STATUS_NOT_IMPLEMENTED;
688 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
689 struct files_struct *fsp,
692 return NT_STATUS_NOT_IMPLEMENTED;
695 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
696 const struct smb_filename *smb_fname,
699 return NT_STATUS_NOT_IMPLEMENTED;
702 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
703 struct files_struct *fsp,
706 return NT_STATUS_NOT_IMPLEMENTED;
709 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
710 uint32_t security_info,
712 struct security_descriptor **ppdesc)
714 return NT_STATUS_NOT_IMPLEMENTED;
717 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
718 const struct smb_filename *smb_fname,
719 uint32_t security_info,
721 struct security_descriptor **ppdesc)
723 return NT_STATUS_NOT_IMPLEMENTED;
726 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
727 uint32_t security_info_sent,
728 const struct security_descriptor *psd)
730 return NT_STATUS_NOT_IMPLEMENTED;
733 static int skel_chmod_acl(vfs_handle_struct *handle,
734 const struct smb_filename *smb_fname,
741 static int skel_fchmod_acl(vfs_handle_struct *handle, files_struct *fsp,
748 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
749 const struct smb_filename *smb_fname,
754 return (SMB_ACL_T) NULL;
757 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
758 files_struct *fsp, TALLOC_CTX *mem_ctx)
761 return (SMB_ACL_T) NULL;
764 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
765 const struct smb_filename *smb_fname,
767 char **blob_description,
774 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
775 files_struct *fsp, TALLOC_CTX *mem_ctx,
776 char **blob_description, DATA_BLOB *blob)
782 static int skel_sys_acl_set_file(vfs_handle_struct *handle,
783 const struct smb_filename *smb_fname,
784 SMB_ACL_TYPE_T acltype,
791 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
798 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
799 const struct smb_filename *smb_fname)
805 static ssize_t skel_getxattr(vfs_handle_struct *handle,
806 const struct smb_filename *smb_fname,
815 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
816 struct files_struct *fsp, const char *name,
817 void *value, size_t size)
823 static ssize_t skel_listxattr(vfs_handle_struct *handle,
824 const struct smb_filename *smb_fname,
832 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
833 struct files_struct *fsp, char *list,
840 static int skel_removexattr(vfs_handle_struct *handle,
841 const struct smb_filename *smb_fname,
848 static int skel_fremovexattr(vfs_handle_struct *handle,
849 struct files_struct *fsp, const char *name)
853 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
856 static int skel_setxattr(vfs_handle_struct *handle,
857 const struct smb_filename *smb_fname,
867 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
868 const char *name, const void *value, size_t size,
875 static bool skel_aio_force(struct vfs_handle_struct *handle,
876 struct files_struct *fsp)
882 /* VFS operations structure */
884 struct vfs_fn_pointers skel_opaque_fns = {
885 /* Disk operations */
887 .connect_fn = skel_connect,
888 .disconnect_fn = skel_disconnect,
889 .disk_free_fn = skel_disk_free,
890 .get_quota_fn = skel_get_quota,
891 .set_quota_fn = skel_set_quota,
892 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
893 .statvfs_fn = skel_statvfs,
894 .fs_capabilities_fn = skel_fs_capabilities,
895 .get_dfs_referrals_fn = skel_get_dfs_referrals,
896 .snap_check_path_fn = skel_snap_check_path,
897 .snap_create_fn = skel_snap_create,
898 .snap_delete_fn = skel_snap_delete,
900 /* Directory operations */
902 .opendir_fn = skel_opendir,
903 .fdopendir_fn = skel_fdopendir,
904 .readdir_fn = skel_readdir,
905 .seekdir_fn = skel_seekdir,
906 .telldir_fn = skel_telldir,
907 .rewind_dir_fn = skel_rewind_dir,
908 .mkdir_fn = skel_mkdir,
909 .rmdir_fn = skel_rmdir,
910 .closedir_fn = skel_closedir,
911 .init_search_op_fn = skel_init_search_op,
913 /* File operations */
915 .open_fn = skel_open,
916 .create_file_fn = skel_create_file,
917 .close_fn = skel_close_fn,
918 .read_fn = skel_vfs_read,
919 .pread_fn = skel_pread,
920 .pread_send_fn = skel_pread_send,
921 .pread_recv_fn = skel_pread_recv,
922 .write_fn = skel_write,
923 .pwrite_fn = skel_pwrite,
924 .pwrite_send_fn = skel_pwrite_send,
925 .pwrite_recv_fn = skel_pwrite_recv,
926 .lseek_fn = skel_lseek,
927 .sendfile_fn = skel_sendfile,
928 .recvfile_fn = skel_recvfile,
929 .rename_fn = skel_rename,
930 .fsync_fn = skel_fsync,
931 .fsync_send_fn = skel_fsync_send,
932 .fsync_recv_fn = skel_fsync_recv,
933 .stat_fn = skel_stat,
934 .fstat_fn = skel_fstat,
935 .lstat_fn = skel_lstat,
936 .get_alloc_size_fn = skel_get_alloc_size,
937 .unlink_fn = skel_unlink,
938 .chmod_fn = skel_chmod,
939 .fchmod_fn = skel_fchmod,
940 .chown_fn = skel_chown,
941 .fchown_fn = skel_fchown,
942 .lchown_fn = skel_lchown,
943 .chdir_fn = skel_chdir,
944 .getwd_fn = skel_getwd,
945 .ntimes_fn = skel_ntimes,
946 .ftruncate_fn = skel_ftruncate,
947 .fallocate_fn = skel_fallocate,
948 .lock_fn = skel_lock,
949 .kernel_flock_fn = skel_kernel_flock,
950 .linux_setlease_fn = skel_linux_setlease,
951 .getlock_fn = skel_getlock,
952 .symlink_fn = skel_symlink,
953 .readlink_fn = skel_vfs_readlink,
954 .link_fn = skel_link,
955 .mknod_fn = skel_mknod,
956 .realpath_fn = skel_realpath,
957 .chflags_fn = skel_chflags,
958 .file_id_create_fn = skel_file_id_create,
959 .copy_chunk_send_fn = skel_copy_chunk_send,
960 .copy_chunk_recv_fn = skel_copy_chunk_recv,
961 .get_compression_fn = skel_get_compression,
962 .set_compression_fn = skel_set_compression,
964 .streaminfo_fn = skel_streaminfo,
965 .get_real_filename_fn = skel_get_real_filename,
966 .connectpath_fn = skel_connectpath,
967 .brl_lock_windows_fn = skel_brl_lock_windows,
968 .brl_unlock_windows_fn = skel_brl_unlock_windows,
969 .brl_cancel_windows_fn = skel_brl_cancel_windows,
970 .strict_lock_fn = skel_strict_lock,
971 .strict_unlock_fn = skel_strict_unlock,
972 .translate_name_fn = skel_translate_name,
973 .fsctl_fn = skel_fsctl,
974 .readdir_attr_fn = skel_readdir_attr,
976 /* DOS attributes. */
977 .get_dos_attributes_fn = skel_get_dos_attributes,
978 .fget_dos_attributes_fn = skel_fget_dos_attributes,
979 .set_dos_attributes_fn = skel_set_dos_attributes,
980 .fset_dos_attributes_fn = skel_fset_dos_attributes,
982 /* NT ACL operations. */
984 .fget_nt_acl_fn = skel_fget_nt_acl,
985 .get_nt_acl_fn = skel_get_nt_acl,
986 .fset_nt_acl_fn = skel_fset_nt_acl,
988 /* POSIX ACL operations. */
990 .chmod_acl_fn = skel_chmod_acl,
991 .fchmod_acl_fn = skel_fchmod_acl,
993 .sys_acl_get_file_fn = skel_sys_acl_get_file,
994 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
995 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
996 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
997 .sys_acl_set_file_fn = skel_sys_acl_set_file,
998 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
999 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1001 /* EA operations. */
1002 .getxattr_fn = skel_getxattr,
1003 .fgetxattr_fn = skel_fgetxattr,
1004 .listxattr_fn = skel_listxattr,
1005 .flistxattr_fn = skel_flistxattr,
1006 .removexattr_fn = skel_removexattr,
1007 .fremovexattr_fn = skel_fremovexattr,
1008 .setxattr_fn = skel_setxattr,
1009 .fsetxattr_fn = skel_fsetxattr,
1011 /* aio operations */
1012 .aio_force_fn = skel_aio_force,
1016 NTSTATUS vfs_skel_opaque_init(TALLOC_CTX *ctx)
1018 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_opaque",