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
,
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_t attr
)
105 static NTSTATUS
skel_snap_check_path(struct vfs_handle_struct
*handle
,
107 const char *service_path
,
110 return NT_STATUS_NOT_SUPPORTED
;
113 static NTSTATUS
skel_snap_create(struct vfs_handle_struct
*handle
,
115 const char *base_volume
,
121 return NT_STATUS_NOT_SUPPORTED
;
124 static NTSTATUS
skel_snap_delete(struct vfs_handle_struct
*handle
,
129 return NT_STATUS_NOT_SUPPORTED
;
132 static DIR *skel_fdopendir(vfs_handle_struct
*handle
, files_struct
*fsp
,
133 const char *mask
, uint32_t attr
)
138 static struct dirent
*skel_readdir(vfs_handle_struct
*handle
,
139 DIR *dirp
, SMB_STRUCT_STAT
*sbuf
)
144 static void skel_seekdir(vfs_handle_struct
*handle
, DIR *dirp
, long offset
)
149 static long skel_telldir(vfs_handle_struct
*handle
, DIR *dirp
)
154 static void skel_rewind_dir(vfs_handle_struct
*handle
, DIR *dirp
)
159 static int skel_mkdir(vfs_handle_struct
*handle
, const char *path
, mode_t mode
)
165 static int skel_rmdir(vfs_handle_struct
*handle
, const char *path
)
171 static int skel_closedir(vfs_handle_struct
*handle
, DIR *dir
)
177 static void skel_init_search_op(struct vfs_handle_struct
*handle
, DIR *dirp
)
182 static int skel_open(vfs_handle_struct
*handle
, struct smb_filename
*smb_fname
,
183 files_struct
*fsp
, int flags
, mode_t mode
)
189 static NTSTATUS
skel_create_file(struct vfs_handle_struct
*handle
,
190 struct smb_request
*req
,
191 uint16_t root_dir_fid
,
192 struct smb_filename
*smb_fname
,
193 uint32_t access_mask
,
194 uint32_t share_access
,
195 uint32_t create_disposition
,
196 uint32_t create_options
,
197 uint32_t file_attributes
,
198 uint32_t oplock_request
,
199 struct smb2_lease
*lease
,
200 uint64_t allocation_size
,
201 uint32_t private_flags
,
202 struct security_descriptor
*sd
,
203 struct ea_list
*ea_list
,
204 files_struct
**result
, int *pinfo
,
205 const struct smb2_create_blobs
*in_context_blobs
,
206 struct smb2_create_blobs
*out_context_blobs
)
208 return NT_STATUS_NOT_IMPLEMENTED
;
211 static int skel_close_fn(vfs_handle_struct
*handle
, files_struct
*fsp
)
217 static ssize_t
skel_vfs_read(vfs_handle_struct
*handle
, files_struct
*fsp
,
218 void *data
, size_t n
)
224 static ssize_t
skel_pread(vfs_handle_struct
*handle
, files_struct
*fsp
,
225 void *data
, size_t n
, off_t offset
)
231 static struct tevent_req
*skel_pread_send(struct vfs_handle_struct
*handle
,
233 struct tevent_context
*ev
,
234 struct files_struct
*fsp
,
235 void *data
, size_t n
, off_t offset
)
240 static ssize_t
skel_pread_recv(struct tevent_req
*req
, int *err
)
246 static ssize_t
skel_write(vfs_handle_struct
*handle
, files_struct
*fsp
,
247 const void *data
, size_t n
)
253 static ssize_t
skel_pwrite(vfs_handle_struct
*handle
, files_struct
*fsp
,
254 const void *data
, size_t n
, off_t offset
)
260 static struct tevent_req
*skel_pwrite_send(struct vfs_handle_struct
*handle
,
262 struct tevent_context
*ev
,
263 struct files_struct
*fsp
,
265 size_t n
, off_t offset
)
270 static ssize_t
skel_pwrite_recv(struct tevent_req
*req
, int *err
)
276 static off_t
skel_lseek(vfs_handle_struct
*handle
, files_struct
*fsp
,
277 off_t offset
, int whence
)
283 static ssize_t
skel_sendfile(vfs_handle_struct
*handle
, int tofd
,
284 files_struct
*fromfsp
, const DATA_BLOB
*hdr
,
285 off_t offset
, size_t n
)
291 static ssize_t
skel_recvfile(vfs_handle_struct
*handle
, int fromfd
,
292 files_struct
*tofsp
, off_t offset
, size_t n
)
298 static int skel_rename(vfs_handle_struct
*handle
,
299 const struct smb_filename
*smb_fname_src
,
300 const struct smb_filename
*smb_fname_dst
)
306 static int skel_fsync(vfs_handle_struct
*handle
, files_struct
*fsp
)
312 static struct tevent_req
*skel_fsync_send(struct vfs_handle_struct
*handle
,
314 struct tevent_context
*ev
,
315 struct files_struct
*fsp
)
320 static int skel_fsync_recv(struct tevent_req
*req
, int *err
)
326 static int skel_stat(vfs_handle_struct
*handle
, struct smb_filename
*smb_fname
)
332 static int skel_fstat(vfs_handle_struct
*handle
, files_struct
*fsp
,
333 SMB_STRUCT_STAT
*sbuf
)
339 static int skel_lstat(vfs_handle_struct
*handle
,
340 struct smb_filename
*smb_fname
)
346 static uint64_t skel_get_alloc_size(struct vfs_handle_struct
*handle
,
347 struct files_struct
*fsp
,
348 const SMB_STRUCT_STAT
*sbuf
)
354 static int skel_unlink(vfs_handle_struct
*handle
,
355 const struct smb_filename
*smb_fname
)
361 static int skel_chmod(vfs_handle_struct
*handle
, const char *path
, mode_t mode
)
367 static int skel_fchmod(vfs_handle_struct
*handle
, files_struct
*fsp
,
374 static int skel_chown(vfs_handle_struct
*handle
, const char *path
,
375 uid_t uid
, gid_t gid
)
381 static int skel_fchown(vfs_handle_struct
*handle
, files_struct
*fsp
,
382 uid_t uid
, gid_t gid
)
388 static int skel_lchown(vfs_handle_struct
*handle
, const char *path
,
389 uid_t uid
, gid_t gid
)
395 static int skel_chdir(vfs_handle_struct
*handle
, const char *path
)
401 static char *skel_getwd(vfs_handle_struct
*handle
)
407 static int skel_ntimes(vfs_handle_struct
*handle
,
408 const struct smb_filename
*smb_fname
,
409 struct smb_file_time
*ft
)
415 static int skel_ftruncate(vfs_handle_struct
*handle
, files_struct
*fsp
,
422 static int skel_fallocate(vfs_handle_struct
*handle
, files_struct
*fsp
,
423 uint32_t mode
, off_t offset
, off_t len
)
429 static bool skel_lock(vfs_handle_struct
*handle
, files_struct
*fsp
, int op
,
430 off_t offset
, off_t count
, int type
)
436 static int skel_kernel_flock(struct vfs_handle_struct
*handle
,
437 struct files_struct
*fsp
,
438 uint32_t share_mode
, uint32_t access_mask
)
444 static int skel_linux_setlease(struct vfs_handle_struct
*handle
,
445 struct files_struct
*fsp
, int leasetype
)
451 static bool skel_getlock(vfs_handle_struct
*handle
, files_struct
*fsp
,
452 off_t
*poffset
, off_t
*pcount
, int *ptype
,
459 static int skel_symlink(vfs_handle_struct
*handle
, const char *oldpath
,
466 static int skel_vfs_readlink(vfs_handle_struct
*handle
, const char *path
,
467 char *buf
, size_t bufsiz
)
473 static int skel_link(vfs_handle_struct
*handle
, const char *oldpath
,
480 static int skel_mknod(vfs_handle_struct
*handle
, const char *path
, mode_t mode
,
487 static char *skel_realpath(vfs_handle_struct
*handle
, const char *path
)
493 static int skel_chflags(vfs_handle_struct
*handle
, const char *path
,
500 static struct file_id
skel_file_id_create(vfs_handle_struct
*handle
,
501 const SMB_STRUCT_STAT
*sbuf
)
509 struct skel_cc_state
{
512 static struct tevent_req
*skel_copy_chunk_send(struct vfs_handle_struct
*handle
,
514 struct tevent_context
*ev
,
515 struct files_struct
*src_fsp
,
517 struct files_struct
*dest_fsp
,
521 struct tevent_req
*req
;
522 struct skel_cc_state
*cc_state
;
524 req
= tevent_req_create(mem_ctx
, &cc_state
, struct skel_cc_state
);
529 tevent_req_nterror(req
, NT_STATUS_NOT_IMPLEMENTED
);
530 return tevent_req_post(req
, ev
);
533 static NTSTATUS
skel_copy_chunk_recv(struct vfs_handle_struct
*handle
,
534 struct tevent_req
*req
,
539 if (tevent_req_is_nterror(req
, &status
)) {
540 tevent_req_received(req
);
543 tevent_req_received(req
);
548 static NTSTATUS
skel_get_compression(struct vfs_handle_struct
*handle
,
550 struct files_struct
*fsp
,
551 struct smb_filename
*smb_fname
,
552 uint16_t *_compression_fmt
)
554 return NT_STATUS_INVALID_DEVICE_REQUEST
;
557 static NTSTATUS
skel_set_compression(struct vfs_handle_struct
*handle
,
559 struct files_struct
*fsp
,
560 uint16_t compression_fmt
)
562 return NT_STATUS_INVALID_DEVICE_REQUEST
;
565 static NTSTATUS
skel_streaminfo(struct vfs_handle_struct
*handle
,
566 struct files_struct
*fsp
,
569 unsigned int *num_streams
,
570 struct stream_struct
**streams
)
572 return NT_STATUS_NOT_IMPLEMENTED
;
575 static int skel_get_real_filename(struct vfs_handle_struct
*handle
,
578 TALLOC_CTX
*mem_ctx
, char **found_name
)
584 static const char *skel_connectpath(struct vfs_handle_struct
*handle
,
585 const char *filename
)
591 static NTSTATUS
skel_brl_lock_windows(struct vfs_handle_struct
*handle
,
592 struct byte_range_lock
*br_lck
,
593 struct lock_struct
*plock
,
596 return NT_STATUS_NOT_IMPLEMENTED
;
599 static bool skel_brl_unlock_windows(struct vfs_handle_struct
*handle
,
600 struct messaging_context
*msg_ctx
,
601 struct byte_range_lock
*br_lck
,
602 const struct lock_struct
*plock
)
608 static bool skel_brl_cancel_windows(struct vfs_handle_struct
*handle
,
609 struct byte_range_lock
*br_lck
,
610 struct lock_struct
*plock
)
616 static bool skel_strict_lock(struct vfs_handle_struct
*handle
,
617 struct files_struct
*fsp
,
618 struct lock_struct
*plock
)
624 static void skel_strict_unlock(struct vfs_handle_struct
*handle
,
625 struct files_struct
*fsp
,
626 struct lock_struct
*plock
)
631 static NTSTATUS
skel_translate_name(struct vfs_handle_struct
*handle
,
632 const char *mapped_name
,
633 enum vfs_translate_direction direction
,
634 TALLOC_CTX
*mem_ctx
, char **pmapped_name
)
636 return NT_STATUS_NOT_IMPLEMENTED
;
639 static NTSTATUS
skel_fsctl(struct vfs_handle_struct
*handle
,
640 struct files_struct
*fsp
,
643 uint16_t req_flags
, /* Needed for UNICODE ... */
644 const uint8_t *_in_data
,
647 uint32_t max_out_len
, uint32_t *out_len
)
649 return NT_STATUS_NOT_IMPLEMENTED
;
652 static NTSTATUS
skel_readdir_attr(struct vfs_handle_struct
*handle
,
653 const struct smb_filename
*fname
,
655 struct readdir_attr_data
**pattr_data
)
657 return NT_STATUS_NOT_IMPLEMENTED
;
660 static NTSTATUS
skel_fget_nt_acl(vfs_handle_struct
*handle
, files_struct
*fsp
,
661 uint32_t security_info
,
663 struct security_descriptor
**ppdesc
)
665 return NT_STATUS_NOT_IMPLEMENTED
;
668 static NTSTATUS
skel_get_nt_acl(vfs_handle_struct
*handle
,
669 const char *name
, uint32_t security_info
,
671 struct security_descriptor
**ppdesc
)
673 return NT_STATUS_NOT_IMPLEMENTED
;
676 static NTSTATUS
skel_fset_nt_acl(vfs_handle_struct
*handle
, files_struct
*fsp
,
677 uint32_t security_info_sent
,
678 const struct security_descriptor
*psd
)
680 return NT_STATUS_NOT_IMPLEMENTED
;
683 static int skel_chmod_acl(vfs_handle_struct
*handle
, const char *name
,
690 static int skel_fchmod_acl(vfs_handle_struct
*handle
, files_struct
*fsp
,
697 static SMB_ACL_T
skel_sys_acl_get_file(vfs_handle_struct
*handle
,
703 return (SMB_ACL_T
) NULL
;
706 static SMB_ACL_T
skel_sys_acl_get_fd(vfs_handle_struct
*handle
,
707 files_struct
*fsp
, TALLOC_CTX
*mem_ctx
)
710 return (SMB_ACL_T
) NULL
;
713 static int skel_sys_acl_blob_get_file(vfs_handle_struct
*handle
,
714 const char *path_p
, TALLOC_CTX
*mem_ctx
,
715 char **blob_description
, DATA_BLOB
*blob
)
721 static int skel_sys_acl_blob_get_fd(vfs_handle_struct
*handle
,
722 files_struct
*fsp
, TALLOC_CTX
*mem_ctx
,
723 char **blob_description
, DATA_BLOB
*blob
)
729 static int skel_sys_acl_set_file(vfs_handle_struct
*handle
, const char *name
,
730 SMB_ACL_TYPE_T acltype
, SMB_ACL_T theacl
)
736 static int skel_sys_acl_set_fd(vfs_handle_struct
*handle
, files_struct
*fsp
,
743 static int skel_sys_acl_delete_def_file(vfs_handle_struct
*handle
,
750 static ssize_t
skel_getxattr(vfs_handle_struct
*handle
, const char *path
,
751 const char *name
, void *value
, size_t size
)
757 static ssize_t
skel_fgetxattr(vfs_handle_struct
*handle
,
758 struct files_struct
*fsp
, const char *name
,
759 void *value
, size_t size
)
765 static ssize_t
skel_listxattr(vfs_handle_struct
*handle
, const char *path
,
766 char *list
, size_t size
)
772 static ssize_t
skel_flistxattr(vfs_handle_struct
*handle
,
773 struct files_struct
*fsp
, char *list
,
780 static int skel_removexattr(vfs_handle_struct
*handle
, const char *path
,
787 static int skel_fremovexattr(vfs_handle_struct
*handle
,
788 struct files_struct
*fsp
, const char *name
)
792 return SMB_VFS_NEXT_FREMOVEXATTR(handle
, fsp
, name
);
795 static int skel_setxattr(vfs_handle_struct
*handle
, const char *path
,
796 const char *name
, const void *value
, size_t size
,
803 static int skel_fsetxattr(vfs_handle_struct
*handle
, struct files_struct
*fsp
,
804 const char *name
, const void *value
, size_t size
,
811 static bool skel_aio_force(struct vfs_handle_struct
*handle
,
812 struct files_struct
*fsp
)
818 static bool skel_is_offline(struct vfs_handle_struct
*handle
,
819 const struct smb_filename
*fname
,
820 SMB_STRUCT_STAT
*sbuf
)
826 static int skel_set_offline(struct vfs_handle_struct
*handle
,
827 const struct smb_filename
*fname
)
833 /* VFS operations structure */
835 struct vfs_fn_pointers skel_opaque_fns
= {
836 /* Disk operations */
838 .connect_fn
= skel_connect
,
839 .disconnect_fn
= skel_disconnect
,
840 .disk_free_fn
= skel_disk_free
,
841 .get_quota_fn
= skel_get_quota
,
842 .set_quota_fn
= skel_set_quota
,
843 .get_shadow_copy_data_fn
= skel_get_shadow_copy_data
,
844 .statvfs_fn
= skel_statvfs
,
845 .fs_capabilities_fn
= skel_fs_capabilities
,
846 .get_dfs_referrals_fn
= skel_get_dfs_referrals
,
847 .snap_check_path_fn
= skel_snap_check_path
,
848 .snap_create_fn
= skel_snap_create
,
849 .snap_delete_fn
= skel_snap_delete
,
851 /* Directory operations */
853 .opendir_fn
= skel_opendir
,
854 .fdopendir_fn
= skel_fdopendir
,
855 .readdir_fn
= skel_readdir
,
856 .seekdir_fn
= skel_seekdir
,
857 .telldir_fn
= skel_telldir
,
858 .rewind_dir_fn
= skel_rewind_dir
,
859 .mkdir_fn
= skel_mkdir
,
860 .rmdir_fn
= skel_rmdir
,
861 .closedir_fn
= skel_closedir
,
862 .init_search_op_fn
= skel_init_search_op
,
864 /* File operations */
866 .open_fn
= skel_open
,
867 .create_file_fn
= skel_create_file
,
868 .close_fn
= skel_close_fn
,
869 .read_fn
= skel_vfs_read
,
870 .pread_fn
= skel_pread
,
871 .pread_send_fn
= skel_pread_send
,
872 .pread_recv_fn
= skel_pread_recv
,
873 .write_fn
= skel_write
,
874 .pwrite_fn
= skel_pwrite
,
875 .pwrite_send_fn
= skel_pwrite_send
,
876 .pwrite_recv_fn
= skel_pwrite_recv
,
877 .lseek_fn
= skel_lseek
,
878 .sendfile_fn
= skel_sendfile
,
879 .recvfile_fn
= skel_recvfile
,
880 .rename_fn
= skel_rename
,
881 .fsync_fn
= skel_fsync
,
882 .fsync_send_fn
= skel_fsync_send
,
883 .fsync_recv_fn
= skel_fsync_recv
,
884 .stat_fn
= skel_stat
,
885 .fstat_fn
= skel_fstat
,
886 .lstat_fn
= skel_lstat
,
887 .get_alloc_size_fn
= skel_get_alloc_size
,
888 .unlink_fn
= skel_unlink
,
889 .chmod_fn
= skel_chmod
,
890 .fchmod_fn
= skel_fchmod
,
891 .chown_fn
= skel_chown
,
892 .fchown_fn
= skel_fchown
,
893 .lchown_fn
= skel_lchown
,
894 .chdir_fn
= skel_chdir
,
895 .getwd_fn
= skel_getwd
,
896 .ntimes_fn
= skel_ntimes
,
897 .ftruncate_fn
= skel_ftruncate
,
898 .fallocate_fn
= skel_fallocate
,
899 .lock_fn
= skel_lock
,
900 .kernel_flock_fn
= skel_kernel_flock
,
901 .linux_setlease_fn
= skel_linux_setlease
,
902 .getlock_fn
= skel_getlock
,
903 .symlink_fn
= skel_symlink
,
904 .readlink_fn
= skel_vfs_readlink
,
905 .link_fn
= skel_link
,
906 .mknod_fn
= skel_mknod
,
907 .realpath_fn
= skel_realpath
,
908 .chflags_fn
= skel_chflags
,
909 .file_id_create_fn
= skel_file_id_create
,
910 .copy_chunk_send_fn
= skel_copy_chunk_send
,
911 .copy_chunk_recv_fn
= skel_copy_chunk_recv
,
912 .get_compression_fn
= skel_get_compression
,
913 .set_compression_fn
= skel_set_compression
,
915 .streaminfo_fn
= skel_streaminfo
,
916 .get_real_filename_fn
= skel_get_real_filename
,
917 .connectpath_fn
= skel_connectpath
,
918 .brl_lock_windows_fn
= skel_brl_lock_windows
,
919 .brl_unlock_windows_fn
= skel_brl_unlock_windows
,
920 .brl_cancel_windows_fn
= skel_brl_cancel_windows
,
921 .strict_lock_fn
= skel_strict_lock
,
922 .strict_unlock_fn
= skel_strict_unlock
,
923 .translate_name_fn
= skel_translate_name
,
924 .fsctl_fn
= skel_fsctl
,
925 .readdir_attr_fn
= skel_readdir_attr
,
927 /* NT ACL operations. */
929 .fget_nt_acl_fn
= skel_fget_nt_acl
,
930 .get_nt_acl_fn
= skel_get_nt_acl
,
931 .fset_nt_acl_fn
= skel_fset_nt_acl
,
933 /* POSIX ACL operations. */
935 .chmod_acl_fn
= skel_chmod_acl
,
936 .fchmod_acl_fn
= skel_fchmod_acl
,
938 .sys_acl_get_file_fn
= skel_sys_acl_get_file
,
939 .sys_acl_get_fd_fn
= skel_sys_acl_get_fd
,
940 .sys_acl_blob_get_file_fn
= skel_sys_acl_blob_get_file
,
941 .sys_acl_blob_get_fd_fn
= skel_sys_acl_blob_get_fd
,
942 .sys_acl_set_file_fn
= skel_sys_acl_set_file
,
943 .sys_acl_set_fd_fn
= skel_sys_acl_set_fd
,
944 .sys_acl_delete_def_file_fn
= skel_sys_acl_delete_def_file
,
947 .getxattr_fn
= skel_getxattr
,
948 .fgetxattr_fn
= skel_fgetxattr
,
949 .listxattr_fn
= skel_listxattr
,
950 .flistxattr_fn
= skel_flistxattr
,
951 .removexattr_fn
= skel_removexattr
,
952 .fremovexattr_fn
= skel_fremovexattr
,
953 .setxattr_fn
= skel_setxattr
,
954 .fsetxattr_fn
= skel_fsetxattr
,
957 .aio_force_fn
= skel_aio_force
,
959 /* offline operations */
960 .is_offline_fn
= skel_is_offline
,
961 .set_offline_fn
= skel_set_offline
964 NTSTATUS
vfs_skel_opaque_init(void)
966 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "skel_opaque",