]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_status.c
29eb20f6c8df42fa68ca53804008e3fb1beaa2fa
[bacula/bacula] / bacula / src / dird / ua_status.c
1 /*
2  *
3  *   Bacula Director -- User Agent Status Command
4  *
5  *     Kern Sibbald, August MMI
6  *
7  *   Version $Id$
8  */
9
10 /*
11    Copyright (C) 2000-2004 Kern Sibbald and John Walker
12
13    This program is free software; you can redistribute it and/or
14    modify it under the terms of the GNU General Public License as
15    published by the Free Software Foundation; either version 2 of
16    the License, or (at your option) any later version.
17
18    This program is distributed in the hope that it will be useful,
19    but WITHOUT ANY WARRANTY; without even the implied warranty of
20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21    General Public License for more details.
22
23    You should have received a copy of the GNU General Public
24    License along with this program; if not, write to the Free
25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
26    MA 02111-1307, USA.
27
28  */
29
30 #include "bacula.h"
31 #include "dird.h"
32
33 extern char my_name[];
34 extern time_t daemon_start_time;
35 extern int num_jobs_run;
36
37 static void list_scheduled_jobs(UAContext *ua);
38 static void list_running_jobs(UAContext *ua);
39 static void list_terminated_jobs(UAContext *ua);
40 static void do_storage_status(UAContext *ua, STORE *store);
41 static void do_client_status(UAContext *ua, CLIENT *client);
42 static void do_director_status(UAContext *ua);
43 static void do_all_status(UAContext *ua);
44
45 /*
46  * status command
47  */
48 int status_cmd(UAContext *ua, const char *cmd)
49 {
50    STORE *store;
51    CLIENT *client;
52    int item, i;
53
54    if (!open_db(ua)) {
55       return 1;
56    }
57    Dmsg1(20, "status:%s:\n", cmd);
58
59    for (i=1; i<ua->argc; i++) {
60       if (strcasecmp(ua->argk[i], _("all")) == 0) {
61          do_all_status(ua);
62          return 1;
63       } else if (strcasecmp(ua->argk[i], _("dir")) == 0 ||
64                  strcasecmp(ua->argk[i], _("director")) == 0) {
65          do_director_status(ua);
66          return 1;
67       } else if (strcasecmp(ua->argk[i], _("client")) == 0) {
68          client = get_client_resource(ua);
69          if (client) {
70             do_client_status(ua, client);
71          }
72          return 1;
73       } else {
74          store = get_storage_resource(ua, 0);
75          if (store) {
76             do_storage_status(ua, store);
77          }
78          return 1;
79       }
80    }
81    /* If no args, ask for status type */
82    if (ua->argc == 1) {                                    
83        char prmt[MAX_NAME_LENGTH];              
84        
85       start_prompt(ua, _("Status available for:\n"));
86       add_prompt(ua, _("Director"));
87       add_prompt(ua, _("Storage"));
88       add_prompt(ua, _("Client"));
89       add_prompt(ua, _("All"));
90       Dmsg0(20, "do_prompt: select daemon\n");
91       if ((item=do_prompt(ua, "",  _("Select daemon type for status"), prmt, sizeof(prmt))) < 0) {
92          return 1;
93       }
94       Dmsg1(20, "item=%d\n", item);
95       switch (item) { 
96       case 0:                         /* Director */
97          do_director_status(ua);
98          break;
99       case 1:
100          store = select_storage_resource(ua);
101          if (store) {
102             do_storage_status(ua, store);
103          }
104          break;
105       case 2:
106          client = select_client_resource(ua);
107          if (client) {
108             do_client_status(ua, client);
109          }
110          break;
111       case 3:
112          do_all_status(ua);
113          break;
114       default:
115          break;
116       }
117    }
118    return 1;
119 }
120
121 static void do_all_status(UAContext *ua)
122 {
123    STORE *store, **unique_store;
124    CLIENT *client, **unique_client;
125    int i, j;
126    bool found;
127
128    do_director_status(ua);
129
130    /* Count Storage items */
131    LockRes();
132    i = 0;
133    foreach_res(store, R_STORAGE) {
134       i++;
135    }
136    unique_store = (STORE **) malloc(i * sizeof(STORE));
137    /* Find Unique Storage address/port */         
138    i = 0;
139    foreach_res(store, R_STORAGE) {
140       found = false;
141       if (!acl_access_ok(ua, Storage_ACL, store->hdr.name)) {
142          continue;
143       }
144       for (j=0; j<i; j++) {
145          if (strcmp(unique_store[j]->address, store->address) == 0 &&
146              unique_store[j]->SDport == store->SDport) {
147             found = true;
148             break;
149          }
150       }
151       if (!found) {
152          unique_store[i++] = store;
153          Dmsg2(40, "Stuffing: %s:%d\n", store->address, store->SDport);
154       }
155    }
156    UnlockRes();
157
158    /* Call each unique Storage daemon */
159    for (j=0; j<i; j++) {
160       do_storage_status(ua, unique_store[j]);
161    }
162    free(unique_store);
163
164    /* Count Client items */
165    LockRes();
166    i = 0;
167    foreach_res(client, R_CLIENT) {
168       i++;
169    }
170    unique_client = (CLIENT **)malloc(i * sizeof(CLIENT));
171    /* Find Unique Client address/port */         
172    i = 0;
173    foreach_res(client, R_CLIENT) {
174       found = false;
175       if (!acl_access_ok(ua, Client_ACL, client->hdr.name)) {
176          continue;
177       }
178       for (j=0; j<i; j++) {
179          if (strcmp(unique_client[j]->address, client->address) == 0 &&
180              unique_client[j]->FDport == client->FDport) {
181             found = true;
182             break;
183          }
184       }
185       if (!found) {
186          unique_client[i++] = client;
187          Dmsg2(40, "Stuffing: %s:%d\n", client->address, client->FDport);
188       }
189    }
190    UnlockRes();
191
192    /* Call each unique File daemon */
193    for (j=0; j<i; j++) {
194       do_client_status(ua, unique_client[j]);
195    }
196    free(unique_client);
197    
198 }
199
200 static void do_director_status(UAContext *ua)
201 {
202    char dt[MAX_TIME_LENGTH];
203
204    bsendmsg(ua, "%s Version: " VERSION " (" BDATE ") %s %s %s\n", my_name,
205             HOST_OS, DISTNAME, DISTVER);
206    bstrftime_nc(dt, sizeof(dt), daemon_start_time);
207    bsendmsg(ua, _("Daemon started %s, %d Job%s run since started.\n"), 
208         dt, num_jobs_run, num_jobs_run == 1 ? "" : "s");
209    if (debug_level > 0) {
210       char b1[35], b2[35], b3[35], b4[35];
211       bsendmsg(ua, _(" Heap: bytes=%s max_bytes=%s bufs=%s max_bufs=%s\n"),
212             edit_uint64_with_commas(sm_bytes, b1),
213             edit_uint64_with_commas(sm_max_bytes, b2),
214             edit_uint64_with_commas(sm_buffers, b3),
215             edit_uint64_with_commas(sm_max_buffers, b4));
216    }
217    /*
218     * List scheduled Jobs
219     */
220    list_scheduled_jobs(ua);
221
222    /* 
223     * List running jobs
224     */
225    list_running_jobs(ua);
226
227    /* 
228     * List terminated jobs
229     */
230    list_terminated_jobs(ua);
231    bsendmsg(ua, "====\n");
232 }
233
234 static void do_storage_status(UAContext *ua, STORE *store)
235 {
236    BSOCK *sd;
237
238    ua->jcr->store = store;
239    /* Try connecting for up to 15 seconds */
240    bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d\n"), 
241       store->hdr.name, store->address, store->SDport);
242    if (!connect_to_storage_daemon(ua->jcr, 1, 15, 0)) {
243       bsendmsg(ua, _("\nFailed to connect to Storage daemon %s.\n====\n"),
244          store->hdr.name);
245       if (ua->jcr->store_bsock) {
246          bnet_close(ua->jcr->store_bsock);
247          ua->jcr->store_bsock = NULL;
248       }         
249       return;
250    }
251    Dmsg0(20, _("Connected to storage daemon\n"));
252    sd = ua->jcr->store_bsock;
253    bnet_fsend(sd, "status");
254    while (bnet_recv(sd) >= 0) {
255       bsendmsg(ua, "%s", sd->msg);
256    }
257    bnet_sig(sd, BNET_TERMINATE);
258    bnet_close(sd);
259    ua->jcr->store_bsock = NULL;
260    return;  
261 }
262    
263 static void do_client_status(UAContext *ua, CLIENT *client)
264 {
265    BSOCK *fd;
266
267    /* Connect to File daemon */
268
269    ua->jcr->client = client;
270    /* Release any old dummy key */
271    if (ua->jcr->sd_auth_key) {
272       free(ua->jcr->sd_auth_key);
273    }
274    /* Create a new dummy SD auth key */
275    ua->jcr->sd_auth_key = bstrdup("dummy");
276
277    /* Try to connect for 15 seconds */
278    bsendmsg(ua, _("Connecting to Client %s at %s:%d\n"), 
279       client->hdr.name, client->address, client->FDport);
280    if (!connect_to_file_daemon(ua->jcr, 1, 15, 0)) {
281       bsendmsg(ua, _("Failed to connect to Client %s.\n====\n"),
282          client->hdr.name);
283       if (ua->jcr->file_bsock) {
284          bnet_close(ua->jcr->file_bsock);
285          ua->jcr->file_bsock = NULL;
286       }         
287       return;
288    }
289    Dmsg0(20, _("Connected to file daemon\n"));
290    fd = ua->jcr->file_bsock;
291    bnet_fsend(fd, "status");
292    while (bnet_recv(fd) >= 0) {
293       bsendmsg(ua, "%s", fd->msg);
294    }
295    bnet_sig(fd, BNET_TERMINATE);
296    bnet_close(fd);
297    ua->jcr->file_bsock = NULL;
298
299    return;  
300 }
301
302 static void prt_runhdr(UAContext *ua)
303 {
304    bsendmsg(ua, _("\nScheduled Jobs:\n"));
305    bsendmsg(ua, _("Level          Type     Pri  Scheduled          Name               Volume\n"));
306    bsendmsg(ua, _("===================================================================================\n"));
307 }
308
309 /* Scheduling packet */
310 struct sched_pkt {
311    dlink link;                        /* keep this as first item!!! */
312    JOB *job;
313    int level;
314    int priority;
315    time_t runtime;
316    POOL *pool;
317 };
318
319 static void prt_runtime(UAContext *ua, sched_pkt *sp)
320 {
321    char dt[MAX_TIME_LENGTH];       
322    const char *level_ptr;
323    bool ok = false;
324    bool close_db = false;
325    JCR *jcr = ua->jcr;
326    MEDIA_DBR mr;
327    memset(&mr, 0, sizeof(mr));
328    if (sp->job->JobType == JT_BACKUP) {
329       jcr->db = NULL;
330       ok = complete_jcr_for_job(jcr, sp->job, sp->pool);
331       if (jcr->db) {
332          close_db = true;             /* new db opened, remember to close it */
333       }
334       if (ok) {
335          ok = find_next_volume_for_append(jcr, &mr, 0);
336       }
337       if (!ok) {
338          bstrncpy(mr.VolumeName, "*unknown*", sizeof(mr.VolumeName));
339       }
340    }
341    bstrftime_nc(dt, sizeof(dt), sp->runtime);
342    switch (sp->job->JobType) {
343    case JT_ADMIN:
344    case JT_RESTORE:
345       level_ptr = " ";
346       break;
347    default:
348       level_ptr = level_to_str(sp->level);
349       break;
350    }
351    bsendmsg(ua, _("%-14s %-8s %3d  %-18s %-18s %s\n"), 
352       level_ptr, job_type_to_str(sp->job->JobType), sp->priority, dt, 
353       sp->job->hdr.name, mr.VolumeName);
354    if (close_db) {
355       db_close_database(jcr, jcr->db);
356    }
357    jcr->db = ua->db;                  /* restore ua db to jcr */
358
359 }
360
361 /*
362  * Sort items by runtime, priority
363  */
364 static int my_compare(void *item1, void *item2)
365 {
366    sched_pkt *p1 = (sched_pkt *)item1;
367    sched_pkt *p2 = (sched_pkt *)item2;
368    if (p1->runtime < p2->runtime) {
369       return -1;
370    } else if (p1->runtime > p2->runtime) {
371       return 1;
372    }     
373    if (p1->priority < p2->priority) {
374       return -1;
375    } else if (p1->priority > p2->priority) {
376       return 1;
377    }
378    return 0;
379 }
380
381 /*          
382  * Find all jobs to be run in roughly the
383  *  next 24 hours.
384  */
385 static void list_scheduled_jobs(UAContext *ua)
386 {
387    time_t runtime;
388    RUN *run;
389    JOB *job;
390    int level, num_jobs = 0;
391    int priority;
392    bool hdr_printed = false;
393    dlist sched;
394    sched_pkt *sp;
395
396    Dmsg0(200, "enter list_sched_jobs()\n");
397
398    /* Loop through all jobs */
399    LockRes();
400    foreach_res(job, R_JOB) {
401       if (!acl_access_ok(ua, Job_ACL, job->hdr.name)) {
402          continue;
403       }
404       for (run=NULL; (run = find_next_run(run, job, runtime)); ) {
405          level = job->level;   
406          if (run->level) {
407             level = run->level;
408          }
409          priority = job->Priority;   
410          if (run->Priority) {
411             priority = run->Priority;
412          }
413          if (!hdr_printed) {
414             prt_runhdr(ua);
415             hdr_printed = true;
416          }
417          sp = (sched_pkt *)malloc(sizeof(sched_pkt));
418          sp->job = job;
419          sp->level = level;
420          sp->priority = priority;
421          sp->runtime = runtime;
422          sp->pool = run->pool;
423          sched.binary_insert(sp, my_compare);
424          num_jobs++;
425       }
426    } /* end for loop over resources */
427    UnlockRes();
428    foreach_dlist(sp, &sched) {
429       prt_runtime(ua, sp);
430    }
431    if (num_jobs == 0) {
432       bsendmsg(ua, _("No Scheduled Jobs.\n"));
433    } 
434    bsendmsg(ua, "====\n");
435    Dmsg0(200, "Leave list_sched_jobs_runs()\n");
436 }
437
438 static void list_running_jobs(UAContext *ua)
439 {
440    JCR *jcr;
441    int njobs = 0;
442    const char *msg;
443    char *emsg;                        /* edited message */
444    char dt[MAX_TIME_LENGTH];
445    char level[10];
446    bool pool_mem = false;
447
448    Dmsg0(200, "enter list_run_jobs()\n");
449    bsendmsg(ua, _("\nRunning Jobs:\n"));
450    lock_jcr_chain();
451    foreach_jcr(jcr) {
452       njobs++;
453       if (jcr->JobId == 0) {      /* this is us */
454          /* this is a console or other control job. We only show console
455           * jobs in the status output.
456           */
457          if (jcr->JobType == JT_CONSOLE) {
458             bstrftime_nc(dt, sizeof(dt), jcr->start_time);
459             bsendmsg(ua, _("Console connected at %s\n"), dt);
460          }
461          njobs--;
462       }
463       free_locked_jcr(jcr);
464    }
465    if (njobs == 0) {
466       unlock_jcr_chain();
467       /* Note the following message is used in regress -- don't change */
468       bsendmsg(ua, _("No Jobs running.\n====\n"));
469       Dmsg0(200, "leave list_run_jobs()\n");
470       return;
471    }
472    njobs = 0;
473    bsendmsg(ua, _(" JobId Level   Name                       Status\n"));
474    bsendmsg(ua, _("======================================================================\n"));
475    foreach_jcr(jcr) {
476       if (jcr->JobId == 0 || !acl_access_ok(ua, Job_ACL, jcr->job->hdr.name)) {
477          free_locked_jcr(jcr);
478          continue;
479       }
480       njobs++;
481       switch (jcr->JobStatus) {
482       case JS_Created:
483          msg = _("is waiting execution");
484          break;
485       case JS_Running:
486          msg = _("is running");
487          break;
488       case JS_Blocked:
489          msg = _("is blocked");
490          break;
491       case JS_Terminated:
492          msg = _("has terminated");
493          break;
494       case JS_ErrorTerminated:
495          msg = _("has erred");
496          break;
497       case JS_Error:
498          msg = _("has errors");
499          break;
500       case JS_FatalError:
501          msg = _("has a fatal error");
502          break;
503       case JS_Differences:
504          msg = _("has verify differences");
505          break;
506       case JS_Canceled:
507          msg = _("has been canceled");
508          break;
509       case JS_WaitFD:
510          emsg = (char *) get_pool_memory(PM_FNAME);
511          Mmsg(&emsg, _("is waiting on Client %s"), jcr->client->hdr.name);
512          pool_mem = true;
513          msg = emsg;
514          break;
515       case JS_WaitSD:
516          emsg = (char *) get_pool_memory(PM_FNAME);
517          Mmsg(&emsg, _("is waiting on Storage %s"), jcr->store->hdr.name);
518          pool_mem = true;
519          msg = emsg;
520          break;
521       case JS_WaitStoreRes:
522          msg = _("is waiting on max Storage jobs");
523          break;
524       case JS_WaitClientRes:
525          msg = _("is waiting on max Client jobs");
526          break;
527       case JS_WaitJobRes:
528          msg = _("is waiting on max Job jobs");
529          break;
530       case JS_WaitMaxJobs:
531          msg = _("is waiting on max total jobs");
532          break;
533       case JS_WaitStartTime:
534          msg = _("is waiting for its start time");
535          break;
536       case JS_WaitPriority:
537          msg = _("is waiting for higher priority jobs to finish");
538          break;
539
540       default:
541          emsg = (char *) get_pool_memory(PM_FNAME);
542          Mmsg(&emsg, _("is in unknown state %c"), jcr->JobStatus);
543          pool_mem = true;
544          msg = emsg;
545          break;
546       }
547       /* 
548        * Now report Storage daemon status code 
549        */
550       switch (jcr->SDJobStatus) {
551       case JS_WaitMount:
552          if (pool_mem) {
553             free_pool_memory(emsg);
554             pool_mem = false;
555          }
556          msg = _("is waiting for a mount request");
557          break;
558       case JS_WaitMedia:
559          if (pool_mem) {
560             free_pool_memory(emsg);
561             pool_mem = false;
562          }
563          msg = _("is waiting for an appendable Volume");
564          break;
565       case JS_WaitFD:
566          if (!pool_mem) {
567             emsg = (char *) get_pool_memory(PM_FNAME);
568             pool_mem = true;
569          }
570          Mmsg(&emsg, _("is waiting for Client %s to connect to Storage %s"),
571               jcr->client->hdr.name, jcr->store->hdr.name);
572          msg = emsg;
573          break;
574       }
575       switch (jcr->JobType) {
576       case JT_ADMIN:
577       case JT_RESTORE:
578          bstrncpy(level, "      ", sizeof(level));
579          break;
580       default:
581          bstrncpy(level, level_to_str(jcr->JobLevel), sizeof(level));
582          level[7] = 0;
583          break;
584       }
585
586       bsendmsg(ua, _("%6d %-6s  %-20s %s\n"), 
587          jcr->JobId,
588          level, 
589          jcr->Job,
590          msg);
591
592       if (pool_mem) {
593          free_pool_memory(emsg);
594          pool_mem = false;
595       }
596       free_locked_jcr(jcr);
597    }
598    unlock_jcr_chain();
599    bsendmsg(ua, "====\n");
600    Dmsg0(200, "leave list_run_jobs()\n");
601 }
602
603 static void list_terminated_jobs(UAContext *ua)
604 {
605    char dt[MAX_TIME_LENGTH], b1[30], b2[30];
606    char level[10];
607
608    if (last_jobs->empty()) {
609       bsendmsg(ua, _("No Terminated Jobs.\n"));
610       return;
611    }
612    lock_last_jobs_list();
613    struct s_last_job *je;
614    bsendmsg(ua, _("\nTerminated Jobs:\n"));
615    bsendmsg(ua, _(" JobId  Level     Files      Bytes     Status   Finished        Name \n"));
616    bsendmsg(ua, _("========================================================================\n"));
617    foreach_dlist(je, last_jobs) {
618       char JobName[MAX_NAME_LENGTH];
619       const char *termstat;
620
621       bstrftime_nc(dt, sizeof(dt), je->end_time);
622       switch (je->JobType) {
623       case JT_ADMIN:
624       case JT_RESTORE:
625          bstrncpy(level, "    ", sizeof(level));
626          break;
627       default:
628          bstrncpy(level, level_to_str(je->JobLevel), sizeof(level));
629          level[4] = 0;
630          break;
631       }
632       switch (je->JobStatus) {
633       case JS_Created:
634          termstat = "Created";
635          break;
636       case JS_FatalError:
637       case JS_ErrorTerminated:
638          termstat = "Error";
639          break;
640       case JS_Differences:
641          termstat = "Diffs";
642          break;
643       case JS_Canceled:
644          termstat = "Cancel";
645          break;
646       case JS_Terminated:
647          termstat = "OK";
648          break;
649       default:
650          termstat = "Other";
651          break;
652       }
653       bstrncpy(JobName, je->Job, sizeof(JobName));
654       /* There are three periods after the Job name */
655       char *p;
656       for (int i=0; i<3; i++) {
657          if ((p=strrchr(JobName, '.')) != NULL) {
658             *p = 0;
659          }
660       }
661       bsendmsg(ua, _("%6d  %-6s %8s %14s %-7s  %-8s %s\n"), 
662          je->JobId,
663          level, 
664          edit_uint64_with_commas(je->JobFiles, b1),
665          edit_uint64_with_commas(je->JobBytes, b2), 
666          termstat,
667          dt, JobName);
668    }
669    bsendmsg(ua, "\n");
670    unlock_last_jobs_list();
671 }