4 * Kern Sibbald, March 2004
9 Copyright (C) 2004-2005 Kern Sibbald
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(DCR *dcr, POOLMEM **name);
33 static bool open_data_spool_file(DCR *dcr);
34 static bool close_data_spool_file(DCR *dcr);
35 static bool despool_data(DCR *dcr, bool commit);
36 static int read_block_from_spool_file(DCR *dcr);
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);
40 static bool write_spool_data(DCR *dcr);
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(DCR *dcr)
90 if (dcr->jcr->spool_data) {
91 Dmsg0(100, "Turning on data spooling\n");
92 dcr->spool_data = true;
93 stat = open_data_spool_file(dcr);
96 Jmsg(dcr->jcr, M_INFO, 0, _("Spooling data ...\n"));
98 spool_stats.data_jobs++;
105 bool discard_data_spool(DCR *dcr)
108 Dmsg0(100, "Data spooling discarded\n");
109 return close_data_spool_file(dcr);
114 bool commit_data_spool(DCR *dcr)
119 Dmsg0(100, "Committing spooled data\n");
120 stat = despool_data(dcr, true /*commit*/);
122 Pmsg1(000, "Bad return from despool WroteVol=%d\n", dcr->WroteVol);
123 close_data_spool_file(dcr);
126 return close_data_spool_file(dcr);
131 static void make_unique_data_spool_filename(DCR *dcr, POOLMEM **name)
134 if (dcr->dev->device->spool_directory) {
135 dir = dcr->dev->device->spool_directory;
137 dir = working_directory;
139 Mmsg(name, "%s/%s.data.spool.%s.%s", dir, my_name, dcr->jcr->Job,
140 dcr->device->hdr.name);
144 static bool open_data_spool_file(DCR *dcr)
146 POOLMEM *name = get_pool_memory(PM_MESSAGE);
149 make_unique_data_spool_filename(dcr, &name);
150 if ((spool_fd = open(name, O_CREAT|O_TRUNC|O_RDWR|O_BINARY, 0640)) >= 0) {
151 dcr->spool_fd = spool_fd;
152 dcr->jcr->spool_attributes = true;
155 Jmsg(dcr->jcr, M_FATAL, 0, _("Open data spool file %s failed: ERR=%s\n"), name,
157 free_pool_memory(name);
160 Dmsg1(100, "Created spool file: %s\n", name);
161 free_pool_memory(name);
165 static bool close_data_spool_file(DCR *dcr)
167 POOLMEM *name = get_pool_memory(PM_MESSAGE);
170 spool_stats.data_jobs--;
171 spool_stats.total_data_jobs++;
172 if (spool_stats.data_size < dcr->spool_size) {
173 spool_stats.data_size = 0;
175 spool_stats.data_size -= dcr->spool_size;
180 make_unique_data_spool_filename(dcr, &name);
181 close(dcr->spool_fd);
183 dcr->spooling = false;
185 Dmsg1(100, "Deleted spool file: %s\n", name);
186 free_pool_memory(name);
190 static const char *spool_name = "*spool*";
192 static bool despool_data(DCR *dcr, bool commit)
202 Dmsg0(100, "Despooling data\n");
203 Jmsg(jcr, M_INFO, 0, _("%s spooled data to Volume. Despooling %s bytes ...\n"),
204 commit?"Committing":"Writing",
205 edit_uint64_with_commas(jcr->dcr->spool_size, ec1));
206 dcr->spooling = false;
207 lock_device(dcr->dev);
208 dcr->dev_locked = true;
211 * This is really quite kludgy and should be fixed some time.
212 * We create a dev structure to read from the spool file
215 rdev = (DEVICE *)malloc(sizeof(DEVICE));
216 memset(rdev, 0, sizeof(DEVICE));
217 rdev->dev_name = get_memory(strlen(spool_name)+1);
218 bstrncpy(rdev->dev_name, spool_name, sizeof(rdev->dev_name));
219 rdev->errmsg = get_pool_memory(PM_EMSG);
221 rdev->max_block_size = dcr->dev->max_block_size;
222 rdev->min_block_size = dcr->dev->min_block_size;
223 rdev->device = dcr->dev->device;
224 rdcr = new_dcr(NULL, rdev);
225 rdcr->spool_fd = dcr->spool_fd;
226 rdcr->jcr = jcr; /* set a valid jcr */
227 block = dcr->block; /* save block */
228 dcr->block = rdcr->block; /* make read and write block the same */
230 Dmsg1(800, "read/write block size = %d\n", block->buf_len);
231 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
234 if (job_canceled(jcr)) {
238 stat = read_block_from_spool_file(rdcr);
239 if (stat == RB_EOT) {
241 } else if (stat == RB_ERROR) {
245 ok = write_block_to_device(dcr);
246 Dmsg3(800, "Write block ok=%d FI=%d LI=%d\n", ok, block->FirstIndex, block->LastIndex);
248 dcr->block = block; /* reset block */
250 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
251 if (ftruncate(rdcr->spool_fd, 0) != 0) {
253 Jmsg(dcr->jcr, M_ERROR, 0, _("Ftruncate spool file failed: ERR=%s\n"),
255 Pmsg1(000, "Bad return from ftruncate. ERR=%s\n", be.strerror());
260 if (spool_stats.data_size < dcr->spool_size) {
261 spool_stats.data_size = 0;
263 spool_stats.data_size -= dcr->spool_size;
266 P(dcr->dev->spool_mutex);
267 dcr->dev->spool_size -= dcr->spool_size;
268 dcr->spool_size = 0; /* zap size in input dcr */
269 V(dcr->dev->spool_mutex);
270 free_memory(rdev->dev_name);
271 free_pool_memory(rdev->errmsg);
272 /* Be careful to NULL the jcr and free rdev after free_dcr() */
276 unlock_device(dcr->dev);
277 dcr->dev_locked = false;
278 dcr->spooling = true; /* turn on spooling again */
283 * Read a block from the spool file
285 * Returns RB_OK on success
286 * RB_EOT when file done
289 static int read_block_from_spool_file(DCR *dcr)
294 DEV_BLOCK *block = dcr->block;
297 stat = read(dcr->spool_fd, (char *)&hdr, (size_t)rlen);
299 Dmsg0(100, "EOT on spool read.\n");
301 } else if (stat != (ssize_t)rlen) {
304 Jmsg(dcr->jcr, M_FATAL, 0, _("Spool header read error. ERR=%s\n"),
307 Pmsg2(000, "Spool read error. Wanted %u bytes, got %u\n", rlen, stat);
308 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool header read error. Wanted %u bytes, got %u\n"), rlen, stat);
313 if (rlen > block->buf_len) {
314 Pmsg2(000, "Spool block too big. Max %u bytes, got %u\n", block->buf_len, rlen);
315 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool block too big. Max %u bytes, got %u\n"), block->buf_len, rlen);
318 stat = read(dcr->spool_fd, (char *)block->buf, (size_t)rlen);
319 if (stat != (ssize_t)rlen) {
320 Pmsg2(000, "Spool data read error. Wanted %u bytes, got %u\n", rlen, stat);
321 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool data read error. Wanted %u bytes, got %u\n"), rlen, stat);
324 /* Setup write pointers */
325 block->binbuf = rlen;
326 block->bufp = block->buf + block->binbuf;
327 block->FirstIndex = hdr.FirstIndex;
328 block->LastIndex = hdr.LastIndex;
329 block->VolSessionId = dcr->jcr->VolSessionId;
330 block->VolSessionTime = dcr->jcr->VolSessionTime;
331 Dmsg2(800, "Read block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
336 * Write a block to the spool file
338 * Returns: true on success or EOT
339 * false on hard error
341 bool write_block_to_spool_file(DCR *dcr)
343 uint32_t wlen, hlen; /* length to write */
344 bool despool = false;
345 DEV_BLOCK *block = dcr->block;
347 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
348 if (block->binbuf <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
352 hlen = sizeof(spool_hdr);
353 wlen = block->binbuf;
354 P(dcr->dev->spool_mutex);
355 dcr->spool_size += hlen + wlen;
356 dcr->dev->spool_size += hlen + wlen;
357 if ((dcr->max_spool_size > 0 && dcr->spool_size >= dcr->max_spool_size) ||
358 (dcr->dev->max_spool_size > 0 && dcr->dev->spool_size >= dcr->dev->max_spool_size)) {
361 V(dcr->dev->spool_mutex);
363 spool_stats.data_size += hlen + wlen;
364 if (spool_stats.data_size > spool_stats.max_data_size) {
365 spool_stats.max_data_size = spool_stats.data_size;
370 char ec1[30], ec2[30], ec3[30], ec4[30];
371 Dmsg4(100, "Despool in write_block_to_spool_file max_size=%s size=%s "
372 "max_job_size=%s job_size=%s\n",
373 edit_uint64_with_commas(dcr->max_spool_size, ec1),
374 edit_uint64_with_commas(dcr->spool_size, ec2),
375 edit_uint64_with_commas(dcr->dev->max_spool_size, ec3),
376 edit_uint64_with_commas(dcr->dev->spool_size, ec4));
378 Jmsg(dcr->jcr, M_INFO, 0, _("User specified spool size reached.\n"));
379 if (!despool_data(dcr, false)) {
380 Pmsg0(000, "Bad return from despool in write_block.\n");
383 /* Despooling cleared these variables so reset them */
384 P(dcr->dev->spool_mutex);
385 dcr->spool_size += hlen + wlen;
386 dcr->dev->spool_size += hlen + wlen;
387 V(dcr->dev->spool_mutex);
388 Jmsg(dcr->jcr, M_INFO, 0, _("Spooling data again ...\n"));
392 if (!write_spool_header(dcr)) {
395 if (!write_spool_data(dcr)) {
399 Dmsg2(800, "Wrote block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
404 static bool write_spool_header(DCR *dcr)
408 DEV_BLOCK *block = dcr->block;
410 hdr.FirstIndex = block->FirstIndex;
411 hdr.LastIndex = block->LastIndex;
412 hdr.len = block->binbuf;
415 for (int retry=0; retry<=1; retry++) {
416 stat = write(dcr->spool_fd, (char*)&hdr, sizeof(hdr));
419 Jmsg(dcr->jcr, M_FATAL, 0, _("Error writing header to spool file. ERR=%s\n"),
422 if (stat != (ssize_t)sizeof(hdr)) {
423 /* If we wrote something, truncate it, then despool */
425 if (ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR) - stat) != 0) {
427 Jmsg(dcr->jcr, M_FATAL, 0, _("Ftruncate spool file failed: ERR=%s\n"),
432 if (!despool_data(dcr, false)) {
433 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
436 continue; /* try again */
440 Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after header spooling error failed.\n"));
444 static bool write_spool_data(DCR *dcr)
447 DEV_BLOCK *block = dcr->block;
450 for (int retry=0; retry<=1; retry++) {
451 stat = write(dcr->spool_fd, block->buf, (size_t)block->binbuf);
454 Jmsg(dcr->jcr, M_FATAL, 0, _("Error writing data to spool file. ERR=%s\n"),
457 if (stat != (ssize_t)block->binbuf) {
459 * If we wrote something, truncate it and the header, then despool
462 if (ftruncate(dcr->spool_fd, lseek(dcr->spool_fd, (off_t)0, SEEK_CUR)
463 - stat - sizeof(spool_hdr)) != 0) {
465 Jmsg(dcr->jcr, M_FATAL, 0, _("Ftruncate spool file failed: ERR=%s\n"),
470 if (!despool_data(dcr, false)) {
471 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
474 if (!write_spool_header(dcr)) {
477 continue; /* try again */
481 Jmsg(dcr->jcr, M_FATAL, 0, _("Retrying after data spooling error failed.\n"));
487 bool are_attributes_spooled(JCR *jcr)
489 return jcr->spool_attributes && jcr->dir_bsock->spool_fd;
493 * Create spool file for attributes.
494 * This is done by "attaching" to the bsock, and when
495 * it is called, the output is written to a file.
496 * The actual spooling is turned on and off in
497 * append.c only during writing of the attributes.
499 bool begin_attribute_spool(JCR *jcr)
501 if (!jcr->no_attributes && jcr->spool_attributes) {
502 return open_attr_spool_file(jcr, jcr->dir_bsock);
507 bool discard_attribute_spool(JCR *jcr)
509 if (are_attributes_spooled(jcr)) {
510 return close_attr_spool_file(jcr, jcr->dir_bsock);
515 static void update_attr_spool_size(ssize_t size)
519 if ((spool_stats.attr_size - size) > 0) {
520 spool_stats.attr_size -= size;
522 spool_stats.attr_size = 0;
528 bool commit_attribute_spool(JCR *jcr)
533 if (are_attributes_spooled(jcr)) {
534 if (fseek(jcr->dir_bsock->spool_fd, 0, SEEK_END) != 0) {
536 Jmsg(jcr, M_FATAL, 0, _("Fseek on attributes file failed: ERR=%s\n"),
539 size = ftell(jcr->dir_bsock->spool_fd);
542 if (spool_stats.attr_size + size > spool_stats.max_attr_size) {
543 spool_stats.max_attr_size = spool_stats.attr_size + size;
546 spool_stats.attr_size += size;
548 Jmsg(jcr, M_INFO, 0, _("Sending spooled attrs to the Director. Despooling %s bytes ...\n"),
549 edit_uint64_with_commas(size, ec1));
550 bnet_despool_to_bsock(jcr->dir_bsock, update_attr_spool_size, size);
551 return close_attr_spool_file(jcr, jcr->dir_bsock);
556 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
558 Mmsg(name, "%s/%s.attr.spool.%s.%d", working_directory, my_name,
563 bool open_attr_spool_file(JCR *jcr, BSOCK *bs)
565 POOLMEM *name = get_pool_memory(PM_MESSAGE);
567 make_unique_spool_filename(jcr, &name, bs->fd);
568 bs->spool_fd = fopen(name, "w+");
571 Jmsg(jcr, M_FATAL, 0, _("fopen attr spool file %s failed: ERR=%s\n"), name,
573 free_pool_memory(name);
577 spool_stats.attr_jobs++;
579 free_pool_memory(name);
583 bool close_attr_spool_file(JCR *jcr, BSOCK *bs)
590 name = get_pool_memory(PM_MESSAGE);
592 spool_stats.attr_jobs--;
593 spool_stats.total_attr_jobs++;
595 make_unique_spool_filename(jcr, &name, bs->fd);
596 fclose(bs->spool_fd);
598 free_pool_memory(name);