/* [<][>][^][v][top][bottom][index][help] */
1 /*
2 Unix SMB/CIFS implementation.
3 Infrastructure for async SMB client requests
4 Copyright (C) Volker Lendecke 2008
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef __ASYNC_SMB_H__
21 #define __ASYNC_SMB_H__
22
23 #include "includes.h"
24
25 /**
26 * struct cli_request is the state holder for an async client request we sent
27 * to the server. It can consist of more than one struct async_req that we
28 * have to server if the application did a cli_chain_cork() and
29 * cli_chain_uncork()
30 */
31
32 struct cli_request {
33 /**
34 * "prev" and "next" form the doubly linked list in
35 * cli_state->outstanding_requests
36 */
37 struct cli_request *prev, *next;
38
39 /**
40 * num_async: How many chained requests do we serve?
41 */
42 int num_async;
43
44 /**
45 * async: This is the list of chained requests that were queued up by
46 * cli_request_chain before we sent out this request
47 */
48 struct async_req **async;
49
50 /**
51 * The client connection for this request
52 */
53 struct cli_state *cli;
54
55 /**
56 * The enc_state to decrypt the reply
57 */
58 struct smb_trans_enc_state *enc_state;
59
60 /**
61 * The mid we used for this request. Mainly used to demultiplex on
62 * receiving replies.
63 */
64 uint16_t mid;
65
66 /**
67 * The bytes we have to ship to the server
68 */
69 uint8_t *outbuf;
70
71 /**
72 * How much from "outbuf" did we already send
73 */
74 size_t sent;
75
76 /**
77 * The reply comes in here. Its intended size is implicit by
78 * smb_len(), its current size can be read via talloc_get_size()
79 */
80 char *inbuf;
81
82 /**
83 * Specific requests might add stuff here. Maybe convert this to a
84 * private_pointer at some point.
85 */
86 union {
87 struct {
88 off_t ofs;
89 size_t size;
90 ssize_t received;
91 uint8_t *rcvbuf;
92 } read;
93 struct {
94 DATA_BLOB data;
95 uint16_t num_echos;
96 } echo;
97 } data;
98
99 /*
100 * timer used for request timeout.
101 */
102 struct timed_event *timer;
103 /**
104 * For requests that don't follow the strict request/reply pattern
105 * such as the transaction request family and echo requests it is
106 * necessary to break the standard procedure in
107 * handle_incoming_pdu(). For a simple example look at
108 * cli_echo_recv_helper().
109 */
110 struct {
111 void (*fn)(struct async_req *req);
112 void *priv;
113 } recv_helper;
114 };
115
116 /*
117 * Ship a new smb request to the server
118 */
119
120 struct async_req *cli_request_send(TALLOC_CTX *mem_ctx,
121 struct event_context *ev,
122 struct cli_state *cli,
123 uint8_t smb_command,
124 uint8_t additional_flags,
125 uint8_t wct, const uint16_t *vwv,
126 size_t bytes_alignment,
127 uint32_t num_bytes, const uint8_t *bytes);
128
129 uint16_t cli_wct_ofs(const struct cli_state *cli);
130
131 bool cli_chain_cork(struct cli_state *cli, struct event_context *ev,
132 size_t size_hint);
133 void cli_chain_uncork(struct cli_state *cli);
134 bool cli_in_chain(struct cli_state *cli);
135 bool smb_splice_chain(uint8_t **poutbuf, uint8_t smb_command,
136 uint8_t wct, const uint16_t *vwv,
137 size_t bytes_alignment,
138 uint32_t num_bytes, const uint8_t *bytes);
139
140 NTSTATUS cli_pull_reply(struct async_req *req,
141 uint8_t *pwct, uint16_t **pvwv,
142 uint16_t *pnum_bytes, uint8_t **pbytes);
143
144 /*
145 * Fetch an error out of a NBT packet
146 */
147
148 NTSTATUS cli_pull_error(char *buf);
149
150 /*
151 * Compatibility helper for the sync APIs: Fake NTSTATUS in cli->inbuf
152 */
153
154 void cli_set_error(struct cli_state *cli, NTSTATUS status);
155
156 #endif