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