2 * Unix SMB/CIFS implementation.
5 * Copyright (C) Andrew Tridgell 1992-2000
6 * Copyright (C) Jeremy Allison 1992-2006
7 * Copyright (C) Volker Lendecke 2005
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #ifndef _LOCKING_PROTO_H_
24 #define _LOCKING_PROTO_H_
26 /* The following definitions come from locking/brlock.c */
28 void brl_init(bool read_only);
29 void brl_shutdown(void);
31 unsigned int brl_num_locks(const struct byte_range_lock *brl);
32 struct files_struct *brl_fsp(struct byte_range_lock *brl);
33 bool brl_have_read_oplocks(const struct byte_range_lock *brl);
34 void brl_set_have_read_oplocks(struct byte_range_lock *brl,
35 bool have_read_oplocks);
37 NTSTATUS brl_lock_windows_default(struct byte_range_lock *br_lck,
38 struct lock_struct *plock,
41 NTSTATUS brl_lock(struct messaging_context *msg_ctx,
42 struct byte_range_lock *br_lck,
47 enum brl_type lock_type,
48 enum brl_flavour lock_flav,
51 bool brl_unlock(struct messaging_context *msg_ctx,
52 struct byte_range_lock *br_lck,
57 enum brl_flavour lock_flav);
58 bool brl_unlock_windows_default(struct messaging_context *msg_ctx,
59 struct byte_range_lock *br_lck,
60 const struct lock_struct *plock);
61 bool brl_locktest(struct byte_range_lock *br_lck,
66 enum brl_type lock_type,
67 enum brl_flavour lock_flav);
68 NTSTATUS brl_lockquery(struct byte_range_lock *br_lck,
73 enum brl_type *plock_type,
74 enum brl_flavour lock_flav);
75 bool brl_lock_cancel(struct byte_range_lock *br_lck,
80 enum brl_flavour lock_flav,
81 struct blocking_lock_record *blr);
82 bool brl_lock_cancel_default(struct byte_range_lock *br_lck,
83 struct lock_struct *plock);
84 bool brl_mark_disconnected(struct files_struct *fsp);
85 bool brl_reconnect_disconnected(struct files_struct *fsp);
86 void brl_close_fnum(struct messaging_context *msg_ctx,
87 struct byte_range_lock *br_lck);
88 int brl_forall(void (*fn)(struct file_id id, struct server_id pid,
89 enum brl_type lock_type,
90 enum brl_flavour lock_flav,
91 br_off start, br_off size,
94 struct byte_range_lock *brl_get_locks(TALLOC_CTX *mem_ctx,
96 struct byte_range_lock *brl_get_locks_readonly(files_struct *fsp);
97 void brl_revalidate(struct messaging_context *msg_ctx,
100 struct server_id server_id,
102 bool brl_cleanup_disconnected(struct file_id fid, uint64_t open_persistent_id);
104 /* The following definitions come from locking/locking.c */
106 const char *lock_type_name(enum brl_type lock_type);
107 const char *lock_flav_name(enum brl_flavour lock_flav);
108 void init_strict_lock_struct(files_struct *fsp,
112 enum brl_type lock_type,
113 struct lock_struct *plock);
114 bool strict_lock_default(files_struct *fsp,
115 struct lock_struct *plock);
116 void strict_unlock_default(files_struct *fsp,
117 struct lock_struct *plock);
118 NTSTATUS query_lock(files_struct *fsp,
122 enum brl_type *plock_type,
123 enum brl_flavour lock_flav);
124 struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
129 enum brl_type lock_type,
130 enum brl_flavour lock_flav,
134 struct blocking_lock_record *blr);
135 NTSTATUS do_unlock(struct messaging_context *msg_ctx,
140 enum brl_flavour lock_flav);
141 NTSTATUS do_lock_cancel(files_struct *fsp,
145 enum brl_flavour lock_flav,
146 struct blocking_lock_record *blr);
147 void locking_close_file(struct messaging_context *msg_ctx,
149 enum file_close_type close_type);
150 bool locking_init(void);
151 bool locking_init_readonly(void);
152 bool locking_end(void);
153 char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e);
154 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
156 struct share_mode_lock *get_share_mode_lock(
159 const char *servicepath,
160 const struct smb_filename *smb_fname,
161 const struct timespec *old_write_time);
162 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
164 bool rename_share_filename(struct messaging_context *msg_ctx,
165 struct share_mode_lock *lck,
167 const char *servicepath,
168 uint32_t orig_name_hash,
169 uint32_t new_name_hash,
170 const struct smb_filename *smb_fname);
171 void get_file_infos(struct file_id id,
173 bool *delete_on_close,
174 struct timespec *write_time);
175 bool is_valid_share_mode_entry(const struct share_mode_entry *e);
176 bool share_mode_stale_pid(struct share_mode_data *d, uint32_t idx);
177 bool set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
178 uid_t uid, uint64_t mid, uint16 op_type);
179 void remove_stale_share_mode_entries(struct share_mode_data *d);
180 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp);
181 bool mark_share_mode_disconnected(struct share_mode_lock *lck,
182 struct files_struct *fsp);
183 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
184 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
185 bool get_delete_on_close_token(struct share_mode_lock *lck,
187 const struct security_token **pp_nt_tok,
188 const struct security_unix_token **pp_tok);
189 void set_delete_on_close_lck(files_struct *fsp,
190 struct share_mode_lock *lck,
191 bool delete_on_close,
192 const struct security_token *nt_tok,
193 const struct security_unix_token *tok);
194 bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
195 const struct security_token *nt_tok,
196 const struct security_unix_token *tok);
197 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash);
198 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time);
199 bool set_write_time(struct file_id fileid, struct timespec write_time);
200 struct timespec get_share_mode_write_time(struct share_mode_lock *lck);
201 int share_mode_forall(void (*fn)(const struct share_mode_entry *, const char *,
202 const char *, void *),
204 bool share_mode_cleanup_disconnected(struct file_id id,
205 uint64_t open_persistent_id);
208 /* The following definitions come from locking/posix.c */
210 bool is_posix_locked(files_struct *fsp,
213 enum brl_type *plock_type,
214 enum brl_flavour lock_flav);
215 bool posix_locking_init(bool read_only);
216 bool posix_locking_end(void);
217 int fd_close_posix(struct files_struct *fsp);
218 bool set_posix_lock_windows_flavour(files_struct *fsp,
221 enum brl_type lock_type,
222 const struct lock_context *lock_ctx,
223 const struct lock_struct *plocks,
226 bool release_posix_lock_windows_flavour(files_struct *fsp,
229 enum brl_type deleted_lock_type,
230 const struct lock_context *lock_ctx,
231 const struct lock_struct *plocks,
233 bool set_posix_lock_posix_flavour(files_struct *fsp,
236 enum brl_type lock_type,
238 bool release_posix_lock_posix_flavour(files_struct *fsp,
241 const struct lock_context *lock_ctx,
242 const struct lock_struct *plocks,
245 #endif /* _LOCKING_PROTO_H_ */