]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/askdir.c
Minor updates + doc -- see kes21Nov02
[bacula/bacula] / bacula / src / stored / askdir.c
1 /*
2  *  Subroutines to handle Catalog reqests sent to the Director
3  *   Reqests/commands from the Director are handled in dircmd.c
4  *
5  *   Kern Sibbald, December 2000
6  *
7  *   Version $Id$
8  */
9 /*
10    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
11
12    This program is free software; you can redistribute it and/or
13    modify it under the terms of the GNU General Public License as
14    published by the Free Software Foundation; either version 2 of
15    the License, or (at your option) any later version.
16
17    This program is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20    General Public License for more details.
21
22    You should have received a copy of the GNU General Public
23    License along with this program; if not, write to the Free
24    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25    MA 02111-1307, USA.
26
27  */
28
29 #include "bacula.h"                   /* pull in global headers */
30 #include "stored.h"                   /* pull in Storage Deamon headers */
31
32 /* Requests sent to the Director */
33 static char Find_media[]    = "CatReq Job=%s FindMedia=%d\n";
34 static char Get_Vol_Info[] = "CatReq Job=%s GetVolInfo VolName=%s write=%d\n";
35
36 static char Update_media[] = "CatReq Job=%s UpdateMedia VolName=%s\
37  VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%s VolMounts=%u\
38  VolErrors=%u VolWrites=%u MaxVolBytes=%s EndTime=%d VolStatus=%s\
39  Slot=%d relabel=%d\n";
40
41 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia \
42  FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u \
43  StartBlock=%u EndBlock=%u\n";
44
45
46 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
47
48 static char Job_status[]   = "3012 Job %s jobstatus %d\n";
49
50
51 /* Responses received from the Director */
52 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u\
53  VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u\
54  MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s\
55  Slot=%d MaxVolJobs=%u MaxVolFiles=%u\n";
56
57 static char OK_update[] = "1000 OK UpdateMedia\n";
58
59
60 /*
61  * Send current JobStatus to Director
62  */
63 int dir_send_job_status(JCR *jcr)
64 {
65    return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
66 }
67
68 /*
69  * Common routine for:
70  *   dir_get_volume_info()
71  * and
72  *   dir_find_next_appendable_volume()
73  */
74 static int do_request_volume_info(JCR *jcr)
75 {
76     BSOCK *dir = jcr->dir_bsock;
77     VOLUME_CAT_INFO *vol = &jcr->VolCatInfo;
78
79     jcr->VolumeName[0] = 0;           /* No volume */
80     if (bnet_recv(dir) <= 0) {
81        Dmsg0(200, "getvolname error bnet_recv\n");
82        Mmsg(&jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
83        return 0;
84     }
85     if (sscanf(dir->msg, OK_media, vol->VolCatName, 
86                &vol->VolCatJobs, &vol->VolCatFiles,
87                &vol->VolCatBlocks, &vol->VolCatBytes,
88                &vol->VolCatMounts, &vol->VolCatErrors,
89                &vol->VolCatWrites, &vol->VolCatMaxBytes,
90                &vol->VolCatCapacityBytes, vol->VolCatStatus,
91                &vol->Slot, &vol->VolCatMaxJobs, &vol->VolCatMaxFiles) != 14) {
92
93        Dmsg1(000, "Bad response from Dir: %s\n", dir->msg);
94        Mmsg(&jcr->errmsg, _("Error scanning Dir response: %s\n"), dir->msg);
95        return 0;
96     }
97     unbash_spaces(vol->VolCatName);
98     strcpy(jcr->VolumeName, vol->VolCatName); /* set desired VolumeName */
99     
100     Dmsg2(200, "do_reqest_vol_info got slot=%d Volume=%s\n", 
101        vol->Slot, vol->VolCatName);
102     return 1;
103 }
104
105
106 /*
107  * Get Volume info for a specific volume from the Director's Database
108  *
109  * Returns: 1 on success   (not Director guarantees that Pool and MediaType
110  *                          are correct and VolStatus==Append or
111  *                          VolStatus==Recycle)
112  *          0 on failure
113  *
114  *          Volume information returned in jcr
115  */
116 int dir_get_volume_info(JCR *jcr, int writing)
117 {
118     BSOCK *dir = jcr->dir_bsock;
119
120     strcpy(jcr->VolCatInfo.VolCatName, jcr->VolumeName);
121     Dmsg1(200, "dir_get_volume_info=%s\n", jcr->VolCatInfo.VolCatName);
122     bash_spaces(jcr->VolCatInfo.VolCatName);
123     bnet_fsend(dir, Get_Vol_Info, jcr->Job, jcr->VolCatInfo.VolCatName, writing);
124     return do_request_volume_info(jcr);
125 }
126
127
128
129 /*
130  * Get info on the next appendable volume in the Director's database
131  * Returns: 1 on success
132  *          0 on failure
133  *
134  *          Volume information returned in jcr
135  *
136  */
137 int dir_find_next_appendable_volume(JCR *jcr)
138 {
139     BSOCK *dir = jcr->dir_bsock;
140
141     Dmsg0(200, "dir_find_next_appendable_volume\n");
142     bnet_fsend(dir, Find_media, jcr->Job, 1);
143     return do_request_volume_info(jcr);
144 }
145
146     
147 /*
148  * After writing a Volume, send the updated statistics
149  * back to the director.
150  */
151 int dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int relabel)
152 {
153    BSOCK *dir = jcr->dir_bsock;
154    time_t EndTime = time(NULL);
155    char ed1[50], ed2[50];
156
157    if (vol->VolCatName[0] == 0) {
158       Jmsg0(jcr, M_ERROR, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
159       return 0;
160    }
161    bnet_fsend(dir, Update_media, jcr->Job, 
162       vol->VolCatName, vol->VolCatJobs, vol->VolCatFiles,
163       vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
164       vol->VolCatMounts, vol->VolCatErrors,
165       vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2), 
166       EndTime, vol->VolCatStatus, vol->Slot, relabel);
167    Dmsg1(120, "update_volume_data(): %s", dir->msg);
168    if (bnet_recv(dir) <= 0) {
169       Dmsg0(190, "updateVolCatInfo error bnet_recv\n");
170       Jmsg(jcr, M_ERROR, 0, _("Error updating Volume Info: %s\n"), 
171            bnet_strerror(dir));
172       return 0;
173    }
174    Dmsg1(120, "Updatevol: %s", dir->msg);
175    if (strcmp(dir->msg, OK_update) != 0) {
176       Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
177       Jmsg(jcr, M_ERROR, 0, _("Error updating Volume Info: %s\n"), dir->msg);
178       return 0;
179    }
180    return 1;
181 }
182
183 /*
184  * After writing a Volume, create the JobMedia record.
185  */
186 int dir_create_jobmedia_record(JCR *jcr)
187 {
188    BSOCK *dir = jcr->dir_bsock;
189
190    bnet_fsend(dir, Create_job_media, jcr->Job, 
191       jcr->VolFirstFile, jcr->JobFiles,
192       jcr->StartFile, jcr->EndFile,
193       jcr->StartBlock, jcr->EndBlock);
194    Dmsg1(100, "create_jobmedia(): %s", dir->msg);
195    if (bnet_recv(dir) <= 0) {
196       Dmsg0(190, "create_jobmedia error bnet_recv\n");
197       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), 
198            bnet_strerror(dir));
199       return 0;
200    }
201    Dmsg1(120, "Create_jobmedia: %s", dir->msg);
202    if (strcmp(dir->msg, OK_update) != 0) {
203       Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
204       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
205       return 0;
206    }
207    return 1;
208 }
209
210
211 /* 
212  * Update File Attribute data
213  */
214 int dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec)
215 {
216    BSOCK *dir = jcr->dir_bsock;
217    ser_declare;
218
219    dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
220    dir->msg = check_pool_memory_size(dir->msg, dir->msglen + 
221                 sizeof(DEV_RECORD) + rec->data_len);
222    ser_begin(dir->msg + dir->msglen, 0);
223    ser_uint32(rec->VolSessionId);
224    ser_uint32(rec->VolSessionTime);
225    ser_int32(rec->FileIndex);
226    ser_int32(rec->Stream);
227    ser_uint32(rec->data_len);
228    ser_bytes(rec->data, rec->data_len);
229    dir->msglen = ser_length(dir->msg);
230    return bnet_send(dir);
231 }
232
233
234 /*
235  *   
236  *   Entered with device blocked.
237  *   Leaves with device blocked.
238  *
239  *   Returns: 1 on success (operator issues a mount command)
240  *            0 on failure
241  *              Note, must create dev->errmsg on error return.
242  *
243  *    On success, jcr->VolumeName and jcr->VolCatInfo contain
244  *      information on suggested volume, but this may not be the
245  *      same as what is actually mounted.
246  *
247  *    When we return with success, the correct tape may or may not
248  *      actually be mounted. The calling routine must read it and
249  *      verify the label.
250  */
251 int dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev)
252 {
253    struct timeval tv;
254    struct timezone tz;
255    struct timespec timeout;
256    int stat = 0, jstat;
257    /* ******FIXME******* put these on config variable */
258    int min_wait = 60 * 60;
259    int max_wait = 24 * 60 * 60;
260    int max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
261
262    int wait_sec;
263    int num_wait = 0;
264    int dev_blocked;
265
266    Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
267    ASSERT(dev->dev_blocked);
268    wait_sec = min_wait;
269    for ( ;; ) {
270       if (job_cancelled(jcr)) {
271          Mmsg(&dev->errmsg, _("Job %s cancelled while waiting for mount on Storage Device \"%s\".\n"), 
272               jcr->Job, jcr->dev_name);
273          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
274          return 0;
275       }
276       if (dir_find_next_appendable_volume(jcr)) {    /* get suggested volume */
277          jstat = JS_WaitMount;
278          /*
279           * If we have a valid volume name and we are not
280           * removable media, return now, otherwise wait
281           * for the operator to mount the media.
282           */
283          if (jcr->VolumeName[0] && !(dev->capabilities & CAP_REM) &&      
284               dev->capabilities & CAP_LABEL) {
285             Dmsg0(190, "Return 1 from mount without wait.\n");
286             return 1;
287          }
288          Jmsg(jcr, M_MOUNT, 0, _(
289 "Please mount Volume \"%s\" on Storage Device \"%s\" for Job %s\n"
290 "Use \"mount\" command to release Job.\n"),
291               jcr->VolumeName, jcr->dev_name, jcr->Job);
292          Dmsg3(190, "Mount %s on %s for Job %s\n",
293                 jcr->VolumeName, jcr->dev_name, jcr->Job);
294       } else {
295          jstat = JS_WaitMedia;
296          Jmsg(jcr, M_MOUNT, 0, _(
297 "Job %s waiting. Cannot find any appendable volumes.\n\
298 Please use the \"label\"  command to create a new Volume for:\n\
299     Storage:      %s\n\
300     Media type:   %s\n\
301     Pool:         %s\n"),
302               jcr->Job, 
303               jcr->dev_name, 
304               jcr->media_type,
305               jcr->pool_name);
306       }
307       /*
308        * Wait then send message again
309        */
310       gettimeofday(&tv, &tz);
311       timeout.tv_nsec = tv.tv_usec * 1000;
312       timeout.tv_sec = tv.tv_sec + wait_sec;
313
314       P(dev->mutex);
315       dev_blocked = dev->dev_blocked;
316       dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
317       jcr->JobStatus = jstat;
318       dir_send_job_status(jcr);
319
320       for ( ;!job_cancelled(jcr); ) {
321          Dmsg1(190, "I'm going to sleep on device %s\n", dev->dev_name);
322          stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
323          if (dev->dev_blocked == BST_WAITING_FOR_SYSOP) {
324             break;
325          }
326          /*         
327           * Someone other than us blocked the device (probably the
328           *  user via the Console program.   
329           * So, we continue waiting.
330           */
331          gettimeofday(&tv, &tz);
332          timeout.tv_nsec = 0;
333          timeout.tv_sec = tv.tv_sec + 10; /* wait 10 seconds */
334       }
335       dev->dev_blocked = dev_blocked;
336       V(dev->mutex);
337
338       if (stat == ETIMEDOUT) {
339          wait_sec *= 2;               /* double wait time */
340          if (wait_sec > max_wait) {   /* but not longer than maxtime */
341             wait_sec = max_wait;
342          }
343          num_wait++;
344          if (num_wait >= max_num_wait) {
345             Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"), 
346                  jcr->dev_name, jcr->Job);
347             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
348             Dmsg1(190, "Gave up waiting on device %s\n", dev->dev_name);
349             return 0;                 /* exceeded maximum waits */
350          }
351          continue;
352       }
353       if (stat == EINVAL) {
354          Mmsg2(&dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
355                stat, strerror(stat));
356          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
357          return 0;
358       }
359       if (stat != 0) {
360          Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
361             strerror(stat));
362       }
363       Dmsg1(190, "Someone woke me for device %s\n", dev->dev_name);
364
365       /* Restart wait counters */
366       wait_sec = min_wait;
367       num_wait = 0;
368       /* If no VolumeName, and cannot get one, try again */
369       if (jcr->VolumeName[0] == 0 && 
370           !dir_find_next_appendable_volume(jcr)) {
371          Jmsg(jcr, M_MOUNT, 0, _(
372 "Someone woke me up, but I cannot find any appendable\n\
373 volumes for Job=%s.\n"), jcr->Job);
374          continue;
375       }       
376       break;
377    }
378    jcr->JobStatus = JS_Running;
379    dir_send_job_status(jcr);
380    Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
381    return 1;
382 }
383
384 /*
385  *   
386  *   Entered with device blocked and jcr->VolumeName is desired
387  *      volume.
388  *   Leaves with device blocked.
389  *
390  *   Returns: 1 on success (operator issues a mount command)
391  *            0 on failure
392  *              Note, must create dev->errmsg on error return.
393  *
394  */
395 int dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev)
396 {
397    int stat = 0;
398    /* ******FIXME******* put these on config variable */
399    int min_wait = 60 * 60;
400    int max_wait = 24 * 60 * 60;
401    int max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
402    int wait_sec;
403    int num_wait = 0;
404    int dev_blocked;
405    char *msg;
406    struct timeval tv;
407    struct timezone tz;
408    struct timespec timeout;
409
410    Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
411    if (!jcr->VolumeName[0]) {
412       Mmsg0(&dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
413       return 0;
414    }
415    ASSERT(dev->dev_blocked);
416    wait_sec = min_wait;
417    for ( ;; ) {
418       if (job_cancelled(jcr)) {
419          Mmsg(&dev->errmsg, _("Job %s cancelled while waiting for mount on Storage Device \"%s\".\n"), 
420               jcr->Job, jcr->dev_name);
421          return 0;
422       }
423       msg = _("Please mount");
424       Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device \"%s\" for Job %s\n"),
425            msg, jcr->VolumeName, jcr->dev_name, jcr->Job);
426       Dmsg3(190, "Mount %s on %s for Job %s\n",
427             jcr->VolumeName, jcr->dev_name, jcr->Job);
428
429       /*
430        * Wait then send message again
431        */
432       gettimeofday(&tv, &tz);
433       timeout.tv_nsec = tv.tv_usec * 1000;
434       timeout.tv_sec = tv.tv_sec + wait_sec;
435
436       P(dev->mutex);
437       dev_blocked = dev->dev_blocked;
438       dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
439       jcr->JobStatus = JS_WaitMount;
440       dir_send_job_status(jcr);
441
442       for ( ;!job_cancelled(jcr); ) {
443          Dmsg1(190, "I'm going to sleep on device %s\n", dev->dev_name);
444          stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
445          if (dev->dev_blocked == BST_WAITING_FOR_SYSOP) {
446             break;
447          }
448          /*         
449           * Someone other than us blocked the device (probably the
450           *  user via the Console program.   
451           * So, we continue waiting.
452           */
453          gettimeofday(&tv, &tz);
454          timeout.tv_nsec = 0;
455          timeout.tv_sec = tv.tv_sec + 10; /* wait 10 seconds */
456       }
457       dev->dev_blocked = dev_blocked;
458       V(dev->mutex);
459
460       if (stat == ETIMEDOUT) {
461          wait_sec *= 2;               /* double wait time */
462          if (wait_sec > max_wait) {   /* but not longer than maxtime */
463             wait_sec = max_wait;
464          }
465          num_wait++;
466          if (num_wait >= max_num_wait) {
467             Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"), 
468                  jcr->dev_name, jcr->Job);
469             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
470             Dmsg1(190, "Gave up waiting on device %s\n", dev->dev_name);
471             return 0;                 /* exceeded maximum waits */
472          }
473          continue;
474       }
475       if (stat == EINVAL) {
476          Mmsg2(&dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
477                stat, strerror(stat));
478          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
479          return 0;
480       }
481       if (stat != 0) {
482          Jmsg(jcr, M_ERROR, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
483             strerror(stat));
484       }
485       Dmsg1(190, "Someone woke me for device %s\n", dev->dev_name);
486
487       /* Restart wait counters */
488       wait_sec = min_wait;
489       num_wait = 0;
490       break;
491    }
492    jcr->JobStatus = JS_Running;
493    dir_send_job_status(jcr);
494    Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
495    return 1;
496 }