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 FreeRangeRouting (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
  26 /* Large Communities value is twelve octets long.  */
  27 #define LCOMMUNITY_SIZE                        12
  28
  29 /* Large Communities attribute.  */
  30 struct lcommunity {
  31         /* Reference counter.  */
  32         unsigned long refcnt;
  33
  34         /* Size of Extended Communities attribute.  */
  35         int size;
  36
  37         /* Large Communities value.  */
  38         uint8_t *val;
  39
  40         /* Large Communities as a json object */
  41         json_object *json;
  42
  43         /* Human readable format string.  */
  44         char *str;
  45 };
  46
  47 /* Large community value is 12 octets.  */
  48 struct lcommunity_val {
  49         char val[LCOMMUNITY_SIZE];
  50 };
  51
  52 #define lcom_length(X)    ((X)->size * LCOMMUNITY_SIZE)
  53
  54 extern void lcommunity_init(void);
  55 extern void lcommunity_finish(void);
  56 extern void lcommunity_free(struct lcommunity **);
  57 extern struct lcommunity *lcommunity_parse(uint8_t *, unsigned short);
  58 extern struct lcommunity *lcommunity_dup(struct lcommunity *);
  59 extern struct lcommunity *lcommunity_merge(struct lcommunity *,
  60                                            struct lcommunity *);
  61 extern struct lcommunity *lcommunity_uniq_sort(struct lcommunity *);
  62 extern struct lcommunity *lcommunity_intern(struct lcommunity *);
  63 extern bool lcommunity_cmp(const void *arg1, const void *arg2);
  64 extern void lcommunity_unintern(struct lcommunity **);
  65 extern unsigned int lcommunity_hash_make(void *);
  66 extern struct hash *lcommunity_hash(void);
  67 extern struct lcommunity *lcommunity_str2com(const char *);
  68 extern int lcommunity_match(const struct lcommunity *,
  69                             const struct lcommunity *);
  70 extern char *lcommunity_str(struct lcommunity *, bool make_json);
  71 extern int lcommunity_include(struct lcommunity *lcom, uint8_t *ptr);
  72 extern void lcommunity_del_val(struct lcommunity *lcom, uint8_t *ptr);
  73 #endif /* _QUAGGA_BGP_LCOMMUNITY_H */