src/pulsecore/core-util.h

   1 #ifndef foocoreutilhfoo
   2 #define foocoreutilhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006-2007 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as
  12   published by the Free Software Foundation; either version 2.1 of the
  13   License, or (at your option) any later version.
  14
  15   PulseAudio is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public
  21   License along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <sys/types.h>
  27 #include <inttypes.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31
  32 #ifdef HAVE_SYS_RESOURCE_H
  33 #include <sys/resource.h>
  34 #endif
  35
  36 #include <pulse/gccmacro.h>
  37 #include <pulsecore/macro.h>
  38
  39 #ifndef PACKAGE
  40 #error "Please include config.h before including this file!"
  41 #endif
  42
  43 struct timeval;
  44
  45 /* These resource limits are pretty new on Linux, let's define them
  46  * here manually, in case the kernel is newer than the glibc */
  47 #if !defined(RLIMIT_NICE) && defined(__linux__)
  48 #define RLIMIT_NICE 13
  49 #endif
  50 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
  51 #define RLIMIT_RTPRIO 14
  52 #endif
  53 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
  54 #define RLIMIT_RTTIME 15
  55 #endif
  56
  57 void pa_make_fd_nonblock(int fd);
  58 void pa_make_fd_cloexec(int fd);
  59
  60 int pa_make_secure_dir(const char* dir, mode_t m, uid_t uid, gid_t gid);
  61 int pa_make_secure_parent_dir(const char *fn, mode_t, uid_t uid, gid_t gid);
  62
  63 ssize_t pa_read(int fd, void *buf, size_t count, int *type);
  64 ssize_t pa_write(int fd, const void *buf, size_t count, int *type);
  65 ssize_t pa_loop_read(int fd, void*data, size_t size, int *type);
  66 ssize_t pa_loop_write(int fd, const void*data, size_t size, int *type);
  67
  68 int pa_close(int fd);
  69
  70 void pa_check_signal_is_blocked(int sig);
  71
  72 char *pa_sprintf_malloc(const char *format, ...) PA_GCC_PRINTF_ATTR(1,2);
  73 char *pa_vsprintf_malloc(const char *format, va_list ap);
  74
  75 char *pa_strlcpy(char *b, const char *s, size_t l);
  76
  77 char *pa_parent_dir(const char *fn);
  78
  79 int pa_make_realtime(int rtprio);
  80 int pa_raise_priority(int nice_level);
  81 void pa_reset_priority(void);
  82
  83 pa_bool_t pa_can_realtime(void);
  84 pa_bool_t pa_can_high_priority(void);
  85
  86 int pa_parse_boolean(const char *s) PA_GCC_PURE;
  87
  88 static inline const char *pa_yes_no(pa_bool_t b) {
  89     return b ? "yes" : "no";
  90 }
  91
  92 static inline const char *pa_strnull(const char *x) {
  93     return x ? x : "(null)";
  94 }
  95
  96 static inline const char *pa_strempty(const char *x) {
  97     return x ? x : "";
  98 }
  99
 100 static inline const char *pa_strna(const char *x) {
 101     return x ? x : "n/a";
 102 }
 103
 104 char *pa_split(const char *c, const char*delimiters, const char **state);
 105 char *pa_split_spaces(const char *c, const char **state);
 106
 107 char *pa_strip_nl(char *s);
 108
 109 const char *pa_sig2str(int sig) PA_GCC_PURE;
 110
 111 int pa_own_uid_in_group(const char *name, gid_t *gid);
 112 int pa_uid_in_group(uid_t uid, const char *name);
 113 gid_t pa_get_gid_of_group(const char *name);
 114 int pa_check_in_group(gid_t g);
 115
 116 int pa_lock_fd(int fd, int b);
 117
 118 int pa_lock_lockfile(const char *fn);
 119 int pa_unlock_lockfile(const char *fn, int fd);
 120
 121 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 122 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 123
 124 pa_bool_t pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 125 pa_bool_t pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 126
 127 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 128 char* pa_find_config_file(const char *global, const char *local, const char *env);
 129
 130 char *pa_get_runtime_dir(void);
 131 char *pa_get_state_dir(void);
 132 char *pa_runtime_path(const char *fn);
 133 char *pa_state_path(const char *fn, pa_bool_t prepend_machine_id);
 134
 135 int pa_atoi(const char *s, int32_t *ret_i);
 136 int pa_atou(const char *s, uint32_t *ret_u);
 137 int pa_atod(const char *s, double *ret_d);
 138
 139 size_t pa_snprintf(char *str, size_t size, const char *format, ...);
 140 size_t pa_vsnprintf(char *str, size_t size, const char *format, va_list ap);
 141
 142 char *pa_truncate_utf8(char *c, size_t l);
 143
 144 char *pa_getcwd(void);
 145 char *pa_make_path_absolute(const char *p);
 146 pa_bool_t pa_is_path_absolute(const char *p);
 147
 148 void *pa_will_need(const void *p, size_t l);
 149
 150 static inline int pa_is_power_of_two(unsigned n) {
 151     return !(n & (n - 1));
 152 }
 153
 154 static inline unsigned pa_ulog2(unsigned n) {
 155
 156     if (n <= 1)
 157         return 0;
 158
 159 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 160     return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
 161 #else
 162 {
 163     unsigned r = 0;
 164
 165     for (;;) {
 166         n = n >> 1;
 167
 168         if (!n)
 169             return r;
 170
 171         r++;
 172     }
 173 }
 174 #endif
 175 }
 176
 177 static inline unsigned pa_make_power_of_two(unsigned n) {
 178
 179     if (pa_is_power_of_two(n))
 180         return n;
 181
 182     return 1U << (pa_ulog2(n) + 1);
 183 }
 184
 185 void pa_close_pipe(int fds[2]);
 186
 187 char *pa_readlink(const char *p);
 188
 189 int pa_close_all(int except_fd, ...);
 190 int pa_close_allv(const int except_fds[]);
 191 int pa_unblock_sigs(int except, ...);
 192 int pa_unblock_sigsv(const int except[]);
 193 int pa_reset_sigs(int except, ...);
 194 int pa_reset_sigsv(const int except[]);
 195
 196 void pa_set_env(const char *key, const char *value);
 197
 198 pa_bool_t pa_in_system_mode(void);
 199
 200 #define pa_streq(a,b) (!strcmp((a),(b)))
 201
 202 char *pa_machine_id(void);
 203 char *pa_uname_string(void);
 204
 205 #ifdef HAVE_VALGRIND_MEMCHECK_H
 206 pa_bool_t pa_in_valgrind(void);
 207 #else
 208 static inline pa_bool_t pa_in_valgrind(void) {
 209     return FALSE;
 210 }
 211 #endif
 212
 213 unsigned pa_gcd(unsigned a, unsigned b);
 214 void pa_reduce(unsigned *num, unsigned *den);
 215
 216 unsigned pa_ncpus(void);
 217
 218 char *pa_replace(const char*s, const char*a, const char *b);
 219
 220 char *pa_unescape(char *p);
 221
 222 #endif