add experimental ast_copy_string() function to be used in place of strncpy() (see...
[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 <netdb.h>
21 #include <pthread.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 extern char *ast_strip(char *buf);
134 extern struct hostent *ast_gethostbyname(const char *host, struct ast_hostent *hp);
135 /* ast_md5_hash: Produces MD5 hash based on input string */
136 extern void ast_md5_hash(char *output, char *input);
137 extern int ast_base64encode(char *dst, unsigned char *src, int srclen, int max);
138 extern int ast_base64decode(unsigned char *dst, char *src, int max);
139
140 extern int test_for_thread_safety(void);
141
142 extern const char *ast_inet_ntoa(char *buf, int bufsiz, struct in_addr ia);
143 extern int ast_utils_init(void);
144 extern int ast_wait_for_input(int fd, int ms);
145
146 /* The realloca lets us ast_restrdupa(), but you can't mix any other ast_strdup calls! */
147
148 struct ast_realloca {
149         char *ptr;
150         int alloclen;
151 };
152
153 #define ast_restrdupa(ra, s) \
154         ({ \
155                 if ((ra)->ptr && strlen(s) + 1 < (ra)->alloclen) { \
156                         strcpy((ra)->ptr, s); \
157                 } else { \
158                         (ra)->ptr = alloca(strlen(s) + 1 - (ra)->alloclen); \
159                         if ((ra)->ptr) (ra)->alloclen = strlen(s) + 1; \
160                 } \
161                 (ra)->ptr; \
162         })
163
164 #ifdef inet_ntoa
165 #undef inet_ntoa
166 #endif
167 #define inet_ntoa __dont__use__inet_ntoa__use__ast_inet_ntoa__instead__
168
169 #define AST_STACKSIZE 256 * 1024
170 #define ast_pthread_create(a,b,c,d) ast_pthread_create_stack(a,b,c,d,0)
171 extern int ast_pthread_create_stack(pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize);
172
173 #ifdef __linux__
174 #define ast_strcasestr strcasestr
175 #else
176 extern char *ast_strcasestr(const char *, const char *);
177 #endif /* __linux__ */
178
179 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
180 #define __builtin_expect(exp, c) (exp)
181 #endif
182
183 /*!
184   \brief Size-limited null-terminating string copy.
185   \param dst The destination buffer.
186   \param src The source string
187   \param size The size of the destination buffer
188
189   This is similar to \a strncpy, with two important differences:
190     - the destination buffer will \b always be null-terminated
191     - the destination buffer is not filled with zeros past the copied string length
192   These differences make it slightly more efficient, and safer to use since it will
193   not leave the destination buffer unterminated. There is no need to pass an artificially
194   reduced buffer size to this function (unlike \a strncpy), and the buffer does not need
195   to be initialized to zeroes prior to calling this function.
196   No return value.
197 */
198 void ast_copy_string(char *dst, const char *src, size_t size);
199
200 #endif /* _ASTERISK_UTILS_H */