s3:smb2_server: move sconn->smb2.*credits* to xconn->smb2.credits.*
[kamenim/samba-autobuild/.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5    Copyright (C) Jeremy Allison 2010
6
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.
11
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.
16
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/>.
19 */
20
21 #include "system/select.h"
22 #include "librpc/gen_ndr/smbXsrv.h"
23
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
26
27 #ifdef USE_DMAPI
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
30 #endif
31
32 extern bool dfree_broken;
33
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
36
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;
41 };
42
43 extern const struct mangle_fns *mangle_fns;
44
45 extern unsigned char *chartest;
46 struct tdb_context;
47 extern struct tdb_context *tdb_mangled_cache;
48
49 /*
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.
53 */
54 extern unsigned mangle_prefix;
55
56 struct msg_state;
57
58 extern bool logged_ioctl_message;
59
60 extern int trans_num;
61
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;
65
66 /****************************************************************************
67  structure to hold a linked list of queued messages.
68  for processing.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
71
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
74
75 struct sec_ctx {
76         struct security_unix_token ut;
77         struct security_token *token;
78 };
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;
85
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
88
89 extern uint32_t global_client_caps;
90
91 extern uint16_t fnf_handle;
92
93 struct conn_ctx {
94         connection_struct *conn;
95         uint64_t vuid;
96 };
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;
100
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
105
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;
110
111 struct tstream_context;
112 struct smbd_smb2_request;
113
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
115
116 void smbd_lock_socket(struct smbd_server_connection *sconn);
117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
118
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_locks,
124                          struct smbd_lock_element *locks,
125                          bool *async);
126 NTSTATUS smbd_do_unlocking(struct smb_request *req,
127                            files_struct *fsp,
128                            uint16_t num_ulocks,
129                            struct smbd_lock_element *ulocks);
130
131 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
132                                TALLOC_CTX *mem_ctx,
133                                uint16_t info_level,
134                                files_struct *fsp,
135                                struct smb_filename *smb_fname,
136                                bool delete_pending,
137                                struct timespec write_time_ts,
138                                struct ea_list *ea_list,
139                                int lock_data_count,
140                                char *lock_data,
141                                uint16_t flags2,
142                                unsigned int max_data_bytes,
143                                size_t *fixed_portion,
144                                char **ppdata,
145                                unsigned int *pdata_size);
146
147 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
148                                 struct smb_request *req,
149                                 TALLOC_CTX *mem_ctx,
150                                 uint16_t info_level,
151                                 files_struct *fsp,
152                                 struct smb_filename *smb_fname,
153                                 char **ppdata, int total_data,
154                                 int *ret_data_size);
155
156 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
157                          TALLOC_CTX *mem_ctx,
158                          uint16_t info_level,
159                          uint16_t flags2,
160                          unsigned int max_data_bytes,
161                          size_t *fixed_portion,
162                          struct smb_filename *smb_fname,
163                          char **ppdata,
164                          int *ret_data_len);
165
166 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
167                            struct dptr_struct *dirptr,
168                            const char *mask,
169                            uint32_t dirtype,
170                            bool dont_descend,
171                            bool ask_sharemode,
172                            bool (*match_fn)(TALLOC_CTX *ctx,
173                                             void *private_data,
174                                             const char *dname,
175                                             const char *mask,
176                                             char **_fname),
177                            bool (*mode_fn)(TALLOC_CTX *ctx,
178                                            void *private_data,
179                                            struct smb_filename *smb_fname,
180                                            uint32_t *_mode),
181                            void *private_data,
182                            char **_fname,
183                            struct smb_filename **_smb_fname,
184                            uint32_t *_mode,
185                            long *_prev_offset);
186
187 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
188                                connection_struct *conn,
189                                struct dptr_struct *dirptr,
190                                uint16 flags2,
191                                const char *path_mask,
192                                uint32 dirtype,
193                                int info_level,
194                                int requires_resume_key,
195                                bool dont_descend,
196                                bool ask_sharemode,
197                                uint8_t align,
198                                bool do_pad,
199                                char **ppdata,
200                                char *base_data,
201                                char *end_data,
202                                int space_remaining,
203                                bool *out_of_space,
204                                bool *got_exact_match,
205                                int *_last_entry_off,
206                                struct ea_list *name_list);
207
208 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
209                                     const struct smb_filename *smb_fname,
210                                     bool use_privs,
211                                     uint32_t access_mask,
212                                     uint32_t *access_mask_out);
213
214 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
215
216 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
217                                          const char *reason,
218                                          const char *location);
219 #define smbd_server_connection_terminate(sconn, reason) \
220         smbd_server_connection_terminate_ex(sconn, reason, __location__)
221
222 const char *smb2_opcode_name(uint16_t opcode);
223 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
224
225 void reply_smb2002(struct smb_request *req, uint16_t choice);
226 void reply_smb20ff(struct smb_request *req, uint16_t choice);
227 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
228                              uint8_t *inbuf, size_t size);
229
230 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
231
232 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
233                                     NTSTATUS status,
234                                     DATA_BLOB *info,
235                                     const char *location);
236 #define smbd_smb2_request_error(req, status) \
237         smbd_smb2_request_error_ex(req, status, NULL, __location__)
238 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
239                                    NTSTATUS status,
240                                    DATA_BLOB body, DATA_BLOB *dyn,
241                                    const char *location);
242 #define smbd_smb2_request_done(req, body, dyn) \
243         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
244
245 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
246                                      struct smbXsrv_session *session,
247                                      struct smbXsrv_tcon *tcon,
248                                      struct smbXsrv_open *op,
249                                      uint8_t oplock_level);
250
251 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
252                                          struct tevent_req *subreq,
253                                          uint32_t defer_time);
254
255 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
256 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
257 void remove_smb2_chained_fsp(files_struct *fsp);
258
259 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
260                                                uint32_t data_length);
261
262 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
263                                         size_t expected_body_size);
264
265 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
266                                                      const int dialect_count,
267                                                      uint16_t *dialect);
268 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
269 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
270 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
271 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
277 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
278 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
279 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
280 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
281                                     int err);
282 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
291 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
292                                 struct tevent_immediate *im,
293                                 void *private_data);
294
295 struct deferred_open_record;
296
297 /* SMB1 -> SMB2 glue. */
298 void send_break_message_smb2(files_struct *fsp, int level);
299 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
300 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
301                                 struct smb_request *req,
302                                 files_struct *fsp,
303                                 int lock_timeout,
304                                 int lock_num,
305                                 uint64_t smblctx,
306                                 enum brl_type lock_type,
307                                 enum brl_flavour lock_flav,
308                                 uint64_t offset,
309                                 uint64_t count,
310                                 uint64_t blocking_smblctx);
311 void process_blocking_lock_queue_smb2(
312         struct smbd_server_connection *sconn, struct timeval tv_curr);
313 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
314                         struct byte_range_lock *br_lck,
315                         enum file_close_type close_type);
316 /* From smbd/smb2_create.c */
317 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
318 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
319                         struct timeval *p_request_time,
320                         struct deferred_open_record **open_rec);
321 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
322                             uint64_t mid);
323 void remove_deferred_open_message_smb2(
324         struct smbd_server_connection *sconn, uint64_t mid);
325 bool schedule_deferred_open_message_smb2(
326         struct smbd_server_connection *sconn, uint64_t mid);
327 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
328                                 struct timeval request_time,
329                                 struct timeval timeout,
330                                 struct file_id id,
331                                 struct deferred_open_record *open_rec);
332
333 struct smbXsrv_connection {
334         struct smbd_server_connection *sconn;
335
336         const struct tsocket_address *local_address;
337         const struct tsocket_address *remote_address;
338         const char *remote_hostname;
339
340         struct tevent_context *ev_ctx;
341         struct messaging_context *msg_ctx;
342
343         enum protocol_types protocol;
344
345         struct {
346                 NTSTATUS status;
347                 int sock;
348                 struct tevent_fd *fde;
349
350                 struct {
351                         bool got_session;
352                 } nbt;
353         } transport;
354
355         struct {
356                 struct {
357                         /*
358                          * fd for the fcntl lock and process shared
359                          * robust mutex to coordinate access to the
360                          * client socket. When the system supports
361                          * process shared robust mutexes, those are
362                          * used. If not, then the fcntl lock will be
363                          * used.
364                          */
365                         int socket_lock_fd;
366 #ifdef HAVE_ROBUST_MUTEXES
367                         pthread_mutex_t *socket_mutex;
368 #endif
369
370                         /*
371                          * fd for the trusted pipe from
372                          * echo handler child
373                          */
374                         int trusted_fd;
375
376                         /*
377                          * fde for the trusted_fd
378                          */
379                         struct tevent_fd *trusted_fde;
380
381                         /*
382                          * Reference count for the fcntl lock to
383                          * allow recursive locks.
384                          */
385                         int ref_count;
386                 } echo_handler;
387
388                 struct {
389                         bool encrypted_passwords;
390                         bool spnego;
391                         struct auth4_context *auth_context;
392                         bool done;
393                         /*
394                          * Size of the data we can receive. Set by us.
395                          * Can be modified by the max xmit parameter.
396                          */
397                         int max_recv;
398                 } negprot;
399
400                 struct {
401                         bool done_sesssetup;
402                         /*
403                          * Size of data we can send to client. Set
404                          *  by the client for all protocols above CORE.
405                          *  Set by us for CORE protocol.
406                          */
407                         int max_send;
408                 } sessions;
409                 struct smb_signing_state *signing_state;
410
411                 struct {
412                         uint16_t client_major;
413                         uint16_t client_minor;
414                         uint32_t client_cap_low;
415                         uint32_t client_cap_high;
416                 } unix_info;
417
418                 struct msg_state *msg_state;
419         } smb1;
420         struct {
421                 struct smbd_smb2_request_read_state {
422                         struct smbd_smb2_request *req;
423                         struct {
424                                 uint8_t nbt[NBT_HDR_SIZE];
425                                 bool done;
426                         } hdr;
427                         struct iovec vector;
428                         bool doing_receivefile;
429                         size_t min_recv_size;
430                         size_t pktfull;
431                         size_t pktlen;
432                         uint8_t *pktbuf;
433                 } request_read_state;
434                 struct smbd_smb2_send_queue *send_queue;
435                 size_t send_queue_len;
436
437                 struct {
438                         /*
439                          * seq_low is the lowest sequence number
440                          * we will accept.
441                          */
442                         uint64_t seq_low;
443                         /*
444                          * seq_range is the range of credits we have
445                          * granted from the sequence windows starting
446                          * at seq_low.
447                          *
448                          * This gets incremented when new credits are
449                          * granted and gets decremented when the
450                          * lowest sequence number is consumed
451                          * (when seq_low gets incremented).
452                          */
453                         uint16_t seq_range;
454                         /*
455                          * The number of credits we have currently granted
456                          * to the client.
457                          *
458                          * This gets incremented when new credits are
459                          * granted and gets decremented when any credit
460                          * is comsumed.
461                          *
462                          * Note: the decrementing is different compared
463                          *       to seq_range.
464                          */
465                         uint16_t granted;
466                         /*
467                          * The maximum number of credits we will ever
468                          * grant to the client.
469                          *
470                          * Typically we will only grant 1/16th of
471                          * max_credits.
472                          *
473                          * This is the "server max credits" parameter.
474                          */
475                         uint16_t max;
476                         /*
477                          * a bitmap of size max_credits
478                          */
479                         struct bitmap *bitmap;
480                         bool multicredit;
481                 } credits;
482
483                 bool allow_2ff;
484                 struct {
485                         uint32_t capabilities;
486                         struct GUID guid;
487                         uint16_t security_mode;
488                         uint16_t num_dialects;
489                         uint16_t *dialects;
490                 } client;
491                 struct {
492                         uint32_t capabilities;
493                         struct GUID guid;
494                         uint16_t security_mode;
495                         uint16_t dialect;
496                         uint32_t max_trans;
497                         uint32_t max_read;
498                         uint32_t max_write;
499                 } server;
500         } smb2;
501
502         uint64_t smbd_idle_profstamp;
503
504         /*
505          * this session_table is used for SMB1 and SMB2,
506          */
507         struct smbXsrv_session_table *session_table;
508         uint64_t last_session_id;
509         /*
510          * this tcon_table is only used for SMB1.
511          */
512         struct smbXsrv_tcon_table *tcon_table;
513         /*
514          * this open_table is used for SMB1 and SMB2,
515          * because we have a global sconn->real_max_open_files
516          * limit.
517          */
518         struct smbXsrv_open_table *open_table;
519 };
520
521 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
522
523 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
524 uint32_t smbXsrv_version_global_current(void);
525
526 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
527                                         enum protocol_types protocol);
528
529 NTSTATUS smbXsrv_session_global_init(void);
530 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
531                                 NTTIME now,
532                                 struct smbXsrv_session **_session);
533 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
534 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
535 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
536 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
537 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
538                                 uint16_t vuid, NTTIME now,
539                                 struct smbXsrv_session **session);
540 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
541 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
542                                 uint64_t session_id, NTTIME now,
543                                 struct smbXsrv_session **session);
544 struct smbXsrv_session_global0;
545 NTSTATUS smbXsrv_session_global_traverse(
546                         int (*fn)(struct smbXsrv_session_global0 *, void *),
547                         void *private_data);
548 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
549                                         struct tevent_context *ev,
550                                         struct smbXsrv_connection *conn,
551                                         struct auth_session_info *session_info,
552                                         uint64_t previous_session_id,
553                                         uint64_t current_session_id);
554 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
555
556 NTSTATUS smbXsrv_tcon_global_init(void);
557 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
558 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
559 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
560 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
561                              NTTIME now,
562                              struct smbXsrv_tcon **_tcon);
563 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
564                              uint16_t tree_id, NTTIME now,
565                              struct smbXsrv_tcon **tcon);
566 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
567 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
568 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
569                              NTTIME now,
570                              struct smbXsrv_tcon **_tcon);
571 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
572                              uint32_t tree_id, NTTIME now,
573                              struct smbXsrv_tcon **tcon);
574 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
575 struct smbXsrv_tcon_global0;
576 NTSTATUS smbXsrv_tcon_global_traverse(
577                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
578                         void *private_data);
579
580 NTSTATUS smbXsrv_open_global_init(void);
581 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
582                              struct auth_session_info *session_info,
583                              NTTIME now,
584                              struct smbXsrv_open **_open);
585 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
586 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
587 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
588 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
589 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
590                              uint16_t fnum, NTTIME now,
591                              struct smbXsrv_open **_open);
592 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
593 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
594                              uint64_t persistent_id,
595                              uint64_t volatile_id,
596                              NTTIME now,
597                              struct smbXsrv_open **_open);
598 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
599                                struct auth_session_info *session_info,
600                                uint64_t persistent_id,
601                                const struct GUID *create_guid,
602                                NTTIME now,
603                                struct smbXsrv_open **_open);
604 struct smbXsrv_open_global0;
605 NTSTATUS smbXsrv_open_global_traverse(
606         int (*fn)(struct smbXsrv_open_global0 *, void *),
607         void *private_data);
608
609 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
610
611 struct smbd_smb2_send_queue {
612         struct smbd_smb2_send_queue *prev, *next;
613
614         DATA_BLOB *sendfile_header;
615         struct iovec *vector;
616         int count;
617
618         TALLOC_CTX *mem_ctx;
619 };
620
621 struct smbd_smb2_request {
622         struct smbd_smb2_request *prev, *next;
623
624         struct smbd_server_connection *sconn;
625
626         struct smbd_smb2_send_queue queue_entry;
627
628         /* the session the request operates on, maybe NULL */
629         struct smbXsrv_session *session;
630         uint64_t last_session_id;
631
632         /* the tcon the request operates on, maybe NULL */
633         struct smbXsrv_tcon *tcon;
634         uint32_t last_tid;
635
636         int current_idx;
637         bool do_signing;
638         bool do_encryption;
639         struct tevent_timer *async_te;
640         bool compound_related;
641
642         /*
643          * the encryption key for the whole
644          * compound chain
645          */
646         DATA_BLOB first_key;
647         /*
648          * the signing key for the last
649          * request/response of a compound chain
650          */
651         DATA_BLOB last_key;
652
653         struct timeval request_time;
654
655         /* fake smb1 request. */
656         struct smb_request *smb1req;
657         struct files_struct *compat_chain_fsp;
658
659         /*
660          * The sub request for async backend calls.
661          * This is used for SMB2 Cancel.
662          */
663         struct tevent_req *subreq;
664
665 #define SMBD_SMB2_TF_IOV_OFS 0
666 #define SMBD_SMB2_HDR_IOV_OFS 1
667 #define SMBD_SMB2_BODY_IOV_OFS 2
668 #define SMBD_SMB2_DYN_IOV_OFS 3
669
670 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
671
672 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
673         (&req->dir.vector[(idx)+(ofs)])
674
675 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
676         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
677 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
678         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
679 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
680         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
681 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
682         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
683
684 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
685 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
686 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
687 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
688 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
689 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
690 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
691 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
692 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
693 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
694
695 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
696 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
697 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
698 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
699 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
700 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
701 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
702 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
703 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
704 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
705
706 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
707
708         struct {
709                 /*
710                  * vector[0] TRANSPORT HEADER (empty)
711                  * .
712                  * vector[1] SMB2_TRANSFORM (optional)
713                  * vector[2] SMB2
714                  * vector[3] fixed body
715                  * vector[4] dynamic body
716                  * .
717                  * .
718                  * .
719                  * vector[5] SMB2_TRANSFORM (optional)
720                  * vector[6] SMB2
721                  * vector[7] fixed body
722                  * vector[8] dynamic body
723                  * .
724                  * .
725                  * .
726                  */
727                 struct iovec *vector;
728                 int vector_count;
729                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
730         } in;
731         struct {
732                 /* the NBT header is not allocated */
733                 uint8_t nbt_hdr[4];
734                 /*
735                  * vector[0] TRANSPORT HEADER
736                  * .
737                  * vector[1] SMB2_TRANSFORM (optional)
738                  * vector[2] SMB2
739                  * vector[3] fixed body
740                  * vector[4] dynamic body
741                  * .
742                  * .
743                  * .
744                  * vector[5] SMB2_TRANSFORM (empty)
745                  * vector[6] SMB2
746                  * vector[7] fixed body
747                  * vector[8] dynamic body
748                  * .
749                  * .
750                  * .
751                  */
752                 struct iovec *vector;
753                 int vector_count;
754                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
755 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
756                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
757                 uint8_t _body[0x58];
758         } out;
759 };
760
761 struct smbd_server_connection;
762 struct user_struct;
763
764 struct pending_message_list;
765 struct pending_auth_data;
766
767 struct user_struct {
768         struct user_struct *next, *prev;
769         uint64_t vuid; /* Tag for this entry. */
770
771         char *session_keystr; /* used by utmp and pam session code.
772                                  TDB key string */
773         int homes_snum;
774
775         struct auth_session_info *session_info;
776
777         struct smbXsrv_session *session;
778 };
779
780 struct smbd_server_connection {
781         const struct tsocket_address *local_address;
782         const struct tsocket_address *remote_address;
783         const char *remote_hostname;
784         struct tevent_context *ev_ctx;
785         struct messaging_context *msg_ctx;
786         struct sys_notify_context *sys_notify_ctx;
787         struct notify_context *notify_ctx;
788         bool using_smb2;
789         int trans_num;
790
791         size_t num_users;
792         struct user_struct *users;
793
794         size_t num_connections;
795         struct connection_struct *connections;
796
797         size_t num_files;
798         struct files_struct *files;
799
800         int real_max_open_files;
801         struct fsp_singleton_cache fsp_fi_cache;
802
803         struct pending_message_list *deferred_open_queue;
804
805
806         /* open directory handles. */
807         struct {
808                 struct bitmap *dptr_bmap;
809                 struct dptr_struct *dirptrs;
810                 int dirhandles_open;
811         } searches;
812
813         uint64_t num_requests;
814
815         /* Current number of oplocks we have outstanding. */
816         struct {
817                 int32_t exclusive_open;
818                 int32_t level_II_open;
819                 struct kernel_oplocks *kernel_ops;
820         } oplocks;
821
822         struct {
823                 struct notify_mid_map *notify_mid_maps;
824
825                 struct {
826                         /* dlink list we store pending lock records on. */
827                         struct blocking_lock_record *blocking_lock_queue;
828                         /* dlink list we move cancelled lock records onto. */
829                         struct blocking_lock_record *blocking_lock_cancelled_queue;
830
831                         /* The event that makes us process our blocking lock queue */
832                         struct tevent_timer *brl_timeout;
833
834                         bool blocking_lock_unlock_state;
835                         bool blocking_lock_cancel_state;
836                 } locks;
837         } smb1;
838         struct {
839                 struct {
840                         /* The event that makes us process our blocking lock queue */
841                         struct tevent_timer *brl_timeout;
842                         bool blocking_lock_unlock_state;
843                 } locks;
844                 struct smbd_smb2_request *requests;
845         } smb2;
846
847         /*
848          * Link into libasys for asynchronous operations
849          */
850         struct asys_context *asys_ctx;
851         struct tevent_fd *asys_fde;
852
853         struct smbXsrv_connection *conn;
854 };
855
856 extern struct smbXsrv_connection *global_smbXsrv_connection;
857
858 void smbd_init_globals(void);