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) {
230 c = pa_xrealloc(c, size);
231 r = vsnprintf(c, size, format, ap);
233 if (r > -1 && r < size)
236 if (r > -1) /* glibc 2.1 */
243 /* Return the current username in the specified string buffer. */
244 char *pa_get_user_name(char *s, size_t l) {
245 struct passwd pw, *r;
250 if (!(p = getenv("USER")) && !(p = getenv("LOGNAME")) && !(p = getenv("USERNAME"))) {
252 #ifdef HAVE_GETPWUID_R
253 if (getpwuid_r(getuid(), &pw, buf, sizeof(buf), &r) != 0 || !r) {
255 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X)
256 * that do not support getpwuid_r. */
257 if ((r = getpwuid(getuid())) == NULL) {
259 snprintf(s, l, "%lu", (unsigned long) getuid());
266 return pa_strlcpy(s, p, l);
269 /* Return the current hostname in the specified buffer. */
270 char *pa_get_host_name(char *s, size_t l) {
272 if (gethostname(s, l) < 0) {
273 pa_log(__FILE__": gethostname(): %s\n", strerror(errno));
280 /* Return the home directory of the current user */
281 char *pa_get_home_dir(char *s, size_t l) {
284 struct passwd pw, *r;
287 if ((e = getenv("HOME")))
288 return pa_strlcpy(s, e, l);
290 if (getpwuid_r(getuid(), &pw, buf, sizeof(buf), &r) != 0 || !r) {
291 pa_log(__FILE__": getpwuid_r() failed\n");
295 return pa_strlcpy(s, r->pw_dir, l);
298 /* Similar to OpenBSD's strlcpy() function */
299 char *pa_strlcpy(char *b, const char *s, size_t l) {
300 assert(b && s && l > 0);
307 /* Calculate the difference between the two specfified timeval
309 pa_usec_t pa_timeval_diff(const struct timeval *a, const struct timeval *b) {
313 /* Check which whan is the earlier time and swap the two arguments if reuqired. */
314 if (pa_timeval_cmp(a, b) < 0) {
315 const struct timeval *c;
321 /* Calculate the second difference*/
322 r = ((pa_usec_t) a->tv_sec - b->tv_sec)* 1000000;
324 /* Calculate the microsecond difference */
325 if (a->tv_usec > b->tv_usec)
326 r += ((pa_usec_t) a->tv_usec - b->tv_usec);
327 else if (a->tv_usec < b->tv_usec)
328 r -= ((pa_usec_t) b->tv_usec - a->tv_usec);
333 /* Compare the two timeval structs and return 0 when equal, negative when a < b, positive otherwse */
334 int pa_timeval_cmp(const struct timeval *a, const struct timeval *b) {
337 if (a->tv_sec < b->tv_sec)
340 if (a->tv_sec > b->tv_sec)
343 if (a->tv_usec < b->tv_usec)
346 if (a->tv_usec > b->tv_usec)
352 /* Return the time difference between now and the specified timestamp */
353 pa_usec_t pa_timeval_age(const struct timeval *tv) {
356 gettimeofday(&now, NULL);
357 return pa_timeval_diff(&now, tv);
360 /* Add the specified time inmicroseconds to the specified timeval structure */
361 void pa_timeval_add(struct timeval *tv, pa_usec_t v) {
366 tv->tv_sec += (unsigned long) secs;
372 while (tv->tv_usec >= 1000000) {
374 tv->tv_usec -= 1000000;
378 #define NICE_LEVEL (-15)
380 /* Raise the priority of the current process as much as possible and
381 sensible: set the nice level to -15 and enable realtime scheduling if
383 void pa_raise_priority(void) {
385 if (setpriority(PRIO_PROCESS, 0, NICE_LEVEL) < 0)
386 pa_log(__FILE__": setpriority() failed: %s\n", strerror(errno));
387 else pa_log(__FILE__": Successfully gained nice level %i.\n", NICE_LEVEL);
389 #ifdef _POSIX_PRIORITY_SCHEDULING
391 struct sched_param sp;
393 if (sched_getparam(0, &sp) < 0) {
394 pa_log(__FILE__": sched_getparam() failed: %s\n", strerror(errno));
398 sp.sched_priority = 1;
399 if (sched_setscheduler(0, SCHED_FIFO, &sp) < 0) {
400 pa_log(__FILE__": sched_setscheduler() failed: %s\n", strerror(errno));
404 pa_log(__FILE__": Successfully enabled SCHED_FIFO scheduling.\n");
409 /* Reset the priority to normal, inverting the changes made by pa_raise_priority() */
410 void pa_reset_priority(void) {
411 #ifdef _POSIX_PRIORITY_SCHEDULING
413 struct sched_param sp;
414 sched_getparam(0, &sp);
415 sp.sched_priority = 0;
416 sched_setscheduler(0, SCHED_OTHER, &sp);
420 setpriority(PRIO_PROCESS, 0, 0);
423 /* Set the FD_CLOEXEC flag for a fd */
424 int pa_fd_set_cloexec(int fd, int b) {
428 if ((v = fcntl(fd, F_GETFD, 0)) < 0)
431 v = (v & ~FD_CLOEXEC) | (b ? FD_CLOEXEC : 0);
433 if (fcntl(fd, F_SETFD, v) < 0)
439 /* Return the binary file name of the current process. Works on Linux
440 * only. This shoul be used for eyecandy only, don't rely on return
442 char *pa_get_binary_name(char *s, size_t l) {
447 /* This works on Linux only */
449 snprintf(path, sizeof(path), "/proc/%u/exe", (unsigned) getpid());
450 if ((i = readlink(path, s, l-1)) < 0)
457 /* Return a pointer to the filename inside a path (which is the last
459 char *pa_path_get_filename(const char *p) {
462 if ((fn = strrchr(p, '/')))
468 /* Try to parse a boolean string value.*/
469 int pa_parse_boolean(const char *v) {
471 if (!strcmp(v, "1") || v[0] == 'y' || v[0] == 'Y' || v[0] == 't' || v[0] == 'T' || !strcasecmp(v, "on"))
473 else if (!strcmp(v, "0") || v[0] == 'n' || v[0] == 'N' || v[0] == 'f' || v[0] == 'F' || !strcasecmp(v, "off"))
479 /* Split the specified string wherever one of the strings in delimiter
480 * occurs. Each time it is called returns a newly allocated string
481 * with pa_xmalloc(). The variable state points to, should be
482 * initiallized to NULL before the first call. */
483 char *pa_split(const char *c, const char *delimiter, const char**state) {
484 const char *current = *state ? *state : c;
490 l = strcspn(current, delimiter);
496 return pa_xstrndup(current, l);
499 /* What is interpreted as whitespace? */
500 #define WHITESPACE " \t\n"
502 /* Split a string into words. Otherwise similar to pa_split(). */
503 char *pa_split_spaces(const char *c, const char **state) {
504 const char *current = *state ? *state : c;
507 if (!*current || *c == 0)
510 current += strspn(current, WHITESPACE);
511 l = strcspn(current, WHITESPACE);
515 return pa_xstrndup(current, l);
518 /* Return the name of an UNIX signal. Similar to GNU's strsignal() */
519 const char *pa_strsignal(int sig) {
521 case SIGINT: return "SIGINT";
522 case SIGTERM: return "SIGTERM";
523 case SIGUSR1: return "SIGUSR1";
524 case SIGUSR2: return "SIGUSR2";
525 case SIGXCPU: return "SIGXCPU";
526 case SIGPIPE: return "SIGPIPE";
527 case SIGCHLD: return "SIGCHLD";
528 case SIGHUP: return "SIGHUP";
529 default: return "UNKNOWN SIGNAL";
533 /* Parse a libsamplrate compatible resampling implementation */
534 int pa_parse_resample_method(const char *string) {
537 if (!strcmp(string, "sinc-best-quality"))
538 return SRC_SINC_BEST_QUALITY;
539 else if (!strcmp(string, "sinc-medium-quality"))
540 return SRC_SINC_MEDIUM_QUALITY;
541 else if (!strcmp(string, "sinc-fastest"))
542 return SRC_SINC_FASTEST;
543 else if (!strcmp(string, "zero-order-hold"))
544 return SRC_ZERO_ORDER_HOLD;
545 else if (!strcmp(string, "linear"))
551 /* Check whether the specified GID and the group name match */
552 static int is_group(gid_t gid, const char *name) {
553 struct group group, *result = NULL;
558 #ifdef HAVE_GETGRGID_R
559 #ifdef _SC_GETGR_R_SIZE_MAX
560 n = sysconf(_SC_GETGR_R_SIZE_MAX);
565 data = pa_xmalloc(n);
567 if (getgrgid_r(gid, &group, data, n, &result) < 0 || !result) {
568 pa_log(__FILE__ ": getgrgid_r(%u) failed: %s\n", gid, strerror(errno));
573 r = strcmp(name, result->gr_name) == 0;
578 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X) that do not
579 * support getgrgid_r. */
580 if ((result = getgrgid(gid)) == NULL) {
581 pa_log(__FILE__ ": getgrgid(%u) failed: %s\n", gid, strerror(errno));
585 r = strcmp(name, result->gr_name) == 0;
593 /* Check the current user is member of the specified group */
594 int pa_uid_in_group(const char *name, gid_t *gid) {
596 long n = sysconf(_SC_NGROUPS_MAX);
601 gids = pa_xmalloc(sizeof(gid_t)*n);
603 if ((n = getgroups(n, gids)) < 0) {
604 pa_log(__FILE__": getgroups() failed: %s\n", strerror(errno));
608 for (i = 0; i < n; i++) {
609 if (is_group(gids[i], name) > 0) {
616 if (is_group(tgid = getgid(), name) > 0) {
630 /* Lock or unlock a file entirely. (advisory) */
631 int pa_lock_fd(int fd, int b) {
635 flock.l_type = b ? F_WRLCK : F_UNLCK;
636 flock.l_whence = SEEK_SET;
640 if (fcntl(fd, F_SETLKW, &flock) < 0) {
641 pa_log(__FILE__": %slock failed: %s\n", !b ? "un" : "", strerror(errno));
648 /* Remove trailing newlines from a string */
649 char* pa_strip_nl(char *s) {
652 s[strcspn(s, "\r\n")] = 0;
656 /* Create a temporary lock file and lock it. */
657 int pa_lock_lockfile(const char *fn) {
661 if ((fd = open(fn, O_CREAT|O_RDWR, S_IRUSR|S_IWUSR)) < 0) {
662 pa_log(__FILE__": failed to create lock file '%s'\n", fn);
666 if (pa_lock_fd(fd, 1) < 0)
679 /* Unlock a temporary lcok file */
680 int pa_unlock_lockfile(int fd) {
684 if (pa_lock_fd(fd, 0) < 0) {
685 pa_log(__FILE__": WARNING: failed to unlock file.\n");
690 pa_log(__FILE__": WARNING: failed to close lock file.\n");
697 /* Try to open a configuration file. If "env" is specified, open the
698 * value of the specified environment variable. Otherwise look for a
699 * file "local" in the home directory or a file "global" in global
700 * file system. If "result" is non-NULL, a pointer to a newly
701 * allocated buffer containing the used configuration file is
703 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result) {
707 if (env && (e = getenv(env))) {
709 *result = pa_xstrdup(e);
710 return fopen(e, "r");
713 if (local && pa_get_home_dir(h, sizeof(h))) {
717 l = pa_sprintf_malloc("%s/%s", h, local);
720 if (f || errno != ENOENT) {
739 *result = pa_xstrdup(global);
741 return fopen(global, "r");
744 /* Format the specified data as a hexademical string */
745 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength) {
747 const char hex[] = "0123456789abcdef";
748 assert(d && s && slength > 0);
750 while (i < dlength && j+3 <= slength) {
751 s[j++] = hex[*d >> 4];
752 s[j++] = hex[*d & 0xF];
758 s[j < slength ? j : slength] = 0;
762 /* Convert a hexadecimal digit to a number or -1 if invalid */
763 static int hexc(char c) {
764 if (c >= '0' && c <= '9')
767 if (c >= 'A' && c <= 'F')
770 if (c >= 'a' && c <= 'f')
776 /* Parse a hexadecimal string as created by pa_hexstr() to a BLOB */
777 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength) {
781 while (j < dlength && *p) {
784 if ((b = hexc(*(p++))) < 0)
787 d[j] = (uint8_t) (b << 4);
792 if ((b = hexc(*(p++))) < 0)
802 /* Return the fully qualified domain name in *s */
803 char *pa_get_fqdn(char *s, size_t l) {
805 struct addrinfo *a, hints;
807 if (!pa_get_host_name(hn, sizeof(hn)))
810 memset(&hints, 0, sizeof(hints));
811 hints.ai_family = AF_UNSPEC;
812 hints.ai_flags = AI_CANONNAME;
814 if (getaddrinfo(hn, NULL, &hints, &a) < 0 || !a || !a->ai_canonname || !*a->ai_canonname)
815 return pa_strlcpy(s, hn, l);
817 pa_strlcpy(s, a->ai_canonname, l);
822 /* Returns nonzero when *s starts with *pfx */
823 int pa_startswith(const char *s, const char *pfx) {
828 return strlen(s) >= l && strncmp(s, pfx, l) == 0;
831 /* if fn is null return the polypaudio run time path in s (/tmp/polypaudio)
832 * if fn is non-null and starts with / return fn in s
833 * otherwise append fn to the run time path and return it in s */
834 char *pa_runtime_path(const char *fn, char *s, size_t l) {
837 if (fn && *fn == '/')
838 return pa_strlcpy(s, fn, l);
840 snprintf(s, l, PA_RUNTIME_PATH_PREFIX"%s%s%s", pa_get_user_name(u, sizeof(u)), fn ? "/" : "", fn ? fn : "");