]>
code.delx.au - pulseaudio/blob - polyp/util.c
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 General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 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 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 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>
47 #include <samplerate.h>
53 /** Make a file descriptor nonblock. Doesn't do any error checking */
54 void pa_make_nonblock_fd(int fd
) {
58 if ((v
= fcntl(fd
, F_GETFL
)) >= 0)
59 if (!(v
& O_NONBLOCK
))
60 fcntl(fd
, F_SETFL
, v
|O_NONBLOCK
);
63 /** Creates a directory securely */
64 int pa_make_secure_dir(const char* dir
) {
68 if (mkdir(dir
, 0700) < 0)
72 if (lstat(dir
, &st
) < 0)
75 if (!S_ISDIR(st
.st_mode
) || (st
.st_uid
!= getuid()) || ((st
.st_mode
& 0777) != 0700))
85 /** Calls read() in a loop. Makes sure that as much as 'size' bytes,
86 * unless EOF is reached or an error occured */
87 ssize_t
pa_loop_read(int fd
, void*data
, size_t size
) {
89 assert(fd
>= 0 && data
&& size
);
94 if ((r
= read(fd
, data
, size
)) < 0)
101 data
= (uint8_t*) data
+ r
;
108 /** Similar to pa_loop_read(), but wraps write() */
109 ssize_t
pa_loop_write(int fd
, const void*data
, size_t size
) {
111 assert(fd
>= 0 && data
&& size
);
116 if ((r
= write(fd
, data
, size
)) < 0)
123 data
= (uint8_t*) data
+ r
;
130 /* Print a warning messages in case that the given signal is not
131 * blocked or trapped */
132 void pa_check_signal_is_blocked(int sig
) {
136 /* If POSIX threads are supported use thread-aware
137 * pthread_sigmask() function, to check if the signal is
138 * blocked. Otherwise fall back to sigprocmask() */
141 if (pthread_sigmask(SIG_SETMASK
, NULL
, &set
) < 0) {
143 if (sigprocmask(SIG_SETMASK
, NULL
, &set
) < 0) {
144 pa_log(__FILE__
": sigprocmask() failed: %s\n", strerror(errno
));
151 if (sigismember(&set
, sig
))
154 /* Check whether the signal is trapped */
156 if (sigaction(sig
, NULL
, &sa
) < 0) {
157 pa_log(__FILE__
": sigaction() failed: %s\n", strerror(errno
));
161 if (sa
.sa_handler
!= SIG_DFL
)
164 pa_log(__FILE__
": WARNING: %s is not trapped. This might cause malfunction!\n", pa_strsignal(sig
));
167 /* The following function is based on an example from the GNU libc
168 * documentation. This function is similar to GNU's asprintf(). */
169 char *pa_sprintf_malloc(const char *format
, ...) {
179 c
= pa_xrealloc(c
, size
);
181 va_start(ap
, format
);
182 r
= vsnprintf(c
, size
, format
, ap
);
185 if (r
> -1 && r
< size
)
188 if (r
> -1) /* glibc 2.1 */
195 /* Same as the previous function, but use a va_list instead of an
197 char *pa_vsprintf_malloc(const char *format
, va_list ap
) {
207 c
= pa_xrealloc(c
, size
);
208 r
= vsnprintf(c
, size
, format
, ap
);
210 if (r
> -1 && r
< size
)
213 if (r
> -1) /* glibc 2.1 */
220 /* Return the current username in the specified string buffer. */
221 char *pa_get_user_name(char *s
, size_t l
) {
222 struct passwd pw
, *r
;
227 if (!(p
= getenv("USER")))
228 if (!(p
= getenv("LOGNAME")))
229 if (!(p
= getenv("USERNAME"))) {
231 #ifdef HAVE_GETPWUID_R
232 if (getpwuid_r(getuid(), &pw
, buf
, sizeof(buf
), &r
) != 0 || !r
) {
234 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X)
235 * that do not support getpwuid_r. */
236 if ((r
= getpwuid(getuid())) == NULL
) {
238 snprintf(s
, l
, "%lu", (unsigned long) getuid());
245 return pa_strlcpy(s
, p
, l
);
248 /* Return the current hostname in the specified buffer. */
249 char *pa_get_host_name(char *s
, size_t l
) {
256 /* Return the home directory of the current user */
257 char *pa_get_home_dir(char *s
, size_t l
) {
260 struct passwd pw
, *r
;
263 if ((e
= getenv("HOME")))
264 return pa_strlcpy(s
, e
, l
);
266 if (getpwuid_r(getuid(), &pw
, buf
, sizeof(buf
), &r
) != 0 || !r
)
269 return pa_strlcpy(s
, r
->pw_dir
, l
);
272 /* Similar to OpenBSD's strlcpy() function */
273 char *pa_strlcpy(char *b
, const char *s
, size_t l
) {
274 assert(b
&& s
&& l
> 0);
281 /* Calculate the difference between the two specfified timeval
283 pa_usec_t
pa_timeval_diff(const struct timeval
*a
, const struct timeval
*b
) {
287 /* Check which whan is the earlier time and swap the two arguments if reuqired. */
288 if (pa_timeval_cmp(a
, b
) < 0) {
289 const struct timeval
*c
;
295 /* Calculate the second difference*/
296 r
= ((pa_usec_t
) a
->tv_sec
- b
->tv_sec
)* 1000000;
298 /* Calculate the microsecond difference */
299 if (a
->tv_usec
> b
->tv_usec
)
300 r
+= ((pa_usec_t
) a
->tv_usec
- b
->tv_usec
);
301 else if (a
->tv_usec
< b
->tv_usec
)
302 r
-= ((pa_usec_t
) b
->tv_usec
- a
->tv_usec
);
307 /* Compare the two timeval structs and return 0 when equal, negative when a < b, positive otherwse */
308 int pa_timeval_cmp(const struct timeval
*a
, const struct timeval
*b
) {
311 if (a
->tv_sec
< b
->tv_sec
)
314 if (a
->tv_sec
> b
->tv_sec
)
317 if (a
->tv_usec
< b
->tv_usec
)
320 if (a
->tv_usec
> b
->tv_usec
)
326 /* Return the time difference between now and the specified timestamp */
327 pa_usec_t
pa_timeval_age(const struct timeval
*tv
) {
330 gettimeofday(&now
, NULL
);
331 return pa_timeval_diff(&now
, tv
);
334 /* Add the specified time inmicroseconds to the specified timeval structure */
335 void pa_timeval_add(struct timeval
*tv
, pa_usec_t v
) {
340 tv
->tv_sec
+= (unsigned long) secs
;
346 while (tv
->tv_usec
>= 1000000) {
348 tv
->tv_usec
-= 1000000;
352 #define NICE_LEVEL (-15)
354 /* Raise the priority of the current process as much as possible and
355 sensible: set the nice level to -15 and enable realtime scheduling if
357 void pa_raise_priority(void) {
359 if (setpriority(PRIO_PROCESS
, 0, NICE_LEVEL
) < 0)
360 pa_log(__FILE__
": setpriority() failed: %s\n", strerror(errno
));
361 else pa_log(__FILE__
": Successfully gained nice level %i.\n", NICE_LEVEL
);
363 #ifdef _POSIX_PRIORITY_SCHEDULING
365 struct sched_param sp
;
367 if (sched_getparam(0, &sp
) < 0) {
368 pa_log(__FILE__
": sched_getparam() failed: %s\n", strerror(errno
));
372 sp
.sched_priority
= 1;
373 if (sched_setscheduler(0, SCHED_FIFO
, &sp
) < 0) {
374 pa_log(__FILE__
": sched_setscheduler() failed: %s\n", strerror(errno
));
378 pa_log(__FILE__
": Successfully enabled SCHED_FIFO scheduling.\n");
383 /* Reset the priority to normal, inverting the changes made by pa_raise_priority() */
384 void pa_reset_priority(void) {
385 #ifdef _POSIX_PRIORITY_SCHEDULING
387 struct sched_param sp
;
388 sched_getparam(0, &sp
);
389 sp
.sched_priority
= 0;
390 sched_setscheduler(0, SCHED_OTHER
, &sp
);
394 setpriority(PRIO_PROCESS
, 0, 0);
397 /* Set the FD_CLOEXEC flag for a fd */
398 int pa_fd_set_cloexec(int fd
, int b
) {
402 if ((v
= fcntl(fd
, F_GETFD
, 0)) < 0)
405 v
= (v
& ~FD_CLOEXEC
) | (b
? FD_CLOEXEC
: 0);
407 if (fcntl(fd
, F_SETFD
, v
) < 0)
413 /* Return the binary file name of the current process. Works on Linux
414 * only. This shoul be used for eyecandy only, don't rely on return
416 char *pa_get_binary_name(char *s
, size_t l
) {
421 /* This works on Linux only */
423 snprintf(path
, sizeof(path
), "/proc/%u/exe", (unsigned) getpid());
424 if ((i
= readlink(path
, s
, l
-1)) < 0)
431 /* Return a pointer to the filename inside a path (which is the last
433 char *pa_path_get_filename(const char *p
) {
436 if ((fn
= strrchr(p
, '/')))
442 /* Try to parse a boolean string value.*/
443 int pa_parse_boolean(const char *v
) {
445 if (!strcmp(v
, "1") || v
[0] == 'y' || v
[0] == 'Y' || v
[0] == 't' || v
[0] == 'T' || !strcasecmp(v
, "on"))
447 else if (!strcmp(v
, "0") || v
[0] == 'n' || v
[0] == 'N' || v
[0] == 'f' || v
[0] == 'F' || !strcasecmp(v
, "off"))
453 /* Split the specified string wherever one of the strings in delimiter
454 * occurs. Each time it is called returns a newly allocated string
455 * with pa_xmalloc(). The variable state points to, should be
456 * initiallized to NULL before the first call. */
457 char *pa_split(const char *c
, const char *delimiter
, const char**state
) {
458 const char *current
= *state
? *state
: c
;
464 l
= strcspn(current
, delimiter
);
470 return pa_xstrndup(current
, l
);
473 /* What is interpreted as whitespace? */
474 #define WHITESPACE " \t\n"
476 /* Split a string into words. Otherwise similar to pa_split(). */
477 char *pa_split_spaces(const char *c
, const char **state
) {
478 const char *current
= *state
? *state
: c
;
484 current
+= strspn(current
, WHITESPACE
);
485 l
= strcspn(current
, WHITESPACE
);
489 return pa_xstrndup(current
, l
);
492 /* Return the name of an UNIX signal. Similar to GNU's strsignal() */
493 const char *pa_strsignal(int sig
) {
495 case SIGINT
: return "SIGINT";
496 case SIGTERM
: return "SIGTERM";
497 case SIGUSR1
: return "SIGUSR1";
498 case SIGUSR2
: return "SIGUSR2";
499 case SIGXCPU
: return "SIGXCPU";
500 case SIGPIPE
: return "SIGPIPE";
501 case SIGCHLD
: return "SIGCHLD";
502 case SIGHUP
: return "SIGHUP";
503 default: return "UNKNOWN SIGNAL";
507 /* Parse a libsamplrate compatible resampling implementation */
508 int pa_parse_resample_method(const char *string
) {
511 if (!strcmp(string
, "sinc-best-quality"))
512 return SRC_SINC_BEST_QUALITY
;
513 else if (!strcmp(string
, "sinc-medium-quality"))
514 return SRC_SINC_MEDIUM_QUALITY
;
515 else if (!strcmp(string
, "sinc-fastest"))
516 return SRC_SINC_FASTEST
;
517 else if (!strcmp(string
, "zero-order-hold"))
518 return SRC_ZERO_ORDER_HOLD
;
519 else if (!strcmp(string
, "linear"))
525 /* Check whether the specified GID and the group name match */
526 static int is_group(gid_t gid
, const char *name
) {
527 struct group group
, *result
= NULL
;
532 #ifdef HAVE_GETGRGID_R
533 #ifdef _SC_GETGR_R_SIZE_MAX
534 n
= sysconf(_SC_GETGR_R_SIZE_MAX
);
539 data
= pa_xmalloc(n
);
541 if (getgrgid_r(gid
, &group
, data
, n
, &result
) < 0 || !result
) {
542 pa_log(__FILE__
": getgrgid_r(%u) failed: %s\n", gid
, strerror(errno
));
547 r
= strcmp(name
, result
->gr_name
) == 0;
552 /* XXX Not thread-safe, but needed on OSes (e.g. FreeBSD 4.X) that do not
553 * support getgrgid_r. */
554 if ((result
= getgrgid(gid
)) == NULL
) {
555 pa_log(__FILE__
": getgrgid(%u) failed: %s\n", gid
, strerror(errno
));
559 r
= strcmp(name
, result
->gr_name
) == 0;
567 /* Check the current user is member of the specified group */
568 int pa_uid_in_group(const char *name
, gid_t
*gid
) {
570 long n
= sysconf(_SC_NGROUPS_MAX
);
575 gids
= pa_xmalloc(sizeof(gid_t
)*n
);
577 if ((n
= getgroups(n
, gids
)) < 0) {
578 pa_log(__FILE__
": getgroups() failed: %s\n", strerror(errno
));
582 for (i
= 0; i
< n
; i
++) {
583 if (is_group(gids
[i
], name
) > 0) {
590 if (is_group(tgid
= getgid(), name
) > 0) {
604 /* Lock or unlock a file entirely. (advisory) */
605 int pa_lock_fd(int fd
, int b
) {
609 flock
.l_type
= b
? F_WRLCK
: F_UNLCK
;
610 flock
.l_whence
= SEEK_SET
;
614 if (fcntl(fd
, F_SETLKW
, &flock
) < 0) {
615 pa_log(__FILE__
": %slock failed: %s\n", !b
? "un" : "", strerror(errno
));
622 /* Remove trailing newlines from a string */
623 char* pa_strip_nl(char *s
) {
626 s
[strcspn(s
, "\r\n")] = 0;
630 /* Create a temporary lock file and lock it. */
631 int pa_lock_lockfile(const char *fn
) {
635 if ((fd
= open(fn
, O_CREAT
|O_RDWR
, S_IRUSR
|S_IWUSR
)) < 0) {
636 pa_log(__FILE__
": failed to create lock file '%s'\n", fn
);
640 if (pa_lock_fd(fd
, 1) < 0)
653 /* Unlock a temporary lcok file */
654 int pa_unlock_lockfile(int fd
) {
658 if (pa_lock_fd(fd
, 0) < 0) {
659 pa_log(__FILE__
": WARNING: failed to unlock file.\n");
664 pa_log(__FILE__
": WARNING: failed to close lock file.\n");
671 /* Try to open a configuration file. If "env" is specified, open the
672 * value of the specified environment variable. Otherwise look for a
673 * file "local" in the home directory or a file "global" in global
674 * file system. If "result" is non-NULL, a pointer to a newly
675 * allocated buffer containing the used configuration file is
677 FILE *pa_open_config_file(const char *global
, const char *local
, const char *env
, char **result
) {
681 if (env
&& (e
= getenv(env
))) {
683 *result
= pa_xstrdup(e
);
684 return fopen(e
, "r");
687 if (local
&& pa_get_home_dir(h
, sizeof(h
))) {
691 l
= pa_sprintf_malloc("%s/%s", h
, local
);
694 if (f
|| errno
!= ENOENT
) {
713 *result
= pa_xstrdup(global
);
715 return fopen(global
, "r");
718 /* Format the specified data as a hexademical string */
719 char *pa_hexstr(const uint8_t* d
, size_t dlength
, char *s
, size_t slength
) {
721 const char hex
[] = "0123456789abcdef";
722 assert(d
&& s
&& slength
> 0);
724 while (i
< dlength
&& j
+3 <= slength
) {
725 s
[j
++] = hex
[*d
>> 4];
726 s
[j
++] = hex
[*d
& 0xF];
732 s
[j
< slength
? j
: slength
] = 0;
736 /* Convert a hexadecimal digit to a number or -1 if invalid */
737 static int hexc(char c
) {
738 if (c
>= '0' && c
<= '9')
741 if (c
>= 'A' && c
<= 'F')
744 if (c
>= 'a' && c
<= 'f')
750 /* Parse a hexadecimal string as created by pa_hexstr() to a BLOB */
751 size_t pa_parsehex(const char *p
, uint8_t *d
, size_t dlength
) {
755 while (j
< dlength
&& *p
) {
758 if ((b
= hexc(*(p
++))) < 0)
761 d
[j
] = (uint8_t) (b
<< 4);
766 if ((b
= hexc(*(p
++))) < 0)