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
  17 along with GNU Zebra; see the file COPYING.  If not, write to the Free
  18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  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 {
  53   struct assegment *next;
  54   as_t *as;
  55   u_short length;
  56   u_char type;
  57 };
  58
  59 /* AS path may be include some AsSegments.  */
  60 struct aspath
  61 {
  62   /* Reference count to this aspath.  */
  63   unsigned long refcnt;
  64
  65   /* segment data */
  66   struct assegment *segments;
  67
  68   /* AS path as a json object */
  69   json_object *json;
  70
  71   /* String expression of AS path.  This string is used by vty output
  72      and AS path regular expression match.  */
  73   char *str;
  74   unsigned short str_len;
  75 };
  76
  77 #define ASPATH_STR_DEFAULT_LEN 32
  78
  79 /* Prototypes. */
  80 extern void aspath_init (void);
  81 extern void aspath_finish (void);
  82 extern struct aspath *aspath_parse (struct stream *, size_t, int);
  83 extern struct aspath *aspath_dup (struct aspath *);
  84 extern struct aspath *aspath_aggregate (struct aspath *, struct aspath *);
  85 extern struct aspath *aspath_prepend (struct aspath *, struct aspath *);
  86 extern struct aspath *aspath_filter_exclude (struct aspath *, struct aspath *);
  87 extern struct aspath *aspath_add_seq_n (struct aspath *, as_t, unsigned);
  88 extern struct aspath *aspath_add_seq (struct aspath *, as_t);
  89 extern struct aspath *aspath_add_confed_seq (struct aspath *, as_t);
  90 extern int aspath_cmp (const void *, const void *);
  91 extern int aspath_cmp_left (const struct aspath *, const struct aspath *);
  92 extern int aspath_cmp_left_confed (const struct aspath *, const struct aspath *);
  93 extern struct aspath *aspath_delete_confed_seq (struct aspath *);
  94 extern struct aspath *aspath_empty (void);
  95 extern struct aspath *aspath_empty_get (void);
  96 extern struct aspath *aspath_str2aspath (const char *);
  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 *, const char *);
 102 extern void aspath_print_all_vty (struct vty *);
 103 extern unsigned int aspath_key_make (void *);
 104 extern unsigned int aspath_get_first_as (struct aspath *);
 105 extern unsigned int aspath_get_last_as (struct aspath *);
 106 extern int aspath_loop_check (struct aspath *, as_t);
 107 extern int aspath_private_as_check (struct aspath *);
 108 extern int aspath_single_asn_check (struct aspath *, as_t asn);
 109 extern struct aspath *aspath_replace_specific_asn (struct aspath *aspath, as_t target_asn, as_t our_asn);
 110 extern struct aspath *aspath_replace_private_asns(struct aspath *aspath, as_t asn);
 111 extern struct aspath *aspath_remove_private_asns (struct aspath *aspath);
 112 extern int aspath_firstas_check (struct aspath *, as_t);
 113 extern int aspath_confed_check (struct aspath *);
 114 extern int aspath_left_confed_check (struct aspath *);
 115 extern unsigned long aspath_count (void);
 116 extern unsigned int aspath_count_hops (const struct aspath *);
 117 extern unsigned int aspath_count_confeds (struct aspath *);
 118 extern unsigned int aspath_size (struct aspath *);
 119 extern as_t aspath_highest (struct aspath *);
 120 extern as_t aspath_leftmost (struct aspath *);
 121 extern size_t aspath_put (struct stream *, struct aspath *, int);
 122
 123 extern struct aspath *aspath_reconcile_as4 (struct aspath *, struct aspath *);
 124 extern unsigned int aspath_has_as4 (struct aspath *);
 125
 126 /* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
 127 extern u_char *aspath_snmp_pathseg (struct aspath *, size_t *);
 128
 129 #endif /* _QUAGGA_BGP_ASPATH_H */