bgpd/bgp_lcommunity.h

   1 /* BGP Large Communities Attribute.
   2  *
   3  * Copyright (C) 2016 Keyur Patel <keyur@arrcus.com>
   4  *
   5  * This file is part of FRRouting (FRR).
   6  *
   7  * FRR is free software; you can redistribute it and/or modify it under the
   8  * terms of the GNU General Public License as published by the Free Software
   9  * Foundation; either version 2, or (at your option) any later version.
  10  *
  11  * FRR is distributed in the hope that it will be useful, but WITHOUT ANY
  12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * 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_LCOMMUNITY_H
  22 #define _QUAGGA_BGP_LCOMMUNITY_H
  23
  24 #include "lib/json.h"
  25 #include "bgpd/bgp_route.h"
  26 #include "bgpd/bgp_clist.h"
  27
  28 /* Large Communities value is twelve octets long.  */
  29 #define LCOMMUNITY_SIZE                        12
  30
  31 /* Large Communities attribute.  */
  32 struct lcommunity {
  33         /* Reference counter.  */
  34         unsigned long refcnt;
  35
  36         /* Size of Extended Communities attribute.  */
  37         int size;
  38
  39         /* Large Communities value.  */
  40         uint8_t *val;
  41
  42         /* Large Communities as a json object */
  43         json_object *json;
  44
  45         /* Human readable format string.  */
  46         char *str;
  47 };
  48
  49 /* Large community value is 12 octets.  */
  50 struct lcommunity_val {
  51         char val[LCOMMUNITY_SIZE];
  52 };
  53
  54 #define lcom_length(X)    ((X)->size * LCOMMUNITY_SIZE)
  55
  56 extern void lcommunity_init(void);
  57 extern void lcommunity_finish(void);
  58 extern void lcommunity_free(struct lcommunity **);
  59 extern struct lcommunity *lcommunity_parse(uint8_t *, unsigned short);
  60 extern struct lcommunity *lcommunity_dup(struct lcommunity *);
  61 extern struct lcommunity *lcommunity_merge(struct lcommunity *,
  62                                            struct lcommunity *);
  63 extern struct lcommunity *lcommunity_uniq_sort(struct lcommunity *);
  64 extern struct lcommunity *lcommunity_intern(struct lcommunity *);
  65 extern bool lcommunity_cmp(const void *arg1, const void *arg2);
  66 extern void lcommunity_unintern(struct lcommunity **);
  67 extern unsigned int lcommunity_hash_make(const void *);
  68 extern struct hash *lcommunity_hash(void);
  69 extern struct lcommunity *lcommunity_str2com(const char *);
  70 extern bool lcommunity_match(const struct lcommunity *,
  71                              const struct lcommunity *);
  72 extern char *lcommunity_str(struct lcommunity *, bool make_json,
  73                             bool translate_alias);
  74 extern bool lcommunity_include(struct lcommunity *lcom, uint8_t *ptr);
  75 extern void lcommunity_del_val(struct lcommunity *lcom, uint8_t *ptr);
  76
  77 extern void bgp_compute_aggregate_lcommunity(
  78                                         struct bgp_aggregate *aggregate,
  79                                         struct lcommunity *lcommunity);
  80
  81 extern void bgp_compute_aggregate_lcommunity_hash(
  82                                         struct bgp_aggregate *aggregate,
  83                                         struct lcommunity *lcommunity);
  84 extern void bgp_compute_aggregate_lcommunity_val(
  85                                         struct bgp_aggregate *aggregate);
  86
  87 extern void bgp_remove_lcommunity_from_aggregate(
  88                                         struct bgp_aggregate *aggregate,
  89                                         struct lcommunity *lcommunity);
  90 extern void bgp_remove_lcomm_from_aggregate_hash(
  91                                         struct bgp_aggregate *aggregate,
  92                                         struct lcommunity *lcommunity);
  93 extern void bgp_aggr_lcommunity_remove(void *arg);
  94
  95 #endif /* _QUAGGA_BGP_LCOMMUNITY_H */