1 #ifndef foocoreutilhfoo
2 #define foocoreutilhfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006-2007 Pierre Ossman <ossman@cendio.se> for Cendio AB
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.
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.
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
26 #include <sys/types.h>
32 #ifdef HAVE_SYS_RESOURCE_H
33 #include <sys/resource.h>
36 #include <pulse/gccmacro.h>
37 #include <pulsecore/macro.h>
40 #error "Please include config.h before including this file!"
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
50 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
51 #define RLIMIT_RTPRIO 14
53 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
54 #define RLIMIT_RTTIME 15
57 void pa_make_fd_nonblock(int fd
);
58 void pa_make_fd_cloexec(int fd
);
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
);
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
);
70 void pa_check_signal_is_blocked(int sig
);
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
);
75 char *pa_strlcpy(char *b
, const char *s
, size_t l
);
77 char *pa_parent_dir(const char *fn
);
79 int pa_make_realtime(int rtprio
);
80 int pa_raise_priority(int nice_level
);
81 void pa_reset_priority(void);
83 int pa_parse_boolean(const char *s
) PA_GCC_PURE
;
85 static inline const char *pa_yes_no(pa_bool_t b
) {
86 return b
? "yes" : "no";
89 static inline const char *pa_strnull(const char *x
) {
90 return x
? x
: "(null)";
93 static inline const char *pa_strempty(const char *x
) {
97 static inline const char *pa_strna(const char *x
) {
101 char *pa_split(const char *c
, const char*delimiters
, const char **state
);
102 char *pa_split_spaces(const char *c
, const char **state
);
104 char *pa_strip_nl(char *s
);
106 const char *pa_sig2str(int sig
) PA_GCC_PURE
;
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
);
113 int pa_lock_fd(int fd
, int b
);
115 int pa_lock_lockfile(const char *fn
);
116 int pa_unlock_lockfile(const char *fn
, int fd
);
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
);
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
;
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
);
127 char *pa_get_runtime_dir(void);
128 char *pa_get_state_dir(void);
129 char *pa_runtime_path(const char *fn
);
130 char *pa_state_path(const char *fn
, pa_bool_t prepend_machine_id
);
132 int pa_atoi(const char *s
, int32_t *ret_i
);
133 int pa_atou(const char *s
, uint32_t *ret_u
);
134 int pa_atod(const char *s
, double *ret_d
);
136 size_t pa_snprintf(char *str
, size_t size
, const char *format
, ...);
137 size_t pa_vsnprintf(char *str
, size_t size
, const char *format
, va_list ap
);
139 char *pa_truncate_utf8(char *c
, size_t l
);
141 int pa_match(const char *expr
, const char *v
);
143 char *pa_getcwd(void);
144 char *pa_make_path_absolute(const char *p
);
145 pa_bool_t
pa_is_path_absolute(const char *p
);
147 void *pa_will_need(const void *p
, size_t l
);
149 static inline int pa_is_power_of_two(unsigned n
) {
150 return !(n
& (n
- 1));
153 static inline unsigned pa_ulog2(unsigned n
) {
158 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
159 return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n
) - 1;
176 static inline unsigned pa_make_power_of_two(unsigned n
) {
178 if (pa_is_power_of_two(n
))
181 return 1U << (pa_ulog2(n
) + 1);
184 void pa_close_pipe(int fds
[2]);
186 char *pa_readlink(const char *p
);
188 int pa_close_all(int except_fd
, ...);
189 int pa_close_allv(const int except_fds
[]);
190 int pa_unblock_sigs(int except
, ...);
191 int pa_unblock_sigsv(const int except
[]);
192 int pa_reset_sigs(int except
, ...);
193 int pa_reset_sigsv(const int except
[]);
195 void pa_set_env(const char *key
, const char *value
);
197 pa_bool_t
pa_in_system_mode(void);
199 #define pa_streq(a,b) (!strcmp((a),(b)))
201 char *pa_get_host_name_malloc(void);
202 char *pa_get_user_name_malloc(void);
204 char *pa_machine_id(void);
205 char *pa_session_id(void);
206 char *pa_uname_string(void);
208 #ifdef HAVE_VALGRIND_MEMCHECK_H
209 pa_bool_t
pa_in_valgrind(void);
211 static inline pa_bool_t
pa_in_valgrind(void) {
216 unsigned pa_gcd(unsigned a
, unsigned b
);
217 void pa_reduce(unsigned *num
, unsigned *den
);
219 unsigned pa_ncpus(void);
221 char *pa_replace(const char*s
, const char*a
, const char *b
);
223 /* Escapes p by inserting backslashes in front of backslashes. chars is a
224 * regular (ie. NULL-terminated) string containing additional characters that
225 * should be escaped. chars can be NULL. The caller has to free the returned
227 char *pa_escape(const char *p
, const char *chars
);
229 /* Does regular backslash unescaping. Returns the argument p. */
230 char *pa_unescape(char *p
);
232 char *pa_realpath(const char *path
);
234 void pa_disable_sigpipe(void);
236 void pa_xfreev(void**a
);
238 static inline void pa_xstrfreev(char **a
) {
239 pa_xfreev((void**) a
);
242 char **pa_split_spaces_strv(const char *s
);
244 char* pa_maybe_prefix_path(const char *path
, const char *prefix
);