VERSION: Bump version up to 3.6.20.
[Samba.git] / source3 / smbd / globals.h
blob8cec74c854dc5ecfd9a84351db22eb7101bc1d41
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 #include "system/select.h"
23 #if defined(WITH_AIO)
24 struct aio_extra;
25 extern struct aio_extra *aio_list_head;
26 extern struct tevent_signal *aio_signal_event;
27 extern int aio_pending_size;
28 extern int outstanding_aio_calls;
29 #endif
31 #ifdef USE_DMAPI
32 struct smbd_dmapi_context;
33 extern struct smbd_dmapi_context *dmapi_ctx;
34 #endif
36 extern bool dfree_broken;
38 /* how many write cache buffers have been allocated */
39 extern unsigned int allocated_write_caches;
41 /* A singleton cache to speed up searching by dev/inode. */
42 struct fsp_singleton_cache {
43 files_struct *fsp;
44 struct file_id id;
47 extern const struct mangle_fns *mangle_fns;
49 extern unsigned char *chartest;
50 struct tdb_context;
51 extern struct tdb_context *tdb_mangled_cache;
54 this determines how many characters are used from the original filename
55 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
56 The largest possible value is 6.
58 extern unsigned mangle_prefix;
60 struct msg_state;
61 extern struct msg_state *smbd_msg_state;
63 extern bool logged_ioctl_message;
65 extern int trans_num;
67 extern time_t last_smb_conf_reload_time;
68 extern time_t last_printer_reload_time;
69 /****************************************************************************
70 structure to hold a linked list of queued messages.
71 for processing.
72 ****************************************************************************/
73 struct pending_message_list;
74 extern struct pending_message_list *deferred_open_queue;
75 extern uint32_t common_flags2;
77 struct smb_srv_trans_enc_ctx;
78 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
79 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
81 struct sec_ctx {
82 struct security_unix_token ut;
83 struct security_token *token;
85 /* A stack of security contexts. We include the current context as being
86 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
87 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
88 extern int sec_ctx_stack_ndx;
89 extern bool become_uid_done;
90 extern bool become_gid_done;
92 extern connection_struct *last_conn;
93 extern uint16_t last_flags;
95 extern uint32_t global_client_caps;
97 extern uint16_t fnf_handle;
99 struct conn_ctx {
100 connection_struct *conn;
101 uint16 vuid;
103 /* A stack of current_user connection contexts. */
104 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
105 extern int conn_ctx_stack_ndx;
107 struct vfs_init_function_entry;
108 extern struct vfs_init_function_entry *backends;
109 extern char *sparse_buf;
110 extern char *LastDir;
112 /* Current number of oplocks we have outstanding. */
113 extern int32_t exclusive_oplocks_open;
114 extern int32_t level_II_oplocks_open;
115 extern struct kernel_oplocks *koplocks;
117 extern int am_parent;
118 extern struct event_context *smbd_event_ctx;
119 extern struct messaging_context *smbd_msg_ctx;
120 extern struct memcache *smbd_memcache_ctx;
121 extern bool exit_firsttime;
122 struct child_pid;
123 extern struct child_pid *children;
124 extern int num_children;
126 struct tstream_context;
127 struct smbd_smb2_request;
128 struct smbd_smb2_session;
129 struct smbd_smb2_tcon;
131 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
133 void smbd_lock_socket(struct smbd_server_connection *sconn);
134 void smbd_unlock_socket(struct smbd_server_connection *sconn);
136 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
137 struct iovec *vector,
138 int count);
139 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
140 const struct iovec *vector,
141 int count);
143 NTSTATUS smbd_do_locking(struct smb_request *req,
144 files_struct *fsp,
145 uint8_t type,
146 int32_t timeout,
147 uint16_t num_ulocks,
148 struct smbd_lock_element *ulocks,
149 uint16_t num_locks,
150 struct smbd_lock_element *locks,
151 bool *async);
153 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
154 TALLOC_CTX *mem_ctx,
155 uint16_t info_level,
156 files_struct *fsp,
157 struct smb_filename *smb_fname,
158 bool delete_pending,
159 struct timespec write_time_ts,
160 struct ea_list *ea_list,
161 int lock_data_count,
162 char *lock_data,
163 uint16_t flags2,
164 unsigned int max_data_bytes,
165 size_t *fixed_portion,
166 char **ppdata,
167 unsigned int *pdata_size);
169 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
170 struct smb_request *req,
171 TALLOC_CTX *mem_ctx,
172 uint16_t info_level,
173 files_struct *fsp,
174 struct smb_filename *smb_fname,
175 char **ppdata, int total_data,
176 int *ret_data_size);
178 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
179 TALLOC_CTX *mem_ctx,
180 uint16_t info_level,
181 uint16_t flags2,
182 unsigned int max_data_bytes,
183 size_t *fixed_portion,
184 struct smb_filename *smb_fname,
185 char **ppdata,
186 int *ret_data_len);
188 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
189 struct dptr_struct *dirptr,
190 const char *mask,
191 uint32_t dirtype,
192 bool dont_descend,
193 bool ask_sharemode,
194 bool (*match_fn)(TALLOC_CTX *ctx,
195 void *private_data,
196 const char *dname,
197 const char *mask,
198 char **_fname),
199 bool (*mode_fn)(TALLOC_CTX *ctx,
200 void *private_data,
201 struct smb_filename *smb_fname,
202 uint32_t *_mode),
203 void *private_data,
204 char **_fname,
205 struct smb_filename **_smb_fname,
206 uint32_t *_mode,
207 long *_prev_offset);
209 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
210 connection_struct *conn,
211 struct dptr_struct *dirptr,
212 uint16 flags2,
213 const char *path_mask,
214 uint32 dirtype,
215 int info_level,
216 int requires_resume_key,
217 bool dont_descend,
218 bool ask_sharemode,
219 uint8_t align,
220 bool do_pad,
221 char **ppdata,
222 char *base_data,
223 char *end_data,
224 int space_remaining,
225 bool *out_of_space,
226 bool *got_exact_match,
227 int *_last_entry_off,
228 struct ea_list *name_list);
230 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
231 const struct smb_filename *smb_fname,
232 bool file_existed,
233 uint32_t access_mask,
234 uint32_t *access_mask_out);
235 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
236 const struct smb_filename *smb_fname,
237 uint32_t access_mask,
238 uint32_t *access_granted);
240 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
242 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
243 const char *reason,
244 const char *location);
245 #define smbd_server_connection_terminate(sconn, reason) \
246 smbd_server_connection_terminate_ex(sconn, reason, __location__)
248 struct server_id sconn_server_id(const struct smbd_server_connection *sconn);
250 const char *smb2_opcode_name(uint16_t opcode);
251 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
253 void reply_smb2002(struct smb_request *req, uint16_t choice);
254 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
255 const uint8_t *inbuf, size_t size);
257 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
258 NTSTATUS status,
259 DATA_BLOB *info,
260 const char *location);
261 #define smbd_smb2_request_error(req, status) \
262 smbd_smb2_request_error_ex(req, status, NULL, __location__)
263 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
264 NTSTATUS status,
265 DATA_BLOB body, DATA_BLOB *dyn,
266 const char *location);
267 #define smbd_smb2_request_done(req, body, dyn) \
268 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
270 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
271 uint64_t file_id_persistent,
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);
282 void remove_smb2_chained_fsp(files_struct *fsp);
284 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
285 size_t expected_body_size);
287 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
291 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
294 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
295 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
296 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
297 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
298 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
299 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
308 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
309 struct tevent_immediate *im,
310 void *private_data);
312 /* SMB1 -> SMB2 glue. */
313 void send_break_message_smb2(files_struct *fsp, int level);
314 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
315 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
316 struct smb_request *req,
317 files_struct *fsp,
318 int lock_timeout,
319 int lock_num,
320 uint64_t smblctx,
321 enum brl_type lock_type,
322 enum brl_flavour lock_flav,
323 uint64_t offset,
324 uint64_t count,
325 uint64_t blocking_smblctx);
326 void process_blocking_lock_queue_smb2(
327 struct smbd_server_connection *sconn, struct timeval tv_curr);
328 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
329 struct byte_range_lock *br_lck,
330 enum file_close_type close_type);
331 /* From smbd/smb2_create.c */
332 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
333 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
334 struct timeval *p_request_time,
335 void **pp_state);
336 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
337 uint64_t mid);
338 void remove_deferred_open_message_smb2(
339 struct smbd_server_connection *sconn, uint64_t mid);
340 void schedule_deferred_open_message_smb2(
341 struct smbd_server_connection *sconn, uint64_t mid);
342 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
343 struct timeval request_time,
344 struct timeval timeout,
345 struct file_id id,
346 char *private_data,
347 size_t priv_len);
349 struct smbd_smb2_request {
350 struct smbd_smb2_request *prev, *next;
352 TALLOC_CTX *mem_pool;
353 struct smbd_smb2_request **parent;
355 struct smbd_server_connection *sconn;
357 /* the session the request operates on, maybe NULL */
358 struct smbd_smb2_session *session;
359 uint64_t last_session_id;
361 /* the tcon the request operates on, maybe NULL */
362 struct smbd_smb2_tcon *tcon;
363 uint32_t last_tid;
365 int current_idx;
366 bool do_signing;
367 bool async;
368 bool cancelled;
369 bool compound_related;
371 /* fake smb1 request. */
372 struct smb_request *smb1req;
373 struct files_struct *compat_chain_fsp;
376 * The sub request for async backend calls.
377 * This is used for SMB2 Cancel.
379 struct tevent_req *subreq;
381 struct {
382 /* the NBT header is not allocated */
383 uint8_t nbt_hdr[4];
385 * vector[0] NBT
387 * vector[1] SMB2
388 * vector[2] fixed body
389 * vector[3] dynamic body
393 * vector[4] SMB2
394 * vector[5] fixed body
395 * vector[6] dynamic body
400 struct iovec *vector;
401 int vector_count;
402 } in;
403 struct {
404 /* the NBT header is not allocated */
405 uint8_t nbt_hdr[4];
407 * vector[0] NBT
409 * vector[1] SMB2
410 * vector[2] fixed body
411 * vector[3] dynamic body
415 * vector[4] SMB2
416 * vector[5] fixed body
417 * vector[6] dynamic body
422 struct iovec *vector;
423 int vector_count;
424 } out;
427 struct smbd_server_connection;
429 struct smbd_smb2_session {
430 struct smbd_smb2_session *prev, *next;
431 struct smbd_server_connection *sconn;
432 NTSTATUS status;
433 uint64_t vuid;
434 struct auth_ntlmssp_state *auth_ntlmssp_state;
435 struct auth_serversupplied_info *session_info;
436 DATA_BLOB session_key;
437 bool do_signing;
439 user_struct *compat_vuser;
441 struct {
442 /* an id tree used to allocate tids */
443 struct idr_context *idtree;
445 /* this is the limit of tid values for this connection */
446 uint32_t limit;
448 struct smbd_smb2_tcon *list;
449 } tcons;
452 struct smbd_smb2_tcon {
453 struct smbd_smb2_tcon *prev, *next;
454 struct smbd_smb2_session *session;
455 uint32_t tid;
456 int snum;
457 connection_struct *compat_conn;
460 struct pending_auth_data;
462 struct smbd_server_connection {
463 int sock;
464 struct client_address client_id;
465 const struct tsocket_address *local_address;
466 const struct tsocket_address *remote_address;
467 struct messaging_context *msg_ctx;
468 struct {
469 bool got_session;
470 } nbt;
471 bool using_smb2;
472 int trans_num;
475 * Cache for calling poll(2) to avoid allocations in our
476 * central event loop
478 struct pollfd *pfds;
480 struct files_struct *files;
481 struct bitmap *file_bmap;
482 int real_max_open_files;
483 int files_used;
484 struct fsp_singleton_cache fsp_fi_cache;
485 unsigned long file_gen_counter;
486 int first_file;
488 /* number of open connections (tcons) */
489 int num_tcons_open;
491 /* open directory handles. */
492 struct {
493 struct bitmap *dptr_bmap;
494 struct dptr_struct *dirptrs;
495 int dirhandles_open;
496 } searches;
498 uint64_t num_requests;
500 struct {
501 struct fd_event *fde;
503 struct {
505 * fd for the fcntl lock mutexing access to our sock
507 int socket_lock_fd;
510 * fd for the trusted pipe from
511 * echo handler child
513 int trusted_fd;
516 * fde for the trusted_fd
518 struct fd_event *trusted_fde;
521 * Reference count for the fcntl lock to
522 * allow recursive locks.
524 int ref_count;
525 } echo_handler;
527 struct {
528 bool encrypted_passwords;
529 bool spnego;
530 struct auth_context *auth_context;
531 bool done;
533 * Size of the data we can receive. Set by us.
534 * Can be modified by the max xmit parameter.
536 int max_recv;
537 } negprot;
539 struct {
540 bool done_sesssetup;
542 * Size of data we can send to client. Set
543 * by the client for all protocols above CORE.
544 * Set by us for CORE protocol.
546 int max_send;
547 uint16_t last_session_tag;
549 /* users from session setup */
550 char *session_userlist;
551 /* workgroup from session setup. */
552 char *session_workgroup;
554 * this holds info on user ids that are already
555 * validated for this VC
557 user_struct *validated_users;
558 uint16_t next_vuid;
559 int num_validated_vuids;
560 } sessions;
561 struct {
562 connection_struct *Connections;
563 /* number of open connections */
564 struct bitmap *bmap;
565 } tcons;
566 struct smb_signing_state *signing_state;
567 /* List to store partial SPNEGO auth fragments. */
568 struct pending_auth_data *pd_list;
570 struct notify_mid_map *notify_mid_maps;
572 struct {
573 /* dlink list we store pending lock records on. */
574 struct blocking_lock_record *blocking_lock_queue;
575 /* dlink list we move cancelled lock records onto. */
576 struct blocking_lock_record *blocking_lock_cancelled_queue;
578 /* The event that makes us process our blocking lock queue */
579 struct timed_event *brl_timeout;
581 bool blocking_lock_unlock_state;
582 bool blocking_lock_cancel_state;
583 } locks;
584 } smb1;
585 struct {
586 struct tevent_context *event_ctx;
587 struct tevent_queue *recv_queue;
588 struct tevent_queue *send_queue;
589 struct tstream_context *stream;
590 struct {
591 /* an id tree used to allocate vuids */
592 /* this holds info on session vuids that are already
593 * validated for this VC */
594 struct idr_context *idtree;
596 /* this is the limit of vuid values for this connection */
597 uint64_t limit;
599 struct smbd_smb2_session *list;
600 } sessions;
601 struct {
602 /* The event that makes us process our blocking lock queue */
603 struct timed_event *brl_timeout;
604 bool blocking_lock_unlock_state;
605 } locks;
606 struct smbd_smb2_request *requests;
608 * seqnum_low is the lowest sequence number
609 * we will accept.
611 uint64_t seqnum_low;
613 * seqnum_range is the range of credits we have
614 * granted from the sequence windows starting
615 * at seqnum_low.
617 * This gets incremented when new credits are
618 * granted and gets decremented when the
619 * lowest sequence number is consumed
620 * (when seqnum_low gets incremented).
622 uint16_t seqnum_range;
624 * credits_grantedThe number of credits we have currently granted
625 * to the client.
627 * This gets incremented when new credits are
628 * granted and gets decremented when any credit
629 * is comsumed.
631 * Note: the decrementing is different compared
632 * to seqnum_range.
634 uint16_t credits_granted;
636 * The maximum number of credits we will ever
637 * grant to the client.
639 * Typically we will only grant 1/16th of
640 * max_credits.
642 * This is the "server max credits" parameter.
644 uint16_t max_credits;
646 * a bitmap of size max_credits
648 struct bitmap *credits_bitmap;
649 uint32_t max_trans;
650 uint32_t max_read;
651 uint32_t max_write;
652 } smb2;
655 extern struct smbd_server_connection *smbd_server_conn;
657 struct smbd_server_connection *msg_ctx_to_sconn(struct messaging_context *msg_ctx);
659 void smbd_init_globals(void);