don't use pthread_mutex_lock
[asterisk/asterisk.git] / include / asterisk / utils.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Utility functions
5  *
6  * Copyright (C) 2004 - 2005, Digium, Inc.
7  *
8  * This program is free software, distributed under the terms of
9  * the GNU General Public License
10  */
11
12 #ifndef _ASTERISK_UTILS_H
13 #define _ASTERISK_UTILS_H
14
15 #ifdef SOLARIS
16 #include <solaris-compat/compat.h>
17 #endif
18
19 #include <netinet/in.h>
20 #include <arpa/inet.h>  /* we want to override inet_ntoa */
21 #include <netdb.h>
22 #include <limits.h>
23
24 #include "asterisk/lock.h"
25
26 /* Note:
27    It is very important to use only unsigned variables to hold
28    bit flags, as otherwise you can fall prey to the compiler's
29    sign-extension antics if you try to use the top two bits in
30    your variable.
31
32    The flag macros below use a set of compiler tricks to verify
33    that the caller is using an "unsigned int" variable to hold
34    the flags, and nothing else. If the caller uses any other
35    type of variable, a warning message similar to this:
36
37    warning: comparison of distinct pointer types lacks cast
38
39    will be generated.
40
41    The "dummy" variable below is used to make these comparisons.
42
43    Also note that at -O2 or above, this type-safety checking
44    does _not_ produce any additional object code at all.
45 */
46
47 extern unsigned int __unsigned_int_flags_dummy;
48
49 #define ast_test_flag(p,flag)           ({ \
50                                         typeof ((p)->flags) __p = (p)->flags; \
51                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
52                                         (void) (&__p == &__x); \
53                                         ((p)->flags & (flag)); \
54                                         })
55
56 #define ast_set_flag(p,flag)            do { \
57                                         typeof ((p)->flags) __p = (p)->flags; \
58                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
59                                         (void) (&__p == &__x); \
60                                         ((p)->flags |= (flag)); \
61                                         } while(0)
62
63 #define ast_clear_flag(p,flag)          do { \
64                                         typeof ((p)->flags) __p = (p)->flags; \
65                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
66                                         (void) (&__p == &__x); \
67                                         ((p)->flags &= ~(flag)); \
68                                         } while(0)
69
70 #define ast_copy_flags(dest,src,flagz)  do { \
71                                         typeof ((dest)->flags) __d = (dest)->flags; \
72                                         typeof ((src)->flags) __s = (src)->flags; \
73                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
74                                         (void) (&__d == &__x); \
75                                         (void) (&__s == &__x); \
76                                         (dest)->flags &= ~(flagz); \
77                                         (dest)->flags |= ((src)->flags & (flagz)); \
78                                         } while (0)
79
80 #define ast_set2_flag(p,value,flag)     do { \
81                                         typeof ((p)->flags) __p = (p)->flags; \
82                                         typeof (__unsigned_int_flags_dummy) __x = 0; \
83                                         (void) (&__p == &__x); \
84                                         if (value) \
85                                                 (p)->flags |= (flag); \
86                                         else \
87                                                 (p)->flags &= ~(flag); \
88                                         } while (0)
89
90 /* Non-type checking variations for non-unsigned int flags.  You
91    should only use non-unsigned int flags where required by 
92    protocol etc and if you know what you're doing :)  */
93 #define ast_test_flag_nonstd(p,flag)            ({ \
94                                         ((p)->flags & (flag)); \
95                                         })
96
97 #define ast_set_flag_nonstd(p,flag)             do { \
98                                         ((p)->flags |= (flag)); \
99                                         } while(0)
100
101 #define ast_clear_flag_nonstd(p,flag)           do { \
102                                         ((p)->flags &= ~(flag)); \
103                                         } while(0)
104
105 #define ast_copy_flags_nonstd(dest,src,flagz)   do { \
106                                         (dest)->flags &= ~(flagz); \
107                                         (dest)->flags |= ((src)->flags & (flagz)); \
108                                         } while (0)
109
110 #define ast_set2_flag_nonstd(p,value,flag)      do { \
111                                         if (value) \
112                                                 (p)->flags |= (flag); \
113                                         else \
114                                                 (p)->flags &= ~(flag); \
115                                         } while (0)
116
117 #define AST_FLAGS_ALL UINT_MAX
118
119 struct ast_flags {
120         unsigned int flags;
121 };
122
123 static inline int ast_strlen_zero(const char *s)
124 {
125         return (*s == '\0');
126 }
127
128 struct ast_hostent {
129         struct hostent hp;
130         char buf[1024];
131 };
132
133 /*!
134   \brief Strip leading/trailing whitespace from a string.
135   \param s The string to be stripped (will be modified).
136   \return The stripped string.
137
138   This functions strips all leading and trailing whitespace
139   characters from the input string, and returns a pointer to
140   the resulting string. The string is modified in place.
141 */
142 char *ast_strip(char *s);
143
144 /*!
145   \brief Strip leading/trailing whitespace and quotes from a string.
146   \param s The string to be stripped (will be modified).
147   \param beg_quotes The list of possible beginning quote characters.
148   \param end_quotes The list of matching ending quote characters.
149   \return The stripped string.
150
151   This functions strips all leading and trailing whitespace
152   characters from the input string, and returns a pointer to
153   the resulting string. The string is modified in place.
154
155   It can also remove beginning and ending quote (or quote-like)
156   characters, in matching pairs. If the first character of the
157   string matches any character in beg_quotes, and the last
158   character of the string is the matching character in
159   end_quotes, then they are removed from the string.
160
161   Examples:
162   \code
163   ast_strip_quoted(buf, "\"", "\"");
164   ast_strip_quoted(buf, "'", "'");
165   ast_strip_quoted(buf, "[{(", "]})");
166   \endcode
167  */
168 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
169
170 extern struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp);
171 /* ast_md5_hash: Produces MD5 hash based on input string */
172 extern void ast_md5_hash(char *output, char *input);
173 extern int ast_base64encode(char *dst, unsigned char *src, int srclen, int max);
174 extern int ast_base64decode(unsigned char *dst, char *src, int max);
175
176 extern int test_for_thread_safety(void);
177
178 extern const char *ast_inet_ntoa(char *buf, int bufsiz, struct in_addr ia);
179 extern int ast_utils_init(void);
180 extern int ast_wait_for_input(int fd, int ms);
181
182 /* The realloca lets us ast_restrdupa(), but you can't mix any other ast_strdup calls! */
183
184 struct ast_realloca {
185         char *ptr;
186         int alloclen;
187 };
188
189 #define ast_restrdupa(ra, s) \
190         ({ \
191                 if ((ra)->ptr && strlen(s) + 1 < (ra)->alloclen) { \
192                         strcpy((ra)->ptr, s); \
193                 } else { \
194                         (ra)->ptr = alloca(strlen(s) + 1 - (ra)->alloclen); \
195                         if ((ra)->ptr) (ra)->alloclen = strlen(s) + 1; \
196                 } \
197                 (ra)->ptr; \
198         })
199
200 #ifdef inet_ntoa
201 #undef inet_ntoa
202 #endif
203 #define inet_ntoa __dont__use__inet_ntoa__use__ast_inet_ntoa__instead__
204
205 #define AST_STACKSIZE 256 * 1024
206 #define ast_pthread_create(a,b,c,d) ast_pthread_create_stack(a,b,c,d,0)
207 extern int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize);
208
209 #ifdef __linux__
210 #define ast_strcasestr strcasestr
211 #else
212 extern char *ast_strcasestr(const char *, const char *);
213 #endif /* __linux__ */
214
215 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
216 #define __builtin_expect(exp, c) (exp)
217 #endif
218
219 /*!
220   \brief Size-limited null-terminating string copy.
221   \param dst The destination buffer.
222   \param src The source string
223   \param size The size of the destination buffer
224   \return Nothing.
225
226   This is similar to \a strncpy, with two important differences:
227     - the destination buffer will \b always be null-terminated
228     - the destination buffer is not filled with zeros past the copied string length
229   These differences make it slightly more efficient, and safer to use since it will
230   not leave the destination buffer unterminated. There is no need to pass an artificially
231   reduced buffer size to this function (unlike \a strncpy), and the buffer does not need
232   to be initialized to zeroes prior to calling this function.
233 */
234 void ast_copy_string(char *dst, const char *src, size_t size);
235
236 /*!
237   \brief Build a string in a buffer, designed to be called repeatedly
238   
239   This is a wrapper for snprintf, that properly handles the buffer pointer
240   and buffer space available.
241
242   \return 0 on success, non-zero on failure.
243   \param buffer current position in buffer to place string into (will be updated on return)
244   \param space remaining space in buffer (will be updated on return)
245   \param fmt printf-style format string
246 */
247 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));
248
249 /* functions for working with 'struct timeval' instances */
250
251 /*!
252  * \brief Computes the difference (in milliseconds) between two \c struct \c timeval instances.
253  * \param start the beginning of the time period
254  * \param end the end of the time period
255  * \return the difference in milliseconds
256  */
257 static inline int ast_tvdiff_ms(struct timeval *start, struct timeval *end)
258 {
259         return ((end->tv_sec - start->tv_sec) * 1000) + ((end->tv_usec - start->tv_usec) / 1000);
260 }
261
262 #endif /* _ASTERISK_UTILS_H */