2 * Copyright (C) 2016 Volta Networks, Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; see the file COPYING; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
28 #include "zebra/debug.h"
29 #include "zebra/rib.h"
30 #include "zebra/zserv.h"
31 #include "zebra/zebra_rnh.h"
32 #include "zebra/zebra_vrf.h"
33 #include "zebra/zebra_pw.h"
35 DEFINE_MTYPE_STATIC(LIB
, PW
, "Pseudowire")
37 DEFINE_QOBJ_TYPE(zebra_pw
)
39 DEFINE_HOOK(pw_install
, (struct zebra_pw
* pw
), (pw
))
40 DEFINE_HOOK(pw_uninstall
, (struct zebra_pw
* pw
), (pw
))
42 #define MPLS_NO_LABEL MPLS_INVALID_LABEL
44 extern struct zebra_t zebrad
;
46 static int zebra_pw_enabled(struct zebra_pw
*);
47 static void zebra_pw_install(struct zebra_pw
*);
48 static void zebra_pw_uninstall(struct zebra_pw
*);
49 static int zebra_pw_install_retry(struct thread
*);
50 static int zebra_pw_check_reachability(struct zebra_pw
*);
51 static void zebra_pw_update_status(struct zebra_pw
*, int);
53 static inline int zebra_pw_compare(const struct zebra_pw
*a
,
54 const struct zebra_pw
*b
)
56 return (strcmp(a
->ifname
, b
->ifname
));
59 RB_GENERATE(zebra_pw_head
, zebra_pw
, pw_entry
, zebra_pw_compare
)
60 RB_GENERATE(zebra_static_pw_head
, zebra_pw
, static_pw_entry
, zebra_pw_compare
)
62 struct zebra_pw
*zebra_pw_add(struct zebra_vrf
*zvrf
, const char *ifname
,
63 uint8_t protocol
, struct zserv
*client
)
67 if (IS_ZEBRA_DEBUG_PW
)
68 zlog_debug("%u: adding pseudowire %s protocol %s",
69 zvrf_id(zvrf
), ifname
, zebra_route_string(protocol
));
71 pw
= XCALLOC(MTYPE_PW
, sizeof(*pw
));
72 strlcpy(pw
->ifname
, ifname
, sizeof(pw
->ifname
));
73 pw
->protocol
= protocol
;
74 pw
->vrf_id
= zvrf_id(zvrf
);
76 pw
->status
= PW_STATUS_DOWN
;
77 pw
->local_label
= MPLS_NO_LABEL
;
78 pw
->remote_label
= MPLS_NO_LABEL
;
79 pw
->flags
= F_PSEUDOWIRE_CWORD
;
81 RB_INSERT(zebra_pw_head
, &zvrf
->pseudowires
, pw
);
82 if (pw
->protocol
== ZEBRA_ROUTE_STATIC
) {
83 RB_INSERT(zebra_static_pw_head
, &zvrf
->static_pseudowires
, pw
);
84 QOBJ_REG(pw
, zebra_pw
);
90 void zebra_pw_del(struct zebra_vrf
*zvrf
, struct zebra_pw
*pw
)
92 if (IS_ZEBRA_DEBUG_PW
)
93 zlog_debug("%u: deleting pseudowire %s protocol %s", pw
->vrf_id
,
94 pw
->ifname
, zebra_route_string(pw
->protocol
));
96 /* remove nexthop tracking */
97 zebra_deregister_rnh_pseudowire(pw
->vrf_id
, pw
);
100 if (pw
->status
== PW_STATUS_UP
)
101 hook_call(pw_uninstall
, pw
);
102 else if (pw
->install_retry_timer
)
103 THREAD_TIMER_OFF(pw
->install_retry_timer
);
105 /* unlink and release memory */
106 RB_REMOVE(zebra_pw_head
, &zvrf
->pseudowires
, pw
);
107 if (pw
->protocol
== ZEBRA_ROUTE_STATIC
)
108 RB_REMOVE(zebra_static_pw_head
, &zvrf
->static_pseudowires
, pw
);
112 void zebra_pw_change(struct zebra_pw
*pw
, ifindex_t ifindex
, int type
, int af
,
113 union g_addr
*nexthop
, uint32_t local_label
,
114 uint32_t remote_label
, uint8_t flags
,
115 union pw_protocol_fields
*data
)
117 zebra_deregister_rnh_pseudowire(pw
->vrf_id
, pw
);
119 pw
->ifindex
= ifindex
;
122 pw
->nexthop
= *nexthop
;
123 pw
->local_label
= local_label
;
124 pw
->remote_label
= remote_label
;
128 if (zebra_pw_enabled(pw
))
129 zebra_register_rnh_pseudowire(pw
->vrf_id
, pw
);
131 zebra_pw_uninstall(pw
);
134 struct zebra_pw
*zebra_pw_find(struct zebra_vrf
*zvrf
, const char *ifname
)
137 strlcpy(pw
.ifname
, ifname
, sizeof(pw
.ifname
));
138 return (RB_FIND(zebra_pw_head
, &zvrf
->pseudowires
, &pw
));
141 static int zebra_pw_enabled(struct zebra_pw
*pw
)
143 if (pw
->protocol
== ZEBRA_ROUTE_STATIC
) {
144 if (pw
->local_label
== MPLS_NO_LABEL
145 || pw
->remote_label
== MPLS_NO_LABEL
|| pw
->af
== AF_UNSPEC
)
152 void zebra_pw_update(struct zebra_pw
*pw
)
154 if (zebra_pw_check_reachability(pw
) < 0) {
155 zebra_pw_uninstall(pw
);
156 /* wait for NHT and try again later */
159 * Install or reinstall the pseudowire (e.g. to update
160 * parameters like the nexthop or the use of the control word).
162 zebra_pw_install(pw
);
166 static void zebra_pw_install(struct zebra_pw
*pw
)
168 if (IS_ZEBRA_DEBUG_PW
)
169 zlog_debug("%u: installing pseudowire %s protocol %s",
170 pw
->vrf_id
, pw
->ifname
,
171 zebra_route_string(pw
->protocol
));
173 if (hook_call(pw_install
, pw
)) {
174 zebra_pw_install_failure(pw
);
178 if (pw
->status
== PW_STATUS_DOWN
)
179 zebra_pw_update_status(pw
, PW_STATUS_UP
);
182 static void zebra_pw_uninstall(struct zebra_pw
*pw
)
184 if (pw
->status
== PW_STATUS_DOWN
)
187 if (IS_ZEBRA_DEBUG_PW
)
188 zlog_debug("%u: uninstalling pseudowire %s protocol %s",
189 pw
->vrf_id
, pw
->ifname
,
190 zebra_route_string(pw
->protocol
));
192 /* ignore any possible error */
193 hook_call(pw_uninstall
, pw
);
195 if (zebra_pw_enabled(pw
))
196 zebra_pw_update_status(pw
, PW_STATUS_DOWN
);
200 * Installation of the pseudowire in the kernel or hardware has failed. This
201 * function will notify the pseudowire client about the failure and schedule
202 * to retry the installation later. This function can be called by an external
203 * agent that performs the pseudowire installation in an asynchronous way.
205 void zebra_pw_install_failure(struct zebra_pw
*pw
)
207 if (IS_ZEBRA_DEBUG_PW
)
209 "%u: failed installing pseudowire %s, "
210 "scheduling retry in %u seconds",
211 pw
->vrf_id
, pw
->ifname
, PW_INSTALL_RETRY_INTERVAL
);
213 /* schedule to retry later */
214 THREAD_TIMER_OFF(pw
->install_retry_timer
);
215 thread_add_timer(zebrad
.master
, zebra_pw_install_retry
, pw
,
216 PW_INSTALL_RETRY_INTERVAL
, &pw
->install_retry_timer
);
218 zebra_pw_update_status(pw
, PW_STATUS_DOWN
);
221 static int zebra_pw_install_retry(struct thread
*thread
)
223 struct zebra_pw
*pw
= THREAD_ARG(thread
);
225 pw
->install_retry_timer
= NULL
;
226 zebra_pw_install(pw
);
231 static void zebra_pw_update_status(struct zebra_pw
*pw
, int status
)
235 zsend_pw_update(pw
->client
, pw
);
238 static int zebra_pw_check_reachability(struct zebra_pw
*pw
)
240 struct route_entry
*re
;
241 struct nexthop
*nexthop
;
243 /* TODO: consider GRE/L2TPv3 tunnels in addition to MPLS LSPs */
245 /* find route to the remote end of the pseudowire */
246 re
= rib_match(family2afi(pw
->af
), SAFI_UNICAST
, pw
->vrf_id
,
249 if (IS_ZEBRA_DEBUG_PW
)
250 zlog_warn("%s: no route found for %s", __func__
,
256 * Need to ensure that there's a label binding for all nexthops.
257 * Otherwise, ECMP for this route could render the pseudowire unusable.
259 for (ALL_NEXTHOPS(re
->nexthop
, nexthop
)) {
260 if (!nexthop
->nh_label
) {
261 if (IS_ZEBRA_DEBUG_PW
)
262 zlog_warn("%s: unlabeled route for %s",
263 __func__
, pw
->ifname
);
271 void zebra_pw_client_close(struct zserv
*client
)
274 struct zebra_vrf
*zvrf
;
275 struct zebra_pw
*pw
, *tmp
;
277 RB_FOREACH (vrf
, vrf_id_head
, &vrfs_by_id
) {
279 RB_FOREACH_SAFE (pw
, zebra_pw_head
, &zvrf
->pseudowires
, tmp
) {
280 if (pw
->client
!= client
)
282 zebra_pw_del(zvrf
, pw
);
287 void zebra_pw_init(struct zebra_vrf
*zvrf
)
289 RB_INIT(zebra_pw_head
, &zvrf
->pseudowires
);
290 RB_INIT(zebra_static_pw_head
, &zvrf
->static_pseudowires
);
293 void zebra_pw_exit(struct zebra_vrf
*zvrf
)
297 while (!RB_EMPTY(zebra_pw_head
, &zvrf
->pseudowires
)) {
298 pw
= RB_ROOT(zebra_pw_head
, &zvrf
->pseudowires
);
300 zebra_pw_del(zvrf
, pw
);
304 DEFUN_NOSH (pseudowire_if
,
306 "[no] pseudowire IFNAME",
308 "Static pseudowire configuration\n"
311 struct zebra_vrf
*zvrf
;
316 zvrf
= vrf_info_lookup(VRF_DEFAULT
);
320 argv_find(argv
, argc
, "IFNAME", &idx
);
321 ifname
= argv
[idx
]->arg
;
322 pw
= zebra_pw_find(zvrf
, ifname
);
323 if (pw
&& pw
->protocol
!= ZEBRA_ROUTE_STATIC
) {
324 vty_out(vty
, "%% Pseudowire is not static\n");
328 if (argv_find(argv
, argc
, "no", &idx
)) {
331 zebra_pw_del(zvrf
, pw
);
336 pw
= zebra_pw_add(zvrf
, ifname
, ZEBRA_ROUTE_STATIC
, NULL
);
337 VTY_PUSH_CONTEXT(PW_NODE
, pw
);
342 DEFUN (pseudowire_labels
,
343 pseudowire_labels_cmd
,
344 "[no] mpls label local (16-1048575) remote (16-1048575)",
346 "MPLS L2VPN PW command\n"
347 "MPLS L2VPN static labels\n"
348 "Local pseudowire label\n"
349 "Local pseudowire label\n"
350 "Remote pseudowire label\n"
351 "Remote pseudowire label\n")
353 VTY_DECLVAR_CONTEXT(zebra_pw
, pw
);
355 mpls_label_t local_label
, remote_label
;
357 if (argv_find(argv
, argc
, "no", &idx
)) {
358 local_label
= MPLS_NO_LABEL
;
359 remote_label
= MPLS_NO_LABEL
;
361 argv_find(argv
, argc
, "local", &idx
);
362 local_label
= atoi(argv
[idx
+ 1]->arg
);
363 argv_find(argv
, argc
, "remote", &idx
);
364 remote_label
= atoi(argv
[idx
+ 1]->arg
);
367 zebra_pw_change(pw
, pw
->ifindex
, pw
->type
, pw
->af
, &pw
->nexthop
,
368 local_label
, remote_label
, pw
->flags
, &pw
->data
);
373 DEFUN (pseudowire_neighbor
,
374 pseudowire_neighbor_cmd
,
375 "[no] neighbor <A.B.C.D|X:X::X:X>",
377 "Specify the IPv4 or IPv6 address of the remote endpoint\n"
381 VTY_DECLVAR_CONTEXT(zebra_pw
, pw
);
385 union g_addr nexthop
;
388 memset(&nexthop
, 0, sizeof(nexthop
));
390 if (!argv_find(argv
, argc
, "no", &idx
)) {
391 argv_find(argv
, argc
, "neighbor", &idx
);
392 address
= argv
[idx
+ 1]->arg
;
394 if (inet_pton(AF_INET
, address
, &nexthop
.ipv4
) == 1)
396 else if (inet_pton(AF_INET6
, address
, &nexthop
.ipv6
) == 1)
399 vty_out(vty
, "%% Malformed address\n");
404 zebra_pw_change(pw
, pw
->ifindex
, pw
->type
, af
, &nexthop
,
405 pw
->local_label
, pw
->remote_label
, pw
->flags
,
411 DEFUN (pseudowire_control_word
,
412 pseudowire_control_word_cmd
,
413 "[no] control-word <exclude|include>",
415 "Control-word options\n"
416 "Exclude control-word in pseudowire packets\n"
417 "Include control-word in pseudowire packets\n")
419 VTY_DECLVAR_CONTEXT(zebra_pw
, pw
);
423 if (argv_find(argv
, argc
, "no", &idx
))
424 flags
= F_PSEUDOWIRE_CWORD
;
426 argv_find(argv
, argc
, "control-word", &idx
);
427 if (argv
[idx
+ 1]->text
[0] == 'i')
428 flags
= F_PSEUDOWIRE_CWORD
;
431 zebra_pw_change(pw
, pw
->ifindex
, pw
->type
, pw
->af
, &pw
->nexthop
,
432 pw
->local_label
, pw
->remote_label
, flags
, &pw
->data
);
437 DEFUN (show_pseudowires
,
438 show_pseudowires_cmd
,
439 "show mpls pseudowires",
444 struct zebra_vrf
*zvrf
;
447 zvrf
= vrf_info_lookup(VRF_DEFAULT
);
451 vty_out(vty
, "%-16s %-24s %-12s %-8s %-10s\n", "Interface", "Neighbor",
452 "Labels", "Protocol", "Status");
454 RB_FOREACH (pw
, zebra_pw_head
, &zvrf
->pseudowires
) {
455 char buf_nbr
[INET6_ADDRSTRLEN
];
458 inet_ntop(pw
->af
, &pw
->nexthop
, buf_nbr
, sizeof(buf_nbr
));
460 if (pw
->local_label
!= MPLS_NO_LABEL
461 && pw
->remote_label
!= MPLS_NO_LABEL
)
462 snprintf(buf_labels
, sizeof(buf_labels
), "%u/%u",
463 pw
->local_label
, pw
->remote_label
);
465 snprintf(buf_labels
, sizeof(buf_labels
), "-");
467 vty_out(vty
, "%-16s %-24s %-12s %-8s %-10s\n", pw
->ifname
,
468 (pw
->af
!= AF_UNSPEC
) ? buf_nbr
: "-", buf_labels
,
469 zebra_route_string(pw
->protocol
),
470 (zebra_pw_enabled(pw
) && pw
->status
== PW_STATUS_UP
)
478 /* Pseudowire configuration write function. */
479 static int zebra_pw_config(struct vty
*vty
)
482 struct zebra_vrf
*zvrf
;
485 zvrf
= vrf_info_lookup(VRF_DEFAULT
);
489 RB_FOREACH (pw
, zebra_static_pw_head
, &zvrf
->static_pseudowires
) {
490 vty_out(vty
, "pseudowire %s\n", pw
->ifname
);
491 if (pw
->local_label
!= MPLS_NO_LABEL
492 && pw
->remote_label
!= MPLS_NO_LABEL
)
493 vty_out(vty
, " mpls label local %u remote %u\n",
494 pw
->local_label
, pw
->remote_label
);
497 " ! Incomplete config, specify the static "
500 if (pw
->af
!= AF_UNSPEC
) {
501 char buf
[INET6_ADDRSTRLEN
];
502 inet_ntop(pw
->af
, &pw
->nexthop
, buf
, sizeof(buf
));
503 vty_out(vty
, " neighbor %s\n", buf
);
506 " ! Incomplete config, specify a neighbor "
509 if (!(pw
->flags
& F_PSEUDOWIRE_CWORD
))
510 vty_out(vty
, " control-word exclude\n");
519 static struct cmd_node pw_node
= {
520 PW_NODE
, "%s(config-pw)# ", 1,
523 void zebra_pw_vty_init(void)
525 install_node(&pw_node
, zebra_pw_config
);
526 install_default(PW_NODE
);
528 install_element(CONFIG_NODE
, &pseudowire_if_cmd
);
529 install_element(PW_NODE
, &pseudowire_labels_cmd
);
530 install_element(PW_NODE
, &pseudowire_neighbor_cmd
);
531 install_element(PW_NODE
, &pseudowire_control_word_cmd
);
533 install_element(VIEW_NODE
, &show_pseudowires_cmd
);