blst: global config variables for ignoring blacklist events
[sip-router] / dst_blacklist.h
1 /*
2  * $Id$
3  *
4  * resolver related functions
5  *
6  * Copyright (C) 2006 iptelorg GmbH
7  *
8  * This file is part of ser, a free SIP server.
9  *
10  * ser is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version
14  *
15  * For a license to use the ser software under conditions
16  * other than those described here, or to purchase support for this
17  * software, please contact iptel.org by e-mail at the following addresses:
18  *    info@iptel.org
19  *
20  * ser is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29 /* History:
30  * --------
31  *  2006-07-29  created by andrei
32  *  2007-07-30  dst blacklist measurements added (Gergo)
33  *  2009-12-22  blacklist ignore mask support and dst_blacklist_{add,su}
34  *               switched to macros (andrei)
35  */
36
37 #ifndef dst_black_list_h
38 #define dst_black_list_h
39
40 #include "ip_addr.h"
41 #include "parser/msg_parser.h"
42 #include "timer_ticks.h"
43 #include "cfg_core.h"
44
45 #define DEFAULT_BLST_TIMEOUT            60  /* 1 min. */
46 #define DEFAULT_BLST_MAX_MEM            250 /* 250 KB */
47
48 /* flags: */
49 #define BLST_IS_IPV6            1               /* set if the address is ipv6 */
50 #define BLST_ERR_SEND           (1<<1)  /* set if  send is denied/failed */
51 #define BLST_ERR_CONNECT        (1<<2)  /* set if connect failed (tcp/tls) */
52 #define BLST_ICMP_RCVD          (1<<3)  /* set if icmp error */
53 #define BLST_ERR_TIMEOUT        (1<<4)  /* set if sip timeout */
54 #define BLST_503                        (1<<5)  /* set for 503 replies */
55 #define BLST_ADM_PROHIBITED     (1<<6)  /* administratively prohibited */
56 #define BLST_PERMANENT          (1<<7)  /* never deleted, never expires */
57
58 /* uncomment the define above to enable blacklist callbacks support */
59 /*#define DST_BLACKLIST_HOOKS*/
60
61 #define DST_BLACKLIST_CONTINUE 0 /* add: do nothing/ignore, search: ignore */
62 #define DST_BLACKLIST_ACCEPT 1   /* add: force accept, search: force match */
63 #define DST_BLACKLIST_DENY  -1   /* add: deny, search: force no match */
64
65 #define DST_BLACKLIST_ADD_CB 1
66 #define DST_BLACKLIST_SEARCH_CB 2
67
68
69 extern unsigned blst_proto_imask[PROTO_LAST+1];
70
71 #ifdef DST_BLACKLIST_HOOKS
72 struct blacklist_hook{
73         /* WARNING: msg might be NULL, and it might point to shared memory
74          * without locking, do not modify it! msg can be used typically for checking
75          * the message flags with isflagset() */
76         int (*on_blst_action)(struct dest_info* si, unsigned char* err_flags,
77                                                         struct sip_msg* msg);
78         /* called before ser shutdown */
79         void (*destroy)(void);
80 };
81
82 int register_blacklist_hook(struct blacklist_hook *h, int type);
83 #endif /* DST_BLACKLIST_HOOKS */
84
85 int init_dst_blacklist();
86 #ifdef USE_DST_BLACKLIST_STATS
87 int init_dst_blacklist_stats(int iproc_num);
88 #define DST_BLACKLIST_ALL_STATS "bkl_all_stats"
89 #endif
90 void destroy_dst_blacklist();
91
92
93 /** force add to the blacklist.
94  * like @function dst_blacklist_add_to, but no ignore mask or
95  * blacklist enabled checks are made.
96  * @see dst_blacklist_add_to for the parameters and return value.
97  */
98 int dst_blacklist_force_add_to(unsigned char err_flags, struct dest_info* si,
99                                                                 struct sip_msg* msg, ticks_t timeout);
100
101 /** force add to the blacklist, long version.
102  * like @function dst_blacklist_su_to, but no ignore mask or
103  * blacklist enabled checks are made.
104  * @see dst_blacklist_su_to for the parameters and return value.
105  */
106 int dst_blacklist_force_su_to(  unsigned char err_flags,
107                                                                 unsigned char proto,
108                                                                 union sockaddr_union* dst,
109                                                                 struct sip_msg* msg,
110                                                                 ticks_t timeout);
111
112
113 /** checks if blacklist should be used.
114   * @param  err_flags - blacklist reason
115   * @param si - filled dest_info structure pointer.
116   * @return 1 if blacklist is enabled (core_cfg) and the event/error
117   *           is not in the ignore list.
118   *         0 otherwise
119   */
120 #define should_blacklist(err_flags, si) \
121         (cfg_get(core, core_cfg, use_dst_blacklist) && \
122                 ((err_flags) & ~blst_proto_imask[(unsigned)((si)->proto)] & \
123                                            ~(si)->send_flags.blst_imask ))
124
125
126 /** checks if blacklist should be used, long version.
127   * @param  err_flags - blacklist reason
128   * @param snd_flags - snd_flags pointer, can be 0.
129   * @param proto - protocol, can be 0 (PROTO_NONE).
130   * @param si  - sockaddr_union pointer, can be 0.
131   * @return 1 if blacklist is enabled (core_cfg) and the event/error
132   *           is not in the ignore list.
133   *         0 otherwise
134   */
135 #define should_blacklist_su(err_flags, snd_flags, proto, su) \
136         (cfg_get(core, core_cfg, use_dst_blacklist) && \
137                 ((err_flags) & ~blst_proto_imask[(unsigned)(proto)] & \
138                                         ~((snd_flags)?((snd_flags_t*)(snd_flags))->blst_imask:0)))
139
140
141 /** adds a dst to the blacklist.
142  *
143  * @param  err_flags - blacklist reason
144  * @param si  - dest_info structure (dst).
145  * @param msg - sip msg struct. pointer if known, 0 otherwise.
146  * @param timeout - timeout in ticks.
147  * @return >=0 on success, -1 on error.
148  */
149 #define dst_blacklist_add_to(err_flags, si, msg, timeout) \
150         (should_blacklist(err_flags, si)? \
151                 dst_blacklist_force_add_to((err_flags), (si), (msg), (timeout))\
152                 : 0)
153
154
155 /** adds a dst to the blacklist, long version.
156  * Similar to dst_blacklist_add_to, but uses "unpacked" parameters.
157  * @param  err_flags - blacklist reason
158  * @param proto - protocol.
159  * @param dst  - sockaddr_union pointer.
160  * @param snd_flags - snd_flags pointer, can be 0.
161  * @param msg - sip msg struct. pointer if known, 0 otherwise.
162  * @param timeout - timeout in ticks.
163  * @return >=0 on success, -1 on error.
164  */
165 #define dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, timeout) \
166         (should_blacklist_su(err_flags, snd_flags, proto, dst) ? \
167                 dst_blacklist_force_su_to((err_flags), (proto), (dst), (msg), \
168                                                                         (timeout))\
169                 : 0)
170
171
172 /** adds a dst to the blacklist with default timeout.
173  *
174  * @param  err_flags - blacklist reason
175  * @param si  - dest_info structure (dst).
176  * @param msg - sip msg struct. pointer if known, 0 otherwise.
177  * @return >=0 on success, -1 on error.
178  * @see dst_blacklist_add_to.
179  */
180 #define dst_blacklist_add(err_flags, si, msg) \
181         dst_blacklist_add_to(err_flags, si, msg, \
182                                                         S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))
183
184
185 /** adds a dst to the blacklist with default timeout, long version.
186  * Similar to dst_blacklist_add_to, but uses "unpacked" parameters.
187  * @param  err_flags - blacklist reason
188  * @param proto - protocol.
189  * @param dst  - sockaddr_union pointer.
190  * @param snd_flags - snd_flags pointer, can be 0.
191  * @param msg - sip msg struct. pointer if known, 0 otherwise.
192  * @return >=0 on success, -1 on error.
193  * @see dst_blacklist_su_to.
194  */
195 #define dst_blacklist_su(err_flags, proto, dst, snd_flags, msg) \
196         dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, \
197                                                         S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))
198
199 int dst_is_blacklisted(struct dest_info* si, struct sip_msg* msg);
200 /* delete an entry from the blacklist */
201 int dst_blacklist_del(struct dest_info* si, struct sip_msg* msg);
202
203 /* deletes all the entries from the blacklist except the permanent ones
204  * (which are marked with BLST_PERMANENT)
205  */
206 void dst_blst_flush(void);
207
208 int use_dst_blacklist_fixup(void *handle, str *gname, str *name, void **val);
209 /* KByte to Byte conversion */
210 int blst_max_mem_fixup(void *handle, str *gname, str *name, void **val);
211
212 void blst_reinit_ign_masks(str* gname, str* name);
213
214 #endif