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 cli_state *cli, int fnum,
45 off_t offset, size_t size)
47 struct async_req *result;
48 struct cli_request *req;
49 bool bigoffset = False;
52 if (size > cli_read_max_bufsize(cli)) {
53 DEBUG(0, ("cli_read_andx_send got size=%d, can only handle "
54 "size=%d\n", (int)size,
55 (int)cli_read_max_bufsize(cli)));
59 result = cli_request_new(mem_ctx, cli->event_ctx, cli, 12, 0, &req);
61 DEBUG(0, ("cli_request_new failed\n"));
65 req = cli_request_get(result);
67 req->data.read.ofs = offset;
68 req->data.read.size = size;
69 req->data.read.received = 0;
70 req->data.read.rcvbuf = NULL;
72 if ((SMB_BIG_UINT)offset >> 32)
75 cli_set_message(req->outbuf, bigoffset ? 12 : 10, 0, False);
77 SCVAL(req->outbuf,smb_com,SMBreadX);
78 SSVAL(req->outbuf,smb_tid,cli->cnum);
79 cli_setup_packet_buf(cli, req->outbuf);
81 SCVAL(req->outbuf,smb_vwv0,0xFF);
82 SCVAL(req->outbuf,smb_vwv0+1,0);
83 SSVAL(req->outbuf,smb_vwv1,0);
84 SSVAL(req->outbuf,smb_vwv2,fnum);
85 SIVAL(req->outbuf,smb_vwv3,offset);
86 SSVAL(req->outbuf,smb_vwv5,size);
87 SSVAL(req->outbuf,smb_vwv6,size);
88 SSVAL(req->outbuf,smb_vwv7,(size >> 16));
89 SSVAL(req->outbuf,smb_vwv8,0);
90 SSVAL(req->outbuf,smb_vwv9,0);
91 SSVAL(req->outbuf,smb_mid,req->mid);
94 SIVAL(req->outbuf, smb_vwv10,
95 (((SMB_BIG_UINT)offset)>>32) & 0xffffffff);
98 cli_calculate_sign_mac(cli, req->outbuf);
100 event_fd_set_writeable(cli->fd_event);
102 if (cli_encryption_on(cli)) {
104 status = cli_encrypt_message(cli, req->outbuf, &enc_buf);
105 if (!NT_STATUS_IS_OK(status)) {
106 DEBUG(0, ("Error in encrypting client message. "
107 "Error %s\n", nt_errstr(status)));
111 req->outbuf = enc_buf;
112 req->enc_state = cli->trans_enc_state;
119 * Pull the data out of a finished async read_and_x request. rcvbuf is
120 * talloced from the request, so better make sure that you copy it away before
121 * you talloc_free(req). "rcvbuf" is NOT a talloc_ctx of its own, so do not
125 NTSTATUS cli_read_andx_recv(struct async_req *req, ssize_t *received,
128 struct cli_request *cli_req = cli_request_get(req);
132 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
133 if (req->state == ASYNC_REQ_ERROR) {
137 status = cli_pull_error(cli_req->inbuf);
139 if (NT_STATUS_IS_ERR(status)) {
143 /* size is the number of bytes the server returned.
145 size = SVAL(cli_req->inbuf, smb_vwv5);
146 size |= (((unsigned int)(SVAL(cli_req->inbuf, smb_vwv7))) << 16);
148 if (size > cli_req->data.read.size) {
149 DEBUG(5,("server returned more than we wanted!\n"));
150 return NT_STATUS_UNEXPECTED_IO_ERROR;
154 DEBUG(5,("read return < 0!\n"));
155 return NT_STATUS_UNEXPECTED_IO_ERROR;
158 *rcvbuf = (uint8_t *)
159 (smb_base(cli_req->inbuf) + SVAL(cli_req->inbuf, smb_vwv6));
165 * Parallel read support.
167 * cli_pull sends as many read&x requests as the server would allow via
168 * max_mux at a time. When replies flow back in, the data is written into
169 * the callback function "sink" in the right order.
172 struct cli_pull_state {
173 struct async_req *req;
175 struct cli_state *cli;
180 NTSTATUS (*sink)(char *buf, size_t n, void *priv);
186 * Outstanding requests
189 struct async_req **reqs;
192 * For how many bytes did we send requests already?
197 * Next request index to push into "sink". This walks around the "req"
198 * array, taking care that the requests are pushed to "sink" in the
199 * right order. If necessary (i.e. replies don't come in in the right
200 * order), replies are held back in "reqs".
205 * How many bytes did we push into "sink"?
211 static char *cli_pull_print(TALLOC_CTX *mem_ctx, struct async_req *req)
213 struct cli_pull_state *state = talloc_get_type_abort(
214 req->private_data, struct cli_pull_state);
217 result = async_req_print(mem_ctx, req);
218 if (result == NULL) {
222 return talloc_asprintf_append_buffer(
223 result, "num_reqs=%d, top_req=%d",
224 state->num_reqs, state->top_req);
227 static void cli_pull_read_done(struct async_req *read_req);
230 * Prepare an async pull request
233 struct async_req *cli_pull_send(TALLOC_CTX *mem_ctx, struct cli_state *cli,
234 uint16_t fnum, off_t start_offset,
235 SMB_OFF_T size, size_t window_size,
236 NTSTATUS (*sink)(char *buf, size_t n,
240 struct async_req *result;
241 struct cli_pull_state *state;
244 result = async_req_new(mem_ctx, cli->event_ctx);
245 if (result == NULL) {
248 state = talloc(result, struct cli_pull_state);
252 result->private_data = state;
253 result->print = cli_pull_print;
258 state->start_offset = start_offset;
267 if (!async_post_status(result, NT_STATUS_OK)) {
273 state->chunk_size = cli_read_max_bufsize(cli);
275 state->num_reqs = MAX(window_size/state->chunk_size, 1);
276 state->num_reqs = MIN(state->num_reqs, cli->max_mux);
278 state->reqs = TALLOC_ZERO_ARRAY(state, struct async_req *,
280 if (state->reqs == NULL) {
284 state->requested = 0;
286 for (i=0; i<state->num_reqs; i++) {
288 size_t request_thistime;
290 if (state->requested >= size) {
295 size_left = size - state->requested;
296 request_thistime = MIN(size_left, state->chunk_size);
298 state->reqs[i] = cli_read_andx_send(
299 state->reqs, cli, fnum,
300 state->start_offset + state->requested,
303 if (state->reqs[i] == NULL) {
307 state->reqs[i]->async.fn = cli_pull_read_done;
308 state->reqs[i]->async.priv = result;
310 state->requested += request_thistime;
320 * Handle incoming read replies, push the data into sink and send out new
321 * requests if necessary.
324 static void cli_pull_read_done(struct async_req *read_req)
326 struct async_req *pull_req = talloc_get_type_abort(
327 read_req->async.priv, struct async_req);
328 struct cli_pull_state *state = talloc_get_type_abort(
329 pull_req->private_data, struct cli_pull_state);
330 struct cli_request *read_state = cli_request_get(read_req);
333 status = cli_read_andx_recv(read_req, &read_state->data.read.received,
334 &read_state->data.read.rcvbuf);
335 if (!NT_STATUS_IS_OK(status)) {
336 async_req_error(state->req, status);
341 * This loop is the one to take care of out-of-order replies. All
342 * pending requests are in state->reqs, state->reqs[top_req] is the
343 * one that is to be pushed next. If however a request later than
344 * top_req is replied to, then we can't push yet. If top_req is
345 * replied to at a later point then, we need to push all the finished
349 while (state->reqs[state->top_req] != NULL) {
350 struct cli_request *top_read;
352 DEBUG(11, ("cli_pull_read_done: top_req = %d\n",
355 if (state->reqs[state->top_req]->state < ASYNC_REQ_DONE) {
356 DEBUG(11, ("cli_pull_read_done: top request not yet "
361 top_read = cli_request_get(state->reqs[state->top_req]);
363 DEBUG(10, ("cli_pull_read_done: Pushing %d bytes, %d already "
364 "pushed\n", (int)top_read->data.read.received,
365 (int)state->pushed));
367 status = state->sink((char *)top_read->data.read.rcvbuf,
368 top_read->data.read.received,
370 if (!NT_STATUS_IS_OK(status)) {
371 async_req_error(state->req, status);
374 state->pushed += top_read->data.read.received;
376 TALLOC_FREE(state->reqs[state->top_req]);
378 if (state->requested < state->size) {
379 struct async_req *new_req;
381 size_t request_thistime;
383 size_left = state->size - state->requested;
384 request_thistime = MIN(size_left, state->chunk_size);
386 DEBUG(10, ("cli_pull_read_done: Requesting %d bytes "
387 "at %d, position %d\n",
388 (int)request_thistime,
389 (int)(state->start_offset
393 new_req = cli_read_andx_send(
394 state->reqs, state->cli, state->fnum,
395 state->start_offset + state->requested,
398 if (async_req_nomem(new_req, state->req)) {
402 new_req->async.fn = cli_pull_read_done;
403 new_req->async.priv = pull_req;
405 state->reqs[state->top_req] = new_req;
406 state->requested += request_thistime;
409 state->top_req = (state->top_req+1) % state->num_reqs;
412 async_req_done(pull_req);
415 NTSTATUS cli_pull_recv(struct async_req *req, SMB_OFF_T *received)
417 struct cli_pull_state *state = talloc_get_type_abort(
418 req->private_data, struct cli_pull_state);
420 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
421 if (req->state == ASYNC_REQ_ERROR) {
424 *received = state->pushed;
428 NTSTATUS cli_pull(struct cli_state *cli, uint16_t fnum,
429 off_t start_offset, SMB_OFF_T size, size_t window_size,
430 NTSTATUS (*sink)(char *buf, size_t n, void *priv),
431 void *priv, SMB_OFF_T *received)
433 TALLOC_CTX *frame = talloc_stackframe();
434 struct async_req *req;
435 NTSTATUS result = NT_STATUS_NO_MEMORY;
437 if (cli_tmp_event_ctx(frame, cli) == NULL) {
441 req = cli_pull_send(frame, cli, fnum, start_offset, size, window_size,
447 while (req->state < ASYNC_REQ_DONE) {
448 event_loop_once(cli->event_ctx);
451 result = cli_pull_recv(req, received);
457 static NTSTATUS cli_read_sink(char *buf, size_t n, void *priv)
459 char **pbuf = (char **)priv;
460 memcpy(*pbuf, buf, n);
465 ssize_t cli_read(struct cli_state *cli, int fnum, char *buf,
466 off_t offset, size_t size)
471 status = cli_pull(cli, fnum, offset, size, size,
472 cli_read_sink, &buf, &ret);
473 if (!NT_STATUS_IS_OK(status)) {
474 cli_set_error(cli, status);
480 #if 0 /* relies on client_receive_smb(), now a static in libsmb/clientgen.c */
482 /* This call is INCOMPATIBLE with SMB signing. If you remove the #if 0
483 you must fix ensure you don't attempt to sign the packets - data
484 *will* be currupted */
486 /****************************************************************************
487 Issue a single SMBreadraw and don't wait for a reply.
488 ****************************************************************************/
490 static bool cli_issue_readraw(struct cli_state *cli, int fnum, off_t offset,
494 if (!cli->sign_info.use_smb_signing) {
495 DEBUG(0, ("Cannot use readraw and SMB Signing\n"));
499 memset(cli->outbuf,'\0',smb_size);
500 memset(cli->inbuf,'\0',smb_size);
502 cli_set_message(cli->outbuf,10,0,True);
504 SCVAL(cli->outbuf,smb_com,SMBreadbraw);
505 SSVAL(cli->outbuf,smb_tid,cli->cnum);
506 cli_setup_packet(cli);
508 SSVAL(cli->outbuf,smb_vwv0,fnum);
509 SIVAL(cli->outbuf,smb_vwv1,offset);
510 SSVAL(cli->outbuf,smb_vwv2,size);
511 SSVAL(cli->outbuf,smb_vwv3,size);
512 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
514 return cli_send_smb(cli);
517 /****************************************************************************
518 Tester for the readraw call.
519 ****************************************************************************/
521 ssize_t cli_readraw(struct cli_state *cli, int fnum, char *buf, off_t offset, size_t size)
532 * Set readsize to the maximum size we can handle in one readraw.
537 while (total < size) {
538 readsize = MIN(readsize, size-total);
540 /* Issue a read and receive a reply */
542 if (!cli_issue_readraw(cli, fnum, offset, readsize, 0))
545 if (!client_receive_smb(cli->fd, cli->inbuf, cli->timeout))
548 size2 = smb_len(cli->inbuf);
550 if (size2 > readsize) {
551 DEBUG(5,("server returned more than we wanted!\n"));
553 } else if (size2 < 0) {
554 DEBUG(5,("read return < 0!\n"));
558 /* Copy data into buffer */
562 memcpy(buf + total, p, size2);
569 * If the server returned less than we asked for we're at EOF.
572 if (size2 < readsize)
580 /****************************************************************************
581 Issue a single SMBwrite and don't wait for a reply.
582 ****************************************************************************/
584 static bool cli_issue_write(struct cli_state *cli,
593 bool large_writex = false;
594 /* We can only do direct writes if not signing and not encrypting. */
595 bool direct_writes = !client_is_signing_on(cli) && !cli_encryption_on(cli);
597 if (!direct_writes && size + 1 > cli->bufsize) {
598 cli->outbuf = (char *)SMB_REALLOC(cli->outbuf, size + 1024);
602 cli->inbuf = (char *)SMB_REALLOC(cli->inbuf, size + 1024);
603 if (cli->inbuf == NULL) {
604 SAFE_FREE(cli->outbuf);
607 cli->bufsize = size + 1024;
610 memset(cli->outbuf,'\0',smb_size);
611 memset(cli->inbuf,'\0',smb_size);
613 if (cli->capabilities & CAP_LARGE_FILES) {
618 cli_set_message(cli->outbuf,14,0,True);
620 cli_set_message(cli->outbuf,12,0,True);
623 SCVAL(cli->outbuf,smb_com,SMBwriteX);
624 SSVAL(cli->outbuf,smb_tid,cli->cnum);
625 cli_setup_packet(cli);
627 SCVAL(cli->outbuf,smb_vwv0,0xFF);
628 SSVAL(cli->outbuf,smb_vwv2,fnum);
630 SIVAL(cli->outbuf,smb_vwv3,offset);
631 SIVAL(cli->outbuf,smb_vwv5,0);
632 SSVAL(cli->outbuf,smb_vwv7,mode);
634 SSVAL(cli->outbuf,smb_vwv8,(mode & 0x0008) ? size : 0);
636 * According to CIFS-TR-1p00, this following field should only
637 * be set if CAP_LARGE_WRITEX is set. We should check this
638 * locally. However, this check might already have been
639 * done by our callers.
641 SSVAL(cli->outbuf,smb_vwv9,(size>>16));
642 SSVAL(cli->outbuf,smb_vwv10,size);
643 /* +1 is pad byte. */
644 SSVAL(cli->outbuf,smb_vwv11,
645 smb_buf(cli->outbuf) - smb_base(cli->outbuf) + 1);
648 SIVAL(cli->outbuf,smb_vwv12,(((SMB_BIG_UINT)offset)>>32) & 0xffffffff);
651 p = smb_base(cli->outbuf) + SVAL(cli->outbuf,smb_vwv11) -1;
652 *p++ = '\0'; /* pad byte. */
653 if (!direct_writes) {
654 memcpy(p, buf, size);
656 if (size > 0x1FFFF) {
657 /* This is a POSIX 14 word large write. */
658 set_message_bcc(cli->outbuf, 0); /* Set bcc to zero. */
659 _smb_setlen_large(cli->outbuf,smb_size + 28 + 1 /* pad */ + size - 4);
661 cli_setup_bcc(cli, p+size);
664 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
666 show_msg(cli->outbuf);
668 /* For direct writes we now need to write the data
669 * directly out of buf. */
670 return cli_send_smb_direct_writeX(cli, buf, size);
672 return cli_send_smb(cli);
676 /****************************************************************************
678 write_mode: 0x0001 disallow write cacheing
679 0x0002 return bytes remaining
680 0x0004 use raw named pipe protocol
681 0x0008 start of message mode named pipe protocol
682 ****************************************************************************/
684 ssize_t cli_write(struct cli_state *cli,
685 int fnum, uint16 write_mode,
686 const char *buf, off_t offset, size_t size)
688 ssize_t bwritten = 0;
689 unsigned int issued = 0;
690 unsigned int received = 0;
695 if(cli->max_mux > 1) {
696 mpx = cli->max_mux-1;
701 /* Default (small) writesize. */
702 writesize = (cli->max_xmit - (smb_size+32)) & ~1023;
704 if (write_mode == 0 &&
705 !client_is_signing_on(cli) &&
706 !cli_encryption_on(cli) &&
707 (cli->posix_capabilities & CIFS_UNIX_LARGE_WRITE_CAP) &&
708 (cli->capabilities & CAP_LARGE_FILES)) {
709 /* Only do massive writes if we can do them direct
710 * with no signing or encrypting - not on a pipe. */
711 writesize = CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE;
712 } else if (cli->capabilities & CAP_LARGE_WRITEX) {
714 writesize = CLI_SAMBA_MAX_LARGE_WRITEX_SIZE;
715 } else if (!client_is_signing_on(cli)) {
716 /* Windows restricts signed writes to max_xmit.
717 * Found by Volker. */
718 writesize = CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE;
722 blocks = (size + (writesize-1)) / writesize;
724 while (received < blocks) {
726 while ((issued - received < mpx) && (issued < blocks)) {
727 ssize_t bsent = issued * writesize;
728 ssize_t size1 = MIN(writesize, size - bsent);
730 if (!cli_issue_write(cli, fnum, offset + bsent,
738 if (!cli_receive_smb(cli)) {
744 if (cli_is_error(cli))
747 bwritten += SVAL(cli->inbuf, smb_vwv2);
748 bwritten += (((int)(SVAL(cli->inbuf, smb_vwv4)))<<16);
751 while (received < issued && cli_receive_smb(cli)) {
758 /****************************************************************************
759 write to a file using a SMBwrite and not bypassing 0 byte writes
760 ****************************************************************************/
762 ssize_t cli_smbwrite(struct cli_state *cli,
763 int fnum, char *buf, off_t offset, size_t size1)
769 size_t size = MIN(size1, cli->max_xmit - 48);
771 memset(cli->outbuf,'\0',smb_size);
772 memset(cli->inbuf,'\0',smb_size);
774 cli_set_message(cli->outbuf,5, 0,True);
776 SCVAL(cli->outbuf,smb_com,SMBwrite);
777 SSVAL(cli->outbuf,smb_tid,cli->cnum);
778 cli_setup_packet(cli);
780 SSVAL(cli->outbuf,smb_vwv0,fnum);
781 SSVAL(cli->outbuf,smb_vwv1,size);
782 SIVAL(cli->outbuf,smb_vwv2,offset);
783 SSVAL(cli->outbuf,smb_vwv4,0);
785 p = smb_buf(cli->outbuf);
787 SSVAL(p, 0, size); p += 2;
788 memcpy(p, buf + total, size); p += size;
790 cli_setup_bcc(cli, p);
792 if (!cli_send_smb(cli))
795 if (!cli_receive_smb(cli))
798 if (cli_is_error(cli))
801 size = SVAL(cli->inbuf,smb_vwv0);