smbd: Add share_mode_forall_leases()
[kai/samba-autobuild/.git] / source3 / locking / proto.h
index f5137f97d27b12b5e2775e59e4d5ff2925166084..9a9feffc0a4cd137d7fa6cec2eed28afcac6f50a 100644 (file)
@@ -29,6 +29,10 @@ 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);
+uint32_t brl_num_read_oplocks(const struct byte_range_lock *brl);
+void brl_set_num_read_oplocks(struct byte_range_lock *brl,
+                             uint32_t num_read_oplocks);
 
 NTSTATUS brl_lock_windows_default(struct byte_range_lock *br_lck,
                struct lock_struct *plock,
@@ -43,8 +47,7 @@ NTSTATUS brl_lock(struct messaging_context *msg_ctx,
                enum brl_type lock_type,
                enum brl_flavour lock_flav,
                bool blocking_lock,
-               uint64_t *psmblctx,
-               struct blocking_lock_record *blr);
+               uint64_t *psmblctx);
 bool brl_unlock(struct messaging_context *msg_ctx,
                struct byte_range_lock *br_lck,
                uint64_t smblctx,
@@ -56,12 +59,7 @@ bool brl_unlock_windows_default(struct messaging_context *msg_ctx,
                               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,
@@ -74,8 +72,7 @@ bool brl_lock_cancel(struct byte_range_lock *br_lck,
                struct server_id pid,
                br_off start,
                br_off size,
-               enum brl_flavour lock_flav,
-               struct blocking_lock_record *blr);
+               enum brl_flavour lock_flav);
 bool brl_lock_cancel_default(struct byte_range_lock *br_lck,
                struct lock_struct *plock);
 bool brl_mark_disconnected(struct files_struct *fsp);
@@ -108,10 +105,8 @@ 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,
@@ -127,8 +122,7 @@ struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
                        enum brl_flavour lock_flav,
                        bool blocking_lock,
                        NTSTATUS *perr,
-                       uint64_t *psmblctx,
-                       struct blocking_lock_record *blr);
+                       uint64_t *psmblctx);
 NTSTATUS do_unlock(struct messaging_context *msg_ctx,
                        files_struct *fsp,
                        uint64_t smblctx,
@@ -136,18 +130,19 @@ NTSTATUS do_unlock(struct messaging_context *msg_ctx,
                        uint64_t offset,
                        enum brl_flavour lock_flav);
 NTSTATUS do_lock_cancel(files_struct *fsp,
-                       uint64 smblctx,
+                       uint64_t smblctx,
                        uint64_t count,
                        uint64_t offset,
-                       enum brl_flavour lock_flav,
-                       struct blocking_lock_record *blr);
+                       enum brl_flavour lock_flav);
 void locking_close_file(struct messaging_context *msg_ctx,
                        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);
+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(
@@ -158,8 +153,16 @@ struct share_mode_lock *get_share_mode_lock(
        const struct timespec *old_write_time);
 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
                                                  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,
@@ -169,9 +172,17 @@ 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 share_mode_stale_pid(struct share_mode_data *d, unsigned idx);
-void set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
-                   uid_t uid, uint64_t mid, uint16 op_type);
+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,
+                   const struct GUID *client_guid,
+                   const struct smb2_lease_key *lease_key);
+struct share_mode_entry *find_share_mode_entry(struct share_mode_lock *lck,
+                                              files_struct *fsp);
+void remove_stale_share_mode_entries(struct share_mode_data *d);
 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp);
 bool mark_share_mode_disconnected(struct share_mode_lock *lck,
                                  struct files_struct *fsp);
@@ -181,9 +192,10 @@ 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,
@@ -192,11 +204,25 @@ bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
 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);
 
 
 /* The following definitions come from locking/posix.c  */
@@ -208,7 +234,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);
-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,
@@ -228,6 +254,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,
@@ -236,4 +263,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(const struct files_struct *fsp);
+uint32_t lease_type_is_exclusive(uint32_t lease_type);
+bool fsp_lease_type_is_exclusive(const struct files_struct *fsp);
+
 #endif /* _LOCKING_PROTO_H_ */