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);
48 char *bstrncat(char *dest, const char *src, int maxlen)
50 strncat(dest, src, maxlen-1);
57 void *bmalloc(size_t size)
63 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
69 void *b_malloc(const char *file, int line, size_t size)
74 buf = sm_malloc(file, line, size);
79 e_msg(file, line, M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
85 void *brealloc (void *buf, size_t size)
87 buf = realloc(buf, size);
89 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
95 void *bcalloc (size_t size1, size_t size2)
99 buf = calloc(size1, size2);
101 Emsg1(M_ABORT, 0, _("Out of memory: ERR=%s\n"), strerror(errno));
111 int bsnprintf(char *str, int32_t size, const char *fmt, ...)
116 va_start(arg_ptr, fmt);
117 len = bvsnprintf(str, size, fmt, arg_ptr);
123 * Implement vsnprintf()
125 int bvsnprintf(char *str, int32_t size, const char *format, va_list ap)
127 #ifdef HAVE_VSNPRINTF
129 len = vsnprintf(str, size, format, ap);
137 buf = get_memory(BIG_BUF);
138 len = vsprintf(buf, format, ap);
139 if (len >= BIG_BUF) {
140 Emsg0(M_ABORT, 0, _("Buffer overflow.\n"));
142 memcpy(str, buf, size);
149 #ifndef HAVE_LOCALTIME_R
151 struct tm *localtime_r(const time_t *timep, struct tm *tm)
153 static pthread_mutex_t mutex;
154 static int first = 1;
158 pthread_mutex_init(&mutex, NULL);
162 ltm = localtime(timep);
164 memcpy(tm, ltm, sizeof(struct tm));
167 return ltm ? tm : NULL;
169 #endif /* HAVE_LOCALTIME_R */
171 #ifndef HAVE_READDIR_R
175 int readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result)
177 static pthread_mutex_t mutex;
178 static int first = 1;
183 pthread_mutex_init(&mutex, NULL);
188 ndir = readdir(dirp);
191 memcpy(entry, ndir, sizeof(struct dirent));
192 strcpy(entry->d_name, ndir->d_name);
202 #endif /* HAVE_READDIR_R */
204 #ifdef xxxxxxxxxx_STRERROR_R
205 int strerror_r(int errnum, char *buf, size_t bufsiz)
207 static pthread_mutex_t mutex;
208 static int first = 1;
213 pthread_mutex_init(&mutex, NULL);
218 msg = strerror(errnum);
220 msg = _("Bad errno");
223 bstrncpy(buf, msg, bufsiz);
227 #endif /* HAVE_STRERROR_R */
230 * These are mutex routines that do error checking
231 * for deadlock and such. Normally not turned on.
234 void _p(char *file, int line, pthread_mutex_t *m)
237 if ((errstat = pthread_mutex_trylock(m))) {
238 e_msg(file, line, M_ERROR, 0, _("Possible mutex deadlock.\n"));
239 /* We didn't get the lock, so do it definitely now */
240 if ((errstat=pthread_mutex_lock(m))) {
241 e_msg(file, line, M_ABORT, 0, _("Mutex lock failure. ERR=%s\n"),
244 e_msg(file, line, M_ERROR, 0, _("Possible mutex deadlock resolved.\n"));
250 void _v(char *file, int line, pthread_mutex_t *m)
254 if ((errstat=pthread_mutex_trylock(m)) == 0) {
255 e_msg(file, line, M_ERROR, 0, _("Mutex unlock not locked. ERR=%s\n"),
258 if ((errstat=pthread_mutex_unlock(m))) {
259 e_msg(file, line, M_ABORT, 0, _("Mutex unlock failure. ERR=%s\n"),
263 #endif /* DEBUG_MUTEX */
266 /* These routines are not normally turned on */
268 void b_memset(const char *file, int line, void *mem, int val, size_t num)
270 /* Testing for 2000 byte zero at beginning of Volume block */
271 if (num > 1900 && num < 3000) {
272 Pmsg3(000, "Memset for %d bytes at %s:%d\n", (int)num, file, line);
274 memset(mem, val, num);
278 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
279 static int del_pid_file_ok = FALSE;
283 * Create a standard "Unix" pid file.
285 void create_pid_file(char *dir, const char *progname, int port)
287 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
291 POOLMEM *fname = get_pool_memory(PM_FNAME);
294 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
295 if (stat(mp_chr(fname), &statp) == 0) {
296 /* File exists, see what we have */
298 if ((pidfd = open(mp_chr(fname), O_RDONLY|O_BINARY, 0)) < 0 ||
299 read(pidfd, &pidbuf, sizeof(pidbuf)) < 0 ||
300 sscanf(pidbuf, "%d", &oldpid) != 1) {
301 Emsg2(M_ERROR_TERM, 0, _("Cannot open pid file. %s ERR=%s\n"), fname, strerror(errno));
303 /* See if other Bacula is still alive */
304 if (kill(oldpid, 0) != -1 || errno != ESRCH) {
305 Emsg3(M_ERROR_TERM, 0, _("%s is already running. pid=%d\nCheck file %s\n"),
306 progname, oldpid, fname);
308 /* He is not alive, so take over file ownership */
309 unlink(mp_chr(fname)); /* remove stale pid file */
311 /* Create new pid file */
312 if ((pidfd = open(mp_chr(fname), O_CREAT|O_TRUNC|O_WRONLY|O_BINARY, 0640)) >= 0) {
313 len = sprintf(pidbuf, "%d\n", (int)getpid());
314 write(pidfd, pidbuf, len);
316 del_pid_file_ok = TRUE; /* we created it so we can delete it */
318 Emsg2(M_ERROR_TERM, 0, _("Could not open pid file. %s ERR=%s\n"), fname, strerror(errno));
320 free_pool_memory(fname);
326 * Delete the pid file if we created it
328 int delete_pid_file(char *dir, const char *progname, int port)
330 #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
331 POOLMEM *fname = get_pool_memory(PM_FNAME);
333 if (!del_pid_file_ok) {
334 free_pool_memory(fname);
337 del_pid_file_ok = FALSE;
338 Mmsg(&fname, "%s/%s.%d.pid", dir, progname, port);
339 unlink(mp_chr(fname));
340 free_pool_memory(fname);
348 uint64_t last_jobs_addr;
349 uint64_t reserved[20];
352 static struct s_state_hdr state_hdr = {
359 * Open and read the state file for the daemon
361 void read_state_file(char *dir, const char *progname, int port)
365 POOLMEM *fname = get_pool_memory(PM_FNAME);
366 struct s_state_hdr hdr;
367 int hdr_size = sizeof(hdr);
369 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
370 /* If file exists, see what we have */
371 // Dmsg1(10, "O_BINARY=%d\n", O_BINARY);
372 if ((sfd = open(mp_chr(fname), O_RDONLY|O_BINARY, 0)) < 0) {
373 Dmsg3(010, "Could not open state file. sfd=%d size=%d: ERR=%s\n",
374 sfd, sizeof(hdr), strerror(errno));
377 if ((stat=read(sfd, &hdr, hdr_size)) != hdr_size) {
378 Dmsg4(010, "Could not read state file. sfd=%d stat=%d size=%d: ERR=%s\n",
379 sfd, (int)stat, hdr_size, strerror(errno));
382 if (hdr.version != state_hdr.version) {
383 Dmsg2(010, "Bad hdr version. Wanted %d got %d\n",
384 state_hdr.version, hdr.version);
387 if (strcmp(hdr.id, state_hdr.id) != 0) {
388 Dmsg0(000, "State file header id invalid.\n");
391 // Dmsg1(010, "Read header of %d bytes.\n", sizeof(hdr));
392 read_last_jobs_list(sfd, hdr.last_jobs_addr);
397 free_pool_memory(fname);
401 * Write the state file
403 void write_state_file(char *dir, const char *progname, int port)
406 POOLMEM *fname = get_pool_memory(PM_FNAME);
408 Mmsg(&fname, "%s/%s.%d.state", dir, progname, port);
409 /* Create new state file */
410 if ((sfd = open(mp_chr(fname), O_CREAT|O_WRONLY|O_BINARY, 0640)) < 0) {
411 Dmsg2(000, _("Could not create state file. %s ERR=%s\n"), fname, strerror(errno));
412 Emsg2(M_ERROR, 0, _("Could not create state file. %s ERR=%s\n"), fname, strerror(errno));
415 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
416 Dmsg1(000, "Write hdr error: ERR=%s\n", strerror(errno));
419 // Dmsg1(010, "Wrote header of %d bytes\n", sizeof(state_hdr));
420 state_hdr.last_jobs_addr = sizeof(state_hdr);
421 state_hdr.reserved[0] = write_last_jobs_list(sfd, state_hdr.last_jobs_addr);
422 // Dmsg1(010, "write last job end = %d\n", (int)state_hdr.reserved[0]);
423 if (lseek(sfd, 0, SEEK_SET) < 0) {
424 Dmsg1(000, "lseek error: ERR=%s\n", strerror(errno));
427 if (write(sfd, &state_hdr, sizeof(state_hdr)) != sizeof(state_hdr)) {
428 Pmsg1(000, "Write final hdr error: ERR=%s\n", strerror(errno));
430 // Dmsg1(010, "rewrote header = %d\n", sizeof(state_hdr));
435 free_pool_memory(fname);
440 * Drop to privilege new userid and new gid if non-NULL
442 void drop(char *uid, char *gid)
449 if ((group = getgrnam(gid)) == NULL) {
450 Emsg1(M_ERROR_TERM, 0, _("Could not find specified group: %s\n"), gid);
452 if (setgid(group->gr_gid)) {
453 Emsg1(M_ERROR_TERM, 0, _("Could not set specified group: %s\n"), gid);
455 gr_list[0] = group->gr_gid;
456 if (setgroups(1, gr_list)) {
457 Emsg1(M_ERROR_TERM, 0, _("Could not set specified group: %s\n"), gid);
464 struct passwd *passw;
465 if ((passw = getpwnam(uid)) == NULL) {
466 Emsg1(M_ERROR_TERM, 0, _("Could not find specified userid: %s\n"), uid);
468 if (setuid(passw->pw_uid)) {
469 Emsg1(M_ERROR_TERM, 0, _("Could not set specified userid: %s\n"), uid);
476 static pthread_mutex_t timer_mutex = PTHREAD_MUTEX_INITIALIZER;
477 static pthread_cond_t timer = PTHREAD_COND_INITIALIZER;
480 * This routine will sleep (sec, microsec). Note, however, that if a
481 * signal occurs, it will return early. It is up to the caller
482 * to recall this routine if he/she REALLY wants to sleep the
485 int bmicrosleep(time_t sec, long usec)
487 struct timespec timeout;
492 timeout.tv_sec = sec;
493 timeout.tv_nsec = usec * 1000;
495 #ifdef HAVE_NANOSLEEP
496 stat = nanosleep(&timeout, NULL);
497 if (!(stat < 0 && errno == ENOSYS)) {
500 /* If we reach here it is because nanosleep is not supported by the OS */
503 /* Do it the old way */
504 gettimeofday(&tv, &tz);
505 timeout.tv_nsec += tv.tv_usec * 1000;
506 timeout.tv_sec += tv.tv_sec;
507 while (timeout.tv_nsec >= 1000000000) {
508 timeout.tv_nsec -= 1000000000;
512 Dmsg1(200, "pthread_cond_timedwait sec=%d\n", timeout.tv_sec);
513 /* Note, this unlocks mutex during the sleep */
515 stat = pthread_cond_timedwait(&timer, &timer_mutex, &timeout);
516 Dmsg1(200, "pthread_cond_timedwait stat=%d\n", stat);
521 /* BSDI does not have this. This is a *poor* simulation */
524 strtoll(const char *ptr, char **endptr, int base)
526 return (long long int)strtod(ptr, endptr);
531 * Bacula's implementation of fgets(). The difference is that it handles
532 * being interrupted by a signal (e.g. a SIGCHLD).
535 char *bfgets(char *s, int size, FILE *fd)
540 for (int i=0; i < size-1; i++) {
544 } while (ch == -1 && (errno == EINTR || errno == EAGAIN));
554 if (ch == '\r') { /* Support for Mac/Windows file format */
556 if (ch == '\n') { /* Windows (\r\n) */
560 else { /* Mac (\r only) */
561 ungetc(ch, fd); /* Push next character back to fd */
573 * Make a "unique" filename. It is important that if
574 * called again with the same "what" that the result
575 * will be identical. This allows us to use the file
576 * without saving its name, and re-generate the name
577 * so that it can be deleted.
579 void make_unique_filename(POOLMEM **name, int Id, char *what)
581 Mmsg(name, "%s/%s.%s.%d.tmp", working_directory, my_name, what, Id);