2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 3 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #ifndef __LOCKING_SHARE_MODE_LOCK_H__
17 #define __LOCKING_SHARE_MODE_LOCK_H__
21 #include "librpc/gen_ndr/file_id.h"
22 #include "lib/util/time.h"
24 struct share_mode_data;
25 struct share_mode_lock;
26 struct share_mode_entry;
29 struct smb2_lease_key;
31 bool locking_init(void);
32 bool locking_init_readonly(void);
33 bool locking_end(void);
35 struct file_id share_mode_lock_file_id(const struct share_mode_lock *lck);
37 struct share_mode_lock *get_share_mode_lock(
40 const char *servicepath,
41 const struct smb_filename *smb_fname,
42 const struct timespec *old_write_time);
43 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
46 bool del_share_mode(struct share_mode_lock *lck,
47 struct files_struct *fsp);
48 bool downgrade_share_oplock(struct share_mode_lock *lck,
49 struct files_struct *fsp);
50 bool remove_share_oplock(struct share_mode_lock *lck,
51 struct files_struct *fsp);
52 bool file_has_read_lease(struct files_struct *fsp);
55 struct share_mode_lock *lck,
56 struct files_struct *fsp,
60 const struct smb2_lease_key *lease_key,
61 uint32_t share_access,
62 uint32_t access_mask);
63 bool reset_share_mode_entry(
64 struct share_mode_lock *lck,
65 struct server_id old_pid,
66 uint64_t old_share_file_id,
67 struct server_id new_pid,
69 uint64_t new_share_file_id);
71 bool mark_share_mode_disconnected(
72 struct share_mode_lock *lck, struct files_struct *fsp);
74 struct share_mode_lock *fetch_share_mode_unlocked(
78 struct tevent_req *fetch_share_mode_send(
80 struct tevent_context *ev,
83 NTSTATUS fetch_share_mode_recv(
84 struct tevent_req *req,
86 struct share_mode_lock **_lck);
88 int share_entry_forall(
89 int (*fn)(struct file_id fid,
90 const struct share_mode_data *data,
91 const struct share_mode_entry *entry,
95 NTSTATUS share_mode_count_entries(struct file_id fid, size_t *num_share_modes);
96 int share_mode_forall(
97 int (*fn)(struct file_id fid,
98 const struct share_mode_data *data,
101 bool share_mode_forall_entries(
102 struct share_mode_lock *lck,
103 bool (*fn)(struct share_mode_entry *e,
108 NTTIME share_mode_changed_write_time(struct share_mode_lock *lck);
109 void share_mode_set_changed_write_time(struct share_mode_lock *lck, struct timespec write_time);
110 void share_mode_set_old_write_time(struct share_mode_lock *lck, struct timespec write_time);
111 const char *share_mode_servicepath(struct share_mode_lock *lck);
112 char *share_mode_filename(TALLOC_CTX *mem_ctx, struct share_mode_lock *lck);
113 char *share_mode_data_dump(
114 TALLOC_CTX *mem_ctx, struct share_mode_lock *lck);
116 void share_mode_flags_get(
117 struct share_mode_lock *lck,
118 uint32_t *access_mask,
119 uint32_t *share_mode,
120 uint32_t *lease_type);
121 void share_mode_flags_set(
122 struct share_mode_lock *lck,
123 uint32_t access_mask,
128 struct tevent_req *share_mode_watch_send(
130 struct tevent_context *ev,
131 struct share_mode_lock *lck,
132 struct server_id blocker);
133 NTSTATUS share_mode_watch_recv(
134 struct tevent_req *req, bool *blockerdead, struct server_id *blocker);
135 NTSTATUS share_mode_wakeup_waiters(struct file_id id);
137 typedef void (*share_mode_do_locked_vfs_fn_t)(
138 struct share_mode_lock *lck,
140 NTSTATUS _share_mode_do_locked_vfs_denied(
142 share_mode_do_locked_vfs_fn_t fn,
144 const char *location);
145 #define share_mode_do_locked_vfs_denied(__id, __fn, __private_data) \
146 _share_mode_do_locked_vfs_denied(__id, __fn, __private_data, __location__)
147 NTSTATUS _share_mode_do_locked_vfs_allowed(
149 share_mode_do_locked_vfs_fn_t fn,
151 const char *location);
152 #define share_mode_do_locked_vfs_allowed(__id, __fn, __private_data) \
153 _share_mode_do_locked_vfs_allowed(__id, __fn, __private_data, __location__)