s3: Make SMB2_GETINFO multi-volume aware.
[Samba.git] / source3 / smbd / globals.h
blob730bb7e4ecb99e33eda31e48aceb89c03241a57d
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 char **ppdata,
166 unsigned int *pdata_size);
168 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
169 struct smb_request *req,
170 TALLOC_CTX *mem_ctx,
171 uint16_t info_level,
172 files_struct *fsp,
173 struct smb_filename *smb_fname,
174 char **ppdata, int total_data,
175 int *ret_data_size);
177 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
178 TALLOC_CTX *mem_ctx,
179 uint16_t info_level,
180 uint16_t flags2,
181 unsigned int max_data_bytes,
182 struct smb_filename *smb_fname,
183 char **ppdata,
184 int *ret_data_len);
186 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
187 struct dptr_struct *dirptr,
188 const char *mask,
189 uint32_t dirtype,
190 bool dont_descend,
191 bool ask_sharemode,
192 bool (*match_fn)(TALLOC_CTX *ctx,
193 void *private_data,
194 const char *dname,
195 const char *mask,
196 char **_fname),
197 bool (*mode_fn)(TALLOC_CTX *ctx,
198 void *private_data,
199 struct smb_filename *smb_fname,
200 uint32_t *_mode),
201 void *private_data,
202 char **_fname,
203 struct smb_filename **_smb_fname,
204 uint32_t *_mode,
205 long *_prev_offset);
207 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
208 connection_struct *conn,
209 struct dptr_struct *dirptr,
210 uint16 flags2,
211 const char *path_mask,
212 uint32 dirtype,
213 int info_level,
214 int requires_resume_key,
215 bool dont_descend,
216 bool ask_sharemode,
217 uint8_t align,
218 bool do_pad,
219 char **ppdata,
220 char *base_data,
221 char *end_data,
222 int space_remaining,
223 bool *out_of_space,
224 bool *got_exact_match,
225 int *_last_entry_off,
226 struct ea_list *name_list);
228 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
229 const struct smb_filename *smb_fname,
230 bool file_existed,
231 uint32_t access_mask,
232 uint32_t *access_mask_out);
233 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
234 const struct smb_filename *smb_fname,
235 uint32_t access_mask,
236 uint32_t *access_granted);
238 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
240 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
241 const char *reason,
242 const char *location);
243 #define smbd_server_connection_terminate(sconn, reason) \
244 smbd_server_connection_terminate_ex(sconn, reason, __location__)
246 struct server_id sconn_server_id(const struct smbd_server_connection *sconn);
248 const char *smb2_opcode_name(uint16_t opcode);
249 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
251 void reply_smb2002(struct smb_request *req, uint16_t choice);
252 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
253 const uint8_t *inbuf, size_t size);
255 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
256 NTSTATUS status,
257 DATA_BLOB *info,
258 const char *location);
259 #define smbd_smb2_request_error(req, status) \
260 smbd_smb2_request_error_ex(req, status, NULL, __location__)
261 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
262 NTSTATUS status,
263 DATA_BLOB body, DATA_BLOB *dyn,
264 const char *location);
265 #define smbd_smb2_request_done(req, body, dyn) \
266 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
268 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
269 uint64_t file_id_persistent,
270 uint64_t file_id_volatile,
271 uint8_t oplock_level);
273 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
274 struct tevent_req *subreq);
276 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
279 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
280 void remove_smb2_chained_fsp(files_struct *fsp);
282 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
283 size_t expected_body_size);
285 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
291 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
292 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
293 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
294 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
295 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
296 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
297 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
306 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
307 struct tevent_immediate *im,
308 void *private_data);
310 /* SMB1 -> SMB2 glue. */
311 void send_break_message_smb2(files_struct *fsp, int level);
312 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
313 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
314 struct smb_request *req,
315 files_struct *fsp,
316 int lock_timeout,
317 int lock_num,
318 uint64_t smblctx,
319 enum brl_type lock_type,
320 enum brl_flavour lock_flav,
321 uint64_t offset,
322 uint64_t count,
323 uint64_t blocking_smblctx);
324 void process_blocking_lock_queue_smb2(
325 struct smbd_server_connection *sconn, struct timeval tv_curr);
326 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
327 struct byte_range_lock *br_lck,
328 enum file_close_type close_type);
329 /* From smbd/smb2_create.c */
330 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
331 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
332 struct timeval *p_request_time,
333 void **pp_state);
334 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
335 uint64_t mid);
336 void remove_deferred_open_message_smb2(
337 struct smbd_server_connection *sconn, uint64_t mid);
338 void schedule_deferred_open_message_smb2(
339 struct smbd_server_connection *sconn, uint64_t mid);
340 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
341 struct timeval request_time,
342 struct timeval timeout,
343 struct file_id id,
344 char *private_data,
345 size_t priv_len);
347 struct smbd_smb2_request {
348 struct smbd_smb2_request *prev, *next;
350 TALLOC_CTX *mem_pool;
351 struct smbd_smb2_request **parent;
353 struct smbd_server_connection *sconn;
355 /* the session the request operates on, maybe NULL */
356 struct smbd_smb2_session *session;
357 uint64_t last_session_id;
359 /* the tcon the request operates on, maybe NULL */
360 struct smbd_smb2_tcon *tcon;
361 uint32_t last_tid;
363 int current_idx;
364 bool do_signing;
365 bool async;
366 bool cancelled;
367 bool compound_related;
369 /* fake smb1 request. */
370 struct smb_request *smb1req;
371 struct files_struct *compat_chain_fsp;
374 * The sub request for async backend calls.
375 * This is used for SMB2 Cancel.
377 struct tevent_req *subreq;
379 struct {
380 /* the NBT header is not allocated */
381 uint8_t nbt_hdr[4];
383 * vector[0] NBT
385 * vector[1] SMB2
386 * vector[2] fixed body
387 * vector[3] dynamic body
391 * vector[4] SMB2
392 * vector[5] fixed body
393 * vector[6] dynamic body
398 struct iovec *vector;
399 int vector_count;
400 } in;
401 struct {
402 /* the NBT header is not allocated */
403 uint8_t nbt_hdr[4];
405 * vector[0] NBT
407 * vector[1] SMB2
408 * vector[2] fixed body
409 * vector[3] dynamic body
413 * vector[4] SMB2
414 * vector[5] fixed body
415 * vector[6] dynamic body
420 struct iovec *vector;
421 int vector_count;
422 } out;
425 struct smbd_server_connection;
427 struct smbd_smb2_session {
428 struct smbd_smb2_session *prev, *next;
429 struct smbd_server_connection *sconn;
430 NTSTATUS status;
431 uint64_t vuid;
432 struct auth_ntlmssp_state *auth_ntlmssp_state;
433 struct auth_serversupplied_info *session_info;
434 DATA_BLOB session_key;
435 bool do_signing;
437 user_struct *compat_vuser;
439 struct {
440 /* an id tree used to allocate tids */
441 struct idr_context *idtree;
443 /* this is the limit of tid values for this connection */
444 uint32_t limit;
446 struct smbd_smb2_tcon *list;
447 } tcons;
450 struct smbd_smb2_tcon {
451 struct smbd_smb2_tcon *prev, *next;
452 struct smbd_smb2_session *session;
453 uint32_t tid;
454 int snum;
455 connection_struct *compat_conn;
458 struct pending_auth_data;
460 struct smbd_server_connection {
461 int sock;
462 struct client_address client_id;
463 const struct tsocket_address *local_address;
464 const struct tsocket_address *remote_address;
465 struct messaging_context *msg_ctx;
466 struct {
467 bool got_session;
468 } nbt;
469 bool using_smb2;
470 int trans_num;
473 * Cache for calling poll(2) to avoid allocations in our
474 * central event loop
476 struct pollfd *pfds;
478 struct files_struct *files;
479 struct bitmap *file_bmap;
480 int real_max_open_files;
481 int files_used;
482 struct fsp_singleton_cache fsp_fi_cache;
483 unsigned long file_gen_counter;
484 int first_file;
486 /* number of open connections (tcons) */
487 int num_tcons_open;
489 /* open directory handles. */
490 struct {
491 struct bitmap *dptr_bmap;
492 struct dptr_struct *dirptrs;
493 int dirhandles_open;
494 } searches;
496 uint64_t num_requests;
498 struct {
499 struct fd_event *fde;
501 struct {
503 * fd for the fcntl lock mutexing access to our sock
505 int socket_lock_fd;
508 * fd for the trusted pipe from
509 * echo handler child
511 int trusted_fd;
514 * fde for the trusted_fd
516 struct fd_event *trusted_fde;
519 * Reference count for the fcntl lock to
520 * allow recursive locks.
522 int ref_count;
523 } echo_handler;
525 struct {
526 bool encrypted_passwords;
527 bool spnego;
528 struct auth_context *auth_context;
529 bool done;
531 * Size of the data we can receive. Set by us.
532 * Can be modified by the max xmit parameter.
534 int max_recv;
535 } negprot;
537 struct {
538 bool done_sesssetup;
540 * Size of data we can send to client. Set
541 * by the client for all protocols above CORE.
542 * Set by us for CORE protocol.
544 int max_send;
545 uint16_t last_session_tag;
547 /* users from session setup */
548 char *session_userlist;
549 /* workgroup from session setup. */
550 char *session_workgroup;
552 * this holds info on user ids that are already
553 * validated for this VC
555 user_struct *validated_users;
556 uint16_t next_vuid;
557 int num_validated_vuids;
558 } sessions;
559 struct {
560 connection_struct *Connections;
561 /* number of open connections */
562 struct bitmap *bmap;
563 } tcons;
564 struct smb_signing_state *signing_state;
565 /* List to store partial SPNEGO auth fragments. */
566 struct pending_auth_data *pd_list;
568 struct notify_mid_map *notify_mid_maps;
570 struct {
571 /* dlink list we store pending lock records on. */
572 struct blocking_lock_record *blocking_lock_queue;
573 /* dlink list we move cancelled lock records onto. */
574 struct blocking_lock_record *blocking_lock_cancelled_queue;
576 /* The event that makes us process our blocking lock queue */
577 struct timed_event *brl_timeout;
579 bool blocking_lock_unlock_state;
580 bool blocking_lock_cancel_state;
581 } locks;
582 } smb1;
583 struct {
584 struct tevent_context *event_ctx;
585 struct tevent_queue *recv_queue;
586 struct tevent_queue *send_queue;
587 struct tstream_context *stream;
588 struct {
589 /* an id tree used to allocate vuids */
590 /* this holds info on session vuids that are already
591 * validated for this VC */
592 struct idr_context *idtree;
594 /* this is the limit of vuid values for this connection */
595 uint64_t limit;
597 struct smbd_smb2_session *list;
598 } sessions;
599 struct {
600 /* The event that makes us process our blocking lock queue */
601 struct timed_event *brl_timeout;
602 bool blocking_lock_unlock_state;
603 } locks;
604 struct smbd_smb2_request *requests;
606 * seqnum_low is the lowest sequence number
607 * we will accept.
609 uint64_t seqnum_low;
611 * seqnum_range is the range of credits we have
612 * granted from the sequence windows starting
613 * at seqnum_low.
615 * This gets incremented when new credits are
616 * granted and gets decremented when the
617 * lowest sequence number is consumed
618 * (when seqnum_low gets incremented).
620 uint16_t seqnum_range;
622 * credits_grantedThe number of credits we have currently granted
623 * to the client.
625 * This gets incremented when new credits are
626 * granted and gets decremented when any credit
627 * is comsumed.
629 * Note: the decrementing is different compared
630 * to seqnum_range.
632 uint16_t credits_granted;
634 * The maximum number of credits we will ever
635 * grant to the client.
637 * Typically we will only grant 1/16th of
638 * max_credits.
640 * This is the "server max credits" parameter.
642 uint16_t max_credits;
644 * a bitmap of size max_credits
646 struct bitmap *credits_bitmap;
647 uint32_t max_trans;
648 uint32_t max_read;
649 uint32_t max_write;
650 bool compound_related_in_progress;
651 } smb2;
654 extern struct smbd_server_connection *smbd_server_conn;
656 struct smbd_server_connection *msg_ctx_to_sconn(struct messaging_context *msg_ctx);
658 void smbd_init_globals(void);