bgpd/bgp_aspath.h

   1 /* AS path related definitions.
   2  * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _QUAGGA_BGP_ASPATH_H
  22 #define _QUAGGA_BGP_ASPATH_H
  23
  24 #include "lib/json.h"
  25
  26 /* AS path segment type.  */
  27 #define AS_SET                       1
  28 #define AS_SEQUENCE                  2
  29 #define AS_CONFED_SEQUENCE           3
  30 #define AS_CONFED_SET                4
  31
  32 /* Private AS range defined in RFC2270.  */
  33 #define BGP_PRIVATE_AS_MIN       64512U
  34 #define BGP_PRIVATE_AS_MAX       65535U
  35
  36 /* Private 4 byte AS range defined in RFC6996.  */
  37 #define BGP_PRIVATE_AS4_MIN     4200000000U
  38 #define BGP_PRIVATE_AS4_MAX     4294967294U
  39
  40 /* we leave BGP_AS_MAX as the 16bit AS MAX number.  */
  41 #define BGP_AS_MAX                   65535U
  42 #define BGP_AS4_MAX             4294967295U
  43 /* Transition 16Bit AS as defined by IANA */
  44 #define BGP_AS_TRANS             23456U
  45
  46 #define BGP_AS_IS_PRIVATE(ASN)                                                 \
  47         (((ASN) >= BGP_PRIVATE_AS_MIN && (ASN) <= BGP_PRIVATE_AS_MAX)          \
  48          || ((ASN) >= BGP_PRIVATE_AS4_MIN && (ASN) <= BGP_PRIVATE_AS4_MAX))
  49
  50 /* AS_PATH segment data in abstracted form, no limit is placed on length */
  51 struct assegment {
  52         struct assegment *next;
  53         as_t *as;
  54         unsigned short length;
  55         uint8_t type;
  56 };
  57
  58 /* AS path may be include some AsSegments.  */
  59 struct aspath {
  60         /* Reference count to this aspath.  */
  61         unsigned long refcnt;
  62
  63         /* segment data */
  64         struct assegment *segments;
  65
  66         /* AS path as a json object */
  67         json_object *json;
  68
  69         /* String expression of AS path.  This string is used by vty output
  70            and AS path regular expression match.  */
  71         char *str;
  72         unsigned short str_len;
  73 };
  74
  75 #define ASPATH_STR_DEFAULT_LEN 32
  76
  77 /* Prototypes. */
  78 extern void aspath_init(void);
  79 extern void aspath_finish(void);
  80 extern struct aspath *aspath_parse(struct stream *, size_t, int);
  81 extern struct aspath *aspath_dup(struct aspath *);
  82 extern struct aspath *aspath_aggregate(struct aspath *, struct aspath *);
  83 extern struct aspath *aspath_prepend(struct aspath *, struct aspath *);
  84 extern struct aspath *aspath_filter_exclude(struct aspath *, struct aspath *);
  85 extern struct aspath *aspath_add_seq_n(struct aspath *, as_t, unsigned);
  86 extern struct aspath *aspath_add_seq(struct aspath *, as_t);
  87 extern struct aspath *aspath_add_confed_seq(struct aspath *, as_t);
  88 extern bool aspath_cmp(const void *as1, const void *as2);
  89 extern int aspath_cmp_left(const struct aspath *, const struct aspath *);
  90 extern bool aspath_cmp_left_confed(const struct aspath *as1,
  91                                    const struct aspath *as2xs);
  92 extern struct aspath *aspath_delete_confed_seq(struct aspath *);
  93 extern struct aspath *aspath_empty(void);
  94 extern struct aspath *aspath_empty_get(void);
  95 extern struct aspath *aspath_str2aspath(const char *);
  96 extern void aspath_str_update(struct aspath *as, bool make_json);
  97 extern void aspath_free(struct aspath *);
  98 extern struct aspath *aspath_intern(struct aspath *);
  99 extern void aspath_unintern(struct aspath **);
 100 extern const char *aspath_print(struct aspath *);
 101 extern void aspath_print_vty(struct vty *, const char *, struct aspath *,
 102                              const char *);
 103 extern void aspath_print_all_vty(struct vty *);
 104 extern unsigned int aspath_key_make(void *);
 105 extern unsigned int aspath_get_first_as(struct aspath *);
 106 extern unsigned int aspath_get_last_as(struct aspath *);
 107 extern int aspath_loop_check(struct aspath *, as_t);
 108 extern int aspath_private_as_check(struct aspath *);
 109 extern int aspath_single_asn_check(struct aspath *, as_t asn);
 110 extern struct aspath *aspath_replace_specific_asn(struct aspath *aspath,
 111                                                   as_t target_asn,
 112                                                   as_t our_asn);
 113 extern struct aspath *aspath_replace_private_asns(struct aspath *aspath,
 114                                                   as_t asn);
 115 extern struct aspath *aspath_remove_private_asns(struct aspath *aspath);
 116 extern int aspath_firstas_check(struct aspath *, as_t);
 117 extern int aspath_confed_check(struct aspath *);
 118 extern int aspath_left_confed_check(struct aspath *);
 119 extern unsigned long aspath_count(void);
 120 extern unsigned int aspath_count_hops(const struct aspath *);
 121 extern unsigned int aspath_count_confeds(struct aspath *);
 122 extern unsigned int aspath_size(struct aspath *);
 123 extern as_t aspath_highest(struct aspath *);
 124 extern as_t aspath_leftmost(struct aspath *);
 125 extern size_t aspath_put(struct stream *, struct aspath *, int);
 126
 127 extern struct aspath *aspath_reconcile_as4(struct aspath *, struct aspath *);
 128 extern unsigned int aspath_has_as4(struct aspath *);
 129
 130 /* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
 131 extern uint8_t *aspath_snmp_pathseg(struct aspath *, size_t *);
 132
 133 #endif /* _QUAGGA_BGP_ASPATH_H */