2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2011 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 three of the GNU Affero 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 Affero 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 Kern Sibbald.
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.
29 * Bacula File Daemon Status routines
31 * Kern Sibbald, August MMI
37 #include "lib/status.h"
39 extern void *start_heap;
41 extern bool GetWindowsVersionString(char *buf, int maxsiz);
44 /* Forward referenced functions */
45 static void list_terminated_jobs(STATUS_PKT *sp);
46 static void list_running_jobs(STATUS_PKT *sp);
47 static void list_status_header(STATUS_PKT *sp);
48 static void sendit(const char *msg, int len, STATUS_PKT *sp);
49 static const char *level_to_str(int level);
51 /* Static variables */
52 static char qstatus[] = ".status %s\n";
54 static char OKqstatus[] = "2000 OK .status\n";
55 static char DotStatusJob[] = "JobId=%d JobStatus=%c JobErrors=%d\n";
57 #if defined(HAVE_WIN32)
63 extern VSSClient *g_pVSSClient;
69 * General status generator
71 void output_status(STATUS_PKT *sp)
73 list_status_header(sp);
74 list_running_jobs(sp);
75 list_terminated_jobs(sp);
78 static void list_status_header(STATUS_PKT *sp)
80 POOL_MEM msg(PM_MESSAGE);
81 char b1[32], b2[32], b3[32], b4[32], b5[35];
83 char dt[MAX_TIME_LENGTH];
85 len = Mmsg(msg, _("%s Version: %s (%s) %s %s %s %s\n"),
86 my_name, VERSION, BDATE, VSS, HOST_OS, DISTNAME, DISTVER);
87 sendit(msg.c_str(), len, sp);
88 bstrftime_nc(dt, sizeof(dt), daemon_start_time);
89 len = Mmsg(msg, _("Daemon started %s. Jobs: run=%d running=%d.\n"),
90 dt, num_jobs_run, job_count());
91 sendit(msg.c_str(), len, sp);
92 #if defined(HAVE_WIN32)
94 if (GetWindowsVersionString(buf, sizeof(buf))) {
95 len = Mmsg(msg, "%s\n", buf);
96 sendit(msg.c_str(), len, sp);
98 if (debug_level > 0) {
100 privs = enable_backup_privileges(NULL, 1);
102 len = Mmsg(msg, "VSS %s, Priv 0x%x\n", g_pVSSClient?"enabled":"disabled", privs);
103 sendit(msg.c_str(), len, sp);
104 len = Mmsg(msg, "APIs=%sOPT,%sATP,%sLPV,%sCFA,%sCFW,\n",
105 p_OpenProcessToken?"":"!",
106 p_AdjustTokenPrivileges?"":"!",
107 p_LookupPrivilegeValue?"":"!",
108 p_CreateFileA?"":"!",
109 p_CreateFileW?"":"!");
110 sendit(msg.c_str(), len, sp);
111 len = Mmsg(msg, " %sWUL,%sWMKD,%sGFAA,%sGFAW,%sGFAEA,%sGFAEW,%sSFAA,%sSFAW,%sBR,%sBW,%sSPSP,\n",
114 p_GetFileAttributesA?"":"!",
115 p_GetFileAttributesW?"":"!",
116 p_GetFileAttributesExA?"":"!",
117 p_GetFileAttributesExW?"":"!",
118 p_SetFileAttributesA?"":"!",
119 p_SetFileAttributesW?"":"!",
121 p_BackupWrite?"":"!",
122 p_SetProcessShutdownParameters?"":"!");
123 sendit(msg.c_str(), len, sp);
124 len = Mmsg(msg, " %sWC2MB,%sMB2WC,%sFFFA,%sFFFW,%sFNFA,%sFNFW,%sSCDA,%sSCDW,\n",
125 p_WideCharToMultiByte?"":"!",
126 p_MultiByteToWideChar?"":"!",
127 p_FindFirstFileA?"":"!",
128 p_FindFirstFileW?"":"!",
129 p_FindNextFileA?"":"!",
130 p_FindNextFileW?"":"!",
131 p_SetCurrentDirectoryA?"":"!",
132 p_SetCurrentDirectoryW?"":"!");
133 sendit(msg.c_str(), len, sp);
134 len = Mmsg(msg, " %sGCDA,%sGCDW,%sGVPNW,%sGVNFVMPW\n",
135 p_GetCurrentDirectoryA?"":"!",
136 p_GetCurrentDirectoryW?"":"!",
137 p_GetVolumePathNameW?"":"!",
138 p_GetVolumeNameForVolumeMountPointW?"":"!");
139 sendit(msg.c_str(), len, sp);
142 len = Mmsg(msg, _(" Heap: heap=%s smbytes=%s max_bytes=%s bufs=%s max_bufs=%s\n"),
143 edit_uint64_with_commas((char *)sbrk(0)-(char *)start_heap, b1),
144 edit_uint64_with_commas(sm_bytes, b2),
145 edit_uint64_with_commas(sm_max_bytes, b3),
146 edit_uint64_with_commas(sm_buffers, b4),
147 edit_uint64_with_commas(sm_max_buffers, b5));
148 sendit(msg.c_str(), len, sp);
149 len = Mmsg(msg, _(" Sizeof: boffset_t=%d size_t=%d debug=%d trace=%d\n"),
150 sizeof(boffset_t), sizeof(size_t), debug_level, get_trace());
151 sendit(msg.c_str(), len, sp);
152 if (debug_level > 0 && plugin_list->size() > 0) {
155 pm_strcpy(msg, "Plugin: ");
156 foreach_alist(plugin, plugin_list) {
157 len = pm_strcat(msg, plugin->file);
159 pm_strcat(msg, "\n ");
164 len = pm_strcat(msg, "\n");
165 sendit(msg.c_str(), len, sp);
169 static void list_running_jobs_plain(STATUS_PKT *sp)
172 POOL_MEM msg(PM_MESSAGE);
173 char b1[32], b2[32], b3[32];
177 char dt[MAX_TIME_LENGTH];
181 Dmsg0(1000, "Begin status jcr loop.\n");
182 len = Mmsg(msg, _("\nRunning Jobs:\n"));
183 sendit(msg.c_str(), len, sp);
184 const char *vss = "";
186 if (g_pVSSClient && g_pVSSClient->IsInitialized()) {
191 bstrftime_nc(dt, sizeof(dt), njcr->start_time);
192 if (njcr->JobId == 0) {
193 len = Mmsg(msg, _("Director connected at: %s\n"), dt);
195 len = Mmsg(msg, _("JobId %d Job %s is running.\n"),
196 njcr->JobId, njcr->Job);
197 sendit(msg.c_str(), len, sp);
198 len = Mmsg(msg, _(" %s%s %s Job started: %s\n"),
199 vss, level_to_str(njcr->getJobLevel()),
200 job_type_to_str(njcr->getJobType()), dt);
202 sendit(msg.c_str(), len, sp);
203 if (njcr->JobId == 0) {
206 sec = time(NULL) - njcr->start_time;
210 bps = (int)(njcr->JobBytes / sec);
211 len = Mmsg(msg, _(" Files=%s Bytes=%s Bytes/sec=%s Errors=%d\n"),
212 edit_uint64_with_commas(njcr->JobFiles, b1),
213 edit_uint64_with_commas(njcr->JobBytes, b2),
214 edit_uint64_with_commas(bps, b3),
216 sendit(msg.c_str(), len, sp);
217 len = Mmsg(msg, _(" Files Examined=%s\n"),
218 edit_uint64_with_commas(njcr->num_files_examined, b1));
219 sendit(msg.c_str(), len, sp);
220 if (njcr->JobFiles > 0) {
222 len = Mmsg(msg, _(" Processing file: %s\n"), njcr->last_fname);
224 sendit(msg.c_str(), len, sp);
228 if (njcr->store_bsock) {
229 len = Mmsg(msg, " SDReadSeqNo=%" lld " fd=%d\n",
230 njcr->store_bsock->read_seqno, njcr->store_bsock->m_fd);
231 sendit(msg.c_str(), len, sp);
233 len = Mmsg(msg, _(" SDSocket closed.\n"));
234 sendit(msg.c_str(), len, sp);
240 len = Mmsg(msg, _("No Jobs running.\n"));
241 sendit(msg.c_str(), len, sp);
243 sendit(_("====\n"), 5, sp);
246 static void list_running_jobs_api(STATUS_PKT *sp)
249 POOL_MEM msg(PM_MESSAGE);
250 char b1[32], b2[32], b3[32];
254 char dt[MAX_TIME_LENGTH];
256 * List running jobs for Bat/Bweb (simple to parse)
260 if (g_pVSSClient && g_pVSSClient->IsInitialized()) {
265 bstrutime(dt, sizeof(dt), njcr->start_time);
266 if (njcr->JobId == 0) {
267 len = Mmsg(msg, "DirectorConnected=%s\n", dt);
269 len = Mmsg(msg, "JobId=%d\n Job=%s\n",
270 njcr->JobId, njcr->Job);
271 sendit(msg.c_str(), len, sp);
272 len = Mmsg(msg," VSS=%d\n Level=%c\n JobType=%c\n JobStarted=%s\n",
273 vss, njcr->getJobLevel(),
274 njcr->getJobType(), dt);
276 sendit(msg.c_str(), len, sp);
277 if (njcr->JobId == 0) {
280 sec = time(NULL) - njcr->start_time;
284 bps = (int)(njcr->JobBytes / sec);
285 len = Mmsg(msg, " Files=%s\n Bytes=%s\n Bytes/sec=%s\n Errors=%d\n"
287 edit_uint64(njcr->JobFiles, b1),
288 edit_uint64(njcr->JobBytes, b2),
289 edit_uint64(bps, b3),
290 njcr->JobErrors, njcr->max_bandwidth);
291 sendit(msg.c_str(), len, sp);
292 len = Mmsg(msg, " Files Examined=%s\n",
293 edit_uint64(njcr->num_files_examined, b1));
294 sendit(msg.c_str(), len, sp);
295 if (njcr->JobFiles > 0) {
297 len = Mmsg(msg, " Processing file=%s\n", njcr->last_fname);
299 sendit(msg.c_str(), len, sp);
303 if (njcr->store_bsock) {
304 len = Mmsg(msg, " SDReadSeqNo=%" lld "\n fd=%d\n",
305 njcr->store_bsock->read_seqno, njcr->store_bsock->m_fd);
306 sendit(msg.c_str(), len, sp);
308 len = Mmsg(msg, _(" SDSocket=closed\n"));
309 sendit(msg.c_str(), len, sp);
315 static void list_running_jobs(STATUS_PKT *sp)
318 list_running_jobs_api(sp);
320 list_running_jobs_plain(sp);
324 static void list_terminated_jobs(STATUS_PKT *sp)
326 char dt[MAX_TIME_LENGTH], b1[30], b2[30];
328 struct s_last_job *je;
332 msg = _("\nTerminated Jobs:\n");
333 sendit(msg, strlen(msg), sp);
336 if (last_jobs->size() == 0) {
337 if (!sp->api) sendit(_("====\n"), 5, sp);
340 lock_last_jobs_list();
342 msg = _(" JobId Level Files Bytes Status Finished Name \n");
343 sendit(msg, strlen(msg), sp);
344 msg = _("======================================================================\n");
345 sendit(msg, strlen(msg), sp);
347 foreach_dlist(je, last_jobs) {
348 char JobName[MAX_NAME_LENGTH];
349 const char *termstat;
352 bstrftime_nc(dt, sizeof(dt), je->end_time);
353 switch (je->JobType) {
356 bstrncpy(level, " ", sizeof(level));
359 bstrncpy(level, level_to_str(je->JobLevel), sizeof(level));
363 switch (je->JobStatus) {
365 termstat = _("Created");
368 case JS_ErrorTerminated:
369 termstat = _("Error");
372 termstat = _("Diffs");
375 termstat = _("Cancel");
381 termstat = _("Other");
384 bstrncpy(JobName, je->Job, sizeof(JobName));
385 /* There are three periods after the Job name */
387 for (int i=0; i<3; i++) {
388 if ((p=strrchr(JobName, '.')) != NULL) {
393 bsnprintf(buf, sizeof(buf), _("%6d\t%-6s\t%8s\t%10s\t%-7s\t%-8s\t%s\n"),
396 edit_uint64_with_commas(je->JobFiles, b1),
397 edit_uint64_with_suffix(je->JobBytes, b2),
401 bsnprintf(buf, sizeof(buf), _("%6d %-6s %8s %10s %-7s %-8s %s\n"),
404 edit_uint64_with_commas(je->JobFiles, b1),
405 edit_uint64_with_suffix(je->JobBytes, b2),
409 sendit(buf, strlen(buf), sp);
411 if (!sp->api) sendit(_("====\n"), 5, sp);
412 unlock_last_jobs_list();
417 * Send to bsock (Director or Console)
419 static void sendit(const char *msg, int len, STATUS_PKT *sp)
422 BSOCK *user = sp->bs;
423 user->msg = check_pool_memory_size(user->msg, len+1);
424 memcpy(user->msg, msg, len+1);
425 user->msglen = len+1;
428 sp->callback(msg, len, sp->context);
433 * Status command from Director
435 int status_cmd(JCR *jcr)
437 BSOCK *user = jcr->dir_bsock;
442 sp.api = false; /* no API output */
445 user->signal(BNET_EOD);
450 * .status command from Director
452 int qstatus_cmd(JCR *jcr)
454 BSOCK *dir = jcr->dir_bsock;
461 cmd = get_memory(dir->msglen+1);
463 if (sscanf(dir->msg, qstatus, cmd) != 1) {
464 pm_strcpy(&jcr->errmsg, dir->msg);
465 Jmsg1(jcr, M_FATAL, 0, _("Bad .status command: %s\n"), jcr->errmsg);
466 dir->fsend(_("2900 Bad .status command, missing argument.\n"));
467 dir->signal(BNET_EOD);
473 if (strcmp(cmd, "current") == 0) {
474 dir->fsend(OKqstatus, cmd);
476 if (njcr->JobId != 0) {
477 dir->fsend(DotStatusJob, njcr->JobId, njcr->JobStatus, njcr->JobErrors);
481 } else if (strcmp(cmd, "last") == 0) {
482 dir->fsend(OKqstatus, cmd);
483 if ((last_jobs) && (last_jobs->size() > 0)) {
484 job = (s_last_job*)last_jobs->last();
485 dir->fsend(DotStatusJob, job->JobId, job->JobStatus, job->Errors);
487 } else if (strcasecmp(cmd, "header") == 0) {
489 list_status_header(&sp);
490 } else if (strcasecmp(cmd, "running") == 0) {
492 list_running_jobs(&sp);
493 } else if (strcasecmp(cmd, "terminated") == 0) {
495 list_terminated_jobs(&sp);
497 pm_strcpy(&jcr->errmsg, dir->msg);
498 Jmsg1(jcr, M_FATAL, 0, _("Bad .status command: %s\n"), jcr->errmsg);
499 dir->fsend(_("2900 Bad .status command, wrong argument.\n"));
500 dir->signal(BNET_EOD);
505 dir->signal(BNET_EOD);
511 * Convert Job Level into a string
513 static const char *level_to_str(int level)
524 str = _("Incremental");
527 str = _("Differential");
532 case L_VERIFY_CATALOG:
533 str = _("Verify Catalog");
536 str = _("Init Catalog");
538 case L_VERIFY_VOLUME_TO_CATALOG:
539 str = _("Volume to Catalog");
541 case L_VERIFY_DISK_TO_CATALOG:
542 str = _("Disk to Catalog");
551 str = _("Unknown Job Level");
558 #if defined(HAVE_WIN32)
562 * Put message in Window List Box
564 char *bac_status(char *buf, int buf_len)
567 const char *termstat = _("Bacula Client: Idle");
568 struct s_last_job *job;
569 int stat = 0; /* Idle */
574 Dmsg0(1000, "Begin bac_status jcr loop.\n");
576 if (njcr->JobId != 0) {
578 termstat = _("Bacula Client: Running");
587 if (last_jobs->size() > 0) {
588 job = (struct s_last_job *)last_jobs->last();
589 stat = job->JobStatus;
590 switch (job->JobStatus) {
592 termstat = _("Bacula Client: Last Job Canceled");
594 case JS_ErrorTerminated:
596 termstat = _("Bacula Client: Last Job Failed");
600 termstat = _("Bacula Client: Last Job had Warnings");
605 Dmsg0(1000, "End bac_status jcr loop.\n");
609 bstrncpy(buf, termstat, buf_len);
614 #endif /* HAVE_WIN32 */