]>
Commit | Line | Data |
---|---|---|
7ee30f28 DS |
1 | /* |
2 | * Nexthop Group structure definition. | |
3 | * Copyright (C) 2018 Cumulus Networks, Inc. | |
4 | * Donald Sharp | |
5 | * | |
6 | * This program 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 Free | |
8 | * Software Foundation; either version 2 of the License, or (at your option) | |
9 | * any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
14 | * more 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 __NEXTHOP_GROUP__ | |
22 | #define __NEXTHOP_GROUP__ | |
23 | ||
1b7bce04 | 24 | #include <vty.h> |
010dd8ed | 25 | #include "json.h" |
1b7bce04 | 26 | |
5e244469 RW |
27 | #ifdef __cplusplus |
28 | extern "C" { | |
29 | #endif | |
30 | ||
7ee30f28 DS |
31 | /* |
32 | * What is a nexthop group? | |
33 | * | |
34 | * A nexthop group is a collection of nexthops that make up | |
35 | * the ECMP path for the route. | |
36 | * | |
37 | * This module provides a proper abstraction to this idea. | |
38 | */ | |
39 | struct nexthop_group { | |
40 | struct nexthop *nexthop; | |
41 | }; | |
42 | ||
31919191 DS |
43 | struct nexthop_group *nexthop_group_new(void); |
44 | void nexthop_group_delete(struct nexthop_group **nhg); | |
dba32923 | 45 | |
6c8b51e1 | 46 | void nexthop_group_copy(struct nexthop_group *to, |
c13bfa74 | 47 | const struct nexthop_group *from); |
e1f3a8eb MS |
48 | |
49 | /* | |
50 | * Copy a list of nexthops in 'nh' to an nhg, enforcing canonical sort order | |
51 | */ | |
52 | void nexthop_group_copy_nh_sorted(struct nexthop_group *nhg, | |
53 | const struct nexthop *nh); | |
54 | ||
deff170e | 55 | void copy_nexthops(struct nexthop **tnh, const struct nexthop *nh, |
7ee30f28 DS |
56 | struct nexthop *rparent); |
57 | ||
2f000944 | 58 | uint32_t nexthop_group_hash_no_recurse(const struct nexthop_group *nhg); |
1b1fe1c4 | 59 | uint32_t nexthop_group_hash(const struct nexthop_group *nhg); |
9ef49038 | 60 | void nexthop_group_mark_duplicates(struct nexthop_group *nhg); |
e4a1ec74 MS |
61 | |
62 | /* Add a nexthop to a list, enforcing the canonical sort order. */ | |
0eb97b86 MS |
63 | void nexthop_group_add_sorted(struct nexthop_group *nhg, |
64 | struct nexthop *nexthop); | |
1b1fe1c4 | 65 | |
7ee30f28 DS |
66 | /* The following for loop allows to iterate over the nexthop |
67 | * structure of routes. | |
68 | * | |
69 | * head: The pointer to the first nexthop in the chain. | |
70 | * | |
71 | * nexthop: The pointer to the current nexthop, either in the | |
72 | * top-level chain or in a resolved chain. | |
73 | */ | |
74 | #define ALL_NEXTHOPS(head, nhop) \ | |
75 | (nhop) = (head.nexthop); \ | |
76 | (nhop); \ | |
77 | (nhop) = nexthop_next(nhop) | |
31919191 | 78 | |
d826a734 MS |
79 | #define ALL_NEXTHOPS_PTR(head, nhop) \ |
80 | (nhop) = ((head)->nexthop); \ | |
81 | (nhop); \ | |
82 | (nhop) = nexthop_next(nhop) | |
83 | ||
c57bd6bb | 84 | |
0a8881b4 MS |
85 | #define NHGC_NAME_SIZE 80 |
86 | ||
31919191 DS |
87 | struct nexthop_group_cmd { |
88 | ||
89 | RB_ENTRY(nexthop_group_cmd) nhgc_entry; | |
90 | ||
0a8881b4 MS |
91 | char name[NHGC_NAME_SIZE]; |
92 | ||
93 | /* Name of group containing backup nexthops (if set) */ | |
94 | char backup_list_name[NHGC_NAME_SIZE]; | |
31919191 DS |
95 | |
96 | struct nexthop_group nhg; | |
97 | ||
c57bd6bb DS |
98 | struct list *nhg_list; |
99 | ||
31919191 DS |
100 | QOBJ_FIELDS |
101 | }; | |
102 | RB_HEAD(nhgc_entry_head, nexthp_group_cmd); | |
103 | RB_PROTOTYPE(nhgc_entry_head, nexthop_group_cmd, nhgc_entry, | |
104 | nexthop_group_cmd_compare) | |
105 | DECLARE_QOBJ_TYPE(nexthop_group_cmd) | |
106 | ||
107 | /* | |
108 | * Initialize nexthop_groups. If you are interested in when | |
109 | * a nexthop_group is added/deleted/modified, then set the | |
110 | * appropriate callback functions to handle it in your | |
111 | * code | |
112 | */ | |
113 | void nexthop_group_init( | |
d01b92fd | 114 | void (*create)(const char *name), |
31919191 DS |
115 | void (*add_nexthop)(const struct nexthop_group_cmd *nhgc, |
116 | const struct nexthop *nhop), | |
117 | void (*del_nexthop)(const struct nexthop_group_cmd *nhgc, | |
118 | const struct nexthop *nhop), | |
d01b92fd | 119 | void (*destroy)(const char *name)); |
31919191 | 120 | |
98cbbaea DS |
121 | void nexthop_group_enable_vrf(struct vrf *vrf); |
122 | void nexthop_group_disable_vrf(struct vrf *vrf); | |
123 | void nexthop_group_interface_state_change(struct interface *ifp, | |
124 | ifindex_t oldifindex); | |
125 | ||
8f8d9845 SW |
126 | extern struct nexthop *nexthop_exists(const struct nexthop_group *nhg, |
127 | const struct nexthop *nh); | |
2171b19c SW |
128 | /* This assumes ordered */ |
129 | extern bool nexthop_group_equal_no_recurse(const struct nexthop_group *nhg1, | |
130 | const struct nexthop_group *nhg2); | |
131 | ||
132 | /* This assumes ordered */ | |
8f8d9845 SW |
133 | extern bool nexthop_group_equal(const struct nexthop_group *nhg1, |
134 | const struct nexthop_group *nhg2); | |
d604266c DS |
135 | |
136 | extern struct nexthop_group_cmd *nhgc_find(const char *name); | |
137 | ||
79924520 SW |
138 | extern void nexthop_group_write_nexthop_simple(struct vty *vty, |
139 | const struct nexthop *nh); | |
28593bcc MS |
140 | extern void nexthop_group_write_nexthop(struct vty *vty, |
141 | const struct nexthop *nh); | |
5e244469 | 142 | |
28593bcc MS |
143 | extern void nexthop_group_json_nexthop(json_object *j, |
144 | const struct nexthop *nh); | |
010dd8ed | 145 | |
454192f4 DS |
146 | /* Return the number of nexthops in this nhg */ |
147 | extern uint8_t nexthop_group_nexthop_num(const struct nexthop_group *nhg); | |
148 | extern uint8_t | |
98cda54a SW |
149 | nexthop_group_nexthop_num_no_recurse(const struct nexthop_group *nhg); |
150 | extern uint8_t | |
454192f4 | 151 | nexthop_group_active_nexthop_num(const struct nexthop_group *nhg); |
98cda54a SW |
152 | extern uint8_t |
153 | nexthop_group_active_nexthop_num_no_recurse(const struct nexthop_group *nhg); | |
454192f4 | 154 | |
5e244469 RW |
155 | #ifdef __cplusplus |
156 | } | |
157 | #endif | |
158 | ||
7ee30f28 | 159 | #endif |