4 This file is part of polypaudio.
6 polypaudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as
8 published by the Free Software Foundation; either version 2.1 of the
9 License, or (at your option) any later version.
11 polypaudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with polypaudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
35 #include <sys/types.h>
42 #include <sys/resource.h>
48 #include <samplerate.h>
54 #define PA_RUNTIME_PATH_PREFIX "/tmp/polypaudio-"
56 /** Make a file descriptor nonblock. Doesn't do any error checking */
57 void pa_make_nonblock_fd(int fd) {
61 if ((v = fcntl(fd, F_GETFL)) >= 0)
62 if (!(v & O_NONBLOCK))
63 fcntl(fd, F_SETFL, v|O_NONBLOCK);
66 /** Creates a directory securely */
67 int pa_make_secure_dir(const char* dir) {
71 if (mkdir(dir, 0700) < 0)
75 if (lstat(dir, &st) < 0)
78 if (!S_ISDIR(st.st_mode) || (st.st_uid != getuid()) || ((st.st_mode & 0777) != 0700))
88 /* Creates a the parent directory of the specified path securely */
89 int pa_make_secure_parent_dir(const char *fn) {
91 char *slash, *dir = pa_xstrdup(fn);
93 if (!(slash = strrchr(dir, '/')))
97 if (pa_make_secure_dir(dir) < 0)
108 /** Calls read() in a loop. Makes sure that as much as 'size' bytes,
109 * unless EOF is reached or an error occured */
110 ssize_t pa_loop_read(int fd, void*data, size_t size) {
112 assert(fd >= 0 && data && size);
117 if ((r = read(fd, data, size)) < 0)
124 data = (uint8_t*) data + r;
131 /** Similar to pa_loop_read(), but wraps write() */
132 ssize_t pa_loop_write(int fd, const void*data, size_t size) {
134 assert(fd >= 0 && data && size);
139 if ((r = write(fd, data, size)) < 0)
146 data = (uint8_t*) data + r;
153 /* Print a warning messages in case that the given signal is not
154 * blocked or trapped */
155 void pa_check_signal_is_blocked(int sig) {
159 /* If POSIX threads are supported use thread-aware
160 * pthread_sigmask() function, to check if the signal is
161 * blocked. Otherwise fall back to sigprocmask() */
164 if (pthread_sigmask(SIG_SETMASK, NULL, &set) < 0) {
166 if (sigprocmask(SIG_SETMASK, NULL, &set) < 0) {
167 pa_log(__FILE__": sigprocmask() failed: %s\n", strerror(errno));
174 if (sigismember(&set, sig))
177 /* Check whether the signal is trapped */
179 if (sigaction(sig, NULL, &sa) < 0) {
180 pa_log(__FILE__": sigaction() failed: %s\n", strerror(errno));
184 if (sa.sa_handler != SIG_DFL)
187 pa_log(__FILE__": WARNING: %s is not trapped. This might cause malfunction!\n", pa_strsignal(sig));
190 /* The following function is based on an example from the GNU libc
191 * documentation. This function is similar to GNU's asprintf(). */
192 char *pa_sprintf_malloc(const char *format, ...) {
202 c = pa_xrealloc(c, size);
204 va_start(ap, format);
205 r = vsnprintf(c, size, format, ap);
208 if (r > -1 && r < size)
211 if (r > -1) /* glibc 2.1 */
218 /* Same as the previous function, but use a va_list instead of an
220 char *pa_vsprintf_malloc(const char *format, va_list ap) {
228 c = pa_xrealloc(c, size);
229 r = vsnprintf(c, size, format, ap);
231 if (r > -1 && r < size)
234 if (r > -1) /* glibc 2.1 */
241 /* Return the current username in the specified string buffer. */
242 char *pa_get_user_name(char *s, size_t l) {
243 struct passwd pw, *r;
248 if (!(p = getenv("USER")) && !(p = getenv("LOGNAME")) && !(p = getenv("USERNAME"))) {
250 #ifdef HAVE_GETPWUID_R
251 if (getpwuid_r(getuid(), &pw, buf, sizeof(buf), &r) != 0 || !r) {
253 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X)
254 * that do not support getpwuid_r. */
255 if ((r = getpwuid(getuid())) == NULL) {
257 snprintf(s, l, "%lu", (unsigned long) getuid());
264 return pa_strlcpy(s, p, l);
267 /* Return the current hostname in the specified buffer. */
268 char *pa_get_host_name(char *s, size_t l) {
270 if (gethostname(s, l) < 0) {
271 pa_log(__FILE__": gethostname(): %s\n", strerror(errno));
278 /* Return the home directory of the current user */
279 char *pa_get_home_dir(char *s, size_t l) {
282 struct passwd pw, *r;
285 if ((e = getenv("HOME")))
286 return pa_strlcpy(s, e, l);
288 if (getpwuid_r(getuid(), &pw, buf, sizeof(buf), &r) != 0 || !r) {
289 pa_log(__FILE__": getpwuid_r() failed\n");
293 return pa_strlcpy(s, r->pw_dir, l);
296 /* Similar to OpenBSD's strlcpy() function */
297 char *pa_strlcpy(char *b, const char *s, size_t l) {
298 assert(b && s && l > 0);
305 /* Calculate the difference between the two specfified timeval
307 pa_usec_t pa_timeval_diff(const struct timeval *a, const struct timeval *b) {
311 /* Check which whan is the earlier time and swap the two arguments if reuqired. */
312 if (pa_timeval_cmp(a, b) < 0) {
313 const struct timeval *c;
319 /* Calculate the second difference*/
320 r = ((pa_usec_t) a->tv_sec - b->tv_sec)* 1000000;
322 /* Calculate the microsecond difference */
323 if (a->tv_usec > b->tv_usec)
324 r += ((pa_usec_t) a->tv_usec - b->tv_usec);
325 else if (a->tv_usec < b->tv_usec)
326 r -= ((pa_usec_t) b->tv_usec - a->tv_usec);
331 /* Compare the two timeval structs and return 0 when equal, negative when a < b, positive otherwse */
332 int pa_timeval_cmp(const struct timeval *a, const struct timeval *b) {
335 if (a->tv_sec < b->tv_sec)
338 if (a->tv_sec > b->tv_sec)
341 if (a->tv_usec < b->tv_usec)
344 if (a->tv_usec > b->tv_usec)
350 /* Return the time difference between now and the specified timestamp */
351 pa_usec_t pa_timeval_age(const struct timeval *tv) {
354 gettimeofday(&now, NULL);
355 return pa_timeval_diff(&now, tv);
358 /* Add the specified time inmicroseconds to the specified timeval structure */
359 void pa_timeval_add(struct timeval *tv, pa_usec_t v) {
364 tv->tv_sec += (unsigned long) secs;
370 while (tv->tv_usec >= 1000000) {
372 tv->tv_usec -= 1000000;
376 #define NICE_LEVEL (-15)
378 /* Raise the priority of the current process as much as possible and
379 sensible: set the nice level to -15 and enable realtime scheduling if
381 void pa_raise_priority(void) {
383 if (setpriority(PRIO_PROCESS, 0, NICE_LEVEL) < 0)
384 pa_log(__FILE__": setpriority() failed: %s\n", strerror(errno));
386 /* pa_log(__FILE__": Successfully gained nice level %i.\n", NICE_LEVEL); */
388 #ifdef _POSIX_PRIORITY_SCHEDULING
390 struct sched_param sp;
392 if (sched_getparam(0, &sp) < 0) {
393 pa_log(__FILE__": sched_getparam() failed: %s\n", strerror(errno));
397 sp.sched_priority = 1;
398 if (sched_setscheduler(0, SCHED_FIFO, &sp) < 0) {
399 pa_log(__FILE__": sched_setscheduler() failed: %s\n", strerror(errno));
403 /* pa_log(__FILE__": Successfully enabled SCHED_FIFO scheduling.\n"); */
408 /* Reset the priority to normal, inverting the changes made by pa_raise_priority() */
409 void pa_reset_priority(void) {
410 #ifdef _POSIX_PRIORITY_SCHEDULING
412 struct sched_param sp;
413 sched_getparam(0, &sp);
414 sp.sched_priority = 0;
415 sched_setscheduler(0, SCHED_OTHER, &sp);
419 setpriority(PRIO_PROCESS, 0, 0);
422 /* Set the FD_CLOEXEC flag for a fd */
423 int pa_fd_set_cloexec(int fd, int b) {
427 if ((v = fcntl(fd, F_GETFD, 0)) < 0)
430 v = (v & ~FD_CLOEXEC) | (b ? FD_CLOEXEC : 0);
432 if (fcntl(fd, F_SETFD, v) < 0)
438 /* Return the binary file name of the current process. Works on Linux
439 * only. This shoul be used for eyecandy only, don't rely on return
441 char *pa_get_binary_name(char *s, size_t l) {
446 /* This works on Linux only */
448 snprintf(path, sizeof(path), "/proc/%u/exe", (unsigned) getpid());
449 if ((i = readlink(path, s, l-1)) < 0)
456 /* Return a pointer to the filename inside a path (which is the last
458 char *pa_path_get_filename(const char *p) {
461 if ((fn = strrchr(p, '/')))
467 /* Try to parse a boolean string value.*/
468 int pa_parse_boolean(const char *v) {
470 if (!strcmp(v, "1") || v[0] == 'y' || v[0] == 'Y' || v[0] == 't' || v[0] == 'T' || !strcasecmp(v, "on"))
472 else if (!strcmp(v, "0") || v[0] == 'n' || v[0] == 'N' || v[0] == 'f' || v[0] == 'F' || !strcasecmp(v, "off"))
478 /* Split the specified string wherever one of the strings in delimiter
479 * occurs. Each time it is called returns a newly allocated string
480 * with pa_xmalloc(). The variable state points to, should be
481 * initiallized to NULL before the first call. */
482 char *pa_split(const char *c, const char *delimiter, const char**state) {
483 const char *current = *state ? *state : c;
489 l = strcspn(current, delimiter);
495 return pa_xstrndup(current, l);
498 /* What is interpreted as whitespace? */
499 #define WHITESPACE " \t\n"
501 /* Split a string into words. Otherwise similar to pa_split(). */
502 char *pa_split_spaces(const char *c, const char **state) {
503 const char *current = *state ? *state : c;
506 if (!*current || *c == 0)
509 current += strspn(current, WHITESPACE);
510 l = strcspn(current, WHITESPACE);
514 return pa_xstrndup(current, l);
517 /* Return the name of an UNIX signal. Similar to GNU's strsignal() */
518 const char *pa_strsignal(int sig) {
520 case SIGINT: return "SIGINT";
521 case SIGTERM: return "SIGTERM";
522 case SIGUSR1: return "SIGUSR1";
523 case SIGUSR2: return "SIGUSR2";
524 case SIGXCPU: return "SIGXCPU";
525 case SIGPIPE: return "SIGPIPE";
526 case SIGCHLD: return "SIGCHLD";
527 case SIGHUP: return "SIGHUP";
528 default: return "UNKNOWN SIGNAL";
533 /* Check whether the specified GID and the group name match */
534 static int is_group(gid_t gid, const char *name) {
535 struct group group, *result = NULL;
540 #ifdef HAVE_GETGRGID_R
541 #ifdef _SC_GETGR_R_SIZE_MAX
542 n = sysconf(_SC_GETGR_R_SIZE_MAX);
547 data = pa_xmalloc(n);
549 if (getgrgid_r(gid, &group, data, n, &result) < 0 || !result) {
550 pa_log(__FILE__ ": getgrgid_r(%u) failed: %s\n", gid, strerror(errno));
555 r = strcmp(name, result->gr_name) == 0;
560 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X) that do not
561 * support getgrgid_r. */
562 if ((result = getgrgid(gid)) == NULL) {
563 pa_log(__FILE__ ": getgrgid(%u) failed: %s\n", gid, strerror(errno));
567 r = strcmp(name, result->gr_name) == 0;
575 /* Check the current user is member of the specified group */
576 int pa_uid_in_group(const char *name, gid_t *gid) {
578 long n = sysconf(_SC_NGROUPS_MAX);
583 gids = pa_xmalloc(sizeof(gid_t)*n);
585 if ((n = getgroups(n, gids)) < 0) {
586 pa_log(__FILE__": getgroups() failed: %s\n", strerror(errno));
590 for (i = 0; i < n; i++) {
591 if (is_group(gids[i], name) > 0) {
598 if (is_group(tgid = getgid(), name) > 0) {
612 /* Lock or unlock a file entirely. (advisory) */
613 int pa_lock_fd(int fd, int b) {
616 /* Try a R/W lock first */
618 flock.l_type = b ? F_WRLCK : F_UNLCK;
619 flock.l_whence = SEEK_SET;
623 if (fcntl(fd, F_SETLKW, &flock) >= 0)
626 /* Perhaps the file descriptor qas opened for read only, than try again with a read lock. */
627 if (b && errno == EBADF) {
628 flock.l_type = F_RDLCK;
629 if (fcntl(fd, F_SETLKW, &flock) >= 0)
633 pa_log(__FILE__": %slock failed: %s\n", !b ? "un" : "", strerror(errno));
637 /* Remove trailing newlines from a string */
638 char* pa_strip_nl(char *s) {
641 s[strcspn(s, "\r\n")] = 0;
645 /* Create a temporary lock file and lock it. */
646 int pa_lock_lockfile(const char *fn) {
653 if ((fd = open(fn, O_CREAT|O_RDWR, S_IRUSR|S_IWUSR)) < 0) {
654 pa_log(__FILE__": failed to create lock file '%s': %s\n", fn, strerror(errno));
658 if (pa_lock_fd(fd, 1) < 0) {
659 pa_log(__FILE__": failed to lock file '%s'.\n", fn);
663 if (fstat(fd, &st) < 0) {
664 pa_log(__FILE__": failed to fstat() file '%s'.\n", fn);
668 /* Check wheter the file has been removed meanwhile. When yes, restart this loop, otherwise, we're done */
669 if (st.st_nlink >= 1)
672 if (pa_lock_fd(fd, 0) < 0) {
673 pa_log(__FILE__": failed to unlock file '%s'.\n", fn);
678 pa_log(__FILE__": failed to close file '%s'.\n", fn);
695 /* Unlock a temporary lcok file */
696 int pa_unlock_lockfile(const char *fn, int fd) {
698 assert(fn && fd >= 0);
700 if (unlink(fn) < 0) {
701 pa_log(__FILE__": WARNING: unable to remove lock file '%s': %s\n", fn, strerror(errno));
705 if (pa_lock_fd(fd, 0) < 0) {
706 pa_log(__FILE__": WARNING: failed to unlock file '%s'.\n", fn);
711 pa_log(__FILE__": WARNING: failed to close lock file '%s': %s\n", fn, strerror(errno));
718 /* Try to open a configuration file. If "env" is specified, open the
719 * value of the specified environment variable. Otherwise look for a
720 * file "local" in the home directory or a file "global" in global
721 * file system. If "result" is non-NULL, a pointer to a newly
722 * allocated buffer containing the used configuration file is
724 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result) {
728 if (env && (e = getenv(env))) {
730 *result = pa_xstrdup(e);
731 return fopen(e, "r");
734 if (local && pa_get_home_dir(h, sizeof(h))) {
738 l = pa_sprintf_malloc("%s/%s", h, local);
741 if (f || errno != ENOENT) {
760 *result = pa_xstrdup(global);
762 return fopen(global, "r");
765 /* Format the specified data as a hexademical string */
766 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength) {
768 const char hex[] = "0123456789abcdef";
769 assert(d && s && slength > 0);
771 while (i < dlength && j+3 <= slength) {
772 s[j++] = hex[*d >> 4];
773 s[j++] = hex[*d & 0xF];
779 s[j < slength ? j : slength] = 0;
783 /* Convert a hexadecimal digit to a number or -1 if invalid */
784 static int hexc(char c) {
785 if (c >= '0' && c <= '9')
788 if (c >= 'A' && c <= 'F')
791 if (c >= 'a' && c <= 'f')
797 /* Parse a hexadecimal string as created by pa_hexstr() to a BLOB */
798 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength) {
802 while (j < dlength && *p) {
805 if ((b = hexc(*(p++))) < 0)
808 d[j] = (uint8_t) (b << 4);
813 if ((b = hexc(*(p++))) < 0)
823 /* Return the fully qualified domain name in *s */
824 char *pa_get_fqdn(char *s, size_t l) {
826 struct addrinfo *a, hints;
828 if (!pa_get_host_name(hn, sizeof(hn)))
831 memset(&hints, 0, sizeof(hints));
832 hints.ai_family = AF_UNSPEC;
833 hints.ai_flags = AI_CANONNAME;
835 if (getaddrinfo(hn, NULL, &hints, &a) < 0 || !a || !a->ai_canonname || !*a->ai_canonname)
836 return pa_strlcpy(s, hn, l);
838 pa_strlcpy(s, a->ai_canonname, l);
843 /* Returns nonzero when *s starts with *pfx */
844 int pa_startswith(const char *s, const char *pfx) {
849 return strlen(s) >= l && strncmp(s, pfx, l) == 0;
852 /* if fn is null return the polypaudio run time path in s (/tmp/polypaudio)
853 * if fn is non-null and starts with / return fn in s
854 * otherwise append fn to the run time path and return it in s */
855 char *pa_runtime_path(const char *fn, char *s, size_t l) {
858 if (fn && *fn == '/')
859 return pa_strlcpy(s, fn, l);
861 snprintf(s, l, PA_RUNTIME_PATH_PREFIX"%s%s%s", pa_get_user_name(u, sizeof(u)), fn ? "/" : "", fn ? fn : "");
865 int pa_msleep(unsigned long t) {
869 ts.tv_nsec = (t % 1000) * 1000000;
871 return nanosleep(&ts, NULL);