2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2009 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Bacula Director -- next_vol -- handles finding the next
31 * volume for append. Split out of catreq.c August MMIII
32 * catalog request from the Storage daemon.
34 * Kern Sibbald, March MMI
44 * mr.PoolId must be set
45 * mr.StorageId should also be set
46 * mr.ScratchPoolId could be set (used if create==true)
50 * MEDIA_DBR mr with PoolId set
51 * create -- whether or not to create a new volume
53 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index,
54 bool create, bool prune)
59 STORE *store = jcr->wstore;
61 bstrncpy(mr->MediaType, store->media_type, sizeof(mr->MediaType));
62 Dmsg3(100, "find_next_vol_for_append: JobId=%u PoolId=%d, MediaType=%s\n",
63 (uint32_t)jcr->JobId, (int)mr->PoolId, mr->MediaType);
65 * If we are using an Autochanger, restrict Volume
66 * search to the Autochanger on the first pass
68 InChanger = store->autochanger;
70 * Find the Next Volume for Append
74 bstrncpy(mr->VolStatus, "Append", sizeof(mr->VolStatus)); /* want only appendable volumes */
76 * 1. Look for volume with "Append" status.
78 ok = db_find_next_volume(jcr, jcr->db, index, InChanger, mr);
81 Dmsg4(150, "after find_next_vol ok=%d index=%d InChanger=%d Vstat=%s\n",
82 ok, index, InChanger, mr->VolStatus);
84 * 2. Try finding a recycled volume
86 ok = find_recycled_volume(jcr, InChanger, mr);
87 Dmsg2(150, "find_recycled_volume ok=%d FW=%d\n", ok, mr->FirstWritten);
90 * 3. Try recycling any purged volume
92 ok = recycle_oldest_purged_volume(jcr, InChanger, mr);
95 * 4. Try pruning Volumes
98 Dmsg0(150, "Call prune_volumes\n");
99 prune_volumes(jcr, InChanger, mr);
101 ok = recycle_oldest_purged_volume(jcr, InChanger, mr);
103 Dmsg4(150, "after prune volumes_vol ok=%d index=%d InChanger=%d Vstat=%s\n",
104 ok, index, InChanger, mr->VolStatus);
106 * 5. Try pulling a volume from the Scratch pool
108 ok = get_scratch_volume(jcr, InChanger, mr);
109 Dmsg4(150, "after get scratch volume ok=%d index=%d InChanger=%d Vstat=%s\n",
110 ok, index, InChanger, mr->VolStatus);
113 * If we are using an Autochanger and have not found
114 * a volume, retry looking for any volume.
116 if (!ok && InChanger) {
118 continue; /* retry again accepting any volume */
126 * 6. Try "creating" a new Volume
128 ok = newVolume(jcr, mr);
131 * Look at more drastic ways to find an Appendable Volume
133 if (!ok && (jcr->pool->purge_oldest_volume ||
134 jcr->pool->recycle_oldest_volume)) {
135 Dmsg2(200, "No next volume found. PurgeOldest=%d\n RecyleOldest=%d",
136 jcr->pool->purge_oldest_volume, jcr->pool->recycle_oldest_volume);
137 /* Find oldest volume to recycle */
138 ok = db_find_next_volume(jcr, jcr->db, -1, InChanger, mr);
139 Dmsg1(200, "Find oldest=%d Volume\n", ok);
142 Dmsg0(200, "Try purge Volume.\n");
144 * 7. Try to purging oldest volume only if not UA calling us.
146 ua = new_ua_context(jcr);
147 if (jcr->pool->purge_oldest_volume && create) {
148 Jmsg(jcr, M_INFO, 0, _("Purging oldest volume \"%s\"\n"), mr->VolumeName);
149 ok = purge_jobs_from_volume(ua, mr);
151 * 8. or try recycling the oldest volume
153 } else if (jcr->pool->recycle_oldest_volume) {
154 Jmsg(jcr, M_INFO, 0, _("Pruning oldest volume \"%s\"\n"), mr->VolumeName);
155 ok = prune_volume(ua, mr);
159 ok = recycle_volume(jcr, mr);
160 Dmsg1(400, "Recycle after purge oldest=%d\n", ok);
165 Dmsg2(100, "VolJobs=%d FirstWritten=%d\n", mr->VolJobs, mr->FirstWritten);
167 /* If we can use the volume, check if it is expired */
168 if (has_volume_expired(jcr, mr)) {
169 if (retry++ < 200) { /* sanity check */
170 continue; /* try again from the top */
172 Jmsg(jcr, M_ERROR, 0, _(
173 "We seem to be looping trying to find the next volume. I give up.\n"));
180 Dmsg1(150, "return ok=%d find_next_vol\n", ok);
185 * Check if any time limits or use limits have expired
186 * if so, set the VolStatus appropriately.
188 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr)
190 bool expired = false;
192 * Check limits and expirations if "Append" and it has been used
193 * i.e. mr->VolJobs > 0
196 if (strcmp(mr->VolStatus, "Append") == 0 && mr->VolJobs > 0) {
197 /* First handle Max Volume Bytes */
198 if ((mr->MaxVolBytes > 0 && mr->VolBytes >= mr->MaxVolBytes)) {
199 Jmsg(jcr, M_INFO, 0, _("Max Volume bytes exceeded. "
200 "Marking Volume \"%s\" as Full.\n"), mr->VolumeName);
201 bstrncpy(mr->VolStatus, "Full", sizeof(mr->VolStatus));
204 /* Now see if Volume should only be used once */
205 } else if (mr->VolBytes > 0 && jcr->pool->use_volume_once) {
206 Jmsg(jcr, M_INFO, 0, _("Volume used once. "
207 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
208 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
211 /* Now see if Max Jobs written to volume */
212 } else if (mr->MaxVolJobs > 0 && mr->MaxVolJobs <= mr->VolJobs) {
213 Jmsg(jcr, M_INFO, 0, _("Max Volume jobs exceeded. "
214 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
215 Dmsg3(100, "MaxVolJobs=%d JobId=%d Vol=%s\n", mr->MaxVolJobs,
216 (uint32_t)jcr->JobId, mr->VolumeName);
217 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
220 /* Now see if Max Files written to volume */
221 } else if (mr->MaxVolFiles > 0 && mr->MaxVolFiles <= mr->VolFiles) {
222 Jmsg(jcr, M_INFO, 0, _("Max Volume files exceeded. "
223 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
224 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
227 /* Finally, check Use duration expiration */
228 } else if (mr->VolUseDuration > 0) {
229 utime_t now = time(NULL);
230 /* See if Vol Use has expired */
231 if (mr->VolUseDuration <= (now - mr->FirstWritten)) {
232 Jmsg(jcr, M_INFO, 0, _("Max configured use duration exceeded. "
233 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
234 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
240 /* Need to update media */
241 Dmsg1(150, "Vol=%s has expired update media record\n", mr->VolumeName);
242 if (!db_update_media_record(jcr, jcr->db, mr)) {
243 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating volume \"%s\". ERR=%s"),
244 mr->VolumeName, db_strerror(jcr->db));
247 Dmsg2(150, "Vol=%s expired=%d\n", mr->VolumeName, expired);
252 * Try hard to recycle the current volume
254 * Returns: on failure - reason = NULL
255 * on success - reason - pointer to reason
257 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason)
263 /* Check if a duration or limit has expired */
264 if (has_volume_expired(jcr, mr)) {
265 *reason = _("volume has expired");
266 /* Keep going because we may be able to recycle volume */
270 * Now see if we can use the volume as is
272 if (strcmp(mr->VolStatus, "Append") == 0 ||
273 strcmp(mr->VolStatus, "Recycle") == 0) {
279 * Check if the Volume is already marked for recycling
281 if (strcmp(mr->VolStatus, "Purged") == 0) {
282 if (recycle_volume(jcr, mr)) {
283 Jmsg(jcr, M_INFO, 0, _("Recycled current volume \"%s\"\n"), mr->VolumeName);
287 /* In principle this shouldn't happen */
288 *reason = _("and recycling of current volume failed");
293 /* At this point, the volume is not valid for writing */
294 *reason = _("but should be Append, Purged or Recycle");
297 * What we're trying to do here is see if the current volume is
298 * "recyclable" - ie. if we prune all expired jobs off it, is
299 * it now possible to reuse it for the job that it is currently
303 *reason = _("volume has recycling disabled");
306 if ((mr->LastWritten + mr->VolRetention) < (utime_t)time(NULL)
307 && jcr->pool->recycle_current_volume
308 && (strcmp(mr->VolStatus, "Full") == 0 ||
309 strcmp(mr->VolStatus, "Used") == 0)) {
311 * Attempt prune of current volume to see if we can
312 * recycle it for use.
316 ua = new_ua_context(jcr);
317 ok = prune_volume(ua, mr);
321 /* If fully purged, recycle current volume */
322 if (recycle_volume(jcr, mr)) {
323 Jmsg(jcr, M_INFO, 0, _("Recycled current volume \"%s\"\n"), mr->VolumeName);
326 *reason = _("but should be Append, Purged or Recycle (recycling of the "
327 "current volume failed)");
330 *reason = _("but should be Append, Purged or Recycle (cannot automatically "
331 "recycle current volume, as it still contains unpruned data "
332 "or the Volume Retention time has not expired.)");
337 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
339 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr)
341 MEDIA_DBR smr; /* for searching scratch pool */
346 /* Only one thread at a time can pull from the scratch pool */
349 * Get Pool record for Scratch Pool
350 * choose between ScratchPoolId and Scratch
351 * db_get_pool_record will first try ScratchPoolId,
352 * and then try the pool named Scratch
354 memset(&spr, 0, sizeof(spr));
355 bstrncpy(spr.Name, "Scratch", sizeof(spr.Name));
356 spr.PoolId = mr->ScratchPoolId;
357 if (db_get_pool_record(jcr, jcr->db, &spr)) {
358 memset(&smr, 0, sizeof(smr));
359 smr.PoolId = spr.PoolId;
361 smr.StorageId = mr->StorageId; /* want only Scratch Volumes in changer */
363 bstrncpy(smr.VolStatus, "Append", sizeof(smr.VolStatus)); /* want only appendable volumes */
364 bstrncpy(smr.MediaType, mr->MediaType, sizeof(smr.MediaType));
367 * If we do not find a valid Scratch volume, try
368 * recycling any existing purged volumes, then
369 * try to take the oldest volume.
371 if (db_find_next_volume(jcr, jcr->db, 1, InChanger, &smr)) {
374 } else if (find_recycled_volume(jcr, InChanger, &smr)) {
377 } else if (recycle_oldest_purged_volume(jcr, InChanger, &smr)) {
382 POOL_MEM query(PM_MESSAGE);
385 * Get pool record where the Scratch Volume will go to ensure
386 * that we can add a Volume.
388 memset(&pr, 0, sizeof(pr));
389 bstrncpy(pr.Name, jcr->pool->name(), sizeof(pr.Name));
391 if (!db_get_pool_record(jcr, jcr->db, &pr)) {
392 Jmsg(jcr, M_WARNING, 0, _("Unable to get Pool record: ERR=%s"),
393 db_strerror(jcr->db));
397 /* Make sure there is room for another volume */
398 if (pr.MaxVols > 0 && pr.NumVols >= pr.MaxVols) {
399 Jmsg(jcr, M_WARNING, 0, _("Unable add Scratch Volume, Pool \"%s\" full MaxVols=%d\n"),
400 jcr->pool->name(), pr.MaxVols);
404 memcpy(mr, &smr, sizeof(MEDIA_DBR));
406 /* Set default parameters from current pool */
407 set_pool_dbr_defaults_in_media_dbr(mr, &pr);
410 * set_pool_dbr_defaults_in_media_dbr set VolStatus to Append,
411 * we could have Recycled media, also, we retain the old
414 bstrncpy(mr->VolStatus, smr.VolStatus, sizeof(smr.VolStatus));
415 mr->RecyclePoolId = smr.RecyclePoolId;
417 if (!db_update_media_record(jcr, jcr->db, mr)) {
418 Jmsg(jcr, M_WARNING, 0, _("Failed to move Scratch Volume. ERR=%s\n"),
419 db_strerror(jcr->db));
423 Jmsg(jcr, M_INFO, 0, _("Using Volume \"%s\" from 'Scratch' pool.\n"),