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 /* AS path segment type.  */
  25 #define AS_SET                       1
  26 #define AS_SEQUENCE                  2
  27 #define AS_CONFED_SEQUENCE           3
  28 #define AS_CONFED_SET                4
  29
  30 /* Private AS range defined in RFC2270.  */
  31 #define BGP_PRIVATE_AS_MIN       64512U
  32 #define BGP_PRIVATE_AS_MAX       65535U
  33
  34 /* Private 4 byte AS range defined in RFC6996.  */
  35 #define BGP_PRIVATE_AS4_MIN     4200000000U
  36 #define BGP_PRIVATE_AS4_MAX     4294967294U
  37
  38 /* we leave BGP_AS_MAX as the 16bit AS MAX number.  */
  39 #define BGP_AS_MAX                   65535U
  40 #define BGP_AS4_MAX             4294967295U
  41 /* Transition 16Bit AS as defined by IANA */
  42 #define BGP_AS_TRANS             23456U
  43
  44 #define BGP_AS_IS_PRIVATE(ASN) \
  45     (((ASN) >= BGP_PRIVATE_AS_MIN && (ASN) <= BGP_PRIVATE_AS_MAX) || \
  46      ((ASN) >= BGP_PRIVATE_AS4_MIN && (ASN) <= BGP_PRIVATE_AS4_MAX))
  47
  48 /* AS_PATH segment data in abstracted form, no limit is placed on length */
  49 struct assegment
  50 {
  51   struct assegment *next;
  52   as_t *as;
  53   u_short length;
  54   u_char type;
  55 };
  56
  57 /* AS path may be include some AsSegments.  */
  58 struct aspath
  59 {
  60   /* Reference count to this aspath.  */
  61   unsigned long refcnt;
  62
  63   /* segment data */
  64   struct assegment *segments;
  65
  66   /* String expression of AS path.  This string is used by vty output
  67      and AS path regular expression match.  */
  68   char *str;
  69   unsigned short str_len;
  70 };
  71
  72 #define ASPATH_STR_DEFAULT_LEN 32
  73
  74 /* Prototypes. */
  75 extern void aspath_init (void);
  76 extern void aspath_finish (void);
  77 extern struct aspath *aspath_parse (struct stream *, size_t, int);
  78 extern struct aspath *aspath_dup (struct aspath *);
  79 extern struct aspath *aspath_aggregate (struct aspath *, struct aspath *);
  80 extern struct aspath *aspath_aggregate_mpath (struct aspath *, struct aspath *);
  81 extern struct aspath *aspath_prepend (struct aspath *, struct aspath *);
  82 extern struct aspath *aspath_filter_exclude (struct aspath *, struct aspath *);
  83 extern struct aspath *aspath_add_seq_n (struct aspath *, as_t, unsigned);
  84 extern struct aspath *aspath_add_seq (struct aspath *, as_t);
  85 extern struct aspath *aspath_add_confed_seq (struct aspath *, as_t);
  86 extern int aspath_cmp (const void *, const void *);
  87 extern int aspath_cmp_left (const struct aspath *, const struct aspath *);
  88 extern int aspath_cmp_left_confed (const struct aspath *, const struct aspath *);
  89 extern struct aspath *aspath_delete_confed_seq (struct aspath *);
  90 extern struct aspath *aspath_empty (void);
  91 extern struct aspath *aspath_empty_get (void);
  92 extern struct aspath *aspath_str2aspath (const char *);
  93 extern void aspath_free (struct aspath *);
  94 extern struct aspath *aspath_intern (struct aspath *);
  95 extern void aspath_unintern (struct aspath **);
  96 extern const char *aspath_print (struct aspath *);
  97 extern void aspath_print_vty (struct vty *, const char *, struct aspath *, const char *);
  98 extern void aspath_print_all_vty (struct vty *);
  99 extern unsigned int aspath_key_make (void *);
 100 extern int aspath_loop_check (struct aspath *, as_t);
 101 extern int aspath_private_as_check (struct aspath *);
 102 extern int aspath_firstas_check (struct aspath *, as_t);
 103 extern int aspath_confed_check (struct aspath *);
 104 extern int aspath_left_confed_check (struct aspath *);
 105 extern unsigned long aspath_count (void);
 106 extern unsigned int aspath_count_hops (const struct aspath *);
 107 extern unsigned int aspath_count_confeds (struct aspath *);
 108 extern unsigned int aspath_size (struct aspath *);
 109 extern as_t aspath_highest (struct aspath *);
 110 extern as_t aspath_leftmost (struct aspath *);
 111 extern size_t aspath_put (struct stream *, struct aspath *, int);
 112
 113 extern struct aspath *aspath_reconcile_as4 (struct aspath *, struct aspath *);
 114 extern unsigned int aspath_has_as4 (struct aspath *);
 115
 116 /* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
 117 extern u_char *aspath_snmp_pathseg (struct aspath *, size_t *);
 118
 119 #endif /* _QUAGGA_BGP_ASPATH_H */