2 * Skeleton VFS module. Implements passthrough operation of all VFS
3 * calls to disk functions.
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_unix.h"
26 #include "lib/util/tevent_ntstatus.h"
28 /* PLEASE,PLEASE READ THE VFS MODULES CHAPTER OF THE
29 SAMBA DEVELOPERS GUIDE!!!!!!
32 /* If you take this file as template for your module
33 * please make sure that you remove all skel_XXX() functions you don't
34 * want to implement!! The passthrough operations are not
35 * necessary in a real module.
40 static int skel_connect(vfs_handle_struct *handle, const char *service,
43 return SMB_VFS_NEXT_CONNECT(handle, service, user);
46 static void skel_disconnect(vfs_handle_struct *handle)
48 SMB_VFS_NEXT_DISCONNECT(handle);
51 static uint64_t skel_disk_free(vfs_handle_struct *handle,
52 const struct smb_filename *smb_fname,
57 return SMB_VFS_NEXT_DISK_FREE(handle, smb_fname, bsize, dfree, dsize);
60 static int skel_get_quota(vfs_handle_struct *handle,
61 const struct smb_filename *smb_fname,
62 enum SMB_QUOTA_TYPE qtype,
66 return SMB_VFS_NEXT_GET_QUOTA(handle, smb_fname, qtype, id, dq);
69 static int skel_set_quota(vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype,
70 unid_t id, SMB_DISK_QUOTA *dq)
72 return SMB_VFS_NEXT_SET_QUOTA(handle, qtype, id, dq);
75 static int skel_get_shadow_copy_data(vfs_handle_struct *handle,
77 struct shadow_copy_data *shadow_copy_data,
80 return SMB_VFS_NEXT_GET_SHADOW_COPY_DATA(handle, fsp, shadow_copy_data,
84 static int skel_statvfs(struct vfs_handle_struct *handle,
85 const struct smb_filename *smb_fname,
86 struct vfs_statvfs_struct *statbuf)
88 return SMB_VFS_NEXT_STATVFS(handle, smb_fname, statbuf);
91 static uint32_t skel_fs_capabilities(struct vfs_handle_struct *handle,
92 enum timestamp_set_resolution *p_ts_res)
94 return SMB_VFS_NEXT_FS_CAPABILITIES(handle, p_ts_res);
97 static NTSTATUS skel_get_dfs_referrals(struct vfs_handle_struct *handle,
98 struct dfs_GetDFSReferral *r)
100 return SMB_VFS_NEXT_GET_DFS_REFERRALS(handle, r);
103 static NTSTATUS skel_create_dfs_pathat(struct vfs_handle_struct *handle,
104 struct files_struct *dirfsp,
105 const struct smb_filename *smb_fname,
106 const struct referral *reflist,
107 size_t referral_count)
109 return SMB_VFS_NEXT_CREATE_DFS_PATHAT(handle,
116 static NTSTATUS skel_read_dfs_pathat(struct vfs_handle_struct *handle,
118 struct files_struct *dirfsp,
119 struct smb_filename *smb_fname,
120 struct referral **ppreflist,
121 size_t *preferral_count)
123 return SMB_VFS_NEXT_READ_DFS_PATHAT(handle,
131 static NTSTATUS skel_snap_check_path(struct vfs_handle_struct *handle,
133 const char *service_path,
136 return SMB_VFS_NEXT_SNAP_CHECK_PATH(handle, mem_ctx, service_path,
140 static NTSTATUS skel_snap_create(struct vfs_handle_struct *handle,
142 const char *base_volume,
148 return SMB_VFS_NEXT_SNAP_CREATE(handle, mem_ctx, base_volume, tstamp,
149 rw, base_path, snap_path);
152 static NTSTATUS skel_snap_delete(struct vfs_handle_struct *handle,
157 return SMB_VFS_NEXT_SNAP_DELETE(handle, mem_ctx, base_path, snap_path);
160 static DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
161 const char *mask, uint32_t attr)
163 return SMB_VFS_NEXT_FDOPENDIR(handle, fsp, mask, attr);
166 static struct dirent *skel_readdir(vfs_handle_struct *handle,
167 struct files_struct *dirfsp,
169 SMB_STRUCT_STAT *sbuf)
171 return SMB_VFS_NEXT_READDIR(handle, dirfsp, dirp, sbuf);
174 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
176 SMB_VFS_NEXT_SEEKDIR(handle, dirp, offset);
179 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
181 return SMB_VFS_NEXT_TELLDIR(handle, dirp);
184 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
186 SMB_VFS_NEXT_REWINDDIR(handle, dirp);
189 static int skel_mkdirat(vfs_handle_struct *handle,
190 struct files_struct *dirfsp,
191 const struct smb_filename *smb_fname,
194 return SMB_VFS_NEXT_MKDIRAT(handle,
200 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
202 return SMB_VFS_NEXT_CLOSEDIR(handle, dir);
205 static int skel_openat(struct vfs_handle_struct *handle,
206 const struct files_struct *dirfsp,
207 const struct smb_filename *smb_fname,
208 struct files_struct *fsp,
212 return SMB_VFS_NEXT_OPENAT(handle, dirfsp, smb_fname, fsp, flags, mode);
215 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
216 struct smb_request *req,
217 struct smb_filename *smb_fname,
218 uint32_t access_mask,
219 uint32_t share_access,
220 uint32_t create_disposition,
221 uint32_t create_options,
222 uint32_t file_attributes,
223 uint32_t oplock_request,
224 const struct smb2_lease *lease,
225 uint64_t allocation_size,
226 uint32_t private_flags,
227 struct security_descriptor *sd,
228 struct ea_list *ea_list,
229 files_struct ** result, int *pinfo,
230 const struct smb2_create_blobs *in_context_blobs,
231 struct smb2_create_blobs *out_context_blobs)
233 return SMB_VFS_NEXT_CREATE_FILE(handle,
245 sd, ea_list, result, pinfo,
246 in_context_blobs, out_context_blobs);
249 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
251 return SMB_VFS_NEXT_CLOSE(handle, fsp);
254 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
255 void *data, size_t n, off_t offset)
257 return SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
260 struct skel_pread_state {
262 struct vfs_aio_state vfs_aio_state;
265 static void skel_pread_done(struct tevent_req *subreq);
267 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
269 struct tevent_context *ev,
270 struct files_struct *fsp,
271 void *data, size_t n, off_t offset)
273 struct tevent_req *req, *subreq;
274 struct skel_pread_state *state;
276 req = tevent_req_create(mem_ctx, &state, struct skel_pread_state);
280 subreq = SMB_VFS_NEXT_PREAD_SEND(state, ev, handle, fsp, data,
282 if (tevent_req_nomem(subreq, req)) {
283 return tevent_req_post(req, ev);
285 tevent_req_set_callback(subreq, skel_pread_done, req);
289 static void skel_pread_done(struct tevent_req *subreq)
291 struct tevent_req *req =
292 tevent_req_callback_data(subreq, struct tevent_req);
293 struct skel_pread_state *state =
294 tevent_req_data(req, struct skel_pread_state);
296 state->ret = SMB_VFS_PREAD_RECV(subreq, &state->vfs_aio_state);
298 tevent_req_done(req);
301 static ssize_t skel_pread_recv(struct tevent_req *req,
302 struct vfs_aio_state *vfs_aio_state)
304 struct skel_pread_state *state =
305 tevent_req_data(req, struct skel_pread_state);
307 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
310 *vfs_aio_state = state->vfs_aio_state;
314 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
315 const void *data, size_t n, off_t offset)
317 return SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
320 struct skel_pwrite_state {
322 struct vfs_aio_state vfs_aio_state;
325 static void skel_pwrite_done(struct tevent_req *subreq);
327 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
329 struct tevent_context *ev,
330 struct files_struct *fsp,
332 size_t n, off_t offset)
334 struct tevent_req *req, *subreq;
335 struct skel_pwrite_state *state;
337 req = tevent_req_create(mem_ctx, &state, struct skel_pwrite_state);
341 subreq = SMB_VFS_NEXT_PWRITE_SEND(state, ev, handle, fsp, data,
343 if (tevent_req_nomem(subreq, req)) {
344 return tevent_req_post(req, ev);
346 tevent_req_set_callback(subreq, skel_pwrite_done, req);
350 static void skel_pwrite_done(struct tevent_req *subreq)
352 struct tevent_req *req =
353 tevent_req_callback_data(subreq, struct tevent_req);
354 struct skel_pwrite_state *state =
355 tevent_req_data(req, struct skel_pwrite_state);
357 state->ret = SMB_VFS_PWRITE_RECV(subreq, &state->vfs_aio_state);
359 tevent_req_done(req);
362 static ssize_t skel_pwrite_recv(struct tevent_req *req,
363 struct vfs_aio_state *vfs_aio_state)
365 struct skel_pwrite_state *state =
366 tevent_req_data(req, struct skel_pwrite_state);
368 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
371 *vfs_aio_state = state->vfs_aio_state;
375 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
376 off_t offset, int whence)
378 return SMB_VFS_NEXT_LSEEK(handle, fsp, offset, whence);
381 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
382 files_struct *fromfsp, const DATA_BLOB *hdr,
383 off_t offset, size_t n)
385 return SMB_VFS_NEXT_SENDFILE(handle, tofd, fromfsp, hdr, offset, n);
388 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
389 files_struct *tofsp, off_t offset, size_t n)
391 return SMB_VFS_NEXT_RECVFILE(handle, fromfd, tofsp, offset, n);
394 static int skel_renameat(vfs_handle_struct *handle,
395 files_struct *srcfsp,
396 const struct smb_filename *smb_fname_src,
397 files_struct *dstfsp,
398 const struct smb_filename *smb_fname_dst)
400 return SMB_VFS_NEXT_RENAMEAT(handle,
407 struct skel_fsync_state {
409 struct vfs_aio_state vfs_aio_state;
412 static void skel_fsync_done(struct tevent_req *subreq);
414 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
416 struct tevent_context *ev,
417 struct files_struct *fsp)
419 struct tevent_req *req, *subreq;
420 struct skel_fsync_state *state;
422 req = tevent_req_create(mem_ctx, &state, struct skel_fsync_state);
426 subreq = SMB_VFS_NEXT_FSYNC_SEND(state, ev, handle, fsp);
427 if (tevent_req_nomem(subreq, req)) {
428 return tevent_req_post(req, ev);
430 tevent_req_set_callback(subreq, skel_fsync_done, req);
434 static void skel_fsync_done(struct tevent_req *subreq)
436 struct tevent_req *req =
437 tevent_req_callback_data(subreq, struct tevent_req);
438 struct skel_fsync_state *state =
439 tevent_req_data(req, struct skel_fsync_state);
441 state->ret = SMB_VFS_FSYNC_RECV(subreq, &state->vfs_aio_state);
443 tevent_req_done(req);
446 static int skel_fsync_recv(struct tevent_req *req,
447 struct vfs_aio_state *vfs_aio_state)
449 struct skel_fsync_state *state =
450 tevent_req_data(req, struct skel_fsync_state);
452 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
455 *vfs_aio_state = state->vfs_aio_state;
459 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
461 return SMB_VFS_NEXT_STAT(handle, smb_fname);
464 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
465 SMB_STRUCT_STAT *sbuf)
467 return SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
470 static int skel_lstat(vfs_handle_struct *handle,
471 struct smb_filename *smb_fname)
473 return SMB_VFS_NEXT_LSTAT(handle, smb_fname);
476 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
477 struct files_struct *fsp,
478 const SMB_STRUCT_STAT *sbuf)
480 return SMB_VFS_NEXT_GET_ALLOC_SIZE(handle, fsp, sbuf);
483 static int skel_unlinkat(vfs_handle_struct *handle,
484 struct files_struct *dirfsp,
485 const struct smb_filename *smb_fname,
488 return SMB_VFS_NEXT_UNLINKAT(handle,
494 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
497 return SMB_VFS_NEXT_FCHMOD(handle, fsp, mode);
500 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
501 uid_t uid, gid_t gid)
503 return SMB_VFS_NEXT_FCHOWN(handle, fsp, uid, gid);
506 static int skel_lchown(vfs_handle_struct *handle,
507 const struct smb_filename *smb_fname,
511 return SMB_VFS_NEXT_LCHOWN(handle, smb_fname, uid, gid);
514 static int skel_chdir(vfs_handle_struct *handle,
515 const struct smb_filename *smb_fname)
517 return SMB_VFS_NEXT_CHDIR(handle, smb_fname);
520 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
523 return SMB_VFS_NEXT_GETWD(handle, ctx);
526 static int skel_fntimes(vfs_handle_struct *handle,
528 struct smb_file_time *ft)
530 return SMB_VFS_NEXT_FNTIMES(handle, fsp, ft);
533 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
536 return SMB_VFS_NEXT_FTRUNCATE(handle, fsp, offset);
539 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
540 uint32_t mode, off_t offset, off_t len)
542 return SMB_VFS_NEXT_FALLOCATE(handle, fsp, mode, offset, len);
545 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
546 off_t offset, off_t count, int type)
548 return SMB_VFS_NEXT_LOCK(handle, fsp, op, offset, count, type);
551 static int skel_kernel_flock(struct vfs_handle_struct *handle,
552 struct files_struct *fsp, uint32_t share_mode,
553 uint32_t access_mask)
555 return SMB_VFS_NEXT_KERNEL_FLOCK(handle, fsp, share_mode, access_mask);
558 static int skel_fcntl(struct vfs_handle_struct *handle,
559 struct files_struct *fsp, int cmd, va_list cmd_arg)
565 va_copy(dup_cmd_arg, cmd_arg);
566 arg = va_arg(dup_cmd_arg, void *);
567 result = SMB_VFS_NEXT_FCNTL(handle, fsp, cmd, arg);
573 static int skel_linux_setlease(struct vfs_handle_struct *handle,
574 struct files_struct *fsp, int leasetype)
576 return SMB_VFS_NEXT_LINUX_SETLEASE(handle, fsp, leasetype);
579 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
580 off_t *poffset, off_t *pcount, int *ptype,
583 return SMB_VFS_NEXT_GETLOCK(handle, fsp, poffset, pcount, ptype, ppid);
586 static int skel_symlinkat(vfs_handle_struct *handle,
587 const struct smb_filename *link_contents,
588 struct files_struct *dirfsp,
589 const struct smb_filename *new_smb_fname)
591 return SMB_VFS_NEXT_SYMLINKAT(handle,
597 static int skel_vfs_readlinkat(vfs_handle_struct *handle,
598 const struct files_struct *dirfsp,
599 const struct smb_filename *smb_fname,
603 return SMB_VFS_NEXT_READLINKAT(handle,
610 static int skel_linkat(vfs_handle_struct *handle,
611 files_struct *srcfsp,
612 const struct smb_filename *old_smb_fname,
613 files_struct *dstfsp,
614 const struct smb_filename *new_smb_fname,
617 return SMB_VFS_NEXT_LINKAT(handle,
625 static int skel_mknodat(vfs_handle_struct *handle,
626 files_struct *dirfsp,
627 const struct smb_filename *smb_fname,
631 return SMB_VFS_NEXT_MKNODAT(handle,
638 static struct smb_filename *skel_realpath(vfs_handle_struct *handle,
640 const struct smb_filename *smb_fname)
642 return SMB_VFS_NEXT_REALPATH(handle, ctx, smb_fname);
645 static int skel_chflags(vfs_handle_struct *handle,
646 const struct smb_filename *smb_fname,
649 return SMB_VFS_NEXT_CHFLAGS(handle, smb_fname, flags);
652 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
653 const SMB_STRUCT_STAT *sbuf)
655 return SMB_VFS_NEXT_FILE_ID_CREATE(handle, sbuf);
658 static uint64_t skel_fs_file_id(vfs_handle_struct *handle,
659 const SMB_STRUCT_STAT *sbuf)
661 return SMB_VFS_NEXT_FS_FILE_ID(handle, sbuf);
664 struct skel_offload_read_state {
665 struct vfs_handle_struct *handle;
669 static void skel_offload_read_done(struct tevent_req *subreq);
671 static struct tevent_req *skel_offload_read_send(
673 struct tevent_context *ev,
674 struct vfs_handle_struct *handle,
675 struct files_struct *fsp,
681 struct tevent_req *req = NULL;
682 struct skel_offload_read_state *state = NULL;
683 struct tevent_req *subreq = NULL;
685 req = tevent_req_create(mem_ctx, &state, struct skel_offload_read_state);
689 *state = (struct skel_offload_read_state) {
693 subreq = SMB_VFS_NEXT_OFFLOAD_READ_SEND(mem_ctx, ev, handle, fsp,
694 fsctl, ttl, offset, to_copy);
695 if (tevent_req_nomem(subreq, req)) {
696 return tevent_req_post(req, ev);
698 tevent_req_set_callback(subreq, skel_offload_read_done, req);
702 static void skel_offload_read_done(struct tevent_req *subreq)
704 struct tevent_req *req = tevent_req_callback_data(
705 subreq, struct tevent_req);
706 struct skel_offload_read_state *state = tevent_req_data(
707 req, struct skel_offload_read_state);
710 status = SMB_VFS_NEXT_OFFLOAD_READ_RECV(subreq,
715 if (tevent_req_nterror(req, status)) {
719 tevent_req_done(req);
723 static NTSTATUS skel_offload_read_recv(struct tevent_req *req,
724 struct vfs_handle_struct *handle,
728 struct skel_offload_read_state *state = tevent_req_data(
729 req, struct skel_offload_read_state);
733 if (tevent_req_is_nterror(req, &status)) {
734 tevent_req_received(req);
738 token = data_blob_talloc(mem_ctx,
740 state->token.length);
742 tevent_req_received(req);
744 if (token.data == NULL) {
745 return NT_STATUS_NO_MEMORY;
752 struct skel_offload_write_state {
753 struct vfs_handle_struct *handle;
756 static void skel_offload_write_done(struct tevent_req *subreq);
758 static struct tevent_req *skel_offload_write_send(struct vfs_handle_struct *handle,
760 struct tevent_context *ev,
763 off_t transfer_offset,
764 struct files_struct *dest_fsp,
768 struct tevent_req *req;
769 struct tevent_req *subreq;
770 struct skel_offload_write_state *state;
772 req = tevent_req_create(mem_ctx, &state, struct skel_offload_write_state);
777 state->handle = handle;
778 subreq = SMB_VFS_NEXT_OFFLOAD_WRITE_SEND(handle, state, ev,
779 fsctl, token, transfer_offset,
780 dest_fsp, dest_off, num);
781 if (tevent_req_nomem(subreq, req)) {
782 return tevent_req_post(req, ev);
785 tevent_req_set_callback(subreq, skel_offload_write_done, req);
789 static void skel_offload_write_done(struct tevent_req *subreq)
791 struct tevent_req *req = tevent_req_callback_data(
792 subreq, struct tevent_req);
793 struct skel_offload_write_state *state
794 = tevent_req_data(req, struct skel_offload_write_state);
797 status = SMB_VFS_NEXT_OFFLOAD_WRITE_RECV(state->handle,
801 if (tevent_req_nterror(req, status)) {
804 tevent_req_done(req);
807 static NTSTATUS skel_offload_write_recv(struct vfs_handle_struct *handle,
808 struct tevent_req *req,
811 struct skel_offload_write_state *state
812 = tevent_req_data(req, struct skel_offload_write_state);
815 *copied = state->copied;
816 if (tevent_req_is_nterror(req, &status)) {
817 tevent_req_received(req);
821 tevent_req_received(req);
825 static NTSTATUS skel_fget_compression(struct vfs_handle_struct *handle,
827 struct files_struct *fsp,
828 uint16_t *_compression_fmt)
830 return SMB_VFS_NEXT_FGET_COMPRESSION(handle, mem_ctx, fsp,
834 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
836 struct files_struct *fsp,
837 uint16_t compression_fmt)
839 return SMB_VFS_NEXT_SET_COMPRESSION(handle, mem_ctx, fsp,
843 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
844 struct files_struct *fsp,
845 const struct smb_filename *smb_fname,
847 unsigned int *num_streams,
848 struct stream_struct **streams)
850 return SMB_VFS_NEXT_STREAMINFO(handle,
858 static int skel_get_real_filename(struct vfs_handle_struct *handle,
859 const struct smb_filename *path,
861 TALLOC_CTX *mem_ctx, char **found_name)
863 return SMB_VFS_NEXT_GET_REAL_FILENAME(handle,
864 path, name, mem_ctx, found_name);
867 static const char *skel_connectpath(struct vfs_handle_struct *handle,
868 const struct smb_filename *smb_fname)
870 return SMB_VFS_NEXT_CONNECTPATH(handle, smb_fname);
873 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
874 struct byte_range_lock *br_lck,
875 struct lock_struct *plock)
877 return SMB_VFS_NEXT_BRL_LOCK_WINDOWS(handle, br_lck, plock);
880 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
881 struct byte_range_lock *br_lck,
882 const struct lock_struct *plock)
884 return SMB_VFS_NEXT_BRL_UNLOCK_WINDOWS(handle, br_lck, plock);
887 static bool skel_strict_lock_check(struct vfs_handle_struct *handle,
888 struct files_struct *fsp,
889 struct lock_struct *plock)
891 return SMB_VFS_NEXT_STRICT_LOCK_CHECK(handle, fsp, plock);
894 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
895 const char *mapped_name,
896 enum vfs_translate_direction direction,
897 TALLOC_CTX *mem_ctx, char **pmapped_name)
899 return SMB_VFS_NEXT_TRANSLATE_NAME(handle, mapped_name, direction,
900 mem_ctx, pmapped_name);
903 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
904 struct files_struct *fsp,
907 uint16_t req_flags, /* Needed for UNICODE ... */
908 const uint8_t *_in_data,
910 uint8_t ** _out_data,
911 uint32_t max_out_len, uint32_t *out_len)
913 return SMB_VFS_NEXT_FSCTL(handle,
919 in_len, _out_data, max_out_len, out_len);
922 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
923 const struct smb_filename *fname,
925 struct readdir_attr_data **pattr_data)
927 return SMB_VFS_NEXT_READDIR_ATTR(handle, fname, mem_ctx, pattr_data);
930 struct skel_get_dos_attributes_state {
931 struct vfs_aio_state aio_state;
935 static void skel_get_dos_attributes_done(struct tevent_req *subreq);
937 static struct tevent_req *skel_get_dos_attributes_send(
939 struct tevent_context *ev,
940 struct vfs_handle_struct *handle,
941 files_struct *dir_fsp,
942 struct smb_filename *smb_fname)
944 struct tevent_req *req = NULL;
945 struct skel_get_dos_attributes_state *state = NULL;
946 struct tevent_req *subreq = NULL;
948 req = tevent_req_create(mem_ctx, &state,
949 struct skel_get_dos_attributes_state);
954 subreq = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_SEND(mem_ctx,
959 if (tevent_req_nomem(subreq, req)) {
960 return tevent_req_post(req, ev);
962 tevent_req_set_callback(subreq, skel_get_dos_attributes_done, req);
967 static void skel_get_dos_attributes_done(struct tevent_req *subreq)
969 struct tevent_req *req =
970 tevent_req_callback_data(subreq,
972 struct skel_get_dos_attributes_state *state =
974 struct skel_get_dos_attributes_state);
977 status = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_RECV(subreq,
981 if (tevent_req_nterror(req, status)) {
985 tevent_req_done(req);
989 static NTSTATUS skel_get_dos_attributes_recv(struct tevent_req *req,
990 struct vfs_aio_state *aio_state,
993 struct skel_get_dos_attributes_state *state =
995 struct skel_get_dos_attributes_state);
998 if (tevent_req_is_nterror(req, &status)) {
999 tevent_req_received(req);
1003 *aio_state = state->aio_state;
1004 *dosmode = state->dosmode;
1005 tevent_req_received(req);
1006 return NT_STATUS_OK;
1009 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
1010 struct files_struct *fsp,
1013 return SMB_VFS_NEXT_FGET_DOS_ATTRIBUTES(handle,
1018 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
1019 struct files_struct *fsp,
1022 return SMB_VFS_NEXT_FSET_DOS_ATTRIBUTES(handle,
1027 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1028 uint32_t security_info,
1029 TALLOC_CTX *mem_ctx,
1030 struct security_descriptor **ppdesc)
1032 return SMB_VFS_NEXT_FGET_NT_ACL(handle, fsp, security_info, mem_ctx,
1036 static NTSTATUS skel_get_nt_acl_at(vfs_handle_struct *handle,
1037 struct files_struct *dirfsp,
1038 const struct smb_filename *smb_fname,
1039 uint32_t security_info,
1040 TALLOC_CTX *mem_ctx,
1041 struct security_descriptor **ppdesc)
1043 return SMB_VFS_NEXT_GET_NT_ACL_AT(handle,
1051 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1052 uint32_t security_info_sent,
1053 const struct security_descriptor *psd)
1055 return SMB_VFS_NEXT_FSET_NT_ACL(handle, fsp, security_info_sent, psd);
1058 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
1059 const struct smb_filename *smb_fname,
1060 SMB_ACL_TYPE_T type,
1061 TALLOC_CTX *mem_ctx)
1063 return SMB_VFS_NEXT_SYS_ACL_GET_FILE(handle, smb_fname, type, mem_ctx);
1066 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
1067 files_struct *fsp, TALLOC_CTX *mem_ctx)
1069 return SMB_VFS_NEXT_SYS_ACL_GET_FD(handle, fsp, mem_ctx);
1072 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
1073 const struct smb_filename *smb_fname,
1074 TALLOC_CTX *mem_ctx,
1075 char **blob_description,
1078 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FILE(handle, smb_fname, mem_ctx,
1079 blob_description, blob);
1082 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
1083 files_struct *fsp, TALLOC_CTX *mem_ctx,
1084 char **blob_description, DATA_BLOB *blob)
1086 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FD(handle, fsp, mem_ctx,
1087 blob_description, blob);
1090 static int skel_sys_acl_set_fd(vfs_handle_struct *handle,
1091 struct files_struct *fsp,
1092 SMB_ACL_TYPE_T type,
1095 return SMB_VFS_NEXT_SYS_ACL_SET_FD(handle, fsp, type, theacl);
1098 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
1099 const struct smb_filename *smb_fname)
1101 return SMB_VFS_NEXT_SYS_ACL_DELETE_DEF_FILE(handle, smb_fname);
1104 static ssize_t skel_getxattr(vfs_handle_struct *handle,
1105 const struct smb_filename *smb_fname,
1110 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname, name, value, size);
1113 struct skel_getxattrat_state {
1114 struct vfs_aio_state aio_state;
1116 uint8_t *xattr_value;
1119 static void skel_getxattrat_done(struct tevent_req *subreq);
1121 static struct tevent_req *skel_getxattrat_send(
1122 TALLOC_CTX *mem_ctx,
1123 struct tevent_context *ev,
1124 struct vfs_handle_struct *handle,
1125 files_struct *dir_fsp,
1126 const struct smb_filename *smb_fname,
1127 const char *xattr_name,
1130 struct tevent_req *req = NULL;
1131 struct skel_getxattrat_state *state = NULL;
1132 struct tevent_req *subreq = NULL;
1134 req = tevent_req_create(mem_ctx, &state,
1135 struct skel_getxattrat_state);
1140 subreq = SMB_VFS_NEXT_GETXATTRAT_SEND(state,
1147 if (tevent_req_nomem(subreq, req)) {
1148 return tevent_req_post(req, ev);
1150 tevent_req_set_callback(subreq, skel_getxattrat_done, req);
1155 static void skel_getxattrat_done(struct tevent_req *subreq)
1157 struct tevent_req *req = tevent_req_callback_data(
1158 subreq, struct tevent_req);
1159 struct skel_getxattrat_state *state = tevent_req_data(
1160 req, struct skel_getxattrat_state);
1162 state->xattr_size = SMB_VFS_NEXT_GETXATTRAT_RECV(subreq,
1165 &state->xattr_value);
1166 TALLOC_FREE(subreq);
1167 if (state->xattr_size == -1) {
1168 tevent_req_error(req, state->aio_state.error);
1172 tevent_req_done(req);
1175 static ssize_t skel_getxattrat_recv(struct tevent_req *req,
1176 struct vfs_aio_state *aio_state,
1177 TALLOC_CTX *mem_ctx,
1178 uint8_t **xattr_value)
1180 struct skel_getxattrat_state *state = tevent_req_data(
1181 req, struct skel_getxattrat_state);
1184 if (tevent_req_is_unix_error(req, &aio_state->error)) {
1185 tevent_req_received(req);
1189 *aio_state = state->aio_state;
1190 xattr_size = state->xattr_size;
1191 if (xattr_value != NULL) {
1192 *xattr_value = talloc_move(mem_ctx, &state->xattr_value);
1195 tevent_req_received(req);
1199 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
1200 struct files_struct *fsp, const char *name,
1201 void *value, size_t size)
1203 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
1206 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
1207 struct files_struct *fsp, char *list,
1210 return SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
1213 static int skel_fremovexattr(vfs_handle_struct *handle,
1214 struct files_struct *fsp, const char *name)
1216 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
1219 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
1220 const char *name, const void *value, size_t size,
1223 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value, size, flags);
1226 static bool skel_aio_force(struct vfs_handle_struct *handle,
1227 struct files_struct *fsp)
1229 return SMB_VFS_NEXT_AIO_FORCE(handle, fsp);
1232 static NTSTATUS skel_audit_file(struct vfs_handle_struct *handle,
1233 struct smb_filename *file,
1234 struct security_acl *sacl,
1235 uint32_t access_requested,
1236 uint32_t access_denied)
1238 return SMB_VFS_NEXT_AUDIT_FILE(handle,
1245 static NTSTATUS skel_durable_cookie(struct vfs_handle_struct *handle,
1246 struct files_struct *fsp,
1247 TALLOC_CTX *mem_ctx,
1250 return SMB_VFS_NEXT_DURABLE_COOKIE(handle,
1256 static NTSTATUS skel_durable_disconnect(struct vfs_handle_struct *handle,
1257 struct files_struct *fsp,
1258 const DATA_BLOB old_cookie,
1259 TALLOC_CTX *mem_ctx,
1260 DATA_BLOB *new_cookie)
1262 return SMB_VFS_NEXT_DURABLE_DISCONNECT(handle,
1269 static NTSTATUS skel_durable_reconnect(struct vfs_handle_struct *handle,
1270 struct smb_request *smb1req,
1271 struct smbXsrv_open *op,
1272 const DATA_BLOB old_cookie,
1273 TALLOC_CTX *mem_ctx,
1274 struct files_struct **fsp,
1275 DATA_BLOB *new_cookie)
1277 return SMB_VFS_NEXT_DURABLE_RECONNECT(handle,
1286 /* VFS operations structure */
1288 static struct vfs_fn_pointers skel_transparent_fns = {
1289 /* Disk operations */
1291 .connect_fn = skel_connect,
1292 .disconnect_fn = skel_disconnect,
1293 .disk_free_fn = skel_disk_free,
1294 .get_quota_fn = skel_get_quota,
1295 .set_quota_fn = skel_set_quota,
1296 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
1297 .statvfs_fn = skel_statvfs,
1298 .fs_capabilities_fn = skel_fs_capabilities,
1299 .get_dfs_referrals_fn = skel_get_dfs_referrals,
1300 .create_dfs_pathat_fn = skel_create_dfs_pathat,
1301 .read_dfs_pathat_fn = skel_read_dfs_pathat,
1302 .snap_check_path_fn = skel_snap_check_path,
1303 .snap_create_fn = skel_snap_create,
1304 .snap_delete_fn = skel_snap_delete,
1306 /* Directory operations */
1308 .fdopendir_fn = skel_fdopendir,
1309 .readdir_fn = skel_readdir,
1310 .seekdir_fn = skel_seekdir,
1311 .telldir_fn = skel_telldir,
1312 .rewind_dir_fn = skel_rewind_dir,
1313 .mkdirat_fn = skel_mkdirat,
1314 .closedir_fn = skel_closedir,
1316 /* File operations */
1318 .openat_fn = skel_openat,
1319 .create_file_fn = skel_create_file,
1320 .close_fn = skel_close_fn,
1321 .pread_fn = skel_pread,
1322 .pread_send_fn = skel_pread_send,
1323 .pread_recv_fn = skel_pread_recv,
1324 .pwrite_fn = skel_pwrite,
1325 .pwrite_send_fn = skel_pwrite_send,
1326 .pwrite_recv_fn = skel_pwrite_recv,
1327 .lseek_fn = skel_lseek,
1328 .sendfile_fn = skel_sendfile,
1329 .recvfile_fn = skel_recvfile,
1330 .renameat_fn = skel_renameat,
1331 .fsync_send_fn = skel_fsync_send,
1332 .fsync_recv_fn = skel_fsync_recv,
1333 .stat_fn = skel_stat,
1334 .fstat_fn = skel_fstat,
1335 .lstat_fn = skel_lstat,
1336 .get_alloc_size_fn = skel_get_alloc_size,
1337 .unlinkat_fn = skel_unlinkat,
1338 .fchmod_fn = skel_fchmod,
1339 .fchown_fn = skel_fchown,
1340 .lchown_fn = skel_lchown,
1341 .chdir_fn = skel_chdir,
1342 .getwd_fn = skel_getwd,
1343 .fntimes_fn = skel_fntimes,
1344 .ftruncate_fn = skel_ftruncate,
1345 .fallocate_fn = skel_fallocate,
1346 .lock_fn = skel_lock,
1347 .kernel_flock_fn = skel_kernel_flock,
1348 .fcntl_fn = skel_fcntl,
1349 .linux_setlease_fn = skel_linux_setlease,
1350 .getlock_fn = skel_getlock,
1351 .symlinkat_fn = skel_symlinkat,
1352 .readlinkat_fn = skel_vfs_readlinkat,
1353 .linkat_fn = skel_linkat,
1354 .mknodat_fn = skel_mknodat,
1355 .realpath_fn = skel_realpath,
1356 .chflags_fn = skel_chflags,
1357 .file_id_create_fn = skel_file_id_create,
1358 .fs_file_id_fn = skel_fs_file_id,
1359 .offload_read_send_fn = skel_offload_read_send,
1360 .offload_read_recv_fn = skel_offload_read_recv,
1361 .offload_write_send_fn = skel_offload_write_send,
1362 .offload_write_recv_fn = skel_offload_write_recv,
1363 .fget_compression_fn = skel_fget_compression,
1364 .set_compression_fn = skel_set_compression,
1366 .streaminfo_fn = skel_streaminfo,
1367 .get_real_filename_fn = skel_get_real_filename,
1368 .connectpath_fn = skel_connectpath,
1369 .brl_lock_windows_fn = skel_brl_lock_windows,
1370 .brl_unlock_windows_fn = skel_brl_unlock_windows,
1371 .strict_lock_check_fn = skel_strict_lock_check,
1372 .translate_name_fn = skel_translate_name,
1373 .fsctl_fn = skel_fsctl,
1374 .readdir_attr_fn = skel_readdir_attr,
1375 .audit_file_fn = skel_audit_file,
1377 /* DOS attributes. */
1378 .get_dos_attributes_send_fn = skel_get_dos_attributes_send,
1379 .get_dos_attributes_recv_fn = skel_get_dos_attributes_recv,
1380 .fget_dos_attributes_fn = skel_fget_dos_attributes,
1381 .fset_dos_attributes_fn = skel_fset_dos_attributes,
1383 /* NT ACL operations. */
1385 .fget_nt_acl_fn = skel_fget_nt_acl,
1386 .get_nt_acl_at_fn = skel_get_nt_acl_at,
1387 .fset_nt_acl_fn = skel_fset_nt_acl,
1389 /* POSIX ACL operations. */
1391 .sys_acl_get_file_fn = skel_sys_acl_get_file,
1392 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
1393 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
1394 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
1395 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
1396 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1398 /* EA operations. */
1399 .getxattr_fn = skel_getxattr,
1400 .getxattrat_send_fn = skel_getxattrat_send,
1401 .getxattrat_recv_fn = skel_getxattrat_recv,
1402 .fgetxattr_fn = skel_fgetxattr,
1403 .flistxattr_fn = skel_flistxattr,
1404 .fremovexattr_fn = skel_fremovexattr,
1405 .fsetxattr_fn = skel_fsetxattr,
1407 /* aio operations */
1408 .aio_force_fn = skel_aio_force,
1410 /* durable handle operations */
1411 .durable_cookie_fn = skel_durable_cookie,
1412 .durable_disconnect_fn = skel_durable_disconnect,
1413 .durable_reconnect_fn = skel_durable_reconnect,
1417 NTSTATUS vfs_skel_transparent_init(TALLOC_CTX *ctx)
1420 * smb_vfs_assert_all_fns() is only needed in
1421 * order to have a complete example.
1423 * A transparent vfs module typically don't
1424 * need to implement every calls.
1426 smb_vfs_assert_all_fns(&skel_transparent_fns, "skel_transparent");
1427 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent",
1428 &skel_transparent_fns);