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,
60 const struct smb_filename *smb_fname,
61 enum SMB_QUOTA_TYPE qtype,
69 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype,
70 unid_t id, SMB_DISK_QUOTA *dq)
76 static int skel_get_shadow_copy_data(vfs_handle_struct *handle,
78 struct shadow_copy_data *shadow_copy_data,
85 static int skel_statvfs(struct vfs_handle_struct *handle,
86 const struct smb_filename *smb_fname,
87 struct vfs_statvfs_struct *statbuf)
93 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle,
94 enum timestamp_set_resolution *p_ts_res)
99 static NTSTATUS skel_get_dfs_referrals(struct vfs_handle_struct *handle,
100 struct dfs_GetDFSReferral *r)
102 return NT_STATUS_NOT_IMPLEMENTED;
105 static DIR *skel_opendir(vfs_handle_struct *handle,
106 const struct smb_filename *smb_fname,
113 static NTSTATUS skel_snap_check_path(struct vfs_handle_struct *handle,
115 const char *service_path,
118 return NT_STATUS_NOT_SUPPORTED;
121 static NTSTATUS skel_snap_create(struct vfs_handle_struct *handle,
123 const char *base_volume,
129 return NT_STATUS_NOT_SUPPORTED;
132 static NTSTATUS skel_snap_delete(struct vfs_handle_struct *handle,
137 return NT_STATUS_NOT_SUPPORTED;
140 static DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
141 const char *mask, uint32_t attr)
146 static struct dirent *skel_readdir(vfs_handle_struct *handle,
147 DIR *dirp, SMB_STRUCT_STAT *sbuf)
152 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
157 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
162 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
167 static int skel_mkdir(vfs_handle_struct *handle,
168 const struct smb_filename *smb_fname,
175 static int skel_rmdir(vfs_handle_struct *handle,
176 const struct smb_filename *smb_fname)
182 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
188 static void skel_init_search_op(struct vfs_handle_struct *handle, DIR *dirp)
193 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
194 files_struct *fsp, int flags, mode_t mode)
200 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
201 struct smb_request *req,
202 uint16_t root_dir_fid,
203 struct smb_filename *smb_fname,
204 uint32_t access_mask,
205 uint32_t share_access,
206 uint32_t create_disposition,
207 uint32_t create_options,
208 uint32_t file_attributes,
209 uint32_t oplock_request,
210 struct smb2_lease *lease,
211 uint64_t allocation_size,
212 uint32_t private_flags,
213 struct security_descriptor *sd,
214 struct ea_list *ea_list,
215 files_struct **result, int *pinfo,
216 const struct smb2_create_blobs *in_context_blobs,
217 struct smb2_create_blobs *out_context_blobs)
219 return NT_STATUS_NOT_IMPLEMENTED;
222 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
228 static ssize_t skel_vfs_read(vfs_handle_struct *handle, files_struct *fsp,
229 void *data, size_t n)
235 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
236 void *data, size_t n, off_t offset)
242 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
244 struct tevent_context *ev,
245 struct files_struct *fsp,
246 void *data, size_t n, off_t offset)
251 static ssize_t skel_pread_recv(struct tevent_req *req,
252 struct vfs_aio_state *vfs_aio_state)
254 vfs_aio_state->error = ENOSYS;
258 static ssize_t skel_write(vfs_handle_struct *handle, files_struct *fsp,
259 const void *data, size_t n)
265 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
266 const void *data, size_t n, off_t offset)
272 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
274 struct tevent_context *ev,
275 struct files_struct *fsp,
277 size_t n, off_t offset)
282 static ssize_t skel_pwrite_recv(struct tevent_req *req,
283 struct vfs_aio_state *vfs_aio_state)
285 vfs_aio_state->error = ENOSYS;
289 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
290 off_t offset, int whence)
296 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
297 files_struct *fromfsp, const DATA_BLOB *hdr,
298 off_t offset, size_t n)
304 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
305 files_struct *tofsp, off_t offset, size_t n)
311 static int skel_rename(vfs_handle_struct *handle,
312 const struct smb_filename *smb_fname_src,
313 const struct smb_filename *smb_fname_dst)
319 static int skel_fsync(vfs_handle_struct *handle, files_struct *fsp)
325 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
327 struct tevent_context *ev,
328 struct files_struct *fsp)
333 static int skel_fsync_recv(struct tevent_req *req,
334 struct vfs_aio_state *vfs_aio_state)
336 vfs_aio_state->error = ENOSYS;
340 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
346 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
347 SMB_STRUCT_STAT *sbuf)
353 static int skel_lstat(vfs_handle_struct *handle,
354 struct smb_filename *smb_fname)
360 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
361 struct files_struct *fsp,
362 const SMB_STRUCT_STAT *sbuf)
368 static int skel_unlink(vfs_handle_struct *handle,
369 const struct smb_filename *smb_fname)
375 static int skel_chmod(vfs_handle_struct *handle,
376 const struct smb_filename *smb_fname,
383 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
390 static int skel_chown(vfs_handle_struct *handle,
391 const struct smb_filename *smb_fname,
399 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
400 uid_t uid, gid_t gid)
406 static int skel_lchown(vfs_handle_struct *handle,
407 const struct smb_filename *smb_fname,
415 static int skel_chdir(vfs_handle_struct *handle,
416 const struct smb_filename *smb_fname)
422 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
429 static int skel_ntimes(vfs_handle_struct *handle,
430 const struct smb_filename *smb_fname,
431 struct smb_file_time *ft)
437 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
444 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
445 uint32_t mode, off_t offset, off_t len)
451 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
452 off_t offset, off_t count, int type)
458 static int skel_kernel_flock(struct vfs_handle_struct *handle,
459 struct files_struct *fsp,
460 uint32_t share_mode, uint32_t access_mask)
466 static int skel_linux_setlease(struct vfs_handle_struct *handle,
467 struct files_struct *fsp, int leasetype)
473 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
474 off_t *poffset, off_t *pcount, int *ptype,
481 static int skel_symlink(vfs_handle_struct *handle,
482 const char *link_contents,
483 const struct smb_filename *new_smb_fname)
489 static int skel_vfs_readlink(vfs_handle_struct *handle,
490 const struct smb_filename *smb_fname,
498 static int skel_link(vfs_handle_struct *handle,
499 const struct smb_filename *old_smb_fname,
500 const struct smb_filename *new_smb_fname)
506 static int skel_mknod(vfs_handle_struct *handle,
507 const struct smb_filename *smb_fname,
515 static char *skel_realpath(vfs_handle_struct *handle, const char *path)
521 static int skel_chflags(vfs_handle_struct *handle,
522 const struct smb_filename *smb_fname,
529 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
530 const SMB_STRUCT_STAT *sbuf)
538 struct skel_cc_state {
541 static struct tevent_req *skel_copy_chunk_send(struct vfs_handle_struct *handle,
543 struct tevent_context *ev,
544 struct files_struct *src_fsp,
546 struct files_struct *dest_fsp,
551 struct tevent_req *req;
552 struct skel_cc_state *cc_state;
554 req = tevent_req_create(mem_ctx, &cc_state, struct skel_cc_state);
559 tevent_req_nterror(req, NT_STATUS_NOT_IMPLEMENTED);
560 return tevent_req_post(req, ev);
563 static NTSTATUS skel_copy_chunk_recv(struct vfs_handle_struct *handle,
564 struct tevent_req *req,
569 if (tevent_req_is_nterror(req, &status)) {
570 tevent_req_received(req);
573 tevent_req_received(req);
578 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
580 struct files_struct *fsp,
581 struct smb_filename *smb_fname,
582 uint16_t *_compression_fmt)
584 return NT_STATUS_INVALID_DEVICE_REQUEST;
587 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
589 struct files_struct *fsp,
590 uint16_t compression_fmt)
592 return NT_STATUS_INVALID_DEVICE_REQUEST;
595 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
596 struct files_struct *fsp,
597 const struct smb_filename *smb_fname,
599 unsigned int *num_streams,
600 struct stream_struct **streams)
602 return NT_STATUS_NOT_IMPLEMENTED;
605 static int skel_get_real_filename(struct vfs_handle_struct *handle,
608 TALLOC_CTX *mem_ctx, char **found_name)
614 static const char *skel_connectpath(struct vfs_handle_struct *handle,
615 const char *filename)
621 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
622 struct byte_range_lock *br_lck,
623 struct lock_struct *plock,
626 return NT_STATUS_NOT_IMPLEMENTED;
629 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
630 struct messaging_context *msg_ctx,
631 struct byte_range_lock *br_lck,
632 const struct lock_struct *plock)
638 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
639 struct byte_range_lock *br_lck,
640 struct lock_struct *plock)
646 static bool skel_strict_lock(struct vfs_handle_struct *handle,
647 struct files_struct *fsp,
648 struct lock_struct *plock)
654 static void skel_strict_unlock(struct vfs_handle_struct *handle,
655 struct files_struct *fsp,
656 struct lock_struct *plock)
661 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
662 const char *mapped_name,
663 enum vfs_translate_direction direction,
664 TALLOC_CTX *mem_ctx, char **pmapped_name)
666 return NT_STATUS_NOT_IMPLEMENTED;
669 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
670 struct files_struct *fsp,
673 uint16_t req_flags, /* Needed for UNICODE ... */
674 const uint8_t *_in_data,
677 uint32_t max_out_len, uint32_t *out_len)
679 return NT_STATUS_NOT_IMPLEMENTED;
682 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
683 const struct smb_filename *fname,
685 struct readdir_attr_data **pattr_data)
687 return NT_STATUS_NOT_IMPLEMENTED;
690 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
691 struct smb_filename *smb_fname,
694 return NT_STATUS_NOT_IMPLEMENTED;
697 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
698 struct files_struct *fsp,
701 return NT_STATUS_NOT_IMPLEMENTED;
704 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
705 const struct smb_filename *smb_fname,
708 return NT_STATUS_NOT_IMPLEMENTED;
711 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
712 struct files_struct *fsp,
715 return NT_STATUS_NOT_IMPLEMENTED;
718 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
719 uint32_t security_info,
721 struct security_descriptor **ppdesc)
723 return NT_STATUS_NOT_IMPLEMENTED;
726 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
727 const struct smb_filename *smb_fname,
728 uint32_t security_info,
730 struct security_descriptor **ppdesc)
732 return NT_STATUS_NOT_IMPLEMENTED;
735 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
736 uint32_t security_info_sent,
737 const struct security_descriptor *psd)
739 return NT_STATUS_NOT_IMPLEMENTED;
742 static int skel_chmod_acl(vfs_handle_struct *handle,
743 const struct smb_filename *smb_fname,
750 static int skel_fchmod_acl(vfs_handle_struct *handle, files_struct *fsp,
757 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
758 const struct smb_filename *smb_fname,
763 return (SMB_ACL_T) NULL;
766 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
767 files_struct *fsp, TALLOC_CTX *mem_ctx)
770 return (SMB_ACL_T) NULL;
773 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
774 const struct smb_filename *smb_fname,
776 char **blob_description,
783 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
784 files_struct *fsp, TALLOC_CTX *mem_ctx,
785 char **blob_description, DATA_BLOB *blob)
791 static int skel_sys_acl_set_file(vfs_handle_struct *handle,
792 const struct smb_filename *smb_fname,
793 SMB_ACL_TYPE_T acltype,
800 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
807 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
808 const struct smb_filename *smb_fname)
814 static ssize_t skel_getxattr(vfs_handle_struct *handle,
815 const struct smb_filename *smb_fname,
824 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
825 struct files_struct *fsp, const char *name,
826 void *value, size_t size)
832 static ssize_t skel_listxattr(vfs_handle_struct *handle,
833 const struct smb_filename *smb_fname,
841 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
842 struct files_struct *fsp, char *list,
849 static int skel_removexattr(vfs_handle_struct *handle,
850 const struct smb_filename *smb_fname,
857 static int skel_fremovexattr(vfs_handle_struct *handle,
858 struct files_struct *fsp, const char *name)
862 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
865 static int skel_setxattr(vfs_handle_struct *handle,
866 const struct smb_filename *smb_fname,
876 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
877 const char *name, const void *value, size_t size,
884 static bool skel_aio_force(struct vfs_handle_struct *handle,
885 struct files_struct *fsp)
891 /* VFS operations structure */
893 struct vfs_fn_pointers skel_opaque_fns = {
894 /* Disk operations */
896 .connect_fn = skel_connect,
897 .disconnect_fn = skel_disconnect,
898 .disk_free_fn = skel_disk_free,
899 .get_quota_fn = skel_get_quota,
900 .set_quota_fn = skel_set_quota,
901 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
902 .statvfs_fn = skel_statvfs,
903 .fs_capabilities_fn = skel_fs_capabilities,
904 .get_dfs_referrals_fn = skel_get_dfs_referrals,
905 .snap_check_path_fn = skel_snap_check_path,
906 .snap_create_fn = skel_snap_create,
907 .snap_delete_fn = skel_snap_delete,
909 /* Directory operations */
911 .opendir_fn = skel_opendir,
912 .fdopendir_fn = skel_fdopendir,
913 .readdir_fn = skel_readdir,
914 .seekdir_fn = skel_seekdir,
915 .telldir_fn = skel_telldir,
916 .rewind_dir_fn = skel_rewind_dir,
917 .mkdir_fn = skel_mkdir,
918 .rmdir_fn = skel_rmdir,
919 .closedir_fn = skel_closedir,
920 .init_search_op_fn = skel_init_search_op,
922 /* File operations */
924 .open_fn = skel_open,
925 .create_file_fn = skel_create_file,
926 .close_fn = skel_close_fn,
927 .read_fn = skel_vfs_read,
928 .pread_fn = skel_pread,
929 .pread_send_fn = skel_pread_send,
930 .pread_recv_fn = skel_pread_recv,
931 .write_fn = skel_write,
932 .pwrite_fn = skel_pwrite,
933 .pwrite_send_fn = skel_pwrite_send,
934 .pwrite_recv_fn = skel_pwrite_recv,
935 .lseek_fn = skel_lseek,
936 .sendfile_fn = skel_sendfile,
937 .recvfile_fn = skel_recvfile,
938 .rename_fn = skel_rename,
939 .fsync_fn = skel_fsync,
940 .fsync_send_fn = skel_fsync_send,
941 .fsync_recv_fn = skel_fsync_recv,
942 .stat_fn = skel_stat,
943 .fstat_fn = skel_fstat,
944 .lstat_fn = skel_lstat,
945 .get_alloc_size_fn = skel_get_alloc_size,
946 .unlink_fn = skel_unlink,
947 .chmod_fn = skel_chmod,
948 .fchmod_fn = skel_fchmod,
949 .chown_fn = skel_chown,
950 .fchown_fn = skel_fchown,
951 .lchown_fn = skel_lchown,
952 .chdir_fn = skel_chdir,
953 .getwd_fn = skel_getwd,
954 .ntimes_fn = skel_ntimes,
955 .ftruncate_fn = skel_ftruncate,
956 .fallocate_fn = skel_fallocate,
957 .lock_fn = skel_lock,
958 .kernel_flock_fn = skel_kernel_flock,
959 .linux_setlease_fn = skel_linux_setlease,
960 .getlock_fn = skel_getlock,
961 .symlink_fn = skel_symlink,
962 .readlink_fn = skel_vfs_readlink,
963 .link_fn = skel_link,
964 .mknod_fn = skel_mknod,
965 .realpath_fn = skel_realpath,
966 .chflags_fn = skel_chflags,
967 .file_id_create_fn = skel_file_id_create,
968 .copy_chunk_send_fn = skel_copy_chunk_send,
969 .copy_chunk_recv_fn = skel_copy_chunk_recv,
970 .get_compression_fn = skel_get_compression,
971 .set_compression_fn = skel_set_compression,
973 .streaminfo_fn = skel_streaminfo,
974 .get_real_filename_fn = skel_get_real_filename,
975 .connectpath_fn = skel_connectpath,
976 .brl_lock_windows_fn = skel_brl_lock_windows,
977 .brl_unlock_windows_fn = skel_brl_unlock_windows,
978 .brl_cancel_windows_fn = skel_brl_cancel_windows,
979 .strict_lock_fn = skel_strict_lock,
980 .strict_unlock_fn = skel_strict_unlock,
981 .translate_name_fn = skel_translate_name,
982 .fsctl_fn = skel_fsctl,
983 .readdir_attr_fn = skel_readdir_attr,
985 /* DOS attributes. */
986 .get_dos_attributes_fn = skel_get_dos_attributes,
987 .fget_dos_attributes_fn = skel_fget_dos_attributes,
988 .set_dos_attributes_fn = skel_set_dos_attributes,
989 .fset_dos_attributes_fn = skel_fset_dos_attributes,
991 /* NT ACL operations. */
993 .fget_nt_acl_fn = skel_fget_nt_acl,
994 .get_nt_acl_fn = skel_get_nt_acl,
995 .fset_nt_acl_fn = skel_fset_nt_acl,
997 /* POSIX ACL operations. */
999 .chmod_acl_fn = skel_chmod_acl,
1000 .fchmod_acl_fn = skel_fchmod_acl,
1002 .sys_acl_get_file_fn = skel_sys_acl_get_file,
1003 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
1004 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
1005 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
1006 .sys_acl_set_file_fn = skel_sys_acl_set_file,
1007 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
1008 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1010 /* EA operations. */
1011 .getxattr_fn = skel_getxattr,
1012 .fgetxattr_fn = skel_fgetxattr,
1013 .listxattr_fn = skel_listxattr,
1014 .flistxattr_fn = skel_flistxattr,
1015 .removexattr_fn = skel_removexattr,
1016 .fremovexattr_fn = skel_fremovexattr,
1017 .setxattr_fn = skel_setxattr,
1018 .fsetxattr_fn = skel_fsetxattr,
1020 /* aio operations */
1021 .aio_force_fn = skel_aio_force,
1025 NTSTATUS vfs_skel_opaque_init(TALLOC_CTX *ctx)
1027 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_opaque",