dst_blacklist.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006 iptelorg GmbH
 *
 * This file is part of ser, a free SIP server.
 *
 * ser is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * ser is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/* History:
 * --------
 *  2006-07-29  created by andrei
 *  2007-07-30  dst blacklist measurements added (Gergo)
 *  2009-12-22  blacklist ignore mask support and dst_blacklist_{add,su}
 *               switched to macros (andrei)
 */

#ifndef dst_black_list_h
#define dst_black_list_h

#include "ip_addr.h"
#include "parser/msg_parser.h"
#include "timer_ticks.h"
#include "cfg_core.h"

#define DEFAULT_BLST_TIMEOUT            60  
#define DEFAULT_BLST_MAX_MEM            250 

#define BLST_IS_IPV6            1               
#define BLST_ERR_SEND           (1<<1)  
#define BLST_ERR_CONNECT        (1<<2)  
#define BLST_ICMP_RCVD          (1<<3)  
#define BLST_ERR_TIMEOUT        (1<<4)  
#define BLST_503                        (1<<5)  
#define BLST_ADM_PROHIBITED     (1<<6)  
#define BLST_PERMANENT          (1<<7)  

/* uncomment the define above to enable blacklist callbacks support */
/*#define DST_BLACKLIST_HOOKS*/

#define DST_BLACKLIST_CONTINUE 0 
#define DST_BLACKLIST_ACCEPT 1   
#define DST_BLACKLIST_DENY  -1   
#define DST_BLACKLIST_ADD_CB 1
#define DST_BLACKLIST_SEARCH_CB 2


extern unsigned blst_proto_imask[PROTO_LAST+1];

#ifdef DST_BLACKLIST_HOOKS
struct blacklist_hook{
        /* WARNING: msg might be NULL, and it might point to shared memory
         * without locking, do not modify it! msg can be used typically for checking
         * the message flags with isflagset() */
        int (*on_blst_action)(struct dest_info* si, unsigned char* err_flags,
                                                        struct sip_msg* msg);
        /* called before ser shutdown */
        void (*destroy)(void);
};

int register_blacklist_hook(struct blacklist_hook *h, int type);
#endif /* DST_BLACKLIST_HOOKS */

int init_dst_blacklist(void);
#ifdef USE_DST_BLACKLIST_STATS
int init_dst_blacklist_stats(int iproc_num);
#define DST_BLACKLIST_ALL_STATS "bkl_all_stats"
#endif
void destroy_dst_blacklist(void);


int dst_blacklist_force_add_to(unsigned char err_flags, struct dest_info* si,
                                                                struct sip_msg* msg, ticks_t timeout);

int dst_blacklist_force_su_to(  unsigned char err_flags,
                                                                unsigned char proto,
                                                                union sockaddr_union* dst,
                                                                struct sip_msg* msg,
                                                                ticks_t timeout);


#define should_blacklist(err_flags, si) \
        (cfg_get(core, core_cfg, use_dst_blacklist) && \
                ((err_flags) & ~blst_proto_imask[(unsigned)((si)->proto)] & \
                                           ~(si)->send_flags.blst_imask ))


#define should_blacklist_su(err_flags, snd_flags, proto, su) \
        (cfg_get(core, core_cfg, use_dst_blacklist) && \
                ((err_flags) & ~blst_proto_imask[(unsigned)(proto)] & \
                                        ~((snd_flags)?((snd_flags_t*)(snd_flags))->blst_imask:0)))


#define dst_blacklist_add_to(err_flags, si, msg, timeout) \
        (should_blacklist(err_flags, si)? \
                dst_blacklist_force_add_to((err_flags), (si), (msg), (timeout))\
                : 0)


#define dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, timeout) \
        (should_blacklist_su(err_flags, snd_flags, proto, dst) ? \
                dst_blacklist_force_su_to((err_flags), (proto), (dst), (msg), \
                                                                        (timeout))\
                : 0)


#define dst_blacklist_add(err_flags, si, msg) \
        dst_blacklist_add_to(err_flags, si, msg, \
                                                        S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))


#define dst_blacklist_su(err_flags, proto, dst, snd_flags, msg) \
        dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, \
                                                        S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))

int dst_is_blacklisted(struct dest_info* si, struct sip_msg* msg);

int dst_blacklist_del(struct dest_info* si, struct sip_msg* msg);

void dst_blst_flush(void);

int use_dst_blacklist_fixup(void *handle, str *gname, str *name, void **val);

int blst_max_mem_fixup(void *handle, str *gname, str *name, void **val);

void blst_reinit_ign_masks(str* gname, str* name);

#endif