smbd: Add share_mode_forall_entries()
[samba.git] / source3 / locking / proto.h
index 5be8acc920c64b27c62659cf991c49a3faad3cb9..ae8768e68e91be96c9b6cd7db2a93bb2ca45e933 100644 (file)
 
 /* The following definitions come from locking/brlock.c  */
 
-bool brl_same_context(const struct lock_context *ctx1,
-                            const struct lock_context *ctx2);
-NTSTATUS brl_lock_failed(files_struct *fsp, const struct lock_struct *lock, bool blocking_lock);
 void brl_init(bool read_only);
 void brl_shutdown(void);
 
+unsigned int brl_num_locks(const struct byte_range_lock *brl);
+struct files_struct *brl_fsp(struct byte_range_lock *brl);
+TALLOC_CTX *brl_req_mem_ctx(const struct byte_range_lock *brl);
+const struct GUID *brl_req_guid(const struct byte_range_lock *brl);
+
+bool byte_range_valid(uint64_t ofs, uint64_t len);
+bool byte_range_overlap(uint64_t ofs1,
+                       uint64_t len1,
+                       uint64_t ofs2,
+                       uint64_t len2);
+
 NTSTATUS brl_lock_windows_default(struct byte_range_lock *br_lck,
-               struct lock_struct *plock,
-               bool blocking_lock);
+                                 struct lock_struct *plock);
 
-NTSTATUS brl_lock(struct messaging_context *msg_ctx,
-               struct byte_range_lock *br_lck,
-               uint64_t smblctx,
-               struct server_id pid,
-               br_off start,
-               br_off size,
-               enum brl_type lock_type,
-               enum brl_flavour lock_flav,
-               bool blocking_lock,
-               uint64_t *psmblctx,
-               struct blocking_lock_record *blr);
-bool brl_unlock(struct messaging_context *msg_ctx,
-               struct byte_range_lock *br_lck,
+NTSTATUS brl_lock(
+       struct byte_range_lock *br_lck,
+       uint64_t smblctx,
+       struct server_id pid,
+       br_off start,
+       br_off size,
+       enum brl_type lock_type,
+       enum brl_flavour lock_flav,
+       struct server_id *blocker_pid,
+       uint64_t *psmblctx);
+bool brl_unlock(struct byte_range_lock *br_lck,
                uint64_t smblctx,
                struct server_id pid,
                br_off start,
                br_off size,
                enum brl_flavour lock_flav);
-bool brl_unlock_windows_default(struct messaging_context *msg_ctx,
-                              struct byte_range_lock *br_lck,
-                              const struct lock_struct *plock);
+bool brl_unlock_windows_default(struct byte_range_lock *br_lck,
+                               const struct lock_struct *plock);
 bool brl_locktest(struct byte_range_lock *br_lck,
-               uint64_t smblctx,
-               struct server_id pid,
-               br_off start,
-               br_off size,
-               enum brl_type lock_type,
-               enum brl_flavour lock_flav);
+                 const struct lock_struct *rw_probe);
 NTSTATUS brl_lockquery(struct byte_range_lock *br_lck,
                uint64_t *psmblctx,
                struct server_id pid,
@@ -70,27 +69,23 @@ NTSTATUS brl_lockquery(struct byte_range_lock *br_lck,
                br_off *psize,
                enum brl_type *plock_type,
                enum brl_flavour lock_flav);
-bool brl_lock_cancel(struct byte_range_lock *br_lck,
-               uint64_t smblctx,
-               struct server_id pid,
-               br_off start,
-               br_off size,
-               enum brl_flavour lock_flav,
-               struct blocking_lock_record *blr);
-bool brl_lock_cancel_default(struct byte_range_lock *br_lck,
-               struct lock_struct *plock);
-void brl_close_fnum(struct messaging_context *msg_ctx,
-                   struct byte_range_lock *br_lck);
+bool brl_mark_disconnected(struct files_struct *fsp);
+bool brl_reconnect_disconnected(struct files_struct *fsp);
+void brl_close_fnum(struct byte_range_lock *br_lck);
 int brl_forall(void (*fn)(struct file_id id, struct server_id pid,
                          enum brl_type lock_type,
                          enum brl_flavour lock_flav,
                          br_off start, br_off size,
                          void *private_data),
               void *private_data);
+struct byte_range_lock *brl_get_locks_for_locking(TALLOC_CTX *mem_ctx,
+                                                 files_struct *fsp,
+                                                 TALLOC_CTX *req_mem_ctx,
+                                                 const struct GUID *req_guid);
 struct byte_range_lock *brl_get_locks(TALLOC_CTX *mem_ctx,
                                        files_struct *fsp);
 struct byte_range_lock *brl_get_locks_readonly(files_struct *fsp);
-void brl_register_msgs(struct messaging_context *msg_ctx);
+bool brl_cleanup_disconnected(struct file_id fid, uint64_t open_persistent_id);
 
 /* The following definitions come from locking/locking.c  */
 
@@ -102,55 +97,69 @@ void init_strict_lock_struct(files_struct *fsp,
                                br_off size,
                                enum brl_type lock_type,
                                struct lock_struct *plock);
-bool strict_lock_default(files_struct *fsp,
-                               struct lock_struct *plock);
-void strict_unlock_default(files_struct *fsp,
-                               struct lock_struct *plock);
+bool strict_lock_check_default(files_struct *fsp,
+                              struct lock_struct *plock);
 NTSTATUS query_lock(files_struct *fsp,
                        uint64_t *psmblctx,
                        uint64_t *pcount,
                        uint64_t *poffset,
                        enum brl_type *plock_type,
                        enum brl_flavour lock_flav);
-struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
-                       files_struct *fsp,
-                       uint64_t smblctx,
-                       uint64_t count,
-                       uint64_t offset,
-                       enum brl_type lock_type,
-                       enum brl_flavour lock_flav,
-                       bool blocking_lock,
-                       NTSTATUS *perr,
-                       uint64_t *psmblctx,
-                       struct blocking_lock_record *blr);
-NTSTATUS do_unlock(struct messaging_context *msg_ctx,
-                       files_struct *fsp,
-                       uint64_t smblctx,
-                       uint64_t count,
-                       uint64_t offset,
-                       enum brl_flavour lock_flav);
-NTSTATUS do_lock_cancel(files_struct *fsp,
-                       uint64 smblctx,
-                       uint64_t count,
-                       uint64_t offset,
-                       enum brl_flavour lock_flav,
-                       struct blocking_lock_record *blr);
-void locking_close_file(struct messaging_context *msg_ctx,
-                       files_struct *fsp,
+NTSTATUS do_lock(files_struct *fsp,
+                TALLOC_CTX *req_mem_ctx,
+                const struct GUID *req_guid,
+                uint64_t smblctx,
+                uint64_t count,
+                uint64_t offset,
+                enum brl_type lock_type,
+                enum brl_flavour lock_flav,
+                struct server_id *pblocker_pid,
+                uint64_t *psmblctx);
+NTSTATUS do_unlock(files_struct *fsp,
+                  uint64_t smblctx,
+                  uint64_t count,
+                  uint64_t offset,
+                  enum brl_flavour lock_flav);
+void locking_close_file(files_struct *fsp,
                        enum file_close_type close_type);
 bool locking_init(void);
 bool locking_init_readonly(void);
 bool locking_end(void);
-char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e);
-struct share_mode_lock *get_share_mode_lock(TALLOC_CTX *mem_ctx,
-                                           const struct file_id id,
-                                           const char *servicepath,
-                                           const struct smb_filename *smb_fname,
-                                           const struct timespec *old_write_time);
+char *share_mode_str(TALLOC_CTX *ctx, int num,
+                    const struct file_id *id,
+                    const struct share_mode_entry *e);
+struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
+                                                    struct file_id id);
+struct share_mode_lock *get_share_mode_lock(
+       TALLOC_CTX *mem_ctx,
+       struct file_id id,
+       const char *servicepath,
+       const struct smb_filename *smb_fname,
+       const struct timespec *old_write_time);
+
+bool file_has_read_lease(struct files_struct *fsp);
+
+struct db_record;
+NTSTATUS share_mode_do_locked(
+       struct file_id id,
+       void (*fn)(struct db_record *rec,
+                  bool *modified_dependent,
+                  void *private_data),
+       void *private_data);
+NTSTATUS share_mode_wakeup_waiters(struct file_id id);
+
 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
-                                                 const struct file_id id);
+                                                 struct file_id id);
+struct tevent_req *fetch_share_mode_send(TALLOC_CTX *mem_ctx,
+                                        struct tevent_context *ev,
+                                        struct file_id id,
+                                        bool *queued);
+NTSTATUS fetch_share_mode_recv(struct tevent_req *req,
+                              TALLOC_CTX *mem_ctx,
+                              struct share_mode_lock **_lck);
 bool rename_share_filename(struct messaging_context *msg_ctx,
                        struct share_mode_lock *lck,
+                       struct file_id id,
                        const char *servicepath,
                        uint32_t orig_name_hash,
                        uint32_t new_name_hash,
@@ -160,30 +169,67 @@ void get_file_infos(struct file_id id,
                    bool *delete_on_close,
                    struct timespec *write_time);
 bool is_valid_share_mode_entry(const struct share_mode_entry *e);
-bool is_deferred_open_entry(const struct share_mode_entry *e);
-bool is_unused_share_mode_entry(const struct share_mode_entry *e);
-void set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
-                   uid_t uid, uint64_t mid, uint16 op_type);
-void add_deferred_open(struct share_mode_lock *lck, uint64_t mid,
-                      struct timeval request_time,
-                      struct server_id pid, struct file_id id);
+bool share_entry_stale_pid(struct share_mode_entry *e);
+bool share_mode_stale_pid(struct share_mode_data *d, uint32_t idx);
+bool set_share_mode(struct share_mode_lock *lck,
+                   struct files_struct *fsp,
+                   uid_t uid,
+                   uint64_t mid,
+                   uint16_t op_type,
+                   uint32_t share_access,
+                   uint32_t access_mask);
+NTSTATUS remove_lease_if_stale(const struct share_mode_data *d,
+                              const struct GUID *client_guid,
+                              const struct smb2_lease_key *lease_key);
+void remove_stale_share_mode_entries(struct share_mode_data *d);
 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp);
-void del_deferred_open_entry(struct share_mode_lock *lck, uint64_t mid,
-                            struct server_id pid);
+bool mark_share_mode_disconnected(struct share_mode_lock *lck,
+                                 struct files_struct *fsp);
 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
-const struct security_unix_token *get_delete_on_close_token(struct share_mode_lock *lck, uint32_t name_hash);
+bool get_delete_on_close_token(struct share_mode_lock *lck,
+                               uint32_t name_hash,
+                               const struct security_token **pp_nt_tok,
+                               const struct security_unix_token **pp_tok);
+void reset_delete_on_close_lck(files_struct *fsp,
+                              struct share_mode_lock *lck);
 void set_delete_on_close_lck(files_struct *fsp,
                        struct share_mode_lock *lck,
-                       bool delete_on_close,
+                       const struct security_token *nt_tok,
+                       const struct security_unix_token *tok);
+bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
+                       const struct security_token *nt_tok,
                        const struct security_unix_token *tok);
-bool set_delete_on_close(files_struct *fsp, bool delete_on_close, const struct security_unix_token *tok);
 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash);
 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time);
 bool set_write_time(struct file_id fileid, struct timespec write_time);
-int share_mode_forall(void (*fn)(const struct share_mode_entry *, const char *,
-                                const char *, void *),
+struct timespec get_share_mode_write_time(struct share_mode_lock *lck);
+bool file_has_open_streams(files_struct *fsp);
+int share_mode_forall(int (*fn)(struct file_id fid,
+                               const struct share_mode_data *data,
+                               void *private_data),
                      void *private_data);
+int share_entry_forall(int (*fn)(struct file_id fid,
+                                const struct share_mode_data *data,
+                                const struct share_mode_entry *entry,
+                                void *private_data),
+                     void *private_data);
+bool share_mode_cleanup_disconnected(struct file_id id,
+                                    uint64_t open_persistent_id);
+bool share_mode_forall_leases(
+       struct share_mode_lock *lck,
+       bool (*fn)(struct share_mode_lock *lck,
+                  struct share_mode_entry *e,
+                  void *private_data),
+       void *private_data);
+
+bool share_mode_forall_entries(
+       struct share_mode_lock *lck,
+       bool (*fn)(struct share_mode_entry *e,
+                  bool *modified,
+                  void *private_data),
+       void *private_data);
+
 
 /* The following definitions come from locking/posix.c  */
 
@@ -194,8 +240,7 @@ bool is_posix_locked(files_struct *fsp,
                        enum brl_flavour lock_flav);
 bool posix_locking_init(bool read_only);
 bool posix_locking_end(void);
-void reduce_windows_lock_ref_count(files_struct *fsp, unsigned int dcount);
-int fd_close_posix(struct files_struct *fsp);
+int fd_close_posix(const struct files_struct *fsp);
 bool set_posix_lock_windows_flavour(files_struct *fsp,
                        uint64_t u_offset,
                        uint64_t u_count,
@@ -215,6 +260,7 @@ bool set_posix_lock_posix_flavour(files_struct *fsp,
                        uint64_t u_offset,
                        uint64_t u_count,
                        enum brl_type lock_type,
+                       const struct lock_context *lock_ctx,
                        int *errno_ret);
 bool release_posix_lock_posix_flavour(files_struct *fsp,
                                uint64_t u_offset,
@@ -223,4 +269,10 @@ bool release_posix_lock_posix_flavour(files_struct *fsp,
                                const struct lock_struct *plocks,
                                int num_locks);
 
+/* The following definitions come from locking/leases_util.c */
+uint32_t map_oplock_to_lease_type(uint16_t op_type);
+uint32_t fsp_lease_type(struct files_struct *fsp);
+bool fsp_lease_type_is_exclusive(struct files_struct *fsp);
+const struct GUID *fsp_client_guid(const files_struct *fsp);
+
 #endif /* _LOCKING_PROTO_H_ */