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->data.read.ofs = offset;
66 req->data.read.size = size;
67 req->data.read.received = 0;
68 req->data.read.rcvbuf = NULL;
70 if ((SMB_BIG_UINT)offset >> 32)
73 cli_set_message(req->outbuf, bigoffset ? 12 : 10, 0, False);
75 SCVAL(req->outbuf,smb_com,SMBreadX);
76 SSVAL(req->outbuf,smb_tid,cli->cnum);
77 cli_setup_packet_buf(cli, req->outbuf);
79 SCVAL(req->outbuf,smb_vwv0,0xFF);
80 SCVAL(req->outbuf,smb_vwv0+1,0);
81 SSVAL(req->outbuf,smb_vwv1,0);
82 SSVAL(req->outbuf,smb_vwv2,fnum);
83 SIVAL(req->outbuf,smb_vwv3,offset);
84 SSVAL(req->outbuf,smb_vwv5,size);
85 SSVAL(req->outbuf,smb_vwv6,size);
86 SSVAL(req->outbuf,smb_vwv7,(size >> 16));
87 SSVAL(req->outbuf,smb_vwv8,0);
88 SSVAL(req->outbuf,smb_vwv9,0);
89 SSVAL(req->outbuf,smb_mid,req->mid);
92 SIVAL(req->outbuf, smb_vwv10,
93 (((SMB_BIG_UINT)offset)>>32) & 0xffffffff);
96 cli_calculate_sign_mac(cli, req->outbuf);
98 event_fd_set_writeable(cli->fd_event);
100 if (cli_encryption_on(cli)) {
102 status = cli_encrypt_message(cli, req->outbuf, &enc_buf);
103 if (!NT_STATUS_IS_OK(status)) {
104 DEBUG(0, ("Error in encrypting client message. "
105 "Error %s\n", nt_errstr(status)));
109 req->outbuf = enc_buf;
110 req->enc_state = cli->trans_enc_state;
117 * Pull the data out of a finished async read_and_x request. rcvbuf is
118 * talloced from the request, so better make sure that you copy it away before
119 * you talloc_free(req). "rcvbuf" is NOT a talloc_ctx of its own, so do not
123 NTSTATUS cli_read_andx_recv(struct async_req *req, ssize_t *received,
126 struct cli_request *cli_req = cli_request_get(req);
130 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
131 if (req->state == ASYNC_REQ_ERROR) {
135 status = cli_pull_error(cli_req->inbuf);
137 if (NT_STATUS_IS_ERR(status)) {
141 /* size is the number of bytes the server returned.
143 size = SVAL(cli_req->inbuf, smb_vwv5);
144 size |= (((unsigned int)(SVAL(cli_req->inbuf, smb_vwv7))) << 16);
146 if (size > cli_req->data.read.size) {
147 DEBUG(5,("server returned more than we wanted!\n"));
148 return NT_STATUS_UNEXPECTED_IO_ERROR;
151 *rcvbuf = (uint8_t *)
152 (smb_base(cli_req->inbuf) + SVAL(cli_req->inbuf, smb_vwv6));
158 * Parallel read support.
160 * cli_pull sends as many read&x requests as the server would allow via
161 * max_mux at a time. When replies flow back in, the data is written into
162 * the callback function "sink" in the right order.
165 struct cli_pull_state {
166 struct async_req *req;
168 struct cli_state *cli;
173 NTSTATUS (*sink)(char *buf, size_t n, void *priv);
179 * Outstanding requests
182 struct async_req **reqs;
185 * For how many bytes did we send requests already?
190 * Next request index to push into "sink". This walks around the "req"
191 * array, taking care that the requests are pushed to "sink" in the
192 * right order. If necessary (i.e. replies don't come in in the right
193 * order), replies are held back in "reqs".
198 * How many bytes did we push into "sink"?
204 static char *cli_pull_print(TALLOC_CTX *mem_ctx, struct async_req *req)
206 struct cli_pull_state *state = talloc_get_type_abort(
207 req->private_data, struct cli_pull_state);
210 result = async_req_print(mem_ctx, req);
211 if (result == NULL) {
215 return talloc_asprintf_append_buffer(
216 result, "num_reqs=%d, top_req=%d",
217 state->num_reqs, state->top_req);
220 static void cli_pull_read_done(struct async_req *read_req);
223 * Prepare an async pull request
226 struct async_req *cli_pull_send(TALLOC_CTX *mem_ctx, struct cli_state *cli,
227 uint16_t fnum, off_t start_offset,
228 SMB_OFF_T size, size_t window_size,
229 NTSTATUS (*sink)(char *buf, size_t n,
233 struct async_req *result;
234 struct cli_pull_state *state;
237 result = async_req_new(mem_ctx, cli->event_ctx);
238 if (result == NULL) {
241 state = talloc(result, struct cli_pull_state);
245 result->private_data = state;
246 result->print = cli_pull_print;
251 state->start_offset = start_offset;
260 if (!async_post_status(result, NT_STATUS_OK)) {
266 state->chunk_size = cli_read_max_bufsize(cli);
268 state->num_reqs = MAX(window_size/state->chunk_size, 1);
269 state->num_reqs = MIN(state->num_reqs, cli->max_mux);
271 state->reqs = TALLOC_ZERO_ARRAY(state, struct async_req *,
273 if (state->reqs == NULL) {
277 state->requested = 0;
279 for (i=0; i<state->num_reqs; i++) {
281 size_t request_thistime;
283 if (state->requested >= size) {
288 size_left = size - state->requested;
289 request_thistime = MIN(size_left, state->chunk_size);
291 state->reqs[i] = cli_read_andx_send(
292 state->reqs, cli, fnum,
293 state->start_offset + state->requested,
296 if (state->reqs[i] == NULL) {
300 state->reqs[i]->async.fn = cli_pull_read_done;
301 state->reqs[i]->async.priv = result;
303 state->requested += request_thistime;
313 * Handle incoming read replies, push the data into sink and send out new
314 * requests if necessary.
317 static void cli_pull_read_done(struct async_req *read_req)
319 struct async_req *pull_req = talloc_get_type_abort(
320 read_req->async.priv, struct async_req);
321 struct cli_pull_state *state = talloc_get_type_abort(
322 pull_req->private_data, struct cli_pull_state);
323 struct cli_request *read_state = cli_request_get(read_req);
326 status = cli_read_andx_recv(read_req, &read_state->data.read.received,
327 &read_state->data.read.rcvbuf);
328 if (!NT_STATUS_IS_OK(status)) {
329 async_req_error(state->req, status);
334 * This loop is the one to take care of out-of-order replies. All
335 * pending requests are in state->reqs, state->reqs[top_req] is the
336 * one that is to be pushed next. If however a request later than
337 * top_req is replied to, then we can't push yet. If top_req is
338 * replied to at a later point then, we need to push all the finished
342 while (state->reqs[state->top_req] != NULL) {
343 struct cli_request *top_read;
345 DEBUG(11, ("cli_pull_read_done: top_req = %d\n",
348 if (state->reqs[state->top_req]->state < ASYNC_REQ_DONE) {
349 DEBUG(11, ("cli_pull_read_done: top request not yet "
354 top_read = cli_request_get(state->reqs[state->top_req]);
356 DEBUG(10, ("cli_pull_read_done: Pushing %d bytes, %d already "
357 "pushed\n", (int)top_read->data.read.received,
358 (int)state->pushed));
360 status = state->sink((char *)top_read->data.read.rcvbuf,
361 top_read->data.read.received,
363 if (!NT_STATUS_IS_OK(status)) {
364 async_req_error(state->req, status);
367 state->pushed += top_read->data.read.received;
369 TALLOC_FREE(state->reqs[state->top_req]);
371 if (state->requested < state->size) {
372 struct async_req *new_req;
374 size_t request_thistime;
376 size_left = state->size - state->requested;
377 request_thistime = MIN(size_left, state->chunk_size);
379 DEBUG(10, ("cli_pull_read_done: Requesting %d bytes "
380 "at %d, position %d\n",
381 (int)request_thistime,
382 (int)(state->start_offset
386 new_req = cli_read_andx_send(
387 state->reqs, state->cli, state->fnum,
388 state->start_offset + state->requested,
391 if (async_req_nomem(new_req, state->req)) {
395 new_req->async.fn = cli_pull_read_done;
396 new_req->async.priv = pull_req;
398 state->reqs[state->top_req] = new_req;
399 state->requested += request_thistime;
402 state->top_req = (state->top_req+1) % state->num_reqs;
405 async_req_done(pull_req);
408 NTSTATUS cli_pull_recv(struct async_req *req, SMB_OFF_T *received)
410 struct cli_pull_state *state = talloc_get_type_abort(
411 req->private_data, struct cli_pull_state);
413 SMB_ASSERT(req->state >= ASYNC_REQ_DONE);
414 if (req->state == ASYNC_REQ_ERROR) {
417 *received = state->pushed;
421 NTSTATUS cli_pull(struct cli_state *cli, uint16_t fnum,
422 off_t start_offset, SMB_OFF_T size, size_t window_size,
423 NTSTATUS (*sink)(char *buf, size_t n, void *priv),
424 void *priv, SMB_OFF_T *received)
426 TALLOC_CTX *frame = talloc_stackframe();
427 struct async_req *req;
428 NTSTATUS result = NT_STATUS_NO_MEMORY;
430 if (cli_tmp_event_ctx(frame, cli) == NULL) {
434 req = cli_pull_send(frame, cli, fnum, start_offset, size, window_size,
440 while (req->state < ASYNC_REQ_DONE) {
441 event_loop_once(cli->event_ctx);
444 result = cli_pull_recv(req, received);
450 static NTSTATUS cli_read_sink(char *buf, size_t n, void *priv)
452 char **pbuf = (char **)priv;
453 memcpy(*pbuf, buf, n);
458 ssize_t cli_read(struct cli_state *cli, int fnum, char *buf,
459 off_t offset, size_t size)
464 status = cli_pull(cli, fnum, offset, size, size,
465 cli_read_sink, &buf, &ret);
466 if (!NT_STATUS_IS_OK(status)) {
467 cli_set_error(cli, status);
473 /****************************************************************************
474 Issue a single SMBwrite and don't wait for a reply.
475 ****************************************************************************/
477 static bool cli_issue_write(struct cli_state *cli,
486 bool large_writex = false;
487 /* We can only do direct writes if not signing and not encrypting. */
488 bool direct_writes = !client_is_signing_on(cli) && !cli_encryption_on(cli);
490 if (!direct_writes && size + 1 > cli->bufsize) {
491 cli->outbuf = (char *)SMB_REALLOC(cli->outbuf, size + 1024);
495 cli->inbuf = (char *)SMB_REALLOC(cli->inbuf, size + 1024);
496 if (cli->inbuf == NULL) {
497 SAFE_FREE(cli->outbuf);
500 cli->bufsize = size + 1024;
503 memset(cli->outbuf,'\0',smb_size);
504 memset(cli->inbuf,'\0',smb_size);
506 if (cli->capabilities & CAP_LARGE_FILES) {
511 cli_set_message(cli->outbuf,14,0,True);
513 cli_set_message(cli->outbuf,12,0,True);
516 SCVAL(cli->outbuf,smb_com,SMBwriteX);
517 SSVAL(cli->outbuf,smb_tid,cli->cnum);
518 cli_setup_packet(cli);
520 SCVAL(cli->outbuf,smb_vwv0,0xFF);
521 SSVAL(cli->outbuf,smb_vwv2,fnum);
523 SIVAL(cli->outbuf,smb_vwv3,offset);
524 SIVAL(cli->outbuf,smb_vwv5,0);
525 SSVAL(cli->outbuf,smb_vwv7,mode);
527 SSVAL(cli->outbuf,smb_vwv8,(mode & 0x0008) ? size : 0);
529 * According to CIFS-TR-1p00, this following field should only
530 * be set if CAP_LARGE_WRITEX is set. We should check this
531 * locally. However, this check might already have been
532 * done by our callers.
534 SSVAL(cli->outbuf,smb_vwv9,(size>>16));
535 SSVAL(cli->outbuf,smb_vwv10,size);
536 /* +1 is pad byte. */
537 SSVAL(cli->outbuf,smb_vwv11,
538 smb_buf(cli->outbuf) - smb_base(cli->outbuf) + 1);
541 SIVAL(cli->outbuf,smb_vwv12,(((SMB_BIG_UINT)offset)>>32) & 0xffffffff);
544 p = smb_base(cli->outbuf) + SVAL(cli->outbuf,smb_vwv11) -1;
545 *p++ = '\0'; /* pad byte. */
546 if (!direct_writes) {
547 memcpy(p, buf, size);
549 if (size > 0x1FFFF) {
550 /* This is a POSIX 14 word large write. */
551 set_message_bcc(cli->outbuf, 0); /* Set bcc to zero. */
552 _smb_setlen_large(cli->outbuf,smb_size + 28 + 1 /* pad */ + size - 4);
554 cli_setup_bcc(cli, p+size);
557 SSVAL(cli->outbuf,smb_mid,cli->mid + i);
559 show_msg(cli->outbuf);
561 /* For direct writes we now need to write the data
562 * directly out of buf. */
563 return cli_send_smb_direct_writeX(cli, buf, size);
565 return cli_send_smb(cli);
569 /****************************************************************************
571 write_mode: 0x0001 disallow write cacheing
572 0x0002 return bytes remaining
573 0x0004 use raw named pipe protocol
574 0x0008 start of message mode named pipe protocol
575 ****************************************************************************/
577 ssize_t cli_write(struct cli_state *cli,
578 int fnum, uint16 write_mode,
579 const char *buf, off_t offset, size_t size)
581 ssize_t bwritten = 0;
582 unsigned int issued = 0;
583 unsigned int received = 0;
588 if(cli->max_mux > 1) {
589 mpx = cli->max_mux-1;
594 /* Default (small) writesize. */
595 writesize = (cli->max_xmit - (smb_size+32)) & ~1023;
597 if (write_mode == 0 &&
598 !client_is_signing_on(cli) &&
599 !cli_encryption_on(cli) &&
600 (cli->posix_capabilities & CIFS_UNIX_LARGE_WRITE_CAP) &&
601 (cli->capabilities & CAP_LARGE_FILES)) {
602 /* Only do massive writes if we can do them direct
603 * with no signing or encrypting - not on a pipe. */
604 writesize = CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE;
605 } else if ((cli->capabilities & CAP_LARGE_WRITEX) &&
606 (strcmp(cli->dev, "LPT1:") != 0)) {
608 /* Printer devices are restricted to max_xmit
609 * writesize in Vista and XPSP3. */
612 writesize = CLI_SAMBA_MAX_LARGE_WRITEX_SIZE;
613 } else if (!client_is_signing_on(cli)) {
614 /* Windows restricts signed writes to max_xmit.
615 * Found by Volker. */
616 writesize = CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE;
620 blocks = (size + (writesize-1)) / writesize;
622 while (received < blocks) {
624 while ((issued - received < mpx) && (issued < blocks)) {
625 ssize_t bsent = issued * writesize;
626 ssize_t size1 = MIN(writesize, size - bsent);
628 if (!cli_issue_write(cli, fnum, offset + bsent,
636 if (!cli_receive_smb(cli)) {
642 if (cli_is_error(cli))
645 bwritten += SVAL(cli->inbuf, smb_vwv2);
646 if (writesize > 0xFFFF) {
647 bwritten += (((int)(SVAL(cli->inbuf, smb_vwv4)))<<16);
651 while (received < issued && cli_receive_smb(cli)) {
658 /****************************************************************************
659 write to a file using a SMBwrite and not bypassing 0 byte writes
660 ****************************************************************************/
662 ssize_t cli_smbwrite(struct cli_state *cli,
663 int fnum, char *buf, off_t offset, size_t size1)
669 size_t size = MIN(size1, cli->max_xmit - 48);
671 memset(cli->outbuf,'\0',smb_size);
672 memset(cli->inbuf,'\0',smb_size);
674 cli_set_message(cli->outbuf,5, 0,True);
676 SCVAL(cli->outbuf,smb_com,SMBwrite);
677 SSVAL(cli->outbuf,smb_tid,cli->cnum);
678 cli_setup_packet(cli);
680 SSVAL(cli->outbuf,smb_vwv0,fnum);
681 SSVAL(cli->outbuf,smb_vwv1,size);
682 SIVAL(cli->outbuf,smb_vwv2,offset);
683 SSVAL(cli->outbuf,smb_vwv4,0);
685 p = smb_buf(cli->outbuf);
687 SSVAL(p, 0, size); p += 2;
688 memcpy(p, buf + total, size); p += size;
690 cli_setup_bcc(cli, p);
692 if (!cli_send_smb(cli))
695 if (!cli_receive_smb(cli))
698 if (cli_is_error(cli))
701 size = SVAL(cli->inbuf,smb_vwv0);