lib/plist.h

   1 /*
   2  * Prefix list functions.
   3  * Copyright (C) 1999 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _QUAGGA_PLIST_H
  23 #define _QUAGGA_PLIST_H
  24
  25 #include <zebra.h>
  26
  27 #include "stream.h"
  28 #include "vty.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 enum prefix_list_type {
  35         PREFIX_DENY,
  36         PREFIX_PERMIT,
  37 };
  38
  39 struct prefix_list;
  40 struct prefix_list_entry;
  41
  42 struct orf_prefix {
  43         uint32_t seq;
  44         uint8_t ge;
  45         uint8_t le;
  46         struct prefix p;
  47 };
  48
  49 /* Prototypes. */
  50 extern void prefix_list_init(void);
  51 extern void prefix_list_reset(void);
  52 extern void prefix_list_add_hook(void (*func)(struct prefix_list *));
  53 extern void prefix_list_delete_hook(void (*func)(struct prefix_list *));
  54
  55 extern const char *prefix_list_name(struct prefix_list *);
  56 extern afi_t prefix_list_afi(struct prefix_list *);
  57 extern struct prefix_list *prefix_list_lookup(afi_t, const char *);
  58
  59 /*
  60  * prefix_list_apply_which_prefix
  61  *
  62  * Allow calling function to learn which prefix
  63  * caused the DENY or PERMIT.
  64  *
  65  * If no pointer is sent in, do not return anything.
  66  * If it is a empty plist return a NULL pointer.
  67  *
  68  * address_mode = the "prefix" being passed in is really an address, match
  69  * regardless of prefix length (i.e. ge/le are ignored.)  prefix->prefixlen
  70  * must be /32.
  71  */
  72 extern enum prefix_list_type
  73 prefix_list_apply_ext(struct prefix_list *plist,
  74                       const struct prefix_list_entry **matches,
  75                       union prefixconstptr prefix,
  76                       bool address_mode);
  77 #define prefix_list_apply(A, B) \
  78         prefix_list_apply_ext((A), NULL, (B), false)
  79
  80 extern struct prefix_list *prefix_bgp_orf_lookup(afi_t, const char *);
  81 extern struct stream *prefix_bgp_orf_entry(struct stream *,
  82                                            struct prefix_list *, uint8_t,
  83                                            uint8_t, uint8_t);
  84 extern int prefix_bgp_orf_set(char *, afi_t, struct orf_prefix *, int, int);
  85 extern void prefix_bgp_orf_remove_all(afi_t, char *);
  86 extern int prefix_bgp_show_prefix_list(struct vty *vty, afi_t afi, char *name,
  87                                        bool use_json);
  88
  89 extern struct prefix_list *prefix_list_get(afi_t afi, int orf,
  90                                            const char *name);
  91 extern void prefix_list_delete(struct prefix_list *plist);
  92 extern int64_t prefix_new_seq_get(struct prefix_list *plist);
  93
  94 extern struct prefix_list_entry *prefix_list_entry_new(void);
  95 extern void prefix_list_entry_delete(struct prefix_list *plist,
  96                                      struct prefix_list_entry *pentry,
  97                                      int update_list);
  98 extern struct prefix_list_entry *
  99 prefix_list_entry_lookup(struct prefix_list *plist, struct prefix *prefix,
 100                          enum prefix_list_type type, int64_t seq, int le,
 101                          int ge);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* _QUAGGA_PLIST_H */