Lots of doc updates. Getting ready for 2.2.5 release.
[Samba.git] / source / libsmb / clireadwrite.c
blobca0b1bb2d51d80c895691aba9fa8c1ee88a5ed05
1 /*
2 Unix SMB/Netbios implementation.
3 Version 3.0
4 client file read/write routines
5 Copyright (C) Andrew Tridgell 1994-1998
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.
22 #define NO_SYSLOG
24 #include "includes.h"
26 /****************************************************************************
27 Issue a single SMBread and don't wait for a reply.
28 ****************************************************************************/
30 static BOOL cli_issue_read(struct cli_state *cli, int fnum, off_t offset,
31 size_t size, int i)
33 memset(cli->outbuf,'\0',smb_size);
34 memset(cli->inbuf,'\0',smb_size);
36 set_message(cli->outbuf,10,0,True);
38 SCVAL(cli->outbuf,smb_com,SMBreadX);
39 SSVAL(cli->outbuf,smb_tid,cli->cnum);
40 cli_setup_packet(cli);
42 SCVAL(cli->outbuf,smb_vwv0,0xFF);
43 SSVAL(cli->outbuf,smb_vwv2,fnum);
44 SIVAL(cli->outbuf,smb_vwv3,offset);
45 SSVAL(cli->outbuf,smb_vwv5,size);
46 SSVAL(cli->outbuf,smb_vwv6,size);
47 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
49 return cli_send_smb(cli);
52 /****************************************************************************
53 Issue a single SMBreadraw and don't wait for a reply.
54 ****************************************************************************/
56 static BOOL cli_issue_readraw(struct cli_state *cli, int fnum, off_t offset,
57 size_t size, int i)
59 memset(cli->outbuf,'\0',smb_size);
60 memset(cli->inbuf,'\0',smb_size);
62 set_message(cli->outbuf,10,0,True);
64 SCVAL(cli->outbuf,smb_com,SMBreadbraw);
65 SSVAL(cli->outbuf,smb_tid,cli->cnum);
66 cli_setup_packet(cli);
68 SSVAL(cli->outbuf,smb_vwv0,fnum);
69 SIVAL(cli->outbuf,smb_vwv1,offset);
70 SSVAL(cli->outbuf,smb_vwv2,size);
71 SSVAL(cli->outbuf,smb_vwv3,size);
72 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
74 return cli_send_smb(cli);
77 /****************************************************************************
78 Read size bytes at offset offset using SMBreadX.
79 ****************************************************************************/
81 ssize_t cli_read(struct cli_state *cli, int fnum, char *buf, off_t offset, size_t size)
83 char *p;
84 int size2;
85 int readsize;
86 ssize_t total = 0;
88 if (size == 0)
89 return 0;
92 * Set readsize to the maximum size we can handle in one readX,
93 * rounded down to a multiple of 1024.
96 readsize = (cli->max_xmit - (smb_size+32)) & ~1023;
98 while (total < size) {
99 readsize = MIN(readsize, size-total);
101 /* Issue a read and receive a reply */
103 if (!cli_issue_read(cli, fnum, offset, readsize, 0))
104 return -1;
106 if (!cli_receive_smb(cli))
107 return -1;
109 /* Check for error. Make sure to check for DOS and NT
110 errors. */
112 if (cli_is_error(cli)) {
113 NTSTATUS status = NT_STATUS_OK;
114 uint8 eclass = 0;
115 uint32 ecode = 0;
117 if (cli_is_nt_error(cli))
118 status = cli_nt_error(cli);
119 else
120 cli_dos_error(cli, &eclass, &ecode);
122 if ((eclass == ERRDOS && ecode == ERRmoredata) ||
123 NT_STATUS_V(status) == NT_STATUS_V(STATUS_MORE_ENTRIES))
124 return -1;
127 size2 = SVAL(cli->inbuf, smb_vwv5);
129 if (size2 > readsize) {
130 DEBUG(5,("server returned more than we wanted!\n"));
131 return -1;
132 } else if (size2 < 0) {
133 DEBUG(5,("read return < 0!\n"));
134 return -1;
137 /* Copy data into buffer */
139 p = smb_base(cli->inbuf) + SVAL(cli->inbuf,smb_vwv6);
140 memcpy(buf + total, p, size2);
142 total += size2;
143 offset += size2;
146 * If the server returned less than we asked for we're at EOF.
149 if (size2 < readsize)
150 break;
153 return total;
156 /****************************************************************************
157 Tester for the readraw call.
158 ****************************************************************************/
160 ssize_t cli_readraw(struct cli_state *cli, int fnum, char *buf, off_t offset, size_t size)
162 char *p;
163 int size2;
164 size_t readsize;
165 ssize_t total = 0;
167 if (size == 0)
168 return 0;
171 * Set readsize to the maximum size we can handle in one readraw.
174 readsize = 0xFFFF;
176 while (total < size) {
177 readsize = MIN(readsize, size-total);
179 /* Issue a read and receive a reply */
181 if (!cli_issue_readraw(cli, fnum, offset, readsize, 0))
182 return -1;
184 if (!client_receive_smb(cli->fd, cli->inbuf, cli->timeout))
185 return -1;
187 size2 = smb_len(cli->inbuf);
189 if (size2 > readsize) {
190 DEBUG(5,("server returned more than we wanted!\n"));
191 return -1;
192 } else if (size2 < 0) {
193 DEBUG(5,("read return < 0!\n"));
194 return -1;
197 /* Copy data into buffer */
199 if (size2) {
200 p = cli->inbuf + 4;
201 memcpy(buf + total, p, size2);
204 total += size2;
205 offset += size2;
208 * If the server returned less than we asked for we're at EOF.
211 if (size2 < readsize)
212 break;
215 return total;
218 /****************************************************************************
219 issue a single SMBwrite and don't wait for a reply
220 ****************************************************************************/
222 static BOOL cli_issue_write(struct cli_state *cli, int fnum, off_t offset, uint16 mode, char *buf,
223 size_t size, int i)
225 char *p;
227 if (size > cli->bufsize) {
228 cli->outbuf = realloc(cli->outbuf, size + 1024);
229 cli->inbuf = realloc(cli->inbuf, size + 1024);
230 if (cli->outbuf == NULL || cli->inbuf == NULL)
231 return False;
232 cli->bufsize = size + 1024;
235 memset(cli->outbuf,'\0',smb_size);
236 memset(cli->inbuf,'\0',smb_size);
238 if (size > 0xFFFF)
239 set_message(cli->outbuf,14,0,True);
240 else
241 set_message(cli->outbuf,12,0,True);
243 SCVAL(cli->outbuf,smb_com,SMBwriteX);
244 SSVAL(cli->outbuf,smb_tid,cli->cnum);
245 cli_setup_packet(cli);
247 SCVAL(cli->outbuf,smb_vwv0,0xFF);
248 SSVAL(cli->outbuf,smb_vwv2,fnum);
250 SIVAL(cli->outbuf,smb_vwv3,offset);
251 SIVAL(cli->outbuf,smb_vwv5,(mode & 0x0008) ? 0xFFFFFFFF : 0);
252 SSVAL(cli->outbuf,smb_vwv7,mode);
254 SSVAL(cli->outbuf,smb_vwv8,(mode & 0x0008) ? size : 0);
255 SSVAL(cli->outbuf,smb_vwv9,((size>>16)&1));
256 SSVAL(cli->outbuf,smb_vwv10,size);
257 SSVAL(cli->outbuf,smb_vwv11,
258 smb_buf(cli->outbuf) - smb_base(cli->outbuf));
260 p = smb_base(cli->outbuf) + SVAL(cli->outbuf,smb_vwv11);
261 memcpy(p, buf, size);
262 cli_setup_bcc(cli, p+size);
264 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
266 show_msg(cli->outbuf);
267 return cli_send_smb(cli);
270 /****************************************************************************
271 write to a file
272 write_mode: 0x0001 disallow write cacheing
273 0x0002 return bytes remaining
274 0x0004 use raw named pipe protocol
275 0x0008 start of message mode named pipe protocol
276 ****************************************************************************/
278 ssize_t cli_write(struct cli_state *cli,
279 int fnum, uint16 write_mode,
280 char *buf, off_t offset, size_t size)
282 int bwritten = 0;
283 int issued = 0;
284 int received = 0;
285 int mpx = MAX(cli->max_mux-1, 1);
286 int block = (cli->max_xmit - (smb_size+32)) & ~1023;
287 int blocks = (size + (block-1)) / block;
289 while (received < blocks) {
291 while ((issued - received < mpx) && (issued < blocks)) {
292 int bsent = issued * block;
293 int size1 = MIN(block, size - bsent);
295 if (!cli_issue_write(cli, fnum, offset + bsent,
296 write_mode,
297 buf + bsent,
298 size1, issued))
299 return -1;
300 issued++;
303 if (!cli_receive_smb(cli))
304 return bwritten;
306 received++;
308 if (cli_is_error(cli))
309 break;
311 bwritten += SVAL(cli->inbuf, smb_vwv2);
312 bwritten += (((int)(SVAL(cli->inbuf, smb_vwv4)))>>16);
315 while (received < issued && cli_receive_smb(cli))
316 received++;
318 return bwritten;
321 /****************************************************************************
322 write to a file using a SMBwrite and not bypassing 0 byte writes
323 ****************************************************************************/
325 ssize_t cli_smbwrite(struct cli_state *cli,
326 int fnum, char *buf, off_t offset, size_t size1)
328 char *p;
329 ssize_t total = 0;
331 do {
332 size_t size = MIN(size1, cli->max_xmit - 48);
334 memset(cli->outbuf,'\0',smb_size);
335 memset(cli->inbuf,'\0',smb_size);
337 set_message(cli->outbuf,5, 0,True);
339 SCVAL(cli->outbuf,smb_com,SMBwrite);
340 SSVAL(cli->outbuf,smb_tid,cli->cnum);
341 cli_setup_packet(cli);
343 SSVAL(cli->outbuf,smb_vwv0,fnum);
344 SSVAL(cli->outbuf,smb_vwv1,size);
345 SIVAL(cli->outbuf,smb_vwv2,offset);
346 SSVAL(cli->outbuf,smb_vwv4,0);
348 p = smb_buf(cli->outbuf);
349 *p++ = 1;
350 SSVAL(p, 0, size); p += 2;
351 memcpy(p, buf, size); p += size;
353 cli_setup_bcc(cli, p);
355 if (!cli_send_smb(cli))
356 return -1;
358 if (!cli_receive_smb(cli))
359 return -1;
361 if (cli_is_error(cli))
362 return -1;
364 size = SVAL(cli->inbuf,smb_vwv0);
365 if (size == 0)
366 break;
368 size1 -= size;
369 total += size;
370 offset += size;
372 } while (size1);
374 return total;