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
  31 #ifdef HAVE_SYS_RESOURCE_H
  32 #include <sys/resource.h>
  33 #endif
  34
  35 #include <pulse/gccmacro.h>
  36 #include <pulsecore/macro.h>
  37
  38 #ifndef PACKAGE
  39 #error "Please include config.h before including this file!"
  40 #endif
  41
  42 struct timeval;
  43
  44 /* These resource limits are pretty new on Linux, let's define them
  45  * here manually, in case the kernel is newer than the glibc */
  46 #if !defined(RLIMIT_NICE) && defined(__linux__)
  47 #define RLIMIT_NICE 13
  48 #endif
  49 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
  50 #define RLIMIT_RTPRIO 14
  51 #endif
  52 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
  53 #define RLIMIT_RTTIME 15
  54 #endif
  55
  56 void pa_make_fd_nonblock(int fd);
  57 void pa_make_fd_cloexec(int fd);
  58
  59 int pa_make_secure_dir(const char* dir, mode_t m, uid_t uid, gid_t gid);
  60 int pa_make_secure_parent_dir(const char *fn, mode_t, uid_t uid, gid_t gid);
  61
  62 ssize_t pa_read(int fd, void *buf, size_t count, int *type);
  63 ssize_t pa_write(int fd, const void *buf, size_t count, int *type);
  64 ssize_t pa_loop_read(int fd, void*data, size_t size, int *type);
  65 ssize_t pa_loop_write(int fd, const void*data, size_t size, int *type);
  66
  67 int pa_close(int fd);
  68
  69 void pa_check_signal_is_blocked(int sig);
  70
  71 char *pa_sprintf_malloc(const char *format, ...) PA_GCC_PRINTF_ATTR(1,2);
  72 char *pa_vsprintf_malloc(const char *format, va_list ap);
  73
  74 char *pa_strlcpy(char *b, const char *s, size_t l);
  75
  76 char *pa_parent_dir(const char *fn);
  77
  78 int pa_make_realtime(int rtprio);
  79 int pa_raise_priority(int nice_level);
  80 void pa_reset_priority(void);
  81
  82 pa_bool_t pa_can_realtime(void);
  83 pa_bool_t pa_can_high_priority(void);
  84
  85 int pa_parse_boolean(const char *s) PA_GCC_PURE;
  86
  87 static inline const char *pa_yes_no(pa_bool_t b) {
  88     return b ? "yes" : "no";
  89 }
  90
  91 static inline const char *pa_strnull(const char *x) {
  92     return x ? x : "(null)";
  93 }
  94
  95 static inline const char *pa_strempty(const char *x) {
  96     return x ? x : "";
  97 }
  98
  99 char *pa_split(const char *c, const char*delimiters, const char **state);
 100 char *pa_split_spaces(const char *c, const char **state);
 101
 102 char *pa_strip_nl(char *s);
 103
 104 const char *pa_sig2str(int sig) PA_GCC_PURE;
 105
 106 int pa_own_uid_in_group(const char *name, gid_t *gid);
 107 int pa_uid_in_group(uid_t uid, const char *name);
 108 gid_t pa_get_gid_of_group(const char *name);
 109 int pa_check_in_group(gid_t g);
 110
 111 int pa_lock_fd(int fd, int b);
 112
 113 int pa_lock_lockfile(const char *fn);
 114 int pa_unlock_lockfile(const char *fn, int fd);
 115
 116 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 117 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 118
 119 pa_bool_t pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 120 pa_bool_t pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 121
 122 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 123 char* pa_find_config_file(const char *global, const char *local, const char *env);
 124
 125 char *pa_get_runtime_dir(void);
 126 char *pa_get_state_dir(void);
 127 char *pa_runtime_path(const char *fn);
 128 char *pa_state_path(const char *fn, pa_bool_t prepend_machine_id);
 129
 130 int pa_atoi(const char *s, int32_t *ret_i);
 131 int pa_atou(const char *s, uint32_t *ret_u);
 132 int pa_atod(const char *s, double *ret_d);
 133
 134 size_t pa_snprintf(char *str, size_t size, const char *format, ...);
 135 size_t pa_vsnprintf(char *str, size_t size, const char *format, va_list ap);
 136
 137 char *pa_truncate_utf8(char *c, size_t l);
 138
 139 char *pa_getcwd(void);
 140 char *pa_make_path_absolute(const char *p);
 141 pa_bool_t pa_is_path_absolute(const char *p);
 142
 143 void *pa_will_need(const void *p, size_t l);
 144
 145 static inline int pa_is_power_of_two(unsigned n) {
 146     return !(n & (n - 1));
 147 }
 148
 149 static inline unsigned pa_ulog2(unsigned n) {
 150
 151     if (n <= 1)
 152         return 0;
 153
 154 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 155     return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
 156 #else
 157 {
 158     unsigned r = 0;
 159
 160     for (;;) {
 161         n = n >> 1;
 162
 163         if (!n)
 164             return r;
 165
 166         r++;
 167     }
 168 }
 169 #endif
 170 }
 171
 172 static inline unsigned pa_make_power_of_two(unsigned n) {
 173
 174     if (pa_is_power_of_two(n))
 175         return n;
 176
 177     return 1U << (pa_ulog2(n) + 1);
 178 }
 179
 180 void pa_close_pipe(int fds[2]);
 181
 182 char *pa_readlink(const char *p);
 183
 184 int pa_close_all(int except_fd, ...);
 185 int pa_close_allv(const int except_fds[]);
 186 int pa_unblock_sigs(int except, ...);
 187 int pa_unblock_sigsv(const int except[]);
 188 int pa_reset_sigs(int except, ...);
 189 int pa_reset_sigsv(const int except[]);
 190
 191 void pa_set_env(const char *key, const char *value);
 192
 193 pa_bool_t pa_in_system_mode(void);
 194
 195 #define pa_streq(a,b) (!strcmp((a),(b)))
 196
 197 char *pa_machine_id(void);
 198 char *pa_uname_string(void);
 199
 200
 201 #ifdef HAVE_VALGRIND_MEMCHECK_H
 202 pa_bool_t pa_in_valgrind(void);
 203 #else
 204 static inline pa_bool_t pa_in_valgrind(void) {
 205     return FALSE;
 206 }
 207 #endif
 208
 209 #endif