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