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 const 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 DIR *dirp, SMB_STRUCT_STAT *sbuf)
169 return SMB_VFS_NEXT_READDIR(handle, dirp, sbuf);
172 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
174 SMB_VFS_NEXT_SEEKDIR(handle, dirp, offset);
177 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
179 return SMB_VFS_NEXT_TELLDIR(handle, dirp);
182 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
184 SMB_VFS_NEXT_REWINDDIR(handle, dirp);
187 static int skel_mkdirat(vfs_handle_struct *handle,
188 struct files_struct *dirfsp,
189 const struct smb_filename *smb_fname,
192 return SMB_VFS_NEXT_MKDIRAT(handle,
198 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
200 return SMB_VFS_NEXT_CLOSEDIR(handle, dir);
203 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
204 files_struct *fsp, int flags, mode_t mode)
206 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
209 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
210 struct smb_request *req,
211 uint16_t root_dir_fid,
212 struct smb_filename *smb_fname,
213 uint32_t access_mask,
214 uint32_t share_access,
215 uint32_t create_disposition,
216 uint32_t create_options,
217 uint32_t file_attributes,
218 uint32_t oplock_request,
219 const struct smb2_lease *lease,
220 uint64_t allocation_size,
221 uint32_t private_flags,
222 struct security_descriptor *sd,
223 struct ea_list *ea_list,
224 files_struct ** result, int *pinfo,
225 const struct smb2_create_blobs *in_context_blobs,
226 struct smb2_create_blobs *out_context_blobs)
228 return SMB_VFS_NEXT_CREATE_FILE(handle,
241 sd, ea_list, result, pinfo,
242 in_context_blobs, out_context_blobs);
245 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
247 return SMB_VFS_NEXT_CLOSE(handle, fsp);
250 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
251 void *data, size_t n, off_t offset)
253 return SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
256 struct skel_pread_state {
258 struct vfs_aio_state vfs_aio_state;
261 static void skel_pread_done(struct tevent_req *subreq);
263 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
265 struct tevent_context *ev,
266 struct files_struct *fsp,
267 void *data, size_t n, off_t offset)
269 struct tevent_req *req, *subreq;
270 struct skel_pread_state *state;
272 req = tevent_req_create(mem_ctx, &state, struct skel_pread_state);
276 subreq = SMB_VFS_NEXT_PREAD_SEND(state, ev, handle, fsp, data,
278 if (tevent_req_nomem(subreq, req)) {
279 return tevent_req_post(req, ev);
281 tevent_req_set_callback(subreq, skel_pread_done, req);
285 static void skel_pread_done(struct tevent_req *subreq)
287 struct tevent_req *req =
288 tevent_req_callback_data(subreq, struct tevent_req);
289 struct skel_pread_state *state =
290 tevent_req_data(req, struct skel_pread_state);
292 state->ret = SMB_VFS_PREAD_RECV(subreq, &state->vfs_aio_state);
294 tevent_req_done(req);
297 static ssize_t skel_pread_recv(struct tevent_req *req,
298 struct vfs_aio_state *vfs_aio_state)
300 struct skel_pread_state *state =
301 tevent_req_data(req, struct skel_pread_state);
303 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
306 *vfs_aio_state = state->vfs_aio_state;
310 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
311 const void *data, size_t n, off_t offset)
313 return SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
316 struct skel_pwrite_state {
318 struct vfs_aio_state vfs_aio_state;
321 static void skel_pwrite_done(struct tevent_req *subreq);
323 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
325 struct tevent_context *ev,
326 struct files_struct *fsp,
328 size_t n, off_t offset)
330 struct tevent_req *req, *subreq;
331 struct skel_pwrite_state *state;
333 req = tevent_req_create(mem_ctx, &state, struct skel_pwrite_state);
337 subreq = SMB_VFS_NEXT_PWRITE_SEND(state, ev, handle, fsp, data,
339 if (tevent_req_nomem(subreq, req)) {
340 return tevent_req_post(req, ev);
342 tevent_req_set_callback(subreq, skel_pwrite_done, req);
346 static void skel_pwrite_done(struct tevent_req *subreq)
348 struct tevent_req *req =
349 tevent_req_callback_data(subreq, struct tevent_req);
350 struct skel_pwrite_state *state =
351 tevent_req_data(req, struct skel_pwrite_state);
353 state->ret = SMB_VFS_PWRITE_RECV(subreq, &state->vfs_aio_state);
355 tevent_req_done(req);
358 static ssize_t skel_pwrite_recv(struct tevent_req *req,
359 struct vfs_aio_state *vfs_aio_state)
361 struct skel_pwrite_state *state =
362 tevent_req_data(req, struct skel_pwrite_state);
364 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
367 *vfs_aio_state = state->vfs_aio_state;
371 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
372 off_t offset, int whence)
374 return SMB_VFS_NEXT_LSEEK(handle, fsp, offset, whence);
377 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
378 files_struct *fromfsp, const DATA_BLOB *hdr,
379 off_t offset, size_t n)
381 return SMB_VFS_NEXT_SENDFILE(handle, tofd, fromfsp, hdr, offset, n);
384 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
385 files_struct *tofsp, off_t offset, size_t n)
387 return SMB_VFS_NEXT_RECVFILE(handle, fromfd, tofsp, offset, n);
390 static int skel_renameat(vfs_handle_struct *handle,
391 files_struct *srcfsp,
392 const struct smb_filename *smb_fname_src,
393 files_struct *dstfsp,
394 const struct smb_filename *smb_fname_dst)
396 return SMB_VFS_NEXT_RENAMEAT(handle,
403 struct skel_fsync_state {
405 struct vfs_aio_state vfs_aio_state;
408 static void skel_fsync_done(struct tevent_req *subreq);
410 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
412 struct tevent_context *ev,
413 struct files_struct *fsp)
415 struct tevent_req *req, *subreq;
416 struct skel_fsync_state *state;
418 req = tevent_req_create(mem_ctx, &state, struct skel_fsync_state);
422 subreq = SMB_VFS_NEXT_FSYNC_SEND(state, ev, handle, fsp);
423 if (tevent_req_nomem(subreq, req)) {
424 return tevent_req_post(req, ev);
426 tevent_req_set_callback(subreq, skel_fsync_done, req);
430 static void skel_fsync_done(struct tevent_req *subreq)
432 struct tevent_req *req =
433 tevent_req_callback_data(subreq, struct tevent_req);
434 struct skel_fsync_state *state =
435 tevent_req_data(req, struct skel_fsync_state);
437 state->ret = SMB_VFS_FSYNC_RECV(subreq, &state->vfs_aio_state);
439 tevent_req_done(req);
442 static int skel_fsync_recv(struct tevent_req *req,
443 struct vfs_aio_state *vfs_aio_state)
445 struct skel_fsync_state *state =
446 tevent_req_data(req, struct skel_fsync_state);
448 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
451 *vfs_aio_state = state->vfs_aio_state;
455 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
457 return SMB_VFS_NEXT_STAT(handle, smb_fname);
460 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
461 SMB_STRUCT_STAT *sbuf)
463 return SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
466 static int skel_lstat(vfs_handle_struct *handle,
467 struct smb_filename *smb_fname)
469 return SMB_VFS_NEXT_LSTAT(handle, smb_fname);
472 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
473 struct files_struct *fsp,
474 const SMB_STRUCT_STAT *sbuf)
476 return SMB_VFS_NEXT_GET_ALLOC_SIZE(handle, fsp, sbuf);
479 static int skel_unlinkat(vfs_handle_struct *handle,
480 struct files_struct *dirfsp,
481 const struct smb_filename *smb_fname,
484 return SMB_VFS_NEXT_UNLINKAT(handle,
490 static int skel_chmod(vfs_handle_struct *handle,
491 const struct smb_filename *smb_fname,
494 return SMB_VFS_NEXT_CHMOD(handle, smb_fname, mode);
497 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
500 return SMB_VFS_NEXT_FCHMOD(handle, fsp, mode);
503 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
504 uid_t uid, gid_t gid)
506 return SMB_VFS_NEXT_FCHOWN(handle, fsp, uid, gid);
509 static int skel_lchown(vfs_handle_struct *handle,
510 const struct smb_filename *smb_fname,
514 return SMB_VFS_NEXT_LCHOWN(handle, smb_fname, uid, gid);
517 static int skel_chdir(vfs_handle_struct *handle,
518 const struct smb_filename *smb_fname)
520 return SMB_VFS_NEXT_CHDIR(handle, smb_fname);
523 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
526 return SMB_VFS_NEXT_GETWD(handle, ctx);
529 static int skel_ntimes(vfs_handle_struct *handle,
530 const struct smb_filename *smb_fname,
531 struct smb_file_time *ft)
533 return SMB_VFS_NEXT_NTIMES(handle, smb_fname, ft);
536 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
539 return SMB_VFS_NEXT_FTRUNCATE(handle, fsp, offset);
542 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
543 uint32_t mode, off_t offset, off_t len)
545 return SMB_VFS_NEXT_FALLOCATE(handle, fsp, mode, offset, len);
548 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
549 off_t offset, off_t count, int type)
551 return SMB_VFS_NEXT_LOCK(handle, fsp, op, offset, count, type);
554 static int skel_kernel_flock(struct vfs_handle_struct *handle,
555 struct files_struct *fsp, uint32_t share_mode,
556 uint32_t access_mask)
558 return SMB_VFS_NEXT_KERNEL_FLOCK(handle, fsp, share_mode, access_mask);
561 static int skel_fcntl(struct vfs_handle_struct *handle,
562 struct files_struct *fsp, int cmd, va_list cmd_arg)
568 va_copy(dup_cmd_arg, cmd_arg);
569 arg = va_arg(dup_cmd_arg, void *);
570 result = SMB_VFS_NEXT_FCNTL(handle, fsp, cmd, arg);
576 static int skel_linux_setlease(struct vfs_handle_struct *handle,
577 struct files_struct *fsp, int leasetype)
579 return SMB_VFS_NEXT_LINUX_SETLEASE(handle, fsp, leasetype);
582 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
583 off_t *poffset, off_t *pcount, int *ptype,
586 return SMB_VFS_NEXT_GETLOCK(handle, fsp, poffset, pcount, ptype, ppid);
589 static int skel_symlinkat(vfs_handle_struct *handle,
590 const struct smb_filename *link_contents,
591 struct files_struct *dirfsp,
592 const struct smb_filename *new_smb_fname)
594 return SMB_VFS_NEXT_SYMLINKAT(handle,
600 static int skel_vfs_readlinkat(vfs_handle_struct *handle,
601 files_struct *dirfsp,
602 const struct smb_filename *smb_fname,
606 return SMB_VFS_NEXT_READLINKAT(handle,
613 static int skel_linkat(vfs_handle_struct *handle,
614 files_struct *srcfsp,
615 const struct smb_filename *old_smb_fname,
616 files_struct *dstfsp,
617 const struct smb_filename *new_smb_fname,
620 return SMB_VFS_NEXT_LINKAT(handle,
628 static int skel_mknodat(vfs_handle_struct *handle,
629 files_struct *dirfsp,
630 const struct smb_filename *smb_fname,
634 return SMB_VFS_NEXT_MKNODAT(handle,
641 static struct smb_filename *skel_realpath(vfs_handle_struct *handle,
643 const struct smb_filename *smb_fname)
645 return SMB_VFS_NEXT_REALPATH(handle, ctx, smb_fname);
648 static int skel_chflags(vfs_handle_struct *handle,
649 const struct smb_filename *smb_fname,
652 return SMB_VFS_NEXT_CHFLAGS(handle, smb_fname, flags);
655 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
656 const SMB_STRUCT_STAT *sbuf)
658 return SMB_VFS_NEXT_FILE_ID_CREATE(handle, sbuf);
661 static uint64_t skel_fs_file_id(vfs_handle_struct *handle,
662 const SMB_STRUCT_STAT *sbuf)
664 return SMB_VFS_NEXT_FS_FILE_ID(handle, sbuf);
667 struct skel_offload_read_state {
668 struct vfs_handle_struct *handle;
672 static void skel_offload_read_done(struct tevent_req *subreq);
674 static struct tevent_req *skel_offload_read_send(
676 struct tevent_context *ev,
677 struct vfs_handle_struct *handle,
678 struct files_struct *fsp,
684 struct tevent_req *req = NULL;
685 struct skel_offload_read_state *state = NULL;
686 struct tevent_req *subreq = NULL;
688 req = tevent_req_create(mem_ctx, &state, struct skel_offload_read_state);
692 *state = (struct skel_offload_read_state) {
696 subreq = SMB_VFS_NEXT_OFFLOAD_READ_SEND(mem_ctx, ev, handle, fsp,
697 fsctl, ttl, offset, to_copy);
698 if (tevent_req_nomem(subreq, req)) {
699 return tevent_req_post(req, ev);
701 tevent_req_set_callback(subreq, skel_offload_read_done, req);
705 static void skel_offload_read_done(struct tevent_req *subreq)
707 struct tevent_req *req = tevent_req_callback_data(
708 subreq, struct tevent_req);
709 struct skel_offload_read_state *state = tevent_req_data(
710 req, struct skel_offload_read_state);
713 status = SMB_VFS_NEXT_OFFLOAD_READ_RECV(subreq,
718 if (tevent_req_nterror(req, status)) {
722 tevent_req_done(req);
726 static NTSTATUS skel_offload_read_recv(struct tevent_req *req,
727 struct vfs_handle_struct *handle,
731 struct skel_offload_read_state *state = tevent_req_data(
732 req, struct skel_offload_read_state);
736 if (tevent_req_is_nterror(req, &status)) {
737 tevent_req_received(req);
741 token = data_blob_talloc(mem_ctx,
743 state->token.length);
745 tevent_req_received(req);
747 if (token.data == NULL) {
748 return NT_STATUS_NO_MEMORY;
755 struct skel_offload_write_state {
756 struct vfs_handle_struct *handle;
759 static void skel_offload_write_done(struct tevent_req *subreq);
761 static struct tevent_req *skel_offload_write_send(struct vfs_handle_struct *handle,
763 struct tevent_context *ev,
766 off_t transfer_offset,
767 struct files_struct *dest_fsp,
771 struct tevent_req *req;
772 struct tevent_req *subreq;
773 struct skel_offload_write_state *state;
775 req = tevent_req_create(mem_ctx, &state, struct skel_offload_write_state);
780 state->handle = handle;
781 subreq = SMB_VFS_NEXT_OFFLOAD_WRITE_SEND(handle, state, ev,
782 fsctl, token, transfer_offset,
783 dest_fsp, dest_off, num);
784 if (tevent_req_nomem(subreq, req)) {
785 return tevent_req_post(req, ev);
788 tevent_req_set_callback(subreq, skel_offload_write_done, req);
792 static void skel_offload_write_done(struct tevent_req *subreq)
794 struct tevent_req *req = tevent_req_callback_data(
795 subreq, struct tevent_req);
796 struct skel_offload_write_state *state
797 = tevent_req_data(req, struct skel_offload_write_state);
800 status = SMB_VFS_NEXT_OFFLOAD_WRITE_RECV(state->handle,
804 if (tevent_req_nterror(req, status)) {
807 tevent_req_done(req);
810 static NTSTATUS skel_offload_write_recv(struct vfs_handle_struct *handle,
811 struct tevent_req *req,
814 struct skel_offload_write_state *state
815 = tevent_req_data(req, struct skel_offload_write_state);
818 *copied = state->copied;
819 if (tevent_req_is_nterror(req, &status)) {
820 tevent_req_received(req);
824 tevent_req_received(req);
828 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
830 struct files_struct *fsp,
831 struct smb_filename *smb_fname,
832 uint16_t *_compression_fmt)
834 return SMB_VFS_NEXT_GET_COMPRESSION(handle, mem_ctx, fsp, smb_fname,
838 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
840 struct files_struct *fsp,
841 uint16_t compression_fmt)
843 return SMB_VFS_NEXT_SET_COMPRESSION(handle, mem_ctx, fsp,
847 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
848 struct files_struct *fsp,
849 const struct smb_filename *smb_fname,
851 unsigned int *num_streams,
852 struct stream_struct **streams)
854 return SMB_VFS_NEXT_STREAMINFO(handle,
862 static int skel_get_real_filename(struct vfs_handle_struct *handle,
863 const struct smb_filename *path,
865 TALLOC_CTX *mem_ctx, char **found_name)
867 return SMB_VFS_NEXT_GET_REAL_FILENAME(handle,
868 path, name, mem_ctx, found_name);
871 static const char *skel_connectpath(struct vfs_handle_struct *handle,
872 const struct smb_filename *smb_fname)
874 return SMB_VFS_NEXT_CONNECTPATH(handle, smb_fname);
877 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
878 struct byte_range_lock *br_lck,
879 struct lock_struct *plock)
881 return SMB_VFS_NEXT_BRL_LOCK_WINDOWS(handle, br_lck, plock);
884 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
885 struct byte_range_lock *br_lck,
886 const struct lock_struct *plock)
888 return SMB_VFS_NEXT_BRL_UNLOCK_WINDOWS(handle, br_lck, plock);
891 static bool skel_strict_lock_check(struct vfs_handle_struct *handle,
892 struct files_struct *fsp,
893 struct lock_struct *plock)
895 return SMB_VFS_NEXT_STRICT_LOCK_CHECK(handle, fsp, plock);
898 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
899 const char *mapped_name,
900 enum vfs_translate_direction direction,
901 TALLOC_CTX *mem_ctx, char **pmapped_name)
903 return SMB_VFS_NEXT_TRANSLATE_NAME(handle, mapped_name, direction,
904 mem_ctx, pmapped_name);
907 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
908 struct files_struct *fsp,
911 uint16_t req_flags, /* Needed for UNICODE ... */
912 const uint8_t *_in_data,
914 uint8_t ** _out_data,
915 uint32_t max_out_len, uint32_t *out_len)
917 return SMB_VFS_NEXT_FSCTL(handle,
923 in_len, _out_data, max_out_len, out_len);
926 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
927 const struct smb_filename *fname,
929 struct readdir_attr_data **pattr_data)
931 return SMB_VFS_NEXT_READDIR_ATTR(handle, fname, mem_ctx, pattr_data);
934 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
935 struct smb_filename *smb_fname,
938 return SMB_VFS_NEXT_GET_DOS_ATTRIBUTES(handle,
943 struct skel_get_dos_attributes_state {
944 struct vfs_aio_state aio_state;
948 static void skel_get_dos_attributes_done(struct tevent_req *subreq);
950 static struct tevent_req *skel_get_dos_attributes_send(
952 struct tevent_context *ev,
953 struct vfs_handle_struct *handle,
954 files_struct *dir_fsp,
955 struct smb_filename *smb_fname)
957 struct tevent_req *req = NULL;
958 struct skel_get_dos_attributes_state *state = NULL;
959 struct tevent_req *subreq = NULL;
961 req = tevent_req_create(mem_ctx, &state,
962 struct skel_get_dos_attributes_state);
967 subreq = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_SEND(mem_ctx,
972 if (tevent_req_nomem(subreq, req)) {
973 return tevent_req_post(req, ev);
975 tevent_req_set_callback(subreq, skel_get_dos_attributes_done, req);
980 static void skel_get_dos_attributes_done(struct tevent_req *subreq)
982 struct tevent_req *req =
983 tevent_req_callback_data(subreq,
985 struct skel_get_dos_attributes_state *state =
987 struct skel_get_dos_attributes_state);
990 status = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_RECV(subreq,
994 if (tevent_req_nterror(req, status)) {
998 tevent_req_done(req);
1002 static NTSTATUS skel_get_dos_attributes_recv(struct tevent_req *req,
1003 struct vfs_aio_state *aio_state,
1006 struct skel_get_dos_attributes_state *state =
1007 tevent_req_data(req,
1008 struct skel_get_dos_attributes_state);
1011 if (tevent_req_is_nterror(req, &status)) {
1012 tevent_req_received(req);
1016 *aio_state = state->aio_state;
1017 *dosmode = state->dosmode;
1018 tevent_req_received(req);
1019 return NT_STATUS_OK;
1022 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
1023 struct files_struct *fsp,
1026 return SMB_VFS_NEXT_FGET_DOS_ATTRIBUTES(handle,
1031 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
1032 const struct smb_filename *smb_fname,
1035 return SMB_VFS_NEXT_SET_DOS_ATTRIBUTES(handle,
1040 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
1041 struct files_struct *fsp,
1044 return SMB_VFS_NEXT_FSET_DOS_ATTRIBUTES(handle,
1049 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1050 uint32_t security_info,
1051 TALLOC_CTX *mem_ctx,
1052 struct security_descriptor **ppdesc)
1054 return SMB_VFS_NEXT_FGET_NT_ACL(handle, fsp, security_info, mem_ctx,
1058 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
1059 const struct smb_filename *smb_fname,
1060 uint32_t security_info,
1061 TALLOC_CTX *mem_ctx,
1062 struct security_descriptor **ppdesc)
1064 return SMB_VFS_NEXT_GET_NT_ACL(handle,
1071 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1072 uint32_t security_info_sent,
1073 const struct security_descriptor *psd)
1075 return SMB_VFS_NEXT_FSET_NT_ACL(handle, fsp, security_info_sent, psd);
1078 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
1079 const struct smb_filename *smb_fname,
1080 SMB_ACL_TYPE_T type,
1081 TALLOC_CTX *mem_ctx)
1083 return SMB_VFS_NEXT_SYS_ACL_GET_FILE(handle, smb_fname, type, mem_ctx);
1086 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
1087 files_struct *fsp, TALLOC_CTX *mem_ctx)
1089 return SMB_VFS_NEXT_SYS_ACL_GET_FD(handle, fsp, mem_ctx);
1092 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
1093 const struct smb_filename *smb_fname,
1094 TALLOC_CTX *mem_ctx,
1095 char **blob_description,
1098 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FILE(handle, smb_fname, mem_ctx,
1099 blob_description, blob);
1102 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
1103 files_struct *fsp, TALLOC_CTX *mem_ctx,
1104 char **blob_description, DATA_BLOB *blob)
1106 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FD(handle, fsp, mem_ctx,
1107 blob_description, blob);
1110 static int skel_sys_acl_set_file(vfs_handle_struct *handle,
1111 const struct smb_filename *smb_fname,
1112 SMB_ACL_TYPE_T acltype,
1115 return SMB_VFS_NEXT_SYS_ACL_SET_FILE(handle, smb_fname,
1119 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
1122 return SMB_VFS_NEXT_SYS_ACL_SET_FD(handle, fsp, theacl);
1125 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
1126 const struct smb_filename *smb_fname)
1128 return SMB_VFS_NEXT_SYS_ACL_DELETE_DEF_FILE(handle, smb_fname);
1131 static ssize_t skel_getxattr(vfs_handle_struct *handle,
1132 const struct smb_filename *smb_fname,
1137 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname, name, value, size);
1140 struct skel_getxattrat_state {
1141 struct vfs_aio_state aio_state;
1143 uint8_t *xattr_value;
1146 static void skel_getxattrat_done(struct tevent_req *subreq);
1148 static struct tevent_req *skel_getxattrat_send(
1149 TALLOC_CTX *mem_ctx,
1150 struct tevent_context *ev,
1151 struct vfs_handle_struct *handle,
1152 files_struct *dir_fsp,
1153 const struct smb_filename *smb_fname,
1154 const char *xattr_name,
1157 struct tevent_req *req = NULL;
1158 struct skel_getxattrat_state *state = NULL;
1159 struct tevent_req *subreq = NULL;
1161 req = tevent_req_create(mem_ctx, &state,
1162 struct skel_getxattrat_state);
1167 subreq = SMB_VFS_NEXT_GETXATTRAT_SEND(state,
1174 if (tevent_req_nomem(subreq, req)) {
1175 return tevent_req_post(req, ev);
1177 tevent_req_set_callback(subreq, skel_getxattrat_done, req);
1182 static void skel_getxattrat_done(struct tevent_req *subreq)
1184 struct tevent_req *req = tevent_req_callback_data(
1185 subreq, struct tevent_req);
1186 struct skel_getxattrat_state *state = tevent_req_data(
1187 req, struct skel_getxattrat_state);
1189 state->xattr_size = SMB_VFS_NEXT_GETXATTRAT_RECV(subreq,
1192 &state->xattr_value);
1193 TALLOC_FREE(subreq);
1194 if (state->xattr_size == -1) {
1195 tevent_req_error(req, state->aio_state.error);
1199 tevent_req_done(req);
1202 static ssize_t skel_getxattrat_recv(struct tevent_req *req,
1203 struct vfs_aio_state *aio_state,
1204 TALLOC_CTX *mem_ctx,
1205 uint8_t **xattr_value)
1207 struct skel_getxattrat_state *state = tevent_req_data(
1208 req, struct skel_getxattrat_state);
1211 if (tevent_req_is_unix_error(req, &aio_state->error)) {
1212 tevent_req_received(req);
1216 *aio_state = state->aio_state;
1217 xattr_size = state->xattr_size;
1218 if (xattr_value != NULL) {
1219 *xattr_value = talloc_move(mem_ctx, &state->xattr_value);
1222 tevent_req_received(req);
1226 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
1227 struct files_struct *fsp, const char *name,
1228 void *value, size_t size)
1230 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
1233 static ssize_t skel_listxattr(vfs_handle_struct *handle,
1234 const struct smb_filename *smb_fname,
1238 return SMB_VFS_NEXT_LISTXATTR(handle, smb_fname, list, size);
1241 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
1242 struct files_struct *fsp, char *list,
1245 return SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
1248 static int skel_removexattr(vfs_handle_struct *handle,
1249 const struct smb_filename *smb_fname,
1252 return SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname, name);
1255 static int skel_fremovexattr(vfs_handle_struct *handle,
1256 struct files_struct *fsp, const char *name)
1258 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
1261 static int skel_setxattr(vfs_handle_struct *handle,
1262 const struct smb_filename *smb_fname,
1268 return SMB_VFS_NEXT_SETXATTR(handle, smb_fname,
1269 name, value, size, flags);
1272 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
1273 const char *name, const void *value, size_t size,
1276 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value, size, flags);
1279 static bool skel_aio_force(struct vfs_handle_struct *handle,
1280 struct files_struct *fsp)
1282 return SMB_VFS_NEXT_AIO_FORCE(handle, fsp);
1285 static NTSTATUS skel_audit_file(struct vfs_handle_struct *handle,
1286 struct smb_filename *file,
1287 struct security_acl *sacl,
1288 uint32_t access_requested,
1289 uint32_t access_denied)
1291 return SMB_VFS_NEXT_AUDIT_FILE(handle,
1298 static NTSTATUS skel_durable_cookie(struct vfs_handle_struct *handle,
1299 struct files_struct *fsp,
1300 TALLOC_CTX *mem_ctx,
1303 return SMB_VFS_NEXT_DURABLE_COOKIE(handle,
1309 static NTSTATUS skel_durable_disconnect(struct vfs_handle_struct *handle,
1310 struct files_struct *fsp,
1311 const DATA_BLOB old_cookie,
1312 TALLOC_CTX *mem_ctx,
1313 DATA_BLOB *new_cookie)
1315 return SMB_VFS_NEXT_DURABLE_DISCONNECT(handle,
1322 static NTSTATUS skel_durable_reconnect(struct vfs_handle_struct *handle,
1323 struct smb_request *smb1req,
1324 struct smbXsrv_open *op,
1325 const DATA_BLOB old_cookie,
1326 TALLOC_CTX *mem_ctx,
1327 struct files_struct **fsp,
1328 DATA_BLOB *new_cookie)
1330 return SMB_VFS_NEXT_DURABLE_RECONNECT(handle,
1339 /* VFS operations structure */
1341 static struct vfs_fn_pointers skel_transparent_fns = {
1342 /* Disk operations */
1344 .connect_fn = skel_connect,
1345 .disconnect_fn = skel_disconnect,
1346 .disk_free_fn = skel_disk_free,
1347 .get_quota_fn = skel_get_quota,
1348 .set_quota_fn = skel_set_quota,
1349 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
1350 .statvfs_fn = skel_statvfs,
1351 .fs_capabilities_fn = skel_fs_capabilities,
1352 .get_dfs_referrals_fn = skel_get_dfs_referrals,
1353 .create_dfs_pathat_fn = skel_create_dfs_pathat,
1354 .read_dfs_pathat_fn = skel_read_dfs_pathat,
1355 .snap_check_path_fn = skel_snap_check_path,
1356 .snap_create_fn = skel_snap_create,
1357 .snap_delete_fn = skel_snap_delete,
1359 /* Directory operations */
1361 .fdopendir_fn = skel_fdopendir,
1362 .readdir_fn = skel_readdir,
1363 .seekdir_fn = skel_seekdir,
1364 .telldir_fn = skel_telldir,
1365 .rewind_dir_fn = skel_rewind_dir,
1366 .mkdirat_fn = skel_mkdirat,
1367 .closedir_fn = skel_closedir,
1369 /* File operations */
1371 .open_fn = skel_open,
1372 .create_file_fn = skel_create_file,
1373 .close_fn = skel_close_fn,
1374 .pread_fn = skel_pread,
1375 .pread_send_fn = skel_pread_send,
1376 .pread_recv_fn = skel_pread_recv,
1377 .pwrite_fn = skel_pwrite,
1378 .pwrite_send_fn = skel_pwrite_send,
1379 .pwrite_recv_fn = skel_pwrite_recv,
1380 .lseek_fn = skel_lseek,
1381 .sendfile_fn = skel_sendfile,
1382 .recvfile_fn = skel_recvfile,
1383 .renameat_fn = skel_renameat,
1384 .fsync_send_fn = skel_fsync_send,
1385 .fsync_recv_fn = skel_fsync_recv,
1386 .stat_fn = skel_stat,
1387 .fstat_fn = skel_fstat,
1388 .lstat_fn = skel_lstat,
1389 .get_alloc_size_fn = skel_get_alloc_size,
1390 .unlinkat_fn = skel_unlinkat,
1391 .chmod_fn = skel_chmod,
1392 .fchmod_fn = skel_fchmod,
1393 .fchown_fn = skel_fchown,
1394 .lchown_fn = skel_lchown,
1395 .chdir_fn = skel_chdir,
1396 .getwd_fn = skel_getwd,
1397 .ntimes_fn = skel_ntimes,
1398 .ftruncate_fn = skel_ftruncate,
1399 .fallocate_fn = skel_fallocate,
1400 .lock_fn = skel_lock,
1401 .kernel_flock_fn = skel_kernel_flock,
1402 .fcntl_fn = skel_fcntl,
1403 .linux_setlease_fn = skel_linux_setlease,
1404 .getlock_fn = skel_getlock,
1405 .symlinkat_fn = skel_symlinkat,
1406 .readlinkat_fn = skel_vfs_readlinkat,
1407 .linkat_fn = skel_linkat,
1408 .mknodat_fn = skel_mknodat,
1409 .realpath_fn = skel_realpath,
1410 .chflags_fn = skel_chflags,
1411 .file_id_create_fn = skel_file_id_create,
1412 .fs_file_id_fn = skel_fs_file_id,
1413 .offload_read_send_fn = skel_offload_read_send,
1414 .offload_read_recv_fn = skel_offload_read_recv,
1415 .offload_write_send_fn = skel_offload_write_send,
1416 .offload_write_recv_fn = skel_offload_write_recv,
1417 .get_compression_fn = skel_get_compression,
1418 .set_compression_fn = skel_set_compression,
1420 .streaminfo_fn = skel_streaminfo,
1421 .get_real_filename_fn = skel_get_real_filename,
1422 .connectpath_fn = skel_connectpath,
1423 .brl_lock_windows_fn = skel_brl_lock_windows,
1424 .brl_unlock_windows_fn = skel_brl_unlock_windows,
1425 .strict_lock_check_fn = skel_strict_lock_check,
1426 .translate_name_fn = skel_translate_name,
1427 .fsctl_fn = skel_fsctl,
1428 .readdir_attr_fn = skel_readdir_attr,
1429 .audit_file_fn = skel_audit_file,
1431 /* DOS attributes. */
1432 .get_dos_attributes_fn = skel_get_dos_attributes,
1433 .get_dos_attributes_send_fn = skel_get_dos_attributes_send,
1434 .get_dos_attributes_recv_fn = skel_get_dos_attributes_recv,
1435 .fget_dos_attributes_fn = skel_fget_dos_attributes,
1436 .set_dos_attributes_fn = skel_set_dos_attributes,
1437 .fset_dos_attributes_fn = skel_fset_dos_attributes,
1439 /* NT ACL operations. */
1441 .fget_nt_acl_fn = skel_fget_nt_acl,
1442 .get_nt_acl_fn = skel_get_nt_acl,
1443 .fset_nt_acl_fn = skel_fset_nt_acl,
1445 /* POSIX ACL operations. */
1447 .sys_acl_get_file_fn = skel_sys_acl_get_file,
1448 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
1449 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
1450 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
1451 .sys_acl_set_file_fn = skel_sys_acl_set_file,
1452 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
1453 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1455 /* EA operations. */
1456 .getxattr_fn = skel_getxattr,
1457 .getxattrat_send_fn = skel_getxattrat_send,
1458 .getxattrat_recv_fn = skel_getxattrat_recv,
1459 .fgetxattr_fn = skel_fgetxattr,
1460 .listxattr_fn = skel_listxattr,
1461 .flistxattr_fn = skel_flistxattr,
1462 .removexattr_fn = skel_removexattr,
1463 .fremovexattr_fn = skel_fremovexattr,
1464 .setxattr_fn = skel_setxattr,
1465 .fsetxattr_fn = skel_fsetxattr,
1467 /* aio operations */
1468 .aio_force_fn = skel_aio_force,
1470 /* durable handle operations */
1471 .durable_cookie_fn = skel_durable_cookie,
1472 .durable_disconnect_fn = skel_durable_disconnect,
1473 .durable_reconnect_fn = skel_durable_reconnect,
1477 NTSTATUS vfs_skel_transparent_init(TALLOC_CTX *ctx)
1480 * smb_vfs_assert_all_fns() is only needed in
1481 * order to have a complete example.
1483 * A transparent vfs module typically don't
1484 * need to implement every calls.
1486 smb_vfs_assert_all_fns(&skel_transparent_fns, "skel_transparent");
1487 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent",
1488 &skel_transparent_fns);