diff options
Diffstat (limited to 'bgpd/bgp_common.h')
| -rw-r--r-- | bgpd/bgp_common.h | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/bgpd/bgp_common.h b/bgpd/bgp_common.h new file mode 100644 index 00000000..fd73bc51 --- /dev/null +++ b/bgpd/bgp_common.h @@ -0,0 +1,269 @@ +/* BGP Common -- functions + * Copyright (C) 2009 Chris Hall (GMCH), Highwayman + * + * This file is part of GNU Zebra. + * + * GNU Zebra 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, or (at your option) any + * later version. + * + * GNU Zebra 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 GNU Zebra; see the file COPYING. If not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef _QUAGGA_BGP_COMMON_H +#define _QUAGGA_BGP_COMMON_H + +#include <stdint.h> +#include "qafi_safi.h" +#include "zassert.h" + +#ifndef Inline +#define Inline static inline +#endif + +/*============================================================================== + * Here are a number of "incomplete" declarations, which allow a number of + * bgpd structures to refer to each other. + */ + +struct bgp ; +struct peer ; +struct bgp_session ; +struct bgp_connection ; +struct bgp_open_state ; + +typedef struct bgp* bgp_instance ; +typedef struct peer* bgp_peer ; +typedef struct bgp_session* bgp_session ; +typedef struct bgp_connection* bgp_connection ; +typedef struct bgp_open_state* bgp_open_state ; + +/*============================================================================== + * Both session and connection require this. + */ +typedef enum bgp_connection_ordinal bgp_connection_ordinal_t ; +enum bgp_connection_ordinal +{ + bgp_connection_primary = 0, + bgp_connection_secondary = 1, + + bgp_connection_count = 2 +} ; + +/*============================================================================== + * Both session and connection require this. + */ +typedef enum bgp_stopped_causes bgp_stopped_cause_t ; +enum bgp_stopped_causes +{ + bgp_stopped_min_cause = 0, + + bgp_stopped_not = 0, /* not stopped (yet) */ + + + bgp_stopped_admin = 1, /* Routeing Engine Stop */ + + bgp_stopped_notification = 2, /* Received NOTIFICATION */ + + bgp_stopped_collision = 3, + + bgp_stopped_invalid = 4, /* some internal error */ + bgp_stopped_unknown = 5, /* some unknown reason */ + + bgp_stopped_max_cause = 4 +} ; + +/*============================================================================== + * Other common types and .... + */ + +/* AS Numbers */ +typedef uint32_t as_t ; +typedef uint16_t as16_t ; /* we may still encounter 16 Bit asnums */ + +/* BGP Identifier -- usually an IPv4 address ! */ +typedef uint32_t bgp_id_t ; + +/* Size of BGP packets or thing in such */ +typedef uint16_t bgp_size_t; + +/*============================================================================== + * AFI/SAFI encodings for bgpd + * + * This captures the AFI/SAFI combinations that bgpd supports. + * + */ + +/*------------------------------------------------------------------------------ + * A qafx_num_t identifies a supported AFI/SAFI combination + */ +typedef enum qafx_num qafx_num_t ; + +enum qafx_num +{ + qafx_num_undef = -1, /* No defined AFI/SAFI */ + qafx_num_min = 0, /* minimum valid qafx */ + + qafx_num_first = 0, /* first "real" qafx */ + + qafx_ipv4_unicast = 0, /* iAFI = 1, iSAFI = 1 */ + qafx_ipv4_multicast = 1, /* iAFI = 1, iSAFI = 2 */ + qafx_ipv4_mpls_vpn = 2, /* iAFI = 1, iSAFI = 128 */ + + qafx_ipv6_unicast = 3, /* iAFI = 2, iSAFI = 1 */ + qafx_ipv6_multicast = 4, /* iAFI = 2, iSAFI = 2 */ + qafx_ipv6_mpls_vpn = 5, /* iAFI = 2, iSAFI = 128 */ + + qafx_num_last = 5, /* last "real" qafx */ + + qafx_num_other = 6, /* place-holder: for unknown AFI/SAFI */ + + qafx_num_max = 6, /* maximum qafx */ + qafx_count /* number of qafx */ +} ; + +/*------------------------------------------------------------------------------ + * A qafx_set_t is a set of qafx_bit_t -- a bit-vector + */ +typedef enum qafx_bit qafx_bit_t ; +typedef qafx_bit_t qafx_set_t ; + +enum qafx_bit +{ + qafx_set_empty = 0, + + qafx_bits_min = (1 << qafx_num_min), + + qafx_ipv4_unicast_bit = (1 << qafx_ipv4_unicast), + qafx_ipv4_multicast_bit = (1 << qafx_ipv4_multicast), + qafx_ipv4_mpls_vpn_bit = (1 << qafx_ipv4_mpls_vpn), + + qafx_ipv6_unicast_bit = (1 << qafx_ipv6_unicast), + qafx_ipv6_multicast_bit = (1 << qafx_ipv6_multicast), + qafx_ipv6_mpls_vpn_bit = (1 << qafx_ipv6_mpls_vpn), + + qafx_other_bit = (1 << qafx_num_other), + + qafx_bits_max = (1 << qafx_count) - 1 +} ; + +/*------------------------------------------------------------------------------ + * Conversions qafx_num <-> qafx_bit + * + * The conversion from qafx_bit -> qafx_num is not built for speed. + */ + +/* Get qafx_bit_t for given qafx_num_t + * + * NB: it is a mistake to try to map qafx_num_undef (FATAL unless NDEBUG). + */ +Inline qafx_bit_t +qafx_bit(qafx_num_t num) +{ + dassert((num >= qafx_num_min) && (num <= qafx_num_max)) ; + return (1 << num) ; +} ; + +/* Get qafx_num_t for the given qafx_bit_t. + */ +extern qafx_num_t +qafx_num(qafx_bit_t bit) ; + +/*============================================================================== + * Conversions for qafx_num => qAFI and qSAFI + */ + +/*------------------------------------------------------------------------------ + * Convert qafx_num_t to qAFI_xxx + * + * Maps qafx_num_other to qAFI_undef. + * + * NB: it is a mistake to try to map qafx_num_undef (FATAL unless NDEBUG). + */ + +extern const qAFI_t qAFI_map[] ; + +Inline qAFI_t +get_qAFI(qafx_num_t num) +{ + dassert((num >= qafx_num_min) && (num <= qafx_num_max)) ; + + return qAFI_map[num] ; +} ; + +/*------------------------------------------------------------------------------ + * Convert qafx_num_t to qSAFI_xxx + * + * Maps qafx_num_other to qSAFI_undef. + * + * NB: it is a mistake to try to map qafx_num_undef (FATAL unless NDEBUG). + */ + +extern const qSAFI_t qSAFI_map[] ; + +Inline qSAFI_t +get_qSAFI(qafx_num_t num) +{ + dassert((num >= qafx_num_min) && (num <= qafx_num_max)) ; + + return qSAFI_map[num] ; +} ; + +/*------------------------------------------------------------------------------ + * Convert qafx_num_t to iAFI_xxx + * + * Maps qafx_num_other to iAFI_Reserved. + * + * NB: it is a mistake to try to map qafx_num_undef (FATAL unless NDEBUG). + */ + +extern const iAFI_t iAFI_map[] ; + +Inline iAFI_t +get_iAFI(qafx_num_t num) +{ + dassert((num >= qafx_num_min) && (num <= qafx_num_max)) ; + + return iAFI_map[num] ; +} ; + +/*------------------------------------------------------------------------------ + * Convert qafx_num_t to iSAFI_xxx + * + * Maps qafx_num_other to iSAFI_Reserved. + * + * NB: it is a mistake to try to map qafx_num_undef (FATAL unless NDEBUG). + */ + +extern const iSAFI_t iSAFI_map[] ; + +Inline iSAFI_t +get_iSAFI(qafx_num_t num) +{ + dassert((num >= qafx_num_min) && (num <= qafx_num_max)) ; + + return iSAFI_map[num] ; +} ; + +/*============================================================================== + * Conversions for qAFI/qSAFI => qafx_num_t + * and iAFI/iSAFI => qafx_num_t + */ + +extern qafx_num_t +qafx_num_from_iAFI_iSAFI(iAFI_t afi, iSAFI_t safi) ; + +extern qafx_num_t +qafx_num_from_qAFI_qSAFI(qAFI_t afi, qSAFI_t safi) ; + +#endif /* _QUAGGA_BGP_COMMON_H */ + |