RTRlib
pfx.h
1 /*
2  * This file is part of RTRlib.
3  *
4  * This file is subject to the terms and conditions of the MIT license.
5  * See the file LICENSE in the top level directory for more details.
6  *
7  * Website: http://rtrlib.realmv6.org/
8  */
9 
18 #ifndef RTR_PFX_H
19 #define RTR_PFX_H
20 
21 #include "rtrlib/lib/ip.h"
22 #include "rtrlib/pfx/trie/trie-pfx.h"
23 
24 #include <inttypes.h>
25 
29 enum pfx_rtvals {
32 
34  PFX_ERROR = -1,
35 
38 
41 };
42 
46 enum pfxv_state {
49 
52 
57 };
58 
65 typedef void (*pfx_for_each_fp)(const struct pfx_record *pfx_record, void *data);
66 
72 void pfx_table_init(struct pfx_table *pfx_table, pfx_update_fp update_fp);
73 
78 void pfx_table_free(struct pfx_table *pfx_table);
79 
88 int pfx_table_add(struct pfx_table *pfx_table, const struct pfx_record *pfx_record);
89 
98 int pfx_table_remove(struct pfx_table *pfx_table, const struct pfx_record *pfx_record);
99 
107 int pfx_table_src_remove(struct pfx_table *pfx_table, const struct rtr_socket *socket);
108 
119 int pfx_table_validate(struct pfx_table *pfx_table, const uint32_t asn, const struct lrtr_ip_addr *prefix,
120  const uint8_t mask_len, enum pfxv_state *result);
121 
135 int pfx_table_validate_r(struct pfx_table *pfx_table, struct pfx_record **reason, unsigned int *reason_len,
136  const uint32_t asn, const struct lrtr_ip_addr *prefix, const uint8_t mask_len,
137  enum pfxv_state *result);
138 
148 
158 
159 #endif
160 
PFX_DUPLICATE_RECORD
@ PFX_DUPLICATE_RECORD
Definition: pfx.h:37
pfx_table_init
void pfx_table_init(struct pfx_table *pfx_table, pfx_update_fp update_fp)
Initializes the pfx_table struct.
rtr_socket
A RTR socket.
Definition: rtr.h:116
pfx_table_for_each_ipv6_record
void pfx_table_for_each_ipv6_record(struct pfx_table *pfx_table, pfx_for_each_fp fp, void *data)
Iterates over all IPv6 records in the pfx_table.
pfx_record
pfx_record.
Definition: trie-pfx.h:42
pfx_update_fp
void(* pfx_update_fp)(struct pfx_table *pfx_table, const struct pfx_record record, const bool added)
A function pointer that is called if an record was added to the pfx_table or was removed from the pfx...
Definition: trie-pfx.h:56
pfx_table_free
void pfx_table_free(struct pfx_table *pfx_table)
Frees all memory associated with the pfx_table.
pfx_table_for_each_ipv4_record
void pfx_table_for_each_ipv4_record(struct pfx_table *pfx_table, pfx_for_each_fp fp, void *data)
Iterates over all IPv4 records in the pfx_table.
pfx_table
pfx_table.
Definition: trie-pfx.h:65
BGP_PFXV_STATE_INVALID
@ BGP_PFXV_STATE_INVALID
One or more records that match the input prefix exists in the pfx_table but the prefix max_len or ASN...
Definition: pfx.h:56
pfx_table_remove
int pfx_table_remove(struct pfx_table *pfx_table, const struct pfx_record *pfx_record)
Removes a pfx_record from a pfx_table.
pfx_table_validate
int pfx_table_validate(struct pfx_table *pfx_table, const uint32_t asn, const struct lrtr_ip_addr *prefix, const uint8_t mask_len, enum pfxv_state *result)
Validates the origin of a BGP-Route.
pfx_table_validate_r
int pfx_table_validate_r(struct pfx_table *pfx_table, struct pfx_record **reason, unsigned int *reason_len, const uint32_t asn, const struct lrtr_ip_addr *prefix, const uint8_t mask_len, enum pfxv_state *result)
Validates the origin of a BGP-Route and returns a list of pfx_record that decided the result.
PFX_ERROR
@ PFX_ERROR
Definition: pfx.h:34
pfx_for_each_fp
void(* pfx_for_each_fp)(const struct pfx_record *pfx_record, void *data)
A function pointer that is called for each record in the pfx_table.
Definition: pfx.h:65
lrtr_ip_addr
The lrtr_ip_addr struct stores a IPv4 or IPv6 address in host byte order.
Definition: ip.h:38
BGP_PFXV_STATE_NOT_FOUND
@ BGP_PFXV_STATE_NOT_FOUND
No certificate for the route exists.
Definition: pfx.h:51
pfx_rtvals
pfx_rtvals
Possible return values for pfx_ functions.
Definition: pfx.h:29
PFX_SUCCESS
@ PFX_SUCCESS
Definition: pfx.h:31
pfxv_state
pfxv_state
Validation states returned from pfx_validate_origin.
Definition: pfx.h:46
PFX_RECORD_NOT_FOUND
@ PFX_RECORD_NOT_FOUND
Definition: pfx.h:40
pfx_table_src_remove
int pfx_table_src_remove(struct pfx_table *pfx_table, const struct rtr_socket *socket)
Removes all entries in the pfx_table that match the passed socket_id value from a pfx_table.
BGP_PFXV_STATE_VALID
@ BGP_PFXV_STATE_VALID
Definition: pfx.h:48
pfx_table_add
int pfx_table_add(struct pfx_table *pfx_table, const struct pfx_record *pfx_record)
Adds a pfx_record to a pfx_table.