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