s3:locking:brlock: improve the comment for the brl self cleaning code
[Samba/gebeck_regimport.git] / source3 / smbd / globals.h
blob150275894b62d13719b7363f92f58867ce2cdf8d
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 char **ppdata,
142 unsigned int *pdata_size);
144 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
145 struct smb_request *req,
146 TALLOC_CTX *mem_ctx,
147 uint16_t info_level,
148 files_struct *fsp,
149 struct smb_filename *smb_fname,
150 char **ppdata, int total_data,
151 int *ret_data_size);
153 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
154 TALLOC_CTX *mem_ctx,
155 uint16_t info_level,
156 uint16_t flags2,
157 unsigned int max_data_bytes,
158 struct smb_filename *smb_fname,
159 char **ppdata,
160 int *ret_data_len);
162 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
163 struct dptr_struct *dirptr,
164 const char *mask,
165 uint32_t dirtype,
166 bool dont_descend,
167 bool ask_sharemode,
168 bool (*match_fn)(TALLOC_CTX *ctx,
169 void *private_data,
170 const char *dname,
171 const char *mask,
172 char **_fname),
173 bool (*mode_fn)(TALLOC_CTX *ctx,
174 void *private_data,
175 struct smb_filename *smb_fname,
176 uint32_t *_mode),
177 void *private_data,
178 char **_fname,
179 struct smb_filename **_smb_fname,
180 uint32_t *_mode,
181 long *_prev_offset);
183 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
184 connection_struct *conn,
185 struct dptr_struct *dirptr,
186 uint16 flags2,
187 const char *path_mask,
188 uint32 dirtype,
189 int info_level,
190 int requires_resume_key,
191 bool dont_descend,
192 bool ask_sharemode,
193 uint8_t align,
194 bool do_pad,
195 char **ppdata,
196 char *base_data,
197 char *end_data,
198 int space_remaining,
199 bool *out_of_space,
200 bool *got_exact_match,
201 int *_last_entry_off,
202 struct ea_list *name_list);
204 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
205 const struct smb_filename *smb_fname,
206 bool use_privs,
207 uint32_t access_mask,
208 uint32_t *access_mask_out);
210 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
212 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
213 const char *reason,
214 const char *location);
215 #define smbd_server_connection_terminate(sconn, reason) \
216 smbd_server_connection_terminate_ex(sconn, reason, __location__)
218 const char *smb2_opcode_name(uint16_t opcode);
219 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
221 void reply_smb2002(struct smb_request *req, uint16_t choice);
222 void reply_smb20ff(struct smb_request *req, uint16_t choice);
223 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
224 uint8_t *inbuf, size_t size);
226 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
227 NTSTATUS status,
228 DATA_BLOB *info,
229 const char *location);
230 #define smbd_smb2_request_error(req, status) \
231 smbd_smb2_request_error_ex(req, status, NULL, __location__)
232 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
233 NTSTATUS status,
234 DATA_BLOB body, DATA_BLOB *dyn,
235 const char *location);
236 #define smbd_smb2_request_done(req, body, dyn) \
237 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
239 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
240 struct smbXsrv_session *session,
241 struct smbXsrv_tcon *tcon,
242 struct smbXsrv_open *op,
243 uint8_t oplock_level);
245 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
246 struct tevent_req *subreq,
247 uint32_t defer_time);
249 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
250 void remove_smb2_chained_fsp(files_struct *fsp);
252 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
253 uint32_t data_length);
255 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
256 size_t expected_body_size);
258 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
259 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
266 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
267 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
268 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
269 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
270 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
271 int err);
272 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
280 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
281 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
282 struct tevent_immediate *im,
283 void *private_data);
285 /* SMB1 -> SMB2 glue. */
286 void send_break_message_smb2(files_struct *fsp, int level);
287 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
288 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
289 struct smb_request *req,
290 files_struct *fsp,
291 int lock_timeout,
292 int lock_num,
293 uint64_t smblctx,
294 enum brl_type lock_type,
295 enum brl_flavour lock_flav,
296 uint64_t offset,
297 uint64_t count,
298 uint64_t blocking_smblctx);
299 void process_blocking_lock_queue_smb2(
300 struct smbd_server_connection *sconn, struct timeval tv_curr);
301 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
302 struct byte_range_lock *br_lck,
303 enum file_close_type close_type);
304 /* From smbd/smb2_create.c */
305 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
306 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
307 struct timeval *p_request_time,
308 void **pp_state);
309 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
310 uint64_t mid);
311 void remove_deferred_open_message_smb2(
312 struct smbd_server_connection *sconn, uint64_t mid);
313 bool schedule_deferred_open_message_smb2(
314 struct smbd_server_connection *sconn, uint64_t mid);
315 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
316 struct timeval request_time,
317 struct timeval timeout,
318 struct file_id id,
319 char *private_data,
320 size_t priv_len);
322 struct smbXsrv_connection {
323 struct smbd_server_connection *sconn;
325 const struct tsocket_address *local_address;
326 const struct tsocket_address *remote_address;
327 const char *remote_hostname;
329 struct tevent_context *ev_ctx;
330 struct messaging_context *msg_ctx;
332 enum protocol_types protocol;
334 struct {
335 struct {
336 uint32_t capabilities;
337 struct GUID guid;
338 uint16_t security_mode;
339 uint16_t num_dialects;
340 uint16_t *dialects;
341 } client;
342 struct {
343 uint32_t capabilities;
344 struct GUID guid;
345 uint16_t security_mode;
346 uint16_t dialect;
347 uint32_t max_trans;
348 uint32_t max_read;
349 uint32_t max_write;
350 } server;
351 } smb2;
353 struct msg_state *msg_state;
356 * Link into libasys for asynchronous operations
358 struct asys_context *asys_ctx;
359 struct tevent_fd *asys_fde;
361 uint64_t smbd_idle_profstamp;
364 * this session_table is used for SMB1 and SMB2,
366 struct smbXsrv_session_table *session_table;
368 * this tcon_table is only used for SMB1.
370 struct smbXsrv_tcon_table *tcon_table;
372 * this open_table is used for SMB1 and SMB2,
373 * because we have a global sconn->real_max_open_files
374 * limit.
376 struct smbXsrv_open_table *open_table;
379 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
380 uint32_t smbXsrv_version_global_current(void);
382 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
383 enum protocol_types protocol);
385 NTSTATUS smbXsrv_session_global_init(void);
386 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
387 NTTIME now,
388 struct smbXsrv_session **_session);
389 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
390 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
391 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
392 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
393 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
394 uint16_t vuid, NTTIME now,
395 struct smbXsrv_session **session);
396 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
397 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
398 uint64_t session_id, NTTIME now,
399 struct smbXsrv_session **session);
400 struct smbXsrv_session_global0;
401 NTSTATUS smbXsrv_session_global_traverse(
402 int (*fn)(struct smbXsrv_session_global0 *, void *),
403 void *private_data);
404 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
405 struct tevent_context *ev,
406 struct smbXsrv_connection *conn,
407 struct auth_session_info *session_info,
408 uint64_t previous_session_id,
409 uint64_t current_session_id);
410 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
412 NTSTATUS smbXsrv_tcon_global_init(void);
413 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
414 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
415 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
416 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
417 NTTIME now,
418 struct smbXsrv_tcon **_tcon);
419 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
420 uint16_t tree_id, NTTIME now,
421 struct smbXsrv_tcon **tcon);
422 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
423 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
424 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
425 NTTIME now,
426 struct smbXsrv_tcon **_tcon);
427 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
428 uint32_t tree_id, NTTIME now,
429 struct smbXsrv_tcon **tcon);
430 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
431 struct smbXsrv_tcon_global0;
432 NTSTATUS smbXsrv_tcon_global_traverse(
433 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
434 void *private_data);
436 NTSTATUS smbXsrv_open_global_init(void);
437 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
438 struct auth_session_info *session_info,
439 NTTIME now,
440 struct smbXsrv_open **_open);
441 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
442 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
443 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
444 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
445 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
446 uint16_t fnum, NTTIME now,
447 struct smbXsrv_open **_open);
448 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
449 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
450 uint64_t persistent_id,
451 uint64_t volatile_id,
452 NTTIME now,
453 struct smbXsrv_open **_open);
454 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
455 struct auth_session_info *session_info,
456 uint64_t persistent_id,
457 struct GUID create_guid,
458 NTTIME now,
459 struct smbXsrv_open **_open);
460 struct smbXsrv_open_global0;
461 NTSTATUS smbXsrv_open_global_traverse(
462 int (*fn)(struct smbXsrv_open_global0 *, void *),
463 void *private_data);
465 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
468 struct smbd_smb2_request {
469 struct smbd_smb2_request *prev, *next;
471 struct smbd_server_connection *sconn;
473 /* the session the request operates on, maybe NULL */
474 struct smbXsrv_session *session;
475 uint64_t last_session_id;
477 /* the tcon the request operates on, maybe NULL */
478 struct smbXsrv_tcon *tcon;
479 uint32_t last_tid;
481 int current_idx;
482 bool do_signing;
483 bool do_encryption;
484 struct tevent_timer *async_te;
485 bool compound_related;
488 * the encryption key for the whole
489 * compound chain
491 DATA_BLOB first_key;
493 * the signing key for the last
494 * request/response of a compound chain
496 DATA_BLOB last_key;
498 struct timeval request_time;
500 /* fake smb1 request. */
501 struct smb_request *smb1req;
502 struct files_struct *compat_chain_fsp;
505 * The sub request for async backend calls.
506 * This is used for SMB2 Cancel.
508 struct tevent_req *subreq;
510 #define SMBD_SMB2_TF_IOV_OFS 0
511 #define SMBD_SMB2_HDR_IOV_OFS 1
512 #define SMBD_SMB2_BODY_IOV_OFS 2
513 #define SMBD_SMB2_DYN_IOV_OFS 3
515 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
517 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
518 (&req->dir.vector[(idx)+(ofs)])
520 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
521 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
522 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
523 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
524 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
525 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
526 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
527 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
529 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
530 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
531 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
532 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
533 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
534 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
535 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
536 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
537 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
538 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
540 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
541 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
542 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
543 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
544 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
545 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
546 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
547 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
548 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
549 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
551 struct {
553 * vector[0] TRANSPORT HEADER (empty)
555 * vector[1] SMB2_TRANSFORM (optional)
556 * vector[2] SMB2
557 * vector[3] fixed body
558 * vector[4] dynamic body
562 * vector[5] SMB2_TRANSFORM (optional)
563 * vector[6] SMB2
564 * vector[7] fixed body
565 * vector[8] dynamic body
570 struct iovec *vector;
571 int vector_count;
572 } in;
573 struct {
574 /* the NBT header is not allocated */
575 uint8_t nbt_hdr[4];
577 * vector[0] TRANSPORT HEADER
579 * vector[1] SMB2_TRANSFORM (optional)
580 * vector[2] SMB2
581 * vector[3] fixed body
582 * vector[4] dynamic body
586 * vector[5] SMB2_TRANSFORM (empty)
587 * vector[6] SMB2
588 * vector[7] fixed body
589 * vector[8] dynamic body
594 struct iovec *vector;
595 int vector_count;
596 } out;
599 struct smbd_server_connection;
600 struct user_struct;
602 struct pending_message_list;
603 struct pending_auth_data;
605 struct user_struct {
606 struct user_struct *next, *prev;
607 uint64_t vuid; /* Tag for this entry. */
609 char *session_keystr; /* used by utmp and pam session code.
610 TDB key string */
611 int homes_snum;
613 struct auth_session_info *session_info;
615 struct smbXsrv_session *session;
618 struct smbd_server_connection {
619 int sock;
620 const struct tsocket_address *local_address;
621 const struct tsocket_address *remote_address;
622 const char *remote_hostname;
623 struct tevent_context *ev_ctx;
624 struct messaging_context *msg_ctx;
625 struct sys_notify_context *sys_notify_ctx;
626 struct notify_context *notify_ctx;
627 struct {
628 bool got_session;
629 } nbt;
630 bool using_smb2;
631 int trans_num;
633 size_t num_users;
634 struct user_struct *users;
636 size_t num_connections;
637 struct connection_struct *connections;
639 size_t num_files;
640 struct files_struct *files;
642 int real_max_open_files;
643 struct fsp_singleton_cache fsp_fi_cache;
645 struct pending_message_list *deferred_open_queue;
648 /* open directory handles. */
649 struct {
650 struct bitmap *dptr_bmap;
651 struct dptr_struct *dirptrs;
652 int dirhandles_open;
653 } searches;
655 uint64_t num_requests;
657 /* Current number of oplocks we have outstanding. */
658 struct {
659 int32_t exclusive_open;
660 int32_t level_II_open;
661 struct kernel_oplocks *kernel_ops;
662 } oplocks;
664 struct {
665 struct tevent_fd *fde;
667 struct {
669 * fd for the fcntl lock mutexing access to our sock
671 int socket_lock_fd;
674 * fd for the trusted pipe from
675 * echo handler child
677 int trusted_fd;
680 * fde for the trusted_fd
682 struct tevent_fd *trusted_fde;
685 * Reference count for the fcntl lock to
686 * allow recursive locks.
688 int ref_count;
689 } echo_handler;
691 struct {
692 bool encrypted_passwords;
693 bool spnego;
694 struct auth4_context *auth_context;
695 bool done;
697 * Size of the data we can receive. Set by us.
698 * Can be modified by the max xmit parameter.
700 int max_recv;
701 } negprot;
703 struct {
704 uint16_t client_major;
705 uint16_t client_minor;
706 uint32_t client_cap_low;
707 uint32_t client_cap_high;
708 } unix_info;
710 struct {
711 bool done_sesssetup;
713 * Size of data we can send to client. Set
714 * by the client for all protocols above CORE.
715 * Set by us for CORE protocol.
717 int max_send;
718 uint64_t last_session_tag;
719 } sessions;
720 struct smb_signing_state *signing_state;
722 struct notify_mid_map *notify_mid_maps;
724 struct {
725 /* dlink list we store pending lock records on. */
726 struct blocking_lock_record *blocking_lock_queue;
727 /* dlink list we move cancelled lock records onto. */
728 struct blocking_lock_record *blocking_lock_cancelled_queue;
730 /* The event that makes us process our blocking lock queue */
731 struct tevent_timer *brl_timeout;
733 bool blocking_lock_unlock_state;
734 bool blocking_lock_cancel_state;
735 } locks;
736 } smb1;
737 struct {
738 struct tevent_queue *recv_queue;
739 struct tevent_queue *send_queue;
740 struct tstream_context *stream;
741 bool negprot_2ff;
742 struct {
743 /* The event that makes us process our blocking lock queue */
744 struct tevent_timer *brl_timeout;
745 bool blocking_lock_unlock_state;
746 } locks;
747 struct smbd_smb2_request *requests;
749 * seqnum_low is the lowest sequence number
750 * we will accept.
752 uint64_t seqnum_low;
754 * seqnum_range is the range of credits we have
755 * granted from the sequence windows starting
756 * at seqnum_low.
758 * This gets incremented when new credits are
759 * granted and gets decremented when the
760 * lowest sequence number is consumed
761 * (when seqnum_low gets incremented).
763 uint16_t seqnum_range;
765 * credits_grantedThe number of credits we have currently granted
766 * to the client.
768 * This gets incremented when new credits are
769 * granted and gets decremented when any credit
770 * is comsumed.
772 * Note: the decrementing is different compared
773 * to seqnum_range.
775 uint16_t credits_granted;
777 * The maximum number of credits we will ever
778 * grant to the client.
780 * Typically we will only grant 1/16th of
781 * max_credits.
783 * This is the "server max credits" parameter.
785 uint16_t max_credits;
787 * a bitmap of size max_credits
789 struct bitmap *credits_bitmap;
790 bool supports_multicredit;
791 uint32_t max_trans;
792 uint32_t max_read;
793 uint32_t max_write;
794 bool compound_related_in_progress;
795 } smb2;
797 struct smbXsrv_connection *conn;
800 extern struct smbXsrv_connection *global_smbXsrv_connection;
802 void smbd_init_globals(void);