3 * Utility routines for "tool" programs such as bscan, bls,
4 * bextract, ... Some routines also used by Bacula.
6 * Normally nothing in this file is called by the Storage
7 * daemon because we interact more directly with the user
13 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU General Public License as
17 published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public
26 License along with this program; if not, write to the Free
27 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
35 /* Imported variables -- eliminate some day */
36 extern char *configfile;
39 char *rec_state_to_str(DEV_RECORD *rec)
43 if (rec->state & REC_NO_HEADER) {
44 strcat(buf, "Nohdr,");
46 if (is_partial_record(rec)) {
47 strcat(buf, "partial,");
49 if (rec->state & REC_BLOCK_EMPTY) {
50 strcat(buf, "empty,");
52 if (rec->state & REC_NO_MATCH) {
53 strcat(buf, "Nomatch,");
55 if (rec->state & REC_CONTINUATION) {
59 buf[strlen(buf)-1] = 0;
67 * Setup device, jcr, and prepare to access device.
68 * If the caller wants read access, acquire the device, otherwise,
69 * the caller will do it.
71 DEVICE *setup_to_access_device(JCR *jcr, int read_access)
78 * If no volume name already given and no bsr, and it is a file,
79 * try getting name from Filename
81 if (!jcr->bsr && jcr->VolumeName[0] == 0) {
82 if (strncmp(jcr->dev_name, "/dev/", 5) != 0) {
83 /* Try stripping file part */
84 p = jcr->dev_name + strlen(jcr->dev_name);
85 while (p >= jcr->dev_name && *p != '/')
88 pm_strcpy(&jcr->VolumeName, p+1);
94 if ((device=find_device_res(jcr->dev_name, read_access)) == NULL) {
95 Jmsg2(jcr, M_FATAL, 0, _("Cannot find device \"%s\" in config file %s.\n"),
96 jcr->dev_name, configfile);
100 pm_strcpy(&jcr->dev_name, device->device_name);
102 dev = init_dev(NULL, device);
104 Jmsg1(jcr, M_FATAL, 0, _("Cannot init device %s\n"), jcr->dev_name);
107 jcr->device->dev = dev;
109 if (!dev || !first_open_device(dev)) {
110 Jmsg1(jcr, M_FATAL, 0, _("Cannot open %s\n"), jcr->dev_name);
113 Dmsg0(90, "Device opened for read.\n");
115 create_vol_list(jcr);
118 if (!acquire_device_for_read(jcr)) {
127 * Search for device resource that corresponds to
128 * device name on command line (or default).
130 * Returns: NULL on failure
131 * Device resource pointer on success
133 DEVRES *find_device_res(char *device_name, int read_access)
139 foreach_res(device, R_DEVICE) {
140 if (strcmp(device->device_name, device_name) == 0) {
146 /* Search for name of Device resource rather than archive name */
147 if (device_name[0] == '"') {
148 strcpy(device_name, device_name+1);
149 int len = strlen(device_name);
151 device_name[len-1] = 0;
154 foreach_res(device, R_DEVICE) {
155 if (strcmp(device->hdr.name, device_name) == 0) {
163 Pmsg2(0, _("Could not find device \"%s\" in config file %s.\n"), device_name,
167 Pmsg2(0, _("Using device: \"%s\" for %s.\n"), device_name,
168 read_access?"reading":"writing");
175 * Called here when freeing JCR so that we can get rid
176 * of "daemon" specific memory allocated.
178 static void my_free_jcr(JCR *jcr)
180 if (jcr->pool_name) {
181 free_pool_memory(jcr->pool_name);
182 jcr->pool_name = NULL;
184 if (jcr->pool_type) {
185 free_pool_memory(jcr->pool_type);
186 jcr->pool_type = NULL;
189 free_pool_memory(jcr->job_name);
190 jcr->job_name = NULL;
192 if (jcr->client_name) {
193 free_pool_memory(jcr->client_name);
194 jcr->client_name = NULL;
196 if (jcr->fileset_name) {
197 free_pool_memory(jcr->fileset_name);
198 jcr->fileset_name = NULL;
200 if (jcr->fileset_md5) {
201 free_pool_memory(jcr->fileset_md5);
202 jcr->fileset_md5 = NULL;
205 free_pool_memory(jcr->dev_name);
206 jcr->dev_name = NULL;
220 * Setup a "daemon" JCR for the various standalone
221 * tools (e.g. bls, bextract, bscan, ...)
223 JCR *setup_jcr(const char *name, const char *device, BSR *bsr, const char *VolumeName)
225 JCR *jcr = new_jcr(sizeof(JCR), my_free_jcr);
226 jcr->VolSessionId = 1;
227 jcr->VolSessionTime = (uint32_t)time(NULL);
230 jcr->pool_name = get_pool_memory(PM_FNAME);
231 strcpy(jcr->pool_name, "Default");
232 jcr->pool_type = get_pool_memory(PM_FNAME);
233 strcpy(jcr->pool_type, "Backup");
234 jcr->job_name = get_pool_memory(PM_FNAME);
235 pm_strcpy(&jcr->job_name, "Dummy.Job.Name");
236 jcr->client_name = get_pool_memory(PM_FNAME);
237 pm_strcpy(&jcr->client_name, "Dummy.Client.Name");
238 bstrncpy(jcr->Job, name, sizeof(jcr->Job));
239 jcr->fileset_name = get_pool_memory(PM_FNAME);
240 pm_strcpy(&jcr->fileset_name, "Dummy.fileset.name");
241 jcr->fileset_md5 = get_pool_memory(PM_FNAME);
242 pm_strcpy(&jcr->fileset_md5, "Dummy.fileset.md5");
244 jcr->JobType = JT_CONSOLE;
245 jcr->JobLevel = L_FULL;
246 jcr->JobStatus = JS_Terminated;
247 jcr->dev_name = get_pool_memory(PM_FNAME);
248 pm_strcpy(&jcr->dev_name, device);
249 if (!bsr && VolumeName) {
250 pm_strcpy(&jcr->VolumeName, VolumeName);
252 jcr->where = bstrdup("");
258 * Device got an error, attempt to analyse it
260 void display_tape_error_status(JCR *jcr, DEVICE *dev)
264 status = status_dev(dev);
265 Dmsg1(20, "Device status: %x\n", status);
266 if (status & BMT_EOD)
267 Jmsg(jcr, M_ERROR, 0, _("Unexpected End of Data\n"));
268 else if (status & BMT_EOT)
269 Jmsg(jcr, M_ERROR, 0, _("Unexpected End of Tape\n"));
270 else if (status & BMT_EOF)
271 Jmsg(jcr, M_ERROR, 0, _("Unexpected End of File\n"));
272 else if (status & BMT_DR_OPEN)
273 Jmsg(jcr, M_ERROR, 0, _("Tape Door is Open\n"));
274 else if (!(status & BMT_ONLINE))
275 Jmsg(jcr, M_ERROR, 0, _("Unexpected Tape is Off-line\n"));