s3: VFS: Modify SMB_VFS_GET_NT_ACL to take a const struct smb_filename * instead...
[sfrench/samba-autobuild/.git] / source3 / include / vfs.h
index b10e9a54bee10f04e9170df033b536a888fb2789..d416a5b1e9579ac59b44256d817953d2a427abc2 100644 (file)
 /* Version 32 - Add "lease" to CREATE_FILE operation */
 /* Version 32 - Add "lease" to struct files_struct */
 /* Version 32 - Add SMB_VFS_READDIR_ATTR() */
-
-#define SMB_VFS_INTERFACE_VERSION 32
+/* Version 32 - Add in and out create context blobs to create_file */
+/* Version 32 - Remove unnecessary SMB_VFS_DISK_FREE() small_query parameter */
+/* Bump to version 33 - Samba 4.3 will ship with that. */
+/* Version 33 - change fallocate mode flags param from enum->uint32_t */
+/* Version 33 - Add snapshot create/delete calls */
+/* Version 33 - Add OS X SMB2 AAPL copyfile extension flag to fsp */
+/* Version 33 - Remove notify_watch_fn */
+/* Bump to version 34 - Samba 4.4 will ship with that */
+/* Version 34 - Remove bool posix_open, add uint64_t posix_flags */
+/* Version 34 - Added bool posix_pathnames to struct smb_request */
+/* Bump to version 35 - Samba 4.5 will ship with that */
+/* Version 35 - Change get_nt_acl_fn from const char *, to
+               const struct smb_filename * */
+
+#define SMB_VFS_INTERFACE_VERSION 35
 
 /*
     All intercepted VFS operations must be declared as static functions inside module source
@@ -193,7 +206,7 @@ struct fd_handle {
        int fd;
        uint64_t position_information;
        off_t pos;
-       uint32 private_options; /* NT Create options, but we only look at
+       uint32_t private_options;       /* NT Create options, but we only look at
                                 * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
                                 * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
                                 * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
@@ -220,12 +233,12 @@ typedef struct files_struct {
        unsigned int num_smb_operations;
        struct file_id file_id;
        uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
-       uint16 file_pid;
+       uint16_t file_pid;
        uint64_t vuid; /* SMB2 compat */
        struct write_cache *wcp;
        struct timeval open_time;
-       uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
-       uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
+       uint32_t access_mask;           /* NTCreateX access bits (FILE_READ_DATA etc.) */
+       uint32_t share_access;          /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 
        bool update_write_time_triggered;
        struct tevent_timer *update_write_time_event;
@@ -248,10 +261,11 @@ typedef struct files_struct {
        bool aio_write_behind;
        bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
        bool delete_on_close;
-       bool posix_open;
+       uint64_t posix_flags;
        bool is_sparse;
        bool backup_intent; /* Handle was successfully opened with backup intent
                                and opener has privilege to do so. */
+       bool aapl_copyfile_supported;
        struct smb_filename *fsp_name;
        uint32_t name_hash;             /* Jenkins hash of full pathname. */
        uint64_t mid;                   /* Mid of the operation that created us. */
@@ -289,6 +303,15 @@ typedef struct files_struct {
        struct tevent_req *deferred_close;
 } files_struct;
 
+#define FSP_POSIX_FLAGS_OPEN           0x01
+#define FSP_POSIX_FLAGS_RENAME         0x02
+#define FSP_POSIX_FLAGS_PATHNAMES      0x04
+
+#define FSP_POSIX_FLAGS_ALL                    \
+       (FSP_POSIX_FLAGS_OPEN |                 \
+        FSP_POSIX_FLAGS_PATHNAMES |            \
+        FSP_POSIX_FLAGS_RENAME)
+
 struct vuid_cache_entry {
        struct auth_session_info *session_info;
        uint64_t vuid; /* SMB2 compat */
@@ -388,17 +411,17 @@ struct privilege_paths;
 
 struct smb_request {
        uint8_t cmd;
-       uint16 flags2;
-       uint16 smbpid;
+       uint16_t flags2;
+       uint16_t smbpid;
        uint64_t mid; /* For compatibility with SMB2. */
        uint32_t seqnum;
        uint64_t vuid; /* For compatibility with SMB2. */
        uint32_t tid;
-       uint8  wct;
+       uint8_t  wct;
        const uint16_t *vwv;
        uint16_t buflen;
        const uint8_t *buf;
-       const uint8 *inbuf;
+       const uint8_t *inbuf;
 
        /*
         * Async handling in the main smb processing loop is directed by
@@ -409,7 +432,7 @@ struct smb_request {
         * If async handling is wanted, the reply_xxx routine must make sure
         * that it talloc_move()s the smb_req somewhere else.
         */
-       uint8 *outbuf;
+       uint8_t *outbuf;
 
        size_t unread_bytes;
        bool encrypted;
@@ -445,6 +468,8 @@ struct smb_request {
        struct smb_request **chain;
 
        struct timeval request_time;
+
+       bool posix_pathnames;
 };
 
 /*
@@ -484,9 +509,9 @@ enum vfs_translate_direction {
        vfs_translate_to_windows
 };
 
-enum vfs_fallocate_mode {
-       VFS_FALLOCATE_EXTEND_SIZE = 0,
-       VFS_FALLOCATE_KEEP_SIZE = 1
+enum vfs_fallocate_flags {
+       VFS_FALLOCATE_FL_KEEP_SIZE              = 0x0001,
+       VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 };
 
 /*
@@ -502,9 +527,11 @@ struct vfs_fn_pointers {
 
        int (*connect_fn)(struct vfs_handle_struct *handle, const char *service, const char *user);
        void (*disconnect_fn)(struct vfs_handle_struct *handle);
-       uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, bool small_query, uint64_t *bsize,
+       uint64_t (*disk_free_fn)(struct vfs_handle_struct *handle, const char *path, uint64_t *bsize,
                              uint64_t *dfree, uint64_t *dsize);
-       int (*get_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
+       int (*get_quota_fn)(struct vfs_handle_struct *handle, const char *path,
+                           enum SMB_QUOTA_TYPE qtype, unid_t id,
+                           SMB_DISK_QUOTA *qt);
        int (*set_quota_fn)(struct vfs_handle_struct *handle, enum SMB_QUOTA_TYPE qtype, unid_t id, SMB_DISK_QUOTA *qt);
        int (*get_shadow_copy_data_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, struct shadow_copy_data *shadow_copy_data, bool labels);
        int (*statvfs_fn)(struct vfs_handle_struct *handle, const char *path, struct vfs_statvfs_struct *statbuf);
@@ -519,8 +546,8 @@ struct vfs_fn_pointers {
 
        /* Directory operations */
 
-       DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32 attributes);
-       DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32 attributes);
+       DIR *(*opendir_fn)(struct vfs_handle_struct *handle, const char *fname, const char *mask, uint32_t attributes);
+       DIR *(*fdopendir_fn)(struct vfs_handle_struct *handle, files_struct *fsp, const char *mask, uint32_t attributes);
        struct dirent *(*readdir_fn)(struct vfs_handle_struct *handle,
                                         DIR *dirp,
                                         SMB_STRUCT_STAT *sbuf);
@@ -553,7 +580,9 @@ struct vfs_fn_pointers {
                                   struct security_descriptor *sd,
                                   struct ea_list *ea_list,
                                   files_struct **result,
-                                  int *pinfo);
+                                  int *pinfo,
+                                  const struct smb2_create_blobs *in_context_blobs,
+                                  struct smb2_create_blobs *out_context_blobs);
        int (*close_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
        ssize_t (*read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n);
        ssize_t (*pread_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, void *data, size_t n, off_t offset);
@@ -604,12 +633,12 @@ struct vfs_fn_pointers {
        int (*ftruncate_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset);
        int (*fallocate_fn)(struct vfs_handle_struct *handle,
                            struct files_struct *fsp,
-                           enum vfs_fallocate_mode mode,
+                           uint32_t mode,
                            off_t offset,
                            off_t len);
        bool (*lock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, off_t offset, off_t count, int type);
        int (*kernel_flock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
-                              uint32 share_mode, uint32_t access_mask);
+                              uint32_t share_mode, uint32_t access_mask);
        int (*linux_setlease_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int leasetype);
        bool (*getlock_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid);
        int (*symlink_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
@@ -617,16 +646,6 @@ struct vfs_fn_pointers {
        int (*link_fn)(struct vfs_handle_struct *handle, const char *oldpath, const char *newpath);
        int (*mknod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode, SMB_DEV_T dev);
        char *(*realpath_fn)(struct vfs_handle_struct *handle, const char *path);
-       NTSTATUS (*notify_watch_fn)(struct vfs_handle_struct *handle,
-                                   struct sys_notify_context *ctx,
-                                   const char *path,
-                                   uint32_t *filter,
-                                   uint32_t *subdir_filter,
-                                   void (*callback)(struct sys_notify_context *ctx,
-                                                    void *private_data,
-                                                    struct notify_event *ev),
-                                   void *private_data, 
-                                   void *handle_p);
        int (*chflags_fn)(struct vfs_handle_struct *handle, const char *path, unsigned int flags);
        struct file_id (*file_id_create_fn)(struct vfs_handle_struct *handle,
                                            const SMB_STRUCT_STAT *sbuf);
@@ -650,6 +669,21 @@ struct vfs_fn_pointers {
                                       TALLOC_CTX *mem_ctx,
                                       struct files_struct *fsp,
                                       uint16_t compression_fmt);
+       NTSTATUS (*snap_check_path_fn)(struct vfs_handle_struct *handle,
+                                      TALLOC_CTX *mem_ctx,
+                                      const char *service_path,
+                                      char **base_volume);
+       NTSTATUS (*snap_create_fn)(struct vfs_handle_struct *handle,
+                                  TALLOC_CTX *mem_ctx,
+                                  const char *base_volume,
+                                  time_t *tstamp,
+                                  bool rw,
+                                  char **base_path,
+                                  char **snap_path);
+       NTSTATUS (*snap_delete_fn)(struct vfs_handle_struct *handle,
+                                  TALLOC_CTX *mem_ctx,
+                                  char *base_path,
+                                  char *snap_path);
 
        NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
                                  struct files_struct *fsp,
@@ -710,17 +744,17 @@ struct vfs_fn_pointers {
 
        NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
                                   struct files_struct *fsp,
-                                  uint32 security_info,
+                                  uint32_t security_info,
                                   TALLOC_CTX *mem_ctx,
                                   struct security_descriptor **ppdesc);
        NTSTATUS (*get_nt_acl_fn)(struct vfs_handle_struct *handle,
-                                 const char *name,
-                                 uint32 security_info,
+                                 const struct smb_filename *smb_fname,
+                                 uint32_t security_info,
                                   TALLOC_CTX *mem_ctx,
                                  struct security_descriptor **ppdesc);
        NTSTATUS (*fset_nt_acl_fn)(struct vfs_handle_struct *handle,
                                   struct files_struct *fsp,
-                                  uint32 security_info_sent,
+                                  uint32_t security_info_sent,
                                   const struct security_descriptor *psd);
 
        NTSTATUS (*audit_file_fn)(struct vfs_handle_struct *handle,
@@ -816,8 +850,8 @@ typedef struct vfs_handle_struct {
 
 typedef struct vfs_statvfs_struct {
        /* For undefined recommended transfer size return -1 in that field */
-       uint32 OptimalTransferSize;  /* bsize on some os, iosize on other os */
-       uint32 BlockSize;
+       uint32_t OptimalTransferSize;  /* bsize on some os, iosize on other os */
+       uint32_t BlockSize;
 
        /*
         The next three fields are in terms of the block size.
@@ -900,10 +934,9 @@ int smb_vfs_call_connect(struct vfs_handle_struct *handle,
                         const char *service, const char *user);
 void smb_vfs_call_disconnect(struct vfs_handle_struct *handle);
 uint64_t smb_vfs_call_disk_free(struct vfs_handle_struct *handle,
-                               const char *path, bool small_query,
-                               uint64_t *bsize, uint64_t *dfree,
-                               uint64_t *dsize);
-int smb_vfs_call_get_quota(struct vfs_handle_struct *handle,
+                               const char *path, uint64_t *bsize,
+                               uint64_t *dfree, uint64_t *dsize);
+int smb_vfs_call_get_quota(struct vfs_handle_struct *handle, const char *path,
                           enum SMB_QUOTA_TYPE qtype, unid_t id,
                           SMB_DISK_QUOTA *qt);
 int smb_vfs_call_set_quota(struct vfs_handle_struct *handle,
@@ -924,11 +957,11 @@ NTSTATUS smb_vfs_call_get_dfs_referrals(struct vfs_handle_struct *handle,
                                        struct dfs_GetDFSReferral *r);
 DIR *smb_vfs_call_opendir(struct vfs_handle_struct *handle,
                                     const char *fname, const char *mask,
-                                    uint32 attributes);
+                                    uint32_t attributes);
 DIR *smb_vfs_call_fdopendir(struct vfs_handle_struct *handle,
                                        struct files_struct *fsp,
                                        const char *mask,
-                                       uint32 attributes);
+                                       uint32_t attributes);
 struct dirent *smb_vfs_call_readdir(struct vfs_handle_struct *handle,
                                        DIR *dirp,
                                        SMB_STRUCT_STAT *sbuf);
@@ -964,7 +997,9 @@ NTSTATUS smb_vfs_call_create_file(struct vfs_handle_struct *handle,
                                  struct security_descriptor *sd,
                                  struct ea_list *ea_list,
                                  files_struct **result,
-                                 int *pinfo);
+                                 int *pinfo,
+                                 const struct smb2_create_blobs *in_context_blobs,
+                                 struct smb2_create_blobs *out_context_blobs);
 int smb_vfs_call_close(struct vfs_handle_struct *handle,
                       struct files_struct *fsp);
 ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
@@ -1044,15 +1079,15 @@ int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
 int smb_vfs_call_ftruncate(struct vfs_handle_struct *handle,
                           struct files_struct *fsp, off_t offset);
 int smb_vfs_call_fallocate(struct vfs_handle_struct *handle,
-                       struct files_struct *fsp,
-                       enum vfs_fallocate_mode mode,
-                       off_t offset,
-                       off_t len);
+                          struct files_struct *fsp,
+                          uint32_t mode,
+                          off_t offset,
+                          off_t len);
 bool smb_vfs_call_lock(struct vfs_handle_struct *handle,
                       struct files_struct *fsp, int op, off_t offset,
                       off_t count, int type);
 int smb_vfs_call_kernel_flock(struct vfs_handle_struct *handle,
-                             struct files_struct *fsp, uint32 share_mode,
+                             struct files_struct *fsp, uint32_t share_mode,
                              uint32_t access_mask);
 int smb_vfs_call_linux_setlease(struct vfs_handle_struct *handle,
                                struct files_struct *fsp, int leasetype);
@@ -1068,15 +1103,6 @@ int smb_vfs_call_link(struct vfs_handle_struct *handle, const char *oldpath,
 int smb_vfs_call_mknod(struct vfs_handle_struct *handle, const char *path,
                       mode_t mode, SMB_DEV_T dev);
 char *smb_vfs_call_realpath(struct vfs_handle_struct *handle, const char *path);
-NTSTATUS smb_vfs_call_notify_watch(struct vfs_handle_struct *handle,
-                                  struct sys_notify_context *ctx,
-                                  const char *name,
-                                  uint32_t *filter,
-                                  uint32_t *subdir_filter,
-                                  void (*callback)(struct sys_notify_context *ctx,
-                                                   void *private_data,
-                                                   struct notify_event *ev),
-                                  void *private_data, void *handle_p);
 int smb_vfs_call_chflags(struct vfs_handle_struct *handle, const char *path,
                         unsigned int flags);
 struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
@@ -1144,19 +1170,34 @@ NTSTATUS smb_vfs_call_set_compression(struct vfs_handle_struct *handle,
                                      TALLOC_CTX *mem_ctx,
                                      struct files_struct *fsp,
                                      uint16_t compression_fmt);
+NTSTATUS smb_vfs_call_snap_check_path(vfs_handle_struct *handle,
+                                     TALLOC_CTX *mem_ctx,
+                                     const char *service_path,
+                                     char **base_volume);
+NTSTATUS smb_vfs_call_snap_create(struct vfs_handle_struct *handle,
+                                 TALLOC_CTX *mem_ctx,
+                                 const char *base_volume,
+                                 time_t *tstamp,
+                                 bool rw,
+                                 char **base_path,
+                                 char **snap_path);
+NTSTATUS smb_vfs_call_snap_delete(struct vfs_handle_struct *handle,
+                                 TALLOC_CTX *mem_ctx,
+                                 char *base_path,
+                                 char *snap_path);
 NTSTATUS smb_vfs_call_fget_nt_acl(struct vfs_handle_struct *handle,
                                  struct files_struct *fsp,
-                                 uint32 security_info,
+                                 uint32_t security_info,
                                  TALLOC_CTX *mem_ctx,
                                  struct security_descriptor **ppdesc);
 NTSTATUS smb_vfs_call_get_nt_acl(struct vfs_handle_struct *handle,
-                                const char *name,
-                                uint32 security_info,
+                                const struct smb_filename *smb_fname,
+                                uint32_t security_info,
                                 TALLOC_CTX *mem_ctx,
                                 struct security_descriptor **ppdesc);
 NTSTATUS smb_vfs_call_fset_nt_acl(struct vfs_handle_struct *handle,
                                  struct files_struct *fsp,
-                                 uint32 security_info_sent,
+                                 uint32_t security_info_sent,
                                  const struct security_descriptor *psd);
 NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
                                 struct smb_filename *file,