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 int pa_parse_boolean(const char *s) PA_GCC_PURE;
  84
  85 static inline const char *pa_yes_no(pa_bool_t b) {
  86     return b ? "yes" : "no";
  87 }
  88
  89 static inline const char *pa_strnull(const char *x) {
  90     return x ? x : "(null)";
  91 }
  92
  93 static inline const char *pa_strempty(const char *x) {
  94     return x ? x : "";
  95 }
  96
  97 static inline const char *pa_strna(const char *x) {
  98     return x ? x : "n/a";
  99 }
 100
 101 char *pa_split(const char *c, const char*delimiters, const char **state);
 102 char *pa_split_spaces(const char *c, const char **state);
 103
 104 char *pa_strip_nl(char *s);
 105 char *pa_strip(char *s);
 106
 107 const char *pa_sig2str(int sig) PA_GCC_PURE;
 108
 109 int pa_own_uid_in_group(const char *name, gid_t *gid);
 110 int pa_uid_in_group(uid_t uid, const char *name);
 111 gid_t pa_get_gid_of_group(const char *name);
 112 int pa_check_in_group(gid_t g);
 113
 114 int pa_lock_fd(int fd, int b);
 115
 116 int pa_lock_lockfile(const char *fn);
 117 int pa_unlock_lockfile(const char *fn, int fd);
 118
 119 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 120 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 121
 122 pa_bool_t pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 123 pa_bool_t pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 124
 125 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 126 char* pa_find_config_file(const char *global, const char *local, const char *env);
 127
 128 char *pa_get_runtime_dir(void);
 129 char *pa_get_state_dir(void);
 130 char *pa_get_home_dir_malloc(void);
 131 char *pa_get_binary_name_malloc(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 int pa_match(const char *expr, const char *v);
 145
 146 char *pa_getcwd(void);
 147 char *pa_make_path_absolute(const char *p);
 148 pa_bool_t pa_is_path_absolute(const char *p);
 149
 150 void *pa_will_need(const void *p, size_t l);
 151
 152 static inline int pa_is_power_of_two(unsigned n) {
 153     return !(n & (n - 1));
 154 }
 155
 156 static inline unsigned pa_ulog2(unsigned n) {
 157
 158     if (n <= 1)
 159         return 0;
 160
 161 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 162     return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
 163 #else
 164 {
 165     unsigned r = 0;
 166
 167     for (;;) {
 168         n = n >> 1;
 169
 170         if (!n)
 171             return r;
 172
 173         r++;
 174     }
 175 }
 176 #endif
 177 }
 178
 179 static inline unsigned pa_make_power_of_two(unsigned n) {
 180
 181     if (pa_is_power_of_two(n))
 182         return n;
 183
 184     return 1U << (pa_ulog2(n) + 1);
 185 }
 186
 187 void pa_close_pipe(int fds[2]);
 188
 189 char *pa_readlink(const char *p);
 190
 191 int pa_close_all(int except_fd, ...);
 192 int pa_close_allv(const int except_fds[]);
 193 int pa_unblock_sigs(int except, ...);
 194 int pa_unblock_sigsv(const int except[]);
 195 int pa_reset_sigs(int except, ...);
 196 int pa_reset_sigsv(const int except[]);
 197
 198 void pa_set_env(const char *key, const char *value);
 199 void pa_set_env_and_record(const char *key, const char *value);
 200 void pa_unset_env_recorded(void);
 201
 202 pa_bool_t pa_in_system_mode(void);
 203
 204 #define pa_streq(a,b) (!strcmp((a),(b)))
 205
 206 char *pa_get_host_name_malloc(void);
 207 char *pa_get_user_name_malloc(void);
 208
 209 char *pa_machine_id(void);
 210 char *pa_session_id(void);
 211 char *pa_uname_string(void);
 212
 213 #ifdef HAVE_VALGRIND_MEMCHECK_H
 214 pa_bool_t pa_in_valgrind(void);
 215 #else
 216 static inline pa_bool_t pa_in_valgrind(void) {
 217     return FALSE;
 218 }
 219 #endif
 220
 221 unsigned pa_gcd(unsigned a, unsigned b);
 222 void pa_reduce(unsigned *num, unsigned *den);
 223
 224 unsigned pa_ncpus(void);
 225
 226 char *pa_replace(const char*s, const char*a, const char *b);
 227
 228 char *pa_unescape(char *p);
 229
 230 char *pa_realpath(const char *path);
 231
 232 void pa_disable_sigpipe(void);
 233
 234 void pa_xfreev(void**a);
 235
 236 static inline void pa_xstrfreev(char **a) {
 237     pa_xfreev((void**) a);
 238 }
 239
 240 char **pa_split_spaces_strv(const char *s);
 241
 242 char* pa_maybe_prefix_path(const char *path, const char *prefix);
 243
 244 /* Returns size of the specified pipe or 4096 on failure */
 245 size_t pa_pipe_buf(int fd);
 246
 247 void pa_reset_personality(void);
 248
 249 #if defined(__linux__) && !defined(__OPTIMIZE__)
 250 pa_bool_t pa_run_from_build_tree(void);
 251 #endif
 252
 253 const char *pa_get_temp_dir(void);
 254
 255 char *pa_read_line_from_file(const char *fn);
 256 pa_bool_t pa_running_in_vm(void);
 257
 258 #endif