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_closedir(vfs_handle_struct *handle, DIR *dir)
180 return SMB_VFS_NEXT_CLOSEDIR(handle, dir);
183 static int skel_open(vfs_handle_struct *handle, struct smb_filename *smb_fname,
184 files_struct *fsp, int flags, mode_t mode)
186 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
189 static NTSTATUS skel_create_file(struct vfs_handle_struct *handle,
190 struct smb_request *req,
191 uint16_t root_dir_fid,
192 struct smb_filename *smb_fname,
193 uint32_t access_mask,
194 uint32_t share_access,
195 uint32_t create_disposition,
196 uint32_t create_options,
197 uint32_t file_attributes,
198 uint32_t oplock_request,
199 const struct smb2_lease *lease,
200 uint64_t allocation_size,
201 uint32_t private_flags,
202 struct security_descriptor *sd,
203 struct ea_list *ea_list,
204 files_struct ** result, int *pinfo,
205 const struct smb2_create_blobs *in_context_blobs,
206 struct smb2_create_blobs *out_context_blobs)
208 return SMB_VFS_NEXT_CREATE_FILE(handle,
221 sd, ea_list, result, pinfo,
222 in_context_blobs, out_context_blobs);
225 static int skel_close_fn(vfs_handle_struct *handle, files_struct *fsp)
227 return SMB_VFS_NEXT_CLOSE(handle, fsp);
230 static ssize_t skel_pread(vfs_handle_struct *handle, files_struct *fsp,
231 void *data, size_t n, off_t offset)
233 return SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
236 struct skel_pread_state {
238 struct vfs_aio_state vfs_aio_state;
241 static void skel_pread_done(struct tevent_req *subreq);
243 static struct tevent_req *skel_pread_send(struct vfs_handle_struct *handle,
245 struct tevent_context *ev,
246 struct files_struct *fsp,
247 void *data, size_t n, off_t offset)
249 struct tevent_req *req, *subreq;
250 struct skel_pread_state *state;
252 req = tevent_req_create(mem_ctx, &state, struct skel_pread_state);
256 subreq = SMB_VFS_NEXT_PREAD_SEND(state, ev, handle, fsp, data,
258 if (tevent_req_nomem(subreq, req)) {
259 return tevent_req_post(req, ev);
261 tevent_req_set_callback(subreq, skel_pread_done, req);
265 static void skel_pread_done(struct tevent_req *subreq)
267 struct tevent_req *req =
268 tevent_req_callback_data(subreq, struct tevent_req);
269 struct skel_pread_state *state =
270 tevent_req_data(req, struct skel_pread_state);
272 state->ret = SMB_VFS_PREAD_RECV(subreq, &state->vfs_aio_state);
274 tevent_req_done(req);
277 static ssize_t skel_pread_recv(struct tevent_req *req,
278 struct vfs_aio_state *vfs_aio_state)
280 struct skel_pread_state *state =
281 tevent_req_data(req, struct skel_pread_state);
283 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
286 *vfs_aio_state = state->vfs_aio_state;
290 static ssize_t skel_pwrite(vfs_handle_struct *handle, files_struct *fsp,
291 const void *data, size_t n, off_t offset)
293 return SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
296 struct skel_pwrite_state {
298 struct vfs_aio_state vfs_aio_state;
301 static void skel_pwrite_done(struct tevent_req *subreq);
303 static struct tevent_req *skel_pwrite_send(struct vfs_handle_struct *handle,
305 struct tevent_context *ev,
306 struct files_struct *fsp,
308 size_t n, off_t offset)
310 struct tevent_req *req, *subreq;
311 struct skel_pwrite_state *state;
313 req = tevent_req_create(mem_ctx, &state, struct skel_pwrite_state);
317 subreq = SMB_VFS_NEXT_PWRITE_SEND(state, ev, handle, fsp, data,
319 if (tevent_req_nomem(subreq, req)) {
320 return tevent_req_post(req, ev);
322 tevent_req_set_callback(subreq, skel_pwrite_done, req);
326 static void skel_pwrite_done(struct tevent_req *subreq)
328 struct tevent_req *req =
329 tevent_req_callback_data(subreq, struct tevent_req);
330 struct skel_pwrite_state *state =
331 tevent_req_data(req, struct skel_pwrite_state);
333 state->ret = SMB_VFS_PWRITE_RECV(subreq, &state->vfs_aio_state);
335 tevent_req_done(req);
338 static ssize_t skel_pwrite_recv(struct tevent_req *req,
339 struct vfs_aio_state *vfs_aio_state)
341 struct skel_pwrite_state *state =
342 tevent_req_data(req, struct skel_pwrite_state);
344 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
347 *vfs_aio_state = state->vfs_aio_state;
351 static off_t skel_lseek(vfs_handle_struct *handle, files_struct *fsp,
352 off_t offset, int whence)
354 return SMB_VFS_NEXT_LSEEK(handle, fsp, offset, whence);
357 static ssize_t skel_sendfile(vfs_handle_struct *handle, int tofd,
358 files_struct *fromfsp, const DATA_BLOB *hdr,
359 off_t offset, size_t n)
361 return SMB_VFS_NEXT_SENDFILE(handle, tofd, fromfsp, hdr, offset, n);
364 static ssize_t skel_recvfile(vfs_handle_struct *handle, int fromfd,
365 files_struct *tofsp, off_t offset, size_t n)
367 return SMB_VFS_NEXT_RECVFILE(handle, fromfd, tofsp, offset, n);
370 static int skel_renameat(vfs_handle_struct *handle,
371 files_struct *srcfsp,
372 const struct smb_filename *smb_fname_src,
373 files_struct *dstfsp,
374 const struct smb_filename *smb_fname_dst)
376 return SMB_VFS_NEXT_RENAMEAT(handle,
383 struct skel_fsync_state {
385 struct vfs_aio_state vfs_aio_state;
388 static void skel_fsync_done(struct tevent_req *subreq);
390 static struct tevent_req *skel_fsync_send(struct vfs_handle_struct *handle,
392 struct tevent_context *ev,
393 struct files_struct *fsp)
395 struct tevent_req *req, *subreq;
396 struct skel_fsync_state *state;
398 req = tevent_req_create(mem_ctx, &state, struct skel_fsync_state);
402 subreq = SMB_VFS_NEXT_FSYNC_SEND(state, ev, handle, fsp);
403 if (tevent_req_nomem(subreq, req)) {
404 return tevent_req_post(req, ev);
406 tevent_req_set_callback(subreq, skel_fsync_done, req);
410 static void skel_fsync_done(struct tevent_req *subreq)
412 struct tevent_req *req =
413 tevent_req_callback_data(subreq, struct tevent_req);
414 struct skel_fsync_state *state =
415 tevent_req_data(req, struct skel_fsync_state);
417 state->ret = SMB_VFS_FSYNC_RECV(subreq, &state->vfs_aio_state);
419 tevent_req_done(req);
422 static int skel_fsync_recv(struct tevent_req *req,
423 struct vfs_aio_state *vfs_aio_state)
425 struct skel_fsync_state *state =
426 tevent_req_data(req, struct skel_fsync_state);
428 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
431 *vfs_aio_state = state->vfs_aio_state;
435 static int skel_stat(vfs_handle_struct *handle, struct smb_filename *smb_fname)
437 return SMB_VFS_NEXT_STAT(handle, smb_fname);
440 static int skel_fstat(vfs_handle_struct *handle, files_struct *fsp,
441 SMB_STRUCT_STAT *sbuf)
443 return SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
446 static int skel_lstat(vfs_handle_struct *handle,
447 struct smb_filename *smb_fname)
449 return SMB_VFS_NEXT_LSTAT(handle, smb_fname);
452 static uint64_t skel_get_alloc_size(struct vfs_handle_struct *handle,
453 struct files_struct *fsp,
454 const SMB_STRUCT_STAT *sbuf)
456 return SMB_VFS_NEXT_GET_ALLOC_SIZE(handle, fsp, sbuf);
459 static int skel_unlinkat(vfs_handle_struct *handle,
460 struct files_struct *dirfsp,
461 const struct smb_filename *smb_fname,
464 return SMB_VFS_NEXT_UNLINKAT(handle,
470 static int skel_chmod(vfs_handle_struct *handle,
471 const struct smb_filename *smb_fname,
474 return SMB_VFS_NEXT_CHMOD(handle, smb_fname, mode);
477 static int skel_fchmod(vfs_handle_struct *handle, files_struct *fsp,
480 return SMB_VFS_NEXT_FCHMOD(handle, fsp, mode);
483 static int skel_fchown(vfs_handle_struct *handle, files_struct *fsp,
484 uid_t uid, gid_t gid)
486 return SMB_VFS_NEXT_FCHOWN(handle, fsp, uid, gid);
489 static int skel_lchown(vfs_handle_struct *handle,
490 const struct smb_filename *smb_fname,
494 return SMB_VFS_NEXT_LCHOWN(handle, smb_fname, uid, gid);
497 static int skel_chdir(vfs_handle_struct *handle,
498 const struct smb_filename *smb_fname)
500 return SMB_VFS_NEXT_CHDIR(handle, smb_fname);
503 static struct smb_filename *skel_getwd(vfs_handle_struct *handle,
506 return SMB_VFS_NEXT_GETWD(handle, ctx);
509 static int skel_ntimes(vfs_handle_struct *handle,
510 const struct smb_filename *smb_fname,
511 struct smb_file_time *ft)
513 return SMB_VFS_NEXT_NTIMES(handle, smb_fname, ft);
516 static int skel_ftruncate(vfs_handle_struct *handle, files_struct *fsp,
519 return SMB_VFS_NEXT_FTRUNCATE(handle, fsp, offset);
522 static int skel_fallocate(vfs_handle_struct *handle, files_struct *fsp,
523 uint32_t mode, off_t offset, off_t len)
525 return SMB_VFS_NEXT_FALLOCATE(handle, fsp, mode, offset, len);
528 static bool skel_lock(vfs_handle_struct *handle, files_struct *fsp, int op,
529 off_t offset, off_t count, int type)
531 return SMB_VFS_NEXT_LOCK(handle, fsp, op, offset, count, type);
534 static int skel_kernel_flock(struct vfs_handle_struct *handle,
535 struct files_struct *fsp, uint32_t share_mode,
536 uint32_t access_mask)
538 return SMB_VFS_NEXT_KERNEL_FLOCK(handle, fsp, share_mode, access_mask);
541 static int skel_fcntl(struct vfs_handle_struct *handle,
542 struct files_struct *fsp, int cmd, va_list cmd_arg)
548 va_copy(dup_cmd_arg, cmd_arg);
549 arg = va_arg(dup_cmd_arg, void *);
550 result = SMB_VFS_NEXT_FCNTL(handle, fsp, cmd, arg);
556 static int skel_linux_setlease(struct vfs_handle_struct *handle,
557 struct files_struct *fsp, int leasetype)
559 return SMB_VFS_NEXT_LINUX_SETLEASE(handle, fsp, leasetype);
562 static bool skel_getlock(vfs_handle_struct *handle, files_struct *fsp,
563 off_t *poffset, off_t *pcount, int *ptype,
566 return SMB_VFS_NEXT_GETLOCK(handle, fsp, poffset, pcount, ptype, ppid);
569 static int skel_symlinkat(vfs_handle_struct *handle,
570 const char *link_contents,
571 struct files_struct *dirfsp,
572 const struct smb_filename *new_smb_fname)
574 return SMB_VFS_NEXT_SYMLINKAT(handle,
580 static int skel_vfs_readlinkat(vfs_handle_struct *handle,
581 files_struct *dirfsp,
582 const struct smb_filename *smb_fname,
586 return SMB_VFS_NEXT_READLINKAT(handle,
593 static int skel_linkat(vfs_handle_struct *handle,
594 files_struct *srcfsp,
595 const struct smb_filename *old_smb_fname,
596 files_struct *dstfsp,
597 const struct smb_filename *new_smb_fname,
600 return SMB_VFS_NEXT_LINKAT(handle,
608 static int skel_mknodat(vfs_handle_struct *handle,
609 files_struct *dirfsp,
610 const struct smb_filename *smb_fname,
614 return SMB_VFS_NEXT_MKNODAT(handle,
621 static struct smb_filename *skel_realpath(vfs_handle_struct *handle,
623 const struct smb_filename *smb_fname)
625 return SMB_VFS_NEXT_REALPATH(handle, ctx, smb_fname);
628 static int skel_chflags(vfs_handle_struct *handle,
629 const struct smb_filename *smb_fname,
632 return SMB_VFS_NEXT_CHFLAGS(handle, smb_fname, flags);
635 static struct file_id skel_file_id_create(vfs_handle_struct *handle,
636 const SMB_STRUCT_STAT *sbuf)
638 return SMB_VFS_NEXT_FILE_ID_CREATE(handle, sbuf);
641 static uint64_t skel_fs_file_id(vfs_handle_struct *handle,
642 const SMB_STRUCT_STAT *sbuf)
644 return SMB_VFS_NEXT_FS_FILE_ID(handle, sbuf);
647 struct skel_offload_read_state {
648 struct vfs_handle_struct *handle;
652 static void skel_offload_read_done(struct tevent_req *subreq);
654 static struct tevent_req *skel_offload_read_send(
656 struct tevent_context *ev,
657 struct vfs_handle_struct *handle,
658 struct files_struct *fsp,
664 struct tevent_req *req = NULL;
665 struct skel_offload_read_state *state = NULL;
666 struct tevent_req *subreq = NULL;
668 req = tevent_req_create(mem_ctx, &state, struct skel_offload_read_state);
672 *state = (struct skel_offload_read_state) {
676 subreq = SMB_VFS_NEXT_OFFLOAD_READ_SEND(mem_ctx, ev, handle, fsp,
677 fsctl, ttl, offset, to_copy);
678 if (tevent_req_nomem(subreq, req)) {
679 return tevent_req_post(req, ev);
681 tevent_req_set_callback(subreq, skel_offload_read_done, req);
685 static void skel_offload_read_done(struct tevent_req *subreq)
687 struct tevent_req *req = tevent_req_callback_data(
688 subreq, struct tevent_req);
689 struct skel_offload_read_state *state = tevent_req_data(
690 req, struct skel_offload_read_state);
693 status = SMB_VFS_NEXT_OFFLOAD_READ_RECV(subreq,
698 if (tevent_req_nterror(req, status)) {
702 tevent_req_done(req);
706 static NTSTATUS skel_offload_read_recv(struct tevent_req *req,
707 struct vfs_handle_struct *handle,
711 struct skel_offload_read_state *state = tevent_req_data(
712 req, struct skel_offload_read_state);
716 if (tevent_req_is_nterror(req, &status)) {
717 tevent_req_received(req);
721 token = data_blob_talloc(mem_ctx,
723 state->token.length);
725 tevent_req_received(req);
727 if (token.data == NULL) {
728 return NT_STATUS_NO_MEMORY;
735 struct skel_offload_write_state {
736 struct vfs_handle_struct *handle;
739 static void skel_offload_write_done(struct tevent_req *subreq);
741 static struct tevent_req *skel_offload_write_send(struct vfs_handle_struct *handle,
743 struct tevent_context *ev,
746 off_t transfer_offset,
747 struct files_struct *dest_fsp,
751 struct tevent_req *req;
752 struct tevent_req *subreq;
753 struct skel_offload_write_state *state;
755 req = tevent_req_create(mem_ctx, &state, struct skel_offload_write_state);
760 state->handle = handle;
761 subreq = SMB_VFS_NEXT_OFFLOAD_WRITE_SEND(handle, state, ev,
762 fsctl, token, transfer_offset,
763 dest_fsp, dest_off, num);
764 if (tevent_req_nomem(subreq, req)) {
765 return tevent_req_post(req, ev);
768 tevent_req_set_callback(subreq, skel_offload_write_done, req);
772 static void skel_offload_write_done(struct tevent_req *subreq)
774 struct tevent_req *req = tevent_req_callback_data(
775 subreq, struct tevent_req);
776 struct skel_offload_write_state *state
777 = tevent_req_data(req, struct skel_offload_write_state);
780 status = SMB_VFS_NEXT_OFFLOAD_WRITE_RECV(state->handle,
784 if (tevent_req_nterror(req, status)) {
787 tevent_req_done(req);
790 static NTSTATUS skel_offload_write_recv(struct vfs_handle_struct *handle,
791 struct tevent_req *req,
794 struct skel_offload_write_state *state
795 = tevent_req_data(req, struct skel_offload_write_state);
798 *copied = state->copied;
799 if (tevent_req_is_nterror(req, &status)) {
800 tevent_req_received(req);
804 tevent_req_received(req);
808 static NTSTATUS skel_get_compression(struct vfs_handle_struct *handle,
810 struct files_struct *fsp,
811 struct smb_filename *smb_fname,
812 uint16_t *_compression_fmt)
814 return SMB_VFS_NEXT_GET_COMPRESSION(handle, mem_ctx, fsp, smb_fname,
818 static NTSTATUS skel_set_compression(struct vfs_handle_struct *handle,
820 struct files_struct *fsp,
821 uint16_t compression_fmt)
823 return SMB_VFS_NEXT_SET_COMPRESSION(handle, mem_ctx, fsp,
827 static NTSTATUS skel_streaminfo(struct vfs_handle_struct *handle,
828 struct files_struct *fsp,
829 const struct smb_filename *smb_fname,
831 unsigned int *num_streams,
832 struct stream_struct **streams)
834 return SMB_VFS_NEXT_STREAMINFO(handle,
842 static int skel_get_real_filename(struct vfs_handle_struct *handle,
845 TALLOC_CTX *mem_ctx, char **found_name)
847 return SMB_VFS_NEXT_GET_REAL_FILENAME(handle,
848 path, name, mem_ctx, found_name);
851 static const char *skel_connectpath(struct vfs_handle_struct *handle,
852 const struct smb_filename *smb_fname)
854 return SMB_VFS_NEXT_CONNECTPATH(handle, smb_fname);
857 static NTSTATUS skel_brl_lock_windows(struct vfs_handle_struct *handle,
858 struct byte_range_lock *br_lck,
859 struct lock_struct *plock)
861 return SMB_VFS_NEXT_BRL_LOCK_WINDOWS(handle, br_lck, plock);
864 static bool skel_brl_unlock_windows(struct vfs_handle_struct *handle,
865 struct byte_range_lock *br_lck,
866 const struct lock_struct *plock)
868 return SMB_VFS_NEXT_BRL_UNLOCK_WINDOWS(handle, br_lck, plock);
871 static bool skel_strict_lock_check(struct vfs_handle_struct *handle,
872 struct files_struct *fsp,
873 struct lock_struct *plock)
875 return SMB_VFS_NEXT_STRICT_LOCK_CHECK(handle, fsp, plock);
878 static NTSTATUS skel_translate_name(struct vfs_handle_struct *handle,
879 const char *mapped_name,
880 enum vfs_translate_direction direction,
881 TALLOC_CTX *mem_ctx, char **pmapped_name)
883 return SMB_VFS_NEXT_TRANSLATE_NAME(handle, mapped_name, direction,
884 mem_ctx, pmapped_name);
887 static NTSTATUS skel_fsctl(struct vfs_handle_struct *handle,
888 struct files_struct *fsp,
891 uint16_t req_flags, /* Needed for UNICODE ... */
892 const uint8_t *_in_data,
894 uint8_t ** _out_data,
895 uint32_t max_out_len, uint32_t *out_len)
897 return SMB_VFS_NEXT_FSCTL(handle,
903 in_len, _out_data, max_out_len, out_len);
906 static NTSTATUS skel_readdir_attr(struct vfs_handle_struct *handle,
907 const struct smb_filename *fname,
909 struct readdir_attr_data **pattr_data)
911 return SMB_VFS_NEXT_READDIR_ATTR(handle, fname, mem_ctx, pattr_data);
914 static NTSTATUS skel_get_dos_attributes(struct vfs_handle_struct *handle,
915 struct smb_filename *smb_fname,
918 return SMB_VFS_NEXT_GET_DOS_ATTRIBUTES(handle,
923 struct skel_get_dos_attributes_state {
924 struct vfs_aio_state aio_state;
928 static void skel_get_dos_attributes_done(struct tevent_req *subreq);
930 static struct tevent_req *skel_get_dos_attributes_send(
932 struct tevent_context *ev,
933 struct vfs_handle_struct *handle,
934 files_struct *dir_fsp,
935 struct smb_filename *smb_fname)
937 struct tevent_req *req = NULL;
938 struct skel_get_dos_attributes_state *state = NULL;
939 struct tevent_req *subreq = NULL;
941 req = tevent_req_create(mem_ctx, &state,
942 struct skel_get_dos_attributes_state);
947 subreq = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_SEND(mem_ctx,
952 if (tevent_req_nomem(subreq, req)) {
953 return tevent_req_post(req, ev);
955 tevent_req_set_callback(subreq, skel_get_dos_attributes_done, req);
960 static void skel_get_dos_attributes_done(struct tevent_req *subreq)
962 struct tevent_req *req =
963 tevent_req_callback_data(subreq,
965 struct skel_get_dos_attributes_state *state =
967 struct skel_get_dos_attributes_state);
970 status = SMB_VFS_NEXT_GET_DOS_ATTRIBUTES_RECV(subreq,
974 if (tevent_req_nterror(req, status)) {
978 tevent_req_done(req);
982 static NTSTATUS skel_get_dos_attributes_recv(struct tevent_req *req,
983 struct vfs_aio_state *aio_state,
986 struct skel_get_dos_attributes_state *state =
988 struct skel_get_dos_attributes_state);
991 if (tevent_req_is_nterror(req, &status)) {
992 tevent_req_received(req);
996 *aio_state = state->aio_state;
997 *dosmode = state->dosmode;
998 tevent_req_received(req);
1002 static NTSTATUS skel_fget_dos_attributes(struct vfs_handle_struct *handle,
1003 struct files_struct *fsp,
1006 return SMB_VFS_NEXT_FGET_DOS_ATTRIBUTES(handle,
1011 static NTSTATUS skel_set_dos_attributes(struct vfs_handle_struct *handle,
1012 const struct smb_filename *smb_fname,
1015 return SMB_VFS_NEXT_SET_DOS_ATTRIBUTES(handle,
1020 static NTSTATUS skel_fset_dos_attributes(struct vfs_handle_struct *handle,
1021 struct files_struct *fsp,
1024 return SMB_VFS_NEXT_FSET_DOS_ATTRIBUTES(handle,
1029 static NTSTATUS skel_fget_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
1030 uint32_t security_info,
1031 TALLOC_CTX *mem_ctx,
1032 struct security_descriptor **ppdesc)
1034 return SMB_VFS_NEXT_FGET_NT_ACL(handle, fsp, security_info, mem_ctx,
1038 static NTSTATUS skel_get_nt_acl(vfs_handle_struct *handle,
1039 const struct smb_filename *smb_fname,
1040 uint32_t security_info,
1041 TALLOC_CTX *mem_ctx,
1042 struct security_descriptor **ppdesc)
1044 return SMB_VFS_NEXT_GET_NT_ACL(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_file(vfs_handle_struct *handle,
1091 const struct smb_filename *smb_fname,
1092 SMB_ACL_TYPE_T acltype,
1095 return SMB_VFS_NEXT_SYS_ACL_SET_FILE(handle, smb_fname,
1099 static int skel_sys_acl_set_fd(vfs_handle_struct *handle, files_struct *fsp,
1102 return SMB_VFS_NEXT_SYS_ACL_SET_FD(handle, fsp, theacl);
1105 static int skel_sys_acl_delete_def_file(vfs_handle_struct *handle,
1106 const struct smb_filename *smb_fname)
1108 return SMB_VFS_NEXT_SYS_ACL_DELETE_DEF_FILE(handle, smb_fname);
1111 static ssize_t skel_getxattr(vfs_handle_struct *handle,
1112 const struct smb_filename *smb_fname,
1117 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname, name, value, size);
1120 struct skel_getxattrat_state {
1121 struct vfs_aio_state aio_state;
1123 uint8_t *xattr_value;
1126 static void skel_getxattrat_done(struct tevent_req *subreq);
1128 static struct tevent_req *skel_getxattrat_send(
1129 TALLOC_CTX *mem_ctx,
1130 struct tevent_context *ev,
1131 struct vfs_handle_struct *handle,
1132 files_struct *dir_fsp,
1133 const struct smb_filename *smb_fname,
1134 const char *xattr_name,
1137 struct tevent_req *req = NULL;
1138 struct skel_getxattrat_state *state = NULL;
1139 struct tevent_req *subreq = NULL;
1141 req = tevent_req_create(mem_ctx, &state,
1142 struct skel_getxattrat_state);
1147 subreq = SMB_VFS_NEXT_GETXATTRAT_SEND(state,
1154 if (tevent_req_nomem(subreq, req)) {
1155 return tevent_req_post(req, ev);
1157 tevent_req_set_callback(subreq, skel_getxattrat_done, req);
1162 static void skel_getxattrat_done(struct tevent_req *subreq)
1164 struct tevent_req *req = tevent_req_callback_data(
1165 subreq, struct tevent_req);
1166 struct skel_getxattrat_state *state = tevent_req_data(
1167 req, struct skel_getxattrat_state);
1169 state->xattr_size = SMB_VFS_NEXT_GETXATTRAT_RECV(subreq,
1172 &state->xattr_value);
1173 TALLOC_FREE(subreq);
1174 if (state->xattr_size == -1) {
1175 tevent_req_error(req, state->aio_state.error);
1179 tevent_req_done(req);
1182 static ssize_t skel_getxattrat_recv(struct tevent_req *req,
1183 struct vfs_aio_state *aio_state,
1184 TALLOC_CTX *mem_ctx,
1185 uint8_t **xattr_value)
1187 struct skel_getxattrat_state *state = tevent_req_data(
1188 req, struct skel_getxattrat_state);
1191 if (tevent_req_is_unix_error(req, &aio_state->error)) {
1192 tevent_req_received(req);
1196 *aio_state = state->aio_state;
1197 xattr_size = state->xattr_size;
1198 if (xattr_value != NULL) {
1199 *xattr_value = talloc_move(mem_ctx, &state->xattr_value);
1202 tevent_req_received(req);
1206 static ssize_t skel_fgetxattr(vfs_handle_struct *handle,
1207 struct files_struct *fsp, const char *name,
1208 void *value, size_t size)
1210 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
1213 static ssize_t skel_listxattr(vfs_handle_struct *handle,
1214 const struct smb_filename *smb_fname,
1218 return SMB_VFS_NEXT_LISTXATTR(handle, smb_fname, list, size);
1221 static ssize_t skel_flistxattr(vfs_handle_struct *handle,
1222 struct files_struct *fsp, char *list,
1225 return SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
1228 static int skel_removexattr(vfs_handle_struct *handle,
1229 const struct smb_filename *smb_fname,
1232 return SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname, name);
1235 static int skel_fremovexattr(vfs_handle_struct *handle,
1236 struct files_struct *fsp, const char *name)
1238 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
1241 static int skel_setxattr(vfs_handle_struct *handle,
1242 const struct smb_filename *smb_fname,
1248 return SMB_VFS_NEXT_SETXATTR(handle, smb_fname,
1249 name, value, size, flags);
1252 static int skel_fsetxattr(vfs_handle_struct *handle, struct files_struct *fsp,
1253 const char *name, const void *value, size_t size,
1256 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value, size, flags);
1259 static bool skel_aio_force(struct vfs_handle_struct *handle,
1260 struct files_struct *fsp)
1262 return SMB_VFS_NEXT_AIO_FORCE(handle, fsp);
1265 static NTSTATUS skel_audit_file(struct vfs_handle_struct *handle,
1266 struct smb_filename *file,
1267 struct security_acl *sacl,
1268 uint32_t access_requested,
1269 uint32_t access_denied)
1271 return SMB_VFS_NEXT_AUDIT_FILE(handle,
1278 static NTSTATUS skel_durable_cookie(struct vfs_handle_struct *handle,
1279 struct files_struct *fsp,
1280 TALLOC_CTX *mem_ctx,
1283 return SMB_VFS_NEXT_DURABLE_COOKIE(handle,
1289 static NTSTATUS skel_durable_disconnect(struct vfs_handle_struct *handle,
1290 struct files_struct *fsp,
1291 const DATA_BLOB old_cookie,
1292 TALLOC_CTX *mem_ctx,
1293 DATA_BLOB *new_cookie)
1295 return SMB_VFS_NEXT_DURABLE_DISCONNECT(handle,
1302 static NTSTATUS skel_durable_reconnect(struct vfs_handle_struct *handle,
1303 struct smb_request *smb1req,
1304 struct smbXsrv_open *op,
1305 const DATA_BLOB old_cookie,
1306 TALLOC_CTX *mem_ctx,
1307 struct files_struct **fsp,
1308 DATA_BLOB *new_cookie)
1310 return SMB_VFS_NEXT_DURABLE_RECONNECT(handle,
1319 /* VFS operations structure */
1321 static struct vfs_fn_pointers skel_transparent_fns = {
1322 /* Disk operations */
1324 .connect_fn = skel_connect,
1325 .disconnect_fn = skel_disconnect,
1326 .disk_free_fn = skel_disk_free,
1327 .get_quota_fn = skel_get_quota,
1328 .set_quota_fn = skel_set_quota,
1329 .get_shadow_copy_data_fn = skel_get_shadow_copy_data,
1330 .statvfs_fn = skel_statvfs,
1331 .fs_capabilities_fn = skel_fs_capabilities,
1332 .get_dfs_referrals_fn = skel_get_dfs_referrals,
1333 .snap_check_path_fn = skel_snap_check_path,
1334 .snap_create_fn = skel_snap_create,
1335 .snap_delete_fn = skel_snap_delete,
1337 /* Directory operations */
1339 .opendir_fn = skel_opendir,
1340 .fdopendir_fn = skel_fdopendir,
1341 .readdir_fn = skel_readdir,
1342 .seekdir_fn = skel_seekdir,
1343 .telldir_fn = skel_telldir,
1344 .rewind_dir_fn = skel_rewind_dir,
1345 .mkdirat_fn = skel_mkdirat,
1346 .closedir_fn = skel_closedir,
1348 /* File operations */
1350 .open_fn = skel_open,
1351 .create_file_fn = skel_create_file,
1352 .close_fn = skel_close_fn,
1353 .pread_fn = skel_pread,
1354 .pread_send_fn = skel_pread_send,
1355 .pread_recv_fn = skel_pread_recv,
1356 .pwrite_fn = skel_pwrite,
1357 .pwrite_send_fn = skel_pwrite_send,
1358 .pwrite_recv_fn = skel_pwrite_recv,
1359 .lseek_fn = skel_lseek,
1360 .sendfile_fn = skel_sendfile,
1361 .recvfile_fn = skel_recvfile,
1362 .renameat_fn = skel_renameat,
1363 .fsync_send_fn = skel_fsync_send,
1364 .fsync_recv_fn = skel_fsync_recv,
1365 .stat_fn = skel_stat,
1366 .fstat_fn = skel_fstat,
1367 .lstat_fn = skel_lstat,
1368 .get_alloc_size_fn = skel_get_alloc_size,
1369 .unlinkat_fn = skel_unlinkat,
1370 .chmod_fn = skel_chmod,
1371 .fchmod_fn = skel_fchmod,
1372 .fchown_fn = skel_fchown,
1373 .lchown_fn = skel_lchown,
1374 .chdir_fn = skel_chdir,
1375 .getwd_fn = skel_getwd,
1376 .ntimes_fn = skel_ntimes,
1377 .ftruncate_fn = skel_ftruncate,
1378 .fallocate_fn = skel_fallocate,
1379 .lock_fn = skel_lock,
1380 .kernel_flock_fn = skel_kernel_flock,
1381 .fcntl_fn = skel_fcntl,
1382 .linux_setlease_fn = skel_linux_setlease,
1383 .getlock_fn = skel_getlock,
1384 .symlinkat_fn = skel_symlinkat,
1385 .readlinkat_fn = skel_vfs_readlinkat,
1386 .linkat_fn = skel_linkat,
1387 .mknodat_fn = skel_mknodat,
1388 .realpath_fn = skel_realpath,
1389 .chflags_fn = skel_chflags,
1390 .file_id_create_fn = skel_file_id_create,
1391 .fs_file_id_fn = skel_fs_file_id,
1392 .offload_read_send_fn = skel_offload_read_send,
1393 .offload_read_recv_fn = skel_offload_read_recv,
1394 .offload_write_send_fn = skel_offload_write_send,
1395 .offload_write_recv_fn = skel_offload_write_recv,
1396 .get_compression_fn = skel_get_compression,
1397 .set_compression_fn = skel_set_compression,
1399 .streaminfo_fn = skel_streaminfo,
1400 .get_real_filename_fn = skel_get_real_filename,
1401 .connectpath_fn = skel_connectpath,
1402 .brl_lock_windows_fn = skel_brl_lock_windows,
1403 .brl_unlock_windows_fn = skel_brl_unlock_windows,
1404 .strict_lock_check_fn = skel_strict_lock_check,
1405 .translate_name_fn = skel_translate_name,
1406 .fsctl_fn = skel_fsctl,
1407 .readdir_attr_fn = skel_readdir_attr,
1408 .audit_file_fn = skel_audit_file,
1410 /* DOS attributes. */
1411 .get_dos_attributes_fn = skel_get_dos_attributes,
1412 .get_dos_attributes_send_fn = skel_get_dos_attributes_send,
1413 .get_dos_attributes_recv_fn = skel_get_dos_attributes_recv,
1414 .fget_dos_attributes_fn = skel_fget_dos_attributes,
1415 .set_dos_attributes_fn = skel_set_dos_attributes,
1416 .fset_dos_attributes_fn = skel_fset_dos_attributes,
1418 /* NT ACL operations. */
1420 .fget_nt_acl_fn = skel_fget_nt_acl,
1421 .get_nt_acl_fn = skel_get_nt_acl,
1422 .fset_nt_acl_fn = skel_fset_nt_acl,
1424 /* POSIX ACL operations. */
1426 .sys_acl_get_file_fn = skel_sys_acl_get_file,
1427 .sys_acl_get_fd_fn = skel_sys_acl_get_fd,
1428 .sys_acl_blob_get_file_fn = skel_sys_acl_blob_get_file,
1429 .sys_acl_blob_get_fd_fn = skel_sys_acl_blob_get_fd,
1430 .sys_acl_set_file_fn = skel_sys_acl_set_file,
1431 .sys_acl_set_fd_fn = skel_sys_acl_set_fd,
1432 .sys_acl_delete_def_file_fn = skel_sys_acl_delete_def_file,
1434 /* EA operations. */
1435 .getxattr_fn = skel_getxattr,
1436 .getxattrat_send_fn = skel_getxattrat_send,
1437 .getxattrat_recv_fn = skel_getxattrat_recv,
1438 .fgetxattr_fn = skel_fgetxattr,
1439 .listxattr_fn = skel_listxattr,
1440 .flistxattr_fn = skel_flistxattr,
1441 .removexattr_fn = skel_removexattr,
1442 .fremovexattr_fn = skel_fremovexattr,
1443 .setxattr_fn = skel_setxattr,
1444 .fsetxattr_fn = skel_fsetxattr,
1446 /* aio operations */
1447 .aio_force_fn = skel_aio_force,
1449 /* durable handle operations */
1450 .durable_cookie_fn = skel_durable_cookie,
1451 .durable_disconnect_fn = skel_durable_disconnect,
1452 .durable_reconnect_fn = skel_durable_reconnect,
1456 NTSTATUS vfs_skel_transparent_init(TALLOC_CTX *ctx)
1459 * smb_vfs_assert_all_fns() is only needed in
1460 * order to have a complete example.
1462 * A transparent vfs module typically don't
1463 * need to implement every calls.
1465 smb_vfs_assert_all_fns(&skel_transparent_fns, "skel_transparent");
1466 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "skel_transparent",
1467 &skel_transparent_fns);