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 #include <pulsecore/socket.h>
  39
  40 #ifndef PACKAGE
  41 #error "Please include config.h before including this file!"
  42 #endif
  43
  44 struct timeval;
  45
  46 /* These resource limits are pretty new on Linux, let's define them
  47  * here manually, in case the kernel is newer than the glibc */
  48 #if !defined(RLIMIT_NICE) && defined(__linux__)
  49 #define RLIMIT_NICE 13
  50 #endif
  51 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
  52 #define RLIMIT_RTPRIO 14
  53 #endif
  54 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
  55 #define RLIMIT_RTTIME 15
  56 #endif
  57
  58 void pa_make_fd_nonblock(int fd);
  59 void pa_make_fd_cloexec(int fd);
  60
  61 int pa_make_secure_dir(const char* dir, mode_t m, uid_t uid, gid_t gid);
  62 int pa_make_secure_parent_dir(const char *fn, mode_t, uid_t uid, gid_t gid);
  63
  64 ssize_t pa_read(int fd, void *buf, size_t count, int *type);
  65 ssize_t pa_write(int fd, const void *buf, size_t count, int *type);
  66 ssize_t pa_loop_read(int fd, void*data, size_t size, int *type);
  67 ssize_t pa_loop_write(int fd, const void*data, size_t size, int *type);
  68
  69 int pa_close(int fd);
  70
  71 void pa_check_signal_is_blocked(int sig);
  72
  73 char *pa_sprintf_malloc(const char *format, ...) PA_GCC_PRINTF_ATTR(1,2);
  74 char *pa_vsprintf_malloc(const char *format, va_list ap);
  75
  76 char *pa_strlcpy(char *b, const char *s, size_t l);
  77
  78 char *pa_parent_dir(const char *fn);
  79
  80 int pa_make_realtime(int rtprio);
  81 int pa_raise_priority(int nice_level);
  82 void pa_reset_priority(void);
  83
  84 int pa_parse_boolean(const char *s) PA_GCC_PURE;
  85
  86 static inline const char *pa_yes_no(pa_bool_t b) {
  87     return b ? "yes" : "no";
  88 }
  89
  90 static inline const char *pa_strnull(const char *x) {
  91     return x ? x : "(null)";
  92 }
  93
  94 static inline const char *pa_strempty(const char *x) {
  95     return x ? x : "";
  96 }
  97
  98 static inline const char *pa_strna(const char *x) {
  99     return x ? x : "n/a";
 100 }
 101
 102 char *pa_split(const char *c, const char*delimiters, const char **state);
 103 char *pa_split_spaces(const char *c, const char **state);
 104
 105 char *pa_strip_nl(char *s);
 106 char *pa_strip(char *s);
 107
 108 const char *pa_sig2str(int sig) PA_GCC_PURE;
 109
 110 int pa_own_uid_in_group(const char *name, gid_t *gid);
 111 int pa_uid_in_group(uid_t uid, const char *name);
 112 gid_t pa_get_gid_of_group(const char *name);
 113 int pa_check_in_group(gid_t g);
 114
 115 int pa_lock_fd(int fd, int b);
 116
 117 int pa_lock_lockfile(const char *fn);
 118 int pa_unlock_lockfile(const char *fn, int fd);
 119
 120 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 121 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 122
 123 pa_bool_t pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 124 pa_bool_t pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 125
 126 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 127 char* pa_find_config_file(const char *global, const char *local, const char *env);
 128
 129 char *pa_get_runtime_dir(void);
 130 char *pa_get_state_dir(void);
 131 char *pa_get_home_dir_malloc(void);
 132 char *pa_get_binary_name_malloc(void);
 133 char *pa_runtime_path(const char *fn);
 134 char *pa_state_path(const char *fn, pa_bool_t prepend_machine_id);
 135
 136 int pa_atoi(const char *s, int32_t *ret_i);
 137 int pa_atou(const char *s, uint32_t *ret_u);
 138 int pa_atol(const char *s, long *ret_l);
 139 int pa_atod(const char *s, double *ret_d);
 140
 141 size_t pa_snprintf(char *str, size_t size, const char *format, ...);
 142 size_t pa_vsnprintf(char *str, size_t size, const char *format, va_list ap);
 143
 144 char *pa_truncate_utf8(char *c, size_t l);
 145
 146 int pa_match(const char *expr, const char *v);
 147
 148 char *pa_getcwd(void);
 149 char *pa_make_path_absolute(const char *p);
 150 pa_bool_t pa_is_path_absolute(const char *p);
 151
 152 void *pa_will_need(const void *p, size_t l);
 153
 154 static inline int pa_is_power_of_two(unsigned n) {
 155     return !(n & (n - 1));
 156 }
 157
 158 static inline unsigned pa_ulog2(unsigned n) {
 159
 160     if (n <= 1)
 161         return 0;
 162
 163 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 164     return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
 165 #else
 166 {
 167     unsigned r = 0;
 168
 169     for (;;) {
 170         n = n >> 1;
 171
 172         if (!n)
 173             return r;
 174
 175         r++;
 176     }
 177 }
 178 #endif
 179 }
 180
 181 static inline unsigned pa_make_power_of_two(unsigned n) {
 182
 183     if (pa_is_power_of_two(n))
 184         return n;
 185
 186     return 1U << (pa_ulog2(n) + 1);
 187 }
 188
 189 void pa_close_pipe(int fds[2]);
 190
 191 char *pa_readlink(const char *p);
 192
 193 int pa_close_all(int except_fd, ...);
 194 int pa_close_allv(const int except_fds[]);
 195 int pa_unblock_sigs(int except, ...);
 196 int pa_unblock_sigsv(const int except[]);
 197 int pa_reset_sigs(int except, ...);
 198 int pa_reset_sigsv(const int except[]);
 199
 200 void pa_set_env(const char *key, const char *value);
 201 void pa_set_env_and_record(const char *key, const char *value);
 202 void pa_unset_env_recorded(void);
 203
 204 pa_bool_t pa_in_system_mode(void);
 205
 206 #define pa_streq(a,b) (!strcmp((a),(b)))
 207
 208 char *pa_get_host_name_malloc(void);
 209 char *pa_get_user_name_malloc(void);
 210
 211 char *pa_machine_id(void);
 212 char *pa_session_id(void);
 213 char *pa_uname_string(void);
 214
 215 #ifdef HAVE_VALGRIND_MEMCHECK_H
 216 pa_bool_t pa_in_valgrind(void);
 217 #else
 218 static inline pa_bool_t pa_in_valgrind(void) {
 219     return FALSE;
 220 }
 221 #endif
 222
 223 unsigned pa_gcd(unsigned a, unsigned b);
 224 void pa_reduce(unsigned *num, unsigned *den);
 225
 226 unsigned pa_ncpus(void);
 227
 228 char *pa_replace(const char*s, const char*a, const char *b);
 229
 230 /* Escapes p by inserting backslashes in front of backslashes. chars is a
 231  * regular (ie. NULL-terminated) string containing additional characters that
 232  * should be escaped. chars can be NULL. The caller has to free the returned
 233  * string. */
 234 char *pa_escape(const char *p, const char *chars);
 235
 236 /* Does regular backslash unescaping. Returns the argument p. */
 237 char *pa_unescape(char *p);
 238
 239 char *pa_realpath(const char *path);
 240
 241 void pa_disable_sigpipe(void);
 242
 243 void pa_xfreev(void**a);
 244
 245 static inline void pa_xstrfreev(char **a) {
 246     pa_xfreev((void**) a);
 247 }
 248
 249 char **pa_split_spaces_strv(const char *s);
 250
 251 char* pa_maybe_prefix_path(const char *path, const char *prefix);
 252
 253 /* Returns size of the specified pipe or 4096 on failure */
 254 size_t pa_pipe_buf(int fd);
 255
 256 void pa_reset_personality(void);
 257
 258 /* We abuse __OPTIMIZE__ as a check whether we are a debug build
 259  * or not. If we are and are run from the build tree then we
 260  * override the search path to point to our build tree */
 261 #if defined(__linux__) && !defined(__OPTIMIZE__)
 262 pa_bool_t pa_run_from_build_tree(void);
 263 #else
 264 static inline pa_bool_t pa_run_from_build_tree(void) {return FALSE;}
 265 #endif
 266
 267 const char *pa_get_temp_dir(void);
 268
 269 int pa_open_cloexec(const char *fn, int flags, mode_t mode);
 270 int pa_socket_cloexec(int domain, int type, int protocol);
 271 int pa_pipe_cloexec(int pipefd[2]);
 272 int pa_accept_cloexec(int sockfd, struct sockaddr *addr, socklen_t *addrlen);
 273 FILE* pa_fopen_cloexec(const char *path, const char *mode);
 274
 275 void pa_nullify_stdfds(void);
 276
 277 char *pa_read_line_from_file(const char *fn);
 278 pa_bool_t pa_running_in_vm(void);
 279
 280 #ifdef OS_IS_WIN32
 281 char *pa_win32_get_toplevel(HANDLE handle);
 282 #endif
 283
 284 #endif