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 * neccessary 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 DIR *skel_opendir(vfs_handle_struct *handle,
104 const struct smb_filename *smb_fname,
108 return SMB_VFS_NEXT_OPENDIR(handle, smb_fname, mask, attr);
111 static NTSTATUS skel_snap_check_path(struct vfs_handle_struct *handle,
113 const char *service_path,
116 return SMB_VFS_NEXT_SNAP_CHECK_PATH(handle, mem_ctx, service_path,
120 static NTSTATUS skel_snap_create(struct vfs_handle_struct *handle,
122 const char *base_volume,
128 return SMB_VFS_NEXT_SNAP_CREATE(handle, mem_ctx, base_volume, tstamp,
129 rw, base_path, snap_path);
132 static NTSTATUS skel_snap_delete(struct vfs_handle_struct *handle,
137 return SMB_VFS_NEXT_SNAP_DELETE(handle, mem_ctx, base_path, snap_path);
140 static DIR *skel_fdopendir(vfs_handle_struct *handle, files_struct *fsp,
141 const char *mask, uint32_t attr)
143 return SMB_VFS_NEXT_FDOPENDIR(handle, fsp, mask, attr);
146 static struct dirent *skel_readdir(vfs_handle_struct *handle,
147 DIR *dirp, SMB_STRUCT_STAT *sbuf)
149 return SMB_VFS_NEXT_READDIR(handle, dirp, sbuf);
152 static void skel_seekdir(vfs_handle_struct *handle, DIR *dirp, long offset)
154 SMB_VFS_NEXT_SEEKDIR(handle, dirp, offset);
157 static long skel_telldir(vfs_handle_struct *handle, DIR *dirp)
159 return SMB_VFS_NEXT_TELLDIR(handle, dirp);
162 static void skel_rewind_dir(vfs_handle_struct *handle, DIR *dirp)
164 SMB_VFS_NEXT_REWINDDIR(handle, dirp);
167 static int skel_mkdirat(vfs_handle_struct *handle,
168 struct files_struct *dirfsp,
169 const struct smb_filename *smb_fname,
172 return SMB_VFS_NEXT_MKDIRAT(handle,
178 static int skel_rmdir(vfs_handle_struct *handle,
179 const struct smb_filename *smb_fname)
181 return SMB_VFS_NEXT_RMDIR(handle, smb_fname);
184 static int skel_closedir(vfs_handle_struct *handle, DIR *dir)
186 return SMB_VFS_NEXT_CLOSEDIR(handle, dir);
189 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
190 files_struct *fsp, int flags, mode_t mode)
192 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
195 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
196 struct smb_request *req,
197 uint16_t root_dir_fid,
198 struct smb_filename *smb_fname,
199 uint32_t access_mask,
200 uint32_t share_access,
201 uint32_t create_disposition,
202 uint32_t create_options,
203 uint32_t file_attributes,
204 uint32_t oplock_request,
205 const struct smb2_lease *lease,
206 uint64_t allocation_size,
207 uint32_t private_flags,
208 struct security_descriptor *sd,
209 struct ea_list *ea_list,
210 files_struct ** result, int *pinfo,
211 const struct smb2_create_blobs *in_context_blobs,
212 struct smb2_create_blobs *out_context_blobs)
214 return SMB_VFS_NEXT_CREATE_FILE(handle,
227 sd, ea_list, result, pinfo,
228 in_context_blobs, out_context_blobs);
231 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
233 return SMB_VFS_NEXT_CLOSE(handle, fsp);
236 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
237 void *data, size_t n, off_t offset)
239 return SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
242 struct skel_pread_state {
244 struct vfs_aio_state vfs_aio_state;
247 static void skel_pread_done(struct tevent_req *subreq);
249 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
251 struct tevent_context *ev,
252 struct files_struct *fsp,
253 void *data, size_t n, off_t offset)
255 struct tevent_req *req, *subreq;
256 struct skel_pread_state *state;
258 req = tevent_req_create(mem_ctx, &state, struct skel_pread_state);
262 subreq = SMB_VFS_NEXT_PREAD_SEND(state, ev, handle, fsp, data,
264 if (tevent_req_nomem(subreq, req)) {
265 return tevent_req_post(req, ev);
267 tevent_req_set_callback(subreq, skel_pread_done, req);
271 static void skel_pread_done(struct tevent_req *subreq)
273 struct tevent_req *req =
274 tevent_req_callback_data(subreq, struct tevent_req);
275 struct skel_pread_state *state =
276 tevent_req_data(req, struct skel_pread_state);
278 state->ret = SMB_VFS_PREAD_RECV(subreq, &state->vfs_aio_state);
280 tevent_req_done(req);
283 static ssize_t skel_pread_recv(struct tevent_req *req,
284 struct vfs_aio_state *vfs_aio_state)
286 struct skel_pread_state *state =
287 tevent_req_data(req, struct skel_pread_state);
289 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
292 *vfs_aio_state = state->vfs_aio_state;
296 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
297 const void *data, size_t n, off_t offset)
299 return SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
302 struct skel_pwrite_state {
304 struct vfs_aio_state vfs_aio_state;
307 static void skel_pwrite_done(struct tevent_req *subreq);
309 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
311 struct tevent_context *ev,
312 struct files_struct *fsp,
314 size_t n, off_t offset)
316 struct tevent_req *req, *subreq;
317 struct skel_pwrite_state *state;
319 req = tevent_req_create(mem_ctx, &state, struct skel_pwrite_state);
323 subreq = SMB_VFS_NEXT_PWRITE_SEND(state, ev, handle, fsp, data,
325 if (tevent_req_nomem(subreq, req)) {
326 return tevent_req_post(req, ev);
328 tevent_req_set_callback(subreq, skel_pwrite_done, req);
332 static void skel_pwrite_done(struct tevent_req *subreq)
334 struct tevent_req *req =
335 tevent_req_callback_data(subreq, struct tevent_req);
336 struct skel_pwrite_state *state =
337 tevent_req_data(req, struct skel_pwrite_state);
339 state->ret = SMB_VFS_PWRITE_RECV(subreq, &state->vfs_aio_state);
341 tevent_req_done(req);
344 static ssize_t skel_pwrite_recv(struct tevent_req *req,
345 struct vfs_aio_state *vfs_aio_state)
347 struct skel_pwrite_state *state =
348 tevent_req_data(req, struct skel_pwrite_state);
350 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
353 *vfs_aio_state = state->vfs_aio_state;
357 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
358 off_t offset, int whence)
360 return SMB_VFS_NEXT_LSEEK(handle, fsp, offset, whence);
363 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
364 files_struct *fromfsp, const DATA_BLOB *hdr,
365 off_t offset, size_t n)
367 return SMB_VFS_NEXT_SENDFILE(handle, tofd, fromfsp, hdr, offset, n);
370 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
371 files_struct *tofsp, off_t offset, size_t n)
373 return SMB_VFS_NEXT_RECVFILE(handle, fromfd, tofsp, offset, n);
376 static int skel_renameat(vfs_handle_struct *handle,
377 files_struct *srcfsp,
378 const struct smb_filename *smb_fname_src,
379 files_struct *dstfsp,
380 const struct smb_filename *smb_fname_dst)
382 return SMB_VFS_NEXT_RENAMEAT(handle,
389 struct skel_fsync_state {
391 struct vfs_aio_state vfs_aio_state;
394 static void skel_fsync_done(struct tevent_req *subreq);
396 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
398 struct tevent_context *ev,
399 struct files_struct *fsp)
401 struct tevent_req *req, *subreq;
402 struct skel_fsync_state *state;
404 req = tevent_req_create(mem_ctx, &state, struct skel_fsync_state);
408 subreq = SMB_VFS_NEXT_FSYNC_SEND(state, ev, handle, fsp);
409 if (tevent_req_nomem(subreq, req)) {
410 return tevent_req_post(req, ev);
412 tevent_req_set_callback(subreq, skel_fsync_done, req);
416 static void skel_fsync_done(struct tevent_req *subreq)
418 struct tevent_req *req =
419 tevent_req_callback_data(subreq, struct tevent_req);
420 struct skel_fsync_state *state =
421 tevent_req_data(req, struct skel_fsync_state);
423 state->ret = SMB_VFS_FSYNC_RECV(subreq, &state->vfs_aio_state);
425 tevent_req_done(req);
428 static int skel_fsync_recv(struct tevent_req *req,
429 struct vfs_aio_state *vfs_aio_state)
431 struct skel_fsync_state *state =
432 tevent_req_data(req, struct skel_fsync_state);
434 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
437 *vfs_aio_state = state->vfs_aio_state;
441 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
443 return SMB_VFS_NEXT_STAT(handle, smb_fname);
446 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
447 SMB_STRUCT_STAT *sbuf)
449 return SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
452 static int skel_lstat(vfs_handle_struct *handle,
453 struct smb_filename *smb_fname)
455 return SMB_VFS_NEXT_LSTAT(handle, smb_fname);
458 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
459 struct files_struct *fsp,
460 const SMB_STRUCT_STAT *sbuf)
462 return SMB_VFS_NEXT_GET_ALLOC_SIZE(handle, fsp, sbuf);
465 static int skel_unlink(vfs_handle_struct *handle,
466 const struct smb_filename *smb_fname)
468 return SMB_VFS_NEXT_UNLINK(handle, smb_fname);
471 static int skel_chmod(vfs_handle_struct *handle,
472 const struct smb_filename *smb_fname,
475 return SMB_VFS_NEXT_CHMOD(handle, smb_fname, mode);
478 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
481 return SMB_VFS_NEXT_FCHMOD(handle, fsp, mode);
484 static int skel_chown(vfs_handle_struct *handle,
485 const struct smb_filename *smb_fname,
489 return SMB_VFS_NEXT_CHOWN(handle, smb_fname, uid, gid);
492 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
493 uid_t uid, gid_t gid)
495 return SMB_VFS_NEXT_FCHOWN(handle, fsp, uid, gid);
498 static int skel_lchown(vfs_handle_struct *handle,
499 const struct smb_filename *smb_fname,
503 return SMB_VFS_NEXT_LCHOWN(handle, smb_fname, uid, gid);
506 static int skel_chdir(vfs_handle_struct *handle,
507 const struct smb_filename *smb_fname)
509 return SMB_VFS_NEXT_CHDIR(handle, smb_fname);
512 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
515 return SMB_VFS_NEXT_GETWD(handle, ctx);
518 static int skel_ntimes(vfs_handle_struct *handle,
519 const struct smb_filename *smb_fname,
520 struct smb_file_time *ft)
522 return SMB_VFS_NEXT_NTIMES(handle, smb_fname, ft);
525 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
528 return SMB_VFS_NEXT_FTRUNCATE(handle, fsp, offset);
531 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
532 uint32_t mode, off_t offset, off_t len)
534 return SMB_VFS_NEXT_FALLOCATE(handle, fsp, mode, offset, len);
537 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
538 off_t offset, off_t count, int type)
540 return SMB_VFS_NEXT_LOCK(handle, fsp, op, offset, count, type);
543 static int skel_kernel_flock(struct vfs_handle_struct *handle,
544 struct files_struct *fsp, uint32_t share_mode,
545 uint32_t access_mask)
547 return SMB_VFS_NEXT_KERNEL_FLOCK(handle, fsp, share_mode, access_mask);
550 static int skel_linux_setlease(struct vfs_handle_struct *handle,
551 struct files_struct *fsp, int leasetype)
553 return SMB_VFS_NEXT_LINUX_SETLEASE(handle, fsp, leasetype);
556 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
557 off_t *poffset, off_t *pcount, int *ptype,
560 return SMB_VFS_NEXT_GETLOCK(handle, fsp, poffset, pcount, ptype, ppid);
563 static int skel_symlinkat(vfs_handle_struct *handle,
564 const char *link_contents,
565 struct files_struct *dirfsp,
566 const struct smb_filename *new_smb_fname)
568 return SMB_VFS_NEXT_SYMLINKAT(handle,
574 static int skel_vfs_readlinkat(vfs_handle_struct *handle,
575 files_struct *dirfsp,
576 const struct smb_filename *smb_fname,
580 return SMB_VFS_NEXT_READLINKAT(handle,
587 static int skel_linkat(vfs_handle_struct *handle,
588 files_struct *srcfsp,
589 const struct smb_filename *old_smb_fname,
590 files_struct *dstfsp,
591 const struct smb_filename *new_smb_fname,
594 return SMB_VFS_NEXT_LINKAT(handle,
602 static int skel_mknodat(vfs_handle_struct *handle,
603 files_struct *dirfsp,
604 const struct smb_filename *smb_fname,
608 return SMB_VFS_NEXT_MKNODAT(handle,
615 static struct smb_filename *skel_realpath(vfs_handle_struct *handle,
617 const struct smb_filename *smb_fname)
619 return SMB_VFS_NEXT_REALPATH(handle, ctx, smb_fname);
622 static int skel_chflags(vfs_handle_struct *handle,
623 const struct smb_filename *smb_fname,
626 return SMB_VFS_NEXT_CHFLAGS(handle, smb_fname, flags);
629 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
630 const SMB_STRUCT_STAT *sbuf)
632 return SMB_VFS_NEXT_FILE_ID_CREATE(handle, sbuf);
635 static uint64_t skel_fs_file_id(vfs_handle_struct *handle,
636 const SMB_STRUCT_STAT *sbuf)
638 return SMB_VFS_NEXT_FS_FILE_ID(handle, sbuf);
641 struct skel_offload_read_state {
642 struct vfs_handle_struct *handle;
646 static void skel_offload_read_done(struct tevent_req *subreq);
648 static struct tevent_req *skel_offload_read_send(
650 struct tevent_context *ev,
651 struct vfs_handle_struct *handle,
652 struct files_struct *fsp,
658 struct tevent_req *req = NULL;
659 struct skel_offload_read_state *state = NULL;
660 struct tevent_req *subreq = NULL;
662 req = tevent_req_create(mem_ctx, &state, struct skel_offload_read_state);
666 *state = (struct skel_offload_read_state) {
670 subreq = SMB_VFS_NEXT_OFFLOAD_READ_SEND(mem_ctx, ev, handle, fsp,
671 fsctl, ttl, offset, to_copy);
672 if (tevent_req_nomem(subreq, req)) {
673 return tevent_req_post(req, ev);
675 tevent_req_set_callback(subreq, skel_offload_read_done, req);
679 static void skel_offload_read_done(struct tevent_req *subreq)
681 struct tevent_req *req = tevent_req_callback_data(
682 subreq, struct tevent_req);
683 struct skel_offload_read_state *state = tevent_req_data(
684 req, struct skel_offload_read_state);
687 status = SMB_VFS_NEXT_OFFLOAD_READ_RECV(subreq,
692 if (tevent_req_nterror(req, status)) {
696 tevent_req_done(req);
700 static NTSTATUS skel_offload_read_recv(struct tevent_req *req,
701 struct vfs_handle_struct *handle,
705 struct skel_offload_read_state *state = tevent_req_data(
706 req, struct skel_offload_read_state);
710 if (tevent_req_is_nterror(req, &status)) {
711 tevent_req_received(req);
715 token = data_blob_talloc(mem_ctx,
717 state->token.length);
719 tevent_req_received(req);
721 if (token.data == NULL) {
722 return NT_STATUS_NO_MEMORY;
729 struct skel_offload_write_state {
730 struct vfs_handle_struct *handle;
733 static void skel_offload_write_done(struct tevent_req *subreq);
735 static struct tevent_req *skel_offload_write_send(struct vfs_handle_struct *handle,
737 struct tevent_context *ev,
740 off_t transfer_offset,
741 struct files_struct *dest_fsp,
745 struct tevent_req *req;
746 struct tevent_req *subreq;
747 struct skel_offload_write_state *state;
749 req = tevent_req_create(mem_ctx, &state, struct skel_offload_write_state);
754 state->handle = handle;
755 subreq = SMB_VFS_NEXT_OFFLOAD_WRITE_SEND(handle, state, ev,
756 fsctl, token, transfer_offset,
757 dest_fsp, dest_off, num);
758 if (tevent_req_nomem(subreq, req)) {
759 return tevent_req_post(req, ev);
762 tevent_req_set_callback(subreq, skel_offload_write_done, req);
766 static void skel_offload_write_done(struct tevent_req *subreq)
768 struct tevent_req *req = tevent_req_callback_data(
769 subreq, struct tevent_req);
770 struct skel_offload_write_state *state
771 = tevent_req_data(req, struct skel_offload_write_state);
774 status = SMB_VFS_NEXT_OFFLOAD_WRITE_RECV(state->handle,
778 if (tevent_req_nterror(req, status)) {
781 tevent_req_done(req);
784 static NTSTATUS skel_offload_write_recv(struct vfs_handle_struct *handle,
785 struct tevent_req *req,
788 struct skel_offload_write_state *state
789 = tevent_req_data(req, struct skel_offload_write_state);
792 *copied = state->copied;
793 if (tevent_req_is_nterror(req, &status)) {
794 tevent_req_received(req);
798 tevent_req_received(req);
802 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
804 struct files_struct *fsp,
805 struct smb_filename *smb_fname,
806 uint16_t *_compression_fmt)
808 return SMB_VFS_NEXT_GET_COMPRESSION(handle, mem_ctx, fsp, smb_fname,
812 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
814 struct files_struct *fsp,
815 uint16_t compression_fmt)
817 return SMB_VFS_NEXT_SET_COMPRESSION(handle, mem_ctx, fsp,
821 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
822 struct files_struct *fsp,
823 const struct smb_filename *smb_fname,
825 unsigned int *num_streams,
826 struct stream_struct **streams)
828 return SMB_VFS_NEXT_STREAMINFO(handle,
836 static int skel_get_real_filename(struct vfs_handle_struct *handle,
839 TALLOC_CTX *mem_ctx, char **found_name)
841 return SMB_VFS_NEXT_GET_REAL_FILENAME(handle,
842 path, name, mem_ctx, found_name);
845 static const char *skel_connectpath(struct vfs_handle_struct *handle,
846 const struct smb_filename *smb_fname)
848 return SMB_VFS_NEXT_CONNECTPATH(handle, smb_fname);
851 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
852 struct byte_range_lock *br_lck,
853 struct lock_struct *plock)
855 return SMB_VFS_NEXT_BRL_LOCK_WINDOWS(handle, br_lck, plock);
858 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
859 struct byte_range_lock *br_lck,
860 const struct lock_struct *plock)
862 return SMB_VFS_NEXT_BRL_UNLOCK_WINDOWS(handle, br_lck, plock);
865 static bool skel_strict_lock_check(struct vfs_handle_struct *handle,
866 struct files_struct *fsp,
867 struct lock_struct *plock)
869 return SMB_VFS_NEXT_STRICT_LOCK_CHECK(handle, fsp, plock);
872 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
873 const char *mapped_name,
874 enum vfs_translate_direction direction,
875 TALLOC_CTX *mem_ctx, char **pmapped_name)
877 return SMB_VFS_NEXT_TRANSLATE_NAME(handle, mapped_name, direction,
878 mem_ctx, pmapped_name);
881 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
882 struct files_struct *fsp,
885 uint16_t req_flags, /* Needed for UNICODE ... */
886 const uint8_t *_in_data,
888 uint8_t ** _out_data,
889 uint32_t max_out_len, uint32_t *out_len)
891 return SMB_VFS_NEXT_FSCTL(handle,
897 in_len, _out_data, max_out_len, out_len);
900 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
901 const struct smb_filename *fname,
903 struct readdir_attr_data **pattr_data)
905 return SMB_VFS_NEXT_READDIR_ATTR(handle, fname, mem_ctx, pattr_data);
908 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
909 struct smb_filename *smb_fname,
912 return SMB_VFS_NEXT_GET_DOS_ATTRIBUTES(handle,
917 struct skel_get_dos_attributes_state {
918 struct vfs_aio_state aio_state;
922 static void skel_get_dos_attributes_done(struct tevent_req *subreq);
924 static struct tevent_req *skel_get_dos_attributes_send(
926 struct tevent_context *ev,
927 struct vfs_handle_struct *handle,
928 files_struct *dir_fsp,
929 struct smb_filename *smb_fname)
931 struct tevent_req *req = NULL;
932 struct skel_get_dos_attributes_state *state = NULL;
933 struct tevent_req *subreq = NULL;
935 req = tevent_req_create(mem_ctx, &state,
936 struct skel_get_dos_attributes_state);
941 subreq = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_SEND(mem_ctx,
946 if (tevent_req_nomem(subreq, req)) {
947 return tevent_req_post(req, ev);
949 tevent_req_set_callback(subreq, skel_get_dos_attributes_done, req);
954 static void skel_get_dos_attributes_done(struct tevent_req *subreq)
956 struct tevent_req *req =
957 tevent_req_callback_data(subreq,
959 struct skel_get_dos_attributes_state *state =
961 struct skel_get_dos_attributes_state);
964 status = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_RECV(subreq,
968 if (tevent_req_nterror(req, status)) {
972 tevent_req_done(req);
976 static NTSTATUS skel_get_dos_attributes_recv(struct tevent_req *req,
977 struct vfs_aio_state *aio_state,
980 struct skel_get_dos_attributes_state *state =
982 struct skel_get_dos_attributes_state);
985 if (tevent_req_is_nterror(req, &status)) {
986 tevent_req_received(req);
990 *aio_state = state->aio_state;
991 *dosmode = state->dosmode;
992 tevent_req_received(req);
996 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
997 struct files_struct *fsp,
1000 return SMB_VFS_NEXT_FGET_DOS_ATTRIBUTES(handle,
1005 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
1006 const struct smb_filename *smb_fname,
1009 return SMB_VFS_NEXT_SET_DOS_ATTRIBUTES(handle,
1014 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
1015 struct files_struct *fsp,
1018 return SMB_VFS_NEXT_FSET_DOS_ATTRIBUTES(handle,
1023 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1024 uint32_t security_info,
1025 TALLOC_CTX *mem_ctx,
1026 struct security_descriptor **ppdesc)
1028 return SMB_VFS_NEXT_FGET_NT_ACL(handle, fsp, security_info, mem_ctx,
1032 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
1033 const struct smb_filename *smb_fname,
1034 uint32_t security_info,
1035 TALLOC_CTX *mem_ctx,
1036 struct security_descriptor **ppdesc)
1038 return SMB_VFS_NEXT_GET_NT_ACL(handle,
1045 static NTSTATUS skel_fset_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1046 uint32_t security_info_sent,
1047 const struct security_descriptor *psd)
1049 return SMB_VFS_NEXT_FSET_NT_ACL(handle, fsp, security_info_sent, psd);
1052 static SMB_ACL_T skel_sys_acl_get_file(vfs_handle_struct *handle,
1053 const struct smb_filename *smb_fname,
1054 SMB_ACL_TYPE_T type,
1055 TALLOC_CTX *mem_ctx)
1057 return SMB_VFS_NEXT_SYS_ACL_GET_FILE(handle, smb_fname, type, mem_ctx);
1060 static SMB_ACL_T skel_sys_acl_get_fd(vfs_handle_struct *handle,
1061 files_struct *fsp, TALLOC_CTX *mem_ctx)
1063 return SMB_VFS_NEXT_SYS_ACL_GET_FD(handle, fsp, mem_ctx);
1066 static int skel_sys_acl_blob_get_file(vfs_handle_struct *handle,
1067 const struct smb_filename *smb_fname,
1068 TALLOC_CTX *mem_ctx,
1069 char **blob_description,
1072 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FILE(handle, smb_fname, mem_ctx,
1073 blob_description, blob);
1076 static int skel_sys_acl_blob_get_fd(vfs_handle_struct *handle,
1077 files_struct *fsp, TALLOC_CTX *mem_ctx,
1078 char **blob_description, DATA_BLOB *blob)
1080 return SMB_VFS_NEXT_SYS_ACL_BLOB_GET_FD(handle, fsp, mem_ctx,
1081 blob_description, blob);
1084 static int skel_sys_acl_set_file(vfs_handle_struct *handle,
1085 const struct smb_filename *smb_fname,
1086 SMB_ACL_TYPE_T acltype,
1089 return SMB_VFS_NEXT_SYS_ACL_SET_FILE(handle, smb_fname,
1093 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
1096 return SMB_VFS_NEXT_SYS_ACL_SET_FD(handle, fsp, theacl);
1099 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
1100 const struct smb_filename *smb_fname)
1102 return SMB_VFS_NEXT_SYS_ACL_DELETE_DEF_FILE(handle, smb_fname);
1105 static ssize_t skel_getxattr(vfs_handle_struct *handle,
1106 const struct smb_filename *smb_fname,
1111 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname, name, value, size);
1114 struct skel_getxattrat_state {
1115 struct vfs_aio_state aio_state;
1117 uint8_t *xattr_value;
1120 static void skel_getxattrat_done(struct tevent_req *subreq);
1122 static struct tevent_req *skel_getxattrat_send(
1123 TALLOC_CTX *mem_ctx,
1124 struct tevent_context *ev,
1125 struct vfs_handle_struct *handle,
1126 files_struct *dir_fsp,
1127 const struct smb_filename *smb_fname,
1128 const char *xattr_name,
1131 struct tevent_req *req = NULL;
1132 struct skel_getxattrat_state *state = NULL;
1133 struct tevent_req *subreq = NULL;
1135 req = tevent_req_create(mem_ctx, &state,
1136 struct skel_getxattrat_state);
1141 subreq = SMB_VFS_NEXT_GETXATTRAT_SEND(state,
1148 if (tevent_req_nomem(subreq, req)) {
1149 return tevent_req_post(req, ev);
1151 tevent_req_set_callback(subreq, skel_getxattrat_done, req);
1156 static void skel_getxattrat_done(struct tevent_req *subreq)
1158 struct tevent_req *req = tevent_req_callback_data(
1159 subreq, struct tevent_req);
1160 struct skel_getxattrat_state *state = tevent_req_data(
1161 req, struct skel_getxattrat_state);
1163 state->xattr_size = SMB_VFS_NEXT_GETXATTRAT_RECV(subreq,
1166 &state->xattr_value);
1167 TALLOC_FREE(subreq);
1168 if (state->xattr_size == -1) {
1169 tevent_req_error(req, state->aio_state.error);
1173 tevent_req_done(req);
1176 static ssize_t skel_getxattrat_recv(struct tevent_req *req,
1177 struct vfs_aio_state *aio_state,
1178 TALLOC_CTX *mem_ctx,
1179 uint8_t **xattr_value)
1181 struct skel_getxattrat_state *state = tevent_req_data(
1182 req, struct skel_getxattrat_state);
1185 if (tevent_req_is_unix_error(req, &aio_state->error)) {
1186 tevent_req_received(req);
1190 *aio_state = state->aio_state;
1191 xattr_size = state->xattr_size;
1192 if (xattr_value != NULL) {
1193 *xattr_value = talloc_move(mem_ctx, &state->xattr_value);
1196 tevent_req_received(req);
1200 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
1201 struct files_struct *fsp, const char *name,
1202 void *value, size_t size)
1204 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
1207 static ssize_t skel_listxattr(vfs_handle_struct *handle,
1208 const struct smb_filename *smb_fname,
1212 return SMB_VFS_NEXT_LISTXATTR(handle, smb_fname, list, size);
1215 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
1216 struct files_struct *fsp, char *list,
1219 return SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
1222 static int skel_removexattr(vfs_handle_struct *handle,
1223 const struct smb_filename *smb_fname,
1226 return SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname, name);
1229 static int skel_fremovexattr(vfs_handle_struct *handle,
1230 struct files_struct *fsp, const char *name)
1232 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
1235 static int skel_setxattr(vfs_handle_struct *handle,
1236 const struct smb_filename *smb_fname,
1242 return SMB_VFS_NEXT_SETXATTR(handle, smb_fname,
1243 name, value, size, flags);
1246 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
1247 const char *name, const void *value, size_t size,
1250 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value, size, flags);
1253 static bool skel_aio_force(struct vfs_handle_struct *handle,
1254 struct files_struct *fsp)
1256 return SMB_VFS_NEXT_AIO_FORCE(handle, fsp);
1259 static NTSTATUS skel_audit_file(struct vfs_handle_struct *handle,
1260 struct smb_filename *file,
1261 struct security_acl *sacl,
1262 uint32_t access_requested,
1263 uint32_t access_denied)
1265 return SMB_VFS_NEXT_AUDIT_FILE(handle,
1272 static NTSTATUS skel_durable_cookie(struct vfs_handle_struct *handle,
1273 struct files_struct *fsp,
1274 TALLOC_CTX *mem_ctx,
1277 return SMB_VFS_NEXT_DURABLE_COOKIE(handle,
1283 static NTSTATUS skel_durable_disconnect(struct vfs_handle_struct *handle,
1284 struct files_struct *fsp,
1285 const DATA_BLOB old_cookie,
1286 TALLOC_CTX *mem_ctx,
1287 DATA_BLOB *new_cookie)
1289 return SMB_VFS_NEXT_DURABLE_DISCONNECT(handle,
1296 static NTSTATUS skel_durable_reconnect(struct vfs_handle_struct *handle,
1297 struct smb_request *smb1req,
1298 struct smbXsrv_open *op,
1299 const DATA_BLOB old_cookie,
1300 TALLOC_CTX *mem_ctx,
1301 struct files_struct **fsp,
1302 DATA_BLOB *new_cookie)
1304 return SMB_VFS_NEXT_DURABLE_RECONNECT(handle,
1313 /* VFS operations structure */
1315 static struct vfs_fn_pointers skel_transparent_fns = {
1316 /* Disk operations */
1318 .connect_fn = skel_connect,
1319 .disconnect_fn = skel_disconnect,
1320 .disk_free_fn = skel_disk_free,
1321 .get_quota_fn = skel_get_quota,
1322 .set_quota_fn = skel_set_quota,
1323 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
1324 .statvfs_fn = skel_statvfs,
1325 .fs_capabilities_fn = skel_fs_capabilities,
1326 .get_dfs_referrals_fn = skel_get_dfs_referrals,
1327 .snap_check_path_fn = skel_snap_check_path,
1328 .snap_create_fn = skel_snap_create,
1329 .snap_delete_fn = skel_snap_delete,
1331 /* Directory operations */
1333 .opendir_fn = skel_opendir,
1334 .fdopendir_fn = skel_fdopendir,
1335 .readdir_fn = skel_readdir,
1336 .seekdir_fn = skel_seekdir,
1337 .telldir_fn = skel_telldir,
1338 .rewind_dir_fn = skel_rewind_dir,
1339 .mkdirat_fn = skel_mkdirat,
1340 .rmdir_fn = skel_rmdir,
1341 .closedir_fn = skel_closedir,
1343 /* File operations */
1345 .open_fn = skel_open,
1346 .create_file_fn = skel_create_file,
1347 .close_fn = skel_close_fn,
1348 .pread_fn = skel_pread,
1349 .pread_send_fn = skel_pread_send,
1350 .pread_recv_fn = skel_pread_recv,
1351 .pwrite_fn = skel_pwrite,
1352 .pwrite_send_fn = skel_pwrite_send,
1353 .pwrite_recv_fn = skel_pwrite_recv,
1354 .lseek_fn = skel_lseek,
1355 .sendfile_fn = skel_sendfile,
1356 .recvfile_fn = skel_recvfile,
1357 .renameat_fn = skel_renameat,
1358 .fsync_send_fn = skel_fsync_send,
1359 .fsync_recv_fn = skel_fsync_recv,
1360 .stat_fn = skel_stat,
1361 .fstat_fn = skel_fstat,
1362 .lstat_fn = skel_lstat,
1363 .get_alloc_size_fn = skel_get_alloc_size,
1364 .unlink_fn = skel_unlink,
1365 .chmod_fn = skel_chmod,
1366 .fchmod_fn = skel_fchmod,
1367 .chown_fn = skel_chown,
1368 .fchown_fn = skel_fchown,
1369 .lchown_fn = skel_lchown,
1370 .chdir_fn = skel_chdir,
1371 .getwd_fn = skel_getwd,
1372 .ntimes_fn = skel_ntimes,
1373 .ftruncate_fn = skel_ftruncate,
1374 .fallocate_fn = skel_fallocate,
1375 .lock_fn = skel_lock,
1376 .kernel_flock_fn = skel_kernel_flock,
1377 .linux_setlease_fn = skel_linux_setlease,
1378 .getlock_fn = skel_getlock,
1379 .symlinkat_fn = skel_symlinkat,
1380 .readlinkat_fn = skel_vfs_readlinkat,
1381 .linkat_fn = skel_linkat,
1382 .mknodat_fn = skel_mknodat,
1383 .realpath_fn = skel_realpath,
1384 .chflags_fn = skel_chflags,
1385 .file_id_create_fn = skel_file_id_create,
1386 .fs_file_id_fn = skel_fs_file_id,
1387 .offload_read_send_fn = skel_offload_read_send,
1388 .offload_read_recv_fn = skel_offload_read_recv,
1389 .offload_write_send_fn = skel_offload_write_send,
1390 .offload_write_recv_fn = skel_offload_write_recv,
1391 .get_compression_fn = skel_get_compression,
1392 .set_compression_fn = skel_set_compression,
1394 .streaminfo_fn = skel_streaminfo,
1395 .get_real_filename_fn = skel_get_real_filename,
1396 .connectpath_fn = skel_connectpath,
1397 .brl_lock_windows_fn = skel_brl_lock_windows,
1398 .brl_unlock_windows_fn = skel_brl_unlock_windows,
1399 .strict_lock_check_fn = skel_strict_lock_check,
1400 .translate_name_fn = skel_translate_name,
1401 .fsctl_fn = skel_fsctl,
1402 .readdir_attr_fn = skel_readdir_attr,
1403 .audit_file_fn = skel_audit_file,
1405 /* DOS attributes. */
1406 .get_dos_attributes_fn = skel_get_dos_attributes,
1407 .get_dos_attributes_send_fn = skel_get_dos_attributes_send,
1408 .get_dos_attributes_recv_fn = skel_get_dos_attributes_recv,
1409 .fget_dos_attributes_fn = skel_fget_dos_attributes,
1410 .set_dos_attributes_fn = skel_set_dos_attributes,
1411 .fset_dos_attributes_fn = skel_fset_dos_attributes,
1413 /* NT ACL operations. */
1415 .fget_nt_acl_fn = skel_fget_nt_acl,
1416 .get_nt_acl_fn = skel_get_nt_acl,
1417 .fset_nt_acl_fn = skel_fset_nt_acl,
1419 /* POSIX ACL operations. */
1421 .sys_acl_get_file_fn = skel_sys_acl_get_file,
1422 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
1423 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
1424 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
1425 .sys_acl_set_file_fn = skel_sys_acl_set_file,
1426 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
1427 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1429 /* EA operations. */
1430 .getxattr_fn = skel_getxattr,
1431 .getxattrat_send_fn = skel_getxattrat_send,
1432 .getxattrat_recv_fn = skel_getxattrat_recv,
1433 .fgetxattr_fn = skel_fgetxattr,
1434 .listxattr_fn = skel_listxattr,
1435 .flistxattr_fn = skel_flistxattr,
1436 .removexattr_fn = skel_removexattr,
1437 .fremovexattr_fn = skel_fremovexattr,
1438 .setxattr_fn = skel_setxattr,
1439 .fsetxattr_fn = skel_fsetxattr,
1441 /* aio operations */
1442 .aio_force_fn = skel_aio_force,
1444 /* durable handle operations */
1445 .durable_cookie_fn = skel_durable_cookie,
1446 .durable_disconnect_fn = skel_durable_disconnect,
1447 .durable_reconnect_fn = skel_durable_reconnect,
1451 NTSTATUS vfs_skel_transparent_init(TALLOC_CTX *ctx)
1454 * smb_vfs_assert_all_fns() is only needed in
1455 * order to have a complete example.
1457 * A transparent vfs module typically don't
1458 * need to implement every calls.
1460 smb_vfs_assert_all_fns(&skel_transparent_fns, "skel_transparent");
1461 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent",
1462 &skel_transparent_fns);