Move cached cwd onto conn struct.
[kai/samba.git] / source3 / include / vfs.h
index bd66d34043d492d874214bec4d94eea73ac24f98..c83e7ed54b8fe17eb9c886ff98b63d237382d3ae 100644 (file)
 /* Leave at 29 - not yet released. add SMB_VFS_GET_DFS_REFERRAL() - metze */
 /* Leave at 29 - not yet released. Remove l{list,get,set,remove}xattr - abartlet */
 /* Leave at 29 - not yet released. move to plain off_t - abartlet */
-#define SMB_VFS_INTERFACE_VERSION 29
+/* Leave at 29 - not yet released. Remove sys_acl functions other than set and get - abartlet */
+/* Leave at 29 - not yet released. Added backup_intent bool to files_struct - JRA */
+/* Leave at 29 - not yet released. Add durable handle functions - metze/obnox */
+/* Leave at 29 - not yet released. Added sys_acl_blob_get_file and sys_acl_blob_get_fd */
+/* Bump to version 30 - Samba 4.0.0 will ship with interface version 30 */
+/* Leave at 30 - not yet released. Added conn->cwd to save vfs_GetWd() calls. */
+#define SMB_VFS_INTERFACE_VERSION 30
 
 /*
     All intercepted VFS operations must be declared as static functions inside module source
@@ -186,6 +192,7 @@ struct fd_handle {
 typedef struct files_struct {
        struct files_struct *next, *prev;
        uint64_t fnum;
+       struct smbXsrv_open *op;
        struct connection_struct *conn;
        struct fd_handle *fh;
        unsigned int num_smb_operations;
@@ -224,8 +231,11 @@ typedef struct files_struct {
        bool delete_on_close;
        bool posix_open;
        bool is_sparse;
+       bool backup_intent; /* Handle was successfully opened with backup intent
+                               and opener has privilege to do so. */
        struct smb_filename *fsp_name;
        uint32_t name_hash;             /* Jenkins hash of full pathname. */
+       uint64_t mid;                   /* Mid of the operation that created us. */
 
        struct vfs_fsp_data *vfs_extension;
        struct fake_file_handle *fake_file_handle;
@@ -247,6 +257,17 @@ typedef struct files_struct {
        /* if not NULL, means this is a print file */
        struct print_file_data *print_file;
 
+       unsigned num_aio_requests;
+       struct tevent_req **aio_requests;
+
+       /*
+        * If a close request comes in while we still have aio_requests
+        * around, we need to hold back the close. When all aio_requests are
+        * done, the aio completion routines need tevent_wait_done() on
+        * this. A bit ugly, but before we have close_file() fully async
+        * possibly the simplest approach. Thanks, Jeremy for the idea.
+        */
+       struct tevent_req *deferred_close;
 } files_struct;
 
 struct vuid_cache_entry {
@@ -280,7 +301,7 @@ struct share_params {
 typedef struct connection_struct {
        struct connection_struct *next, *prev;
        struct smbd_server_connection *sconn; /* can be NULL */
-       struct smbXsrv_tcon0 *tcon; /* can be NULL */
+       struct smbXsrv_tcon *tcon; /* can be NULL */
        uint32_t cnum; /* an index passed over the wire */
        struct share_params *params;
        bool force_user;
@@ -295,6 +316,7 @@ typedef struct connection_struct {
        enum timestamp_set_resolution ts_res;
        char *connectpath;
        char *origpath;
+       char *cwd; /* Working directory. */
 
        struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 
@@ -513,8 +535,22 @@ struct vfs_fn_pointers {
        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);
+       struct tevent_req *(*pread_send_fn)(struct vfs_handle_struct *handle,
+                                           TALLOC_CTX *mem_ctx,
+                                           struct tevent_context *ev,
+                                           struct files_struct *fsp,
+                                           void *data,
+                                           size_t n, off_t offset);
+       ssize_t (*pread_recv_fn)(struct tevent_req *req, int *err);
        ssize_t (*write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n);
        ssize_t (*pwrite_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const void *data, size_t n, off_t offset);
+       struct tevent_req *(*pwrite_send_fn)(struct vfs_handle_struct *handle,
+                                            TALLOC_CTX *mem_ctx,
+                                            struct tevent_context *ev,
+                                            struct files_struct *fsp,
+                                            const void *data,
+                                            size_t n, off_t offset);
+       ssize_t (*pwrite_recv_fn)(struct tevent_req *req, int *err);
        off_t (*lseek_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, off_t offset, int whence);
        ssize_t (*sendfile_fn)(struct vfs_handle_struct *handle, int tofd, files_struct *fromfsp, const DATA_BLOB *header, off_t offset, size_t count);
        ssize_t (*recvfile_fn)(struct vfs_handle_struct *handle, int fromfd, files_struct *tofsp, off_t offset, size_t count);
@@ -522,6 +558,11 @@ struct vfs_fn_pointers {
                         const struct smb_filename *smb_fname_src,
                         const struct smb_filename *smb_fname_dst);
        int (*fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
+       struct tevent_req *(*fsync_send_fn)(struct vfs_handle_struct *handle,
+                                           TALLOC_CTX *mem_ctx,
+                                           struct tevent_context *ev,
+                                           struct files_struct *fsp);
+       int (*fsync_recv_fn)(struct tevent_req *req, int *err);
        int (*stat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_fname);
        int (*fstat_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_STAT *sbuf);
        int (*lstat_fn)(struct vfs_handle_struct *handle, struct smb_filename *smb_filename);
@@ -651,28 +692,17 @@ struct vfs_fn_pointers {
        int (*chmod_acl_fn)(struct vfs_handle_struct *handle, const char *name, mode_t mode);
        int (*fchmod_acl_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, mode_t mode);
 
-       int (*sys_acl_get_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, int entry_id, SMB_ACL_ENTRY_T *entry_p);
-       int (*sys_acl_get_tag_type_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *tag_type_p);
-       int (*sys_acl_get_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
-       void * (*sys_acl_get_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry_d);
        SMB_ACL_T (*sys_acl_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type);
        SMB_ACL_T (*sys_acl_get_fd_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
-       int (*sys_acl_clear_perms_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset);
-       int (*sys_acl_add_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
-       char * (*sys_acl_to_text_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl, ssize_t *plen);
-       SMB_ACL_T (*sys_acl_init_fn)(struct vfs_handle_struct *handle, int count);
-       int (*sys_acl_create_entry_fn)(struct vfs_handle_struct *handle, SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
-       int (*sys_acl_set_tag_type_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_TAG_T tagtype);
-       int (*sys_acl_set_qualifier_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, void *qual);
-       int (*sys_acl_set_permset_fn)(struct vfs_handle_struct *handle, SMB_ACL_ENTRY_T entry, SMB_ACL_PERMSET_T permset);
-       int (*sys_acl_valid_fn)(struct vfs_handle_struct *handle, SMB_ACL_T theacl );
+       int (*sys_acl_blob_get_file_fn)(struct vfs_handle_struct *handle, const char *path_p, SMB_ACL_TYPE_T type,      
+                                       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_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_get_perm_fn)(struct vfs_handle_struct *handle, SMB_ACL_PERMSET_T permset, SMB_ACL_PERM_T perm);
-       int (*sys_acl_free_text_fn)(struct vfs_handle_struct *handle, char *text);
-       int (*sys_acl_free_acl_fn)(struct vfs_handle_struct *handle, SMB_ACL_T posix_acl);
-       int (*sys_acl_free_qualifier_fn)(struct vfs_handle_struct *handle, void *qualifier, SMB_ACL_TAG_T tagtype);
 
        /* EA operations. */
        ssize_t (*getxattr_fn)(struct vfs_handle_struct *handle,const char *path, const char *name, void *value, size_t size);
@@ -685,13 +715,6 @@ struct vfs_fn_pointers {
        int (*fsetxattr_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const char *name, const void *value, size_t size, int flags);
 
        /* aio operations */
-       int (*aio_read_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-       int (*aio_write_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-       ssize_t (*aio_return_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-       int (*aio_cancel_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-       int (*aio_error_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-       int (*aio_fsync_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, int op, SMB_STRUCT_AIOCB *aiocb);
-       int (*aio_suspend_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp, const SMB_STRUCT_AIOCB * const aiocb[], int n, const struct timespec *timeout);
        bool (*aio_force_fn)(struct vfs_handle_struct *handle, struct files_struct *fsp);
 
        /* offline operations */
@@ -700,6 +723,24 @@ struct vfs_fn_pointers {
                           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,
+                                     TALLOC_CTX *mem_ctx,
+                                     DATA_BLOB *cookie);
+       NTSTATUS (*durable_disconnect_fn)(struct vfs_handle_struct *handle,
+                                         struct files_struct *fsp,
+                                         const DATA_BLOB old_cookie,
+                                         TALLOC_CTX *mem_ctx,
+                                         DATA_BLOB *new_cookie);
+       NTSTATUS (*durable_reconnect_fn)(struct vfs_handle_struct *handle,
+                                        struct smb_request *smb1req,
+                                        struct smbXsrv_open *op,
+                                        const DATA_BLOB old_cookie,
+                                        TALLOC_CTX *mem_ctx,
+                                        struct files_struct **fsp,
+                                        DATA_BLOB *new_cookie);
 };
 
 /*
@@ -876,12 +917,28 @@ ssize_t smb_vfs_call_read(struct vfs_handle_struct *handle,
 ssize_t smb_vfs_call_pread(struct vfs_handle_struct *handle,
                           struct files_struct *fsp, void *data, size_t n,
                           off_t offset);
+struct tevent_req *smb_vfs_call_pread_send(struct vfs_handle_struct *handle,
+                                          TALLOC_CTX *mem_ctx,
+                                          struct tevent_context *ev,
+                                          struct files_struct *fsp,
+                                          void *data,
+                                          size_t n, off_t offset);
+ssize_t SMB_VFS_PREAD_RECV(struct tevent_req *req, int *perrno);
+
 ssize_t smb_vfs_call_write(struct vfs_handle_struct *handle,
                           struct files_struct *fsp, const void *data,
                           size_t n);
 ssize_t smb_vfs_call_pwrite(struct vfs_handle_struct *handle,
                            struct files_struct *fsp, const void *data,
                            size_t n, off_t offset);
+struct tevent_req *smb_vfs_call_pwrite_send(struct vfs_handle_struct *handle,
+                                           TALLOC_CTX *mem_ctx,
+                                           struct tevent_context *ev,
+                                           struct files_struct *fsp,
+                                           const void *data,
+                                           size_t n, off_t offset);
+ssize_t SMB_VFS_PWRITE_RECV(struct tevent_req *req, int *perrno);
+
 off_t smb_vfs_call_lseek(struct vfs_handle_struct *handle,
                             struct files_struct *fsp, off_t offset,
                             int whence);
@@ -896,6 +953,13 @@ int smb_vfs_call_rename(struct vfs_handle_struct *handle,
                        const struct smb_filename *smb_fname_dst);
 int smb_vfs_call_fsync(struct vfs_handle_struct *handle,
                       struct files_struct *fsp);
+
+struct tevent_req *smb_vfs_call_fsync_send(struct vfs_handle_struct *handle,
+                                          TALLOC_CTX *mem_ctx,
+                                          struct tevent_context *ev,
+                                          struct files_struct *fsp);
+int SMB_VFS_FSYNC_RECV(struct tevent_req *req, int *perrno);
+
 int smb_vfs_call_stat(struct vfs_handle_struct *handle,
                      struct smb_filename *smb_fname);
 int smb_vfs_call_fstat(struct vfs_handle_struct *handle,
@@ -1028,43 +1092,22 @@ int smb_vfs_call_chmod_acl(struct vfs_handle_struct *handle, const char *name,
                           mode_t mode);
 int smb_vfs_call_fchmod_acl(struct vfs_handle_struct *handle,
                            struct files_struct *fsp, mode_t mode);
-int smb_vfs_call_sys_acl_get_entry(struct vfs_handle_struct *handle,
-                                  SMB_ACL_T theacl, int entry_id,
-                                  SMB_ACL_ENTRY_T *entry_p);
-int smb_vfs_call_sys_acl_get_tag_type(struct vfs_handle_struct *handle,
-                                     SMB_ACL_ENTRY_T entry_d,
-                                     SMB_ACL_TAG_T *tag_type_p);
-int smb_vfs_call_sys_acl_get_permset(struct vfs_handle_struct *handle,
-                                    SMB_ACL_ENTRY_T entry_d,
-                                    SMB_ACL_PERMSET_T *permset_p);
-void * smb_vfs_call_sys_acl_get_qualifier(struct vfs_handle_struct *handle,
-                                         SMB_ACL_ENTRY_T entry_d);
 SMB_ACL_T smb_vfs_call_sys_acl_get_file(struct vfs_handle_struct *handle,
                                        const char *path_p,
                                        SMB_ACL_TYPE_T type);
 SMB_ACL_T smb_vfs_call_sys_acl_get_fd(struct vfs_handle_struct *handle,
                                      struct files_struct *fsp);
-int smb_vfs_call_sys_acl_clear_perms(struct vfs_handle_struct *handle,
-                                    SMB_ACL_PERMSET_T permset);
-int smb_vfs_call_sys_acl_add_perm(struct vfs_handle_struct *handle,
-                                 SMB_ACL_PERMSET_T permset,
-                                 SMB_ACL_PERM_T perm);
-char * smb_vfs_call_sys_acl_to_text(struct vfs_handle_struct *handle,
-                                   SMB_ACL_T theacl, ssize_t *plen);
-SMB_ACL_T smb_vfs_call_sys_acl_init(struct vfs_handle_struct *handle,
-                                   int count);
-int smb_vfs_call_sys_acl_create_entry(struct vfs_handle_struct *handle,
-                                     SMB_ACL_T *pacl, SMB_ACL_ENTRY_T *pentry);
-int smb_vfs_call_sys_acl_set_tag_type(struct vfs_handle_struct *handle,
-                                     SMB_ACL_ENTRY_T entry,
-                                     SMB_ACL_TAG_T tagtype);
-int smb_vfs_call_sys_acl_set_qualifier(struct vfs_handle_struct *handle,
-                                      SMB_ACL_ENTRY_T entry, void *qual);
-int smb_vfs_call_sys_acl_set_permset(struct vfs_handle_struct *handle,
-                                    SMB_ACL_ENTRY_T entry,
-                                    SMB_ACL_PERMSET_T permset);
-int smb_vfs_call_sys_acl_valid(struct vfs_handle_struct *handle,
-                              SMB_ACL_T theacl);
+int smb_vfs_call_sys_acl_blob_get_file(struct vfs_handle_struct *handle,
+                                      const char *path_p,
+                                      SMB_ACL_TYPE_T type,     
+                                      TALLOC_CTX *mem_ctx,
+                                      char **blob_description,
+                                      DATA_BLOB *blob);
+int smb_vfs_call_sys_acl_blob_get_fd(struct vfs_handle_struct *handle,
+                                    struct files_struct *fsp,  
+                                    TALLOC_CTX *mem_ctx,
+                                    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);
@@ -1072,15 +1115,6 @@ 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);
-int smb_vfs_call_sys_acl_get_perm(struct vfs_handle_struct *handle,
-                                 SMB_ACL_PERMSET_T permset,
-                                 SMB_ACL_PERM_T perm);
-int smb_vfs_call_sys_acl_free_text(struct vfs_handle_struct *handle,
-                                  char *text);
-int smb_vfs_call_sys_acl_free_acl(struct vfs_handle_struct *handle,
-                                 SMB_ACL_T posix_acl);
-int smb_vfs_call_sys_acl_free_qualifier(struct vfs_handle_struct *handle,
-                                       void *qualifier, SMB_ACL_TAG_T tagtype);
 ssize_t smb_vfs_call_getxattr(struct vfs_handle_struct *handle,
                              const char *path, const char *name, void *value,
                              size_t size);
@@ -1107,25 +1141,6 @@ int smb_vfs_call_lsetxattr(struct vfs_handle_struct *handle, const char *path,
 int smb_vfs_call_fsetxattr(struct vfs_handle_struct *handle,
                           struct files_struct *fsp, const char *name,
                           const void *value, size_t size, int flags);
-int smb_vfs_call_aio_read(struct vfs_handle_struct *handle,
-                         struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-int smb_vfs_call_aio_write(struct vfs_handle_struct *handle,
-                          struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-ssize_t smb_vfs_call_aio_return(struct vfs_handle_struct *handle,
-                               struct files_struct *fsp,
-                               SMB_STRUCT_AIOCB *aiocb);
-int smb_vfs_call_aio_cancel(struct vfs_handle_struct *handle,
-                           struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb);
-int smb_vfs_call_aio_error(struct vfs_handle_struct *handle,
-                          struct files_struct *fsp,
-                          SMB_STRUCT_AIOCB *aiocb);
-int smb_vfs_call_aio_fsync(struct vfs_handle_struct *handle,
-                          struct files_struct *fsp, int op,
-                          SMB_STRUCT_AIOCB *aiocb);
-int smb_vfs_call_aio_suspend(struct vfs_handle_struct *handle,
-                            struct files_struct *fsp,
-                            const SMB_STRUCT_AIOCB * const aiocb[], int n,
-                            const struct timespec *timeout);
 bool smb_vfs_call_aio_force(struct vfs_handle_struct *handle,
                            struct files_struct *fsp);
 bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
@@ -1133,6 +1148,22 @@ bool smb_vfs_call_is_offline(struct vfs_handle_struct *handle,
                             SMB_STRUCT_STAT *sbuf);
 int smb_vfs_call_set_offline(struct vfs_handle_struct *handle,
                             const struct smb_filename *fname);
+NTSTATUS smb_vfs_call_durable_cookie(struct vfs_handle_struct *handle,
+                                    struct files_struct *fsp,
+                                    TALLOC_CTX *mem_ctx,
+                                    DATA_BLOB *cookie);
+NTSTATUS smb_vfs_call_durable_disconnect(struct vfs_handle_struct *handle,
+                                        struct files_struct *fsp,
+                                        const DATA_BLOB old_cookie,
+                                        TALLOC_CTX *mem_ctx,
+                                        DATA_BLOB *new_cookie);
+NTSTATUS smb_vfs_call_durable_reconnect(struct vfs_handle_struct *handle,
+                                       struct smb_request *smb1req,
+                                       struct smbXsrv_open *op,
+                                       const DATA_BLOB old_cookie,
+                                       TALLOC_CTX *mem_ctx,
+                                       struct files_struct **fsp,
+                                       DATA_BLOB *new_cookie);
 
 NTSTATUS smb_register_vfs(int version, const char *name,
                          const struct vfs_fn_pointers *fns);