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);
36 static int read_block_from_spool_file(DCR *dcr, DEV_BLOCK *block);
38 struct spool_stats_t {
39 uint32_t data_jobs; /* current jobs spooling data */
41 uint32_t total_data_jobs; /* total jobs to have spooled data */
42 uint32_t total_attr_jobs;
43 uint64_t max_data_size; /* max data size */
44 uint64_t max_attr_size;
45 uint64_t data_size; /* current data size (all jobs running) */
49 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
50 spool_stats_t spool_stats;
53 * Header for data spool record */
55 int32_t FirstIndex; /* FirstIndex for buffer */
56 int32_t LastIndex; /* LastIndex for buffer */
57 uint32_t len; /* length of next buffer */
66 void list_spool_stats(BSOCK *bs)
68 char ed1[30], ed2[30];
69 if (spool_stats.data_jobs || spool_stats.max_data_size) {
70 bnet_fsend(bs, "Data spooling: %d active jobs, %s bytes; %d total jobs, %s max bytes/job.\n",
71 spool_stats.data_jobs, edit_uint64_with_commas(spool_stats.data_size, ed1),
72 spool_stats.total_data_jobs,
73 edit_uint64_with_commas(spool_stats.max_data_size, ed2));
75 if (spool_stats.attr_jobs || spool_stats.max_attr_size) {
76 bnet_fsend(bs, "Attr spooling: %d active jobs; %d total jobs, %s max bytes/job.\n",
77 spool_stats.attr_jobs, spool_stats.total_attr_jobs,
78 edit_uint64_with_commas(spool_stats.max_attr_size, ed1));
82 bool begin_data_spool(JCR *jcr)
85 if (jcr->spool_data) {
86 Dmsg0(100, "Turning on data spooling\n");
87 jcr->dcr->spool_data = true;
88 stat = open_data_spool_file(jcr);
90 jcr->dcr->spooling = true;
91 Jmsg(jcr, M_INFO, 0, _("Spooling data ...\n"));
93 spool_stats.data_jobs++;
100 bool discard_data_spool(JCR *jcr)
102 if (jcr->dcr->spooling) {
103 Dmsg0(100, "Data spooling discarded\n");
104 return close_data_spool_file(jcr);
109 bool commit_data_spool(JCR *jcr)
114 if (jcr->dcr->spooling) {
115 Dmsg0(100, "Committing spooled data\n");
116 Jmsg(jcr, M_INFO, 0, _("Writing spooled data to Volume. Despooling %s bytes ...\n"),
117 edit_uint64_with_commas(jcr->dcr->dev->spool_size, ec1));
118 stat = despool_data(jcr->dcr);
120 Dmsg1(000, "Bad return from despool WroteVol=%d\n", jcr->dcr->WroteVol);
121 close_data_spool_file(jcr);
124 return close_data_spool_file(jcr);
129 static void make_unique_data_spool_filename(JCR *jcr, POOLMEM **name)
132 if (jcr->dcr->dev->device->spool_directory) {
133 dir = jcr->dcr->dev->device->spool_directory;
135 dir = working_directory;
137 Mmsg(name, "%s/%s.data.spool.%s.%s", dir, my_name, jcr->Job, jcr->device->hdr.name);
141 static bool open_data_spool_file(JCR *jcr)
143 POOLMEM *name = get_pool_memory(PM_MESSAGE);
146 make_unique_data_spool_filename(jcr, &name);
147 if ((spool_fd = open(name, O_CREAT|O_TRUNC|O_RDWR|O_BINARY, 0640)) >= 0) {
148 jcr->dcr->spool_fd = spool_fd;
149 jcr->spool_attributes = true;
151 Jmsg(jcr, M_ERROR, 0, _("Open data spool file %s failed: ERR=%s\n"), name, strerror(errno));
152 free_pool_memory(name);
155 Dmsg1(100, "Created spool file: %s\n", name);
156 free_pool_memory(name);
160 static bool close_data_spool_file(JCR *jcr)
162 POOLMEM *name = get_pool_memory(PM_MESSAGE);
165 spool_stats.data_jobs--;
166 spool_stats.total_data_jobs++;
167 if (spool_stats.data_size < jcr->dcr->spool_size) {
168 spool_stats.data_size = 0;
170 spool_stats.data_size -= jcr->dcr->spool_size;
172 jcr->dcr->spool_size = 0;
175 make_unique_data_spool_filename(jcr, &name);
176 close(jcr->dcr->spool_fd);
177 jcr->dcr->spool_fd = -1;
178 jcr->dcr->spooling = false;
180 Dmsg1(100, "Deleted spool file: %s\n", name);
181 free_pool_memory(name);
185 static bool despool_data(DCR *dcr)
194 Dmsg0(100, "Despooling data\n");
195 dcr->spooling = false;
196 lock_device(dcr->dev);
197 dcr->dev_locked = true;
199 /* Setup a dev structure to read */
200 rdev = (DEVICE *)malloc(sizeof(DEVICE));
201 memset(rdev, 0, sizeof(DEVICE));
202 rdev->dev_name = get_memory(strlen("spool")+1);
203 strcpy(rdev->dev_name, "spool");
204 rdev->errmsg = get_pool_memory(PM_EMSG);
206 rdev->max_block_size = dcr->dev->max_block_size;
207 rdev->min_block_size = dcr->dev->min_block_size;
208 rdev->device = dcr->dev->device;
209 rdcr = new_dcr(NULL, rdev);
210 rdcr->spool_fd = dcr->spool_fd;
211 rdcr->jcr = jcr; /* set a valid jcr */
213 Dmsg1(800, "read/write block size = %d\n", block->buf_len);
214 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
217 if (job_canceled(jcr)) {
221 stat = read_block_from_spool_file(rdcr, block);
222 if (stat == RB_EOT) {
224 } else if (stat == RB_ERROR) {
228 ok = write_block_to_device(dcr, block);
229 Dmsg3(100, "Write block ok=%d FI=%d LI=%d\n", ok, block->FirstIndex, block->LastIndex);
232 lseek(rdcr->spool_fd, 0, SEEK_SET); /* rewind */
233 if (ftruncate(rdcr->spool_fd, 0) != 0) {
234 Jmsg(dcr->jcr, M_FATAL, 0, _("Ftruncate spool file error. ERR=%s\n"),
236 Dmsg1(000, "Bad return from ftruncate. ERR=%s\n", strerror(errno));
241 if (spool_stats.data_size < dcr->spool_size) {
242 spool_stats.data_size = 0;
244 spool_stats.data_size -= dcr->spool_size;
247 P(dcr->dev->spool_mutex);
248 dcr->dev->spool_size -= dcr->spool_size;
249 dcr->spool_size = 0; /* zap size in input dcr */
250 V(dcr->dev->spool_mutex);
251 free_memory(rdev->dev_name);
252 free_pool_memory(rdev->errmsg);
256 unlock_device(dcr->dev);
257 dcr->dev_locked = false;
258 dcr->spooling = true; /* turn on spooling again */
263 * Read a block from the spool file
265 * Returns RB_OK on success
266 * RB_EOT when file done
269 static int read_block_from_spool_file(DCR *dcr, DEV_BLOCK *block)
276 stat = read(dcr->spool_fd, (char *)&hdr, (size_t)rlen);
278 Dmsg0(100, "EOT on spool read.\n");
280 } else if (stat != (ssize_t)rlen) {
282 Jmsg(dcr->jcr, M_FATAL, 0, _("Spool header read error. ERR=%s\n"), strerror(errno));
284 Dmsg2(000, "Spool read error. Wanted %u bytes, got %u\n", rlen, stat);
285 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool header read error. Wanted %u bytes, got %u\n"), rlen, stat);
290 if (rlen > block->buf_len) {
291 Dmsg2(000, "Spool block too big. Max %u bytes, got %u\n", block->buf_len, rlen);
292 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool block too big. Max %u bytes, got %u\n"), block->buf_len, rlen);
295 stat = read(dcr->spool_fd, (char *)block->buf, (size_t)rlen);
296 if (stat != (ssize_t)rlen) {
297 Dmsg2(000, "Spool data read error. Wanted %u bytes, got %u\n", rlen, stat);
298 Jmsg2(dcr->jcr, M_FATAL, 0, _("Spool data read error. Wanted %u bytes, got %u\n"), rlen, stat);
301 /* Setup write pointers */
302 block->binbuf = rlen;
303 block->bufp = block->buf + block->binbuf;
304 block->FirstIndex = hdr.FirstIndex;
305 block->LastIndex = hdr.LastIndex;
306 block->VolSessionId = dcr->jcr->VolSessionId;
307 block->VolSessionTime = dcr->jcr->VolSessionTime;
308 Dmsg2(100, "Read block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
313 * Write a block to the spool file
315 * Returns: true on success or EOT
316 * false on hard error
318 bool write_block_to_spool_file(DCR *dcr, DEV_BLOCK *block)
321 uint32_t wlen, hlen; /* length to write */
324 bool despool = false;
326 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
327 if (block->binbuf <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
332 wlen = block->binbuf;
333 P(dcr->dev->spool_mutex);
334 dcr->spool_size += hlen + wlen;
335 dcr->dev->spool_size += hlen + wlen;
336 if ((dcr->max_spool_size > 0 && dcr->spool_size >= dcr->max_spool_size) ||
337 (dcr->dev->max_spool_size > 0 && dcr->dev->spool_size >= dcr->dev->max_spool_size)) {
340 V(dcr->dev->spool_mutex);
342 spool_stats.data_size += hlen + wlen;
343 if (spool_stats.data_size > spool_stats.max_data_size) {
344 spool_stats.max_data_size = spool_stats.data_size;
350 char ec2[30], ec3[30], ec4[30];
351 Dmsg4(100, "Despool in write_block_to_spool_file max_size=%s size=%s "
352 "max_job_size=%s job_size=%s\n",
353 edit_uint64_with_commas(dcr->max_spool_size, ec1),
354 edit_uint64_with_commas(dcr->spool_size, ec2),
355 edit_uint64_with_commas(dcr->dev->max_spool_size, ec3),
356 edit_uint64_with_commas(dcr->dev->spool_size, ec4));
358 Jmsg(dcr->jcr, M_INFO, 0, _("User specified spool size reached. Despooling %s bytes ...\n"),
359 edit_uint64_with_commas(dcr->dev->spool_size, ec1));
360 if (!despool_data(dcr)) {
361 Dmsg0(000, "Bad return from despool in write_block.\n");
364 /* Despooling cleared these variables so reset them */
365 P(dcr->dev->spool_mutex);
366 dcr->spool_size += hlen + wlen;
367 dcr->dev->spool_size += hlen + wlen;
368 V(dcr->dev->spool_mutex);
369 Jmsg(dcr->jcr, M_INFO, 0, _("Spooling data again ...\n"));
372 hdr.FirstIndex = block->FirstIndex;
373 hdr.LastIndex = block->LastIndex;
374 hdr.len = block->binbuf;
378 stat = write(dcr->spool_fd, (char*)&hdr, (size_t)hlen);
380 Jmsg(dcr->jcr, M_INFO, 0, _("Error writing header to spool file. ERR=%s\n"), strerror(errno));
382 if (stat != (ssize_t)hlen) {
383 if (!despool_data(dcr)) {
384 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
397 stat = write(dcr->spool_fd, block->buf, (size_t)wlen);
399 Jmsg(dcr->jcr, M_INFO, 0, _("Error writing data to spool file. ERR=%s\n"), strerror(errno));
401 if (stat != (ssize_t)wlen) {
402 if (!despool_data(dcr)) {
403 Jmsg(dcr->jcr, M_FATAL, 0, _("Fatal despooling error."));
413 Dmsg2(100, "Wrote block FI=%d LI=%d\n", block->FirstIndex, block->LastIndex);
420 bool are_attributes_spooled(JCR *jcr)
422 return jcr->spool_attributes && jcr->dir_bsock->spool_fd;
426 * Create spool file for attributes.
427 * This is done by "attaching" to the bsock, and when
428 * it is called, the output is written to a file.
429 * The actual spooling is turned on and off in
430 * append.c only during writing of the attributes.
432 bool begin_attribute_spool(JCR *jcr)
434 if (!jcr->no_attributes && jcr->spool_attributes) {
435 return open_spool_file(jcr, jcr->dir_bsock);
440 bool discard_attribute_spool(JCR *jcr)
442 if (are_attributes_spooled(jcr)) {
443 return close_spool_file(jcr, jcr->dir_bsock);
448 bool commit_attribute_spool(JCR *jcr)
450 if (are_attributes_spooled(jcr)) {
451 bnet_despool_to_bsock(jcr->dir_bsock);
452 return close_spool_file(jcr, jcr->dir_bsock);
457 static void make_unique_spool_filename(JCR *jcr, POOLMEM **name, int fd)
459 Mmsg(name, "%s/%s.attr.spool.%s.%d", working_directory, my_name,
463 bool open_spool_file(JCR *jcr, BSOCK *bs)
465 POOLMEM *name = get_pool_memory(PM_MESSAGE);
467 make_unique_spool_filename(jcr, &name, bs->fd);
468 bs->spool_fd = fopen(mp_chr(name), "w+");
470 Jmsg(jcr, M_ERROR, 0, _("fopen attr spool file %s failed: ERR=%s\n"), name, strerror(errno));
471 free_pool_memory(name);
475 spool_stats.attr_jobs++;
477 free_pool_memory(name);
481 bool close_spool_file(JCR *jcr, BSOCK *bs)
483 POOLMEM *name = get_pool_memory(PM_MESSAGE);
486 fseek(bs->spool_fd, 0, SEEK_END);
487 size = ftell(bs->spool_fd);
490 if (spool_stats.attr_size + size > spool_stats.max_attr_size) {
491 spool_stats.max_attr_size = spool_stats.attr_size + size;
494 spool_stats.attr_jobs--;
495 spool_stats.total_attr_jobs++;
497 make_unique_spool_filename(jcr, &name, bs->fd);
498 fclose(bs->spool_fd);
499 unlink(mp_chr(name));
500 free_pool_memory(name);