]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/ua_status.c
Add Peter Eriksson's const code + turn bsscanf code
[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    /*
210     * List scheduled Jobs
211     */
212    list_scheduled_jobs(ua);
213
214    /* 
215     * List running jobs
216     */
217    list_running_jobs(ua);
218
219    /* 
220     * List terminated jobs
221     */
222    list_terminated_jobs(ua);
223    bsendmsg(ua, "====\n");
224 }
225
226 static void do_storage_status(UAContext *ua, STORE *store)
227 {
228    BSOCK *sd;
229
230    ua->jcr->store = store;
231    /* Try connecting for up to 15 seconds */
232    bsendmsg(ua, _("Connecting to Storage daemon %s at %s:%d\n"), 
233       store->hdr.name, store->address, store->SDport);
234    if (!connect_to_storage_daemon(ua->jcr, 1, 15, 0)) {
235       bsendmsg(ua, _("\nFailed to connect to Storage daemon %s.\n====\n"),
236          store->hdr.name);
237       if (ua->jcr->store_bsock) {
238          bnet_close(ua->jcr->store_bsock);
239          ua->jcr->store_bsock = NULL;
240       }         
241       return;
242    }
243    Dmsg0(20, _("Connected to storage daemon\n"));
244    sd = ua->jcr->store_bsock;
245    bnet_fsend(sd, "status");
246    while (bnet_recv(sd) >= 0) {
247       bsendmsg(ua, "%s", sd->msg);
248    }
249    bnet_sig(sd, BNET_TERMINATE);
250    bnet_close(sd);
251    ua->jcr->store_bsock = NULL;
252    return;  
253 }
254    
255 static void do_client_status(UAContext *ua, CLIENT *client)
256 {
257    BSOCK *fd;
258
259    /* Connect to File daemon */
260
261    ua->jcr->client = client;
262    /* Release any old dummy key */
263    if (ua->jcr->sd_auth_key) {
264       free(ua->jcr->sd_auth_key);
265    }
266    /* Create a new dummy SD auth key */
267    ua->jcr->sd_auth_key = bstrdup("dummy");
268
269    /* Try to connect for 15 seconds */
270    bsendmsg(ua, _("Connecting to Client %s at %s:%d\n"), 
271       client->hdr.name, client->address, client->FDport);
272    if (!connect_to_file_daemon(ua->jcr, 1, 15, 0)) {
273       bsendmsg(ua, _("Failed to connect to Client %s.\n====\n"),
274          client->hdr.name);
275       if (ua->jcr->file_bsock) {
276          bnet_close(ua->jcr->file_bsock);
277          ua->jcr->file_bsock = NULL;
278       }         
279       return;
280    }
281    Dmsg0(20, _("Connected to file daemon\n"));
282    fd = ua->jcr->file_bsock;
283    bnet_fsend(fd, "status");
284    while (bnet_recv(fd) >= 0) {
285       bsendmsg(ua, "%s", fd->msg);
286    }
287    bnet_sig(fd, BNET_TERMINATE);
288    bnet_close(fd);
289    ua->jcr->file_bsock = NULL;
290
291    return;  
292 }
293
294 static void prt_runhdr(UAContext *ua)
295 {
296    bsendmsg(ua, _("\nScheduled Jobs:\n"));
297    bsendmsg(ua, _("Level          Type     Scheduled          Name               Volume\n"));
298    bsendmsg(ua, _("===============================================================================\n"));
299 }
300
301 static void prt_runtime(UAContext *ua, JOB *job, int level, time_t runtime, POOL *pool)
302 {
303    char dt[MAX_TIME_LENGTH];       
304    const char *level_ptr;
305    bool ok = false;
306    bool close_db = false;
307    JCR *jcr = ua->jcr;
308    MEDIA_DBR mr;
309    memset(&mr, 0, sizeof(mr));
310    if (job->JobType == JT_BACKUP) {
311       jcr->db = NULL;
312       ok = complete_jcr_for_job(jcr, job, pool);
313       if (jcr->db) {
314          close_db = true;             /* new db opened, remember to close it */
315       }
316       if (ok) {
317          ok = find_next_volume_for_append(jcr, &mr, 0);
318       }
319       if (!ok) {
320          bstrncpy(mr.VolumeName, "*unknown*", sizeof(mr.VolumeName));
321       }
322    }
323    bstrftime_nc(dt, sizeof(dt), runtime);
324    switch (job->JobType) {
325    case JT_ADMIN:
326    case JT_RESTORE:
327       level_ptr = " ";
328       break;
329    default:
330       level_ptr = level_to_str(level);
331       break;
332    }
333    bsendmsg(ua, _("%-14s %-8s %-18s %-18s %s\n"), 
334       level_ptr, job_type_to_str(job->JobType), dt, job->hdr.name, mr.VolumeName);
335    if (close_db) {
336       db_close_database(jcr, jcr->db);
337    }
338    jcr->db = ua->db;                  /* restore ua db to jcr */
339
340 }
341
342 /*          
343  * Find all jobs to be run in roughly the
344  *  next 24 hours.
345  */
346 static void list_scheduled_jobs(UAContext *ua)
347 {
348    time_t runtime;
349    RUN *run;
350    JOB *job;
351    int level, num_jobs = 0;
352    bool hdr_printed = false;
353
354    Dmsg0(200, "enter list_sched_jobs()\n");
355
356    /* Loop through all jobs */
357    LockRes();
358    foreach_res(job, R_JOB) {
359       if (!acl_access_ok(ua, Job_ACL, job->hdr.name)) {
360          continue;
361       }
362       for (run=NULL; (run = find_next_run(run, job, runtime)); ) {
363          level = job->level;   
364          if (run->level) {
365             level = run->level;
366          }
367          if (!hdr_printed) {
368             prt_runhdr(ua);
369             hdr_printed = true;
370          }
371          prt_runtime(ua, job, level, runtime, run->pool);
372          num_jobs++;
373       }
374
375    } /* end for loop over resources */
376    UnlockRes();
377    if (num_jobs == 0) {
378       bsendmsg(ua, _("No Scheduled Jobs.\n"));
379    } 
380    bsendmsg(ua, "====\n");
381    Dmsg0(200, "Leave list_sched_jobs_runs()\n");
382 }
383
384 static void list_running_jobs(UAContext *ua)
385 {
386    JCR *jcr;
387    int njobs = 0;
388    const char *msg;
389    char *emsg;                        /* edited message */
390    char dt[MAX_TIME_LENGTH];
391    char level[10];
392    bool pool_mem = false;
393
394    Dmsg0(200, "enter list_run_jobs()\n");
395    bsendmsg(ua, _("Running Jobs:\n"));
396    lock_jcr_chain();
397    foreach_jcr(jcr) {
398       njobs++;
399       if (jcr->JobId == 0) {      /* this is us */
400          /* this is a console or other control job. We only show console
401           * jobs in the status output.
402           */
403          if (jcr->JobType == JT_CONSOLE) {
404             bstrftime_nc(dt, sizeof(dt), jcr->start_time);
405             bsendmsg(ua, _("Console connected at %s\n"), dt);
406          }
407          njobs--;
408       }
409       free_locked_jcr(jcr);
410    }
411    if (njobs == 0) {
412       unlock_jcr_chain();
413       /* Note the following message is used in regress -- don't change */
414       bsendmsg(ua, _("No Jobs running.\n====\n"));
415       Dmsg0(200, "leave list_run_jobs()\n");
416       return;
417    }
418    njobs = 0;
419    bsendmsg(ua, _(" JobId Level   Name                       Status\n"));
420    bsendmsg(ua, _("======================================================================\n"));
421    foreach_jcr(jcr) {
422       if (jcr->JobId == 0 || !acl_access_ok(ua, Job_ACL, jcr->job->hdr.name)) {
423          free_locked_jcr(jcr);
424          continue;
425       }
426       njobs++;
427       switch (jcr->JobStatus) {
428       case JS_Created:
429          msg = _("is waiting execution");
430          break;
431       case JS_Running:
432          msg = _("is running");
433          break;
434       case JS_Blocked:
435          msg = _("is blocked");
436          break;
437       case JS_Terminated:
438          msg = _("has terminated");
439          break;
440       case JS_ErrorTerminated:
441          msg = _("has erred");
442          break;
443       case JS_Error:
444          msg = _("has errors");
445          break;
446       case JS_FatalError:
447          msg = _("has a fatal error");
448          break;
449       case JS_Differences:
450          msg = _("has verify differences");
451          break;
452       case JS_Canceled:
453          msg = _("has been canceled");
454          break;
455       case JS_WaitFD:
456          emsg = (char *) get_pool_memory(PM_FNAME);
457          Mmsg(&emsg, _("is waiting on Client %s"), jcr->client->hdr.name);
458          pool_mem = true;
459          msg = emsg;
460          break;
461       case JS_WaitSD:
462          emsg = (char *) get_pool_memory(PM_FNAME);
463          Mmsg(&emsg, _("is waiting on Storage %s"), jcr->store->hdr.name);
464          pool_mem = true;
465          msg = emsg;
466          break;
467       case JS_WaitStoreRes:
468          msg = _("is waiting on max Storage jobs");
469          break;
470       case JS_WaitClientRes:
471          msg = _("is waiting on max Client jobs");
472          break;
473       case JS_WaitJobRes:
474          msg = _("is waiting on max Job jobs");
475          break;
476       case JS_WaitMaxJobs:
477          msg = _("is waiting on max total jobs");
478          break;
479       case JS_WaitStartTime:
480          msg = _("is waiting for its start time");
481          break;
482       case JS_WaitPriority:
483          msg = _("is waiting for higher priority jobs to finish");
484          break;
485
486       default:
487          emsg = (char *) get_pool_memory(PM_FNAME);
488          Mmsg(&emsg, _("is in unknown state %c"), jcr->JobStatus);
489          pool_mem = true;
490          msg = emsg;
491          break;
492       }
493       /* 
494        * Now report Storage daemon status code 
495        */
496       switch (jcr->SDJobStatus) {
497       case JS_WaitMount:
498          if (pool_mem) {
499             free_pool_memory(emsg);
500             pool_mem = false;
501          }
502          msg = _("is waiting for a mount request");
503          break;
504       case JS_WaitMedia:
505          if (pool_mem) {
506             free_pool_memory(emsg);
507             pool_mem = false;
508          }
509          msg = _("is waiting for an appendable Volume");
510          break;
511       case JS_WaitFD:
512          if (!pool_mem) {
513             emsg = (char *) get_pool_memory(PM_FNAME);
514             pool_mem = true;
515          }
516          Mmsg(&emsg, _("is waiting for Client %s to connect to Storage %s"),
517               jcr->client->hdr.name, jcr->store->hdr.name);
518          msg = emsg;
519          break;
520       }
521       switch (jcr->JobType) {
522       case JT_ADMIN:
523       case JT_RESTORE:
524          bstrncpy(level, "      ", sizeof(level));
525          break;
526       default:
527          bstrncpy(level, level_to_str(jcr->JobLevel), sizeof(level));
528          level[7] = 0;
529          break;
530       }
531
532       bsendmsg(ua, _("%6d %-6s  %-20s %s\n"), 
533          jcr->JobId,
534          level, 
535          jcr->Job,
536          msg);
537
538       if (pool_mem) {
539          free_pool_memory(emsg);
540          pool_mem = false;
541       }
542       free_locked_jcr(jcr);
543    }
544    unlock_jcr_chain();
545    bsendmsg(ua, "====\n");
546    Dmsg0(200, "leave list_run_jobs()\n");
547 }
548
549 static void list_terminated_jobs(UAContext *ua)
550 {
551    char dt[MAX_TIME_LENGTH], b1[30], b2[30];
552    char level[10];
553
554    if (last_jobs->empty()) {
555       bsendmsg(ua, _("No Terminated Jobs.\n"));
556       return;
557    }
558    lock_last_jobs_list();
559    struct s_last_job *je;
560    bsendmsg(ua, _("\nTerminated Jobs:\n"));
561    bsendmsg(ua, _(" JobId  Level     Files      Bytes     Status   Finished        Name \n"));
562    bsendmsg(ua, _("========================================================================\n"));
563    foreach_dlist(je, last_jobs) {
564       char JobName[MAX_NAME_LENGTH];
565       const char *termstat;
566
567       bstrftime_nc(dt, sizeof(dt), je->end_time);
568       switch (je->JobType) {
569       case JT_ADMIN:
570       case JT_RESTORE:
571          bstrncpy(level, "    ", sizeof(level));
572          break;
573       default:
574          bstrncpy(level, level_to_str(je->JobLevel), sizeof(level));
575          level[4] = 0;
576          break;
577       }
578       switch (je->JobStatus) {
579       case JS_Created:
580          termstat = "Created";
581          break;
582       case JS_FatalError:
583       case JS_ErrorTerminated:
584          termstat = "Error";
585          break;
586       case JS_Differences:
587          termstat = "Diffs";
588          break;
589       case JS_Canceled:
590          termstat = "Cancel";
591          break;
592       case JS_Terminated:
593          termstat = "OK";
594          break;
595       default:
596          termstat = "Other";
597          break;
598       }
599       bstrncpy(JobName, je->Job, sizeof(JobName));
600       /* There are three periods after the Job name */
601       char *p;
602       for (int i=0; i<3; i++) {
603          if ((p=strrchr(JobName, '.')) != NULL) {
604             *p = 0;
605          }
606       }
607       bsendmsg(ua, _("%6d  %-6s %8s %14s %-7s  %-8s %s\n"), 
608          je->JobId,
609          level, 
610          edit_uint64_with_commas(je->JobFiles, b1),
611          edit_uint64_with_commas(je->JobBytes, b2), 
612          termstat,
613          dt, JobName);
614    }
615    bsendmsg(ua, "\n");
616    unlock_last_jobs_list();
617 }