s3: VFS: Change SMB_VFS_SYS_ACL_SET_FILE to use const struct smb_filename * instead...
[metze/samba/wip.git] / source3 / include / vfs.h
index a5ea8e6e1332f25c3f3e8e00d90043eec1802a76..f3a0b323923d3076faca9979cbee01ec1d4561b1 100644 (file)
 /* Version 35 - Change opendir from const char *, to
                const struct smb_filename * */
 /* Version 35 - Wrap aio async funtions args in a struct vfs_aio_state */
-
-#define SMB_VFS_INTERFACE_VERSION 35
+/* Version 35 - Change chmod from const char *, to
+               const struct smb_filename * */
+/* Version 35 - Change chmod_acl from const char *, to
+               const struct smb_filename * */
+/* Version 35 - Change chown from const char *, to
+               const struct smb_filename * */
+/* Version 35 - Change lchown from const char *, to
+               const struct smb_filename * */
+/* Version 35 - Change streaminfo from const char *, to
+               const struct smb_filename * */
+/* Version 35 - Add uint32_t flags to struct smb_filename */
+/* Version 35 - Add get/set/fget/fset dos attribute functions. */
+/* Version 35 - Add bool use_ofd_locks to struct files_struct */
+/* Bump to version 36 - Samba 4.6 will ship with that */
+/* Version 36 - Remove is_offline and set_offline */
+/* Version 37 - Module init functions now take a TALLOC_CTX * parameter. */
+/* Version 37 - Add vfs_copy_chunk_flags for DUP_EXTENTS_TO_FILE */
+/* Version 37 - Change sys_acl_delete_def_file from const char *
+               to const struct smb_filename * */
+/* Version 37 - Change sys_acl_get_file from const char *
+               to const struct smb_filename * */
+/* Version 37 - Change sys_acl_blob_get_file from const char *
+               to const struct smb_filename * */
+/* Version 37 - Change sys_acl_set_file from const char *
+               to const struct smb_filename * */
+
+#define SMB_VFS_INTERFACE_VERSION 37
 
 /*
     All intercepted VFS operations must be declared as static functions inside module source
@@ -247,6 +272,8 @@ typedef struct files_struct {
        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 kernel_share_modes_taken;
+
        bool update_write_time_triggered;
        struct tevent_timer *update_write_time_event;
        bool update_write_time_on_close;
@@ -254,7 +281,7 @@ typedef struct files_struct {
        bool write_time_forced;
 
        int oplock_type;
-       struct fsp_lease *lease; /* Not yet used. Placeholder for leases. */
+       struct fsp_lease *lease;
        int sent_oplock_break;
        struct tevent_timer *oplock_timeout;
        struct lock_struct last_lock_failure;
@@ -273,6 +300,7 @@ typedef struct files_struct {
        bool backup_intent; /* Handle was successfully opened with backup intent
                                and opener has privilege to do so. */
        bool aapl_copyfile_supported;
+       bool use_ofd_locks; /* Are we using open file description locks ? */
        struct smb_filename *fsp_name;
        uint32_t name_hash;             /* Jenkins hash of full pathname. */
        uint64_t mid;                   /* Mid of the operation that created us. */
@@ -504,9 +532,17 @@ struct smb_filename {
        char *base_name;
        char *stream_name;
        char *original_lcomp;
+       uint32_t flags;
        SMB_STRUCT_STAT st;
 };
 
+/*
+ * smb_filename flags. Define in terms of the FSP_POSIX_FLAGS_XX
+ * to keep the numeric values consistent.
+ */
+
+#define SMB_FILENAME_POSIX_PATH                FSP_POSIX_FLAGS_PATHNAMES
+
 #define VFS_FIND(__fn__) while (handle->fns->__fn__##_fn==NULL) { \
                                handle = handle->next; \
                         }
@@ -521,8 +557,23 @@ enum vfs_fallocate_flags {
        VFS_FALLOCATE_FL_PUNCH_HOLE             = 0x0002,
 };
 
+/*
+ * @VFS_COPY_CHUNK_FL_MUST_CLONE: indicates that copy_chunk_send_fn() copy must
+ *                               be handled as a COW clone, AKA reflink.
+ * @VFS_COPY_CHUNK_FL_MASK_ALL: all valid copychunk flags.
+ */
+enum vfs_copy_chunk_flags {
+       VFS_COPY_CHUNK_FL_MUST_CLONE            = 0x0001,
+       VFS_COPY_CHUNK_FL_IGNORE_LOCKS          = 0x0002,
+
+       VFS_COPY_CHUNK_FL_MASK_ALL              =
+                                       (VFS_COPY_CHUNK_FL_MUST_CLONE
+                                        | VFS_COPY_CHUNK_FL_IGNORE_LOCKS),
+};
+
 struct vfs_aio_state {
        int error;
+       uint64_t duration;
 };
 
 /*
@@ -637,11 +688,19 @@ struct vfs_fn_pointers {
        uint64_t (*get_alloc_size_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_STAT *sbuf);
        int (*unlink_fn)(struct vfs_handle_struct *handle,
                         const struct smb_filename *smb_fname);
-       int (*chmod_fn)(struct vfs_handle_struct *handle, const char *path, mode_t mode);
+       int (*chmod_fn)(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       mode_t mode);
        int (*fchmod_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
-       int (*chown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
+       int (*chown_fn)(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       uid_t uid,
+                       gid_t gid);
        int (*fchown_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, uid_t uid, gid_t gid);
-       int (*lchown_fn)(struct vfs_handle_struct *handle, const char *path, uid_t uid, gid_t gid);
+       int (*lchown_fn)(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       uid_t uid,
+                       gid_t gid);
        int (*chdir_fn)(struct vfs_handle_struct *handle, const char *path);
        char *(*getwd_fn)(struct vfs_handle_struct *handle);
        int (*ntimes_fn)(struct vfs_handle_struct *handle,
@@ -673,7 +732,8 @@ struct vfs_fn_pointers {
                                                 off_t src_off,
                                                 struct files_struct *dest_fsp,
                                                 off_t dest_off,
-                                                off_t num);
+                                                off_t to_copy,
+                                                uint32_t flags);
        NTSTATUS (*copy_chunk_recv_fn)(struct vfs_handle_struct *handle,
                                       struct tevent_req *req,
                                       off_t *copied);
@@ -704,7 +764,7 @@ struct vfs_fn_pointers {
 
        NTSTATUS (*streaminfo_fn)(struct vfs_handle_struct *handle,
                                  struct files_struct *fsp,
-                                 const char *fname,
+                                 const struct smb_filename *smb_fname,
                                  TALLOC_CTX *mem_ctx,
                                  unsigned int *num_streams,
                                  struct stream_struct **streams);
@@ -757,6 +817,22 @@ struct vfs_fn_pointers {
                             uint32_t max_out_len,
                             uint32_t *out_len); 
 
+       NTSTATUS (*get_dos_attributes_fn)(struct vfs_handle_struct *handle,
+                                         struct smb_filename *smb_fname,
+                                         uint32_t *dosmode);
+
+       NTSTATUS (*fget_dos_attributes_fn)(struct vfs_handle_struct *handle,
+                                          struct files_struct *fsp,
+                                          uint32_t *dosmode);
+
+       NTSTATUS (*set_dos_attributes_fn)(struct vfs_handle_struct *handle,
+                                         const struct smb_filename *smb_fname,
+                                         uint32_t dosmode);
+
+       NTSTATUS (*fset_dos_attributes_fn)(struct vfs_handle_struct *hande,
+                                          struct files_struct *fsp,
+                                          uint32_t dosmode);
+
        /* NT ACL operations. */
 
        NTSTATUS (*fget_nt_acl_fn)(struct vfs_handle_struct *handle,
@@ -782,27 +858,33 @@ struct vfs_fn_pointers {
 
        /* POSIX ACL operations. */
 
-       int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
+       int (*chmod_acl_fn)(struct vfs_handle_struct *handle,
+                                       const struct smb_filename *smb_fname,
+                                       mode_t mode);
        int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 
        SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle,
-                                        const char *path_p,
+                                        const struct smb_filename *smb_fname,
                                         SMB_ACL_TYPE_T type,
                                         TALLOC_CTX *mem_ctx);
        SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle,
                                       struct files_struct *fsp,
                                       TALLOC_CTX *mem_ctx);
        int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle,
-                                       const char *path_p,
+                                       const struct smb_filename *smb_fname,
                                        TALLOC_CTX *mem_ctx,
                                        char **blob_description,
                                        DATA_BLOB *blob);
        int (*sys_acl_blob_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp,
                                      TALLOC_CTX *mem_ctx, char **blob_description,
                                      DATA_BLOB *blob);
-       int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle, const char *name, SMB_ACL_TYPE_T acltype, SMB_ACL_T theacl);
+       int (*sys_acl_set_file_fn)(struct vfs_handle_struct *handle,
+                                       const struct smb_filename *smb_fname,
+                                       SMB_ACL_TYPE_T acltype,
+                                       SMB_ACL_T theacl);
        int (*sys_acl_set_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_ACL_T theacl);
-       int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle, const char *path);
+       int (*sys_acl_delete_def_file_fn)(struct vfs_handle_struct *handle,
+                                       const struct smb_filename *smb_fname);
 
        /* EA operations. */
        ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
@@ -817,13 +899,6 @@ struct vfs_fn_pointers {
        /* aio operations */
        bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 
-       /* offline operations */
-       bool (*is_offline_fn)(struct vfs_handle_struct *handle,
-                          const struct smb_filename *fname,
-                          SMB_STRUCT_STAT *sbuf);
-       int (*set_offline_fn)(struct vfs_handle_struct *handle,
-                          const struct smb_filename *fname);
-
        /* durable handle operations */
        NTSTATUS (*durable_cookie_fn)(struct vfs_handle_struct *handle,
                                      struct files_struct *fsp,
@@ -1081,16 +1156,21 @@ uint64_t smb_vfs_call_get_alloc_size(struct vfs_handle_struct *handle,
                                     const SMB_STRUCT_STAT *sbuf);
 int smb_vfs_call_unlink(struct vfs_handle_struct *handle,
                        const struct smb_filename *smb_fname);
-int smb_vfs_call_chmod(struct vfs_handle_struct *handle, const char *path,
-                      mode_t mode);
+int smb_vfs_call_chmod(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       mode_t mode);
 int smb_vfs_call_fchmod(struct vfs_handle_struct *handle,
                        struct files_struct *fsp, mode_t mode);
-int smb_vfs_call_chown(struct vfs_handle_struct *handle, const char *path,
-                      uid_t uid, gid_t gid);
+int smb_vfs_call_chown(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       uid_t uid,
+                       gid_t gid);
 int smb_vfs_call_fchown(struct vfs_handle_struct *handle,
                        struct files_struct *fsp, uid_t uid, gid_t gid);
-int smb_vfs_call_lchown(struct vfs_handle_struct *handle, const char *path,
-                       uid_t uid, gid_t gid);
+int smb_vfs_call_lchown(struct vfs_handle_struct *handle,
+                       const struct smb_filename *smb_fname,
+                       uid_t uid,
+                       gid_t gid);
 int smb_vfs_call_chdir(struct vfs_handle_struct *handle, const char *path);
 char *smb_vfs_call_getwd(struct vfs_handle_struct *handle);
 int smb_vfs_call_ntimes(struct vfs_handle_struct *handle,
@@ -1129,7 +1209,7 @@ struct file_id smb_vfs_call_file_id_create(struct vfs_handle_struct *handle,
                                           const SMB_STRUCT_STAT *sbuf);
 NTSTATUS smb_vfs_call_streaminfo(struct vfs_handle_struct *handle,
                                 struct files_struct *fsp,
-                                const char *fname,
+                                const struct smb_filename *smb_fname,
                                 TALLOC_CTX *mem_ctx,
                                 unsigned int *num_streams,
                                 struct stream_struct **streams);
@@ -1170,6 +1250,18 @@ NTSTATUS smb_vfs_call_fsctl(struct vfs_handle_struct *handle,
                            uint8_t **_out_data,
                            uint32_t max_out_len,
                            uint32_t *out_len);
+NTSTATUS smb_vfs_call_get_dos_attributes(struct vfs_handle_struct *handle,
+                                        struct smb_filename *smb_fname,
+                                        uint32_t *dosmode);
+NTSTATUS smb_vfs_call_fget_dos_attributes(struct vfs_handle_struct *handle,
+                                         struct files_struct *fsp,
+                                         uint32_t *dosmode);
+NTSTATUS smb_vfs_call_set_dos_attributes(struct vfs_handle_struct *handle,
+                                        const struct smb_filename *smb_fname,
+                                        uint32_t dosmode);
+NTSTATUS smb_vfs_call_fset_dos_attributes(struct vfs_handle_struct *handle,
+                                         struct files_struct *fsp,
+                                         uint32_t dosmode);
 struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle,
                                                TALLOC_CTX *mem_ctx,
                                                struct tevent_context *ev,
@@ -1177,7 +1269,8 @@ struct tevent_req *smb_vfs_call_copy_chunk_send(struct vfs_handle_struct *handle
                                                off_t src_off,
                                                struct files_struct *dest_fsp,
                                                off_t dest_off,
-                                               off_t num);
+                                               off_t num,
+                                               uint32_t flags);
 NTSTATUS smb_vfs_call_copy_chunk_recv(struct vfs_handle_struct *handle,
                                      struct tevent_req *req,
                                      off_t *copied);
@@ -1224,19 +1317,20 @@ NTSTATUS smb_vfs_call_audit_file(struct vfs_handle_struct *handle,
                                 struct security_acl *sacl,
                                 uint32_t access_requested,
                                 uint32_t access_denied);
-int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
-                          mode_t mode);
+int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle,
+                               const struct smb_filename *file,
+                               mode_t mode);
 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
                            struct files_struct *fsp, mode_t mode);
 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
-                                       const char *path_p,
+                                       const struct smb_filename *smb_fname,
                                        SMB_ACL_TYPE_T type,
                                        TALLOC_CTX *mem_ctx);
 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
                                      struct files_struct *fsp,
                                      TALLOC_CTX *mem_ctx);
 int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
-                                      const char *path_p,
+                                      const struct smb_filename *smb_fname,
                                       TALLOC_CTX *mem_ctx,
                                       char **blob_description,
                                       DATA_BLOB *blob);
@@ -1246,12 +1340,13 @@ int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
                                     char **blob_description,
                                     DATA_BLOB *blob);
 int smb_vfs_call_sys_acl_set_file(struct vfs_handle_struct *handle,
-                                 const char *name, SMB_ACL_TYPE_T acltype,
-                                 SMB_ACL_T theacl);
+                               const struct smb_filename *smb_fname,
+                               SMB_ACL_TYPE_T acltype,
+                               SMB_ACL_T theacl);
 int smb_vfs_call_sys_acl_set_fd(struct vfs_handle_struct *handle,
                                struct files_struct *fsp, SMB_ACL_T theacl);
 int smb_vfs_call_sys_acl_delete_def_file(struct vfs_handle_struct *handle,
-                                        const char *path);
+                               const struct smb_filename *smb_fname);
 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
                              const char *path, const char *name, void *value,
                              size_t size);
@@ -1316,4 +1411,7 @@ void vfs_remove_all_fsp_extensions(struct files_struct *fsp);
 void *vfs_memctx_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
 void *vfs_fetch_fsp_extension(vfs_handle_struct *handle, files_struct *fsp);
 
+void smb_vfs_assert_all_fns(const struct vfs_fn_pointers* fns,
+                           const char *module);
+
 #endif /* _VFS_H */