4 * Kern Sibbald, March 2004
9 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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.
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.
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,
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);
42 struct spool_stats_t {
43 uint32_t data_jobs; /* current jobs spooling data */
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) */
53 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
54 spool_stats_t spool_stats;
57 * Header for data spool record */
59 int32_t FirstIndex; /* FirstIndex for buffer */
60 int32_t LastIndex; /* LastIndex for buffer */
61 uint32_t len; /* length of next buffer */
70 void list_spool_stats(BSOCK *bs)
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));
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));
87 bool begin_data_spool(JCR *jcr)
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);
95 jcr->dcr->spooling = true;
96 Jmsg(jcr, M_INFO, 0, _("Spooling data ...\n"));
98 spool_stats.data_jobs++;
105 bool discard_data_spool(JCR *jcr)
107 if (jcr->dcr->spooling) {
108 Dmsg0(100, "Data spooling discarded\n");
109 return close_data_spool_file(jcr);
114 bool commit_data_spool(JCR *jcr)
118 if (jcr->dcr->spooling) {
119 Dmsg0(100, "Committing spooled data\n");
120 stat = despool_data(jcr->dcr, true /*commit*/);
122 Dmsg1(000, "Bad return from despool WroteVol=%d\n", jcr->dcr->WroteVol);
123 close_data_spool_file(jcr);
126 return close_data_spool_file(jcr);
131 static void make_unique_data_spool_filename(JCR *jcr, POOLMEM **name)
134 if (jcr->dcr->dev->device->spool_directory) {
135 dir = jcr->dcr->dev->device->spool_directory;
137 dir = working_directory;
139 Mmsg(name, "%s/%s.data.spool.%s.%s", dir, my_name, jcr->Job, jcr->device->hdr.name);
143 static bool open_data_spool_file(JCR *jcr)
145 POOLMEM *name = get_pool_memory(PM_MESSAGE);
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;
153 Jmsg(jcr, M_ERROR, 0, _("Open data spool file %s failed: ERR=%s\n"), name, strerror(errno));
154 free_pool_memory(name);
157 Dmsg1(100, "Created spool file: %s\n", name);
158 free_pool_memory(name);
162 static bool close_data_spool_file(JCR *jcr)
164 POOLMEM *name = get_pool_memory(PM_MESSAGE);
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;
172 spool_stats.data_size -= jcr->dcr->spool_size;
174 jcr->dcr->spool_size = 0;
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;
182 Dmsg1(100, "Deleted spool file: %s\n", name);
183 free_pool_memory(name);
187 static const char *spool_name = "*spool*";
189 static bool despool_data(DCR *dcr, bool commit)
199 Dmsg0(100, "Despooling data\n");
200 Jmsg(jcr, M_INFO, 0, _("%s spooled data to Volume. Despooling %s bytes ...\n"),
201 commit?"Committing":"Writting",
202 edit_uint64_with_commas(jcr->dcr->dev->spool_size, ec1));
203 dcr->spooling = false;
204 lock_device(dcr->dev);
205 dcr->dev_locked = true;
208 * This is really quite kludgy and should be fixed some time.
209 * We create a dev structure to read from the spool file
212 rdev = (DEVICE *)malloc(sizeof(DEVICE));
213 memset(rdev, 0, sizeof(DEVICE));
214 rdev->dev_name = get_memory(strlen(spool_name)+1);
215 strcpy(rdev->dev_name, spool_name);
216 rdev->errmsg = get_pool_memory(PM_EMSG);
218 rdev->max_block_size = dcr->dev->max_block_size;
219 rdev->min_block_size = dcr->dev->min_block_size;
220 rdev->device = dcr->dev->device;
221 rdcr = new_dcr(NULL, rdev);
222 rdcr->spool_fd = dcr->spool_fd;
223 rdcr->jcr = jcr; /* set a valid jcr */
226 Dmsg1(800, "read/write block size = %d\n", block->buf_len);
227 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
230 if (job_canceled(jcr)) {
234 stat = read_block_from_spool_file(rdcr, block);
235 if (stat == RB_EOT) {
237 } else if (stat == RB_ERROR) {
241 ok = write_block_to_device(dcr, block);
242 Dmsg3(100, "Write block ok=%d FI=%d LI=%d\n", ok, block->FirstIndex, block->LastIndex);
245 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
246 if (ftruncate(rdcr->spool_fd, 0) != 0) {
247 Jmsg(dcr->jcr, M_FATAL, 0, _("Ftruncate spool file error. ERR=%s\n"),
249 Dmsg1(000, "Bad return from ftruncate. ERR=%s\n", strerror(errno));
254 if (spool_stats.data_size < dcr->spool_size) {
255 spool_stats.data_size = 0;
257 spool_stats.data_size -= dcr->spool_size;
260 P(dcr->dev->spool_mutex);
261 dcr->dev->spool_size -= dcr->spool_size;
262 dcr->spool_size = 0; /* zap size in input dcr */
263 V(dcr->dev->spool_mutex);
264 free_memory(rdev->dev_name);
265 free_pool_memory(rdev->errmsg);
266 /* Be careful to NULL the jcr and free rdev after free_dcr() */
270 unlock_device(dcr->dev);
271 dcr->dev_locked = false;
272 dcr->spooling = true; /* turn on spooling again */
277 * Read a block from the spool file
279 * Returns RB_OK on success
280 * RB_EOT when file done
283 static int read_block_from_spool_file(DCR *dcr, DEV_BLOCK *block)
290 stat = read(dcr->spool_fd, (char *)&hdr, (size_t)rlen);
292 Dmsg0(100, "EOT on spool read.\n");
294 } else if (stat != (ssize_t)rlen) {
296 Jmsg(dcr->jcr, M_FATAL, 0, _("Spool header read error. ERR=%s\n"), strerror(errno));
298 Dmsg2(000, "Spool read error. Wanted %u bytes, got %u\n", rlen, stat);
299 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool header read error. Wanted %u bytes, got %u\n"), rlen, stat);
304 if (rlen > block->buf_len) {
305 Dmsg2(000, "Spool block too big. Max %u bytes, got %u\n", block->buf_len, rlen);
306 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool block too big. Max %u bytes, got %u\n"), block->buf_len, rlen);
309 stat = read(dcr->spool_fd, (char *)block->buf, (size_t)rlen);
310 if (stat != (ssize_t)rlen) {
311 Dmsg2(000, "Spool data read error. Wanted %u bytes, got %u\n", rlen, stat);
312 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool data read error. Wanted %u bytes, got %u\n"), rlen, stat);
315 /* Setup write pointers */
316 block->binbuf = rlen;
317 block->bufp = block->buf + block->binbuf;
318 block->FirstIndex = hdr.FirstIndex;
319 block->LastIndex = hdr.LastIndex;
320 block->VolSessionId = dcr->jcr->VolSessionId;
321 block->VolSessionTime = dcr->jcr->VolSessionTime;
322 Dmsg2(100, "Read block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
327 * Write a block to the spool file
329 * Returns: true on success or EOT
330 * false on hard error
332 bool write_block_to_spool_file(DCR *dcr, DEV_BLOCK *block)
334 uint32_t wlen, hlen; /* length to write */
335 bool despool = false;
337 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
338 if (block->binbuf <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
342 hlen = sizeof(spool_hdr);
343 wlen = block->binbuf;
344 P(dcr->dev->spool_mutex);
345 dcr->spool_size += hlen + wlen;
346 dcr->dev->spool_size += hlen + wlen;
347 if ((dcr->max_spool_size > 0 && dcr->spool_size >= dcr->max_spool_size) ||
348 (dcr->dev->max_spool_size > 0 && dcr->dev->spool_size >= dcr->dev->max_spool_size)) {
351 V(dcr->dev->spool_mutex);
353 spool_stats.data_size += hlen + wlen;
354 if (spool_stats.data_size > spool_stats.max_data_size) {
355 spool_stats.max_data_size = spool_stats.data_size;
360 char ec1[30], ec2[30], ec3[30], ec4[30];
361 Dmsg4(100, "Despool in write_block_to_spool_file max_size=%s size=%s "
362 "max_job_size=%s job_size=%s\n",
363 edit_uint64_with_commas(dcr->max_spool_size, ec1),
364 edit_uint64_with_commas(dcr->spool_size, ec2),
365 edit_uint64_with_commas(dcr->dev->max_spool_size, ec3),
366 edit_uint64_with_commas(dcr->dev->spool_size, ec4));
368 Jmsg(dcr->jcr, M_INFO, 0, _("User specified spool size reached.\n"));
369 if (!despool_data(dcr, false)) {
370 Dmsg0(000, "Bad return from despool in write_block.\n");
373 /* Despooling cleared these variables so reset them */
374 P(dcr->dev->spool_mutex);
375 dcr->spool_size += hlen + wlen;
376 dcr->dev->spool_size += hlen + wlen;
377 V(dcr->dev->spool_mutex);
378 Jmsg(dcr->jcr, M_INFO, 0, _("Spooling data again ...\n"));
382 if (!write_spool_header(dcr, block)) {
385 if (!write_spool_data(dcr, block)) {
389 Dmsg2(100, "Wrote block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
394 static bool write_spool_header(DCR *dcr, DEV_BLOCK *block)
399 hdr.FirstIndex = block->FirstIndex;
400 hdr.LastIndex = block->LastIndex;
401 hdr.len = block->binbuf;
404 for (int retry=0; retry<=1; retry++) {
405 stat = write(dcr->spool_fd, (char*)&hdr, sizeof(hdr));
407 Jmsg(dcr->jcr, M_INFO, 0, _("Error writing header to spool file. ERR=%s\n"), strerror(errno));
409 if (stat != (ssize_t)sizeof(hdr)) {
410 /* If we wrote something, truncate it, then despool */
412 ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR) - stat);
414 if (!despool_data(dcr, false)) {
415 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
418 continue; /* try again */
422 Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after header spooling error failed.\n"));
426 static bool write_spool_data(DCR *dcr, DEV_BLOCK *block)
431 for (int retry=0; retry<=1; retry++) {
432 stat = write(dcr->spool_fd, block->buf, (size_t)block->binbuf);
434 Jmsg(dcr->jcr, M_INFO, 0, _("Error writing data to spool file. ERR=%s\n"), strerror(errno));
436 if (stat != (ssize_t)block->binbuf) {
438 * If we wrote something, truncate it and the header, then despool
441 ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR)
442 - stat - sizeof(spool_hdr));
444 if (!despool_data(dcr, false)) {
445 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
448 if (!write_spool_header(dcr, block)) {
451 continue; /* try again */
455 Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after data spooling error failed.\n"));
461 bool are_attributes_spooled(JCR *jcr)
463 return jcr->spool_attributes && jcr->dir_bsock->spool_fd;
467 * Create spool file for attributes.
468 * This is done by "attaching" to the bsock, and when
469 * it is called, the output is written to a file.
470 * The actual spooling is turned on and off in
471 * append.c only during writing of the attributes.
473 bool begin_attribute_spool(JCR *jcr)
475 if (!jcr->no_attributes && jcr->spool_attributes) {
476 return open_attr_spool_file(jcr, jcr->dir_bsock);
481 bool discard_attribute_spool(JCR *jcr)
483 if (are_attributes_spooled(jcr)) {
484 return close_attr_spool_file(jcr, jcr->dir_bsock);
489 static void update_attr_spool_size(ssize_t size)
493 if ((spool_stats.attr_size - size) > 0) {
494 spool_stats.attr_size -= size;
496 spool_stats.attr_size = 0;
502 bool commit_attribute_spool(JCR *jcr)
507 if (are_attributes_spooled(jcr)) {
508 fseek(jcr->dir_bsock->spool_fd, 0, SEEK_END);
509 size = ftell(jcr->dir_bsock->spool_fd);
512 if (spool_stats.attr_size + size > spool_stats.max_attr_size) {
513 spool_stats.max_attr_size = spool_stats.attr_size + size;
516 spool_stats.attr_size += size;
518 Jmsg(jcr, M_INFO, 0, _("Sending spooled attrs to DIR. Despooling %s bytes ...\n"),
519 edit_uint64_with_commas(size, ec1));
520 bnet_despool_to_bsock(jcr->dir_bsock, update_attr_spool_size, size);
521 return close_attr_spool_file(jcr, jcr->dir_bsock);
526 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
528 Mmsg(name, "%s/%s.attr.spool.%s.%d", working_directory, my_name,
533 bool open_attr_spool_file(JCR *jcr, BSOCK *bs)
535 POOLMEM *name = get_pool_memory(PM_MESSAGE);
537 make_unique_spool_filename(jcr, &name, bs->fd);
538 bs->spool_fd = fopen(mp_chr(name), "w+");
540 Jmsg(jcr, M_ERROR, 0, _("fopen attr spool file %s failed: ERR=%s\n"), name, strerror(errno));
541 free_pool_memory(name);
545 spool_stats.attr_jobs++;
547 free_pool_memory(name);
551 bool close_attr_spool_file(JCR *jcr, BSOCK *bs)
558 name = get_pool_memory(PM_MESSAGE);
560 spool_stats.attr_jobs--;
561 spool_stats.total_attr_jobs++;
563 make_unique_spool_filename(jcr, &name, bs->fd);
564 fclose(bs->spool_fd);
565 unlink(mp_chr(name));
566 free_pool_memory(name);