]>
code.delx.au - pulseaudio/blob - src/pulsecore/core-util.h
e6cb261bbddc98669043ec30eb418fe304f4beb9
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 <pulse/volume.h>
38 #include <pulsecore/macro.h>
39 #include <pulsecore/socket.h>
42 #error "Please include config.h before including this file!"
47 /* These resource limits are pretty new on Linux, let's define them
48 * here manually, in case the kernel is newer than the glibc */
49 #if !defined(RLIMIT_NICE) && defined(__linux__)
50 #define RLIMIT_NICE 13
52 #if !defined(RLIMIT_RTPRIO) && defined(__linux__)
53 #define RLIMIT_RTPRIO 14
55 #if !defined(RLIMIT_RTTIME) && defined(__linux__)
56 #define RLIMIT_RTTIME 15
59 void pa_make_fd_nonblock(int fd
);
60 void pa_make_fd_block(int fd
);
61 bool pa_is_fd_nonblock(int fd
);
63 void pa_make_fd_cloexec(int fd
);
65 int pa_make_secure_dir(const char* dir
, mode_t m
, uid_t uid
, gid_t gid
, bool update_perms
);
66 int pa_make_secure_parent_dir(const char *fn
, mode_t
, uid_t uid
, gid_t gid
, bool update_perms
);
68 ssize_t
pa_read(int fd
, void *buf
, size_t count
, int *type
);
69 ssize_t
pa_write(int fd
, const void *buf
, size_t count
, int *type
);
70 ssize_t
pa_loop_read(int fd
, void*data
, size_t size
, int *type
);
71 ssize_t
pa_loop_write(int fd
, const void*data
, size_t size
, int *type
);
75 void pa_check_signal_is_blocked(int sig
);
77 char *pa_sprintf_malloc(const char *format
, ...) PA_GCC_PRINTF_ATTR(1,2);
78 char *pa_vsprintf_malloc(const char *format
, va_list ap
);
80 char *pa_strlcpy(char *b
, const char *s
, size_t l
);
82 char *pa_parent_dir(const char *fn
);
84 int pa_make_realtime(int rtprio
);
85 int pa_raise_priority(int nice_level
);
86 void pa_reset_priority(void);
88 int pa_parse_boolean(const char *s
) PA_GCC_PURE
;
90 int pa_parse_volume(const char *s
, pa_volume_t
*volume
);
92 static inline const char *pa_yes_no(bool b
) {
93 return b
? "yes" : "no";
96 static inline const char *pa_strnull(const char *x
) {
97 return x
? x
: "(null)";
100 static inline const char *pa_strempty(const char *x
) {
104 static inline const char *pa_strna(const char *x
) {
105 return x
? x
: "n/a";
108 char *pa_split(const char *c
, const char*delimiters
, const char **state
);
109 const char *pa_split_in_place(const char *c
, const char*delimiters
, int *n
, const char **state
);
110 char *pa_split_spaces(const char *c
, const char **state
);
112 char *pa_strip_nl(char *s
);
113 char *pa_strip(char *s
);
115 const char *pa_sig2str(int sig
) PA_GCC_PURE
;
117 int pa_own_uid_in_group(const char *name
, gid_t
*gid
);
118 int pa_uid_in_group(uid_t uid
, const char *name
);
119 gid_t
pa_get_gid_of_group(const char *name
);
120 int pa_check_in_group(gid_t g
);
122 int pa_lock_fd(int fd
, int b
);
124 int pa_lock_lockfile(const char *fn
);
125 int pa_unlock_lockfile(const char *fn
, int fd
);
127 char *pa_hexstr(const uint8_t* d
, size_t dlength
, char *s
, size_t slength
);
128 size_t pa_parsehex(const char *p
, uint8_t *d
, size_t dlength
);
130 bool pa_startswith(const char *s
, const char *pfx
) PA_GCC_PURE
;
131 bool pa_endswith(const char *s
, const char *sfx
) PA_GCC_PURE
;
133 FILE *pa_open_config_file(const char *global
, const char *local
, const char *env
, char **result
);
134 char* pa_find_config_file(const char *global
, const char *local
, const char *env
);
136 char *pa_get_runtime_dir(void);
137 char *pa_get_state_dir(void);
138 char *pa_get_home_dir_malloc(void);
139 char *pa_get_binary_name_malloc(void);
140 char *pa_runtime_path(const char *fn
);
141 char *pa_state_path(const char *fn
, bool prepend_machine_id
);
143 int pa_atoi(const char *s
, int32_t *ret_i
);
144 int pa_atou(const char *s
, uint32_t *ret_u
);
145 int pa_atol(const char *s
, long *ret_l
);
146 int pa_atod(const char *s
, double *ret_d
);
148 size_t pa_snprintf(char *str
, size_t size
, const char *format
, ...);
149 size_t pa_vsnprintf(char *str
, size_t size
, const char *format
, va_list ap
);
151 char *pa_truncate_utf8(char *c
, size_t l
);
153 int pa_match(const char *expr
, const char *v
);
155 char *pa_getcwd(void);
156 char *pa_make_path_absolute(const char *p
);
157 bool pa_is_path_absolute(const char *p
);
159 void *pa_will_need(const void *p
, size_t l
);
161 static inline int pa_is_power_of_two(unsigned n
) {
162 return !(n
& (n
- 1));
165 static inline unsigned pa_ulog2(unsigned n
) {
170 #if __GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
171 return 8U * (unsigned) sizeof(unsigned) - (unsigned) __builtin_clz(n
) - 1;
188 static inline unsigned pa_make_power_of_two(unsigned n
) {
190 if (pa_is_power_of_two(n
))
193 return 1U << (pa_ulog2(n
) + 1);
196 void pa_close_pipe(int fds
[2]);
198 char *pa_readlink(const char *p
);
200 int pa_close_all(int except_fd
, ...);
201 int pa_close_allv(const int except_fds
[]);
202 int pa_unblock_sigs(int except
, ...);
203 int pa_unblock_sigsv(const int except
[]);
204 int pa_reset_sigs(int except
, ...);
205 int pa_reset_sigsv(const int except
[]);
207 void pa_set_env(const char *key
, const char *value
);
208 void pa_set_env_and_record(const char *key
, const char *value
);
209 void pa_unset_env_recorded(void);
211 bool pa_in_system_mode(void);
213 #define pa_streq(a,b) (!strcmp((a),(b)))
215 /* Like pa_streq, but does not blow up on NULL pointers. */
216 static inline bool pa_safe_streq(const char *a
, const char *b
) {
217 if (a
== NULL
|| b
== NULL
)
219 return pa_streq(a
, b
);
222 bool pa_str_in_list_spaces(const char *needle
, const char *haystack
);
224 char *pa_get_host_name_malloc(void);
225 char *pa_get_user_name_malloc(void);
227 char *pa_machine_id(void);
228 char *pa_session_id(void);
229 char *pa_uname_string(void);
231 #ifdef HAVE_VALGRIND_MEMCHECK_H
232 bool pa_in_valgrind(void);
234 static inline bool pa_in_valgrind(void) {
239 unsigned pa_gcd(unsigned a
, unsigned b
);
240 void pa_reduce(unsigned *num
, unsigned *den
);
242 unsigned pa_ncpus(void);
244 char *pa_replace(const char*s
, const char*a
, const char *b
);
246 /* Escapes p by inserting backslashes in front of backslashes. chars is a
247 * regular (i.e. NULL-terminated) string containing additional characters that
248 * should be escaped. chars can be NULL. The caller has to free the returned
250 char *pa_escape(const char *p
, const char *chars
);
252 /* Does regular backslash unescaping. Returns the argument p. */
253 char *pa_unescape(char *p
);
255 char *pa_realpath(const char *path
);
257 void pa_disable_sigpipe(void);
259 void pa_xfreev(void**a
);
261 static inline void pa_xstrfreev(char **a
) {
262 pa_xfreev((void**) a
);
265 char **pa_split_spaces_strv(const char *s
);
267 char* pa_maybe_prefix_path(const char *path
, const char *prefix
);
269 /* Returns size of the specified pipe or 4096 on failure */
270 size_t pa_pipe_buf(int fd
);
272 void pa_reset_personality(void);
274 bool pa_run_from_build_tree(void) PA_GCC_CONST
;
276 const char *pa_get_temp_dir(void);
278 int pa_open_cloexec(const char *fn
, int flags
, mode_t mode
);
279 int pa_socket_cloexec(int domain
, int type
, int protocol
);
280 int pa_pipe_cloexec(int pipefd
[2]);
281 int pa_accept_cloexec(int sockfd
, struct sockaddr
*addr
, socklen_t
*addrlen
);
282 FILE* pa_fopen_cloexec(const char *path
, const char *mode
);
284 void pa_nullify_stdfds(void);
286 char *pa_read_line_from_file(const char *fn
);
287 bool pa_running_in_vm(void);
290 char *pa_win32_get_toplevel(HANDLE handle
);