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
 106 const char *pa_sig2str(int sig) PA_GCC_PURE;
 107
 108 int pa_own_uid_in_group(const char *name, gid_t *gid);
 109 int pa_uid_in_group(uid_t uid, const char *name);
 110 gid_t pa_get_gid_of_group(const char *name);
 111 int pa_check_in_group(gid_t g);
 112
 113 int pa_lock_fd(int fd, int b);
 114
 115 int pa_lock_lockfile(const char *fn);
 116 int pa_unlock_lockfile(const char *fn, int fd);
 117
 118 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 119 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 120
 121 pa_bool_t pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 122 pa_bool_t pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 123
 124 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 125 char* pa_find_config_file(const char *global, const char *local, const char *env);
 126
 127 char *pa_get_runtime_dir(void);
 128 char *pa_get_state_dir(void);
 129 char *pa_get_home_dir_malloc(void);
 130 char *pa_get_binary_name_malloc(void);
 131 char *pa_runtime_path(const char *fn);
 132 char *pa_state_path(const char *fn, pa_bool_t prepend_machine_id);
 133
 134 int pa_atoi(const char *s, int32_t *ret_i);
 135 int pa_atou(const char *s, uint32_t *ret_u);
 136 int pa_atod(const char *s, double *ret_d);
 137
 138 size_t pa_snprintf(char *str, size_t size, const char *format, ...);
 139 size_t pa_vsnprintf(char *str, size_t size, const char *format, va_list ap);
 140
 141 char *pa_truncate_utf8(char *c, size_t l);
 142
 143 int pa_match(const char *expr, const char *v);
 144
 145 char *pa_getcwd(void);
 146 char *pa_make_path_absolute(const char *p);
 147 pa_bool_t pa_is_path_absolute(const char *p);
 148
 149 void *pa_will_need(const void *p, size_t l);
 150
 151 static inline int pa_is_power_of_two(unsigned n) {
 152     return !(n & (n - 1));
 153 }
 154
 155 static inline unsigned pa_ulog2(unsigned n) {
 156
 157     if (n <= 1)
 158         return 0;
 159
 160 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 161     return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
 162 #else
 163 {
 164     unsigned r = 0;
 165
 166     for (;;) {
 167         n = n >> 1;
 168
 169         if (!n)
 170             return r;
 171
 172         r++;
 173     }
 174 }
 175 #endif
 176 }
 177
 178 static inline unsigned pa_make_power_of_two(unsigned n) {
 179
 180     if (pa_is_power_of_two(n))
 181         return n;
 182
 183     return 1U << (pa_ulog2(n) + 1);
 184 }
 185
 186 void pa_close_pipe(int fds[2]);
 187
 188 char *pa_readlink(const char *p);
 189
 190 int pa_close_all(int except_fd, ...);
 191 int pa_close_allv(const int except_fds[]);
 192 int pa_unblock_sigs(int except, ...);
 193 int pa_unblock_sigsv(const int except[]);
 194 int pa_reset_sigs(int except, ...);
 195 int pa_reset_sigsv(const int except[]);
 196
 197 void pa_set_env(const char *key, const char *value);
 198
 199 pa_bool_t pa_in_system_mode(void);
 200
 201 #define pa_streq(a,b) (!strcmp((a),(b)))
 202
 203 char *pa_get_host_name_malloc(void);
 204 char *pa_get_user_name_malloc(void);
 205
 206 char *pa_machine_id(void);
 207 char *pa_session_id(void);
 208 char *pa_uname_string(void);
 209
 210 #ifdef HAVE_VALGRIND_MEMCHECK_H
 211 pa_bool_t pa_in_valgrind(void);
 212 #else
 213 static inline pa_bool_t pa_in_valgrind(void) {
 214     return FALSE;
 215 }
 216 #endif
 217
 218 unsigned pa_gcd(unsigned a, unsigned b);
 219 void pa_reduce(unsigned *num, unsigned *den);
 220
 221 unsigned pa_ncpus(void);
 222
 223 char *pa_replace(const char*s, const char*a, const char *b);
 224
 225 char *pa_unescape(char *p);
 226
 227 char *pa_realpath(const char *path);
 228
 229 void pa_disable_sigpipe(void);
 230
 231 void pa_xfreev(void**a);
 232
 233 static inline void pa_xstrfreev(char **a) {
 234     pa_xfreev((void**) a);
 235 }
 236
 237 char **pa_split_spaces_strv(const char *s);
 238
 239 char* pa_maybe_prefix_path(const char *path, const char *prefix);
 240
 241 /* Returns size of the specified pipe or 4096 on failure */
 242 size_t pa_pipe_buf(int fd);
 243
 244 void pa_reset_personality(void);
 245
 246 #if defined(__linux__) && !defined(__OPTIMIZE__)
 247 pa_bool_t pa_run_from_build_tree(void);
 248 #endif
 249
 250 #endif