source3/libsmb/clireadwrite.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    client file read/write routines
   4    Copyright (C) Andrew Tridgell 1994-1998
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "includes.h"
  21
  22 /****************************************************************************
  23   Calculate the recommended read buffer size
  24 ****************************************************************************/
  25 static size_t cli_read_max_bufsize(struct cli_state *cli)
  26 {
  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;
  30         }
  31         if (cli->capabilities & CAP_LARGE_READX) {
  32                 return cli->is_samba
  33                         ? CLI_SAMBA_MAX_LARGE_READX_SIZE
  34                         : CLI_WINDOWS_MAX_LARGE_READX_SIZE;
  35         }
  36         return (cli->max_xmit - (smb_size+32)) & ~1023;
  37 }
  38
  39 /****************************************************************************
  40   Calculate the recommended write buffer size
  41 ****************************************************************************/
  42 static size_t cli_write_max_bufsize(struct cli_state *cli, uint16_t write_mode)
  43 {
  44         if (write_mode == 0 &&
  45             !client_is_signing_on(cli) &&
  46             !cli_encryption_on(cli) &&
  47             (cli->posix_capabilities & CIFS_UNIX_LARGE_WRITE_CAP) &&
  48             (cli->capabilities & CAP_LARGE_FILES)) {
  49                 /* Only do massive writes if we can do them direct
  50                  * with no signing or encrypting - not on a pipe. */
  51                 return CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE;
  52         }
  53
  54         if (cli->is_samba) {
  55                 return CLI_SAMBA_MAX_LARGE_WRITEX_SIZE;
  56         }
  57
  58         if (((cli->capabilities & CAP_LARGE_WRITEX) == 0)
  59             || client_is_signing_on(cli)
  60             || strequal(cli->dev, "LPT1:")) {
  61
  62                 /*
  63                  * Printer devices are restricted to max_xmit writesize in
  64                  * Vista and XPSP3 as are signing connections.
  65                  */
  66
  67                 return (cli->max_xmit - (smb_size+32)) & ~1023;
  68         }
  69
  70         return CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE;
  71 }
  72
  73 struct cli_read_andx_state {
  74         size_t size;
  75         uint16_t vwv[12];
  76         NTSTATUS status;
  77         size_t received;
  78         uint8_t *buf;
  79 };
  80
  81 static void cli_read_andx_done(struct tevent_req *subreq);
  82
  83 struct tevent_req *cli_read_andx_create(TALLOC_CTX *mem_ctx,
  84                                         struct event_context *ev,
  85                                         struct cli_state *cli, uint16_t fnum,
  86                                         off_t offset, size_t size,
  87                                         struct tevent_req **psmbreq)
  88 {
  89         struct tevent_req *req, *subreq;
  90         struct cli_read_andx_state *state;
  91         bool bigoffset = False;
  92         uint8_t wct = 10;
  93
  94         if (size > cli_read_max_bufsize(cli)) {
  95                 DEBUG(0, ("cli_read_andx_send got size=%d, can only handle "
  96                           "size=%d\n", (int)size,
  97                           (int)cli_read_max_bufsize(cli)));
  98                 return NULL;
  99         }
 100
 101         req = tevent_req_create(mem_ctx, &state, struct cli_read_andx_state);
 102         if (req == NULL) {
 103                 return NULL;
 104         }
 105         state->size = size;
 106
 107         SCVAL(state->vwv + 0, 0, 0xFF);
 108         SCVAL(state->vwv + 0, 1, 0);
 109         SSVAL(state->vwv + 1, 0, 0);
 110         SSVAL(state->vwv + 2, 0, fnum);
 111         SIVAL(state->vwv + 3, 0, offset);
 112         SSVAL(state->vwv + 5, 0, size);
 113         SSVAL(state->vwv + 6, 0, size);
 114         SSVAL(state->vwv + 7, 0, (size >> 16));
 115         SSVAL(state->vwv + 8, 0, 0);
 116         SSVAL(state->vwv + 9, 0, 0);
 117
 118         if ((uint64_t)offset >> 32) {
 119                 bigoffset = true;
 120                 SIVAL(state->vwv + 10, 0,
 121                       (((uint64_t)offset)>>32) & 0xffffffff);
 122                 wct += 2;
 123         }
 124
 125         subreq = cli_smb_req_create(state, ev, cli, SMBreadX, 0, wct,
 126                                     state->vwv, 0, NULL);
 127         if (subreq == NULL) {
 128                 TALLOC_FREE(req);
 129                 return NULL;
 130         }
 131         tevent_req_set_callback(subreq, cli_read_andx_done, req);
 132         *psmbreq = subreq;
 133         return req;
 134 }
 135
 136 struct tevent_req *cli_read_andx_send(TALLOC_CTX *mem_ctx,
 137                                       struct event_context *ev,
 138                                       struct cli_state *cli, uint16_t fnum,
 139                                       off_t offset, size_t size)
 140 {
 141         struct tevent_req *req, *subreq;
 142         NTSTATUS status;
 143
 144         req = cli_read_andx_create(mem_ctx, ev, cli, fnum, offset, size,
 145                                    &subreq);
 146         if (req == NULL) {
 147                 return NULL;
 148         }
 149
 150         status = cli_smb_req_send(subreq);
 151         if (!NT_STATUS_IS_OK(status)) {
 152                 tevent_req_nterror(req, status);
 153                 return tevent_req_post(req, ev);
 154         }
 155         return req;
 156 }
 157
 158 static void cli_read_andx_done(struct tevent_req *subreq)
 159 {
 160         struct tevent_req *req = tevent_req_callback_data(
 161                 subreq, struct tevent_req);
 162         struct cli_read_andx_state *state = tevent_req_data(
 163                 req, struct cli_read_andx_state);
 164         uint8_t *inbuf;
 165         uint8_t wct;
 166         uint16_t *vwv;
 167         uint32_t num_bytes;
 168         uint8_t *bytes;
 169
 170         state->status = cli_smb_recv(subreq, 12, &wct, &vwv, &num_bytes,
 171                                      &bytes);
 172         if (NT_STATUS_IS_ERR(state->status)) {
 173                 tevent_req_nterror(req, state->status);
 174                 return;
 175         }
 176
 177         /* size is the number of bytes the server returned.
 178          * Might be zero. */
 179         state->received = SVAL(vwv + 5, 0);
 180         state->received |= (((unsigned int)SVAL(vwv + 7, 0)) << 16);
 181
 182         if (state->received > state->size) {
 183                 DEBUG(5,("server returned more than we wanted!\n"));
 184                 tevent_req_nterror(req, NT_STATUS_UNEXPECTED_IO_ERROR);
 185                 return;
 186         }
 187
 188         /*
 189          * bcc field must be valid for small reads, for large reads the 16-bit
 190          * bcc field can't be correct.
 191          */
 192
 193         if ((state->received < 0xffff) && (state->received > num_bytes)) {
 194                 DEBUG(5, ("server announced more bytes than sent\n"));
 195                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 196                 return;
 197         }
 198
 199         inbuf = cli_smb_inbuf(subreq);
 200         state->buf = (uint8_t *)smb_base(inbuf) + SVAL(vwv+6, 0);
 201
 202         if (trans_oob(smb_len_large(inbuf), SVAL(vwv+6, 0), state->received)
 203             || ((state->received != 0) && (state->buf < bytes))) {
 204                 DEBUG(5, ("server returned invalid read&x data offset\n"));
 205                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 206                 return;
 207         }
 208         tevent_req_done(req);
 209 }
 210
 211 /*
 212  * Pull the data out of a finished async read_and_x request. rcvbuf is
 213  * talloced from the request, so better make sure that you copy it away before
 214  * you talloc_free(req). "rcvbuf" is NOT a talloc_ctx of its own, so do not
 215  * talloc_move it!
 216  */
 217
 218 NTSTATUS cli_read_andx_recv(struct tevent_req *req, ssize_t *received,
 219                             uint8_t **rcvbuf)
 220 {
 221         struct cli_read_andx_state *state = tevent_req_data(
 222                 req, struct cli_read_andx_state);
 223         NTSTATUS status;
 224
 225         if (tevent_req_is_nterror(req, &status)) {
 226                 return status;
 227         }
 228         *received = state->received;
 229         *rcvbuf = state->buf;
 230         return NT_STATUS_OK;
 231 }
 232
 233 struct cli_readall_state {
 234         struct tevent_context *ev;
 235         struct cli_state *cli;
 236         uint16_t fnum;
 237         off_t start_offset;
 238         size_t size;
 239         size_t received;
 240         uint8_t *buf;
 241 };
 242
 243 static void cli_readall_done(struct tevent_req *subreq);
 244
 245 static struct tevent_req *cli_readall_send(TALLOC_CTX *mem_ctx,
 246                                            struct event_context *ev,
 247                                            struct cli_state *cli,
 248                                            uint16_t fnum,
 249                                            off_t offset, size_t size)
 250 {
 251         struct tevent_req *req, *subreq;
 252         struct cli_readall_state *state;
 253
 254         req = tevent_req_create(mem_ctx, &state, struct cli_readall_state);
 255         if (req == NULL) {
 256                 return NULL;
 257         }
 258         state->ev = ev;
 259         state->cli = cli;
 260         state->fnum = fnum;
 261         state->start_offset = offset;
 262         state->size = size;
 263         state->received = 0;
 264         state->buf = NULL;
 265
 266         subreq = cli_read_andx_send(state, ev, cli, fnum, offset, size);
 267         if (tevent_req_nomem(subreq, req)) {
 268                 return tevent_req_post(req, ev);
 269         }
 270         tevent_req_set_callback(subreq, cli_readall_done, req);
 271         return req;
 272 }
 273
 274 static void cli_readall_done(struct tevent_req *subreq)
 275 {
 276         struct tevent_req *req = tevent_req_callback_data(
 277                 subreq, struct tevent_req);
 278         struct cli_readall_state *state = tevent_req_data(
 279                 req, struct cli_readall_state);
 280         ssize_t received;
 281         uint8_t *buf;
 282         NTSTATUS status;
 283
 284         status = cli_read_andx_recv(subreq, &received, &buf);
 285         if (!NT_STATUS_IS_OK(status)) {
 286                 tevent_req_nterror(req, status);
 287                 return;
 288         }
 289
 290         if (received == 0) {
 291                 /* EOF */
 292                 tevent_req_done(req);
 293                 return;
 294         }
 295
 296         if ((state->received == 0) && (received == state->size)) {
 297                 /* Ideal case: Got it all in one run */
 298                 state->buf = buf;
 299                 state->received += received;
 300                 tevent_req_done(req);
 301                 return;
 302         }
 303
 304         /*
 305          * We got a short read, issue a read for the
 306          * rest. Unfortunately we have to allocate the buffer
 307          * ourselves now, as our caller expects to receive a single
 308          * buffer. cli_read_andx does it from the buffer received from
 309          * the net, but with a short read we have to put it together
 310          * from several reads.
 311          */
 312
 313         if (state->buf == NULL) {
 314                 state->buf = talloc_array(state, uint8_t, state->size);
 315                 if (tevent_req_nomem(state->buf, req)) {
 316                         return;
 317                 }
 318         }
 319         memcpy(state->buf + state->received, buf, received);
 320         state->received += received;
 321
 322         TALLOC_FREE(subreq);
 323
 324         if (state->received >= state->size) {
 325                 tevent_req_done(req);
 326                 return;
 327         }
 328
 329         subreq = cli_read_andx_send(state, state->ev, state->cli, state->fnum,
 330                                     state->start_offset + state->received,
 331                                     state->size - state->received);
 332         if (tevent_req_nomem(subreq, req)) {
 333                 return;
 334         }
 335         tevent_req_set_callback(subreq, cli_readall_done, req);
 336 }
 337
 338 static NTSTATUS cli_readall_recv(struct tevent_req *req, ssize_t *received,
 339                                  uint8_t **rcvbuf)
 340 {
 341         struct cli_readall_state *state = tevent_req_data(
 342                 req, struct cli_readall_state);
 343         NTSTATUS status;
 344
 345         if (tevent_req_is_nterror(req, &status)) {
 346                 return status;
 347         }
 348         *received = state->received;
 349         *rcvbuf = state->buf;
 350         return NT_STATUS_OK;
 351 }
 352
 353 struct cli_pull_subreq {
 354         struct tevent_req *req;
 355         ssize_t received;
 356         uint8_t *buf;
 357 };
 358
 359 /*
 360  * Parallel read support.
 361  *
 362  * cli_pull sends as many read&x requests as the server would allow via
 363  * max_mux at a time. When replies flow back in, the data is written into
 364  * the callback function "sink" in the right order.
 365  */
 366
 367 struct cli_pull_state {
 368         struct tevent_req *req;
 369
 370         struct event_context *ev;
 371         struct cli_state *cli;
 372         uint16_t fnum;
 373         off_t start_offset;
 374         SMB_OFF_T size;
 375
 376         NTSTATUS (*sink)(char *buf, size_t n, void *priv);
 377         void *priv;
 378
 379         size_t chunk_size;
 380
 381         /*
 382          * Outstanding requests
 383          */
 384         int num_reqs;
 385         struct cli_pull_subreq *reqs;
 386
 387         /*
 388          * For how many bytes did we send requests already?
 389          */
 390         SMB_OFF_T requested;
 391
 392         /*
 393          * Next request index to push into "sink". This walks around the "req"
 394          * array, taking care that the requests are pushed to "sink" in the
 395          * right order. If necessary (i.e. replies don't come in in the right
 396          * order), replies are held back in "reqs".
 397          */
 398         int top_req;
 399
 400         /*
 401          * How many bytes did we push into "sink"?
 402          */
 403
 404         SMB_OFF_T pushed;
 405 };
 406
 407 static char *cli_pull_print(struct tevent_req *req, TALLOC_CTX *mem_ctx)
 408 {
 409         struct cli_pull_state *state = tevent_req_data(
 410                 req, struct cli_pull_state);
 411         char *result;
 412
 413         result = tevent_req_print(mem_ctx, req);
 414         if (result == NULL) {
 415                 return NULL;
 416         }
 417
 418         return talloc_asprintf_append_buffer(
 419                 result, "num_reqs=%d, top_req=%d",
 420                 state->num_reqs, state->top_req);
 421 }
 422
 423 static void cli_pull_read_done(struct tevent_req *read_req);
 424
 425 /*
 426  * Prepare an async pull request
 427  */
 428
 429 struct tevent_req *cli_pull_send(TALLOC_CTX *mem_ctx,
 430                                  struct event_context *ev,
 431                                  struct cli_state *cli,
 432                                  uint16_t fnum, off_t start_offset,
 433                                  SMB_OFF_T size, size_t window_size,
 434                                  NTSTATUS (*sink)(char *buf, size_t n,
 435                                                   void *priv),
 436                                  void *priv)
 437 {
 438         struct tevent_req *req;
 439         struct cli_pull_state *state;
 440         int i;
 441
 442         req = tevent_req_create(mem_ctx, &state, struct cli_pull_state);
 443         if (req == NULL) {
 444                 return NULL;
 445         }
 446         tevent_req_set_print_fn(req, cli_pull_print);
 447         state->req = req;
 448
 449         state->cli = cli;
 450         state->ev = ev;
 451         state->fnum = fnum;
 452         state->start_offset = start_offset;
 453         state->size = size;
 454         state->sink = sink;
 455         state->priv = priv;
 456
 457         state->pushed = 0;
 458         state->top_req = 0;
 459
 460         if (size == 0) {
 461                 tevent_req_done(req);
 462                 return tevent_req_post(req, ev);
 463         }
 464
 465         state->chunk_size = cli_read_max_bufsize(cli);
 466
 467         state->num_reqs = MAX(window_size/state->chunk_size, 1);
 468         state->num_reqs = MIN(state->num_reqs, cli->max_mux);
 469
 470         state->reqs = TALLOC_ZERO_ARRAY(state, struct cli_pull_subreq,
 471                                         state->num_reqs);
 472         if (state->reqs == NULL) {
 473                 goto failed;
 474         }
 475
 476         state->requested = 0;
 477
 478         for (i=0; i<state->num_reqs; i++) {
 479                 struct cli_pull_subreq *subreq = &state->reqs[i];
 480                 SMB_OFF_T size_left;
 481                 size_t request_thistime;
 482
 483                 if (state->requested >= size) {
 484                         state->num_reqs = i;
 485                         break;
 486                 }
 487
 488                 size_left = size - state->requested;
 489                 request_thistime = MIN(size_left, state->chunk_size);
 490
 491                 subreq->req = cli_readall_send(
 492                         state->reqs, ev, cli, fnum,
 493                         state->start_offset + state->requested,
 494                         request_thistime);
 495
 496                 if (subreq->req == NULL) {
 497                         goto failed;
 498                 }
 499                 tevent_req_set_callback(subreq->req, cli_pull_read_done, req);
 500                 state->requested += request_thistime;
 501         }
 502         return req;
 503
 504 failed:
 505         TALLOC_FREE(req);
 506         return NULL;
 507 }
 508
 509 /*
 510  * Handle incoming read replies, push the data into sink and send out new
 511  * requests if necessary.
 512  */
 513
 514 static void cli_pull_read_done(struct tevent_req *subreq)
 515 {
 516         struct tevent_req *req = tevent_req_callback_data(
 517                 subreq, struct tevent_req);
 518         struct cli_pull_state *state = tevent_req_data(
 519                 req, struct cli_pull_state);
 520         struct cli_pull_subreq *pull_subreq = NULL;
 521         NTSTATUS status;
 522         int i;
 523
 524         for (i = 0; i < state->num_reqs; i++) {
 525                 pull_subreq = &state->reqs[i];
 526                 if (subreq == pull_subreq->req) {
 527                         break;
 528                 }
 529         }
 530         if (i == state->num_reqs) {
 531                 /* Huh -- received something we did not send?? */
 532                 tevent_req_nterror(req, NT_STATUS_INTERNAL_ERROR);
 533                 return;
 534         }
 535
 536         status = cli_readall_recv(subreq, &pull_subreq->received,
 537                                   &pull_subreq->buf);
 538         if (!NT_STATUS_IS_OK(status)) {
 539                 tevent_req_nterror(state->req, status);
 540                 return;
 541         }
 542
 543         /*
 544          * This loop is the one to take care of out-of-order replies. All
 545          * pending requests are in state->reqs, state->reqs[top_req] is the
 546          * one that is to be pushed next. If however a request later than
 547          * top_req is replied to, then we can't push yet. If top_req is
 548          * replied to at a later point then, we need to push all the finished
 549          * requests.
 550          */
 551
 552         while (state->reqs[state->top_req].req != NULL) {
 553                 struct cli_pull_subreq *top_subreq;
 554
 555                 DEBUG(11, ("cli_pull_read_done: top_req = %d\n",
 556                            state->top_req));
 557
 558                 top_subreq = &state->reqs[state->top_req];
 559
 560                 if (tevent_req_is_in_progress(top_subreq->req)) {
 561                         DEBUG(11, ("cli_pull_read_done: top request not yet "
 562                                    "done\n"));
 563                         return;
 564                 }
 565
 566                 DEBUG(10, ("cli_pull_read_done: Pushing %d bytes, %d already "
 567                            "pushed\n", (int)top_subreq->received,
 568                            (int)state->pushed));
 569
 570                 status = state->sink((char *)top_subreq->buf,
 571                                      top_subreq->received, state->priv);
 572                 if (!NT_STATUS_IS_OK(status)) {
 573                         tevent_req_nterror(state->req, status);
 574                         return;
 575                 }
 576                 state->pushed += top_subreq->received;
 577
 578                 TALLOC_FREE(state->reqs[state->top_req].req);
 579
 580                 if (state->requested < state->size) {
 581                         struct tevent_req *new_req;
 582                         SMB_OFF_T size_left;
 583                         size_t request_thistime;
 584
 585                         size_left = state->size - state->requested;
 586                         request_thistime = MIN(size_left, state->chunk_size);
 587
 588                         DEBUG(10, ("cli_pull_read_done: Requesting %d bytes "
 589                                    "at %d, position %d\n",
 590                                    (int)request_thistime,
 591                                    (int)(state->start_offset
 592                                          + state->requested),
 593                                    state->top_req));
 594
 595                         new_req = cli_readall_send(
 596                                 state->reqs, state->ev, state->cli,
 597                                 state->fnum,
 598                                 state->start_offset + state->requested,
 599                                 request_thistime);
 600
 601                         if (tevent_req_nomem(new_req, state->req)) {
 602                                 return;
 603                         }
 604                         tevent_req_set_callback(new_req, cli_pull_read_done,
 605                                                 req);
 606
 607                         state->reqs[state->top_req].req = new_req;
 608                         state->requested += request_thistime;
 609                 }
 610
 611                 state->top_req = (state->top_req+1) % state->num_reqs;
 612         }
 613
 614         tevent_req_done(req);
 615 }
 616
 617 NTSTATUS cli_pull_recv(struct tevent_req *req, SMB_OFF_T *received)
 618 {
 619         struct cli_pull_state *state = tevent_req_data(
 620                 req, struct cli_pull_state);
 621         NTSTATUS status;
 622
 623         if (tevent_req_is_nterror(req, &status)) {
 624                 return status;
 625         }
 626         *received = state->pushed;
 627         return NT_STATUS_OK;
 628 }
 629
 630 NTSTATUS cli_pull(struct cli_state *cli, uint16_t fnum,
 631                   off_t start_offset, SMB_OFF_T size, size_t window_size,
 632                   NTSTATUS (*sink)(char *buf, size_t n, void *priv),
 633                   void *priv, SMB_OFF_T *received)
 634 {
 635         TALLOC_CTX *frame = talloc_stackframe();
 636         struct event_context *ev;
 637         struct tevent_req *req;
 638         NTSTATUS status = NT_STATUS_OK;
 639
 640         if (cli_has_async_calls(cli)) {
 641                 /*
 642                  * Can't use sync call while an async call is in flight
 643                  */
 644                 status = NT_STATUS_INVALID_PARAMETER;
 645                 goto fail;
 646         }
 647
 648         ev = event_context_init(frame);
 649         if (ev == NULL) {
 650                 status = NT_STATUS_NO_MEMORY;
 651                 goto fail;
 652         }
 653
 654         req = cli_pull_send(frame, ev, cli, fnum, start_offset, size,
 655                             window_size, sink, priv);
 656         if (req == NULL) {
 657                 status = NT_STATUS_NO_MEMORY;
 658                 goto fail;
 659         }
 660
 661         if (!tevent_req_poll(req, ev)) {
 662                 status = map_nt_error_from_unix(errno);
 663                 goto fail;
 664         }
 665
 666         status = cli_pull_recv(req, received);
 667  fail:
 668         TALLOC_FREE(frame);
 669         if (!NT_STATUS_IS_OK(status)) {
 670                 cli_set_error(cli, status);
 671         }
 672         return status;
 673 }
 674
 675 static NTSTATUS cli_read_sink(char *buf, size_t n, void *priv)
 676 {
 677         char **pbuf = (char **)priv;
 678         memcpy(*pbuf, buf, n);
 679         *pbuf += n;
 680         return NT_STATUS_OK;
 681 }
 682
 683 ssize_t cli_read(struct cli_state *cli, uint16_t fnum, char *buf,
 684                  off_t offset, size_t size)
 685 {
 686         NTSTATUS status;
 687         SMB_OFF_T ret;
 688
 689         status = cli_pull(cli, fnum, offset, size, size,
 690                           cli_read_sink, &buf, &ret);
 691         if (!NT_STATUS_IS_OK(status)) {
 692                 cli_set_error(cli, status);
 693                 return -1;
 694         }
 695         return ret;
 696 }
 697
 698 /****************************************************************************
 699  Issue a single SMBwrite and don't wait for a reply.
 700 ****************************************************************************/
 701
 702 static bool cli_issue_write(struct cli_state *cli,
 703                                 uint16_t fnum,
 704                                 off_t offset,
 705                                 uint16 mode,
 706                                 const char *buf,
 707                                 size_t size)
 708 {
 709         char *p;
 710         bool large_writex = false;
 711         /* We can only do direct writes if not signing and not encrypting. */
 712         bool direct_writes = !client_is_signing_on(cli) && !cli_encryption_on(cli);
 713
 714         if (!direct_writes && size + 1 > cli->bufsize) {
 715                 cli->outbuf = (char *)SMB_REALLOC(cli->outbuf, size + 1024);
 716                 if (!cli->outbuf) {
 717                         return False;
 718                 }
 719                 cli->inbuf = (char *)SMB_REALLOC(cli->inbuf, size + 1024);
 720                 if (cli->inbuf == NULL) {
 721                         SAFE_FREE(cli->outbuf);
 722                         return False;
 723                 }
 724                 cli->bufsize = size + 1024;
 725         }
 726
 727         memset(cli->outbuf,'\0',smb_size);
 728         memset(cli->inbuf,'\0',smb_size);
 729
 730         if (cli->capabilities & CAP_LARGE_FILES) {
 731                 large_writex = True;
 732         }
 733
 734         if (large_writex) {
 735                 cli_set_message(cli->outbuf,14,0,True);
 736         } else {
 737                 cli_set_message(cli->outbuf,12,0,True);
 738         }
 739
 740         SCVAL(cli->outbuf,smb_com,SMBwriteX);
 741         SSVAL(cli->outbuf,smb_tid,cli->cnum);
 742         cli_setup_packet(cli);
 743
 744         SCVAL(cli->outbuf,smb_vwv0,0xFF);
 745         SSVAL(cli->outbuf,smb_vwv2,fnum);
 746
 747         SIVAL(cli->outbuf,smb_vwv3,offset);
 748         SIVAL(cli->outbuf,smb_vwv5,0);
 749         SSVAL(cli->outbuf,smb_vwv7,mode);
 750
 751         SSVAL(cli->outbuf,smb_vwv8,(mode & 0x0008) ? size : 0);
 752         /*
 753          * According to CIFS-TR-1p00, this following field should only
 754          * be set if CAP_LARGE_WRITEX is set. We should check this
 755          * locally. However, this check might already have been
 756          * done by our callers.
 757          */
 758         SSVAL(cli->outbuf,smb_vwv9,(size>>16));
 759         SSVAL(cli->outbuf,smb_vwv10,size);
 760         /* +1 is pad byte. */
 761         SSVAL(cli->outbuf,smb_vwv11,
 762               smb_buf(cli->outbuf) - smb_base(cli->outbuf) + 1);
 763
 764         if (large_writex) {
 765                 SIVAL(cli->outbuf,smb_vwv12,(((uint64_t)offset)>>32) & 0xffffffff);
 766         }
 767
 768         p = smb_base(cli->outbuf) + SVAL(cli->outbuf,smb_vwv11) -1;
 769         *p++ = '\0'; /* pad byte. */
 770         if (!direct_writes) {
 771                 memcpy(p, buf, size);
 772         }
 773         if (size > 0x1FFFF) {
 774                 /* This is a POSIX 14 word large write. */
 775                 set_message_bcc(cli->outbuf, 0); /* Set bcc to zero. */
 776                 _smb_setlen_large(cli->outbuf,smb_size + 28 + 1 /* pad */ + size - 4);
 777         } else {
 778                 cli_setup_bcc(cli, p+size);
 779         }
 780
 781         show_msg(cli->outbuf);
 782         if (direct_writes) {
 783                 /* For direct writes we now need to write the data
 784                  * directly out of buf. */
 785                 return cli_send_smb_direct_writeX(cli, buf, size);
 786         } else {
 787                 return cli_send_smb(cli);
 788         }
 789 }
 790
 791 /****************************************************************************
 792   write to a file
 793   write_mode: 0x0001 disallow write cacheing
 794               0x0002 return bytes remaining
 795               0x0004 use raw named pipe protocol
 796               0x0008 start of message mode named pipe protocol
 797 ****************************************************************************/
 798
 799 ssize_t cli_write(struct cli_state *cli,
 800                  uint16_t fnum, uint16 write_mode,
 801                  const char *buf, off_t offset, size_t size)
 802 {
 803         ssize_t bwritten = 0;
 804         unsigned int issued = 0;
 805         unsigned int received = 0;
 806         int mpx = 1;
 807         size_t writesize;
 808         int blocks;
 809
 810         if(cli->max_mux > 1) {
 811                 mpx = cli->max_mux-1;
 812         } else {
 813                 mpx = 1;
 814         }
 815
 816         writesize = cli_write_max_bufsize(cli, write_mode);
 817
 818         blocks = (size + (writesize-1)) / writesize;
 819
 820         while (received < blocks) {
 821
 822                 while ((issued - received < mpx) && (issued < blocks)) {
 823                         ssize_t bsent = issued * writesize;
 824                         ssize_t size1 = MIN(writesize, size - bsent);
 825
 826                         if (!cli_issue_write(cli, fnum, offset + bsent,
 827                                         write_mode,
 828                                         buf + bsent,
 829                                         size1))
 830                                 return -1;
 831                         issued++;
 832                 }
 833
 834                 if (!cli_receive_smb(cli)) {
 835                         return bwritten;
 836                 }
 837
 838                 received++;
 839
 840                 if (cli_is_error(cli))
 841                         break;
 842
 843                 bwritten += SVAL(cli->inbuf, smb_vwv2);
 844                 if (writesize > 0xFFFF) {
 845                         bwritten += (((int)(SVAL(cli->inbuf, smb_vwv4)))<<16);
 846                 }
 847         }
 848
 849         while (received < issued && cli_receive_smb(cli)) {
 850                 received++;
 851         }
 852
 853         return bwritten;
 854 }
 855
 856 /****************************************************************************
 857   write to a file using a SMBwrite and not bypassing 0 byte writes
 858 ****************************************************************************/
 859
 860 ssize_t cli_smbwrite(struct cli_state *cli,
 861                      uint16_t fnum, char *buf, off_t offset, size_t size1)
 862 {
 863         char *p;
 864         ssize_t total = 0;
 865
 866         do {
 867                 size_t size = MIN(size1, cli->max_xmit - 48);
 868
 869                 memset(cli->outbuf,'\0',smb_size);
 870                 memset(cli->inbuf,'\0',smb_size);
 871
 872                 cli_set_message(cli->outbuf,5, 0,True);
 873
 874                 SCVAL(cli->outbuf,smb_com,SMBwrite);
 875                 SSVAL(cli->outbuf,smb_tid,cli->cnum);
 876                 cli_setup_packet(cli);
 877
 878                 SSVAL(cli->outbuf,smb_vwv0,fnum);
 879                 SSVAL(cli->outbuf,smb_vwv1,size);
 880                 SIVAL(cli->outbuf,smb_vwv2,offset);
 881                 SSVAL(cli->outbuf,smb_vwv4,0);
 882
 883                 p = smb_buf(cli->outbuf);
 884                 *p++ = 1;
 885                 SSVAL(p, 0, size); p += 2;
 886                 memcpy(p, buf + total, size); p += size;
 887
 888                 cli_setup_bcc(cli, p);
 889
 890                 if (!cli_send_smb(cli))
 891                         return -1;
 892
 893                 if (!cli_receive_smb(cli))
 894                         return -1;
 895
 896                 if (cli_is_error(cli))
 897                         return -1;
 898
 899                 size = SVAL(cli->inbuf,smb_vwv0);
 900                 if (size == 0)
 901                         break;
 902
 903                 size1 -= size;
 904                 total += size;
 905                 offset += size;
 906
 907         } while (size1);
 908
 909         return total;
 910 }
 911
 912 /*
 913  * Send a write&x request
 914  */
 915
 916 struct cli_write_andx_state {
 917         size_t size;
 918         uint16_t vwv[14];
 919         size_t written;
 920         uint8_t pad;
 921         struct iovec iov[2];
 922 };
 923
 924 static void cli_write_andx_done(struct tevent_req *subreq);
 925
 926 struct tevent_req *cli_write_andx_create(TALLOC_CTX *mem_ctx,
 927                                          struct event_context *ev,
 928                                          struct cli_state *cli, uint16_t fnum,
 929                                          uint16_t mode, const uint8_t *buf,
 930                                          off_t offset, size_t size,
 931                                          struct tevent_req **reqs_before,
 932                                          int num_reqs_before,
 933                                          struct tevent_req **psmbreq)
 934 {
 935         struct tevent_req *req, *subreq;
 936         struct cli_write_andx_state *state;
 937         bool bigoffset = ((cli->capabilities & CAP_LARGE_FILES) != 0);
 938         uint8_t wct = bigoffset ? 14 : 12;
 939         size_t max_write = cli_write_max_bufsize(cli, mode);
 940         uint16_t *vwv;
 941
 942         req = tevent_req_create(mem_ctx, &state, struct cli_write_andx_state);
 943         if (req == NULL) {
 944                 return NULL;
 945         }
 946
 947         state->size = MIN(size, max_write);
 948
 949         vwv = state->vwv;
 950
 951         SCVAL(vwv+0, 0, 0xFF);
 952         SCVAL(vwv+0, 1, 0);
 953         SSVAL(vwv+1, 0, 0);
 954         SSVAL(vwv+2, 0, fnum);
 955         SIVAL(vwv+3, 0, offset);
 956         SIVAL(vwv+5, 0, 0);
 957         SSVAL(vwv+7, 0, mode);
 958         SSVAL(vwv+8, 0, 0);
 959         SSVAL(vwv+9, 0, (state->size>>16));
 960         SSVAL(vwv+10, 0, state->size);
 961
 962         SSVAL(vwv+11, 0,
 963               cli_smb_wct_ofs(reqs_before, num_reqs_before)
 964               + 1               /* the wct field */
 965               + wct * 2         /* vwv */
 966               + 2               /* num_bytes field */
 967               + 1               /* pad */);
 968
 969         if (bigoffset) {
 970                 SIVAL(vwv+12, 0, (((uint64_t)offset)>>32) & 0xffffffff);
 971         }
 972
 973         state->pad = 0;
 974         state->iov[0].iov_base = (void *)&state->pad;
 975         state->iov[0].iov_len = 1;
 976         state->iov[1].iov_base = CONST_DISCARD(void *, buf);
 977         state->iov[1].iov_len = state->size;
 978
 979         subreq = cli_smb_req_create(state, ev, cli, SMBwriteX, 0, wct, vwv,
 980                                     2, state->iov);
 981         if (tevent_req_nomem(subreq, req)) {
 982                 return tevent_req_post(req, ev);
 983         }
 984         tevent_req_set_callback(subreq, cli_write_andx_done, req);
 985         *psmbreq = subreq;
 986         return req;
 987 }
 988
 989 struct tevent_req *cli_write_andx_send(TALLOC_CTX *mem_ctx,
 990                                        struct event_context *ev,
 991                                        struct cli_state *cli, uint16_t fnum,
 992                                        uint16_t mode, const uint8_t *buf,
 993                                        off_t offset, size_t size)
 994 {
 995         struct tevent_req *req, *subreq;
 996         NTSTATUS status;
 997
 998         req = cli_write_andx_create(mem_ctx, ev, cli, fnum, mode, buf, offset,
 999                                     size, NULL, 0, &subreq);
1000         if (req == NULL) {
1001                 return NULL;
1002         }
1003
1004         status = cli_smb_req_send(subreq);
1005         if (!NT_STATUS_IS_OK(status)) {
1006                 tevent_req_nterror(req, status);
1007                 return tevent_req_post(req, ev);
1008         }
1009         return req;
1010 }
1011
1012 static void cli_write_andx_done(struct tevent_req *subreq)
1013 {
1014         struct tevent_req *req = tevent_req_callback_data(
1015                 subreq, struct tevent_req);
1016         struct cli_write_andx_state *state = tevent_req_data(
1017                 req, struct cli_write_andx_state);
1018         uint8_t wct;
1019         uint16_t *vwv;
1020         NTSTATUS status;
1021
1022         status = cli_smb_recv(subreq, 6, &wct, &vwv, NULL, NULL);
1023         if (NT_STATUS_IS_ERR(status)) {
1024                 TALLOC_FREE(subreq);
1025                 tevent_req_nterror(req, status);
1026                 return;
1027         }
1028         state->written = SVAL(vwv+2, 0);
1029         if (state->size > UINT16_MAX) {
1030                 /*
1031                  * It is important that we only set the
1032                  * high bits only if we asked for a large write.
1033                  *
1034                  * OS/2 print shares get this wrong and may send
1035                  * invalid values.
1036                  *
1037                  * See bug #5326.
1038                  */
1039                 state->written |= SVAL(vwv+4, 0)<<16;
1040         }
1041         tevent_req_done(req);
1042 }
1043
1044 NTSTATUS cli_write_andx_recv(struct tevent_req *req, size_t *pwritten)
1045 {
1046         struct cli_write_andx_state *state = tevent_req_data(
1047                 req, struct cli_write_andx_state);
1048         NTSTATUS status;
1049
1050         if (tevent_req_is_nterror(req, &status)) {
1051                 return status;
1052         }
1053         *pwritten = state->written;
1054         return NT_STATUS_OK;
1055 }
1056
1057 struct cli_writeall_state {
1058         struct event_context *ev;
1059         struct cli_state *cli;
1060         uint16_t fnum;
1061         uint16_t mode;
1062         const uint8_t *buf;
1063         off_t offset;
1064         size_t size;
1065         size_t written;
1066 };
1067
1068 static void cli_writeall_written(struct tevent_req *req);
1069
1070 static struct tevent_req *cli_writeall_send(TALLOC_CTX *mem_ctx,
1071                                             struct event_context *ev,
1072                                             struct cli_state *cli,
1073                                             uint16_t fnum,
1074                                             uint16_t mode,
1075                                             const uint8_t *buf,
1076                                             off_t offset, size_t size)
1077 {
1078         struct tevent_req *req, *subreq;
1079         struct cli_writeall_state *state;
1080
1081         req = tevent_req_create(mem_ctx, &state, struct cli_writeall_state);
1082         if (req == NULL) {
1083                 return NULL;
1084         }
1085         state->ev = ev;
1086         state->cli = cli;
1087         state->fnum = fnum;
1088         state->mode = mode;
1089         state->buf = buf;
1090         state->offset = offset;
1091         state->size = size;
1092         state->written = 0;
1093
1094         subreq = cli_write_andx_send(state, state->ev, state->cli, state->fnum,
1095                                      state->mode, state->buf, state->offset,
1096                                      state->size);
1097         if (tevent_req_nomem(subreq, req)) {
1098                 return tevent_req_post(req, ev);
1099         }
1100         tevent_req_set_callback(subreq, cli_writeall_written, req);
1101         return req;
1102 }
1103
1104 static void cli_writeall_written(struct tevent_req *subreq)
1105 {
1106         struct tevent_req *req = tevent_req_callback_data(
1107                 subreq, struct tevent_req);
1108         struct cli_writeall_state *state = tevent_req_data(
1109                 req, struct cli_writeall_state);
1110         NTSTATUS status;
1111         size_t written, to_write;
1112
1113         status = cli_write_andx_recv(subreq, &written);
1114         TALLOC_FREE(subreq);
1115         if (!NT_STATUS_IS_OK(status)) {
1116                 tevent_req_nterror(req, status);
1117                 return;
1118         }
1119
1120         state->written += written;
1121
1122         if (state->written > state->size) {
1123                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
1124                 return;
1125         }
1126
1127         to_write = state->size - state->written;
1128
1129         if (to_write == 0) {
1130                 tevent_req_done(req);
1131                 return;
1132         }
1133
1134         subreq = cli_write_andx_send(state, state->ev, state->cli, state->fnum,
1135                                      state->mode,
1136                                      state->buf + state->written,
1137                                      state->offset + state->written, to_write);
1138         if (tevent_req_nomem(subreq, req)) {
1139                 return;
1140         }
1141         tevent_req_set_callback(subreq, cli_writeall_written, req);
1142 }
1143
1144 static NTSTATUS cli_writeall_recv(struct tevent_req *req)
1145 {
1146         return tevent_req_simple_recv_ntstatus(req);
1147 }
1148
1149 struct cli_push_write_state {
1150         struct tevent_req *req;/* This is the main request! Not the subreq */
1151         uint32_t idx;
1152         off_t ofs;
1153         uint8_t *buf;
1154         size_t size;
1155 };
1156
1157 struct cli_push_state {
1158         struct event_context *ev;
1159         struct cli_state *cli;
1160         uint16_t fnum;
1161         uint16_t mode;
1162         off_t start_offset;
1163         size_t window_size;
1164
1165         size_t (*source)(uint8_t *buf, size_t n, void *priv);
1166         void *priv;
1167
1168         bool eof;
1169
1170         size_t chunk_size;
1171         off_t next_offset;
1172
1173         /*
1174          * Outstanding requests
1175          */
1176         uint32_t pending;
1177         uint32_t num_reqs;
1178         struct cli_push_write_state **reqs;
1179 };
1180
1181 static void cli_push_written(struct tevent_req *req);
1182
1183 static bool cli_push_write_setup(struct tevent_req *req,
1184                                  struct cli_push_state *state,
1185                                  uint32_t idx)
1186 {
1187         struct cli_push_write_state *substate;
1188         struct tevent_req *subreq;
1189
1190         substate = talloc(state->reqs, struct cli_push_write_state);
1191         if (!substate) {
1192                 return false;
1193         }
1194         substate->req = req;
1195         substate->idx = idx;
1196         substate->ofs = state->next_offset;
1197         substate->buf = talloc_array(substate, uint8_t, state->chunk_size);
1198         if (!substate->buf) {
1199                 talloc_free(substate);
1200                 return false;
1201         }
1202         substate->size = state->source(substate->buf,
1203                                        state->chunk_size,
1204                                        state->priv);
1205         if (substate->size == 0) {
1206                 state->eof = true;
1207                 /* nothing to send */
1208                 talloc_free(substate);
1209                 return true;
1210         }
1211
1212         subreq = cli_writeall_send(substate,
1213                                    state->ev, state->cli,
1214                                    state->fnum, state->mode,
1215                                    substate->buf,
1216                                    substate->ofs,
1217                                    substate->size);
1218         if (!subreq) {
1219                 talloc_free(substate);
1220                 return false;
1221         }
1222         tevent_req_set_callback(subreq, cli_push_written, substate);
1223
1224         state->reqs[idx] = substate;
1225         state->pending += 1;
1226         state->next_offset += substate->size;
1227
1228         return true;
1229 }
1230
1231 struct tevent_req *cli_push_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
1232                                  struct cli_state *cli,
1233                                  uint16_t fnum, uint16_t mode,
1234                                  off_t start_offset, size_t window_size,
1235                                  size_t (*source)(uint8_t *buf, size_t n,
1236                                                   void *priv),
1237                                  void *priv)
1238 {
1239         struct tevent_req *req;
1240         struct cli_push_state *state;
1241         uint32_t i;
1242
1243         req = tevent_req_create(mem_ctx, &state, struct cli_push_state);
1244         if (req == NULL) {
1245                 return NULL;
1246         }
1247         state->cli = cli;
1248         state->ev = ev;
1249         state->fnum = fnum;
1250         state->start_offset = start_offset;
1251         state->mode = mode;
1252         state->source = source;
1253         state->priv = priv;
1254         state->eof = false;
1255         state->pending = 0;
1256         state->next_offset = start_offset;
1257
1258         state->chunk_size = cli_write_max_bufsize(cli, mode);
1259
1260         if (window_size == 0) {
1261                 window_size = cli->max_mux * state->chunk_size;
1262         }
1263         state->num_reqs = window_size/state->chunk_size;
1264         if ((window_size % state->chunk_size) > 0) {
1265                 state->num_reqs += 1;
1266         }
1267         state->num_reqs = MIN(state->num_reqs, cli->max_mux);
1268         state->num_reqs = MAX(state->num_reqs, 1);
1269
1270         state->reqs = TALLOC_ZERO_ARRAY(state, struct cli_push_write_state *,
1271                                         state->num_reqs);
1272         if (state->reqs == NULL) {
1273                 goto failed;
1274         }
1275
1276         for (i=0; i<state->num_reqs; i++) {
1277                 if (!cli_push_write_setup(req, state, i)) {
1278                         goto failed;
1279                 }
1280
1281                 if (state->eof) {
1282                         break;
1283                 }
1284         }
1285
1286         if (state->pending == 0) {
1287                 tevent_req_done(req);
1288                 return tevent_req_post(req, ev);
1289         }
1290
1291         return req;
1292
1293  failed:
1294         tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
1295         return tevent_req_post(req, ev);
1296 }
1297
1298 static void cli_push_written(struct tevent_req *subreq)
1299 {
1300         struct cli_push_write_state *substate = tevent_req_callback_data(
1301                 subreq, struct cli_push_write_state);
1302         struct tevent_req *req = substate->req;
1303         struct cli_push_state *state = tevent_req_data(
1304                 req, struct cli_push_state);
1305         NTSTATUS status;
1306         uint32_t idx = substate->idx;
1307
1308         state->reqs[idx] = NULL;
1309         state->pending -= 1;
1310
1311         status = cli_writeall_recv(subreq);
1312         TALLOC_FREE(subreq);
1313         TALLOC_FREE(substate);
1314         if (!NT_STATUS_IS_OK(status)) {
1315                 tevent_req_nterror(req, status);
1316                 return;
1317         }
1318
1319         if (!state->eof) {
1320                 if (!cli_push_write_setup(req, state, idx)) {
1321                         tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
1322                         return;
1323                 }
1324         }
1325
1326         if (state->pending == 0) {
1327                 tevent_req_done(req);
1328                 return;
1329         }
1330 }
1331
1332 NTSTATUS cli_push_recv(struct tevent_req *req)
1333 {
1334         return tevent_req_simple_recv_ntstatus(req);
1335 }
1336
1337 NTSTATUS cli_push(struct cli_state *cli, uint16_t fnum, uint16_t mode,
1338                   off_t start_offset, size_t window_size,
1339                   size_t (*source)(uint8_t *buf, size_t n, void *priv),
1340                   void *priv)
1341 {
1342         TALLOC_CTX *frame = talloc_stackframe();
1343         struct event_context *ev;
1344         struct tevent_req *req;
1345         NTSTATUS status = NT_STATUS_OK;
1346
1347         if (cli_has_async_calls(cli)) {
1348                 /*
1349                  * Can't use sync call while an async call is in flight
1350                  */
1351                 status = NT_STATUS_INVALID_PARAMETER;
1352                 goto fail;
1353         }
1354
1355         ev = event_context_init(frame);
1356         if (ev == NULL) {
1357                 status = NT_STATUS_NO_MEMORY;
1358                 goto fail;
1359         }
1360
1361         req = cli_push_send(frame, ev, cli, fnum, mode, start_offset,
1362                             window_size, source, priv);
1363         if (req == NULL) {
1364                 status = NT_STATUS_NO_MEMORY;
1365                 goto fail;
1366         }
1367
1368         if (!tevent_req_poll(req, ev)) {
1369                 status = map_nt_error_from_unix(errno);
1370                 goto fail;
1371         }
1372
1373         status = cli_push_recv(req);
1374  fail:
1375         TALLOC_FREE(frame);
1376         if (!NT_STATUS_IS_OK(status)) {
1377                 cli_set_error(cli, status);
1378         }
1379         return status;
1380 }