2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2008 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 John Walker.
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
48 * MEDIA_DBR mr with PoolId set
49 * create -- whether or not to create a new volume
51 int find_next_volume_for_append(JCR *jcr, MEDIA_DBR *mr, int index,
52 bool create, bool prune)
57 STORE *store = jcr->wstore;
59 bstrncpy(mr->MediaType, store->media_type, sizeof(mr->MediaType));
60 Dmsg3(050, "find_next_vol_for_append: JobId=%u PoolId=%d, MediaType=%s\n",
61 (uint32_t)jcr->JobId, (int)mr->PoolId, mr->MediaType);
63 * If we are using an Autochanger, restrict Volume
64 * search to the Autochanger on the first pass
66 InChanger = store->autochanger;
68 * Find the Next Volume for Append
72 bstrncpy(mr->VolStatus, "Append", sizeof(mr->VolStatus)); /* want only appendable volumes */
74 * 1. Look for volume with "Append" status.
76 ok = db_find_next_volume(jcr, jcr->db, index, InChanger, mr);
79 Dmsg4(050, "after find_next_vol ok=%d index=%d InChanger=%d Vstat=%s\n",
80 ok, index, InChanger, mr->VolStatus);
82 * 2. Try finding a recycled volume
84 ok = find_recycled_volume(jcr, InChanger, mr);
85 Dmsg2(050, "find_recycled_volume ok=%d FW=%d\n", ok, mr->FirstWritten);
88 * 3. Try recycling any purged volume
90 ok = recycle_oldest_purged_volume(jcr, InChanger, mr);
93 * 4. Try pruning Volumes
96 Dmsg0(150, "Call prune_volumes\n");
97 prune_volumes(jcr, InChanger, mr);
99 ok = recycle_oldest_purged_volume(jcr, InChanger, mr);
101 Dmsg4(050, "after prune volumes_vol ok=%d index=%d InChanger=%d Vstat=%s\n",
102 ok, index, InChanger, mr->VolStatus);
104 * 5. Try pulling a volume from the Scratch pool
106 ok = get_scratch_volume(jcr, InChanger, mr);
109 * If we are using an Autochanger and have not found
110 * a volume, retry looking for any volume.
115 continue; /* retry again accepting any volume */
124 * 6. Try "creating" a new Volume
126 ok = newVolume(jcr, mr);
129 * Look at more drastic ways to find an Appendable Volume
131 if (!ok && (jcr->pool->purge_oldest_volume ||
132 jcr->pool->recycle_oldest_volume)) {
133 Dmsg2(050, "No next volume found. PurgeOldest=%d\n RecyleOldest=%d",
134 jcr->pool->purge_oldest_volume, jcr->pool->recycle_oldest_volume);
135 /* Find oldest volume to recycle */
136 ok = db_find_next_volume(jcr, jcr->db, -1, InChanger, mr);
137 Dmsg1(050, "Find oldest=%d\n", ok);
140 Dmsg0(050, "Try purge.\n");
142 * 7. Try to purging oldest volume only if not UA calling us.
144 ua = new_ua_context(jcr);
145 if (jcr->pool->purge_oldest_volume && create) {
146 Jmsg(jcr, M_INFO, 0, _("Purging oldest volume \"%s\"\n"), mr->VolumeName);
147 ok = purge_jobs_from_volume(ua, mr);
149 * 8. or try recycling the oldest volume
151 } else if (jcr->pool->recycle_oldest_volume) {
152 Jmsg(jcr, M_INFO, 0, _("Pruning oldest volume \"%s\"\n"), mr->VolumeName);
153 ok = prune_volume(ua, mr);
157 ok = recycle_volume(jcr, mr);
158 Dmsg1(050, "Recycle after purge oldest=%d\n", ok);
163 Dmsg2(050, "VolJobs=%d FirstWritten=%d\n", mr->VolJobs, mr->FirstWritten);
165 /* If we can use the volume, check if it is expired */
166 if (has_volume_expired(jcr, mr)) {
167 if (retry++ < 200) { /* sanity check */
168 continue; /* try again from the top */
170 Jmsg(jcr, M_ERROR, 0, _(
171 "We seem to be looping trying to find the next volume. I give up.\n"));
178 Dmsg1(050, "return ok=%d find_next_vol\n", ok);
183 * Check if any time limits or use limits have expired
184 * if so, set the VolStatus appropriately.
186 bool has_volume_expired(JCR *jcr, MEDIA_DBR *mr)
188 bool expired = false;
190 * Check limits and expirations if "Append" and it has been used
191 * i.e. mr->VolJobs > 0
194 if (strcmp(mr->VolStatus, "Append") == 0 && mr->VolJobs > 0) {
195 /* First handle Max Volume Bytes */
196 if ((mr->MaxVolBytes > 0 && mr->VolBytes >= mr->MaxVolBytes)) {
197 Jmsg(jcr, M_INFO, 0, _("Max Volume bytes exceeded. "
198 "Marking Volume \"%s\" as Full.\n"), mr->VolumeName);
199 bstrncpy(mr->VolStatus, "Full", sizeof(mr->VolStatus));
202 /* Now see if Volume should only be used once */
203 } else if (mr->VolBytes > 0 && jcr->pool->use_volume_once) {
204 Jmsg(jcr, M_INFO, 0, _("Volume used once. "
205 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
206 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
209 /* Now see if Max Jobs written to volume */
210 } else if (mr->MaxVolJobs > 0 && mr->MaxVolJobs <= mr->VolJobs) {
211 Jmsg(jcr, M_INFO, 0, _("Max Volume jobs exceeded. "
212 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
213 Dmsg3(100, "MaxVolJobs=%d JobId=%d Vol=%s\n", mr->MaxVolJobs,
214 (uint32_t)jcr->JobId, mr->VolumeName);
215 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
218 /* Now see if Max Files written to volume */
219 } else if (mr->MaxVolFiles > 0 && mr->MaxVolFiles <= mr->VolFiles) {
220 Jmsg(jcr, M_INFO, 0, _("Max Volume files exceeded. "
221 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
222 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
225 /* Finally, check Use duration expiration */
226 } else if (mr->VolUseDuration > 0) {
227 utime_t now = time(NULL);
228 /* See if Vol Use has expired */
229 if (mr->VolUseDuration <= (now - mr->FirstWritten)) {
230 Jmsg(jcr, M_INFO, 0, _("Max configured use duration exceeded. "
231 "Marking Volume \"%s\" as Used.\n"), mr->VolumeName);
232 bstrncpy(mr->VolStatus, "Used", sizeof(mr->VolStatus));
238 /* Need to update media */
239 if (!db_update_media_record(jcr, jcr->db, mr)) {
240 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating volume \"%s\". ERR=%s"),
241 mr->VolumeName, db_strerror(jcr->db));
248 * Try hard to recycle the current volume
250 * Returns: on failure - reason = NULL
251 * on success - reason - pointer to reason
253 void check_if_volume_valid_or_recyclable(JCR *jcr, MEDIA_DBR *mr, const char **reason)
259 /* Check if a duration or limit has expired */
260 if (has_volume_expired(jcr, mr)) {
261 *reason = _("volume has expired");
262 /* Keep going because we may be able to recycle volume */
266 * Now see if we can use the volume as is
268 if (strcmp(mr->VolStatus, "Append") == 0 ||
269 strcmp(mr->VolStatus, "Recycle") == 0) {
275 * Check if the Volume is already marked for recycling
277 if (strcmp(mr->VolStatus, "Purged") == 0) {
278 if (recycle_volume(jcr, mr)) {
279 Jmsg(jcr, M_INFO, 0, _("Recycled current volume \"%s\"\n"), mr->VolumeName);
283 /* In principle this shouldn't happen */
284 *reason = _("and recycling of current volume failed");
289 /* At this point, the volume is not valid for writing */
290 *reason = _("but should be Append, Purged or Recycle");
293 * What we're trying to do here is see if the current volume is
294 * "recyclable" - ie. if we prune all expired jobs off it, is
295 * it now possible to reuse it for the job that it is currently
298 if ((mr->LastWritten + mr->VolRetention) < (utime_t)time(NULL)
299 && mr->Recycle && jcr->pool->recycle_current_volume
300 && (strcmp(mr->VolStatus, "Full") == 0 ||
301 strcmp(mr->VolStatus, "Used") == 0)) {
303 * Attempt prune of current volume to see if we can
304 * recycle it for use.
308 ua = new_ua_context(jcr);
309 ok = prune_volume(ua, mr);
313 /* If fully purged, recycle current volume */
314 if (recycle_volume(jcr, mr)) {
315 Jmsg(jcr, M_INFO, 0, _("Recycled current volume \"%s\"\n"), mr->VolumeName);
318 *reason = _("but should be Append, Purged or Recycle (recycling of the "
319 "current volume failed)");
322 *reason = _("but should be Append, Purged or Recycle (cannot automatically "
323 "recycle current volume, as it still contains unpruned data "
324 "or the Volume Retention time has not expired.)");
329 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
331 bool get_scratch_volume(JCR *jcr, bool InChanger, MEDIA_DBR *mr)
333 MEDIA_DBR smr; /* for searching scratch pool */
338 /* Only one thread at a time can pull from the scratch pool */
341 * Get Pool record for Scratch Pool
343 memset(&spr, 0, sizeof(spr));
344 bstrncpy(spr.Name, "Scratch", sizeof(spr.Name));
345 if (db_get_pool_record(jcr, jcr->db, &spr)) {
346 memset(&smr, 0, sizeof(smr));
347 smr.PoolId = spr.PoolId;
349 smr.StorageId = mr->StorageId; /* want only Scratch Volumes in changer */
351 bstrncpy(smr.VolStatus, "Append", sizeof(smr.VolStatus)); /* want only appendable volumes */
352 bstrncpy(smr.MediaType, mr->MediaType, sizeof(smr.MediaType));
355 * If we do not find a valid Scratch volume, try
356 * recycling any existing purged volumes, then
357 * try to take the oldest volume.
359 if (db_find_next_volume(jcr, jcr->db, 1, InChanger, &smr)) {
362 } else if (find_recycled_volume(jcr, InChanger, &smr)) {
365 } else if (recycle_oldest_purged_volume(jcr, InChanger, &smr)) {
370 POOL_MEM query(PM_MESSAGE);
373 * Get pool record where the Scratch Volume will go to ensure
374 * that we can add a Volume.
376 memset(&pr, 0, sizeof(pr));
377 bstrncpy(pr.Name, jcr->pool->name(), sizeof(pr.Name));
379 if (!db_get_pool_record(jcr, jcr->db, &pr)) {
380 Jmsg(jcr, M_WARNING, 0, _("Unable to get Pool record: ERR=%s"),
381 db_strerror(jcr->db));
385 /* Make sure there is room for another volume */
386 if (pr.MaxVols > 0 && pr.NumVols >= pr.MaxVols) {
387 Jmsg(jcr, M_WARNING, 0, _("Unable add Scratch Volume, Pool \"%s\" full MaxVols=%d\n"),
388 jcr->pool->name(), pr.MaxVols);
392 memcpy(mr, &smr, sizeof(MEDIA_DBR));
394 /* Set default parameters from current pool */
395 set_pool_dbr_defaults_in_media_dbr(mr, &pr);
398 * set_pool_dbr_defaults_in_media_dbr set VolStatus to Append,
399 * we could have Recycled media, also, we retain the old
402 bstrncpy(mr->VolStatus, smr.VolStatus, sizeof(smr.VolStatus));
403 mr->RecyclePoolId = smr.RecyclePoolId;
405 if (!db_update_media_record(jcr, jcr->db, mr)) {
406 Jmsg(jcr, M_WARNING, 0, _("Failed to move Scratch Volume. ERR=%s\n"),
407 db_strerror(jcr->db));
411 Jmsg(jcr, M_INFO, 0, _("Using Volume \"%s\" from 'Scratch' pool.\n"),