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, see <http://www.gnu.org/licenses/>.
22***/
23
24#include <sys/types.h>
25#include <inttypes.h>
26#include <stdarg.h>
27#include <stdio.h>
28#include <string.h>
29
30#ifdef HAVE_SYS_RESOURCE_H
31#include <sys/resource.h>
32#endif
33
34#include <pulse/gccmacro.h>
35#include <pulse/volume.h>
36
37#include <pulsecore/i18n.h>
38#include <pulsecore/macro.h>
39#include <pulsecore/socket.h>
40#include <pulsecore/dynarray.h>
41
42#ifndef PACKAGE
43#error "Please include config.h before including this file!"
44#endif
45
46struct timeval;
47
48/* These resource limits are pretty new on Linux, let's define them
49 * here manually, in case the kernel is newer than the glibc */
50#if !defined(RLIMIT_NICE) && defined(__linux__)
51#define RLIMIT_NICE 13
52#endif
53#if !defined(RLIMIT_RTPRIO) && defined(__linux__)
54#define RLIMIT_RTPRIO 14
55#endif
56#if !defined(RLIMIT_RTTIME) && defined(__linux__)
57#define RLIMIT_RTTIME 15
58#endif
59
60void pa_make_fd_nonblock(int fd);
61void pa_make_fd_block(int fd);
62bool pa_is_fd_nonblock(int fd);
63
64void pa_make_fd_cloexec(int fd);
65
66int pa_make_secure_dir(const char* dir, mode_t m, uid_t uid, gid_t gid, bool update_perms);
67int pa_make_secure_parent_dir(const char *fn, mode_t, uid_t uid, gid_t gid, bool update_perms);
68
69ssize_t pa_read(int fd, void *buf, size_t count, int *type);
70ssize_t pa_write(int fd, const void *buf, size_t count, int *type);
71ssize_t pa_loop_read(int fd, void*data, size_t size, int *type);
72ssize_t pa_loop_write(int fd, const void*data, size_t size, int *type);
73
74int pa_close(int fd);
75
76void pa_check_signal_is_blocked(int sig);
77
78char *pa_sprintf_malloc(const char *format, ...) PA_GCC_PRINTF_ATTR(1,2);
79char *pa_vsprintf_malloc(const char *format, va_list ap);
80
81char *pa_strlcpy(char *b, const char *s, size_t l);
82
83char *pa_parent_dir(const char *fn);
84
85int pa_raise_priority(int nice_level);
86void pa_reset_priority(void);
87
88int pa_parse_boolean(const char *s) PA_GCC_PURE;
89
90int pa_parse_volume(const char *s, pa_volume_t *volume);
91
92static inline const char *pa_yes_no(bool b) {
93    return b ? "yes" : "no";
94}
95
96static inline const char *pa_yes_no_localised(bool b) {
97    return b ? _("yes") : _("no");
98}
99
100static inline const char *pa_strnull(const char *x) {
101    return x ? x : "(null)";
102}
103
104static inline const char *pa_strempty(const char *x) {
105    return x ? x : "";
106}
107
108static inline const char *pa_strna(const char *x) {
109    return x ? x : "n/a";
110}
111
112char *pa_split(const char *c, const char *delimiters, const char **state);
113const char *pa_split_in_place(const char *c, const char *delimiters, size_t *n, const char **state);
114char *pa_split_spaces(const char *c, const char **state);
115const char *pa_split_spaces_in_place(const char *c, size_t *n, const char **state);
116
117char *pa_strip_nl(char *s);
118char *pa_strip(char *s);
119
120const char *pa_sig2str(int sig) PA_GCC_PURE;
121
122int pa_own_uid_in_group(const char *name, gid_t *gid);
123int pa_uid_in_group(uid_t uid, const char *name);
124gid_t pa_get_gid_of_group(const char *name);
125int pa_check_in_group(gid_t g);
126
127int pa_lock_fd(int fd, int b);
128
129int pa_lock_lockfile(const char *fn);
130int pa_unlock_lockfile(const char *fn, int fd);
131
132char *pa_hexstr(const uint8_t* d, size_t dlength, char *s, size_t slength);
133size_t pa_parsehex(const char *p, uint8_t *d, size_t dlength);
134
135bool pa_startswith(const char *s, const char *pfx) PA_GCC_PURE;
136bool pa_endswith(const char *s, const char *sfx) PA_GCC_PURE;
137
138FILE *pa_open_config_file(const char *global, const char *local, const char *env, char **result);
139char* pa_find_config_file(const char *global, const char *local, const char *env);
140
141char *pa_get_runtime_dir(void);
142char *pa_get_state_dir(void);
143char *pa_get_home_dir_malloc(void);
144int pa_append_to_home_dir(const char *path, char **_r);
145int pa_get_config_home_dir(char **_r);
146int pa_get_data_home_dir(char **_r);
147int pa_get_data_dirs(pa_dynarray **_r);
148int pa_append_to_config_home_dir(const char *path, char **_r);
149char *pa_get_binary_name_malloc(void);
150char *pa_runtime_path(const char *fn);
151char *pa_state_path(const char *fn, bool prepend_machine_id);
152
153int pa_atoi(const char *s, int32_t *ret_i);
154int pa_atou(const char *s, uint32_t *ret_u);
155int pa_atol(const char *s, long *ret_l);
156int pa_atod(const char *s, double *ret_d);
157int pa_atoi64(const char *s, int64_t *ret_l);
158int pa_atou64(const char *s, uint64_t *ret_u);
159
160size_t pa_snprintf(char *str, size_t size, const char *format, ...);
161size_t pa_vsnprintf(char *str, size_t size, const char *format, va_list ap);
162
163char *pa_truncate_utf8(char *c, size_t l);
164
165int pa_match(const char *expr, const char *v);
166bool pa_is_regex_valid(const char *expr);
167
168char *pa_getcwd(void);
169char *pa_make_path_absolute(const char *p);
170bool pa_is_path_absolute(const char *p);
171
172void *pa_will_need(const void *p, size_t l);
173
174static inline int pa_is_power_of_two(unsigned n) {
175    return !(n & (n - 1));
176}
177
178static inline unsigned pa_ulog2(unsigned n) {
179
180    if (n <= 1)
181        return 0;
182
183#if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
184    return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n) - 1;
185#else
186{
187    unsigned r = 0;
188
189    for (;;) {
190        n = n >> 1;
191
192        if (!n)
193            return r;
194
195        r++;
196    }
197}
198#endif
199}
200
201static inline unsigned pa_make_power_of_two(unsigned n) {
202
203    if (pa_is_power_of_two(n))
204        return n;
205
206    return 1U << (pa_ulog2(n) + 1);
207}
208
209void pa_close_pipe(int fds[2]);
210
211char *pa_readlink(const char *p);
212
213int pa_close_all(int except_fd, ...);
214int pa_close_allv(const int except_fds[]);
215int pa_unblock_sigs(int except, ...);
216int pa_unblock_sigsv(const int except[]);
217int pa_reset_sigs(int except, ...);
218int pa_reset_sigsv(const int except[]);
219
220void pa_set_env(const char *key, const char *value);
221void pa_unset_env(const char *key);
222void pa_set_env_and_record(const char *key, const char *value);
223void pa_unset_env_recorded(void);
224
225bool pa_in_system_mode(void);
226
227#define pa_streq(a,b) (!strcmp((a),(b)))
228#define pa_strneq(a,b,n) (!strncmp((a),(b),(n)))
229
230/* Like pa_streq, but does not blow up on NULL pointers. */
231static inline bool pa_safe_streq(const char *a, const char *b) {
232    if (a == NULL || b == NULL)
233        return a == b;
234    return pa_streq(a, b);
235}
236
237bool pa_str_in_list_spaces(const char *needle, const char *haystack);
238bool pa_str_in_list(const char *haystack, const char *delimiters, const char *needle);
239
240char* pa_str_strip_suffix(const char *str, const char *suffix);
241
242char *pa_get_host_name_malloc(void);
243char *pa_get_user_name_malloc(void);
244
245char *pa_machine_id(void);
246char *pa_session_id(void);
247char *pa_uname_string(void);
248
249#ifdef HAVE_VALGRIND_MEMCHECK_H
250bool pa_in_valgrind(void);
251#else
252static inline bool pa_in_valgrind(void) {
253    return false;
254}
255#endif
256
257unsigned pa_gcd(unsigned a, unsigned b);
258void pa_reduce(unsigned *num, unsigned *den);
259
260unsigned pa_ncpus(void);
261
262/* Replaces all occurrences of `a' in `s' with `b'. The caller has to free the
263 * returned string. All parameters must be non-NULL and additionally `a' must
264 * not be a zero-length string.
265 */
266char *pa_replace(const char*s, const char*a, const char *b);
267
268/* Escapes p by inserting backslashes in front of backslashes. chars is a
269 * regular (i.e. NULL-terminated) string containing additional characters that
270 * should be escaped. chars can be NULL. The caller has to free the returned
271 * string. */
272char *pa_escape(const char *p, const char *chars);
273
274/* Does regular backslash unescaping. Returns the argument p. */
275char *pa_unescape(char *p);
276
277char *pa_realpath(const char *path);
278
279void pa_disable_sigpipe(void);
280
281void pa_xfreev(void**a);
282
283static inline void pa_xstrfreev(char **a) {
284    pa_xfreev((void**) a);
285}
286
287char **pa_split_spaces_strv(const char *s);
288
289char* pa_maybe_prefix_path(const char *path, const char *prefix);
290
291/* Returns size of the specified pipe or 4096 on failure */
292size_t pa_pipe_buf(int fd);
293
294void pa_reset_personality(void);
295
296bool pa_run_from_build_tree(void) PA_GCC_CONST;
297
298const char *pa_get_temp_dir(void);
299
300int pa_open_cloexec(const char *fn, int flags, mode_t mode);
301int pa_socket_cloexec(int domain, int type, int protocol);
302int pa_pipe_cloexec(int pipefd[2]);
303int pa_accept_cloexec(int sockfd, struct sockaddr *addr, socklen_t *addrlen);
304FILE* pa_fopen_cloexec(const char *path, const char *mode);
305
306void pa_nullify_stdfds(void);
307
308char *pa_read_line_from_file(const char *fn);
309bool pa_running_in_vm(void);
310
311#ifdef OS_IS_WIN32
312char *pa_win32_get_toplevel(HANDLE handle);
313char *pa_win32_get_system_appdata();
314#endif
315
316size_t pa_page_size(void);
317
318/* Rounds down */
319static inline void* PA_PAGE_ALIGN_PTR(const void *p) {
320    return (void*) (((size_t) p) & ~(pa_page_size() - 1));
321}
322
323/* Rounds up */
324static inline size_t PA_PAGE_ALIGN(size_t l) {
325    size_t page_size = pa_page_size();
326    return (l + page_size - 1) & ~(page_size - 1);
327}
328
329#endif
330