s3:registry: let fill_subkey_cache return WERR_BADFILE when the subkey list could...
[Samba/gebeck_regimport.git] / source3 / locking / proto.h
blob54badd91498c3b188811e7a207f69cbb7305dd65
1 /*
2 * Unix SMB/CIFS implementation.
3 * Locking functions
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 bool brl_same_context(const struct lock_context *ctx1,
29 const struct lock_context *ctx2);
30 NTSTATUS brl_lock_failed(files_struct *fsp, const struct lock_struct *lock, bool blocking_lock);
31 void brl_init(bool read_only);
32 void brl_shutdown(void);
34 NTSTATUS brl_lock_windows_default(struct byte_range_lock *br_lck,
35 struct lock_struct *plock,
36 bool blocking_lock);
38 NTSTATUS brl_lock(struct messaging_context *msg_ctx,
39 struct byte_range_lock *br_lck,
40 uint64_t smblctx,
41 struct server_id pid,
42 br_off start,
43 br_off size,
44 enum brl_type lock_type,
45 enum brl_flavour lock_flav,
46 bool blocking_lock,
47 uint64_t *psmblctx,
48 struct blocking_lock_record *blr);
49 bool brl_unlock(struct messaging_context *msg_ctx,
50 struct byte_range_lock *br_lck,
51 uint64_t smblctx,
52 struct server_id pid,
53 br_off start,
54 br_off size,
55 enum brl_flavour lock_flav);
56 bool brl_unlock_windows_default(struct messaging_context *msg_ctx,
57 struct byte_range_lock *br_lck,
58 const struct lock_struct *plock);
59 bool brl_locktest(struct byte_range_lock *br_lck,
60 uint64_t smblctx,
61 struct server_id pid,
62 br_off start,
63 br_off size,
64 enum brl_type lock_type,
65 enum brl_flavour lock_flav);
66 NTSTATUS brl_lockquery(struct byte_range_lock *br_lck,
67 uint64_t *psmblctx,
68 struct server_id pid,
69 br_off *pstart,
70 br_off *psize,
71 enum brl_type *plock_type,
72 enum brl_flavour lock_flav);
73 bool brl_lock_cancel(struct byte_range_lock *br_lck,
74 uint64_t smblctx,
75 struct server_id pid,
76 br_off start,
77 br_off size,
78 enum brl_flavour lock_flav,
79 struct blocking_lock_record *blr);
80 bool brl_lock_cancel_default(struct byte_range_lock *br_lck,
81 struct lock_struct *plock);
82 void brl_close_fnum(struct messaging_context *msg_ctx,
83 struct byte_range_lock *br_lck);
84 int brl_forall(void (*fn)(struct file_id id, struct server_id pid,
85 enum brl_type lock_type,
86 enum brl_flavour lock_flav,
87 br_off start, br_off size,
88 void *private_data),
89 void *private_data);
90 struct byte_range_lock *brl_get_locks(TALLOC_CTX *mem_ctx,
91 files_struct *fsp);
92 struct byte_range_lock *brl_get_locks_readonly(files_struct *fsp);
93 void brl_revalidate(struct messaging_context *msg_ctx,
94 void *private_data,
95 uint32_t msg_type,
96 struct server_id server_id,
97 DATA_BLOB *data);
99 /* The following definitions come from locking/locking.c */
101 const char *lock_type_name(enum brl_type lock_type);
102 const char *lock_flav_name(enum brl_flavour lock_flav);
103 void init_strict_lock_struct(files_struct *fsp,
104 uint64_t smblctx,
105 br_off start,
106 br_off size,
107 enum brl_type lock_type,
108 struct lock_struct *plock);
109 bool strict_lock_default(files_struct *fsp,
110 struct lock_struct *plock);
111 void strict_unlock_default(files_struct *fsp,
112 struct lock_struct *plock);
113 NTSTATUS query_lock(files_struct *fsp,
114 uint64_t *psmblctx,
115 uint64_t *pcount,
116 uint64_t *poffset,
117 enum brl_type *plock_type,
118 enum brl_flavour lock_flav);
119 struct byte_range_lock *do_lock(struct messaging_context *msg_ctx,
120 files_struct *fsp,
121 uint64_t smblctx,
122 uint64_t count,
123 uint64_t offset,
124 enum brl_type lock_type,
125 enum brl_flavour lock_flav,
126 bool blocking_lock,
127 NTSTATUS *perr,
128 uint64_t *psmblctx,
129 struct blocking_lock_record *blr);
130 NTSTATUS do_unlock(struct messaging_context *msg_ctx,
131 files_struct *fsp,
132 uint64_t smblctx,
133 uint64_t count,
134 uint64_t offset,
135 enum brl_flavour lock_flav);
136 NTSTATUS do_lock_cancel(files_struct *fsp,
137 uint64 smblctx,
138 uint64_t count,
139 uint64_t offset,
140 enum brl_flavour lock_flav,
141 struct blocking_lock_record *blr);
142 void locking_close_file(struct messaging_context *msg_ctx,
143 files_struct *fsp,
144 enum file_close_type close_type);
145 bool locking_init(void);
146 bool locking_init_readonly(void);
147 bool locking_end(void);
148 char *share_mode_str(TALLOC_CTX *ctx, int num, const struct share_mode_entry *e);
149 struct share_mode_lock *get_existing_share_mode_lock(TALLOC_CTX *mem_ctx,
150 const struct file_id id);
151 struct share_mode_lock *get_share_mode_lock(
152 TALLOC_CTX *mem_ctx,
153 const struct file_id id,
154 const char *servicepath,
155 const struct smb_filename *smb_fname,
156 const struct timespec *old_write_time);
157 struct share_mode_lock *fetch_share_mode_unlocked(TALLOC_CTX *mem_ctx,
158 const struct file_id id);
159 bool rename_share_filename(struct messaging_context *msg_ctx,
160 struct share_mode_lock *lck,
161 const char *servicepath,
162 uint32_t orig_name_hash,
163 uint32_t new_name_hash,
164 const struct smb_filename *smb_fname);
165 void get_file_infos(struct file_id id,
166 uint32_t name_hash,
167 bool *delete_on_close,
168 struct timespec *write_time);
169 bool is_valid_share_mode_entry(const struct share_mode_entry *e);
170 bool is_deferred_open_entry(const struct share_mode_entry *e);
171 void set_share_mode(struct share_mode_lock *lck, files_struct *fsp,
172 uid_t uid, uint64_t mid, uint16 op_type);
173 void add_deferred_open(struct share_mode_lock *lck, uint64_t mid,
174 struct timeval request_time,
175 struct server_id pid, struct file_id id);
176 bool del_share_mode(struct share_mode_lock *lck, files_struct *fsp);
177 void del_deferred_open_entry(struct share_mode_lock *lck, uint64_t mid,
178 struct server_id pid);
179 bool remove_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
180 bool downgrade_share_oplock(struct share_mode_lock *lck, files_struct *fsp);
181 bool get_delete_on_close_token(struct share_mode_lock *lck,
182 uint32_t name_hash,
183 const struct security_token **pp_nt_tok,
184 const struct security_unix_token **pp_tok);
185 void set_delete_on_close_lck(files_struct *fsp,
186 struct share_mode_lock *lck,
187 bool delete_on_close,
188 const struct security_token *nt_tok,
189 const struct security_unix_token *tok);
190 bool set_delete_on_close(files_struct *fsp, bool delete_on_close,
191 const struct security_token *nt_tok,
192 const struct security_unix_token *tok);
193 bool is_delete_on_close_set(struct share_mode_lock *lck, uint32_t name_hash);
194 bool set_sticky_write_time(struct file_id fileid, struct timespec write_time);
195 bool set_write_time(struct file_id fileid, struct timespec write_time);
196 int share_mode_forall(void (*fn)(const struct share_mode_entry *, const char *,
197 const char *, void *),
198 void *private_data);
200 /* The following definitions come from locking/posix.c */
202 bool is_posix_locked(files_struct *fsp,
203 uint64_t *pu_offset,
204 uint64_t *pu_count,
205 enum brl_type *plock_type,
206 enum brl_flavour lock_flav);
207 bool posix_locking_init(bool read_only);
208 bool posix_locking_end(void);
209 void reduce_windows_lock_ref_count(files_struct *fsp, unsigned int dcount);
210 int fd_close_posix(struct files_struct *fsp);
211 bool set_posix_lock_windows_flavour(files_struct *fsp,
212 uint64_t u_offset,
213 uint64_t u_count,
214 enum brl_type lock_type,
215 const struct lock_context *lock_ctx,
216 const struct lock_struct *plocks,
217 int num_locks,
218 int *errno_ret);
219 bool release_posix_lock_windows_flavour(files_struct *fsp,
220 uint64_t u_offset,
221 uint64_t u_count,
222 enum brl_type deleted_lock_type,
223 const struct lock_context *lock_ctx,
224 const struct lock_struct *plocks,
225 int num_locks);
226 bool set_posix_lock_posix_flavour(files_struct *fsp,
227 uint64_t u_offset,
228 uint64_t u_count,
229 enum brl_type lock_type,
230 int *errno_ret);
231 bool release_posix_lock_posix_flavour(files_struct *fsp,
232 uint64_t u_offset,
233 uint64_t u_count,
234 const struct lock_context *lock_ctx,
235 const struct lock_struct *plocks,
236 int num_locks);
238 #endif /* _LOCKING_PROTO_H_ */