2 Unix SMB/CIFS implementation.
3 client file read/write routines
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) James Myers 2003
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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include "libcli/raw/libcliraw.h"
25 #define SETUP_REQUEST(cmd, wct, buflen) do { \
26 req = smbcli_request_setup(tree, cmd, wct, buflen); \
27 if (!req) return NULL; \
30 /****************************************************************************
31 low level read operation (async send)
32 ****************************************************************************/
33 struct smbcli_request *smb_raw_read_send(struct smbcli_tree *tree, union smb_read *parms)
35 BOOL bigoffset = False;
36 struct smbcli_request *req = NULL;
38 switch (parms->generic.level) {
39 case RAW_READ_READBRAW:
40 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
43 SETUP_REQUEST(SMBreadbraw, bigoffset? 10:8, 0);
44 SSVAL(req->out.vwv, VWV(0), parms->readbraw.in.file.fnum);
45 SIVAL(req->out.vwv, VWV(1), parms->readbraw.in.offset);
46 SSVAL(req->out.vwv, VWV(3), parms->readbraw.in.maxcnt);
47 SSVAL(req->out.vwv, VWV(4), parms->readbraw.in.mincnt);
48 SIVAL(req->out.vwv, VWV(5), parms->readbraw.in.timeout);
49 SSVAL(req->out.vwv, VWV(7), 0); /* reserved */
51 SIVAL(req->out.vwv, VWV(8),parms->readbraw.in.offset>>32);
55 case RAW_READ_LOCKREAD:
56 SETUP_REQUEST(SMBlockread, 5, 0);
57 SSVAL(req->out.vwv, VWV(0), parms->lockread.in.file.fnum);
58 SSVAL(req->out.vwv, VWV(1), parms->lockread.in.count);
59 SIVAL(req->out.vwv, VWV(2), parms->lockread.in.offset);
60 SSVAL(req->out.vwv, VWV(4), parms->lockread.in.remaining);
64 SETUP_REQUEST(SMBread, 5, 0);
65 SSVAL(req->out.vwv, VWV(0), parms->read.in.file.fnum);
66 SSVAL(req->out.vwv, VWV(1), parms->read.in.count);
67 SIVAL(req->out.vwv, VWV(2), parms->read.in.offset);
68 SSVAL(req->out.vwv, VWV(4), parms->read.in.remaining);
72 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
75 SETUP_REQUEST(SMBreadX, bigoffset ? 12 : 10, 0);
76 SSVAL(req->out.vwv, VWV(0), SMB_CHAIN_NONE);
77 SSVAL(req->out.vwv, VWV(1), 0);
78 SSVAL(req->out.vwv, VWV(2), parms->readx.in.file.fnum);
79 SIVAL(req->out.vwv, VWV(3), parms->readx.in.offset);
80 SSVAL(req->out.vwv, VWV(5), parms->readx.in.maxcnt & 0xFFFF);
81 SSVAL(req->out.vwv, VWV(6), parms->readx.in.mincnt);
82 SIVAL(req->out.vwv, VWV(7), parms->readx.in.maxcnt >> 16);
83 SSVAL(req->out.vwv, VWV(9), parms->readx.in.remaining);
85 * TODO: give an error when the offset is 64 bit
86 * and the server doesn't support it
89 SIVAL(req->out.vwv, VWV(10),parms->readx.in.offset>>32);
91 if (parms->readx.in.read_for_execute) {
92 uint16_t flags2 = SVAL(req->out.hdr, HDR_FLG2);
93 flags2 |= FLAGS2_READ_PERMIT_EXECUTE;
94 SSVAL(req->out.hdr, HDR_FLG2, flags2);
102 if (!smbcli_request_send(req)) {
103 smbcli_request_destroy(req);
107 /* the transport layer needs to know that a readbraw is pending
108 and handle receives a little differently */
109 if (parms->generic.level == RAW_READ_READBRAW) {
110 tree->session->transport->readbraw_pending = 1;
116 /****************************************************************************
117 low level read operation (async recv)
118 ****************************************************************************/
119 NTSTATUS smb_raw_read_recv(struct smbcli_request *req, union smb_read *parms)
121 if (!smbcli_request_receive(req) ||
122 smbcli_request_is_error(req)) {
126 switch (parms->generic.level) {
127 case RAW_READ_READBRAW:
128 parms->readbraw.out.nread = req->in.size - NBT_HDR_SIZE;
129 if (parms->readbraw.out.nread >
130 MAX(parms->readx.in.mincnt, parms->readx.in.maxcnt)) {
131 req->status = NT_STATUS_BUFFER_TOO_SMALL;
134 memcpy(parms->readbraw.out.data, req->in.buffer + NBT_HDR_SIZE, parms->readbraw.out.nread);
137 case RAW_READ_LOCKREAD:
138 SMBCLI_CHECK_WCT(req, 5);
139 parms->lockread.out.nread = SVAL(req->in.vwv, VWV(0));
140 if (parms->lockread.out.nread > parms->lockread.in.count ||
141 !smbcli_raw_pull_data(req, req->in.data+3,
142 parms->lockread.out.nread, parms->lockread.out.data)) {
143 req->status = NT_STATUS_BUFFER_TOO_SMALL;
148 /* there are 4 reserved words in the reply */
149 SMBCLI_CHECK_WCT(req, 5);
150 parms->read.out.nread = SVAL(req->in.vwv, VWV(0));
151 if (parms->read.out.nread > parms->read.in.count ||
152 !smbcli_raw_pull_data(req, req->in.data+3,
153 parms->read.out.nread, parms->read.out.data)) {
154 req->status = NT_STATUS_BUFFER_TOO_SMALL;
159 /* there are 5 reserved words in the reply */
160 SMBCLI_CHECK_WCT(req, 12);
161 parms->readx.out.remaining = SVAL(req->in.vwv, VWV(2));
162 parms->readx.out.compaction_mode = SVAL(req->in.vwv, VWV(3));
163 parms->readx.out.nread = SVAL(req->in.vwv, VWV(5));
164 if (parms->readx.out.nread > MAX(parms->readx.in.mincnt, parms->readx.in.maxcnt) ||
165 !smbcli_raw_pull_data(req, req->in.hdr + SVAL(req->in.vwv, VWV(6)),
166 parms->readx.out.nread,
167 parms->readx.out.data)) {
168 req->status = NT_STATUS_BUFFER_TOO_SMALL;
173 req->status = NT_STATUS_INTERNAL_ERROR;
178 return smbcli_request_destroy(req);
181 /****************************************************************************
182 low level read operation (sync interface)
183 ****************************************************************************/
184 NTSTATUS smb_raw_read(struct smbcli_tree *tree, union smb_read *parms)
186 struct smbcli_request *req = smb_raw_read_send(tree, parms);
187 return smb_raw_read_recv(req, parms);
191 /****************************************************************************
192 raw write interface (async send)
193 ****************************************************************************/
194 struct smbcli_request *smb_raw_write_send(struct smbcli_tree *tree, union smb_write *parms)
196 BOOL bigoffset = False;
197 struct smbcli_request *req = NULL;
199 switch (parms->generic.level) {
200 case RAW_WRITE_WRITEUNLOCK:
201 SETUP_REQUEST(SMBwriteunlock, 5, 3 + parms->writeunlock.in.count);
202 SSVAL(req->out.vwv, VWV(0), parms->writeunlock.in.file.fnum);
203 SSVAL(req->out.vwv, VWV(1), parms->writeunlock.in.count);
204 SIVAL(req->out.vwv, VWV(2), parms->writeunlock.in.offset);
205 SSVAL(req->out.vwv, VWV(4), parms->writeunlock.in.remaining);
206 SCVAL(req->out.data, 0, SMB_DATA_BLOCK);
207 SSVAL(req->out.data, 1, parms->writeunlock.in.count);
208 if (parms->writeunlock.in.count > 0) {
209 memcpy(req->out.data+3, parms->writeunlock.in.data,
210 parms->writeunlock.in.count);
214 case RAW_WRITE_WRITE:
215 SETUP_REQUEST(SMBwrite, 5, 3 + parms->write.in.count);
216 SSVAL(req->out.vwv, VWV(0), parms->write.in.file.fnum);
217 SSVAL(req->out.vwv, VWV(1), parms->write.in.count);
218 SIVAL(req->out.vwv, VWV(2), parms->write.in.offset);
219 SSVAL(req->out.vwv, VWV(4), parms->write.in.remaining);
220 SCVAL(req->out.data, 0, SMB_DATA_BLOCK);
221 SSVAL(req->out.data, 1, parms->write.in.count);
222 if (parms->write.in.count > 0) {
223 memcpy(req->out.data+3, parms->write.in.data, parms->write.in.count);
227 case RAW_WRITE_WRITECLOSE:
228 SETUP_REQUEST(SMBwriteclose, 6, 1 + parms->writeclose.in.count);
229 SSVAL(req->out.vwv, VWV(0), parms->writeclose.in.file.fnum);
230 SSVAL(req->out.vwv, VWV(1), parms->writeclose.in.count);
231 SIVAL(req->out.vwv, VWV(2), parms->writeclose.in.offset);
232 raw_push_dos_date3(tree->session->transport,
233 req->out.vwv, VWV(4), parms->writeclose.in.mtime);
234 SCVAL(req->out.data, 0, 0);
235 if (parms->writeclose.in.count > 0) {
236 memcpy(req->out.data+1, parms->writeclose.in.data,
237 parms->writeclose.in.count);
241 case RAW_WRITE_WRITEX:
242 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
245 SETUP_REQUEST(SMBwriteX, bigoffset ? 14 : 12, parms->writex.in.count);
246 SSVAL(req->out.vwv, VWV(0), SMB_CHAIN_NONE);
247 SSVAL(req->out.vwv, VWV(1), 0);
248 SSVAL(req->out.vwv, VWV(2), parms->writex.in.file.fnum);
249 SIVAL(req->out.vwv, VWV(3), parms->writex.in.offset);
250 SIVAL(req->out.vwv, VWV(5), 0); /* reserved */
251 SSVAL(req->out.vwv, VWV(7), parms->writex.in.wmode);
252 SSVAL(req->out.vwv, VWV(8), parms->writex.in.remaining);
253 SSVAL(req->out.vwv, VWV(9), parms->writex.in.count>>16);
254 SSVAL(req->out.vwv, VWV(10), parms->writex.in.count);
255 SSVAL(req->out.vwv, VWV(11), PTR_DIFF(req->out.data, req->out.hdr));
257 SIVAL(req->out.vwv,VWV(12),parms->writex.in.offset>>32);
259 if (parms->writex.in.count > 0) {
260 memcpy(req->out.data, parms->writex.in.data, parms->writex.in.count);
264 case RAW_WRITE_SPLWRITE:
265 SETUP_REQUEST(SMBsplwr, 1, parms->splwrite.in.count);
266 SSVAL(req->out.vwv, VWV(0), parms->splwrite.in.file.fnum);
267 if (parms->splwrite.in.count > 0) {
268 memcpy(req->out.data, parms->splwrite.in.data, parms->splwrite.in.count);
276 if (!smbcli_request_send(req)) {
277 smbcli_request_destroy(req);
285 /****************************************************************************
286 raw write interface (async recv)
287 ****************************************************************************/
288 NTSTATUS smb_raw_write_recv(struct smbcli_request *req, union smb_write *parms)
290 if (!smbcli_request_receive(req) ||
291 smbcli_request_is_error(req)) {
295 switch (parms->generic.level) {
296 case RAW_WRITE_WRITEUNLOCK:
297 SMBCLI_CHECK_WCT(req, 1);
298 parms->writeunlock.out.nwritten = SVAL(req->in.vwv, VWV(0));
300 case RAW_WRITE_WRITE:
301 SMBCLI_CHECK_WCT(req, 1);
302 parms->write.out.nwritten = SVAL(req->in.vwv, VWV(0));
304 case RAW_WRITE_WRITECLOSE:
305 SMBCLI_CHECK_WCT(req, 1);
306 parms->writeclose.out.nwritten = SVAL(req->in.vwv, VWV(0));
308 case RAW_WRITE_WRITEX:
309 SMBCLI_CHECK_WCT(req, 6);
310 parms->writex.out.nwritten = SVAL(req->in.vwv, VWV(2));
311 parms->writex.out.nwritten += (CVAL(req->in.vwv, VWV(4)) << 16);
312 parms->writex.out.remaining = SVAL(req->in.vwv, VWV(3));
314 case RAW_WRITE_SPLWRITE:
317 req->status = NT_STATUS_INTERNAL_ERROR;
322 return smbcli_request_destroy(req);
325 /****************************************************************************
326 raw write interface (sync interface)
327 ****************************************************************************/
328 NTSTATUS smb_raw_write(struct smbcli_tree *tree, union smb_write *parms)
330 struct smbcli_request *req = smb_raw_write_send(tree, parms);
331 return smb_raw_write_recv(req, parms);