Be more forgiving on client oplock break failure (as Windows does). Remove a global.
[Samba/ekacnet.git] / source3 / smbd / globals.h
blobad175bc4209100a231392efe94b33af810ad1c6e
1 /*
2 Unix SMB/Netbios implementation.
3 smbd globals
4 Copyright (C) Stefan Metzmacher 2009
5 Copyright (C) Jeremy Allison 2010
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #if defined(WITH_AIO)
22 struct aio_extra;
23 extern struct aio_extra *aio_list_head;
24 extern struct tevent_signal *aio_signal_event;
25 extern int aio_pending_size;
26 extern int outstanding_aio_calls;
27 #endif
29 #ifdef USE_DMAPI
30 struct smbd_dmapi_context;
31 extern struct smbd_dmapi_context *dmapi_ctx;
32 #endif
34 extern bool dfree_broken;
36 /* how many write cache buffers have been allocated */
37 extern unsigned int allocated_write_caches;
39 extern int real_max_open_files;
40 extern struct bitmap *file_bmap;
41 extern files_struct *Files;
42 extern int files_used;
43 /* A singleton cache to speed up searching by dev/inode. */
44 struct fsp_singleton_cache {
45 files_struct *fsp;
46 struct file_id id;
48 extern struct fsp_singleton_cache fsp_fi_cache;
49 extern unsigned long file_gen_counter;
50 extern int first_file;
52 extern const struct mangle_fns *mangle_fns;
54 extern unsigned char *chartest;
55 extern TDB_CONTEXT *tdb_mangled_cache;
57 /* these tables are used to provide fast tests for characters */
58 extern unsigned char char_flags[256];
60 this determines how many characters are used from the original filename
61 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
62 The largest possible value is 6.
64 extern unsigned mangle_prefix;
65 extern unsigned char base_reverse[256];
67 extern char *last_from;
68 extern char *last_to;
70 struct msg_state;
71 extern struct msg_state *smbd_msg_state;
73 extern bool logged_ioctl_message;
75 extern int trans_num;
77 extern pid_t mypid;
78 extern time_t last_smb_conf_reload_time;
79 extern time_t last_printer_reload_time;
80 /****************************************************************************
81 structure to hold a linked list of queued messages.
82 for processing.
83 ****************************************************************************/
84 struct pending_message_list;
85 extern struct pending_message_list *deferred_open_queue;
86 extern uint32_t common_flags2;
88 struct smb_srv_trans_enc_ctx;
89 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
90 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
92 struct sec_ctx {
93 UNIX_USER_TOKEN ut;
94 NT_USER_TOKEN *token;
96 /* A stack of security contexts. We include the current context as being
97 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
98 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
99 extern int sec_ctx_stack_ndx;
100 extern bool become_uid_done;
101 extern bool become_gid_done;
103 extern connection_struct *last_conn;
104 extern uint16_t last_flags;
106 extern uint32_t global_client_caps;
108 extern uint16_t fnf_handle;
110 struct conn_ctx {
111 connection_struct *conn;
112 uint16 vuid;
114 /* A stack of current_user connection contexts. */
115 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
116 extern int conn_ctx_stack_ndx;
118 struct vfs_init_function_entry;
119 extern struct vfs_init_function_entry *backends;
120 extern char *sparse_buf;
122 /* Current number of oplocks we have outstanding. */
123 extern int32_t exclusive_oplocks_open;
124 extern int32_t level_II_oplocks_open;
125 extern struct kernel_oplocks *koplocks;
127 extern int am_parent;
128 extern int server_fd;
129 extern struct event_context *smbd_event_ctx;
130 extern struct messaging_context *smbd_msg_ctx;
131 extern struct memcache *smbd_memcache_ctx;
132 extern bool exit_firsttime;
133 struct child_pid;
134 extern struct child_pid *children;
135 extern int num_children;
137 struct tstream_context;
138 struct smbd_smb2_request;
139 struct smbd_smb2_session;
140 struct smbd_smb2_tcon;
142 DATA_BLOB negprot_spnego(void);
144 void smbd_lock_socket(struct smbd_server_connection *sconn);
145 void smbd_unlock_socket(struct smbd_server_connection *sconn);
147 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
148 struct iovec *vector,
149 int count);
150 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
151 const struct iovec *vector,
152 int count);
154 NTSTATUS smbd_do_locking(struct smb_request *req,
155 files_struct *fsp,
156 uint8_t type,
157 int32_t timeout,
158 uint16_t num_ulocks,
159 struct smbd_lock_element *ulocks,
160 uint16_t num_locks,
161 struct smbd_lock_element *locks,
162 bool *async);
164 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
165 TALLOC_CTX *mem_ctx,
166 uint16_t info_level,
167 files_struct *fsp,
168 struct smb_filename *smb_fname,
169 bool delete_pending,
170 struct timespec write_time_ts,
171 struct ea_list *ea_list,
172 int lock_data_count,
173 char *lock_data,
174 uint16_t flags2,
175 unsigned int max_data_bytes,
176 char **ppdata,
177 unsigned int *pdata_size);
179 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
180 struct smb_request *req,
181 TALLOC_CTX *mem_ctx,
182 uint16_t info_level,
183 files_struct *fsp,
184 struct smb_filename *smb_fname,
185 char **ppdata, int total_data,
186 int *ret_data_size);
188 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
189 TALLOC_CTX *mem_ctx,
190 uint16_t info_level,
191 uint16_t flags2,
192 unsigned int max_data_bytes,
193 char **ppdata,
194 int *ret_data_len);
196 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
197 struct dptr_struct *dirptr,
198 const char *mask,
199 uint32_t dirtype,
200 bool dont_descend,
201 bool ask_sharemode,
202 bool (*match_fn)(TALLOC_CTX *ctx,
203 void *private_data,
204 const char *dname,
205 const char *mask,
206 char **_fname),
207 bool (*mode_fn)(TALLOC_CTX *ctx,
208 void *private_data,
209 struct smb_filename *smb_fname,
210 uint32_t *_mode),
211 void *private_data,
212 char **_fname,
213 struct smb_filename **_smb_fname,
214 uint32_t *_mode,
215 long *_prev_offset);
217 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
218 connection_struct *conn,
219 struct dptr_struct *dirptr,
220 uint16 flags2,
221 const char *path_mask,
222 uint32 dirtype,
223 int info_level,
224 int requires_resume_key,
225 bool dont_descend,
226 bool ask_sharemode,
227 uint8_t align,
228 bool do_pad,
229 char **ppdata,
230 char *base_data,
231 char *end_data,
232 int space_remaining,
233 bool *out_of_space,
234 bool *got_exact_match,
235 int *_last_entry_off,
236 struct ea_list *name_list);
238 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
239 const struct smb_filename *smb_fname,
240 uint32_t access_mask,
241 uint32_t *access_granted);
243 void smbd_notify_cancel_by_smbreq(struct smbd_server_connection *sconn,
244 const struct smb_request *smbreq);
246 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
247 const char *reason,
248 const char *location);
249 #define smbd_server_connection_terminate(sconn, reason) \
250 smbd_server_connection_terminate_ex(sconn, reason, __location__)
252 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
254 void reply_smb2002(struct smb_request *req, uint16_t choice);
255 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
256 const uint8_t *inbuf, size_t size);
258 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
259 NTSTATUS status,
260 DATA_BLOB *info,
261 const char *location);
262 #define smbd_smb2_request_error(req, status) \
263 smbd_smb2_request_error_ex(req, status, NULL, __location__)
264 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
265 NTSTATUS status,
266 DATA_BLOB body, DATA_BLOB *dyn,
267 const char *location);
268 #define smbd_smb2_request_done(req, body, dyn) \
269 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
271 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
272 uint64_t file_id_volatile,
273 uint8_t oplock_level);
275 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
276 struct tevent_req *subreq);
278 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
281 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
291 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
294 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
295 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
296 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
297 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
302 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
303 struct tevent_immediate *im,
304 void *private_data);
306 /* SMB1 -> SMB2 glue. */
307 void send_break_message_smb2(files_struct *fsp, int level);
308 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
309 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
310 struct smb_request *req,
311 files_struct *fsp,
312 int lock_timeout,
313 int lock_num,
314 uint64_t smblctx,
315 enum brl_type lock_type,
316 enum brl_flavour lock_flav,
317 uint64_t offset,
318 uint64_t count,
319 uint64_t blocking_smblctx);
320 void process_blocking_lock_queue_smb2(struct timeval tv_curr);
321 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
322 struct byte_range_lock *br_lck,
323 enum file_close_type close_type);
324 /* From smbd/smb2_create.c */
325 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
326 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
327 struct timeval *p_request_time,
328 void **pp_state);
329 bool open_was_deferred_smb2(uint64_t mid);
330 void remove_deferred_open_message_smb2(uint64_t mid);
331 void schedule_deferred_open_message_smb2(uint64_t mid);
332 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
333 struct timeval request_time,
334 struct timeval timeout,
335 struct file_id id,
336 char *private_data,
337 size_t priv_len);
339 struct smbd_smb2_request {
340 struct smbd_smb2_request *prev, *next;
342 TALLOC_CTX *mem_pool;
343 struct smbd_smb2_request **parent;
345 struct smbd_server_connection *sconn;
347 /* the session the request operates on, maybe NULL */
348 struct smbd_smb2_session *session;
350 /* the tcon the request operates on, maybe NULL */
351 struct smbd_smb2_tcon *tcon;
353 int current_idx;
354 bool do_signing;
355 bool async;
356 bool cancelled;
358 struct files_struct *compat_chain_fsp;
360 NTSTATUS next_status;
363 * The sub request for async backend calls.
364 * This is used for SMB2 Cancel.
366 struct tevent_req *subreq;
368 struct {
369 /* the NBT header is not allocated */
370 uint8_t nbt_hdr[4];
372 * vector[0] NBT
374 * vector[1] SMB2
375 * vector[2] fixed body
376 * vector[3] dynamic body
380 * vector[4] SMB2
381 * vector[5] fixed body
382 * vector[6] dynamic body
387 struct iovec *vector;
388 int vector_count;
389 } in;
390 struct {
391 /* the NBT header is not allocated */
392 uint8_t nbt_hdr[4];
394 * vector[0] NBT
396 * vector[1] SMB2
397 * vector[2] fixed body
398 * vector[3] dynamic body
402 * vector[4] SMB2
403 * vector[5] fixed body
404 * vector[6] dynamic body
409 struct iovec *vector;
410 int vector_count;
411 } out;
414 struct smbd_server_connection;
416 struct smbd_smb2_session {
417 struct smbd_smb2_session *prev, *next;
418 struct smbd_server_connection *sconn;
419 NTSTATUS status;
420 uint64_t vuid;
421 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
422 struct auth_serversupplied_info *server_info;
423 DATA_BLOB session_key;
424 bool do_signing;
426 user_struct *compat_vuser;
428 struct {
429 /* an id tree used to allocate tids */
430 struct idr_context *idtree;
432 /* this is the limit of tid values for this connection */
433 uint32_t limit;
435 struct smbd_smb2_tcon *list;
436 } tcons;
439 struct smbd_smb2_tcon {
440 struct smbd_smb2_tcon *prev, *next;
441 struct smbd_smb2_session *session;
442 uint32_t tid;
443 int snum;
444 connection_struct *compat_conn;
447 struct pending_auth_data;
449 struct smbd_server_connection {
450 const struct tsocket_address *local_address;
451 const struct tsocket_address *remote_address;
452 struct {
453 bool got_session;
454 } nbt;
455 bool allow_smb2;
456 struct {
457 struct fd_event *fde;
459 struct {
461 * fd for the fcntl lock mutexing access to smbd_server_fd
463 int socket_lock_fd;
466 * fd for the trusted pipe from
467 * echo handler child
469 int trusted_fd;
472 * fde for the trusted_fd
474 struct fd_event *trusted_fde;
477 * Reference count for the fcntl lock to
478 * allow recursive locks.
480 int ref_count;
481 } echo_handler;
483 uint64_t num_requests;
484 struct {
485 bool encrypted_passwords;
486 bool spnego;
487 struct auth_context *auth_context;
488 bool done;
490 * Size of the data we can receive. Set by us.
491 * Can be modified by the max xmit parameter.
493 int max_recv;
494 } negprot;
496 struct {
497 bool done_sesssetup;
499 * Size of data we can send to client. Set
500 * by the client for all protocols above CORE.
501 * Set by us for CORE protocol.
503 int max_send;
504 uint16_t last_session_tag;
506 /* users from session setup */
507 char *session_userlist;
508 /* workgroup from session setup. */
509 char *session_workgroup;
511 * this holds info on user ids that are already
512 * validated for this VC
514 user_struct *validated_users;
515 uint16_t next_vuid;
516 int num_validated_vuids;
517 #ifdef HAVE_NETGROUP
518 char *my_yp_domain;
519 #endif
520 } sessions;
521 struct {
522 connection_struct *Connections;
523 /* number of open connections */
524 struct bitmap *bmap;
525 int num_open;
526 } tcons;
527 struct smb_signing_state *signing_state;
528 /* List to store partial SPNEGO auth fragments. */
529 struct pending_auth_data *pd_list;
531 struct notify_mid_map *notify_mid_maps;
533 struct {
534 struct bitmap *dptr_bmap;
535 struct dptr_struct *dirptrs;
536 int dirhandles_open;
537 } searches;
538 struct {
539 /* dlink list we store pending lock records on. */
540 struct blocking_lock_record *blocking_lock_queue;
541 /* dlink list we move cancelled lock records onto. */
542 struct blocking_lock_record *blocking_lock_cancelled_queue;
544 /* The event that makes us process our blocking lock queue */
545 struct timed_event *brl_timeout;
547 bool blocking_lock_unlock_state;
548 bool blocking_lock_cancel_state;
549 } locks;
550 } smb1;
551 struct {
552 struct tevent_context *event_ctx;
553 struct tevent_queue *recv_queue;
554 struct tevent_queue *send_queue;
555 struct tstream_context *stream;
556 struct {
557 /* an id tree used to allocate vuids */
558 /* this holds info on session vuids that are already
559 * validated for this VC */
560 struct idr_context *idtree;
562 /* this is the limit of vuid values for this connection */
563 uint64_t limit;
565 struct smbd_smb2_session *list;
566 } sessions;
567 struct {
568 /* The event that makes us process our blocking lock queue */
569 struct timed_event *brl_timeout;
570 bool blocking_lock_unlock_state;
571 } locks;
572 struct smbd_smb2_request *requests;
573 } smb2;
576 extern struct smbd_server_connection *smbd_server_conn;
578 void smbd_init_globals(void);