code.delx.au - pulseaudio/blob - src/pulsecore/core-util.h

   1 #ifndef foocoreutilhfoo
   2 #define foocoreutilhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10   Copyright 2006-2007 Pierre Ossman <ossman@cendio.se> for Cendio AB
  11
  12   PulseAudio is free software; you can redistribute it and/or modify
  13   it under the terms of the GNU Lesser General Public License as
  14   published by the Free Software Foundation; either version 2.1 of the
  15   License, or (at your option) any later version.
  16
  17   PulseAudio is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public
  23   License along with PulseAudio; if not, write to the Free Software
  24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25   USA.
  26 ***/
  27
  28 #include <sys/types.h>
  29 #include <inttypes.h>
  30 #include <stdarg.h>
  31 #include <stdio.h>
  32
  33 #ifdef HAVE_SYS_RESOURCE_H
  34 #include <sys/resource.h>
  35 #endif
  36
  37 #include <pulse/gccmacro.h>
  38 #include <pulsecore/macro.h>
  39
  40 struct timeval;
  41
  42 /* These resource limits are pretty new on Linux, let's define them
  43  * here manually, in case the kernel is newer than the glibc */
  44 #if !defined(RLIMIT_NICE) && defined(__linux__)
  45 #define RLIMIT_NICE 13
  46 #endif
  47 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
  48 #define RLIMIT_RTPRIO 14
  49 #endif
  50 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
  51 #define RLIMIT_RTTIME 15
  52 #endif
  53
  54 void pa_make_fd_nonblock(int fd);
  55 void pa_make_fd_cloexec(int fd);
  56
  57 int pa_make_secure_dir(const char* dir, mode_t m, uid_t uid, gid_t gid);
  58 int pa_make_secure_parent_dir(const char *fn, mode_t, uid_t uid, gid_t gid);
  59
  60 ssize_t pa_read(int fd, void *buf, size_t count, int *type);
  61 ssize_t pa_write(int fd, const void *buf, size_t count, int *type);
  62 ssize_t pa_loop_read(int fd, void*data, size_t size, int *type);
  63 ssize_t pa_loop_write(int fd, const void*data, size_t size, int *type);
  64
  65 int pa_close(int fd);
  66
  67 void pa_check_signal_is_blocked(int sig);
  68
  69 char *pa_sprintf_malloc(const char *format, ...) PA_GCC_PRINTF_ATTR(1,2);
  70 char *pa_vsprintf_malloc(const char *format, va_list ap);
  71
  72 char *pa_strlcpy(char *b, const char *s, size_t l);
  73
  74 char *pa_parent_dir(const char *fn);
  75
  76 int pa_make_realtime(int rtprio);
  77 int pa_raise_priority(int nice_level);
  78 void pa_reset_priority(void);
  79
  80 pa_bool_t pa_can_realtime(void);
  81 pa_bool_t pa_can_high_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 char *pa_split(const char *c, const char*delimiters, const char **state);
  98 char *pa_split_spaces(const char *c, const char **state);
  99
 100 char *pa_strip_nl(char *s);
 101
 102 const char *pa_sig2str(int sig) PA_GCC_PURE;
 103
 104 int pa_own_uid_in_group(const char *name, gid_t *gid);
 105 int pa_uid_in_group(uid_t uid, const char *name);
 106 gid_t pa_get_gid_of_group(const char *name);
 107 int pa_check_in_group(gid_t g);
 108
 109 int pa_lock_fd(int fd, int b);
 110
 111 int pa_lock_lockfile(const char *fn);
 112 int pa_unlock_lockfile(const char *fn, int fd);
 113
 114 char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
 115 size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
 116
 117 int pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
 118 int pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
 119
 120 FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
 121 char* pa_find_config_file(const char *global, const char *local, const char *env);
 122
 123 char *pa_get_runtime_dir(void);
 124 char *pa_runtime_path(const char *fn);
 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_atof(const char *s, float *ret_f);
 129
 130 int pa_snprintf(char *str, size_t size, const char *format, ...);
 131 int 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_make_power_of_two(unsigned n) {
 146     unsigned j = n;
 147
 148     if (pa_is_power_of_two(n))
 149         return n;
 150
 151     while (j) {
 152         j = j >> 1;
 153         n = n | j;
 154     }
 155
 156     return n + 1;
 157 }
 158
 159 static inline unsigned pa_ulog2(unsigned n) {
 160     unsigned r = 0;
 161
 162     while (n) {
 163         r++;
 164         n = n >> 1;
 165     }
 166
 167     return r;
 168 }
 169
 170 void pa_close_pipe(int fds[2]);
 171
 172 char *pa_readlink(const char *p);
 173
 174 int pa_close_all(int except_fd, ...);
 175 int pa_close_allv(const int except_fds[]);
 176 int pa_unblock_sigs(int except, ...);
 177 int pa_unblock_sigsv(const int except[]);
 178 int pa_reset_sigs(int except, ...);
 179 int pa_reset_sigsv(const int except[]);
 180
 181 void pa_set_env(const char *key, const char *value);
 182
 183 #endif