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 int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
189 files_struct *fsp, int flags, mode_t mode)
195 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
196 struct smb_request *req,
197 uint16_t root_dir_fid,
198 struct smb_filename *smb_fname,
199 uint32_t access_mask,
200 uint32_t share_access,
201 uint32_t create_disposition,
202 uint32_t create_options,
203 uint32_t file_attributes,
204 uint32_t oplock_request,
205 struct smb2_lease *lease,
206 uint64_t allocation_size,
207 uint32_t private_flags,
208 struct security_descriptor *sd,
209 struct ea_list *ea_list,
210 files_struct **result, int *pinfo,
211 const struct smb2_create_blobs *in_context_blobs,
212 struct smb2_create_blobs *out_context_blobs)
214 return NT_STATUS_NOT_IMPLEMENTED;
217 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
223 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
224 void *data, size_t n, off_t offset)
230 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
232 struct tevent_context *ev,
233 struct files_struct *fsp,
234 void *data, size_t n, off_t offset)
239 static ssize_t skel_pread_recv(struct tevent_req *req,
240 struct vfs_aio_state *vfs_aio_state)
242 vfs_aio_state->error = ENOSYS;
246 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
247 const void *data, size_t n, off_t offset)
253 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
255 struct tevent_context *ev,
256 struct files_struct *fsp,
258 size_t n, off_t offset)
263 static ssize_t skel_pwrite_recv(struct tevent_req *req,
264 struct vfs_aio_state *vfs_aio_state)
266 vfs_aio_state->error = ENOSYS;
270 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
271 off_t offset, int whence)
277 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
278 files_struct *fromfsp, const DATA_BLOB *hdr,
279 off_t offset, size_t n)
285 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
286 files_struct *tofsp, off_t offset, size_t n)
292 static int skel_rename(vfs_handle_struct *handle,
293 const struct smb_filename *smb_fname_src,
294 const struct smb_filename *smb_fname_dst)
300 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
302 struct tevent_context *ev,
303 struct files_struct *fsp)
308 static int skel_fsync_recv(struct tevent_req *req,
309 struct vfs_aio_state *vfs_aio_state)
311 vfs_aio_state->error = ENOSYS;
315 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
321 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
322 SMB_STRUCT_STAT *sbuf)
328 static int skel_lstat(vfs_handle_struct *handle,
329 struct smb_filename *smb_fname)
335 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
336 struct files_struct *fsp,
337 const SMB_STRUCT_STAT *sbuf)
343 static int skel_unlink(vfs_handle_struct *handle,
344 const struct smb_filename *smb_fname)
350 static int skel_chmod(vfs_handle_struct *handle,
351 const struct smb_filename *smb_fname,
358 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
365 static int skel_chown(vfs_handle_struct *handle,
366 const struct smb_filename *smb_fname,
374 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
375 uid_t uid, gid_t gid)
381 static int skel_lchown(vfs_handle_struct *handle,
382 const struct smb_filename *smb_fname,
390 static int skel_chdir(vfs_handle_struct *handle,
391 const struct smb_filename *smb_fname)
397 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
404 static int skel_ntimes(vfs_handle_struct *handle,
405 const struct smb_filename *smb_fname,
406 struct smb_file_time *ft)
412 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
419 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
420 uint32_t mode, off_t offset, off_t len)
426 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
427 off_t offset, off_t count, int type)
433 static int skel_kernel_flock(struct vfs_handle_struct *handle,
434 struct files_struct *fsp,
435 uint32_t share_mode, uint32_t access_mask)
441 static int skel_linux_setlease(struct vfs_handle_struct *handle,
442 struct files_struct *fsp, int leasetype)
448 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
449 off_t *poffset, off_t *pcount, int *ptype,
456 static int skel_symlink(vfs_handle_struct *handle,
457 const char *link_contents,
458 const struct smb_filename *new_smb_fname)
464 static int skel_vfs_readlink(vfs_handle_struct *handle,
465 const struct smb_filename *smb_fname,
473 static int skel_link(vfs_handle_struct *handle,
474 const struct smb_filename *old_smb_fname,
475 const struct smb_filename *new_smb_fname)
481 static int skel_mknod(vfs_handle_struct *handle,
482 const struct smb_filename *smb_fname,
490 static struct smb_filename *skel_realpath(vfs_handle_struct *handle,
492 const struct smb_filename *smb_fname)
498 static int skel_chflags(vfs_handle_struct *handle,
499 const struct smb_filename *smb_fname,
506 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
507 const SMB_STRUCT_STAT *sbuf)
515 struct skel_offload_read_state {
519 static struct tevent_req *skel_offload_read_send(
521 struct tevent_context *ev,
522 struct vfs_handle_struct *handle,
523 struct files_struct *fsp,
529 struct tevent_req *req = NULL;
530 struct skel_offload_read_state *state = NULL;
532 req = tevent_req_create(mem_ctx, &state, struct skel_offload_read_state);
537 tevent_req_nterror(req, NT_STATUS_NOT_IMPLEMENTED);
538 return tevent_req_post(req, ev);
541 static NTSTATUS skel_offload_read_recv(struct tevent_req *req,
542 struct vfs_handle_struct *handle,
544 DATA_BLOB *_token_blob)
548 if (tevent_req_is_nterror(req, &status)) {
549 tevent_req_received(req);
552 tevent_req_received(req);
557 struct skel_cc_state {
560 static struct tevent_req *skel_offload_write_send(struct vfs_handle_struct *handle,
562 struct tevent_context *ev,
565 off_t transfer_offset,
566 struct files_struct *dest_fsp,
570 struct tevent_req *req;
571 struct skel_cc_state *cc_state;
573 req = tevent_req_create(mem_ctx, &cc_state, struct skel_cc_state);
578 tevent_req_nterror(req, NT_STATUS_NOT_IMPLEMENTED);
579 return tevent_req_post(req, ev);
582 static NTSTATUS skel_offload_write_recv(struct vfs_handle_struct *handle,
583 struct tevent_req *req,
588 if (tevent_req_is_nterror(req, &status)) {
589 tevent_req_received(req);
592 tevent_req_received(req);
597 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
599 struct files_struct *fsp,
600 struct smb_filename *smb_fname,
601 uint16_t *_compression_fmt)
603 return NT_STATUS_INVALID_DEVICE_REQUEST;
606 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
608 struct files_struct *fsp,
609 uint16_t compression_fmt)
611 return NT_STATUS_INVALID_DEVICE_REQUEST;
614 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
615 struct files_struct *fsp,
616 const struct smb_filename *smb_fname,
618 unsigned int *num_streams,
619 struct stream_struct **streams)
621 return NT_STATUS_NOT_IMPLEMENTED;
624 static int skel_get_real_filename(struct vfs_handle_struct *handle,
627 TALLOC_CTX *mem_ctx, char **found_name)
633 static const char *skel_connectpath(struct vfs_handle_struct *handle,
634 const struct smb_filename *smb_fname)
640 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
641 struct byte_range_lock *br_lck,
642 struct lock_struct *plock,
645 return NT_STATUS_NOT_IMPLEMENTED;
648 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
649 struct messaging_context *msg_ctx,
650 struct byte_range_lock *br_lck,
651 const struct lock_struct *plock)
657 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
658 struct byte_range_lock *br_lck,
659 struct lock_struct *plock)
665 static bool skel_strict_lock_check(struct vfs_handle_struct *handle,
666 struct files_struct *fsp,
667 struct lock_struct *plock)
673 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
674 const char *mapped_name,
675 enum vfs_translate_direction direction,
676 TALLOC_CTX *mem_ctx, char **pmapped_name)
678 return NT_STATUS_NOT_IMPLEMENTED;
681 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
682 struct files_struct *fsp,
685 uint16_t req_flags, /* Needed for UNICODE ... */
686 const uint8_t *_in_data,
689 uint32_t max_out_len, uint32_t *out_len)
691 return NT_STATUS_NOT_IMPLEMENTED;
694 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
695 const struct smb_filename *fname,
697 struct readdir_attr_data **pattr_data)
699 return NT_STATUS_NOT_IMPLEMENTED;
702 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
703 struct smb_filename *smb_fname,
706 return NT_STATUS_NOT_IMPLEMENTED;
709 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
710 struct files_struct *fsp,
713 return NT_STATUS_NOT_IMPLEMENTED;
716 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
717 const struct smb_filename *smb_fname,
720 return NT_STATUS_NOT_IMPLEMENTED;
723 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
724 struct files_struct *fsp,
727 return NT_STATUS_NOT_IMPLEMENTED;
730 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
731 uint32_t security_info,
733 struct security_descriptor **ppdesc)
735 return NT_STATUS_NOT_IMPLEMENTED;
738 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
739 const struct smb_filename *smb_fname,
740 uint32_t security_info,
742 struct security_descriptor **ppdesc)
744 return NT_STATUS_NOT_IMPLEMENTED;
747 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
748 uint32_t security_info_sent,
749 const struct security_descriptor *psd)
751 return NT_STATUS_NOT_IMPLEMENTED;
754 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
755 const struct smb_filename *smb_fname,
760 return (SMB_ACL_T) NULL;
763 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
764 files_struct *fsp, TALLOC_CTX *mem_ctx)
767 return (SMB_ACL_T) NULL;
770 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
771 const struct smb_filename *smb_fname,
773 char **blob_description,
780 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
781 files_struct *fsp, TALLOC_CTX *mem_ctx,
782 char **blob_description, DATA_BLOB *blob)
788 static int skel_sys_acl_set_file(vfs_handle_struct *handle,
789 const struct smb_filename *smb_fname,
790 SMB_ACL_TYPE_T acltype,
797 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
804 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
805 const struct smb_filename *smb_fname)
811 static ssize_t skel_getxattr(vfs_handle_struct *handle,
812 const struct smb_filename *smb_fname,
821 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
822 struct files_struct *fsp, const char *name,
823 void *value, size_t size)
829 static ssize_t skel_listxattr(vfs_handle_struct *handle,
830 const struct smb_filename *smb_fname,
838 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
839 struct files_struct *fsp, char *list,
846 static int skel_removexattr(vfs_handle_struct *handle,
847 const struct smb_filename *smb_fname,
854 static int skel_fremovexattr(vfs_handle_struct *handle,
855 struct files_struct *fsp, const char *name)
859 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
862 static int skel_setxattr(vfs_handle_struct *handle,
863 const struct smb_filename *smb_fname,
873 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
874 const char *name, const void *value, size_t size,
881 static bool skel_aio_force(struct vfs_handle_struct *handle,
882 struct files_struct *fsp)
888 /* VFS operations structure */
890 struct vfs_fn_pointers skel_opaque_fns = {
891 /* Disk operations */
893 .connect_fn = skel_connect,
894 .disconnect_fn = skel_disconnect,
895 .disk_free_fn = skel_disk_free,
896 .get_quota_fn = skel_get_quota,
897 .set_quota_fn = skel_set_quota,
898 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
899 .statvfs_fn = skel_statvfs,
900 .fs_capabilities_fn = skel_fs_capabilities,
901 .get_dfs_referrals_fn = skel_get_dfs_referrals,
902 .snap_check_path_fn = skel_snap_check_path,
903 .snap_create_fn = skel_snap_create,
904 .snap_delete_fn = skel_snap_delete,
906 /* Directory operations */
908 .opendir_fn = skel_opendir,
909 .fdopendir_fn = skel_fdopendir,
910 .readdir_fn = skel_readdir,
911 .seekdir_fn = skel_seekdir,
912 .telldir_fn = skel_telldir,
913 .rewind_dir_fn = skel_rewind_dir,
914 .mkdir_fn = skel_mkdir,
915 .rmdir_fn = skel_rmdir,
916 .closedir_fn = skel_closedir,
918 /* File operations */
920 .open_fn = skel_open,
921 .create_file_fn = skel_create_file,
922 .close_fn = skel_close_fn,
923 .pread_fn = skel_pread,
924 .pread_send_fn = skel_pread_send,
925 .pread_recv_fn = skel_pread_recv,
926 .pwrite_fn = skel_pwrite,
927 .pwrite_send_fn = skel_pwrite_send,
928 .pwrite_recv_fn = skel_pwrite_recv,
929 .lseek_fn = skel_lseek,
930 .sendfile_fn = skel_sendfile,
931 .recvfile_fn = skel_recvfile,
932 .rename_fn = skel_rename,
933 .fsync_send_fn = skel_fsync_send,
934 .fsync_recv_fn = skel_fsync_recv,
935 .stat_fn = skel_stat,
936 .fstat_fn = skel_fstat,
937 .lstat_fn = skel_lstat,
938 .get_alloc_size_fn = skel_get_alloc_size,
939 .unlink_fn = skel_unlink,
940 .chmod_fn = skel_chmod,
941 .fchmod_fn = skel_fchmod,
942 .chown_fn = skel_chown,
943 .fchown_fn = skel_fchown,
944 .lchown_fn = skel_lchown,
945 .chdir_fn = skel_chdir,
946 .getwd_fn = skel_getwd,
947 .ntimes_fn = skel_ntimes,
948 .ftruncate_fn = skel_ftruncate,
949 .fallocate_fn = skel_fallocate,
950 .lock_fn = skel_lock,
951 .kernel_flock_fn = skel_kernel_flock,
952 .linux_setlease_fn = skel_linux_setlease,
953 .getlock_fn = skel_getlock,
954 .symlink_fn = skel_symlink,
955 .readlink_fn = skel_vfs_readlink,
956 .link_fn = skel_link,
957 .mknod_fn = skel_mknod,
958 .realpath_fn = skel_realpath,
959 .chflags_fn = skel_chflags,
960 .file_id_create_fn = skel_file_id_create,
961 .offload_read_send_fn = skel_offload_read_send,
962 .offload_read_recv_fn = skel_offload_read_recv,
963 .offload_write_send_fn = skel_offload_write_send,
964 .offload_write_recv_fn = skel_offload_write_recv,
965 .get_compression_fn = skel_get_compression,
966 .set_compression_fn = skel_set_compression,
968 .streaminfo_fn = skel_streaminfo,
969 .get_real_filename_fn = skel_get_real_filename,
970 .connectpath_fn = skel_connectpath,
971 .brl_lock_windows_fn = skel_brl_lock_windows,
972 .brl_unlock_windows_fn = skel_brl_unlock_windows,
973 .brl_cancel_windows_fn = skel_brl_cancel_windows,
974 .strict_lock_check_fn = skel_strict_lock_check,
975 .translate_name_fn = skel_translate_name,
976 .fsctl_fn = skel_fsctl,
977 .readdir_attr_fn = skel_readdir_attr,
979 /* DOS attributes. */
980 .get_dos_attributes_fn = skel_get_dos_attributes,
981 .fget_dos_attributes_fn = skel_fget_dos_attributes,
982 .set_dos_attributes_fn = skel_set_dos_attributes,
983 .fset_dos_attributes_fn = skel_fset_dos_attributes,
985 /* NT ACL operations. */
987 .fget_nt_acl_fn = skel_fget_nt_acl,
988 .get_nt_acl_fn = skel_get_nt_acl,
989 .fset_nt_acl_fn = skel_fset_nt_acl,
991 /* POSIX ACL operations. */
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",