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,
62 const struct lock_struct *rw_probe);
63 NTSTATUS brl_lockquery(struct byte_range_lock *br_lck,
68 enum brl_type *plock_type,
69 enum brl_flavour lock_flav);
70 bool brl_lock_cancel(struct byte_range_lock *br_lck,
75 enum brl_flavour lock_flav);
76 bool brl_lock_cancel_default(struct byte_range_lock *br_lck,
77 struct lock_struct *plock);
78 bool brl_mark_disconnected(struct files_struct *fsp);
79 bool brl_reconnect_disconnected(struct files_struct *fsp);
80 void brl_close_fnum(struct messaging_context *msg_ctx,
81 struct byte_range_lock *br_lck);
82 int brl_forall(void (*fn)(struct file_id id, struct server_id pid,
83 enum brl_type lock_type,
84 enum brl_flavour lock_flav,
85 br_off start, br_off size,
88 struct byte_range_lock *brl_get_locks(TALLOC_CTX *mem_ctx,
90 struct byte_range_lock *brl_get_locks_readonly(files_struct *fsp);
91 void brl_revalidate(struct messaging_context *msg_ctx,
94 struct server_id server_id,
96 bool brl_cleanup_disconnected(struct file_id fid, uint64_t open_persistent_id);
98 /* The following definitions come from locking/locking.c */
100 const char *lock_type_name(enum brl_type lock_type);
101 const char *lock_flav_name(enum brl_flavour lock_flav);
102 void init_strict_lock_struct(files_struct *fsp,
106 enum brl_type lock_type,
107 struct lock_struct *plock);
108 bool strict_lock_default(files_struct *fsp,
109 struct lock_struct *plock);
110 void strict_unlock_default(files_struct *fsp,
111 struct lock_struct *plock);
112 NTSTATUS query_lock(files_struct *fsp,
116 enum brl_type *plock_type,
117 enum brl_flavour lock_flav);
118 struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
123 enum brl_type lock_type,
124 enum brl_flavour lock_flav,
128 NTSTATUS do_unlock(struct messaging_context *msg_ctx,
133 enum brl_flavour lock_flav);
134 NTSTATUS do_lock_cancel(files_struct *fsp,
138 enum brl_flavour lock_flav);
139 void locking_close_file(struct messaging_context *msg_ctx,
141 enum file_close_type close_type);
142 bool locking_init(void);
143 bool locking_init_readonly(void);
144 bool locking_end(void);
145 char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e);
146 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
148 struct share_mode_lock *get_share_mode_lock(
151 const char *servicepath,
152 const struct smb_filename *smb_fname,
153 const struct timespec *old_write_time);
154 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
156 bool rename_share_filename(struct messaging_context *msg_ctx,
157 struct share_mode_lock *lck,
159 const char *servicepath,
160 uint32_t orig_name_hash,
161 uint32_t new_name_hash,
162 const struct smb_filename *smb_fname);
163 void get_file_infos(struct file_id id,
165 bool *delete_on_close,
166 struct timespec *write_time);
167 bool is_valid_share_mode_entry(const struct share_mode_entry *e);
168 bool share_mode_stale_pid(struct share_mode_data *d, uint32_t idx);
169 bool set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
170 uid_t uid, uint64_t mid, uint16 op_type);
171 void remove_stale_share_mode_entries(struct share_mode_data *d);
172 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp);
173 bool mark_share_mode_disconnected(struct share_mode_lock *lck,
174 struct files_struct *fsp);
175 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
176 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
177 bool get_delete_on_close_token(struct share_mode_lock *lck,
179 const struct security_token **pp_nt_tok,
180 const struct security_unix_token **pp_tok);
181 void set_delete_on_close_lck(files_struct *fsp,
182 struct share_mode_lock *lck,
183 bool delete_on_close,
184 const struct security_token *nt_tok,
185 const struct security_unix_token *tok);
186 bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
187 const struct security_token *nt_tok,
188 const struct security_unix_token *tok);
189 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash);
190 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time);
191 bool set_write_time(struct file_id fileid, struct timespec write_time);
192 struct timespec get_share_mode_write_time(struct share_mode_lock *lck);
193 int share_mode_forall(int (*fn)(struct file_id fid,
194 const struct share_mode_data *data,
197 int share_entry_forall(void (*fn)(const struct share_mode_entry *, const char *,
198 const char *, void *),
200 bool share_mode_cleanup_disconnected(struct file_id id,
201 uint64_t open_persistent_id);
204 /* The following definitions come from locking/posix.c */
206 bool is_posix_locked(files_struct *fsp,
209 enum brl_type *plock_type,
210 enum brl_flavour lock_flav);
211 bool posix_locking_init(bool read_only);
212 bool posix_locking_end(void);
213 int fd_close_posix(struct files_struct *fsp);
214 bool set_posix_lock_windows_flavour(files_struct *fsp,
217 enum brl_type lock_type,
218 const struct lock_context *lock_ctx,
219 const struct lock_struct *plocks,
222 bool release_posix_lock_windows_flavour(files_struct *fsp,
225 enum brl_type deleted_lock_type,
226 const struct lock_context *lock_ctx,
227 const struct lock_struct *plocks,
229 bool set_posix_lock_posix_flavour(files_struct *fsp,
232 enum brl_type lock_type,
234 bool release_posix_lock_posix_flavour(files_struct *fsp,
237 const struct lock_context *lock_ctx,
238 const struct lock_struct *plocks,
241 #endif /* _LOCKING_PROTO_H_ */