/*
- * Manipulation routines for Job Control Records
+ Bacula® - The Network Backup Solution
+
+ Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
+
+ The main author of Bacula is Kern Sibbald, with contributions from
+ many others, a complete list can be found in the file AUTHORS.
+ This program is Free Software; you can redistribute it and/or
+ modify it under the terms of version two of the GNU General Public
+ License as published by the Free Software Foundation and included
+ in the file LICENSE.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+
+ Bacula® is a registered trademark of Kern Sibbald.
+ The licensor of Bacula is the Free Software Foundation Europe
+ (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+ Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ * Manipulation routines for Job Control Records and
+ * handling of last_jobs_list.
*
* Kern E. Sibbald, December 2000
*
*
* These routines are thread safe.
*
- */
-/*
- Copyright (C) 2000-2003 Kern Sibbald and John Walker
-
- This program is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License as
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public
- License along with this program; if not, write to the Free
- Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- MA 02111-1307, USA.
-
+ * The job list routines were re-written in May 2005 to
+ * eliminate the global lock while traversing the list, and
+ * to use the dlist subroutines. The locking is now done
+ * on the list each time the list is modified or traversed.
+ * That is it is "micro-locked" rather than globally locked.
+ * The result is that there is one lock/unlock for each entry
+ * in the list while traversing it rather than a single lock
+ * at the beginning of a traversal and one at the end. This
+ * incurs slightly more overhead, but effectively eliminates
+ * the possibilty of race conditions. In addition, with the
+ * exception of the global locking of the list during the
+ * re-reading of the config file, no recursion is needed.
+ *
*/
#include "bacula.h"
#include "jcr.h"
+const int dbglvl = 3400;
+
/* External variables we reference */
extern time_t watchdog_time;
+/* External referenced functions */
+void free_bregexps(alist *bregexps);
+
/* Forward referenced functions */
-static void timeout_handler(int sig);
+extern "C" void timeout_handler(int sig);
static void jcr_timeout_check(watchdog_t *self);
+#ifdef TRACE_JCR_CHAIN
+static void b_lock_jcr_chain(const char *filen, int line);
+static void b_unlock_jcr_chain(const char *filen, int line);
+#define lock_jcr_chain() b_lock_jcr_chain(__FILE__, __LINE__);
+#define unlock_jcr_chain() b_unlock_jcr_chain(__FILE__, __LINE__);
+#else
+static void lock_jcr_chain();
+static void unlock_jcr_chain();
+#endif
+
int num_jobs_run;
dlist *last_jobs = NULL;
-#define MAX_LAST_JOBS 15
+const int max_last_jobs = 10;
+
+static dlist *jcrs = NULL; /* JCR chain */
+static pthread_mutex_t jcr_lock = PTHREAD_MUTEX_INITIALIZER;
+
+static pthread_mutex_t job_start_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+static pthread_mutex_t last_jobs_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+static pthread_key_t jcr_key; /* Pointer to jcr for each thread */
+
+pthread_once_t key_once = PTHREAD_ONCE_INIT;
+
-static JCR *jobs = NULL; /* pointer to JCR chain */
-static brwlock_t lock; /* lock for last jobs and JCR chain */
+void lock_jobs()
+{
+ P(job_start_mutex);
+}
+
+void unlock_jobs()
+{
+ V(job_start_mutex);
+}
void init_last_jobs_list()
{
- int errstat;
+ JCR *jcr = NULL;
struct s_last_job *job_entry = NULL;
if (!last_jobs) {
- last_jobs = new dlist(job_entry, &job_entry->link);
- if ((errstat=rwl_init(&lock)) != 0) {
- Emsg1(M_ABORT, 0, _("Unable to initialize jcr_chain lock. ERR=%s\n"),
- strerror(errstat));
- }
+ last_jobs = New(dlist(job_entry, &job_entry->link));
+ }
+ if (!jcrs) {
+ jcrs = New(dlist(jcr, &jcr->link));
}
-
}
void term_last_jobs_list()
{
- struct s_last_job *je;
if (last_jobs) {
- foreach_dlist(je, last_jobs) {
- free(je);
+ lock_last_jobs_list();
+ while (!last_jobs->empty()) {
+ void *je = last_jobs->first();
+ last_jobs->remove(je);
+ free(je);
}
delete last_jobs;
last_jobs = NULL;
- rwl_destroy(&lock);
+ unlock_last_jobs_list();
+ }
+ if (jcrs) {
+ delete jcrs;
+ jcrs = NULL;
}
}
-void read_last_jobs_list(int fd, uint64_t addr)
+bool read_last_jobs_list(int fd, uint64_t addr)
{
struct s_last_job *je, job;
uint32_t num;
+ bool ok = true;
- if (addr == 0 || lseek(fd, addr, SEEK_SET) < 0) {
- return;
+ Dmsg1(100, "read_last_jobs seek to %d\n", (int)addr);
+ if (addr == 0 || lseek(fd, (boffset_t)addr, SEEK_SET) < 0) {
+ return false;
}
- if (read(fd, &num, sizeof(num)) < 0) {
- return;
+ if (read(fd, &num, sizeof(num)) != sizeof(num)) {
+ return false;
}
- if (num > 4 * MAX_LAST_JOBS) { /* sanity check */
- return;
+ Dmsg1(100, "Read num_items=%d\n", num);
+ if (num > 4 * max_last_jobs) { /* sanity check */
+ return false;
}
+ lock_last_jobs_list();
for ( ; num; num--) {
- if (read(fd, &job, sizeof(job)) < 0) {
- return;
+ if (read(fd, &job, sizeof(job)) != sizeof(job)) {
+ berrno be;
+ Pmsg1(000, "Read job entry. ERR=%s\n", be.bstrerror());
+ ok = false;
+ break;
}
if (job.JobId > 0) {
- je = (struct s_last_job *)malloc(sizeof(struct s_last_job));
- memcpy((char *)je, (char *)&job, sizeof(job));
- if (!last_jobs) {
- init_last_jobs_list();
- }
- last_jobs->append(je);
- if (last_jobs->size() > MAX_LAST_JOBS) {
- last_jobs->remove(last_jobs->first());
- }
+ je = (struct s_last_job *)malloc(sizeof(struct s_last_job));
+ memcpy((char *)je, (char *)&job, sizeof(job));
+ if (!last_jobs) {
+ init_last_jobs_list();
+ }
+ last_jobs->append(je);
+ if (last_jobs->size() > max_last_jobs) {
+ je = (struct s_last_job *)last_jobs->first();
+ last_jobs->remove(je);
+ free(je);
+ }
}
}
+ unlock_last_jobs_list();
+ return ok;
}
uint64_t write_last_jobs_list(int fd, uint64_t addr)
{
struct s_last_job *je;
uint32_t num;
+ ssize_t stat;
- if (lseek(fd, addr, SEEK_SET) < 0) {
+ Dmsg1(100, "write_last_jobs seek to %d\n", (int)addr);
+ if (lseek(fd, (boffset_t)addr, SEEK_SET) < 0) {
return 0;
}
if (last_jobs) {
+ lock_last_jobs_list();
/* First record is number of entires */
num = last_jobs->size();
- if (write(fd, &num, sizeof(num)) < 0) {
- return 0;
+ if (write(fd, &num, sizeof(num)) != sizeof(num)) {
+ berrno be;
+ Pmsg1(000, "Error writing num_items: ERR=%s\n", be.bstrerror());
+ goto bail_out;
}
foreach_dlist(je, last_jobs) {
- if (write(fd, je, sizeof(struct s_last_job)) < 0) {
- return 0;
- }
+ if (write(fd, je, sizeof(struct s_last_job)) != sizeof(struct s_last_job)) {
+ berrno be;
+ Pmsg1(000, "Error writing job: ERR=%s\n", be.bstrerror());
+ goto bail_out;
+ }
}
+ unlock_last_jobs_list();
}
/* Return current address */
- ssize_t stat = lseek(fd, 0, SEEK_CUR);
+ stat = lseek(fd, 0, SEEK_CUR);
if (stat < 0) {
stat = 0;
}
return stat;
-
+
+bail_out:
+ unlock_last_jobs_list();
+ return 0;
}
-void lock_last_jobs_list()
+void lock_last_jobs_list()
{
- /* Use jcr chain mutex */
- lock_jcr_chain();
+ P(last_jobs_mutex);
}
-void unlock_last_jobs_list()
+void unlock_last_jobs_list()
{
- /* Use jcr chain mutex */
- unlock_jcr_chain();
+ V(last_jobs_mutex);
+}
+
+/* Get an ASCII representation of the Operation being performed as an english Noun */
+const char *JCR::get_OperationName()
+{
+ switch(m_JobType) {
+ case JT_BACKUP:
+ return _("Backup");
+ case JT_VERIFY:
+ return _("Verifying");
+ case JT_RESTORE:
+ return _("Restoring");
+ case JT_ARCHIVE:
+ return _("Archiving");
+ case JT_COPY:
+ return _("Copying");
+ case JT_MIGRATE:
+ return _("Migration");
+ case JT_SCAN:
+ return _("Scanning");
+ default:
+ return _("Unknown operation");
+ }
+}
+
+/* Get an ASCII representation of the Action being performed either an english Verb or Adjective */
+const char *JCR::get_ActionName(bool past)
+{
+ switch(m_JobType) {
+ case JT_BACKUP:
+ return _("backup");
+ case JT_VERIFY:
+ return (past == true) ? _("verified") : _("verify");
+ case JT_RESTORE:
+ return (past == true) ? _("restored") : _("restore");
+ case JT_ARCHIVE:
+ return (past == true) ? _("archived") : _("archive");
+ case JT_COPY:
+ return (past == true) ? _("copied") : _("copy");
+ case JT_MIGRATE:
+ return (past == true) ? _("migrated") : _("migrate");
+ case JT_SCAN:
+ return (past == true) ? _("scanned") : _("scan");
+ default:
+ return _("unknown action");
+ }
+}
+
+/* Set Job type in JCR and also set appropriate read flag */
+void JCR::set_JobType(int32_t JobType)
+{
+ m_JobType = JobType;
+}
+
+/* Set Job level in JCR and also set appropriate read flag */
+void JCR::set_JobLevel(int32_t JobLevel)
+{
+ m_JobLevel = JobLevel;
+}
+
+bool JCR::JobReads()
+{
+ switch (m_JobType) {
+ case JT_VERIFY:
+ case JT_RESTORE:
+ case JT_COPY:
+ case JT_MIGRATE:
+ return true;
+ case JT_BACKUP:
+ if (m_JobLevel == L_VIRTUAL_FULL) {
+ return true;
+ }
+ break;
+ default:
+ break;
+ }
+ return false;
+}
+
+/*
+ * Push a subroutine address into the job end callback stack
+ */
+void job_end_push(JCR *jcr, void job_end_cb(JCR *jcr,void *), void *ctx)
+{
+ jcr->job_end_push.append((void *)job_end_cb);
+ jcr->job_end_push.append(ctx);
+}
+
+/* Pop each job_end subroutine and call it */
+static void job_end_pop(JCR *jcr)
+{
+ void (*job_end_cb)(JCR *jcr, void *ctx);
+ void *ctx;
+ for (int i=jcr->job_end_push.size()-1; i > 0; ) {
+ ctx = jcr->job_end_push.get(i--);
+ job_end_cb = (void (*)(JCR *,void *))jcr->job_end_push.get(i--);
+ job_end_cb(jcr, ctx);
+ }
+}
+
+void create_jcr_key()
+{
+ int status = pthread_key_create(&jcr_key, NULL);
+ if (status != 0) {
+ berrno be;
+ Jmsg1(NULL, M_ABORT, 0, _("pthread key create failed: ERR=%s\n"),
+ be.bstrerror(status));
+ }
}
/*
JCR *jcr;
MQUEUE_ITEM *item = NULL;
struct sigaction sigtimer;
+ int status;
- Dmsg0(200, "Enter new_jcr\n");
+ Dmsg0(dbglvl, "Enter new_jcr\n");
+ status = pthread_once(&key_once, create_jcr_key);
+ if (status != 0) {
+ berrno be;
+ Jmsg1(NULL, M_ABORT, 0, _("pthread_once failed. ERR=%s\n"), be.bstrerror(status));
+ }
jcr = (JCR *)malloc(size);
memset(jcr, 0, size);
- jcr->msg_queue = new dlist(item, &item->link);
jcr->my_thread_id = pthread_self();
+ jcr->msg_queue = New(dlist(item, &item->link));
+ jcr->job_end_push.init(1, false);
jcr->sched_time = time(NULL);
jcr->daemon_free_jcr = daemon_free_jcr; /* plug daemon free routine */
- jcr->use_count = 1;
- pthread_mutex_init(&(jcr->mutex), NULL);
- jcr->JobStatus = JS_Created; /* ready to run */
+ jcr->init_mutex();
+ jcr->inc_use_count();
jcr->VolumeName = get_pool_memory(PM_FNAME);
jcr->VolumeName[0] = 0;
jcr->errmsg = get_pool_memory(PM_MESSAGE);
jcr->errmsg[0] = 0;
- strcpy(jcr->Job, "*Console*"); /* default */
-
+ /* Setup some dummy values */
+ bstrncpy(jcr->Job, "*System*", sizeof(jcr->Job));
+ jcr->JobId = 0;
+ jcr->set_JobType(JT_SYSTEM); /* internal job until defined */
+ jcr->set_JobLevel(L_NONE);
+ set_jcr_job_status(jcr, JS_Created); /* ready to run */
+ set_jcr_in_tsd(jcr);
sigtimer.sa_flags = 0;
sigtimer.sa_handler = timeout_handler;
sigfillset(&sigtimer.sa_mask);
sigaction(TIMEOUT_SIGNAL, &sigtimer, NULL);
+ /*
+ * Locking jobs is a global lock that is needed
+ * so that the Director can stop new jobs from being
+ * added to the jcr chain while it processes a new
+ * conf file and does the job_end_push().
+ */
+ lock_jobs();
lock_jcr_chain();
- jcr->prev = NULL;
- jcr->next = jobs;
- if (jobs) {
- jobs->prev = jcr;
+ if (!jcrs) {
+ jcrs = New(dlist(jcr, &jcr->link));
}
- jobs = jcr;
+ jcrs->append(jcr);
unlock_jcr_chain();
+ unlock_jobs();
+
return jcr;
}
/*
* Remove a JCR from the chain
* NOTE! The chain must be locked prior to calling
- * this routine.
+ * this routine.
*/
static void remove_jcr(JCR *jcr)
{
- Dmsg0(150, "Enter remove_jcr\n");
+ Dmsg0(dbglvl, "Enter remove_jcr\n");
if (!jcr) {
- Emsg0(M_ABORT, 0, "NULL jcr.\n");
- }
- if (!jcr->prev) { /* if no prev */
- jobs = jcr->next; /* set new head */
- } else {
- jcr->prev->next = jcr->next; /* update prev */
+ Emsg0(M_ABORT, 0, _("NULL jcr.\n"));
}
- if (jcr->next) {
- jcr->next->prev = jcr->prev;
- }
- Dmsg0(150, "Leave remove_jcr\n");
+ jcrs->remove(jcr);
+ Dmsg0(dbglvl, "Leave remove_jcr\n");
}
/*
* Free stuff common to all JCRs. N.B. Be careful to include only
- * generic stuff in the common part of the jcr.
+ * generic stuff in the common part of the jcr.
*/
static void free_common_jcr(JCR *jcr)
{
- struct s_last_job *je, last_job;
+ jcr->destroy_mutex();
- /* Keep some statistics */
- switch (jcr->JobType) {
- case JT_BACKUP:
- case JT_VERIFY:
- case JT_RESTORE:
- case JT_ADMIN:
- num_jobs_run++;
- last_job.JobType = jcr->JobType;
- last_job.JobId = jcr->JobId;
- last_job.VolSessionId = jcr->VolSessionId;
- last_job.VolSessionTime = jcr->VolSessionTime;
- bstrncpy(last_job.Job, jcr->Job, sizeof(last_job.Job));
- last_job.JobFiles = jcr->JobFiles;
- last_job.JobBytes = jcr->JobBytes;
- last_job.JobStatus = jcr->JobStatus;
- last_job.JobLevel = jcr->JobLevel;
- last_job.start_time = jcr->start_time;
- last_job.end_time = time(NULL);
- /* Keep list of last jobs, but not Console where JobId==0 */
- if (last_job.JobId > 0) {
- je = (struct s_last_job *)malloc(sizeof(struct s_last_job));
- memcpy((char *)je, (char *)&last_job, sizeof(last_job));
- if (!last_jobs) {
- init_last_jobs_list();
- }
- last_jobs->append(je);
- if (last_jobs->size() > MAX_LAST_JOBS) {
- last_jobs->remove(last_jobs->first());
- }
- }
- break;
- default:
- break;
+ if (jcr->msg_queue) {
+ delete jcr->msg_queue;
+ jcr->msg_queue = NULL;
}
- pthread_mutex_destroy(&jcr->mutex);
-
- close_msg(jcr); /* close messages for this job */
- delete jcr->msg_queue;
+ close_msg(jcr); /* close messages for this job */
/* do this after closing messages */
if (jcr->client_name) {
jcr->client_name = NULL;
}
+ if (jcr->attr) {
+ free_pool_memory(jcr->attr);
+ jcr->attr = NULL;
+ }
+
if (jcr->sd_auth_key) {
free(jcr->sd_auth_key);
jcr->sd_auth_key = NULL;
free(jcr->where);
jcr->where = NULL;
}
+ if (jcr->RegexWhere) {
+ free(jcr->RegexWhere);
+ jcr->RegexWhere = NULL;
+ }
+ if (jcr->where_bregexp) {
+ free_bregexps(jcr->where_bregexp);
+ delete jcr->where_bregexp;
+ jcr->where_bregexp = NULL;
+ }
if (jcr->cached_path) {
free_pool_memory(jcr->cached_path);
jcr->cached_path = NULL;
jcr->cached_pnl = 0;
}
- free_getuser_cache();
- free_getgroup_cache();
+ if (jcr->id_list) {
+ free_guid_list(jcr->id_list);
+ jcr->id_list = NULL;
+ }
+ /* Invalidate the tsd jcr data */
+ set_jcr_in_tsd(INVALID_JCR);
free(jcr);
}
-/*
+/*
* Global routine to free a jcr
*/
#ifdef DEBUG
void b_free_jcr(const char *file, int line, JCR *jcr)
{
- Dmsg3(200, "Enter free_jcr 0x%x from %s:%d\n", jcr, file, line);
+ struct s_last_job *je;
+
+ Dmsg3(dbglvl, "Enter free_jcr jid=%u from %s:%d\n", jcr->JobId, file, line);
#else
void free_jcr(JCR *jcr)
{
+ struct s_last_job *je;
- Dmsg1(200, "Enter free_jcr 0x%x\n", jcr);
+ Dmsg3(dbglvl, "Enter free_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
#endif
+ dequeue_messages(jcr);
lock_jcr_chain();
- jcr->use_count--; /* decrement use count */
- if (jcr->use_count < 0) {
- Emsg2(M_ERROR, 0, _("JCR use_count=%d JobId=%d\n"),
- jcr->use_count, jcr->JobId);
+ jcr->dec_use_count(); /* decrement use count */
+ if (jcr->use_count() < 0) {
+ Jmsg2(jcr, M_ERROR, 0, _("JCR use_count=%d JobId=%d\n"),
+ jcr->use_count(), jcr->JobId);
+ }
+ if (jcr->JobId > 0) {
+ Dmsg3(dbglvl, "Dec free_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
}
- Dmsg3(200, "Dec free_jcr 0x%x use_count=%d jobid=%d\n", jcr, jcr->use_count, jcr->JobId);
- if (jcr->use_count > 0) { /* if in use */
+ if (jcr->use_count() > 0) { /* if in use */
unlock_jcr_chain();
- Dmsg2(200, "free_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
return;
}
- remove_jcr(jcr);
+ if (jcr->JobId > 0) {
+ Dmsg3(dbglvl, "remove jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ }
+ remove_jcr(jcr); /* remove Jcr from chain */
+
+ job_end_pop(jcr); /* pop and call hooked routines */
+
+ Dmsg1(dbglvl, "End job=%d\n", jcr->JobId);
+
+ /* Keep some statistics */
+ switch (jcr->get_JobType()) {
+ case JT_BACKUP:
+ case JT_VERIFY:
+ case JT_RESTORE:
+ case JT_MIGRATE:
+ case JT_COPY:
+ case JT_ADMIN:
+ /* Keep list of last jobs, but not Console where JobId==0 */
+ if (jcr->JobId > 0) {
+ lock_last_jobs_list();
+ num_jobs_run++;
+ je = (struct s_last_job *)malloc(sizeof(struct s_last_job));
+ memset(je, 0, sizeof(struct s_last_job)); /* zero in case unset fields */
+ je->Errors = jcr->Errors;
+ je->JobType = jcr->get_JobType();
+ je->JobId = jcr->JobId;
+ je->VolSessionId = jcr->VolSessionId;
+ je->VolSessionTime = jcr->VolSessionTime;
+ bstrncpy(je->Job, jcr->Job, sizeof(je->Job));
+ je->JobFiles = jcr->JobFiles;
+ je->JobBytes = jcr->JobBytes;
+ je->JobStatus = jcr->JobStatus;
+ je->JobLevel = jcr->get_JobLevel();
+ je->start_time = jcr->start_time;
+ je->end_time = time(NULL);
+
+ if (!last_jobs) {
+ init_last_jobs_list();
+ }
+ last_jobs->append(je);
+ if (last_jobs->size() > max_last_jobs) {
+ je = (struct s_last_job *)last_jobs->first();
+ last_jobs->remove(je);
+ free(je);
+ }
+ unlock_last_jobs_list();
+ }
+ break;
+ default:
+ break;
+ }
- Dmsg1(200, "End job=%d\n", jcr->JobId);
if (jcr->daemon_free_jcr) {
jcr->daemon_free_jcr(jcr); /* call daemon free routine */
}
+ unlock_jcr_chain();
free_common_jcr(jcr);
+ close_msg(NULL); /* flush any daemon messages */
+ garbage_collect_memory_pool();
+ Dmsg0(dbglvl, "Exit free_jcr\n");
+}
- close_msg(NULL); /* flush any daemon messages */
- unlock_jcr_chain();
- Dmsg0(200, "Exit free_jcr\n");
+void set_jcr_in_tsd(JCR *jcr)
+{
+ int status = pthread_setspecific(jcr_key, (void *)jcr);
+ if (status != 0) {
+ berrno be;
+ Jmsg1(jcr, M_ABORT, 0, _("pthread_setspecific failed: ERR=%s\n"), be.bstrerror(status));
+ }
}
+JCR *get_jcr_from_tsd()
+{
+ JCR *jcr = (JCR *)pthread_getspecific(jcr_key);
+// printf("get_jcr_from_tsd: jcr=%p\n", jcr);
+ /* set any INVALID_JCR to NULL which the rest of Bacula understands */
+ if (jcr == INVALID_JCR) {
+ jcr = NULL;
+ }
+ return jcr;
+}
-/*
- * Global routine to free a jcr
- * JCR chain is already locked
+
+/*
+ * Find which JobId corresponds to the current thread
*/
-void free_locked_jcr(JCR *jcr)
+uint32_t get_jobid_from_tsd()
{
- jcr->use_count--; /* decrement use count */
- Dmsg2(200, "Dec free_locked_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
- if (jcr->use_count > 0) { /* if in use */
- return;
+ JCR *jcr;
+ uint32_t JobId = 0;
+ jcr = get_jcr_from_tsd();
+// printf("get_jobid_from_tsr: jcr=%p\n", jcr);
+ if (jcr) {
+ JobId = (uint32_t)jcr->JobId;
}
- remove_jcr(jcr);
- jcr->daemon_free_jcr(jcr); /* call daemon free routine */
- free_common_jcr(jcr);
+ return JobId;
}
-
-
-
/*
- * Given a JobId, find the JCR
+ * Given a JobId, find the JCR
* Returns: jcr on success
- * NULL on failure
+ * NULL on failure
*/
JCR *get_jcr_by_id(uint32_t JobId)
{
- JCR *jcr;
+ JCR *jcr;
- lock_jcr_chain(); /* lock chain */
- for (jcr = jobs; jcr; jcr=jcr->next) {
+ foreach_jcr(jcr) {
if (jcr->JobId == JobId) {
- P(jcr->mutex);
- jcr->use_count++;
- V(jcr->mutex);
- Dmsg2(200, "Inc get_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
- break;
+ jcr->inc_use_count();
+ Dmsg3(dbglvl, "Inc get_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ break;
}
}
- unlock_jcr_chain();
- return jcr;
+ endeach_jcr(jcr);
+ return jcr;
}
/*
- * Given a SessionId and SessionTime, find the JCR
+ * Given a SessionId and SessionTime, find the JCR
* Returns: jcr on success
- * NULL on failure
+ * NULL on failure
*/
JCR *get_jcr_by_session(uint32_t SessionId, uint32_t SessionTime)
{
- JCR *jcr;
+ JCR *jcr;
- lock_jcr_chain();
- for (jcr = jobs; jcr; jcr=jcr->next) {
- if (jcr->VolSessionId == SessionId &&
- jcr->VolSessionTime == SessionTime) {
- P(jcr->mutex);
- jcr->use_count++;
- V(jcr->mutex);
- Dmsg2(200, "Inc get_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
- break;
+ foreach_jcr(jcr) {
+ if (jcr->VolSessionId == SessionId &&
+ jcr->VolSessionTime == SessionTime) {
+ jcr->inc_use_count();
+ Dmsg3(dbglvl, "Inc get_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ break;
}
}
- unlock_jcr_chain();
- return jcr;
+ endeach_jcr(jcr);
+ return jcr;
}
/*
- * Given a Job, find the JCR
+ * Given a Job, find the JCR
* compares on the number of characters in Job
* thus allowing partial matches.
* Returns: jcr on success
- * NULL on failure
+ * NULL on failure
*/
JCR *get_jcr_by_partial_name(char *Job)
{
- JCR *jcr;
+ JCR *jcr;
int len;
if (!Job) {
return NULL;
}
- lock_jcr_chain();
len = strlen(Job);
- for (jcr = jobs; jcr; jcr=jcr->next) {
+ foreach_jcr(jcr) {
if (strncmp(Job, jcr->Job, len) == 0) {
- P(jcr->mutex);
- jcr->use_count++;
- V(jcr->mutex);
- Dmsg2(200, "Inc get_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
- break;
+ jcr->inc_use_count();
+ Dmsg3(dbglvl, "Inc get_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ break;
}
}
- unlock_jcr_chain();
- return jcr;
+ endeach_jcr(jcr);
+ return jcr;
}
/*
- * Given a Job, find the JCR
+ * Given a Job, find the JCR
* requires an exact match of names.
* Returns: jcr on success
- * NULL on failure
+ * NULL on failure
*/
JCR *get_jcr_by_full_name(char *Job)
{
- JCR *jcr;
+ JCR *jcr;
if (!Job) {
return NULL;
}
- lock_jcr_chain();
- for (jcr = jobs; jcr; jcr=jcr->next) {
+ foreach_jcr(jcr) {
if (strcmp(jcr->Job, Job) == 0) {
- P(jcr->mutex);
- jcr->use_count++;
- V(jcr->mutex);
- Dmsg2(200, "Inc get_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
- break;
+ jcr->inc_use_count();
+ Dmsg3(dbglvl, "Inc get_jcr jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ break;
}
}
- unlock_jcr_chain();
- return jcr;
+ endeach_jcr(jcr);
+ return jcr;
}
-void set_jcr_job_status(JCR *jcr, int JobStatus)
+/*
+ * Priority runs from 0 (lowest) to 10 (highest)
+ */
+static int get_status_priority(int JobStatus)
{
- /*
- * For a set of errors, ... keep the current status
- * so it isn't lost. For all others, set it.
- */
- switch (jcr->JobStatus) {
+ int priority = 0;
+ switch (JobStatus) {
case JS_ErrorTerminated:
- case JS_Error:
case JS_FatalError:
- case JS_Differences:
+ priority = 10;
+ break;
case JS_Canceled:
+ priority = 9;
+ break;
+ case JS_Error:
+ priority = 8;
+ break;
+ case JS_Differences:
+ priority = 7;
+ break;
+ }
+ return priority;
+}
+
+
+static void update_wait_time(JCR *jcr, int newJobStatus)
+{
+ bool enter_in_waittime;
+ int oldJobStatus = jcr->JobStatus;
+
+ switch (newJobStatus) {
+ case JS_WaitFD:
+ case JS_WaitSD:
+ case JS_WaitMedia:
+ case JS_WaitMount:
+ case JS_WaitStoreRes:
+ case JS_WaitJobRes:
+ case JS_WaitClientRes:
+ case JS_WaitMaxJobs:
+ case JS_WaitPriority:
+ enter_in_waittime = true;
break;
default:
- jcr->JobStatus = JobStatus;
+ enter_in_waittime = false; /* not a Wait situation */
+ break;
+ }
+
+ /*
+ * If we were previously waiting and are not any more
+ * we want to update the wait_time variable, which is
+ * the start of waiting.
+ */
+ switch (oldJobStatus) {
+ case JS_WaitFD:
+ case JS_WaitSD:
+ case JS_WaitMedia:
+ case JS_WaitMount:
+ case JS_WaitStoreRes:
+ case JS_WaitJobRes:
+ case JS_WaitClientRes:
+ case JS_WaitMaxJobs:
+ case JS_WaitPriority:
+ if (!enter_in_waittime) { /* we get out the wait time */
+ jcr->wait_time_sum += (time(NULL) - jcr->wait_time);
+ jcr->wait_time = 0;
+ }
+ break;
+
+ /* if wait state is new, we keep current time for watchdog MaxWaitTime */
+ default:
+ if (enter_in_waittime) {
+ jcr->wait_time = time(NULL);
+ }
+ break;
}
}
-/*
+void set_jcr_job_status(JCR *jcr, int JobStatus)
+{
+ int priority, old_priority;
+ int oldJobStatus = jcr->JobStatus;
+ priority = get_status_priority(JobStatus);
+ old_priority = get_status_priority(oldJobStatus);
+
+ Dmsg2(800, "set_jcr_job_status(%s, %c)\n", jcr->Job, JobStatus);
+
+ /* Update wait_time depending on newJobStatus and oldJobStatus */
+ update_wait_time(jcr, JobStatus);
+
+ /*
+ * For a set of errors, ... keep the current status
+ * so it isn't lost. For all others, set it.
+ */
+ Dmsg3(300, "jid=%u OnEntry JobStatus=%c set=%c\n", (uint32_t)jcr->JobId,
+ jcr->JobStatus, JobStatus);
+ if (priority >= old_priority) {
+ jcr->JobStatus = JobStatus; /* replace with new priority */
+ }
+
+ if (oldJobStatus != jcr->JobStatus) {
+ Dmsg3(200, "jid=%u leave set_old_job_status=%c new_set=%c\n", (uint32_t)jcr->JobId,
+ oldJobStatus, JobStatus);
+// generate_plugin_event(jcr, bEventStatusChange, NULL);
+ }
+}
+
+#ifdef TRACE_JCR_CHAIN
+static int lock_count = 0;
+#endif
+
+/*
* Lock the chain
*/
-void lock_jcr_chain()
+#ifdef TRACE_JCR_CHAIN
+static void b_lock_jcr_chain(const char *fname, int line)
+#else
+static void lock_jcr_chain()
+#endif
{
- int errstat;
- if ((errstat=rwl_writelock(&lock)) != 0) {
- Emsg1(M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
- strerror(errstat));
- }
+#ifdef TRACE_JCR_CHAIN
+ Dmsg3(dbglvl, "Lock jcr chain %d from %s:%d\n", ++lock_count, fname, line);
+#endif
+ P(jcr_lock);
}
/*
* Unlock the chain
*/
-void unlock_jcr_chain()
+#ifdef TRACE_JCR_CHAIN
+static void b_unlock_jcr_chain(const char *fname, int line)
+#else
+static void unlock_jcr_chain()
+#endif
{
- int errstat;
- if ((errstat=rwl_writeunlock(&lock)) != 0) {
- Emsg1(M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
- strerror(errstat));
- }
+#ifdef TRACE_JCR_CHAIN
+ Dmsg3(dbglvl, "Unlock jcr chain %d from %s:%d\n", lock_count--, fname, line);
+#endif
+ V(jcr_lock);
}
+/*
+ * Start walk of jcr chain
+ * The proper way to walk the jcr chain is:
+ * JCR *jcr;
+ * foreach_jcr(jcr) {
+ * ...
+ * }
+ * endeach_jcr(jcr);
+ *
+ * It is possible to leave out the endeach_jcr(jcr), but
+ * in that case, the last jcr referenced must be explicitly
+ * released with:
+ *
+ * free_jcr(jcr);
+ *
+ */
+JCR *jcr_walk_start()
+{
+ JCR *jcr;
+ lock_jcr_chain();
+ jcr = (JCR *)jcrs->first();
+ if (jcr) {
+ jcr->inc_use_count();
+ if (jcr->JobId > 0) {
+ Dmsg3(dbglvl, "Inc walk_start jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ }
+ }
+ unlock_jcr_chain();
+ return jcr;
+}
-JCR *get_next_jcr(JCR *prev_jcr)
+/*
+ * Get next jcr from chain, and release current one
+ */
+JCR *jcr_walk_next(JCR *prev_jcr)
{
JCR *jcr;
- if (prev_jcr == NULL) {
- jcr = jobs;
- } else {
- jcr = prev_jcr->next;
- }
+ lock_jcr_chain();
+ jcr = (JCR *)jcrs->next(prev_jcr);
if (jcr) {
- P(jcr->mutex);
- jcr->use_count++;
- V(jcr->mutex);
- Dmsg2(200, "Inc get_next_jcr 0x%x use_count=%d\n", jcr, jcr->use_count);
+ jcr->inc_use_count();
+ if (jcr->JobId > 0) {
+ Dmsg3(dbglvl, "Inc walk_next jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ }
+ }
+ unlock_jcr_chain();
+ if (prev_jcr) {
+ free_jcr(prev_jcr);
}
return jcr;
}
+/*
+ * Release last jcr referenced
+ */
+void jcr_walk_end(JCR *jcr)
+{
+ if (jcr) {
+ if (jcr->JobId > 0) {
+ Dmsg3(dbglvl, "Free walk_end jid=%u use_count=%d Job=%s\n",
+ jcr->JobId, jcr->use_count(), jcr->Job);
+ }
+ free_jcr(jcr);
+ }
+}
+
+
+/*
+ * Setup to call the timeout check routine every 30 seconds
+ * This routine will check any timers that have been enabled.
+ */
bool init_jcr_subsystem(void)
{
watchdog_t *wd = new_watchdog();
wd->one_shot = false;
- wd->interval = 30; /* FIXME: should be configurable somewhere, even
- if only with a #define */
+ wd->interval = 30; /* FIXME: should be configurable somewhere, even
+ if only with a #define */
wd->callback = jcr_timeout_check;
register_watchdog(wd);
static void jcr_timeout_check(watchdog_t *self)
{
JCR *jcr;
- BSOCK *fd;
+ BSOCK *bs;
time_t timer_start;
- Dmsg0(400, "Start JCR timeout checks\n");
+ Dmsg0(dbglvl, "Start JCR timeout checks\n");
- /* Walk through all JCRs checking if any one is
+ /* Walk through all JCRs checking if any one is
* blocked for more than specified max time.
*/
- lock_jcr_chain();
foreach_jcr(jcr) {
- free_locked_jcr(jcr); /* OK to free now cuz chain is locked */
+ Dmsg2(dbglvl, "jcr_timeout_check JobId=%u jcr=0x%x\n", jcr->JobId, jcr);
if (jcr->JobId == 0) {
- continue;
+ continue;
}
- fd = jcr->store_bsock;
- if (fd) {
- timer_start = fd->timer_start;
- if (timer_start && (watchdog_time - timer_start) > fd->timeout) {
- fd->timer_start = 0; /* turn off timer */
- fd->timed_out = TRUE;
- Jmsg(jcr, M_ERROR, 0, _(
+ bs = jcr->store_bsock;
+ if (bs) {
+ timer_start = bs->timer_start;
+ if (timer_start && (watchdog_time - timer_start) > bs->timeout) {
+ bs->timer_start = 0; /* turn off timer */
+ bs->set_timed_out();
+ Qmsg(jcr, M_ERROR, 0, _(
"Watchdog sending kill after %d secs to thread stalled reading Storage daemon.\n"),
- watchdog_time - timer_start);
- pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
- }
+ watchdog_time - timer_start);
+ pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
+ }
}
- fd = jcr->file_bsock;
- if (fd) {
- timer_start = fd->timer_start;
- if (timer_start && (watchdog_time - timer_start) > fd->timeout) {
- fd->timer_start = 0; /* turn off timer */
- fd->timed_out = TRUE;
- Jmsg(jcr, M_ERROR, 0, _(
+ bs = jcr->file_bsock;
+ if (bs) {
+ timer_start = bs->timer_start;
+ if (timer_start && (watchdog_time - timer_start) > bs->timeout) {
+ bs->timer_start = 0; /* turn off timer */
+ bs->set_timed_out();
+ Qmsg(jcr, M_ERROR, 0, _(
"Watchdog sending kill after %d secs to thread stalled reading File daemon.\n"),
- watchdog_time - timer_start);
- pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
- }
+ watchdog_time - timer_start);
+ pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
+ }
}
- fd = jcr->dir_bsock;
- if (fd) {
- timer_start = fd->timer_start;
- if (timer_start && (watchdog_time - timer_start) > fd->timeout) {
- fd->timer_start = 0; /* turn off timer */
- fd->timed_out = TRUE;
- Jmsg(jcr, M_ERROR, 0, _(
+ bs = jcr->dir_bsock;
+ if (bs) {
+ timer_start = bs->timer_start;
+ if (timer_start && (watchdog_time - timer_start) > bs->timeout) {
+ bs->timer_start = 0; /* turn off timer */
+ bs->set_timed_out();
+ Qmsg(jcr, M_ERROR, 0, _(
"Watchdog sending kill after %d secs to thread stalled reading Director.\n"),
- watchdog_time - timer_start);
- pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
- }
+ watchdog_time - timer_start);
+ pthread_kill(jcr->my_thread_id, TIMEOUT_SIGNAL);
+ }
}
-
}
- unlock_jcr_chain();
+ endeach_jcr(jcr);
- Dmsg0(200, "Finished JCR timeout checks\n");
+ Dmsg0(dbglvl, "Finished JCR timeout checks\n");
}
/*
* Timeout signal comes here
*/
-static void timeout_handler(int sig)
+extern "C" void timeout_handler(int sig)
{
- return; /* thus interrupting the function */
+ return; /* thus interrupting the function */
}
+
+/* Used to display specific daemon information after a fatal signal
+ * (like B_DB in the director)
+ */
+#define MAX_DBG_HOOK 10
+static dbg_jcr_hook_t *dbg_jcr_hooks[MAX_DBG_HOOK];
+static int dbg_jcr_handler_count;
+
+void dbg_jcr_add_hook(dbg_jcr_hook_t *fct)
+{
+ ASSERT(dbg_jcr_handler_count < MAX_DBG_HOOK);
+ dbg_jcr_hooks[dbg_jcr_handler_count++] = fct;
+}
+
+/*
+ * !!! WARNING !!!
+ *
+ * This function should be used ONLY after a fatal signal. We walk through the
+ * JCR chain without doing any lock, bacula should not be running.
+ */
+void _dbg_print_jcr(FILE *fp)
+{
+ char buf1[128], buf2[128], buf3[128], buf4[128];
+ if (!jcrs) {
+ return;
+ }
+
+ fprintf(fp, "Attempt to dump current JCRs\n");
+
+ for (JCR *jcr = (JCR *)jcrs->first(); jcr ; jcr = (JCR *)jcrs->next(jcr)) {
+ if (!jcr) { /* protect us against something ? */
+ continue;
+ }
+
+ fprintf(fp, "JCR=%p JobId=%i name=%s JobStatus=%c\n",
+ jcr, jcr->JobId, jcr->Job, jcr->JobStatus);
+#ifdef HAVE_WIN32
+ fprintf(fp, "\tuse_count=%i\n",
+ jcr->use_count());
+#else
+ fprintf(fp, "\tuse_count=%i threadid=0x%x\n",
+ jcr->use_count(), (int)jcr->my_thread_id);
+#endif
+ fprintf(fp, "\tJobType=%c JobLevel=%c\n",
+ jcr->get_JobType(), jcr->get_JobLevel());
+ bstrftime(buf1, sizeof(buf1), jcr->sched_time);
+ bstrftime(buf2, sizeof(buf2), jcr->start_time);
+ bstrftime(buf3, sizeof(buf3), jcr->end_time);
+ bstrftime(buf4, sizeof(buf4), jcr->wait_time);
+ fprintf(fp, "\tsched_time=%s start_time=%s\n\tend_time=%s wait_time=%s\n",
+ buf1, buf2, buf3, buf4);
+ fprintf(fp, "\tdequeing=%i\n", jcr->dequeuing);
+ fprintf(fp, "\tdb=%p db_batch=%p batch_started=%i\n",
+ jcr->db, jcr->db_batch, jcr->batch_started);
+
+ for(int i=0; i < dbg_jcr_handler_count; i++) {
+ dbg_jcr_hook_t *fct = dbg_jcr_hooks[i];
+ fct(jcr, fp);
+ }
+ }
+}
+