2 Unix SMB/CIFS implementation.
3 client file read/write routines
4 Copyright (C) Andrew Tridgell 1994-1998
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.
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.
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/>.
22 /****************************************************************************
23 Calculate the recommended read buffer size
24 ****************************************************************************/
25 static size_t cli_read_max_bufsize(struct cli_state *cli)
27 if (!client_is_signing_on(cli) && !cli_encryption_on(cli)
28 && (cli->posix_capabilities & CIFS_UNIX_LARGE_READ_CAP)) {
29 return CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE;
31 if (cli->capabilities & CAP_LARGE_READX) {
33 ? CLI_SAMBA_MAX_LARGE_READX_SIZE
34 : CLI_WINDOWS_MAX_LARGE_READX_SIZE;
36 return (cli->max_xmit - (smb_size+32)) & ~1023;
40 * Send a read&x request
43 struct async_req *cli_read_andx_send(TALLOC_CTX *mem_ctx,
44 struct event_context *ev,
45 struct cli_state *cli, int fnum,
46 off_t offset, size_t size)
48 struct async_req *result;
49 struct cli_request *req;
50 bool bigoffset = False;
55 if (size > cli_read_max_bufsize(cli)) {
56 DEBUG(0, ("cli_read_andx_send got size=%d, can only handle "
57 "size=%d\n", (int)size,
58 (int)cli_read_max_bufsize(cli)));
62 SCVAL(vwv + 0, 0, 0xFF);
65 SSVAL(vwv + 2, 0, fnum);
66 SIVAL(vwv + 3, 0, offset);
67 SSVAL(vwv + 5, 0, size);
68 SSVAL(vwv + 6, 0, size);
69 SSVAL(vwv + 7, 0, (size >> 16));
73 if ((uint64_t)offset >> 32) {
76 (((uint64_t)offset)>>32) & 0xffffffff);
80 result = cli_request_send(mem_ctx, ev, cli, SMBreadX, 0, wct, vwv,
86 req = talloc_get_type_abort(result->private_data, struct cli_request);
88 req->data.read.ofs = offset;
89 req->data.read.size = size;
90 req->data.read.received = 0;
91 req->data.read.rcvbuf = NULL;
97 * Pull the data out of a finished async read_and_x request. rcvbuf is
98 * talloced from the request, so better make sure that you copy it away before
99 * you talloc_free(req). "rcvbuf" is NOT a talloc_ctx of its own, so do not
103 NTSTATUS cli_read_andx_recv(struct async_req *req, ssize_t *received,
106 struct cli_request *cli_req = talloc_get_type_abort(
107 req->private_data, struct cli_request);
115 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
116 if (req->state == ASYNC_REQ_ERROR) {
120 status = cli_pull_reply(req, &wct, &vwv, &num_bytes, &bytes);
122 if (NT_STATUS_IS_ERR(status)) {
127 return NT_STATUS_INVALID_NETWORK_RESPONSE;
130 /* size is the number of bytes the server returned.
132 size = SVAL(vwv + 5, 0);
133 size |= (((unsigned int)SVAL(vwv + 7, 0)) << 16);
135 if (size > cli_req->data.read.size) {
136 DEBUG(5,("server returned more than we wanted!\n"));
137 return NT_STATUS_UNEXPECTED_IO_ERROR;
140 *rcvbuf = (uint8_t *)(smb_base(cli_req->inbuf) + SVAL(vwv + 6, 0));
146 * Parallel read support.
148 * cli_pull sends as many read&x requests as the server would allow via
149 * max_mux at a time. When replies flow back in, the data is written into
150 * the callback function "sink" in the right order.
153 struct cli_pull_state {
154 struct async_req *req;
156 struct event_context *ev;
157 struct cli_state *cli;
162 NTSTATUS (*sink)(char *buf, size_t n, void *priv);
168 * Outstanding requests
171 struct async_req **reqs;
174 * For how many bytes did we send requests already?
179 * Next request index to push into "sink". This walks around the "req"
180 * array, taking care that the requests are pushed to "sink" in the
181 * right order. If necessary (i.e. replies don't come in in the right
182 * order), replies are held back in "reqs".
187 * How many bytes did we push into "sink"?
193 static char *cli_pull_print(TALLOC_CTX *mem_ctx, struct async_req *req)
195 struct cli_pull_state *state = talloc_get_type_abort(
196 req->private_data, struct cli_pull_state);
199 result = async_req_print(mem_ctx, req);
200 if (result == NULL) {
204 return talloc_asprintf_append_buffer(
205 result, "num_reqs=%d, top_req=%d",
206 state->num_reqs, state->top_req);
209 static void cli_pull_read_done(struct async_req *read_req);
212 * Prepare an async pull request
215 struct async_req *cli_pull_send(TALLOC_CTX *mem_ctx,
216 struct event_context *ev,
217 struct cli_state *cli,
218 uint16_t fnum, off_t start_offset,
219 SMB_OFF_T size, size_t window_size,
220 NTSTATUS (*sink)(char *buf, size_t n,
224 struct async_req *result;
225 struct cli_pull_state *state;
228 result = async_req_new(mem_ctx, ev);
229 if (result == NULL) {
232 state = talloc(result, struct cli_pull_state);
236 result->private_data = state;
237 result->print = cli_pull_print;
243 state->start_offset = start_offset;
252 if (!async_post_status(result, NT_STATUS_OK)) {
258 state->chunk_size = cli_read_max_bufsize(cli);
260 state->num_reqs = MAX(window_size/state->chunk_size, 1);
261 state->num_reqs = MIN(state->num_reqs, cli->max_mux);
263 state->reqs = TALLOC_ZERO_ARRAY(state, struct async_req *,
265 if (state->reqs == NULL) {
269 state->requested = 0;
271 for (i=0; i<state->num_reqs; i++) {
273 size_t request_thistime;
275 if (state->requested >= size) {
280 size_left = size - state->requested;
281 request_thistime = MIN(size_left, state->chunk_size);
283 state->reqs[i] = cli_read_andx_send(
284 state->reqs, ev, cli, fnum,
285 state->start_offset + state->requested,
288 if (state->reqs[i] == NULL) {
292 state->reqs[i]->async.fn = cli_pull_read_done;
293 state->reqs[i]->async.priv = result;
295 state->requested += request_thistime;
305 * Handle incoming read replies, push the data into sink and send out new
306 * requests if necessary.
309 static void cli_pull_read_done(struct async_req *read_req)
311 struct async_req *pull_req = talloc_get_type_abort(
312 read_req->async.priv, struct async_req);
313 struct cli_pull_state *state = talloc_get_type_abort(
314 pull_req->private_data, struct cli_pull_state);
315 struct cli_request *read_state = talloc_get_type_abort(
316 read_req->private_data, struct cli_request);
319 status = cli_read_andx_recv(read_req, &read_state->data.read.received,
320 &read_state->data.read.rcvbuf);
321 if (!NT_STATUS_IS_OK(status)) {
322 async_req_error(state->req, status);
327 * This loop is the one to take care of out-of-order replies. All
328 * pending requests are in state->reqs, state->reqs[top_req] is the
329 * one that is to be pushed next. If however a request later than
330 * top_req is replied to, then we can't push yet. If top_req is
331 * replied to at a later point then, we need to push all the finished
335 while (state->reqs[state->top_req] != NULL) {
336 struct cli_request *top_read;
338 DEBUG(11, ("cli_pull_read_done: top_req = %d\n",
341 if (state->reqs[state->top_req]->state < ASYNC_REQ_DONE) {
342 DEBUG(11, ("cli_pull_read_done: top request not yet "
347 top_read = talloc_get_type_abort(
348 state->reqs[state->top_req]->private_data,
351 DEBUG(10, ("cli_pull_read_done: Pushing %d bytes, %d already "
352 "pushed\n", (int)top_read->data.read.received,
353 (int)state->pushed));
355 status = state->sink((char *)top_read->data.read.rcvbuf,
356 top_read->data.read.received,
358 if (!NT_STATUS_IS_OK(status)) {
359 async_req_error(state->req, status);
362 state->pushed += top_read->data.read.received;
364 TALLOC_FREE(state->reqs[state->top_req]);
366 if (state->requested < state->size) {
367 struct async_req *new_req;
369 size_t request_thistime;
371 size_left = state->size - state->requested;
372 request_thistime = MIN(size_left, state->chunk_size);
374 DEBUG(10, ("cli_pull_read_done: Requesting %d bytes "
375 "at %d, position %d\n",
376 (int)request_thistime,
377 (int)(state->start_offset
381 new_req = cli_read_andx_send(
382 state->reqs, state->ev, state->cli,
384 state->start_offset + state->requested,
387 if (async_req_nomem(new_req, state->req)) {
391 new_req->async.fn = cli_pull_read_done;
392 new_req->async.priv = pull_req;
394 state->reqs[state->top_req] = new_req;
395 state->requested += request_thistime;
398 state->top_req = (state->top_req+1) % state->num_reqs;
401 async_req_done(pull_req);
404 NTSTATUS cli_pull_recv(struct async_req *req, SMB_OFF_T *received)
406 struct cli_pull_state *state = talloc_get_type_abort(
407 req->private_data, struct cli_pull_state);
409 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
410 if (req->state == ASYNC_REQ_ERROR) {
413 *received = state->pushed;
417 NTSTATUS cli_pull(struct cli_state *cli, uint16_t fnum,
418 off_t start_offset, SMB_OFF_T size, size_t window_size,
419 NTSTATUS (*sink)(char *buf, size_t n, void *priv),
420 void *priv, SMB_OFF_T *received)
422 TALLOC_CTX *frame = talloc_stackframe();
423 struct event_context *ev;
424 struct async_req *req;
425 NTSTATUS result = NT_STATUS_NO_MEMORY;
427 if (cli->fd_event != NULL) {
429 * Can't use sync call while an async call is in flight
431 return NT_STATUS_INVALID_PARAMETER;
434 ev = event_context_init(frame);
439 req = cli_pull_send(frame, ev, cli, fnum, start_offset, size,
440 window_size, sink, priv);
445 while (req->state < ASYNC_REQ_DONE) {
449 result = cli_pull_recv(req, received);
455 static NTSTATUS cli_read_sink(char *buf, size_t n, void *priv)
457 char **pbuf = (char **)priv;
458 memcpy(*pbuf, buf, n);
463 ssize_t cli_read(struct cli_state *cli, int fnum, char *buf,
464 off_t offset, size_t size)
469 status = cli_pull(cli, fnum, offset, size, size,
470 cli_read_sink, &buf, &ret);
471 if (!NT_STATUS_IS_OK(status)) {
472 cli_set_error(cli, status);
478 /****************************************************************************
479 Issue a single SMBwrite and don't wait for a reply.
480 ****************************************************************************/
482 static bool cli_issue_write(struct cli_state *cli,
491 bool large_writex = false;
492 /* We can only do direct writes if not signing and not encrypting. */
493 bool direct_writes = !client_is_signing_on(cli) && !cli_encryption_on(cli);
495 if (!direct_writes && size + 1 > cli->bufsize) {
496 cli->outbuf = (char *)SMB_REALLOC(cli->outbuf, size + 1024);
500 cli->inbuf = (char *)SMB_REALLOC(cli->inbuf, size + 1024);
501 if (cli->inbuf == NULL) {
502 SAFE_FREE(cli->outbuf);
505 cli->bufsize = size + 1024;
508 memset(cli->outbuf,'\0',smb_size);
509 memset(cli->inbuf,'\0',smb_size);
511 if (cli->capabilities & CAP_LARGE_FILES) {
516 cli_set_message(cli->outbuf,14,0,True);
518 cli_set_message(cli->outbuf,12,0,True);
521 SCVAL(cli->outbuf,smb_com,SMBwriteX);
522 SSVAL(cli->outbuf,smb_tid,cli->cnum);
523 cli_setup_packet(cli);
525 SCVAL(cli->outbuf,smb_vwv0,0xFF);
526 SSVAL(cli->outbuf,smb_vwv2,fnum);
528 SIVAL(cli->outbuf,smb_vwv3,offset);
529 SIVAL(cli->outbuf,smb_vwv5,0);
530 SSVAL(cli->outbuf,smb_vwv7,mode);
532 SSVAL(cli->outbuf,smb_vwv8,(mode & 0x0008) ? size : 0);
534 * According to CIFS-TR-1p00, this following field should only
535 * be set if CAP_LARGE_WRITEX is set. We should check this
536 * locally. However, this check might already have been
537 * done by our callers.
539 SSVAL(cli->outbuf,smb_vwv9,(size>>16));
540 SSVAL(cli->outbuf,smb_vwv10,size);
541 /* +1 is pad byte. */
542 SSVAL(cli->outbuf,smb_vwv11,
543 smb_buf(cli->outbuf) - smb_base(cli->outbuf) + 1);
546 SIVAL(cli->outbuf,smb_vwv12,(((uint64_t)offset)>>32) & 0xffffffff);
549 p = smb_base(cli->outbuf) + SVAL(cli->outbuf,smb_vwv11) -1;
550 *p++ = '\0'; /* pad byte. */
551 if (!direct_writes) {
552 memcpy(p, buf, size);
554 if (size > 0x1FFFF) {
555 /* This is a POSIX 14 word large write. */
556 set_message_bcc(cli->outbuf, 0); /* Set bcc to zero. */
557 _smb_setlen_large(cli->outbuf,smb_size + 28 + 1 /* pad */ + size - 4);
559 cli_setup_bcc(cli, p+size);
562 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
564 show_msg(cli->outbuf);
566 /* For direct writes we now need to write the data
567 * directly out of buf. */
568 return cli_send_smb_direct_writeX(cli, buf, size);
570 return cli_send_smb(cli);
574 /****************************************************************************
576 write_mode: 0x0001 disallow write cacheing
577 0x0002 return bytes remaining
578 0x0004 use raw named pipe protocol
579 0x0008 start of message mode named pipe protocol
580 ****************************************************************************/
582 ssize_t cli_write(struct cli_state *cli,
583 int fnum, uint16 write_mode,
584 const char *buf, off_t offset, size_t size)
586 ssize_t bwritten = 0;
587 unsigned int issued = 0;
588 unsigned int received = 0;
593 if(cli->max_mux > 1) {
594 mpx = cli->max_mux-1;
599 /* Default (small) writesize. */
600 writesize = (cli->max_xmit - (smb_size+32)) & ~1023;
602 if (write_mode == 0 &&
603 !client_is_signing_on(cli) &&
604 !cli_encryption_on(cli) &&
605 (cli->posix_capabilities & CIFS_UNIX_LARGE_WRITE_CAP) &&
606 (cli->capabilities & CAP_LARGE_FILES)) {
607 /* Only do massive writes if we can do them direct
608 * with no signing or encrypting - not on a pipe. */
609 writesize = CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE;
610 } else if ((cli->capabilities & CAP_LARGE_WRITEX) &&
611 (strcmp(cli->dev, "LPT1:") != 0)) {
613 /* Printer devices are restricted to max_xmit
614 * writesize in Vista and XPSP3. */
617 writesize = CLI_SAMBA_MAX_LARGE_WRITEX_SIZE;
618 } else if (!client_is_signing_on(cli)) {
619 /* Windows restricts signed writes to max_xmit.
620 * Found by Volker. */
621 writesize = CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE;
625 blocks = (size + (writesize-1)) / writesize;
627 while (received < blocks) {
629 while ((issued - received < mpx) && (issued < blocks)) {
630 ssize_t bsent = issued * writesize;
631 ssize_t size1 = MIN(writesize, size - bsent);
633 if (!cli_issue_write(cli, fnum, offset + bsent,
641 if (!cli_receive_smb(cli)) {
647 if (cli_is_error(cli))
650 bwritten += SVAL(cli->inbuf, smb_vwv2);
651 if (writesize > 0xFFFF) {
652 bwritten += (((int)(SVAL(cli->inbuf, smb_vwv4)))<<16);
656 while (received < issued && cli_receive_smb(cli)) {
663 /****************************************************************************
664 write to a file using a SMBwrite and not bypassing 0 byte writes
665 ****************************************************************************/
667 ssize_t cli_smbwrite(struct cli_state *cli,
668 int fnum, char *buf, off_t offset, size_t size1)
674 size_t size = MIN(size1, cli->max_xmit - 48);
676 memset(cli->outbuf,'\0',smb_size);
677 memset(cli->inbuf,'\0',smb_size);
679 cli_set_message(cli->outbuf,5, 0,True);
681 SCVAL(cli->outbuf,smb_com,SMBwrite);
682 SSVAL(cli->outbuf,smb_tid,cli->cnum);
683 cli_setup_packet(cli);
685 SSVAL(cli->outbuf,smb_vwv0,fnum);
686 SSVAL(cli->outbuf,smb_vwv1,size);
687 SIVAL(cli->outbuf,smb_vwv2,offset);
688 SSVAL(cli->outbuf,smb_vwv4,0);
690 p = smb_buf(cli->outbuf);
692 SSVAL(p, 0, size); p += 2;
693 memcpy(p, buf + total, size); p += size;
695 cli_setup_bcc(cli, p);
697 if (!cli_send_smb(cli))
700 if (!cli_receive_smb(cli))
703 if (cli_is_error(cli))
706 size = SVAL(cli->inbuf,smb_vwv0);