2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 two of the GNU 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 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 * Miscellaneous Bacula memory and thread safe routines
30 * Generally, these are interfaces to system or standard
33 * Bacula utility functions are in util.c
41 static pthread_mutex_t timer_mutex = PTHREAD_MUTEX_INITIALIZER;
42 static pthread_cond_t timer = PTHREAD_COND_INITIALIZER;
45 * This routine will sleep (sec, microsec). Note, however, that if a
46 * signal occurs, it will return early. It is up to the caller
47 * to recall this routine if he/she REALLY wants to sleep the
50 int bmicrosleep(int32_t sec, int32_t usec)
52 struct timespec timeout;
58 timeout.tv_nsec = usec * 1000;
61 stat = nanosleep(&timeout, NULL);
62 if (!(stat < 0 && errno == ENOSYS)) {
65 /* If we reach here it is because nanosleep is not supported by the OS */
68 /* Do it the old way */
69 gettimeofday(&tv, &tz);
70 timeout.tv_nsec += tv.tv_usec * 1000;
71 timeout.tv_sec += tv.tv_sec;
72 while (timeout.tv_nsec >= 1000000000) {
73 timeout.tv_nsec -= 1000000000;
77 Dmsg2(200, "pthread_cond_timedwait sec=%lld usec=%d\n", sec, usec);
78 /* Note, this unlocks mutex during the sleep */
80 stat = pthread_cond_timedwait(&timer, &timer_mutex, &timeout);
83 Dmsg2(200, "pthread_cond_timedwait stat=%d ERR=%s\n", stat,
91 * Guarantee that the string is properly terminated */
92 char *bstrncpy(char *dest, const char *src, int maxlen)
94 strncpy(dest, src, maxlen-1);
100 * Guarantee that the string is properly terminated */
101 char *bstrncpy(char *dest, POOL_MEM &src, int maxlen)
103 strncpy(dest, src.c_str(), maxlen-1);
108 char *bstrncat(char *dest, const char *src, int maxlen)
110 int len = strlen(dest);
111 if (len < maxlen-1) {
112 strncpy(dest+len, src, maxlen-len-1);
119 * Note: Here the maxlen is the maximum length permitted
120 * stored in dest, while on Unix systems, it is the maximum characters
121 * that may be copied from src.
123 char *bstrncat(char *dest, POOL_MEM &src, int maxlen)
125 int len = strlen(dest);
126 if (len < maxlen-1) {
127 strncpy(dest+len, src.c_str(), maxlen-len-1);
134 * Allows one or both pointers to be NULL
136 bool bstrcmp(const char *s1, const char *s2)
138 if (s1 == s2) return true;
139 if (s1 == NULL || s2 == NULL) return false;
140 return strcmp(s1, s2) == 0;
144 * Get character length of UTF-8 string
147 * U-00000000 - U-0000007F: 0xxxxxxx
148 * U-00000080 - U-000007FF: 110xxxxx 10xxxxxx
149 * U-00000800 - U-0000FFFF: 1110xxxx 10xxxxxx 10xxxxxx
150 * U-00010000 - U-001FFFFF: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
151 * U-00200000 - U-03FFFFFF: 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
152 * U-04000000 - U-7FFFFFFF: 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
154 int cstrlen(const char *str)
156 uint8_t *p = (uint8_t *)str;
159 if ((*p & 0xC0) != 0xC0) {
164 if ((*p & 0xD0) == 0xC0) {
169 if ((*p & 0xF0) == 0xD0) {
174 if ((*p & 0xF8) == 0xF0) {
179 if ((*p & 0xFC) == 0xF8) {
184 if ((*p & 0xFE) == 0xFC) {
189 p++; /* Shouln't get here but must advance */
197 void *bmalloc(size_t size)
202 buf = sm_malloc(file, line, size);
208 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), be.bstrerror());
214 void *b_malloc(const char *file, int line, size_t size)
219 buf = sm_malloc(file, line, size);
225 e_msg(file, line, M_ABORT, 0, _("Out of memory: ERR=%s\n"), be.bstrerror());
231 void bfree(void *buf)
234 sm_free(__FILE__, __LINE__, buf);
240 void *brealloc (void *buf, size_t size)
243 buf = sm_realloc(__FILE__, __LINE__, buf, size);
245 buf = realloc(buf, size);
249 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), be.bstrerror());
255 void *bcalloc(size_t size1, size_t size2)
259 buf = calloc(size1, size2);
262 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), be.bstrerror());
267 /* Code now in src/lib/bsnprintf.c */
268 #ifndef USE_BSNPRINTF
274 int bsnprintf(char *str, int32_t size, const char *fmt, ...)
279 va_start(arg_ptr, fmt);
280 len = bvsnprintf(str, size, fmt, arg_ptr);
286 * Implement vsnprintf()
288 int bvsnprintf(char *str, int32_t size, const char *format, va_list ap)
290 #ifdef HAVE_VSNPRINTF
292 len = vsnprintf(str, size, format, ap);
300 buflen = size > BIG_BUF ? size : BIG_BUF;
301 buf = get_memory(buflen);
302 len = vsprintf(buf, format, ap);
304 Emsg0(M_ABORT, 0, _("Buffer overflow.\n"));
306 memcpy(str, buf, len);
307 str[len] = 0; /* len excludes the null */
312 #endif /* USE_BSNPRINTF */
314 #ifndef HAVE_LOCALTIME_R
316 struct tm *localtime_r(const time_t *timep, struct tm *tm)
318 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
322 ltm = localtime(timep);
324 memcpy(tm, ltm, sizeof(struct tm));
327 return ltm ? tm : NULL;
329 #endif /* HAVE_LOCALTIME_R */
331 #ifndef HAVE_READDIR_R
335 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result)
337 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
343 ndir = readdir(dirp);
346 memcpy(entry, ndir, sizeof(struct dirent));
347 strcpy(entry->d_name, ndir->d_name);
357 #endif /* HAVE_READDIR_R */
360 int b_strerror(int errnum, char *buf, size_t bufsiz)
362 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
368 msg = strerror(errnum);
370 msg = _("Bad errno");
373 bstrncpy(buf, msg, bufsiz);
379 /* These routines are not normally turned on */
381 void b_memset(const char *file, int line, void *mem, int val, size_t num)
383 /* Testing for 2000 byte zero at beginning of Volume block */
384 if (num > 1900 && num < 3000) {
385 Pmsg3(000, _("Memset for %d bytes at %s:%d\n"), (int)num, file, line);
387 memset(mem, val, num);
391 #if !defined(HAVE_WIN32)
392 static int del_pid_file_ok = FALSE;
396 * Create a standard "Unix" pid file.
398 void create_pid_file(char *dir, const char *progname, int port)
400 #if !defined(HAVE_WIN32)
404 POOLMEM *fname = get_pool_memory(PM_FNAME);
407 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
408 if (stat(fname, &statp) == 0) {
409 /* File exists, see what we have */
411 if ((pidfd = open(fname, O_RDONLY|O_BINARY, 0)) < 0 ||
412 read(pidfd, &pidbuf, sizeof(pidbuf)) < 0 ||
413 sscanf(pidbuf, "%d", &oldpid) != 1) {
415 Emsg2(M_ERROR_TERM, 0, _("Cannot open pid file. %s ERR=%s\n"), fname,
418 /* Some OSes (IRIX) don't bother to clean out the old pid files after a crash, and
419 * since they use a deterministic algorithm for assigning PIDs, we can have
420 * pid conflicts with the old PID file after a reboot.
421 * The intent the following code is to check if the oldpid read from the pid
422 * file is the same as the currently executing process's pid,
423 * and if oldpid == getpid(), skip the attempt to
424 * kill(oldpid,0), since the attempt is guaranteed to succeed,
425 * but the success won't actually mean that there is an
426 * another Bacula process already running.
427 * For more details see bug #797.
429 if ((oldpid != (int)getpid()) && (kill(oldpid, 0) != -1 || errno != ESRCH)) {
430 Emsg3(M_ERROR_TERM, 0, _("%s is already running. pid=%d\nCheck file %s\n"),
431 progname, oldpid, fname);
433 /* He is not alive, so take over file ownership */
434 unlink(fname); /* remove stale pid file */
436 /* Create new pid file */
437 if ((pidfd = open(fname, O_CREAT|O_TRUNC|O_WRONLY|O_BINARY, 0640)) >= 0) {
438 len = sprintf(pidbuf, "%d\n", (int)getpid());
439 write(pidfd, pidbuf, len);
441 del_pid_file_ok = TRUE; /* we created it so we can delete it */
444 Emsg2(M_ERROR_TERM, 0, _("Could not open pid file. %s ERR=%s\n"), fname,
447 free_pool_memory(fname);
453 * Delete the pid file if we created it
455 int delete_pid_file(char *dir, const char *progname, int port)
457 #if !defined(HAVE_WIN32)
458 POOLMEM *fname = get_pool_memory(PM_FNAME);
460 if (!del_pid_file_ok) {
461 free_pool_memory(fname);
464 del_pid_file_ok = FALSE;
465 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
467 free_pool_memory(fname);
475 uint64_t last_jobs_addr;
476 uint64_t reserved[20];
479 static struct s_state_hdr state_hdr = {
486 * Open and read the state file for the daemon
488 void read_state_file(char *dir, const char *progname, int port)
493 POOLMEM *fname = get_pool_memory(PM_FNAME);
494 struct s_state_hdr hdr;
495 int hdr_size = sizeof(hdr);
497 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
498 /* If file exists, see what we have */
499 // Dmsg1(10, "O_BINARY=%d\n", O_BINARY);
500 if ((sfd = open(fname, O_RDONLY|O_BINARY)) < 0) {
502 Dmsg3(010, "Could not open state file. sfd=%d size=%d: ERR=%s\n",
503 sfd, sizeof(hdr), be.bstrerror());
506 if ((stat=read(sfd, &hdr, hdr_size)) != hdr_size) {
508 Dmsg4(010, "Could not read state file. sfd=%d stat=%d size=%d: ERR=%s\n",
509 sfd, (int)stat, hdr_size, be.bstrerror());
512 if (hdr.version != state_hdr.version) {
513 Dmsg2(010, "Bad hdr version. Wanted %d got %d\n",
514 state_hdr.version, hdr.version);
518 if (strcmp(hdr.id, state_hdr.id) != 0) {
519 Dmsg0(000, "State file header id invalid.\n");
522 // Dmsg1(010, "Read header of %d bytes.\n", sizeof(hdr));
523 if (!read_last_jobs_list(sfd, hdr.last_jobs_addr)) {
534 free_pool_memory(fname);
538 * Write the state file
540 void write_state_file(char *dir, const char *progname, int port)
544 POOLMEM *fname = get_pool_memory(PM_FNAME);
546 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
547 /* Create new state file */
549 if ((sfd = open(fname, O_CREAT|O_WRONLY|O_BINARY, 0640)) < 0) {
551 Dmsg2(000, "Could not create state file. %s ERR=%s\n", fname, be.bstrerror());
552 Emsg2(M_ERROR, 0, _("Could not create state file. %s ERR=%s\n"), fname, be.bstrerror());
555 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
557 Dmsg1(000, "Write hdr error: ERR=%s\n", be.bstrerror());
560 // Dmsg1(010, "Wrote header of %d bytes\n", sizeof(state_hdr));
561 state_hdr.last_jobs_addr = sizeof(state_hdr);
562 state_hdr.reserved[0] = write_last_jobs_list(sfd, state_hdr.last_jobs_addr);
563 // Dmsg1(010, "write last job end = %d\n", (int)state_hdr.reserved[0]);
564 if (lseek(sfd, 0, SEEK_SET) < 0) {
566 Dmsg1(000, "lseek error: ERR=%s\n", be.bstrerror());
569 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
571 Pmsg1(000, _("Write final hdr error: ERR=%s\n"), be.bstrerror());
575 // Dmsg1(010, "rewrote header = %d\n", sizeof(state_hdr));
583 free_pool_memory(fname);
587 /* BSDI does not have this. This is a *poor* simulation */
590 strtoll(const char *ptr, char **endptr, int base)
592 return (long long int)strtod(ptr, endptr);
597 * Bacula's implementation of fgets(). The difference is that it handles
598 * being interrupted by a signal (e.g. a SIGCHLD).
601 char *bfgets(char *s, int size, FILE *fd)
606 for (int i=0; i < size-1; i++) {
610 } while (ch == EOF && ferror(fd) && (errno == EINTR || errno == EAGAIN));
620 if (ch == '\r') { /* Support for Mac/Windows file format */
622 if (ch != '\n') { /* Mac (\r only) */
623 (void)ungetc(ch, fd); /* Push next character back to fd */
636 * Make a "unique" filename. It is important that if
637 * called again with the same "what" that the result
638 * will be identical. This allows us to use the file
639 * without saving its name, and re-generate the name
640 * so that it can be deleted.
642 void make_unique_filename(POOLMEM **name, int Id, char *what)
644 Mmsg(name, "%s/%s.%s.%d.tmp", working_directory, my_name, what, Id);
647 char *escape_filename(const char *file_path)
649 if (file_path == NULL || strpbrk(file_path, "\"\\") == NULL) {
653 char *escaped_path = (char *)bmalloc(2 * (strlen(file_path) + 1));
654 char *cur_char = escaped_path;
657 if (*file_path == '\\' || *file_path == '"') {
661 *cur_char++ = *file_path++;