1 /* common.h - Common functions/includes
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of srvx.
6 * srvx is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with srvx; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
35 #define ArrayLength(x) (sizeof(x)/sizeof(x[0]))
36 #define safestrncpy(dest, src, len) do { char *d = (dest); const char *s = (src); size_t l = strlen(s)+1; if ((len) < l) l = (len); memmove(d, s, l); d[l-1] = 0; } while (0)
39 #define PRINTF_LIKE(M,N) __attribute__((format (printf, M, N)))
41 #define PRINTF_LIKE(M,N)
45 #define UNUSED_ARG(ARG) ARG __attribute__((unused))
46 #elif defined(S_SPLINT_S)
47 #define UNUSED_ARG(ARG) /*@unused@*/ ARG
48 #define const /*@observer@*/ /*@temp@*/
50 #define UNUSED_ARG(ARG) ARG
53 #if defined(__GNUC__) && (__GNUC__ < 3)
54 # define GCC_VARMACROS 1
55 #elif !defined(S_SPLINT_S)
56 # define C99_VARMACROS 1
59 #if defined(WITH_MALLOC_DMALLOC)
60 # define DMALLOC_FUNC_CHECK 1
63 #elif defined(WITH_MALLOC_MPATROL)
66 #elif defined(WITH_MALLOC_BOEHM_GC)
73 # define malloc(n) GC_MALLOC(n)
74 # define calloc(m,n) GC_MALLOC((m)*(n))
75 # define realloc(p,n) GC_REALLOC((p),(n))
76 # define free(p) GC_FREE(p)
79 #elif defined(WITH_MALLOC_SRVX)
81 # define malloc(n) srvx_malloc(__FILE__, __LINE__, (n))
83 # define calloc(m,n) srvx_malloc(__FILE__, __LINE__, (m)*(n))
85 # define realloc(p,n) srvx_realloc(__FILE__, __LINE__, (p), (n))
87 # define free(p) srvx_free(__FILE__, __LINE__, (p))
89 # define strdup(s) srvx_strdup(__FILE__, __LINE__, (s))
90 extern void *srvx_malloc(const char *, unsigned int, size_t);
91 extern void *srvx_realloc(const char *, unsigned int, void *, size_t);
92 extern char *srvx_strdup(const char *, unsigned int, const char *);
93 extern void srvx_free(const char *, unsigned int, void *);
95 extern void verify(const void *ptr);
96 # define verify(x) verify(x)
98 #elif defined(WITH_MALLOC_SLAB)
99 # define malloc(n) slab_malloc(__FILE__, __LINE__, (n))
101 # define calloc(m,n) slab_malloc(__FILE__, __LINE__, (m)*(n))
103 # define realloc(p,n) slab_realloc(__FILE__, __LINE__, (p), (n))
105 # define free(p) slab_free(__FILE__, __LINE__, (p))
107 # define strdup(s) slab_strdup(__FILE__, __LINE__, (s))
108 extern void *slab_malloc(const char *, unsigned int, size_t);
109 extern void *slab_realloc(const char *, unsigned int, void *, size_t);
110 extern char *slab_strdup(const char *, unsigned int, const char *);
111 extern void slab_free(const char *, unsigned int, void *);
112 # if !defined(NDEBUG)
113 extern void verify(const void *ptr);
114 # define verify(x) verify(x)
119 # define verify(ptr) (void)(ptr)
122 extern unsigned long now;
123 extern int quit_services;
124 extern struct log_type *MAIN_LOG;
125 extern const char git_version[];
127 typedef union irc_in_addr {
133 #define irc_in_addr_is_valid(ADDR) (((ADDR).in6[0] && (ADDR).in6[0] != 65535) \
134 || (ADDR).in6[1] != (ADDR).in6[0] \
135 || (ADDR).in6[2] != (ADDR).in6[0] \
136 || (ADDR).in6[3] != (ADDR).in6[0] \
137 || (ADDR).in6[4] != (ADDR).in6[0] \
138 || (ADDR).in6[5] != (ADDR).in6[0] \
139 || (ADDR).in6[6] != (ADDR).in6[0] \
140 || (ADDR).in6[7] != (ADDR).in6[0])
141 #define irc_in_addr_is_ipv4(ADDR) (!(ADDR).in6[0] && !(ADDR).in6[1] \
142 && !(ADDR).in6[2] && !(ADDR).in6[3] \
143 && !(ADDR).in6[4] && (ADDR).in6[6] \
144 && (!(ADDR).in6[5] || (ADDR).in6[5] == 65535))
145 #define irc_in_addr_is_ipv6(ADDR) !irc_in_addr_is_ipv4(ADDR)
146 #define irc_in_addr_is_loopback(ADDR) (irc_in_addr_is_ipv4(ADDR) ? (ADDR).in6_8[12] == 127 \
147 : (ADDR).in6[0] == 0 && (ADDR).in6[1] == 0 \
148 && (ADDR).in6[2] == 0 && (ADDR).in6[3] == 0 \
149 && (ADDR).in6[4] == 0 && (ADDR).in6[5] == 0 \
150 && (ADDR).in6[6] == 0 && (ADDR).in6[7] == 1)
151 #define IRC_NTOP_MAX_SIZE 40
152 unsigned int irc_ntop(char *output, unsigned int out_size, const irc_in_addr_t *addr);
153 #define IRC_NTOP_MASK_MAX_SIZE (IRC_NTOP_MAX_SIZE + 4)
154 unsigned int irc_ntop_mask(char *output, unsigned int out_size, const irc_in_addr_t *addr, unsigned char bits);
155 unsigned int irc_pton(irc_in_addr_t *addr, unsigned char *bits, const char *input);
156 unsigned int irc_check_mask(const irc_in_addr_t *check, const irc_in_addr_t *mask, unsigned char bits);
157 const char *irc_ntoa(const irc_in_addr_t *addr);
159 int create_socket_client(struct uplinkNode *target);
160 void close_socket(void);
162 typedef void (*exit_func_t)(void);
163 void reg_exit_func(exit_func_t handler);
164 void call_exit_funcs(void);
166 const char *inttobase64(char *buf, unsigned int v, unsigned int count);
167 unsigned long base64toint(const char *s, int count);
168 int split_line(char *line, int irc_colon, int argv_size, char *argv[]);
170 /* match_ircglobs(oldglob, newglob) returns non-zero if oldglob is a superset of newglob */
171 #define match_ircglobs !mmatch
172 int mmatch(const char *glob, const char *newglob);
173 int match_ircglob(const char *text, const char *glob);
174 #define MATCH_USENICK 1
175 #define MATCH_VISIBLE 2
176 int user_matches_glob(struct userNode *user, const char *glob, int flags);
178 int is_ircmask(const char *text);
179 int is_gline(const char *text);
181 char *sanitize_ircmask(char *text);
183 unsigned long ParseInterval(const char *interval);
184 unsigned long ParseVolume(const char *volume);
186 #define MD5_CRYPT_LENGTH 42
187 /* buffer[] must be at least MD5_CRYPT_LENGTH bytes long */
188 const char *cryptpass(const char *pass, char buffer[]);
189 int checkpass(const char *pass, const char *crypt);
191 int split_ircmask(char *text, char **nick, char **ident, char **host);
192 char *unsplit_string(char *set[], unsigned int max, char *dest);
194 #define DECLARE_LIST(STRUCTNAME,ITEMTYPE) struct STRUCTNAME {\
195 unsigned int used, size;\
198 void STRUCTNAME##_init(struct STRUCTNAME *list);\
199 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item);\
200 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item);\
201 void STRUCTNAME##_clean(struct STRUCTNAME *list)
203 #define DEFINE_LIST(STRUCTNAME,ITEMTYPE) \
204 void STRUCTNAME##_init(struct STRUCTNAME *list) {\
207 list->list = malloc(list->size*sizeof(list->list[0]));\
209 void STRUCTNAME##_append(struct STRUCTNAME *list, ITEMTYPE new_item) {\
211 if (list->used == list->size) {\
212 list->size = list->size ? (list->size << 1) : 4;\
213 list->list = realloc(list->list, list->size*sizeof(list->list[0]));\
215 list->list[list->used++] = new_item;\
217 int STRUCTNAME##_remove(struct STRUCTNAME *list, ITEMTYPE new_item) {\
218 unsigned int n, found;\
220 for (found=n=0; n<list->used; n++) {\
221 if (list->list[n] == new_item) {\
222 memmove(list->list+n, list->list+n+1, (list->used-n-1)*sizeof(list->list[n]));\
229 void STRUCTNAME##_clean(struct STRUCTNAME *list) {\
230 list->used = list->size = 0;\
235 /* The longest string that is likely to be produced in English is "10
236 * minutes, and 10 seconds" (27 characters). Other languages will
237 * vary, so there's plenty of leeway.
239 #define INTERVALLEN 50
242 char *intervalString(char *output, unsigned long interval, struct handle_info *hi);
243 int getipbyname(const char *name, unsigned long *ip);
244 int set_policer_param(const char *param, void *data, void *extra);
245 const char *strtab(unsigned int ii);
247 void tools_init(void);
248 void tools_cleanup(void);
250 int irccasecmp(const char *stra, const char *strb);
251 int ircncasecmp(const char *stra, const char *strb, unsigned int len);
252 const char *irccasestr(const char *haystack, const char *needle);
253 char *ircstrlower(char *str);
255 DECLARE_LIST(string_buffer, char);
256 void string_buffer_append_string(struct string_buffer *buf, const char *tail);
257 void string_buffer_append_substring(struct string_buffer *buf, const char *tail, unsigned int len);
258 void string_buffer_append_vprintf(struct string_buffer *buf, const char *fmt, va_list args);
259 void string_buffer_append_printf(struct string_buffer *buf, const char *fmt, ...);
260 void string_buffer_replace(struct string_buffer *buf, unsigned int from, unsigned int len, const char *repl);
262 #define enabled_string(string) (!irccasecmp((string), "on") || !strcmp((string), "1") || !irccasecmp((string), "enabled"))
263 #define disabled_string(string) (!irccasecmp((string), "off") || !strcmp((string), "0") || !irccasecmp((string), "disabled"))
264 #define true_string(string) (!irccasecmp((string), "true") || !strcmp((string), "1") || !irccasecmp((string), "yes"))
265 #define false_string(string) (!irccasecmp((string), "false") || !strcmp((string), "0") || !irccasecmp((string), "no"))
267 #endif /* ifdef COMMON_H */