smbd: Store "struct deferred_open_record" instead of anonymous data on pml
[Samba.git] / source3 / smbd / globals.h
blob28e4f94430373e8d8ad39167a266baed465dba0c
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"
22 #include "librpc/gen_ndr/smbXsrv.h"
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
27 #ifdef USE_DMAPI
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
30 #endif
32 extern bool dfree_broken;
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
37 /* A singleton cache to speed up searching by dev/inode. */
38 struct fsp_singleton_cache {
39 files_struct *fsp;
40 struct file_id id;
43 extern const struct mangle_fns *mangle_fns;
45 extern unsigned char *chartest;
46 struct tdb_context;
47 extern struct tdb_context *tdb_mangled_cache;
50 this determines how many characters are used from the original filename
51 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
52 The largest possible value is 6.
54 extern unsigned mangle_prefix;
56 struct msg_state;
58 extern bool logged_ioctl_message;
60 extern int trans_num;
62 extern time_t last_smb_conf_reload_time;
63 extern time_t last_printer_reload_time;
64 extern pid_t background_lpq_updater_pid;
66 /****************************************************************************
67 structure to hold a linked list of queued messages.
68 for processing.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
75 struct sec_ctx {
76 struct security_unix_token ut;
77 struct security_token *token;
79 /* A stack of security contexts. We include the current context as being
80 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
81 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
82 extern int sec_ctx_stack_ndx;
83 extern bool become_uid_done;
84 extern bool become_gid_done;
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
89 extern uint32_t global_client_caps;
91 extern uint16_t fnf_handle;
93 struct conn_ctx {
94 connection_struct *conn;
95 uint64_t vuid;
97 /* A stack of current_user connection contexts. */
98 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
99 extern int conn_ctx_stack_ndx;
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
106 struct smbd_parent_context;
107 extern struct smbd_parent_context *am_parent;
108 extern struct memcache *smbd_memcache_ctx;
109 extern bool exit_firsttime;
111 struct tstream_context;
112 struct smbd_smb2_request;
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
116 void smbd_lock_socket(struct smbd_server_connection *sconn);
117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
119 NTSTATUS smbd_do_locking(struct smb_request *req,
120 files_struct *fsp,
121 uint8_t type,
122 int32_t timeout,
123 uint16_t num_ulocks,
124 struct smbd_lock_element *ulocks,
125 uint16_t num_locks,
126 struct smbd_lock_element *locks,
127 bool *async);
129 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
130 TALLOC_CTX *mem_ctx,
131 uint16_t info_level,
132 files_struct *fsp,
133 struct smb_filename *smb_fname,
134 bool delete_pending,
135 struct timespec write_time_ts,
136 struct ea_list *ea_list,
137 int lock_data_count,
138 char *lock_data,
139 uint16_t flags2,
140 unsigned int max_data_bytes,
141 size_t *fixed_portion,
142 char **ppdata,
143 unsigned int *pdata_size);
145 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
146 struct smb_request *req,
147 TALLOC_CTX *mem_ctx,
148 uint16_t info_level,
149 files_struct *fsp,
150 struct smb_filename *smb_fname,
151 char **ppdata, int total_data,
152 int *ret_data_size);
154 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
155 TALLOC_CTX *mem_ctx,
156 uint16_t info_level,
157 uint16_t flags2,
158 unsigned int max_data_bytes,
159 size_t *fixed_portion,
160 struct smb_filename *smb_fname,
161 char **ppdata,
162 int *ret_data_len);
164 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
165 struct dptr_struct *dirptr,
166 const char *mask,
167 uint32_t dirtype,
168 bool dont_descend,
169 bool ask_sharemode,
170 bool (*match_fn)(TALLOC_CTX *ctx,
171 void *private_data,
172 const char *dname,
173 const char *mask,
174 char **_fname),
175 bool (*mode_fn)(TALLOC_CTX *ctx,
176 void *private_data,
177 struct smb_filename *smb_fname,
178 uint32_t *_mode),
179 void *private_data,
180 char **_fname,
181 struct smb_filename **_smb_fname,
182 uint32_t *_mode,
183 long *_prev_offset);
185 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
186 connection_struct *conn,
187 struct dptr_struct *dirptr,
188 uint16 flags2,
189 const char *path_mask,
190 uint32 dirtype,
191 int info_level,
192 int requires_resume_key,
193 bool dont_descend,
194 bool ask_sharemode,
195 uint8_t align,
196 bool do_pad,
197 char **ppdata,
198 char *base_data,
199 char *end_data,
200 int space_remaining,
201 bool *out_of_space,
202 bool *got_exact_match,
203 int *_last_entry_off,
204 struct ea_list *name_list);
206 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
207 const struct smb_filename *smb_fname,
208 bool use_privs,
209 uint32_t access_mask,
210 uint32_t *access_mask_out);
212 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
214 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
215 const char *reason,
216 const char *location);
217 #define smbd_server_connection_terminate(sconn, reason) \
218 smbd_server_connection_terminate_ex(sconn, reason, __location__)
220 const char *smb2_opcode_name(uint16_t opcode);
221 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
223 void reply_smb2002(struct smb_request *req, uint16_t choice);
224 void reply_smb20ff(struct smb_request *req, uint16_t choice);
225 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
226 uint8_t *inbuf, size_t size);
228 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
230 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
231 NTSTATUS status,
232 DATA_BLOB *info,
233 const char *location);
234 #define smbd_smb2_request_error(req, status) \
235 smbd_smb2_request_error_ex(req, status, NULL, __location__)
236 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
237 NTSTATUS status,
238 DATA_BLOB body, DATA_BLOB *dyn,
239 const char *location);
240 #define smbd_smb2_request_done(req, body, dyn) \
241 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
243 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
244 struct smbXsrv_session *session,
245 struct smbXsrv_tcon *tcon,
246 struct smbXsrv_open *op,
247 uint8_t oplock_level);
249 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
250 struct tevent_req *subreq,
251 uint32_t defer_time);
253 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
254 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
255 void remove_smb2_chained_fsp(files_struct *fsp);
257 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
258 uint32_t data_length);
260 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
261 size_t expected_body_size);
263 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
267 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
268 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
271 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
272 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
273 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
274 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
275 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
276 int err);
277 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
281 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
286 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
287 struct tevent_immediate *im,
288 void *private_data);
290 struct deferred_open_record;
292 /* SMB1 -> SMB2 glue. */
293 void send_break_message_smb2(files_struct *fsp, int level);
294 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
295 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
296 struct smb_request *req,
297 files_struct *fsp,
298 int lock_timeout,
299 int lock_num,
300 uint64_t smblctx,
301 enum brl_type lock_type,
302 enum brl_flavour lock_flav,
303 uint64_t offset,
304 uint64_t count,
305 uint64_t blocking_smblctx);
306 void process_blocking_lock_queue_smb2(
307 struct smbd_server_connection *sconn, struct timeval tv_curr);
308 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
309 struct byte_range_lock *br_lck,
310 enum file_close_type close_type);
311 /* From smbd/smb2_create.c */
312 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
313 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
314 struct timeval *p_request_time,
315 struct deferred_open_record **open_rec);
316 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
317 uint64_t mid);
318 void remove_deferred_open_message_smb2(
319 struct smbd_server_connection *sconn, uint64_t mid);
320 bool schedule_deferred_open_message_smb2(
321 struct smbd_server_connection *sconn, uint64_t mid);
322 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
323 struct timeval request_time,
324 struct timeval timeout,
325 struct file_id id,
326 struct deferred_open_record *open_rec);
328 struct smbXsrv_connection {
329 struct smbd_server_connection *sconn;
331 const struct tsocket_address *local_address;
332 const struct tsocket_address *remote_address;
333 const char *remote_hostname;
335 struct tevent_context *ev_ctx;
336 struct messaging_context *msg_ctx;
338 enum protocol_types protocol;
340 struct {
341 struct {
342 uint32_t capabilities;
343 struct GUID guid;
344 uint16_t security_mode;
345 uint16_t num_dialects;
346 uint16_t *dialects;
347 } client;
348 struct {
349 uint32_t capabilities;
350 struct GUID guid;
351 uint16_t security_mode;
352 uint16_t dialect;
353 uint32_t max_trans;
354 uint32_t max_read;
355 uint32_t max_write;
356 } server;
357 } smb2;
359 struct msg_state *msg_state;
362 * Link into libasys for asynchronous operations
364 struct asys_context *asys_ctx;
365 struct tevent_fd *asys_fde;
367 uint64_t smbd_idle_profstamp;
370 * this session_table is used for SMB1 and SMB2,
372 struct smbXsrv_session_table *session_table;
373 uint64_t last_session_id;
375 * this tcon_table is only used for SMB1.
377 struct smbXsrv_tcon_table *tcon_table;
379 * this open_table is used for SMB1 and SMB2,
380 * because we have a global sconn->real_max_open_files
381 * limit.
383 struct smbXsrv_open_table *open_table;
386 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
387 uint32_t smbXsrv_version_global_current(void);
389 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
390 enum protocol_types protocol);
392 NTSTATUS smbXsrv_session_global_init(void);
393 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
394 NTTIME now,
395 struct smbXsrv_session **_session);
396 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
397 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
398 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
399 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
400 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
401 uint16_t vuid, NTTIME now,
402 struct smbXsrv_session **session);
403 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
404 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
405 uint64_t session_id, NTTIME now,
406 struct smbXsrv_session **session);
407 struct smbXsrv_session_global0;
408 NTSTATUS smbXsrv_session_global_traverse(
409 int (*fn)(struct smbXsrv_session_global0 *, void *),
410 void *private_data);
411 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
412 struct tevent_context *ev,
413 struct smbXsrv_connection *conn,
414 struct auth_session_info *session_info,
415 uint64_t previous_session_id,
416 uint64_t current_session_id);
417 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
419 NTSTATUS smbXsrv_tcon_global_init(void);
420 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
421 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
422 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
423 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
424 NTTIME now,
425 struct smbXsrv_tcon **_tcon);
426 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
427 uint16_t tree_id, NTTIME now,
428 struct smbXsrv_tcon **tcon);
429 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
430 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
431 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
432 NTTIME now,
433 struct smbXsrv_tcon **_tcon);
434 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
435 uint32_t tree_id, NTTIME now,
436 struct smbXsrv_tcon **tcon);
437 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
438 struct smbXsrv_tcon_global0;
439 NTSTATUS smbXsrv_tcon_global_traverse(
440 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
441 void *private_data);
443 NTSTATUS smbXsrv_open_global_init(void);
444 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
445 struct auth_session_info *session_info,
446 NTTIME now,
447 struct smbXsrv_open **_open);
448 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
449 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
450 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
451 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
452 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
453 uint16_t fnum, NTTIME now,
454 struct smbXsrv_open **_open);
455 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
456 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
457 uint64_t persistent_id,
458 uint64_t volatile_id,
459 NTTIME now,
460 struct smbXsrv_open **_open);
461 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
462 struct auth_session_info *session_info,
463 uint64_t persistent_id,
464 const struct GUID *create_guid,
465 NTTIME now,
466 struct smbXsrv_open **_open);
467 struct smbXsrv_open_global0;
468 NTSTATUS smbXsrv_open_global_traverse(
469 int (*fn)(struct smbXsrv_open_global0 *, void *),
470 void *private_data);
472 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
474 struct smbd_smb2_send_queue {
475 struct smbd_smb2_send_queue *prev, *next;
477 DATA_BLOB *sendfile_header;
478 struct iovec *vector;
479 int count;
481 TALLOC_CTX *mem_ctx;
484 struct smbd_smb2_request {
485 struct smbd_smb2_request *prev, *next;
487 struct smbd_server_connection *sconn;
489 struct smbd_smb2_send_queue queue_entry;
491 /* the session the request operates on, maybe NULL */
492 struct smbXsrv_session *session;
493 uint64_t last_session_id;
495 /* the tcon the request operates on, maybe NULL */
496 struct smbXsrv_tcon *tcon;
497 uint32_t last_tid;
499 int current_idx;
500 bool do_signing;
501 bool do_encryption;
502 struct tevent_timer *async_te;
503 bool compound_related;
506 * the encryption key for the whole
507 * compound chain
509 DATA_BLOB first_key;
511 * the signing key for the last
512 * request/response of a compound chain
514 DATA_BLOB last_key;
516 struct timeval request_time;
518 /* fake smb1 request. */
519 struct smb_request *smb1req;
520 struct files_struct *compat_chain_fsp;
523 * The sub request for async backend calls.
524 * This is used for SMB2 Cancel.
526 struct tevent_req *subreq;
528 #define SMBD_SMB2_TF_IOV_OFS 0
529 #define SMBD_SMB2_HDR_IOV_OFS 1
530 #define SMBD_SMB2_BODY_IOV_OFS 2
531 #define SMBD_SMB2_DYN_IOV_OFS 3
533 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
535 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
536 (&req->dir.vector[(idx)+(ofs)])
538 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
539 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
540 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
541 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
542 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
543 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
544 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
545 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
547 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
548 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
549 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
550 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
551 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
552 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
553 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
554 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
555 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
556 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
558 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
559 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
560 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
561 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
562 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
563 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
564 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
565 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
566 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
567 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
569 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
571 struct {
573 * vector[0] TRANSPORT HEADER (empty)
575 * vector[1] SMB2_TRANSFORM (optional)
576 * vector[2] SMB2
577 * vector[3] fixed body
578 * vector[4] dynamic body
582 * vector[5] SMB2_TRANSFORM (optional)
583 * vector[6] SMB2
584 * vector[7] fixed body
585 * vector[8] dynamic body
590 struct iovec *vector;
591 int vector_count;
592 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
593 } in;
594 struct {
595 /* the NBT header is not allocated */
596 uint8_t nbt_hdr[4];
598 * vector[0] TRANSPORT HEADER
600 * vector[1] SMB2_TRANSFORM (optional)
601 * vector[2] SMB2
602 * vector[3] fixed body
603 * vector[4] dynamic body
607 * vector[5] SMB2_TRANSFORM (empty)
608 * vector[6] SMB2
609 * vector[7] fixed body
610 * vector[8] dynamic body
615 struct iovec *vector;
616 int vector_count;
617 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
618 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
619 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
620 uint8_t _body[0x58];
621 } out;
624 struct smbd_server_connection;
625 struct user_struct;
627 struct pending_message_list;
628 struct pending_auth_data;
630 struct user_struct {
631 struct user_struct *next, *prev;
632 uint64_t vuid; /* Tag for this entry. */
634 char *session_keystr; /* used by utmp and pam session code.
635 TDB key string */
636 int homes_snum;
638 struct auth_session_info *session_info;
640 struct smbXsrv_session *session;
643 struct smbd_server_connection {
644 NTSTATUS status;
645 int sock;
646 const struct tsocket_address *local_address;
647 const struct tsocket_address *remote_address;
648 const char *remote_hostname;
649 struct tevent_context *ev_ctx;
650 struct messaging_context *msg_ctx;
651 struct sys_notify_context *sys_notify_ctx;
652 struct notify_context *notify_ctx;
653 struct {
654 bool got_session;
655 } nbt;
656 bool using_smb2;
657 int trans_num;
659 size_t num_users;
660 struct user_struct *users;
662 size_t num_connections;
663 struct connection_struct *connections;
665 size_t num_files;
666 struct files_struct *files;
668 int real_max_open_files;
669 struct fsp_singleton_cache fsp_fi_cache;
671 struct pending_message_list *deferred_open_queue;
674 /* open directory handles. */
675 struct {
676 struct bitmap *dptr_bmap;
677 struct dptr_struct *dirptrs;
678 int dirhandles_open;
679 } searches;
681 uint64_t num_requests;
683 /* Current number of oplocks we have outstanding. */
684 struct {
685 int32_t exclusive_open;
686 int32_t level_II_open;
687 struct kernel_oplocks *kernel_ops;
688 } oplocks;
690 struct {
691 struct tevent_fd *fde;
693 struct {
695 * fd for the fcntl lock mutexing access to our sock
697 int socket_lock_fd;
700 * fd for the trusted pipe from
701 * echo handler child
703 int trusted_fd;
706 * fde for the trusted_fd
708 struct tevent_fd *trusted_fde;
711 * Reference count for the fcntl lock to
712 * allow recursive locks.
714 int ref_count;
715 } echo_handler;
717 struct {
718 bool encrypted_passwords;
719 bool spnego;
720 struct auth4_context *auth_context;
721 bool done;
723 * Size of the data we can receive. Set by us.
724 * Can be modified by the max xmit parameter.
726 int max_recv;
727 } negprot;
729 struct {
730 uint16_t client_major;
731 uint16_t client_minor;
732 uint32_t client_cap_low;
733 uint32_t client_cap_high;
734 } unix_info;
736 struct {
737 bool done_sesssetup;
739 * Size of data we can send to client. Set
740 * by the client for all protocols above CORE.
741 * Set by us for CORE protocol.
743 int max_send;
744 } sessions;
745 struct smb_signing_state *signing_state;
747 struct notify_mid_map *notify_mid_maps;
749 struct {
750 /* dlink list we store pending lock records on. */
751 struct blocking_lock_record *blocking_lock_queue;
752 /* dlink list we move cancelled lock records onto. */
753 struct blocking_lock_record *blocking_lock_cancelled_queue;
755 /* The event that makes us process our blocking lock queue */
756 struct tevent_timer *brl_timeout;
758 bool blocking_lock_unlock_state;
759 bool blocking_lock_cancel_state;
760 } locks;
761 } smb1;
762 struct {
763 struct smbd_smb2_request_read_state {
764 struct smbd_smb2_request *req;
765 struct {
766 uint8_t nbt[NBT_HDR_SIZE];
767 bool done;
768 } hdr;
769 struct iovec vector;
770 bool doing_receivefile;
771 size_t min_recv_size;
772 size_t pktfull;
773 size_t pktlen;
774 uint8_t *pktbuf;
775 } request_read_state;
776 struct smbd_smb2_send_queue *send_queue;
777 size_t send_queue_len;
778 struct tevent_fd *fde;
779 bool negprot_2ff;
780 struct {
781 /* The event that makes us process our blocking lock queue */
782 struct tevent_timer *brl_timeout;
783 bool blocking_lock_unlock_state;
784 } locks;
785 struct smbd_smb2_request *requests;
787 * seqnum_low is the lowest sequence number
788 * we will accept.
790 uint64_t seqnum_low;
792 * seqnum_range is the range of credits we have
793 * granted from the sequence windows starting
794 * at seqnum_low.
796 * This gets incremented when new credits are
797 * granted and gets decremented when the
798 * lowest sequence number is consumed
799 * (when seqnum_low gets incremented).
801 uint16_t seqnum_range;
803 * credits_grantedThe number of credits we have currently granted
804 * to the client.
806 * This gets incremented when new credits are
807 * granted and gets decremented when any credit
808 * is comsumed.
810 * Note: the decrementing is different compared
811 * to seqnum_range.
813 uint16_t credits_granted;
815 * The maximum number of credits we will ever
816 * grant to the client.
818 * Typically we will only grant 1/16th of
819 * max_credits.
821 * This is the "server max credits" parameter.
823 uint16_t max_credits;
825 * a bitmap of size max_credits
827 struct bitmap *credits_bitmap;
828 bool supports_multicredit;
829 uint32_t max_trans;
830 uint32_t max_read;
831 uint32_t max_write;
832 } smb2;
834 struct smbXsrv_connection *conn;
837 extern struct smbXsrv_connection *global_smbXsrv_connection;
839 void smbd_init_globals(void);