2 * Miscellaneous Bacula memory and thread safe routines
3 * Generally, these are interfaces to system or standard
6 * Bacula utility functions are in util.c
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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.
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.
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,
40 * Guarantee that the string is properly terminated */
41 char *bstrncpy(char *dest, const char *src, int maxlen)
43 strncpy(dest, src, maxlen-1);
49 * Guarantee that the string is properly terminated */
50 char *bstrncpy(char *dest, POOL_MEM &src, int maxlen)
52 strncpy(dest, src.c_str(), maxlen-1);
58 char *bstrncat(char *dest, const char *src, int maxlen)
60 strncat(dest, src, maxlen-1);
65 char *bstrncat(char *dest, POOL_MEM &src, int maxlen)
67 strncat(dest, src.c_str(), maxlen-1);
75 void *bmalloc(size_t size)
81 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
87 void *b_malloc(const char *file, int line, size_t size)
92 buf = sm_malloc(file, line, size);
97 e_msg(file, line, M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
103 void *brealloc (void *buf, size_t size)
105 buf = realloc(buf, size);
107 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
113 void *bcalloc (size_t size1, size_t size2)
117 buf = calloc(size1, size2);
119 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
129 int bsnprintf(char *str, int32_t size, const char *fmt, ...)
134 va_start(arg_ptr, fmt);
135 len = bvsnprintf(str, size, fmt, arg_ptr);
141 * Implement vsnprintf()
143 int bvsnprintf(char *str, int32_t size, const char *format, va_list ap)
145 #ifdef HAVE_VSNPRINTF
147 len = vsnprintf(str, size, format, ap);
155 buf = get_memory(BIG_BUF);
156 len = vsprintf(buf, format, ap);
157 if (len >= BIG_BUF) {
158 Emsg0(M_ABORT, 0, _("Buffer overflow.\n"));
160 memcpy(str, buf, size);
167 #ifndef HAVE_LOCALTIME_R
169 struct tm *localtime_r(const time_t *timep, struct tm *tm)
171 static pthread_mutex_t mutex;
172 static int first = 1;
176 pthread_mutex_init(&mutex, NULL);
180 ltm = localtime(timep);
182 memcpy(tm, ltm, sizeof(struct tm));
185 return ltm ? tm : NULL;
187 #endif /* HAVE_LOCALTIME_R */
189 #ifndef HAVE_READDIR_R
193 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result)
195 static pthread_mutex_t mutex;
196 static int first = 1;
201 pthread_mutex_init(&mutex, NULL);
206 ndir = readdir(dirp);
209 memcpy(entry, ndir, sizeof(struct dirent));
210 strcpy(entry->d_name, ndir->d_name);
220 #endif /* HAVE_READDIR_R */
223 int bstrerror(int errnum, char *buf, size_t bufsiz)
225 static pthread_mutex_t mutex;
226 static int first = 1;
231 pthread_mutex_init(&mutex, NULL);
236 msg = strerror(errnum);
238 msg = _("Bad errno");
241 bstrncpy(buf, msg, bufsiz);
247 * These are mutex routines that do error checking
248 * for deadlock and such. Normally not turned on.
251 void _p(char *file, int line, pthread_mutex_t *m)
254 if ((errstat = pthread_mutex_trylock(m))) {
255 e_msg(file, line, M_ERROR, 0, _("Possible mutex deadlock.\n"));
256 /* We didn't get the lock, so do it definitely now */
257 if ((errstat=pthread_mutex_lock(m))) {
258 e_msg(file, line, M_ABORT, 0, _("Mutex lock failure. ERR=%s\n"),
261 e_msg(file, line, M_ERROR, 0, _("Possible mutex deadlock resolved.\n"));
267 void _v(char *file, int line, pthread_mutex_t *m)
271 if ((errstat=pthread_mutex_trylock(m)) == 0) {
272 e_msg(file, line, M_ERROR, 0, _("Mutex unlock not locked. ERR=%s\n"),
275 if ((errstat=pthread_mutex_unlock(m))) {
276 e_msg(file, line, M_ABORT, 0, _("Mutex unlock failure. ERR=%s\n"),
280 #endif /* DEBUG_MUTEX */
283 /* These routines are not normally turned on */
285 void b_memset(const char *file, int line, void *mem, int val, size_t num)
287 /* Testing for 2000 byte zero at beginning of Volume block */
288 if (num > 1900 && num < 3000) {
289 Pmsg3(000, "Memset for %d bytes at %s:%d\n", (int)num, file, line);
291 memset(mem, val, num);
295 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
296 static int del_pid_file_ok = FALSE;
300 * Create a standard "Unix" pid file.
302 void create_pid_file(char *dir, const char *progname, int port)
304 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
308 POOLMEM *fname = get_pool_memory(PM_FNAME);
311 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
312 if (stat(mp_chr(fname), &statp) == 0) {
313 /* File exists, see what we have */
315 if ((pidfd = open(mp_chr(fname), O_RDONLY|O_BINARY, 0)) < 0 ||
316 read(pidfd, &pidbuf, sizeof(pidbuf)) < 0 ||
317 sscanf(pidbuf, "%d", &oldpid) != 1) {
318 Emsg2(M_ERROR_TERM, 0, _("Cannot open pid file. %s ERR=%s\n"), fname, strerror(errno));
320 /* See if other Bacula is still alive */
321 if (kill(oldpid, 0) != -1 || errno != ESRCH) {
322 Emsg3(M_ERROR_TERM, 0, _("%s is already running. pid=%d\nCheck file %s\n"),
323 progname, oldpid, fname);
325 /* He is not alive, so take over file ownership */
326 unlink(mp_chr(fname)); /* remove stale pid file */
328 /* Create new pid file */
329 if ((pidfd = open(mp_chr(fname), O_CREAT|O_TRUNC|O_WRONLY|O_BINARY, 0640)) >= 0) {
330 len = sprintf(pidbuf, "%d\n", (int)getpid());
331 write(pidfd, pidbuf, len);
333 del_pid_file_ok = TRUE; /* we created it so we can delete it */
335 Emsg2(M_ERROR_TERM, 0, _("Could not open pid file. %s ERR=%s\n"), fname, strerror(errno));
337 free_pool_memory(fname);
343 * Delete the pid file if we created it
345 int delete_pid_file(char *dir, const char *progname, int port)
347 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
348 POOLMEM *fname = get_pool_memory(PM_FNAME);
350 if (!del_pid_file_ok) {
351 free_pool_memory(fname);
354 del_pid_file_ok = FALSE;
355 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
356 unlink(mp_chr(fname));
357 free_pool_memory(fname);
365 uint64_t last_jobs_addr;
366 uint64_t reserved[20];
369 static struct s_state_hdr state_hdr = {
376 * Open and read the state file for the daemon
378 void read_state_file(char *dir, const char *progname, int port)
382 POOLMEM *fname = get_pool_memory(PM_FNAME);
383 struct s_state_hdr hdr;
384 int hdr_size = sizeof(hdr);
386 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
387 /* If file exists, see what we have */
388 // Dmsg1(10, "O_BINARY=%d\n", O_BINARY);
389 if ((sfd = open(mp_chr(fname), O_RDONLY|O_BINARY, 0)) < 0) {
390 Dmsg3(010, "Could not open state file. sfd=%d size=%d: ERR=%s\n",
391 sfd, sizeof(hdr), strerror(errno));
394 if ((stat=read(sfd, &hdr, hdr_size)) != hdr_size) {
395 Dmsg4(010, "Could not read state file. sfd=%d stat=%d size=%d: ERR=%s\n",
396 sfd, (int)stat, hdr_size, strerror(errno));
399 if (hdr.version != state_hdr.version) {
400 Dmsg2(010, "Bad hdr version. Wanted %d got %d\n",
401 state_hdr.version, hdr.version);
404 if (strcmp(hdr.id, state_hdr.id) != 0) {
405 Dmsg0(000, "State file header id invalid.\n");
408 // Dmsg1(010, "Read header of %d bytes.\n", sizeof(hdr));
409 read_last_jobs_list(sfd, hdr.last_jobs_addr);
414 free_pool_memory(fname);
418 * Write the state file
420 void write_state_file(char *dir, const char *progname, int port)
423 POOLMEM *fname = get_pool_memory(PM_FNAME);
425 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
426 /* Create new state file */
427 if ((sfd = open(mp_chr(fname), O_CREAT|O_WRONLY|O_BINARY, 0640)) < 0) {
428 Dmsg2(000, _("Could not create state file. %s ERR=%s\n"), fname, strerror(errno));
429 Emsg2(M_ERROR, 0, _("Could not create state file. %s ERR=%s\n"), fname, strerror(errno));
432 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
433 Dmsg1(000, "Write hdr error: ERR=%s\n", strerror(errno));
436 // Dmsg1(010, "Wrote header of %d bytes\n", sizeof(state_hdr));
437 state_hdr.last_jobs_addr = sizeof(state_hdr);
438 state_hdr.reserved[0] = write_last_jobs_list(sfd, state_hdr.last_jobs_addr);
439 // Dmsg1(010, "write last job end = %d\n", (int)state_hdr.reserved[0]);
440 if (lseek(sfd, 0, SEEK_SET) < 0) {
441 Dmsg1(000, "lseek error: ERR=%s\n", strerror(errno));
444 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
445 Pmsg1(000, "Write final hdr error: ERR=%s\n", strerror(errno));
447 // Dmsg1(010, "rewrote header = %d\n", sizeof(state_hdr));
452 free_pool_memory(fname);
457 * Drop to privilege new userid and new gid if non-NULL
459 void drop(char *uid, char *gid)
466 if ((group = getgrnam(gid)) == NULL) {
467 Emsg1(M_ERROR_TERM, 0, _("Could not find specified group: %s\n"), gid);
469 if (setgid(group->gr_gid)) {
470 Emsg1(M_ERROR_TERM, 0, _("Could not set specified group: %s\n"), gid);
472 gr_list[0] = group->gr_gid;
473 if (setgroups(1, gr_list)) {
474 Emsg1(M_ERROR_TERM, 0, _("Could not set specified group: %s\n"), gid);
481 struct passwd *passw;
482 if ((passw = getpwnam(uid)) == NULL) {
483 Emsg1(M_ERROR_TERM, 0, _("Could not find specified userid: %s\n"), uid);
485 if (setuid(passw->pw_uid)) {
486 Emsg1(M_ERROR_TERM, 0, _("Could not set specified userid: %s\n"), uid);
493 static pthread_mutex_t timer_mutex = PTHREAD_MUTEX_INITIALIZER;
494 static pthread_cond_t timer = PTHREAD_COND_INITIALIZER;
497 * This routine will sleep (sec, microsec). Note, however, that if a
498 * signal occurs, it will return early. It is up to the caller
499 * to recall this routine if he/she REALLY wants to sleep the
502 int bmicrosleep(time_t sec, long usec)
504 struct timespec timeout;
509 timeout.tv_sec = sec;
510 timeout.tv_nsec = usec * 1000;
512 #ifdef HAVE_NANOSLEEP
513 stat = nanosleep(&timeout, NULL);
514 if (!(stat < 0 && errno == ENOSYS)) {
517 /* If we reach here it is because nanosleep is not supported by the OS */
520 /* Do it the old way */
521 gettimeofday(&tv, &tz);
522 timeout.tv_nsec += tv.tv_usec * 1000;
523 timeout.tv_sec += tv.tv_sec;
524 while (timeout.tv_nsec >= 1000000000) {
525 timeout.tv_nsec -= 1000000000;
529 Dmsg2(200, "pthread_cond_timedwait sec=%d usec=%d\n", sec, usec);
530 /* Note, this unlocks mutex during the sleep */
532 stat = pthread_cond_timedwait(&timer, &timer_mutex, &timeout);
535 Dmsg2(200, "pthread_cond_timedwait stat=%d ERR=%s\n", stat,
542 /* BSDI does not have this. This is a *poor* simulation */
545 strtoll(const char *ptr, char **endptr, int base)
547 return (long long int)strtod(ptr, endptr);
552 * Bacula's implementation of fgets(). The difference is that it handles
553 * being interrupted by a signal (e.g. a SIGCHLD).
556 char *bfgets(char *s, int size, FILE *fd)
561 for (int i=0; i < size-1; i++) {
565 } while (ch == -1 && (errno == EINTR || errno == EAGAIN));
575 if (ch == '\r') { /* Support for Mac/Windows file format */
577 if (ch == '\n') { /* Windows (\r\n) */
581 else { /* Mac (\r only) */
582 ungetc(ch, fd); /* Push next character back to fd */
594 * Make a "unique" filename. It is important that if
595 * called again with the same "what" that the result
596 * will be identical. This allows us to use the file
597 * without saving its name, and re-generate the name
598 * so that it can be deleted.
600 void make_unique_filename(POOLMEM **name, int Id, char *what)
602 Mmsg(name, "%s/%s.%s.%d.tmp", working_directory, my_name, what, Id);