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, 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,
58 unid_t id, SMB_DISK_QUOTA *dq)
64 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype,
65 unid_t id, SMB_DISK_QUOTA *dq)
71 static int skel_get_shadow_copy_data(vfs_handle_struct *handle,
73 struct shadow_copy_data *shadow_copy_data,
80 static int skel_statvfs(struct vfs_handle_struct *handle,
81 const char *path, struct vfs_statvfs_struct *statbuf)
87 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle,
88 enum timestamp_set_resolution *p_ts_res)
93 static NTSTATUS skel_get_dfs_referrals(struct vfs_handle_struct *handle,
94 struct dfs_GetDFSReferral *r)
96 return NT_STATUS_NOT_IMPLEMENTED;
99 static DIR *skel_opendir(vfs_handle_struct *handle, const char *fname,
100 const char *mask, uint32 attr)
105 static DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
106 const char *mask, uint32 attr)
111 static struct dirent *skel_readdir(vfs_handle_struct *handle,
112 DIR *dirp, SMB_STRUCT_STAT *sbuf)
117 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
122 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
127 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
132 static int skel_mkdir(vfs_handle_struct *handle, const char *path, mode_t mode)
138 static int skel_rmdir(vfs_handle_struct *handle, const char *path)
144 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
150 static void skel_init_search_op(struct vfs_handle_struct *handle, DIR *dirp)
155 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
156 files_struct *fsp, int flags, mode_t mode)
162 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
163 struct smb_request *req,
164 uint16_t root_dir_fid,
165 struct smb_filename *smb_fname,
166 uint32_t access_mask,
167 uint32_t share_access,
168 uint32_t create_disposition,
169 uint32_t create_options,
170 uint32_t file_attributes,
171 uint32_t oplock_request,
172 uint64_t allocation_size,
173 uint32_t private_flags,
174 struct security_descriptor *sd,
175 struct ea_list *ea_list,
176 files_struct **result, int *pinfo)
178 return NT_STATUS_NOT_IMPLEMENTED;
181 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
187 static ssize_t skel_vfs_read(vfs_handle_struct *handle, files_struct *fsp,
188 void *data, size_t n)
194 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
195 void *data, size_t n, off_t offset)
201 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
203 struct tevent_context *ev,
204 struct files_struct *fsp,
205 void *data, size_t n, off_t offset)
210 static ssize_t skel_pread_recv(struct tevent_req *req, int *err)
216 static ssize_t skel_write(vfs_handle_struct *handle, files_struct *fsp,
217 const void *data, size_t n)
223 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
224 const void *data, size_t n, off_t offset)
230 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
232 struct tevent_context *ev,
233 struct files_struct *fsp,
235 size_t n, off_t offset)
240 static ssize_t skel_pwrite_recv(struct tevent_req *req, int *err)
246 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
247 off_t offset, int whence)
253 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
254 files_struct *fromfsp, const DATA_BLOB *hdr,
255 off_t offset, size_t n)
261 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
262 files_struct *tofsp, off_t offset, size_t n)
268 static int skel_rename(vfs_handle_struct *handle,
269 const struct smb_filename *smb_fname_src,
270 const struct smb_filename *smb_fname_dst)
276 static int skel_fsync(vfs_handle_struct *handle, files_struct *fsp)
282 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
284 struct tevent_context *ev,
285 struct files_struct *fsp)
290 static int skel_fsync_recv(struct tevent_req *req, int *err)
296 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
302 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
303 SMB_STRUCT_STAT *sbuf)
309 static int skel_lstat(vfs_handle_struct *handle,
310 struct smb_filename *smb_fname)
316 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
317 struct files_struct *fsp,
318 const SMB_STRUCT_STAT *sbuf)
324 static int skel_unlink(vfs_handle_struct *handle,
325 const struct smb_filename *smb_fname)
331 static int skel_chmod(vfs_handle_struct *handle, const char *path, mode_t mode)
337 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
344 static int skel_chown(vfs_handle_struct *handle, const char *path,
345 uid_t uid, gid_t gid)
351 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
352 uid_t uid, gid_t gid)
358 static int skel_lchown(vfs_handle_struct *handle, const char *path,
359 uid_t uid, gid_t gid)
365 static int skel_chdir(vfs_handle_struct *handle, const char *path)
371 static char *skel_getwd(vfs_handle_struct *handle)
377 static int skel_ntimes(vfs_handle_struct *handle,
378 const struct smb_filename *smb_fname,
379 struct smb_file_time *ft)
385 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
392 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
393 enum vfs_fallocate_mode mode, off_t offset, off_t len)
399 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
400 off_t offset, off_t count, int type)
406 static int skel_kernel_flock(struct vfs_handle_struct *handle,
407 struct files_struct *fsp,
408 uint32 share_mode, uint32 access_mask)
414 static int skel_linux_setlease(struct vfs_handle_struct *handle,
415 struct files_struct *fsp, int leasetype)
421 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
422 off_t *poffset, off_t *pcount, int *ptype,
429 static int skel_symlink(vfs_handle_struct *handle, const char *oldpath,
436 static int skel_vfs_readlink(vfs_handle_struct *handle, const char *path,
437 char *buf, size_t bufsiz)
443 static int skel_link(vfs_handle_struct *handle, const char *oldpath,
450 static int skel_mknod(vfs_handle_struct *handle, const char *path, mode_t mode,
457 static char *skel_realpath(vfs_handle_struct *handle, const char *path)
463 static NTSTATUS skel_notify_watch(struct vfs_handle_struct *handle,
464 struct sys_notify_context *ctx,
467 uint32_t *subdir_filter,
468 void (*callback) (struct sys_notify_context *
469 ctx, void *private_data,
470 struct notify_event *ev),
471 void *private_data, void *handle_p)
473 return NT_STATUS_NOT_IMPLEMENTED;
476 static int skel_chflags(vfs_handle_struct *handle, const char *path,
483 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
484 const SMB_STRUCT_STAT *sbuf)
492 struct skel_cc_state {
495 static struct tevent_req *skel_copy_chunk_send(struct vfs_handle_struct *handle,
497 struct tevent_context *ev,
498 struct files_struct *src_fsp,
500 struct files_struct *dest_fsp,
504 struct tevent_req *req;
505 struct skel_cc_state *cc_state;
507 req = tevent_req_create(mem_ctx, &cc_state, struct skel_cc_state);
512 tevent_req_nterror(req, NT_STATUS_NOT_IMPLEMENTED);
513 return tevent_req_post(req, ev);
516 static NTSTATUS skel_copy_chunk_recv(struct vfs_handle_struct *handle,
517 struct tevent_req *req,
522 if (tevent_req_is_nterror(req, &status)) {
523 tevent_req_received(req);
526 tevent_req_received(req);
531 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
532 struct files_struct *fsp,
535 unsigned int *num_streams,
536 struct stream_struct **streams)
538 return NT_STATUS_NOT_IMPLEMENTED;
541 static int skel_get_real_filename(struct vfs_handle_struct *handle,
544 TALLOC_CTX *mem_ctx, char **found_name)
550 static const char *skel_connectpath(struct vfs_handle_struct *handle,
551 const char *filename)
557 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
558 struct byte_range_lock *br_lck,
559 struct lock_struct *plock,
561 struct blocking_lock_record *blr)
563 return NT_STATUS_NOT_IMPLEMENTED;
566 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
567 struct messaging_context *msg_ctx,
568 struct byte_range_lock *br_lck,
569 const struct lock_struct *plock)
575 static bool skel_brl_cancel_windows(struct vfs_handle_struct *handle,
576 struct byte_range_lock *br_lck,
577 struct lock_struct *plock,
578 struct blocking_lock_record *blr)
584 static bool skel_strict_lock(struct vfs_handle_struct *handle,
585 struct files_struct *fsp,
586 struct lock_struct *plock)
592 static void skel_strict_unlock(struct vfs_handle_struct *handle,
593 struct files_struct *fsp,
594 struct lock_struct *plock)
599 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
600 const char *mapped_name,
601 enum vfs_translate_direction direction,
602 TALLOC_CTX *mem_ctx, char **pmapped_name)
604 return NT_STATUS_NOT_IMPLEMENTED;
607 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
608 struct files_struct *fsp,
611 uint16_t req_flags, /* Needed for UNICODE ... */
612 const uint8_t *_in_data,
615 uint32_t max_out_len, uint32_t *out_len)
617 return NT_STATUS_NOT_IMPLEMENTED;
620 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
621 uint32 security_info,
623 struct security_descriptor **ppdesc)
625 return NT_STATUS_NOT_IMPLEMENTED;
628 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
629 const char *name, uint32 security_info,
631 struct security_descriptor **ppdesc)
633 return NT_STATUS_NOT_IMPLEMENTED;
636 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
637 uint32 security_info_sent,
638 const struct security_descriptor *psd)
640 return NT_STATUS_NOT_IMPLEMENTED;
643 static int skel_chmod_acl(vfs_handle_struct *handle, const char *name,
650 static int skel_fchmod_acl(vfs_handle_struct *handle, files_struct *fsp,
657 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
663 return (SMB_ACL_T) NULL;
666 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
667 files_struct *fsp, TALLOC_CTX *mem_ctx)
670 return (SMB_ACL_T) NULL;
673 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
674 const char *path_p, TALLOC_CTX *mem_ctx,
675 char **blob_description, DATA_BLOB *blob)
681 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
682 files_struct *fsp, TALLOC_CTX *mem_ctx,
683 char **blob_description, DATA_BLOB *blob)
689 static int skel_sys_acl_set_file(vfs_handle_struct *handle, const char *name,
690 SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl)
696 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
703 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
710 static ssize_t skel_getxattr(vfs_handle_struct *handle, const char *path,
711 const char *name, void *value, size_t size)
717 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
718 struct files_struct *fsp, const char *name,
719 void *value, size_t size)
725 static ssize_t skel_listxattr(vfs_handle_struct *handle, const char *path,
726 char *list, size_t size)
732 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
733 struct files_struct *fsp, char *list,
740 static int skel_removexattr(vfs_handle_struct *handle, const char *path,
747 static int skel_fremovexattr(vfs_handle_struct *handle,
748 struct files_struct *fsp, const char *name)
752 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
755 static int skel_setxattr(vfs_handle_struct *handle, const char *path,
756 const char *name, const void *value, size_t size,
763 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
764 const char *name, const void *value, size_t size,
771 static bool skel_aio_force(struct vfs_handle_struct *handle,
772 struct files_struct *fsp)
778 static bool skel_is_offline(struct vfs_handle_struct *handle,
779 const struct smb_filename *fname,
780 SMB_STRUCT_STAT *sbuf)
786 static int skel_set_offline(struct vfs_handle_struct *handle,
787 const struct smb_filename *fname)
793 /* VFS operations structure */
795 struct vfs_fn_pointers skel_opaque_fns = {
796 /* Disk operations */
798 .connect_fn = skel_connect,
799 .disconnect_fn = skel_disconnect,
800 .disk_free_fn = skel_disk_free,
801 .get_quota_fn = skel_get_quota,
802 .set_quota_fn = skel_set_quota,
803 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
804 .statvfs_fn = skel_statvfs,
805 .fs_capabilities_fn = skel_fs_capabilities,
806 .get_dfs_referrals_fn = skel_get_dfs_referrals,
808 /* Directory operations */
810 .opendir_fn = skel_opendir,
811 .fdopendir_fn = skel_fdopendir,
812 .readdir_fn = skel_readdir,
813 .seekdir_fn = skel_seekdir,
814 .telldir_fn = skel_telldir,
815 .rewind_dir_fn = skel_rewind_dir,
816 .mkdir_fn = skel_mkdir,
817 .rmdir_fn = skel_rmdir,
818 .closedir_fn = skel_closedir,
819 .init_search_op_fn = skel_init_search_op,
821 /* File operations */
823 .open_fn = skel_open,
824 .create_file_fn = skel_create_file,
825 .close_fn = skel_close_fn,
826 .read_fn = skel_vfs_read,
827 .pread_fn = skel_pread,
828 .pread_send_fn = skel_pread_send,
829 .pread_recv_fn = skel_pread_recv,
830 .write_fn = skel_write,
831 .pwrite_fn = skel_pwrite,
832 .pwrite_send_fn = skel_pwrite_send,
833 .pwrite_recv_fn = skel_pwrite_recv,
834 .lseek_fn = skel_lseek,
835 .sendfile_fn = skel_sendfile,
836 .recvfile_fn = skel_recvfile,
837 .rename_fn = skel_rename,
838 .fsync_fn = skel_fsync,
839 .fsync_send_fn = skel_fsync_send,
840 .fsync_recv_fn = skel_fsync_recv,
841 .stat_fn = skel_stat,
842 .fstat_fn = skel_fstat,
843 .lstat_fn = skel_lstat,
844 .get_alloc_size_fn = skel_get_alloc_size,
845 .unlink_fn = skel_unlink,
846 .chmod_fn = skel_chmod,
847 .fchmod_fn = skel_fchmod,
848 .chown_fn = skel_chown,
849 .fchown_fn = skel_fchown,
850 .lchown_fn = skel_lchown,
851 .chdir_fn = skel_chdir,
852 .getwd_fn = skel_getwd,
853 .ntimes_fn = skel_ntimes,
854 .ftruncate_fn = skel_ftruncate,
855 .fallocate_fn = skel_fallocate,
856 .lock_fn = skel_lock,
857 .kernel_flock_fn = skel_kernel_flock,
858 .linux_setlease_fn = skel_linux_setlease,
859 .getlock_fn = skel_getlock,
860 .symlink_fn = skel_symlink,
861 .readlink_fn = skel_vfs_readlink,
862 .link_fn = skel_link,
863 .mknod_fn = skel_mknod,
864 .realpath_fn = skel_realpath,
865 .notify_watch_fn = skel_notify_watch,
866 .chflags_fn = skel_chflags,
867 .file_id_create_fn = skel_file_id_create,
868 .copy_chunk_send_fn = skel_copy_chunk_send,
869 .copy_chunk_recv_fn = skel_copy_chunk_recv,
871 .streaminfo_fn = skel_streaminfo,
872 .get_real_filename_fn = skel_get_real_filename,
873 .connectpath_fn = skel_connectpath,
874 .brl_lock_windows_fn = skel_brl_lock_windows,
875 .brl_unlock_windows_fn = skel_brl_unlock_windows,
876 .brl_cancel_windows_fn = skel_brl_cancel_windows,
877 .strict_lock_fn = skel_strict_lock,
878 .strict_unlock_fn = skel_strict_unlock,
879 .translate_name_fn = skel_translate_name,
880 .fsctl_fn = skel_fsctl,
882 /* NT ACL operations. */
884 .fget_nt_acl_fn = skel_fget_nt_acl,
885 .get_nt_acl_fn = skel_get_nt_acl,
886 .fset_nt_acl_fn = skel_fset_nt_acl,
888 /* POSIX ACL operations. */
890 .chmod_acl_fn = skel_chmod_acl,
891 .fchmod_acl_fn = skel_fchmod_acl,
893 .sys_acl_get_file_fn = skel_sys_acl_get_file,
894 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
895 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
896 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
897 .sys_acl_set_file_fn = skel_sys_acl_set_file,
898 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
899 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
902 .getxattr_fn = skel_getxattr,
903 .fgetxattr_fn = skel_fgetxattr,
904 .listxattr_fn = skel_listxattr,
905 .flistxattr_fn = skel_flistxattr,
906 .removexattr_fn = skel_removexattr,
907 .fremovexattr_fn = skel_fremovexattr,
908 .setxattr_fn = skel_setxattr,
909 .fsetxattr_fn = skel_fsetxattr,
912 .aio_force_fn = skel_aio_force,
914 /* offline operations */
915 .is_offline_fn = skel_is_offline,
916 .set_offline_fn = skel_set_offline
919 NTSTATUS vfs_skel_opaque_init(void)
921 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_opaque",