git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/spool.c

   1 /*
   2  *  Spooling code
   3  *
   4  *      Kern Sibbald, March 2004
   5  *
   6  *  Version $Id$
   7  */
   8 /*
   9    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License as
  13    published by the Free Software Foundation; either version 2 of
  14    the License, or (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19    General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public
  22    License along with this program; if not, write to the Free
  23    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  24    MA 02111-1307, USA.
  25
  26  */
  27
  28 #include "bacula.h"
  29 #include "stored.h"
  30
  31 /* Forward referenced subroutines */
  32 static void make_unique_data_spool_filename(JCR *jcr, POOLMEM **name);
  33 static bool open_data_spool_file(JCR *jcr);
  34 static bool close_data_spool_file(JCR *jcr);
  35 static bool despool_data(DCR *dcr, bool commit);
  36 static int  read_block_from_spool_file(DCR *dcr, DEV_BLOCK *block);
  37 static bool open_attr_spool_file(JCR *jcr, BSOCK *bs);
  38 static bool close_attr_spool_file(JCR *jcr, BSOCK *bs);
  39 static bool write_spool_header(DCR *dcr, DEV_BLOCK *block);
  40 static bool write_spool_data(DCR *dcr, DEV_BLOCK *block);
  41
  42 struct spool_stats_t {
  43    uint32_t data_jobs;                /* current jobs spooling data */
  44    uint32_t attr_jobs;
  45    uint32_t total_data_jobs;          /* total jobs to have spooled data */
  46    uint32_t total_attr_jobs;
  47    int64_t max_data_size;             /* max data size */
  48    int64_t max_attr_size;
  49    int64_t data_size;                 /* current data size (all jobs running) */
  50    int64_t attr_size;
  51 };
  52
  53 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  54 spool_stats_t spool_stats;
  55
  56 /*
  57  * Header for data spool record */
  58 struct spool_hdr {
  59    int32_t  FirstIndex;               /* FirstIndex for buffer */
  60    int32_t  LastIndex;                /* LastIndex for buffer */
  61    uint32_t len;                      /* length of next buffer */
  62 };
  63
  64 enum {
  65    RB_EOT = 1,
  66    RB_ERROR,
  67    RB_OK
  68 };
  69
  70 void list_spool_stats(BSOCK *bs)
  71 {
  72    char ed1[30], ed2[30];
  73    if (spool_stats.data_jobs || spool_stats.max_data_size) {
  74       bnet_fsend(bs, "Data spooling: %u active jobs, %s bytes; %u total jobs, %s max bytes/job.\n",
  75          spool_stats.data_jobs, edit_uint64_with_commas(spool_stats.data_size, ed1),
  76          spool_stats.total_data_jobs,
  77          edit_uint64_with_commas(spool_stats.max_data_size, ed2));
  78    }
  79    if (spool_stats.attr_jobs || spool_stats.max_attr_size) {
  80       bnet_fsend(bs, "Attr spooling: %u active jobs, %s bytes; %u total jobs, %s max bytes.\n",
  81          spool_stats.attr_jobs, edit_uint64_with_commas(spool_stats.attr_size, ed1),
  82          spool_stats.total_attr_jobs,
  83          edit_uint64_with_commas(spool_stats.max_attr_size, ed2));
  84    }
  85 }
  86
  87 bool begin_data_spool(JCR *jcr)
  88 {
  89    bool stat = true;
  90    if (jcr->spool_data) {
  91       Dmsg0(100, "Turning on data spooling\n");
  92       jcr->dcr->spool_data = true;
  93       stat = open_data_spool_file(jcr);
  94       if (stat) {
  95          jcr->dcr->spooling = true;
  96          Jmsg(jcr, M_INFO, 0, _("Spooling data ...\n"));
  97          P(mutex);
  98          spool_stats.data_jobs++;
  99          V(mutex);
 100       }
 101    }
 102    return stat;
 103 }
 104
 105 bool discard_data_spool(JCR *jcr)
 106 {
 107    if (jcr->dcr->spooling) {
 108       Dmsg0(100, "Data spooling discarded\n");
 109       return close_data_spool_file(jcr);
 110    }
 111    return true;
 112 }
 113
 114 bool commit_data_spool(JCR *jcr)
 115 {
 116    bool stat;
 117
 118    if (jcr->dcr->spooling) {
 119       Dmsg0(100, "Committing spooled data\n");
 120       stat = despool_data(jcr->dcr, true /*commit*/);
 121       if (!stat) {
 122          Dmsg1(000, "Bad return from despool WroteVol=%d\n", jcr->dcr->WroteVol);
 123          close_data_spool_file(jcr);
 124          return false;
 125       }
 126       return close_data_spool_file(jcr);
 127    }
 128    return true;
 129 }
 130
 131 static void make_unique_data_spool_filename(JCR *jcr, POOLMEM **name)
 132 {
 133    char *dir;
 134    if (jcr->dcr->dev->device->spool_directory) {
 135       dir = jcr->dcr->dev->device->spool_directory;
 136    } else {
 137       dir = working_directory;
 138    }
 139    Mmsg(name, "%s/%s.data.spool.%s.%s", dir, my_name, jcr->Job, jcr->device->hdr.name);
 140 }
 141
 142
 143 static bool open_data_spool_file(JCR *jcr)
 144 {
 145    POOLMEM *name  = get_pool_memory(PM_MESSAGE);
 146    int spool_fd;
 147
 148    make_unique_data_spool_filename(jcr, &name);
 149    if ((spool_fd = open(name, O_CREAT|O_TRUNC|O_RDWR|O_BINARY, 0640)) >= 0) {
 150       jcr->dcr->spool_fd = spool_fd;
 151       jcr->spool_attributes = true;
 152    } else {
 153       Jmsg(jcr, M_ERROR, 0, _("Open data spool file %s failed: ERR=%s\n"), name, strerror(errno));
 154       free_pool_memory(name);
 155       return false;
 156    }
 157    Dmsg1(100, "Created spool file: %s\n", name);
 158    free_pool_memory(name);
 159    return true;
 160 }
 161
 162 static bool close_data_spool_file(JCR *jcr)
 163 {
 164    POOLMEM *name  = get_pool_memory(PM_MESSAGE);
 165
 166    P(mutex);
 167    spool_stats.data_jobs--;
 168    spool_stats.total_data_jobs++;
 169    if (spool_stats.data_size < jcr->dcr->spool_size) {
 170       spool_stats.data_size = 0;
 171    } else {
 172       spool_stats.data_size -= jcr->dcr->spool_size;
 173    }
 174    jcr->dcr->spool_size = 0;
 175    V(mutex);
 176
 177    make_unique_data_spool_filename(jcr, &name);
 178    close(jcr->dcr->spool_fd);
 179    jcr->dcr->spool_fd = -1;
 180    jcr->dcr->spooling = false;
 181    unlink(name);
 182    Dmsg1(100, "Deleted spool file: %s\n", name);
 183    free_pool_memory(name);
 184    return true;
 185 }
 186
 187 static bool despool_data(DCR *dcr, bool commit)
 188 {
 189    DEVICE *rdev;
 190    DCR *rdcr;
 191    bool ok = true;
 192    DEV_BLOCK *block;
 193    JCR *jcr = dcr->jcr;
 194    int stat;
 195    char ec1[50];
 196
 197    Dmsg0(100, "Despooling data\n");
 198    Jmsg(jcr, M_INFO, 0, _("%s spooled data to Volume. Despooling %s bytes ...\n"),
 199         commit?"Committing":"Writting",
 200         edit_uint64_with_commas(jcr->dcr->dev->spool_size, ec1));
 201    dcr->spooling = false;
 202    lock_device(dcr->dev);
 203    dcr->dev_locked = true;
 204
 205    /* Setup a dev structure to read */
 206    rdev = (DEVICE *)malloc(sizeof(DEVICE));
 207    memset(rdev, 0, sizeof(DEVICE));
 208    rdev->dev_name = get_memory(strlen("spool")+1);
 209    strcpy(rdev->dev_name, "spool");
 210    rdev->errmsg = get_pool_memory(PM_EMSG);
 211    *rdev->errmsg = 0;
 212    rdev->max_block_size = dcr->dev->max_block_size;
 213    rdev->min_block_size = dcr->dev->min_block_size;
 214    rdev->device = dcr->dev->device;
 215    rdcr = new_dcr(NULL, rdev);
 216    rdcr->spool_fd = dcr->spool_fd;
 217    rdcr->jcr = jcr;                   /* set a valid jcr */
 218    block = rdcr->block;
 219    Dmsg1(800, "read/write block size = %d\n", block->buf_len);
 220    lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
 221
 222    for ( ; ok; ) {
 223       if (job_canceled(jcr)) {
 224          ok = false;
 225          break;
 226       }
 227       stat = read_block_from_spool_file(rdcr, block);
 228       if (stat == RB_EOT) {
 229          break;
 230       } else if (stat == RB_ERROR) {
 231          ok = false;
 232          break;
 233       }
 234       ok = write_block_to_device(dcr, block);
 235       Dmsg3(100, "Write block ok=%d FI=%d LI=%d\n", ok, block->FirstIndex, block->LastIndex);
 236    }
 237
 238    lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
 239    if (ftruncate(rdcr->spool_fd, 0) != 0) {
 240       Jmsg(dcr->jcr, M_FATAL, 0, _("Ftruncate spool file error. ERR=%s\n"),
 241          strerror(errno));
 242       Dmsg1(000, "Bad return from ftruncate. ERR=%s\n", strerror(errno));
 243       ok = false;
 244    }
 245
 246    P(mutex);
 247    if (spool_stats.data_size < dcr->spool_size) {
 248       spool_stats.data_size = 0;
 249    } else {
 250       spool_stats.data_size -= dcr->spool_size;
 251    }
 252    V(mutex);
 253    P(dcr->dev->spool_mutex);
 254    dcr->dev->spool_size -= dcr->spool_size;
 255    dcr->spool_size = 0;               /* zap size in input dcr */
 256    V(dcr->dev->spool_mutex);
 257    free_memory(rdev->dev_name);
 258    free_pool_memory(rdev->errmsg);
 259    free(rdev);
 260    rdcr->jcr = NULL;
 261    free_dcr(rdcr);
 262    unlock_device(dcr->dev);
 263    dcr->dev_locked = false;
 264    dcr->spooling = true;           /* turn on spooling again */
 265    return ok;
 266 }
 267
 268 /*
 269  * Read a block from the spool file
 270  *
 271  *  Returns RB_OK on success
 272  *          RB_EOT when file done
 273  *          RB_ERROR on error
 274  */
 275 static int read_block_from_spool_file(DCR *dcr, DEV_BLOCK *block)
 276 {
 277    uint32_t rlen;
 278    ssize_t stat;
 279    spool_hdr hdr;
 280
 281    rlen = sizeof(hdr);
 282    stat = read(dcr->spool_fd, (char *)&hdr, (size_t)rlen);
 283    if (stat == 0) {
 284       Dmsg0(100, "EOT on spool read.\n");
 285       return RB_EOT;
 286    } else if (stat != (ssize_t)rlen) {
 287       if (stat == -1) {
 288          Jmsg(dcr->jcr, M_FATAL, 0, _("Spool header read error. ERR=%s\n"), strerror(errno));
 289       } else {
 290          Dmsg2(000, "Spool read error. Wanted %u bytes, got %u\n", rlen, stat);
 291          Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool header read error. Wanted %u bytes, got %u\n"), rlen, stat);
 292       }
 293       return RB_ERROR;
 294    }
 295    rlen = hdr.len;
 296    if (rlen > block->buf_len) {
 297       Dmsg2(000, "Spool block too big. Max %u bytes, got %u\n", block->buf_len, rlen);
 298       Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool block too big. Max %u bytes, got %u\n"), block->buf_len, rlen);
 299       return RB_ERROR;
 300    }
 301    stat = read(dcr->spool_fd, (char *)block->buf, (size_t)rlen);
 302    if (stat != (ssize_t)rlen) {
 303       Dmsg2(000, "Spool data read error. Wanted %u bytes, got %u\n", rlen, stat);
 304       Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool data read error. Wanted %u bytes, got %u\n"), rlen, stat);
 305       return RB_ERROR;
 306    }
 307    /* Setup write pointers */
 308    block->binbuf = rlen;
 309    block->bufp = block->buf + block->binbuf;
 310    block->FirstIndex = hdr.FirstIndex;
 311    block->LastIndex = hdr.LastIndex;
 312    block->VolSessionId = dcr->jcr->VolSessionId;
 313    block->VolSessionTime = dcr->jcr->VolSessionTime;
 314    Dmsg2(100, "Read block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
 315    return RB_OK;
 316 }
 317
 318 /*
 319  * Write a block to the spool file
 320  *
 321  *  Returns: true on success or EOT
 322  *           false on hard error
 323  */
 324 bool write_block_to_spool_file(DCR *dcr, DEV_BLOCK *block)
 325 {
 326    uint32_t wlen, hlen;               /* length to write */
 327    bool despool = false;
 328
 329    ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
 330    if (block->binbuf <= WRITE_BLKHDR_LENGTH) {  /* Does block have data in it? */
 331       return true;
 332    }
 333
 334    hlen = sizeof(spool_hdr);
 335    wlen = block->binbuf;
 336    P(dcr->dev->spool_mutex);
 337    dcr->spool_size += hlen + wlen;
 338    dcr->dev->spool_size += hlen + wlen;
 339    if ((dcr->max_spool_size > 0 && dcr->spool_size >= dcr->max_spool_size) ||
 340        (dcr->dev->max_spool_size > 0 && dcr->dev->spool_size >= dcr->dev->max_spool_size)) {
 341       despool = true;
 342    }
 343    V(dcr->dev->spool_mutex);
 344    P(mutex);
 345    spool_stats.data_size += hlen + wlen;
 346    if (spool_stats.data_size > spool_stats.max_data_size) {
 347       spool_stats.max_data_size = spool_stats.data_size;
 348    }
 349    V(mutex);
 350    if (despool) {
 351 #ifdef xDEBUG
 352       char ec1[30], ec2[30], ec3[30], ec4[30];
 353       Dmsg4(100, "Despool in write_block_to_spool_file max_size=%s size=%s "
 354             "max_job_size=%s job_size=%s\n",
 355             edit_uint64_with_commas(dcr->max_spool_size, ec1),
 356             edit_uint64_with_commas(dcr->spool_size, ec2),
 357             edit_uint64_with_commas(dcr->dev->max_spool_size, ec3),
 358             edit_uint64_with_commas(dcr->dev->spool_size, ec4));
 359 #endif
 360       Jmsg(dcr->jcr, M_INFO, 0, _("User specified spool size reached.\n"));
 361       if (!despool_data(dcr, false)) {
 362          Dmsg0(000, "Bad return from despool in write_block.\n");
 363          return false;
 364       }
 365       /* Despooling cleared these variables so reset them */
 366       P(dcr->dev->spool_mutex);
 367       dcr->spool_size += hlen + wlen;
 368       dcr->dev->spool_size += hlen + wlen;
 369       V(dcr->dev->spool_mutex);
 370       Jmsg(dcr->jcr, M_INFO, 0, _("Spooling data again ...\n"));
 371    }
 372
 373
 374    if (!write_spool_header(dcr, block)) {
 375       return false;
 376    }
 377    if (!write_spool_data(dcr, block)) {
 378      return false;
 379    }
 380
 381    Dmsg2(100, "Wrote block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
 382    empty_block(block);
 383    return true;
 384 }
 385
 386 static bool write_spool_header(DCR *dcr, DEV_BLOCK *block)
 387 {
 388    spool_hdr hdr;
 389    ssize_t stat;
 390
 391    hdr.FirstIndex = block->FirstIndex;
 392    hdr.LastIndex = block->LastIndex;
 393    hdr.len = block->binbuf;
 394
 395    /* Write header */
 396    for (int retry=0; retry<=1; retry++) {
 397       stat = write(dcr->spool_fd, (char*)&hdr, sizeof(hdr));
 398       if (stat == -1) {
 399          Jmsg(dcr->jcr, M_INFO, 0, _("Error writing header to spool file. ERR=%s\n"), strerror(errno));
 400       }
 401       if (stat != (ssize_t)sizeof(hdr)) {
 402          /* If we wrote something, truncate it, then despool */
 403          if (stat != -1) {
 404             ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR) - stat);
 405          }
 406          if (!despool_data(dcr, false)) {
 407             Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
 408             return false;
 409          }
 410          continue;                    /* try again */
 411       }
 412       return true;
 413    }
 414    Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after header spooling error failed.\n"));
 415    return false;
 416 }
 417
 418 static bool write_spool_data(DCR *dcr, DEV_BLOCK *block)
 419 {
 420    ssize_t stat;
 421
 422    /* Write data */
 423    for (int retry=0; retry<=1; retry++) {
 424       stat = write(dcr->spool_fd, block->buf, (size_t)block->binbuf);
 425       if (stat == -1) {
 426          Jmsg(dcr->jcr, M_INFO, 0, _("Error writing data to spool file. ERR=%s\n"), strerror(errno));
 427       }
 428       if (stat != (ssize_t)block->binbuf) {
 429          /*
 430           * If we wrote something, truncate it and the header, then despool
 431           */
 432          if (stat != -1) {
 433             ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR)
 434                       - stat - sizeof(spool_hdr));
 435          }
 436          if (!despool_data(dcr, false)) {
 437             Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
 438             return false;
 439          }
 440          if (!write_spool_header(dcr, block)) {
 441             return false;
 442          }
 443          continue;                    /* try again */
 444    }
 445    return true;
 446    }
 447    Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after data spooling error failed.\n"));
 448    return false;
 449 }
 450
 451
 452
 453 bool are_attributes_spooled(JCR *jcr)
 454 {
 455    return jcr->spool_attributes && jcr->dir_bsock->spool_fd;
 456 }
 457
 458 /*
 459  * Create spool file for attributes.
 460  *  This is done by "attaching" to the bsock, and when
 461  *  it is called, the output is written to a file.
 462  *  The actual spooling is turned on and off in
 463  *  append.c only during writing of the attributes.
 464  */
 465 bool begin_attribute_spool(JCR *jcr)
 466 {
 467    if (!jcr->no_attributes && jcr->spool_attributes) {
 468       return open_attr_spool_file(jcr, jcr->dir_bsock);
 469    }
 470    return true;
 471 }
 472
 473 bool discard_attribute_spool(JCR *jcr)
 474 {
 475    if (are_attributes_spooled(jcr)) {
 476       return close_attr_spool_file(jcr, jcr->dir_bsock);
 477    }
 478    return true;
 479 }
 480
 481 static void update_attr_spool_size(ssize_t size)
 482 {
 483    P(mutex);
 484    if (size > 0) {
 485      if ((spool_stats.attr_size - size) > 0) {
 486         spool_stats.attr_size -= size;
 487      } else {
 488         spool_stats.attr_size = 0;
 489      }
 490    }
 491    V(mutex);
 492 }
 493
 494 bool commit_attribute_spool(JCR *jcr)
 495 {
 496    ssize_t size;
 497    char ec1[30];
 498
 499    if (are_attributes_spooled(jcr)) {
 500       fseek(jcr->dir_bsock->spool_fd, 0, SEEK_END);
 501       size = ftell(jcr->dir_bsock->spool_fd);
 502       P(mutex);
 503       if (size > 0) {
 504         if (spool_stats.attr_size + size > spool_stats.max_attr_size) {
 505            spool_stats.max_attr_size = spool_stats.attr_size + size;
 506         }
 507       }
 508       spool_stats.attr_size += size;
 509       V(mutex);
 510       Jmsg(jcr, M_INFO, 0, _("Sending spooled attrs to DIR. Despooling %s bytes ...\n"),
 511             edit_uint64_with_commas(size, ec1));
 512       bnet_despool_to_bsock(jcr->dir_bsock, update_attr_spool_size, size);
 513       return close_attr_spool_file(jcr, jcr->dir_bsock);
 514    }
 515    return true;
 516 }
 517
 518 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
 519 {
 520    Mmsg(name, "%s/%s.attr.spool.%s.%d", working_directory, my_name,
 521       jcr->Job, fd);
 522 }
 523
 524
 525 bool open_attr_spool_file(JCR *jcr, BSOCK *bs)
 526 {
 527    POOLMEM *name  = get_pool_memory(PM_MESSAGE);
 528
 529    make_unique_spool_filename(jcr, &name, bs->fd);
 530    bs->spool_fd = fopen(mp_chr(name), "w+");
 531    if (!bs->spool_fd) {
 532       Jmsg(jcr, M_ERROR, 0, _("fopen attr spool file %s failed: ERR=%s\n"), name, strerror(errno));
 533       free_pool_memory(name);
 534       return false;
 535    }
 536    P(mutex);
 537    spool_stats.attr_jobs++;
 538    V(mutex);
 539    free_pool_memory(name);
 540    return true;
 541 }
 542
 543 bool close_attr_spool_file(JCR *jcr, BSOCK *bs)
 544 {
 545    POOLMEM *name;
 546
 547    if (!bs->spool_fd) {
 548       return true;
 549    }
 550    name = get_pool_memory(PM_MESSAGE);
 551    P(mutex);
 552    spool_stats.attr_jobs--;
 553    spool_stats.total_attr_jobs++;
 554    V(mutex);
 555    make_unique_spool_filename(jcr, &name, bs->fd);
 556    fclose(bs->spool_fd);
 557    unlink(mp_chr(name));
 558    free_pool_memory(name);
 559    bs->spool_fd = NULL;
 560    bs->spool = false;
 561    return true;
 562 }