]> git.proxmox.com Git - mirror_frr.git/blob - lib/if.c
projects / mirror_frr.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #6891 from opensourcerouting/feature/sr-te-bgpd
[mirror_frr.git] / lib / if.c
1 /*
2 * Interface functions.
3 * Copyright (C) 1997, 98 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 #include <zebra.h>
23
24 #include "linklist.h"
25 #include "vector.h"
26 #include "lib_errors.h"
27 #include "vty.h"
28 #include "command.h"
29 #include "vrf.h"
30 #include "if.h"
31 #include "sockunion.h"
32 #include "prefix.h"
33 #include "memory.h"
34 #include "table.h"
35 #include "buffer.h"
36 #include "log.h"
37 #include "northbound_cli.h"
38 #ifndef VTYSH_EXTRACT_PL
39 #include "lib/if_clippy.c"
40 #endif
41
42 DEFINE_MTYPE_STATIC(LIB, IF, "Interface")
43 DEFINE_MTYPE_STATIC(LIB, CONNECTED, "Connected")
44 DEFINE_MTYPE_STATIC(LIB, NBR_CONNECTED, "Neighbor Connected")
45 DEFINE_MTYPE(LIB, CONNECTED_LABEL, "Connected interface label")
46 DEFINE_MTYPE_STATIC(LIB, IF_LINK_PARAMS, "Informational Link Parameters")
47
48 static struct interface *if_lookup_by_ifindex(ifindex_t ifindex,
49 vrf_id_t vrf_id);
50 static int if_cmp_func(const struct interface *, const struct interface *);
51 static int if_cmp_index_func(const struct interface *ifp1,
52 const struct interface *ifp2);
53 RB_GENERATE(if_name_head, interface, name_entry, if_cmp_func);
54 RB_GENERATE(if_index_head, interface, index_entry, if_cmp_index_func);
55
56 DEFINE_QOBJ_TYPE(interface)
57
58 DEFINE_HOOK(if_add, (struct interface * ifp), (ifp))
59 DEFINE_KOOH(if_del, (struct interface * ifp), (ifp))
60
61 static struct interface_master{
62 int (*create_hook)(struct interface *ifp);
63 int (*up_hook)(struct interface *ifp);
64 int (*down_hook)(struct interface *ifp);
65 int (*destroy_hook)(struct interface *ifp);
66 } ifp_master = { 0, };
67
68 /* Compare interface names, returning an integer greater than, equal to, or
69 * less than 0, (following the strcmp convention), according to the
70 * relationship between ifp1 and ifp2. Interface names consist of an
71 * alphabetic prefix and a numeric suffix. The primary sort key is
72 * lexicographic by name, and then numeric by number. No number sorts
73 * before all numbers. Examples: de0 < de1, de100 < fxp0 < xl0, devpty <
74 * devpty0, de0 < del0
75 */
76 int if_cmp_name_func(const char *p1, const char *p2)
77 {
78 unsigned int l1, l2;
79 long int x1, x2;
80 int res;
81
82 while (*p1 && *p2) {
83 /* look up to any number */
84 l1 = strcspn(p1, "0123456789");
85 l2 = strcspn(p2, "0123456789");
86
87 /* name lengths are different -> compare names */
88 if (l1 != l2)
89 return (strcmp(p1, p2));
90
91 /* Note that this relies on all numbers being less than all
92 * letters, so
93 * that de0 < del0.
94 */
95 res = strncmp(p1, p2, l1);
96
97 /* names are different -> compare them */
98 if (res)
99 return res;
100
101 /* with identical name part, go to numeric part */
102 p1 += l1;
103 p2 += l1;
104
105 if (!*p1 && !*p2)
106 return 0;
107 if (!*p1)
108 return -1;
109 if (!*p2)
110 return 1;
111
112 x1 = strtol(p1, (char **)&p1, 10);
113 x2 = strtol(p2, (char **)&p2, 10);
114
115 /* let's compare numbers now */
116 if (x1 < x2)
117 return -1;
118 if (x1 > x2)
119 return 1;
120
121 /* numbers were equal, lets do it again..
122 (it happens with name like "eth123.456:789") */
123 }
124 if (*p1)
125 return 1;
126 if (*p2)
127 return -1;
128 return 0;
129 }
130
131 static int if_cmp_func(const struct interface *ifp1,
132 const struct interface *ifp2)
133 {
134 return if_cmp_name_func(ifp1->name, ifp2->name);
135 }
136
137 static int if_cmp_index_func(const struct interface *ifp1,
138 const struct interface *ifp2)
139 {
140 if (ifp1->ifindex == ifp2->ifindex)
141 return 0;
142 else if (ifp1->ifindex > ifp2->ifindex)
143 return 1;
144 else
145 return -1;
146 }
147
148 static void ifp_connected_free(void *arg)
149 {
150 struct connected *c = arg;
151
152 connected_free(&c);
153 }
154
155 /* Create new interface structure. */
156 static struct interface *if_new(vrf_id_t vrf_id)
157 {
158 struct interface *ifp;
159
160 ifp = XCALLOC(MTYPE_IF, sizeof(struct interface));
161
162 ifp->ifindex = IFINDEX_INTERNAL;
163 ifp->name[0] = '\0';
164
165 ifp->vrf_id = vrf_id;
166
167 ifp->connected = list_new();
168 ifp->connected->del = ifp_connected_free;
169
170 ifp->nbr_connected = list_new();
171 ifp->nbr_connected->del = (void (*)(void *))nbr_connected_free;
172
173 /* Enable Link-detection by default */
174 SET_FLAG(ifp->status, ZEBRA_INTERFACE_LINKDETECTION);
175
176 QOBJ_REG(ifp, interface);
177 return ifp;
178 }
179
180 void if_new_via_zapi(struct interface *ifp)
181 {
182 if (ifp_master.create_hook)
183 (*ifp_master.create_hook)(ifp);
184 }
185
186 void if_destroy_via_zapi(struct interface *ifp)
187 {
188 if (ifp_master.destroy_hook)
189 (*ifp_master.destroy_hook)(ifp);
190
191 ifp->oldifindex = ifp->ifindex;
192 if_set_index(ifp, IFINDEX_INTERNAL);
193
194 if (!ifp->configured)
195 if_delete(&ifp);
196 }
197
198 void if_up_via_zapi(struct interface *ifp)
199 {
200 if (ifp_master.up_hook)
201 (*ifp_master.up_hook)(ifp);
202 }
203
204 void if_down_via_zapi(struct interface *ifp)
205 {
206 if (ifp_master.down_hook)
207 (*ifp_master.down_hook)(ifp);
208 }
209
210 struct interface *if_create_name(const char *name, vrf_id_t vrf_id)
211 {
212 struct interface *ifp;
213
214 ifp = if_new(vrf_id);
215
216 if_set_name(ifp, name);
217
218 hook_call(if_add, ifp);
219 return ifp;
220 }
221
222 struct interface *if_create_ifindex(ifindex_t ifindex, vrf_id_t vrf_id)
223 {
224 struct interface *ifp;
225
226 ifp = if_new(vrf_id);
227
228 if_set_index(ifp, ifindex);
229
230 hook_call(if_add, ifp);
231 return ifp;
232 }
233
234 /* Create new interface structure. */
235 void if_update_to_new_vrf(struct interface *ifp, vrf_id_t vrf_id)
236 {
237 struct vrf *old_vrf, *vrf;
238
239 /* remove interface from old master vrf list */
240 old_vrf = vrf_lookup_by_id(ifp->vrf_id);
241 if (old_vrf) {
242 if (ifp->name[0] != '\0')
243 IFNAME_RB_REMOVE(old_vrf, ifp);
244
245 if (ifp->ifindex != IFINDEX_INTERNAL)
246 IFINDEX_RB_REMOVE(old_vrf, ifp);
247 }
248
249 ifp->vrf_id = vrf_id;
250 vrf = vrf_get(ifp->vrf_id, NULL);
251
252 if (ifp->name[0] != '\0')
253 IFNAME_RB_INSERT(vrf, ifp);
254
255 if (ifp->ifindex != IFINDEX_INTERNAL)
256 IFINDEX_RB_INSERT(vrf, ifp);
257
258 /*
259 * HACK: Change the interface VRF in the running configuration directly,
260 * bypassing the northbound layer. This is necessary to avoid deleting
261 * the interface and readding it in the new VRF, which would have
262 * several implications.
263 */
264 if (yang_module_find("frr-interface")) {
265 struct lyd_node *if_dnode;
266 char oldpath[XPATH_MAXLEN];
267 char newpath[XPATH_MAXLEN];
268
269 if_dnode = yang_dnode_get(
270 running_config->dnode,
271 "/frr-interface:lib/interface[name='%s'][vrf='%s']/vrf",
272 ifp->name, old_vrf->name);
273
274 if (if_dnode) {
275 yang_dnode_get_path(if_dnode->parent, oldpath,
276 sizeof(oldpath));
277 yang_dnode_change_leaf(if_dnode, vrf->name);
278 yang_dnode_get_path(if_dnode->parent, newpath,
279 sizeof(newpath));
280 nb_running_move_tree(oldpath, newpath);
281 running_config->version++;
282 }
283 }
284 }
285
286
287 /* Delete interface structure. */
288 void if_delete_retain(struct interface *ifp)
289 {
290 hook_call(if_del, ifp);
291 QOBJ_UNREG(ifp);
292
293 /* Free connected address list */
294 list_delete_all_node(ifp->connected);
295
296 /* Free connected nbr address list */
297 list_delete_all_node(ifp->nbr_connected);
298 }
299
300 /* Delete and free interface structure. */
301 void if_delete(struct interface **ifp)
302 {
303 struct interface *ptr = *ifp;
304 struct vrf *vrf;
305
306 vrf = vrf_lookup_by_id(ptr->vrf_id);
307 assert(vrf);
308
309 IFNAME_RB_REMOVE(vrf, ptr);
310 if (ptr->ifindex != IFINDEX_INTERNAL)
311 IFINDEX_RB_REMOVE(vrf, ptr);
312
313 if_delete_retain(ptr);
314
315 list_delete(&ptr->connected);
316 list_delete(&ptr->nbr_connected);
317
318 if_link_params_free(ptr);
319
320 XFREE(MTYPE_TMP, ptr->desc);
321
322 XFREE(MTYPE_IF, ptr);
323 *ifp = NULL;
324 }
325
326 /* Used only internally to check within VRF only */
327 static struct interface *if_lookup_by_ifindex(ifindex_t ifindex,
328 vrf_id_t vrf_id)
329 {
330 struct vrf *vrf;
331 struct interface if_tmp;
332
333 vrf = vrf_lookup_by_id(vrf_id);
334 if (!vrf)
335 return NULL;
336
337 if_tmp.ifindex = ifindex;
338 return RB_FIND(if_index_head, &vrf->ifaces_by_index, &if_tmp);
339 }
340
341 /* Interface existance check by index. */
342 struct interface *if_lookup_by_index(ifindex_t ifindex, vrf_id_t vrf_id)
343 {
344 switch (vrf_get_backend()) {
345 case VRF_BACKEND_UNKNOWN:
346 case VRF_BACKEND_NETNS:
347 return(if_lookup_by_ifindex(ifindex, vrf_id));
348 case VRF_BACKEND_VRF_LITE:
349 return(if_lookup_by_index_all_vrf(ifindex));
350 }
351 return NULL;
352 }
353
354 const char *ifindex2ifname(ifindex_t ifindex, vrf_id_t vrf_id)
355 {
356 struct interface *ifp;
357
358 return ((ifp = if_lookup_by_index(ifindex, vrf_id)) != NULL)
359 ? ifp->name
360 : "unknown";
361 }
362
363 ifindex_t ifname2ifindex(const char *name, vrf_id_t vrf_id)
364 {
365 struct interface *ifp;
366
367 return ((ifp = if_lookup_by_name(name, vrf_id)) != NULL)
368 ? ifp->ifindex
369 : IFINDEX_INTERNAL;
370 }
371
372 /* Interface existance check by interface name. */
373 struct interface *if_lookup_by_name(const char *name, vrf_id_t vrf_id)
374 {
375 struct vrf *vrf = vrf_lookup_by_id(vrf_id);
376 struct interface if_tmp;
377
378 if (!vrf || !name
379 || strnlen(name, INTERFACE_NAMSIZ) == INTERFACE_NAMSIZ)
380 return NULL;
381
382 strlcpy(if_tmp.name, name, sizeof(if_tmp.name));
383 return RB_FIND(if_name_head, &vrf->ifaces_by_name, &if_tmp);
384 }
385
386 struct interface *if_lookup_by_name_vrf(const char *name, struct vrf *vrf)
387 {
388 struct interface if_tmp;
389
390 if (!name || strnlen(name, INTERFACE_NAMSIZ) == INTERFACE_NAMSIZ)
391 return NULL;
392
393 strlcpy(if_tmp.name, name, sizeof(if_tmp.name));
394 return RB_FIND(if_name_head, &vrf->ifaces_by_name, &if_tmp);
395 }
396
397 struct interface *if_lookup_by_name_all_vrf(const char *name)
398 {
399 struct vrf *vrf;
400 struct interface *ifp;
401
402 if (!name || strnlen(name, INTERFACE_NAMSIZ) == INTERFACE_NAMSIZ)
403 return NULL;
404
405 RB_FOREACH (vrf, vrf_id_head, &vrfs_by_id) {
406 ifp = if_lookup_by_name(name, vrf->vrf_id);
407 if (ifp)
408 return ifp;
409 }
410
411 return NULL;
412 }
413
414 struct interface *if_lookup_by_index_all_vrf(ifindex_t ifindex)
415 {
416 struct vrf *vrf;
417 struct interface *ifp;
418
419 if (ifindex == IFINDEX_INTERNAL)
420 return NULL;
421
422 RB_FOREACH (vrf, vrf_id_head, &vrfs_by_id) {
423 ifp = if_lookup_by_ifindex(ifindex, vrf->vrf_id);
424 if (ifp)
425 return ifp;
426 }
427
428 return NULL;
429 }
430
431 /* Lookup interface by IP address. */
432 struct interface *if_lookup_exact_address(const void *src, int family,
433 vrf_id_t vrf_id)
434 {
435 struct vrf *vrf = vrf_lookup_by_id(vrf_id);
436 struct listnode *cnode;
437 struct interface *ifp;
438 struct prefix *p;
439 struct connected *c;
440
441 FOR_ALL_INTERFACES (vrf, ifp) {
442 for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, c)) {
443 p = c->address;
444
445 if (p && (p->family == family)) {
446 if (family == AF_INET) {
447 if (IPV4_ADDR_SAME(
448 &p->u.prefix4,
449 (struct in_addr *)src))
450 return ifp;
451 } else if (family == AF_INET6) {
452 if (IPV6_ADDR_SAME(
453 &p->u.prefix6,
454 (struct in6_addr *)src))
455 return ifp;
456 }
457 }
458 }
459 }
460 return NULL;
461 }
462
463 /* Lookup interface by IP address. */
464 struct connected *if_lookup_address(const void *matchaddr, int family,
465 vrf_id_t vrf_id)
466 {
467 struct vrf *vrf = vrf_lookup_by_id(vrf_id);
468 struct prefix addr;
469 int bestlen = 0;
470 struct listnode *cnode;
471 struct interface *ifp;
472 struct connected *c;
473 struct connected *match;
474
475 if (family == AF_INET) {
476 addr.family = AF_INET;
477 addr.u.prefix4 = *((struct in_addr *)matchaddr);
478 addr.prefixlen = IPV4_MAX_BITLEN;
479 } else if (family == AF_INET6) {
480 addr.family = AF_INET6;
481 addr.u.prefix6 = *((struct in6_addr *)matchaddr);
482 addr.prefixlen = IPV6_MAX_BITLEN;
483 }
484
485 match = NULL;
486
487 FOR_ALL_INTERFACES (vrf, ifp) {
488 for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, c)) {
489 if (c->address && (c->address->family == AF_INET)
490 && prefix_match(CONNECTED_PREFIX(c), &addr)
491 && (c->address->prefixlen > bestlen)) {
492 bestlen = c->address->prefixlen;
493 match = c;
494 }
495 }
496 }
497 return match;
498 }
499
500 /* Lookup interface by prefix */
501 struct interface *if_lookup_prefix(const struct prefix *prefix, vrf_id_t vrf_id)
502 {
503 struct vrf *vrf = vrf_lookup_by_id(vrf_id);
504 struct listnode *cnode;
505 struct interface *ifp;
506 struct connected *c;
507
508 FOR_ALL_INTERFACES (vrf, ifp) {
509 for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, c)) {
510 if (prefix_cmp(c->address, prefix) == 0) {
511 return ifp;
512 }
513 }
514 }
515 return NULL;
516 }
517
518 size_t if_lookup_by_hwaddr(const uint8_t *hw_addr, size_t addrsz,
519 struct interface ***result, vrf_id_t vrf_id)
520 {
521 struct vrf *vrf = vrf_lookup_by_id(vrf_id);
522
523 struct list *rs = list_new();
524 struct interface *ifp;
525
526 FOR_ALL_INTERFACES (vrf, ifp) {
527 if (ifp->hw_addr_len == (int)addrsz
528 && !memcmp(hw_addr, ifp->hw_addr, addrsz))
529 listnode_add(rs, ifp);
530 }
531
532 if (rs->count) {
533 *result = XCALLOC(MTYPE_TMP,
534 sizeof(struct interface *) * rs->count);
535 list_to_array(rs, (void **)*result, rs->count);
536 }
537
538 int count = rs->count;
539
540 list_delete(&rs);
541
542 return count;
543 }
544
545
546 /* Get interface by name if given name interface doesn't exist create
547 one. */
548 struct interface *if_get_by_name(const char *name, vrf_id_t vrf_id)
549 {
550 struct interface *ifp;
551
552 switch (vrf_get_backend()) {
553 case VRF_BACKEND_UNKNOWN:
554 case VRF_BACKEND_NETNS:
555 ifp = if_lookup_by_name(name, vrf_id);
556 if (ifp)
557 return ifp;
558 return if_create_name(name, vrf_id);
559 case VRF_BACKEND_VRF_LITE:
560 ifp = if_lookup_by_name_all_vrf(name);
561 if (ifp) {
562 if (ifp->vrf_id == vrf_id)
563 return ifp;
564 /* If it came from the kernel or by way of zclient,
565 * believe it and update the ifp accordingly.
566 */
567 if_update_to_new_vrf(ifp, vrf_id);
568 return ifp;
569 }
570 return if_create_name(name, vrf_id);
571 }
572
573 return NULL;
574 }
575
576 struct interface *if_get_by_ifindex(ifindex_t ifindex, vrf_id_t vrf_id)
577 {
578 struct interface *ifp;
579
580 switch (vrf_get_backend()) {
581 case VRF_BACKEND_UNKNOWN:
582 case VRF_BACKEND_NETNS:
583 ifp = if_lookup_by_ifindex(ifindex, vrf_id);
584 if (ifp)
585 return ifp;
586 return if_create_ifindex(ifindex, vrf_id);
587 case VRF_BACKEND_VRF_LITE:
588 ifp = if_lookup_by_index_all_vrf(ifindex);
589 if (ifp) {
590 if (ifp->vrf_id == vrf_id)
591 return ifp;
592 /* If it came from the kernel or by way of zclient,
593 * believe it and update the ifp accordingly.
594 */
595 if_update_to_new_vrf(ifp, vrf_id);
596 return ifp;
597 }
598 return if_create_ifindex(ifindex, vrf_id);
599 }
600
601 return NULL;
602 }
603
604 int if_set_index(struct interface *ifp, ifindex_t ifindex)
605 {
606 struct vrf *vrf;
607
608 if (ifp->ifindex == ifindex)
609 return 0;
610
611 vrf = vrf_get(ifp->vrf_id, NULL);
612 assert(vrf);
613
614 /*
615 * If there is already an interface with this ifindex, we will collide
616 * on insertion, so don't even try.
617 */
618 if (if_lookup_by_ifindex(ifindex, ifp->vrf_id))
619 return -1;
620
621 if (ifp->ifindex != IFINDEX_INTERNAL)
622 IFINDEX_RB_REMOVE(vrf, ifp);
623
624 ifp->ifindex = ifindex;
625
626 if (ifp->ifindex != IFINDEX_INTERNAL) {
627 /*
628 * This should never happen, since we checked if there was
629 * already an interface with the desired ifindex at the top of
630 * the function. Nevertheless.
631 */
632 if (IFINDEX_RB_INSERT(vrf, ifp))
633 return -1;
634 }
635
636 return 0;
637 }
638
639 void if_set_name(struct interface *ifp, const char *name)
640 {
641 struct vrf *vrf;
642
643 vrf = vrf_get(ifp->vrf_id, NULL);
644 assert(vrf);
645
646 if (if_cmp_name_func(ifp->name, name) == 0)
647 return;
648
649 if (ifp->name[0] != '\0')
650 IFNAME_RB_REMOVE(vrf, ifp);
651
652 strlcpy(ifp->name, name, sizeof(ifp->name));
653
654 if (ifp->name[0] != '\0')
655 IFNAME_RB_INSERT(vrf, ifp);
656 }
657
658 /* Does interface up ? */
659 int if_is_up(const struct interface *ifp)
660 {
661 return ifp->flags & IFF_UP;
662 }
663
664 /* Is interface running? */
665 int if_is_running(const struct interface *ifp)
666 {
667 return ifp->flags & IFF_RUNNING;
668 }
669
670 /* Is the interface operative, eg. either UP & RUNNING
671 or UP & !ZEBRA_INTERFACE_LINK_DETECTION and
672 if ptm checking is enabled, then ptm check has passed */
673 int if_is_operative(const struct interface *ifp)
674 {
675 return ((ifp->flags & IFF_UP)
676 && (((ifp->flags & IFF_RUNNING)
677 && (ifp->ptm_status || !ifp->ptm_enable))
678 || !CHECK_FLAG(ifp->status,
679 ZEBRA_INTERFACE_LINKDETECTION)));
680 }
681
682 /* Is the interface operative, eg. either UP & RUNNING
683 or UP & !ZEBRA_INTERFACE_LINK_DETECTION, without PTM check */
684 int if_is_no_ptm_operative(const struct interface *ifp)
685 {
686 return ((ifp->flags & IFF_UP)
687 && ((ifp->flags & IFF_RUNNING)
688 || !CHECK_FLAG(ifp->status,
689 ZEBRA_INTERFACE_LINKDETECTION)));
690 }
691
692 /* Is this loopback interface ? */
693 int if_is_loopback(const struct interface *ifp)
694 {
695 /* XXX: Do this better, eg what if IFF_WHATEVER means X on platform M
696 * but Y on platform N?
697 */
698 return (ifp->flags & (IFF_LOOPBACK | IFF_NOXMIT | IFF_VIRTUAL));
699 }
700
701 /* Check interface is VRF */
702 int if_is_vrf(const struct interface *ifp)
703 {
704 return CHECK_FLAG(ifp->status, ZEBRA_INTERFACE_VRF_LOOPBACK);
705 }
706
707 bool if_is_loopback_or_vrf(const struct interface *ifp)
708 {
709 if (if_is_loopback(ifp) || if_is_vrf(ifp))
710 return true;
711
712 return false;
713 }
714
715 /* Does this interface support broadcast ? */
716 int if_is_broadcast(const struct interface *ifp)
717 {
718 return ifp->flags & IFF_BROADCAST;
719 }
720
721 /* Does this interface support broadcast ? */
722 int if_is_pointopoint(const struct interface *ifp)
723 {
724 return ifp->flags & IFF_POINTOPOINT;
725 }
726
727 /* Does this interface support multicast ? */
728 int if_is_multicast(const struct interface *ifp)
729 {
730 return ifp->flags & IFF_MULTICAST;
731 }
732
733 /* Printout flag information into log */
734 const char *if_flag_dump(unsigned long flag)
735 {
736 int separator = 0;
737 static char logbuf[BUFSIZ];
738
739 #define IFF_OUT_LOG(X, STR) \
740 if (flag & (X)) { \
741 if (separator) \
742 strlcat(logbuf, ",", sizeof(logbuf)); \
743 else \
744 separator = 1; \
745 strlcat(logbuf, STR, sizeof(logbuf)); \
746 }
747
748 strlcpy(logbuf, "<", BUFSIZ);
749 IFF_OUT_LOG(IFF_UP, "UP");
750 IFF_OUT_LOG(IFF_BROADCAST, "BROADCAST");
751 IFF_OUT_LOG(IFF_DEBUG, "DEBUG");
752 IFF_OUT_LOG(IFF_LOOPBACK, "LOOPBACK");
753 IFF_OUT_LOG(IFF_POINTOPOINT, "POINTOPOINT");
754 IFF_OUT_LOG(IFF_NOTRAILERS, "NOTRAILERS");
755 IFF_OUT_LOG(IFF_RUNNING, "RUNNING");
756 IFF_OUT_LOG(IFF_NOARP, "NOARP");
757 IFF_OUT_LOG(IFF_PROMISC, "PROMISC");
758 IFF_OUT_LOG(IFF_ALLMULTI, "ALLMULTI");
759 IFF_OUT_LOG(IFF_OACTIVE, "OACTIVE");
760 IFF_OUT_LOG(IFF_SIMPLEX, "SIMPLEX");
761 IFF_OUT_LOG(IFF_LINK0, "LINK0");
762 IFF_OUT_LOG(IFF_LINK1, "LINK1");
763 IFF_OUT_LOG(IFF_LINK2, "LINK2");
764 IFF_OUT_LOG(IFF_MULTICAST, "MULTICAST");
765 IFF_OUT_LOG(IFF_NOXMIT, "NOXMIT");
766 IFF_OUT_LOG(IFF_NORTEXCH, "NORTEXCH");
767 IFF_OUT_LOG(IFF_VIRTUAL, "VIRTUAL");
768 IFF_OUT_LOG(IFF_IPV4, "IPv4");
769 IFF_OUT_LOG(IFF_IPV6, "IPv6");
770
771 strlcat(logbuf, ">", sizeof(logbuf));
772
773 return logbuf;
774 #undef IFF_OUT_LOG
775 }
776
777 /* For debugging */
778 static void if_dump(const struct interface *ifp)
779 {
780 struct listnode *node;
781 struct connected *c __attribute__((unused));
782
783 for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, c)) {
784 struct vrf *vrf = vrf_lookup_by_id(ifp->vrf_id);
785
786 zlog_info(
787 "Interface %s vrf %s(%u) index %d metric %d mtu %d mtu6 %d %s",
788 ifp->name, VRF_LOGNAME(vrf), ifp->vrf_id, ifp->ifindex,
789 ifp->metric, ifp->mtu, ifp->mtu6,
790 if_flag_dump(ifp->flags));
791 }
792 }
793
794 /* Interface printing for all interface. */
795 void if_dump_all(void)
796 {
797 struct vrf *vrf;
798 void *ifp;
799
800 RB_FOREACH (vrf, vrf_id_head, &vrfs_by_id)
801 FOR_ALL_INTERFACES (vrf, ifp)
802 if_dump(ifp);
803 }
804
805 #ifdef SUNOS_5
806 /* Need to handle upgrade from SUNWzebra to Quagga. SUNWzebra created
807 * a seperate struct interface for each logical interface, so config
808 * file may be full of 'interface fooX:Y'. Solaris however does not
809 * expose logical interfaces via PF_ROUTE, so trying to track logical
810 * interfaces can be fruitless, for that reason Quagga only tracks
811 * the primary IP interface.
812 *
813 * We try accomodate SUNWzebra by:
814 * - looking up the interface name, to see whether it exists, if so
815 * its useable
816 * - for protocol daemons, this could only because zebra told us of
817 * the interface
818 * - for zebra, only because it learnt from kernel
819 * - if not:
820 * - search the name to see if it contains a sub-ipif / logical interface
821 * seperator, the ':' char. If it does:
822 * - text up to that char must be the primary name - get that name.
823 * if not:
824 * - no idea, just get the name in its entirety.
825 */
826 static struct interface *if_sunwzebra_get(const char *name, vrf_id_t vrf_id)
827 {
828 struct interface *ifp;
829 char *cp;
830
831 if ((ifp = if_lookup_by_name(name, vrf_id)) != NULL)
832 return ifp;
833
834 /* hunt the primary interface name... */
835 cp = strchr(name, ':');
836 if (cp)
837 *cp = '\0';
838
839 return if_get_by_name(name, vrf_id);
840 }
841 #endif /* SUNOS_5 */
842
843 #if 0
844 /* For debug purpose. */
845 DEFUN (show_address,
846 show_address_cmd,
847 "show address [vrf NAME]",
848 SHOW_STR
849 "address\n"
850 VRF_CMD_HELP_STR)
851 {
852 int idx_vrf = 3;
853 struct listnode *node;
854 struct interface *ifp;
855 struct connected *ifc;
856 struct prefix *p;
857 vrf_id_t vrf_id = VRF_DEFAULT;
858
859 if (argc > 2)
860 VRF_GET_ID (vrf_id, argv[idx_vrf]->arg);
861
862 FOR_ALL_INTERFACES (vrf, ifp) {
863 for (ALL_LIST_ELEMENTS_RO (ifp->connected, node, ifc)) {
864 p = ifc->address;
865
866 if (p->family == AF_INET)
867 vty_out (vty, "%s/%d\n", inet_ntoa (p->u.prefix4), p->prefixlen);
868 }
869 }
870 return CMD_SUCCESS;
871 }
872
873 DEFUN (show_address_vrf_all,
874 show_address_vrf_all_cmd,
875 "show address vrf all",
876 SHOW_STR
877 "address\n"
878 VRF_ALL_CMD_HELP_STR)
879 {
880 struct vrf *vrf;
881 struct listnode *node;
882 struct interface *ifp;
883 struct connected *ifc;
884 struct prefix *p;
885
886 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name)
887 {
888 if (RB_EMPTY (if_name_head, &vrf->ifaces_by_name))
889 continue;
890
891 vty_out (vty, "\nVRF %s(%u)\n\n",
892 VRF_LOGNAME(vrf), vrf->vrf_id);
893
894 FOR_ALL_INTERFACES (vrf, ifp) {
895 for (ALL_LIST_ELEMENTS_RO (ifp->connected, node, ifc)) {
896 p = ifc->address;
897
898 if (p->family == AF_INET)
899 vty_out (vty, "%s/%d\n", inet_ntoa (p->u.prefix4), p->prefixlen);
900 }
901 }
902 }
903 return CMD_SUCCESS;
904 }
905 #endif
906
907 /* Allocate connected structure. */
908 struct connected *connected_new(void)
909 {
910 return XCALLOC(MTYPE_CONNECTED, sizeof(struct connected));
911 }
912
913 /* Allocate nbr connected structure. */
914 struct nbr_connected *nbr_connected_new(void)
915 {
916 return XCALLOC(MTYPE_NBR_CONNECTED, sizeof(struct nbr_connected));
917 }
918
919 /* Free connected structure. */
920 void connected_free(struct connected **connected)
921 {
922 struct connected *ptr = *connected;
923
924 prefix_free(&ptr->address);
925 prefix_free(&ptr->destination);
926
927 XFREE(MTYPE_CONNECTED_LABEL, ptr->label);
928
929 XFREE(MTYPE_CONNECTED, ptr);
930 *connected = NULL;
931 }
932
933 /* Free nbr connected structure. */
934 void nbr_connected_free(struct nbr_connected *connected)
935 {
936 if (connected->address)
937 prefix_free(&connected->address);
938
939 XFREE(MTYPE_NBR_CONNECTED, connected);
940 }
941
942 /* If same interface nbr address already exists... */
943 struct nbr_connected *nbr_connected_check(struct interface *ifp,
944 struct prefix *p)
945 {
946 struct nbr_connected *ifc;
947 struct listnode *node;
948
949 for (ALL_LIST_ELEMENTS_RO(ifp->nbr_connected, node, ifc))
950 if (prefix_same(ifc->address, p))
951 return ifc;
952
953 return NULL;
954 }
955
956 /* Print if_addr structure. */
957 static void __attribute__((unused))
958 connected_log(struct connected *connected, char *str)
959 {
960 struct prefix *p;
961 struct interface *ifp;
962 struct vrf *vrf;
963 char logbuf[BUFSIZ];
964 char buf[BUFSIZ];
965
966 ifp = connected->ifp;
967 p = connected->address;
968
969 vrf = vrf_lookup_by_id(ifp->vrf_id);
970 snprintf(logbuf, sizeof(logbuf), "%s interface %s vrf %s(%u) %s %s/%d ",
971 str, ifp->name, VRF_LOGNAME(vrf), ifp->vrf_id,
972 prefix_family_str(p),
973 inet_ntop(p->family, &p->u.prefix, buf, BUFSIZ), p->prefixlen);
974
975 p = connected->destination;
976 if (p) {
977 strncat(logbuf, inet_ntop(p->family, &p->u.prefix, buf, BUFSIZ),
978 BUFSIZ - strlen(logbuf));
979 }
980 zlog_info("%s", logbuf);
981 }
982
983 /* Print if_addr structure. */
984 static void __attribute__((unused))
985 nbr_connected_log(struct nbr_connected *connected, char *str)
986 {
987 struct prefix *p;
988 struct interface *ifp;
989 char logbuf[BUFSIZ];
990 char buf[BUFSIZ];
991
992 ifp = connected->ifp;
993 p = connected->address;
994
995 snprintf(logbuf, sizeof(logbuf), "%s interface %s %s %s/%d ", str,
996 ifp->name, prefix_family_str(p),
997 inet_ntop(p->family, &p->u.prefix, buf, BUFSIZ), p->prefixlen);
998
999 zlog_info("%s", logbuf);
1000 }
1001
1002 /* If two connected address has same prefix return 1. */
1003 static int connected_same_prefix(const struct prefix *p1,
1004 const struct prefix *p2)
1005 {
1006 if (p1->family == p2->family) {
1007 if (p1->family == AF_INET
1008 && IPV4_ADDR_SAME(&p1->u.prefix4, &p2->u.prefix4))
1009 return 1;
1010 if (p1->family == AF_INET6
1011 && IPV6_ADDR_SAME(&p1->u.prefix6, &p2->u.prefix6))
1012 return 1;
1013 }
1014 return 0;
1015 }
1016
1017 /* count the number of connected addresses that are in the given family */
1018 unsigned int connected_count_by_family(struct interface *ifp, int family)
1019 {
1020 struct listnode *cnode;
1021 struct connected *connected;
1022 unsigned int cnt = 0;
1023
1024 for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, connected))
1025 if (connected->address->family == family)
1026 cnt++;
1027
1028 return cnt;
1029 }
1030
1031 struct connected *connected_lookup_prefix_exact(struct interface *ifp,
1032 const struct prefix *p)
1033 {
1034 struct listnode *node;
1035 struct listnode *next;
1036 struct connected *ifc;
1037
1038 for (node = listhead(ifp->connected); node; node = next) {
1039 ifc = listgetdata(node);
1040 next = node->next;
1041
1042 if (connected_same_prefix(ifc->address, p))
1043 return ifc;
1044 }
1045 return NULL;
1046 }
1047
1048 struct connected *connected_delete_by_prefix(struct interface *ifp,
1049 struct prefix *p)
1050 {
1051 struct listnode *node;
1052 struct listnode *next;
1053 struct connected *ifc;
1054
1055 /* In case of same prefix come, replace it with new one. */
1056 for (node = listhead(ifp->connected); node; node = next) {
1057 ifc = listgetdata(node);
1058 next = node->next;
1059
1060 if (connected_same_prefix(ifc->address, p)) {
1061 listnode_delete(ifp->connected, ifc);
1062 return ifc;
1063 }
1064 }
1065 return NULL;
1066 }
1067
1068 /* Find the address on our side that will be used when packets
1069 are sent to dst. */
1070 struct connected *connected_lookup_prefix(struct interface *ifp,
1071 const struct prefix *addr)
1072 {
1073 struct listnode *cnode;
1074 struct connected *c;
1075 struct connected *match;
1076
1077 match = NULL;
1078
1079 for (ALL_LIST_ELEMENTS_RO(ifp->connected, cnode, c)) {
1080 if (c->address && (c->address->family == addr->family)
1081 && prefix_match(CONNECTED_PREFIX(c), addr)
1082 && (!match
1083 || (c->address->prefixlen > match->address->prefixlen)))
1084 match = c;
1085 }
1086 return match;
1087 }
1088
1089 struct connected *connected_add_by_prefix(struct interface *ifp,
1090 struct prefix *p,
1091 struct prefix *destination)
1092 {
1093 struct connected *ifc;
1094
1095 /* Allocate new connected address. */
1096 ifc = connected_new();
1097 ifc->ifp = ifp;
1098
1099 /* Fetch interface address */
1100 ifc->address = prefix_new();
1101 memcpy(ifc->address, p, sizeof(struct prefix));
1102
1103 /* Fetch dest address */
1104 if (destination) {
1105 ifc->destination = prefix_new();
1106 memcpy(ifc->destination, destination, sizeof(struct prefix));
1107 }
1108
1109 /* Add connected address to the interface. */
1110 listnode_add(ifp->connected, ifc);
1111 return ifc;
1112 }
1113
1114 struct connected *connected_get_linklocal(struct interface *ifp)
1115 {
1116 struct listnode *n;
1117 struct connected *c = NULL;
1118
1119 for (ALL_LIST_ELEMENTS_RO(ifp->connected, n, c)) {
1120 if (c->address->family == AF_INET6
1121 && IN6_IS_ADDR_LINKLOCAL(&c->address->u.prefix6))
1122 break;
1123 }
1124 return c;
1125 }
1126
1127 #if 0 /* this route_table of struct connected's is unused \
1128 * however, it would be good to use a route_table rather than \
1129 * a list.. \
1130 */
1131 /* Interface looking up by interface's address. */
1132 /* Interface's IPv4 address reverse lookup table. */
1133 struct route_table *ifaddr_ipv4_table;
1134 /* struct route_table *ifaddr_ipv6_table; */
1135
1136 static void
1137 ifaddr_ipv4_add (struct in_addr *ifaddr, struct interface *ifp)
1138 {
1139 struct route_node *rn;
1140 struct prefix_ipv4 p;
1141
1142 p.family = AF_INET;
1143 p.prefixlen = IPV4_MAX_PREFIXLEN;
1144 p.prefix = *ifaddr;
1145
1146 rn = route_node_get (ifaddr_ipv4_table, (struct prefix *) &p);
1147 if (rn)
1148 {
1149 route_unlock_node (rn);
1150 zlog_info ("ifaddr_ipv4_add(): address %s is already added",
1151 inet_ntoa (*ifaddr));
1152 return;
1153 }
1154 rn->info = ifp;
1155 }
1156
1157 static void
1158 ifaddr_ipv4_delete (struct in_addr *ifaddr, struct interface *ifp)
1159 {
1160 struct route_node *rn;
1161 struct prefix_ipv4 p;
1162
1163 p.family = AF_INET;
1164 p.prefixlen = IPV4_MAX_PREFIXLEN;
1165 p.prefix = *ifaddr;
1166
1167 rn = route_node_lookup (ifaddr_ipv4_table, (struct prefix *) &p);
1168 if (! rn)
1169 {
1170 zlog_info ("ifaddr_ipv4_delete(): can't find address %s",
1171 inet_ntoa (*ifaddr));
1172 return;
1173 }
1174 rn->info = NULL;
1175 route_unlock_node (rn);
1176 route_unlock_node (rn);
1177 }
1178
1179 /* Lookup interface by interface's IP address or interface index. */
1180 static struct interface *
1181 ifaddr_ipv4_lookup (struct in_addr *addr, ifindex_t ifindex)
1182 {
1183 struct prefix_ipv4 p;
1184 struct route_node *rn;
1185 struct interface *ifp;
1186
1187 if (addr)
1188 {
1189 p.family = AF_INET;
1190 p.prefixlen = IPV4_MAX_PREFIXLEN;
1191 p.prefix = *addr;
1192
1193 rn = route_node_lookup (ifaddr_ipv4_table, (struct prefix *) &p);
1194 if (! rn)
1195 return NULL;
1196
1197 ifp = rn->info;
1198 route_unlock_node (rn);
1199 return ifp;
1200 }
1201 else
1202 return if_lookup_by_index(ifindex, VRF_DEFAULT);
1203 }
1204 #endif /* ifaddr_ipv4_table */
1205
1206 void if_terminate(struct vrf *vrf)
1207 {
1208 struct interface *ifp;
1209
1210 while (!RB_EMPTY(if_name_head, &vrf->ifaces_by_name)) {
1211 ifp = RB_ROOT(if_name_head, &vrf->ifaces_by_name);
1212
1213 if (ifp->node) {
1214 ifp->node->info = NULL;
1215 route_unlock_node(ifp->node);
1216 }
1217 if_delete(&ifp);
1218 }
1219 }
1220
1221 const char *if_link_type_str(enum zebra_link_type llt)
1222 {
1223 switch (llt) {
1224 #define llts(T,S) case (T): return (S)
1225 llts(ZEBRA_LLT_UNKNOWN, "Unknown");
1226 llts(ZEBRA_LLT_ETHER, "Ethernet");
1227 llts(ZEBRA_LLT_EETHER, "Experimental Ethernet");
1228 llts(ZEBRA_LLT_AX25, "AX.25 Level 2");
1229 llts(ZEBRA_LLT_PRONET, "PROnet token ring");
1230 llts(ZEBRA_LLT_IEEE802, "IEEE 802.2 Ethernet/TR/TB");
1231 llts(ZEBRA_LLT_ARCNET, "ARCnet");
1232 llts(ZEBRA_LLT_APPLETLK, "AppleTalk");
1233 llts(ZEBRA_LLT_DLCI, "Frame Relay DLCI");
1234 llts(ZEBRA_LLT_ATM, "ATM");
1235 llts(ZEBRA_LLT_METRICOM, "Metricom STRIP");
1236 llts(ZEBRA_LLT_IEEE1394, "IEEE 1394 IPv4");
1237 llts(ZEBRA_LLT_EUI64, "EUI-64");
1238 llts(ZEBRA_LLT_INFINIBAND, "InfiniBand");
1239 llts(ZEBRA_LLT_SLIP, "SLIP");
1240 llts(ZEBRA_LLT_CSLIP, "Compressed SLIP");
1241 llts(ZEBRA_LLT_SLIP6, "SLIPv6");
1242 llts(ZEBRA_LLT_CSLIP6, "Compressed SLIPv6");
1243 llts(ZEBRA_LLT_ROSE, "ROSE packet radio");
1244 llts(ZEBRA_LLT_X25, "CCITT X.25");
1245 llts(ZEBRA_LLT_PPP, "PPP");
1246 llts(ZEBRA_LLT_CHDLC, "Cisco HDLC");
1247 llts(ZEBRA_LLT_RAWHDLC, "Raw HDLC");
1248 llts(ZEBRA_LLT_LAPB, "LAPB");
1249 llts(ZEBRA_LLT_IPIP, "IPIP Tunnel");
1250 llts(ZEBRA_LLT_IPIP6, "IPIP6 Tunnel");
1251 llts(ZEBRA_LLT_FRAD, "FRAD");
1252 llts(ZEBRA_LLT_SKIP, "SKIP vif");
1253 llts(ZEBRA_LLT_LOOPBACK, "Loopback");
1254 llts(ZEBRA_LLT_LOCALTLK, "Localtalk");
1255 llts(ZEBRA_LLT_FDDI, "FDDI");
1256 llts(ZEBRA_LLT_SIT, "IPv6-in-IPv4 SIT");
1257 llts(ZEBRA_LLT_IPDDP, "IP-in-DDP tunnel");
1258 llts(ZEBRA_LLT_IPGRE, "GRE over IP");
1259 llts(ZEBRA_LLT_PIMREG, "PIMSM registration");
1260 llts(ZEBRA_LLT_HIPPI, "HiPPI");
1261 llts(ZEBRA_LLT_IRDA, "IrDA");
1262 llts(ZEBRA_LLT_FCPP, "Fibre-Channel PtP");
1263 llts(ZEBRA_LLT_FCAL, "Fibre-Channel Arbitrated Loop");
1264 llts(ZEBRA_LLT_FCPL, "Fibre-Channel Public Loop");
1265 llts(ZEBRA_LLT_FCFABRIC, "Fibre-Channel Fabric");
1266 llts(ZEBRA_LLT_IEEE802_TR, "IEEE 802.2 Token Ring");
1267 llts(ZEBRA_LLT_IEEE80211, "IEEE 802.11");
1268 llts(ZEBRA_LLT_IEEE80211_RADIOTAP, "IEEE 802.11 Radiotap");
1269 llts(ZEBRA_LLT_IEEE802154, "IEEE 802.15.4");
1270 llts(ZEBRA_LLT_IEEE802154_PHY, "IEEE 802.15.4 Phy");
1271 default:
1272 flog_err(EC_LIB_DEVELOPMENT, "Unknown value %d", llt);
1273 return "Unknown type!";
1274 #undef llts
1275 }
1276 return NULL;
1277 }
1278
1279 struct if_link_params *if_link_params_get(struct interface *ifp)
1280 {
1281 int i;
1282
1283 if (ifp->link_params != NULL)
1284 return ifp->link_params;
1285
1286 struct if_link_params *iflp =
1287 XCALLOC(MTYPE_IF_LINK_PARAMS, sizeof(struct if_link_params));
1288
1289 /* Set TE metric equal to standard metric */
1290 iflp->te_metric = ifp->metric;
1291
1292 /* Compute default bandwidth based on interface */
1293 iflp->default_bw =
1294 ((ifp->bandwidth ? ifp->bandwidth : DEFAULT_BANDWIDTH)
1295 * TE_MEGA_BIT / TE_BYTE);
1296
1297 /* Set Max, Reservable and Unreserved Bandwidth */
1298 iflp->max_bw = iflp->default_bw;
1299 iflp->max_rsv_bw = iflp->default_bw;
1300 for (i = 0; i < MAX_CLASS_TYPE; i++)
1301 iflp->unrsv_bw[i] = iflp->default_bw;
1302
1303 /* Update Link parameters status */
1304 iflp->lp_status =
1305 LP_TE_METRIC | LP_MAX_BW | LP_MAX_RSV_BW | LP_UNRSV_BW;
1306
1307 /* Finally attach newly created Link Parameters */
1308 ifp->link_params = iflp;
1309
1310 return iflp;
1311 }
1312
1313 void if_link_params_free(struct interface *ifp)
1314 {
1315 XFREE(MTYPE_IF_LINK_PARAMS, ifp->link_params);
1316 }
1317
1318 /* ----------- CLI commands ----------- */
1319
1320 /*
1321 * XPath: /frr-interface:lib/interface
1322 */
1323 DEFPY_YANG_NOSH (interface,
1324 interface_cmd,
1325 "interface IFNAME [vrf NAME$vrf_name]",
1326 "Select an interface to configure\n"
1327 "Interface's name\n"
1328 VRF_CMD_HELP_STR)
1329 {
1330 char xpath_list[XPATH_MAXLEN];
1331 vrf_id_t vrf_id;
1332 struct interface *ifp;
1333 int ret;
1334
1335 if (!vrf_name)
1336 vrf_name = VRF_DEFAULT_NAME;
1337
1338 /*
1339 * This command requires special handling to maintain backward
1340 * compatibility. If a VRF name is not specified, it means we're willing
1341 * to accept any interface with the given name on any VRF. If no
1342 * interface is found, then a new one should be created on the default
1343 * VRF.
1344 */
1345 VRF_GET_ID(vrf_id, vrf_name, false);
1346 ifp = if_lookup_by_name_all_vrf(ifname);
1347 if (ifp && ifp->vrf_id != vrf_id) {
1348 struct vrf *vrf;
1349
1350 /*
1351 * Special case 1: a VRF name was specified, but the found
1352 * interface is associated to different VRF. Reject the command.
1353 */
1354 if (vrf_id != VRF_DEFAULT) {
1355 vty_out(vty, "%% interface %s not in %s vrf\n", ifname,
1356 vrf_name);
1357 return CMD_WARNING_CONFIG_FAILED;
1358 }
1359
1360 /*
1361 * Special case 2: a VRF name was *not* specified, and the found
1362 * interface is associated to a VRF other than the default one.
1363 * Update vrf_id and vrf_name to account for that.
1364 */
1365 vrf = vrf_lookup_by_id(ifp->vrf_id);
1366 assert(vrf);
1367 vrf_id = ifp->vrf_id;
1368 vrf_name = vrf->name;
1369 }
1370
1371 snprintf(xpath_list, sizeof(xpath_list),
1372 "/frr-interface:lib/interface[name='%s'][vrf='%s']", ifname,
1373 vrf_name);
1374
1375 nb_cli_enqueue_change(vty, ".", NB_OP_CREATE, NULL);
1376 ret = nb_cli_apply_changes(vty, xpath_list);
1377 if (ret == CMD_SUCCESS) {
1378 VTY_PUSH_XPATH(INTERFACE_NODE, xpath_list);
1379
1380 /*
1381 * For backward compatibility with old commands we still need
1382 * to use the qobj infrastructure. This can be removed once
1383 * all interface-level commands are converted to the new
1384 * northbound model.
1385 */
1386 nb_cli_pending_commit_check(vty);
1387 ifp = if_lookup_by_name(ifname, vrf_id);
1388 if (ifp)
1389 VTY_PUSH_CONTEXT(INTERFACE_NODE, ifp);
1390 }
1391
1392 return ret;
1393 }
1394
1395 DEFPY_YANG (no_interface,
1396 no_interface_cmd,
1397 "no interface IFNAME [vrf NAME$vrf_name]",
1398 NO_STR
1399 "Delete a pseudo interface's configuration\n"
1400 "Interface's name\n"
1401 VRF_CMD_HELP_STR)
1402 {
1403 if (!vrf_name)
1404 vrf_name = VRF_DEFAULT_NAME;
1405
1406 nb_cli_enqueue_change(vty, ".", NB_OP_DESTROY, NULL);
1407
1408 return nb_cli_apply_changes(
1409 vty, "/frr-interface:lib/interface[name='%s'][vrf='%s']",
1410 ifname, vrf_name);
1411 }
1412
1413 static void cli_show_interface(struct vty *vty, struct lyd_node *dnode,
1414 bool show_defaults)
1415 {
1416 const char *vrf;
1417
1418 vrf = yang_dnode_get_string(dnode, "./vrf");
1419
1420 vty_out(vty, "!\n");
1421 vty_out(vty, "interface %s", yang_dnode_get_string(dnode, "./name"));
1422 if (!strmatch(vrf, VRF_DEFAULT_NAME))
1423 vty_out(vty, " vrf %s", vrf);
1424 vty_out(vty, "\n");
1425 }
1426
1427 /*
1428 * XPath: /frr-interface:lib/interface/description
1429 */
1430 DEFPY_YANG (interface_desc,
1431 interface_desc_cmd,
1432 "description LINE...",
1433 "Interface specific description\n"
1434 "Characters describing this interface\n")
1435 {
1436 char *desc;
1437 int ret;
1438
1439 desc = argv_concat(argv, argc, 1);
1440 nb_cli_enqueue_change(vty, "./description", NB_OP_MODIFY, desc);
1441 ret = nb_cli_apply_changes(vty, NULL);
1442 XFREE(MTYPE_TMP, desc);
1443
1444 return ret;
1445 }
1446
1447 DEFPY_YANG (no_interface_desc,
1448 no_interface_desc_cmd,
1449 "no description",
1450 NO_STR
1451 "Interface specific description\n")
1452 {
1453 nb_cli_enqueue_change(vty, "./description", NB_OP_DESTROY, NULL);
1454
1455 return nb_cli_apply_changes(vty, NULL);
1456 }
1457
1458 static void cli_show_interface_desc(struct vty *vty, struct lyd_node *dnode,
1459 bool show_defaults)
1460 {
1461 vty_out(vty, " description %s\n", yang_dnode_get_string(dnode, NULL));
1462 }
1463
1464 /* Interface autocomplete. */
1465 static void if_autocomplete(vector comps, struct cmd_token *token)
1466 {
1467 struct interface *ifp;
1468 struct vrf *vrf;
1469
1470 RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name) {
1471 FOR_ALL_INTERFACES (vrf, ifp) {
1472 vector_set(comps, XSTRDUP(MTYPE_COMPLETION, ifp->name));
1473 }
1474 }
1475 }
1476
1477 static const struct cmd_variable_handler if_var_handlers[] = {
1478 {/* "interface NAME" */
1479 .varname = "interface",
1480 .completions = if_autocomplete},
1481 {.tokenname = "IFNAME", .completions = if_autocomplete},
1482 {.tokenname = "INTERFACE", .completions = if_autocomplete},
1483 {.completions = NULL}};
1484
1485 void if_cmd_init(void)
1486 {
1487 cmd_variable_handler_register(if_var_handlers);
1488
1489 install_element(CONFIG_NODE, &interface_cmd);
1490 install_element(CONFIG_NODE, &no_interface_cmd);
1491
1492 install_default(INTERFACE_NODE);
1493 install_element(INTERFACE_NODE, &interface_desc_cmd);
1494 install_element(INTERFACE_NODE, &no_interface_desc_cmd);
1495 }
1496
1497 void if_zapi_callbacks(int (*create)(struct interface *ifp),
1498 int (*up)(struct interface *ifp),
1499 int (*down)(struct interface *ifp),
1500 int (*destroy)(struct interface *ifp))
1501 {
1502 ifp_master.create_hook = create;
1503 ifp_master.up_hook = up;
1504 ifp_master.down_hook = down;
1505 ifp_master.destroy_hook = destroy;
1506 }
1507
1508 /* ------- Northbound callbacks ------- */
1509
1510 /*
1511 * XPath: /frr-interface:lib/interface
1512 */
1513 static int lib_interface_create(struct nb_cb_create_args *args)
1514 {
1515 const char *ifname;
1516 const char *vrfname;
1517 struct vrf *vrf;
1518 struct interface *ifp;
1519
1520 ifname = yang_dnode_get_string(args->dnode, "./name");
1521 vrfname = yang_dnode_get_string(args->dnode, "./vrf");
1522
1523 switch (args->event) {
1524 case NB_EV_VALIDATE:
1525 vrf = vrf_lookup_by_name(vrfname);
1526 if (!vrf) {
1527 zlog_warn("%s: VRF %s doesn't exist", __func__,
1528 vrfname);
1529 return NB_ERR_VALIDATION;
1530 }
1531 if (vrf->vrf_id == VRF_UNKNOWN) {
1532 zlog_warn("%s: VRF %s is not active", __func__,
1533 vrf->name);
1534 return NB_ERR_VALIDATION;
1535 }
1536
1537 /* if VRF is netns or not yet known - init for instance
1538 * then assumption is that passed config is exact
1539 * then the user intent was not to use an other iface
1540 */
1541 if (vrf_get_backend() == VRF_BACKEND_VRF_LITE) {
1542 ifp = if_lookup_by_name_all_vrf(ifname);
1543 if (ifp && ifp->vrf_id != vrf->vrf_id) {
1544 zlog_warn(
1545 "%s: interface %s already exists in another VRF",
1546 __func__, ifp->name);
1547 return NB_ERR_VALIDATION;
1548 }
1549 }
1550 break;
1551 case NB_EV_PREPARE:
1552 case NB_EV_ABORT:
1553 break;
1554 case NB_EV_APPLY:
1555 vrf = vrf_lookup_by_name(vrfname);
1556 assert(vrf);
1557 #ifdef SUNOS_5
1558 ifp = if_sunwzebra_get(ifname, vrf->vrf_id);
1559 #else
1560 ifp = if_get_by_name(ifname, vrf->vrf_id);
1561 #endif /* SUNOS_5 */
1562
1563 ifp->configured = true;
1564 nb_running_set_entry(args->dnode, ifp);
1565 break;
1566 }
1567
1568 return NB_OK;
1569 }
1570
1571 static int lib_interface_destroy(struct nb_cb_destroy_args *args)
1572 {
1573 struct interface *ifp;
1574
1575
1576 switch (args->event) {
1577 case NB_EV_VALIDATE:
1578 ifp = nb_running_get_entry(args->dnode, NULL, true);
1579 if (CHECK_FLAG(ifp->status, ZEBRA_INTERFACE_ACTIVE)) {
1580 snprintf(args->errmsg, args->errmsg_len,
1581 "only inactive interfaces can be deleted");
1582 return NB_ERR_VALIDATION;
1583 }
1584 break;
1585 case NB_EV_PREPARE:
1586 case NB_EV_ABORT:
1587 break;
1588 case NB_EV_APPLY:
1589 ifp = nb_running_unset_entry(args->dnode);
1590
1591 ifp->configured = false;
1592 if_delete(&ifp);
1593 break;
1594 }
1595
1596 return NB_OK;
1597 }
1598
1599 /*
1600 * XPath: /frr-interface:lib/interface
1601 */
1602 static const void *lib_interface_get_next(struct nb_cb_get_next_args *args)
1603 {
1604 struct vrf *vrf;
1605 struct interface *pif = (struct interface *)args->list_entry;
1606
1607 if (args->list_entry == NULL) {
1608 vrf = RB_MIN(vrf_name_head, &vrfs_by_name);
1609 assert(vrf);
1610 pif = RB_MIN(if_name_head, &vrf->ifaces_by_name);
1611 } else {
1612 vrf = vrf_lookup_by_id(pif->vrf_id);
1613 pif = RB_NEXT(if_name_head, pif);
1614 /* if no more interfaces, switch to next vrf */
1615 while (pif == NULL) {
1616 vrf = RB_NEXT(vrf_name_head, vrf);
1617 if (!vrf)
1618 return NULL;
1619 pif = RB_MIN(if_name_head, &vrf->ifaces_by_name);
1620 }
1621 }
1622
1623 return pif;
1624 }
1625
1626 static int lib_interface_get_keys(struct nb_cb_get_keys_args *args)
1627 {
1628 const struct interface *ifp = args->list_entry;
1629
1630 struct vrf *vrf = vrf_lookup_by_id(ifp->vrf_id);
1631
1632 assert(vrf);
1633
1634 args->keys->num = 2;
1635 strlcpy(args->keys->key[0], ifp->name, sizeof(args->keys->key[0]));
1636 strlcpy(args->keys->key[1], vrf->name, sizeof(args->keys->key[1]));
1637
1638 return NB_OK;
1639 }
1640
1641 static const void *
1642 lib_interface_lookup_entry(struct nb_cb_lookup_entry_args *args)
1643 {
1644 const char *ifname = args->keys->key[0];
1645 const char *vrfname = args->keys->key[1];
1646 struct vrf *vrf = vrf_lookup_by_name(vrfname);
1647
1648 return vrf ? if_lookup_by_name(ifname, vrf->vrf_id) : NULL;
1649 }
1650
1651 /*
1652 * XPath: /frr-interface:lib/interface/description
1653 */
1654 static int lib_interface_description_modify(struct nb_cb_modify_args *args)
1655 {
1656 struct interface *ifp;
1657 const char *description;
1658
1659 if (args->event != NB_EV_APPLY)
1660 return NB_OK;
1661
1662 ifp = nb_running_get_entry(args->dnode, NULL, true);
1663 XFREE(MTYPE_TMP, ifp->desc);
1664 description = yang_dnode_get_string(args->dnode, NULL);
1665 ifp->desc = XSTRDUP(MTYPE_TMP, description);
1666
1667 return NB_OK;
1668 }
1669
1670 static int lib_interface_description_destroy(struct nb_cb_destroy_args *args)
1671 {
1672 struct interface *ifp;
1673
1674 if (args->event != NB_EV_APPLY)
1675 return NB_OK;
1676
1677 ifp = nb_running_get_entry(args->dnode, NULL, true);
1678 XFREE(MTYPE_TMP, ifp->desc);
1679
1680 return NB_OK;
1681 }
1682
1683 /*
1684 * XPath: /frr-interface:lib/interface/state/if-index
1685 */
1686 static struct yang_data *
1687 lib_interface_state_if_index_get_elem(struct nb_cb_get_elem_args *args)
1688 {
1689 const struct interface *ifp = args->list_entry;
1690
1691 return yang_data_new_int32(args->xpath, ifp->ifindex);
1692 }
1693
1694 /*
1695 * XPath: /frr-interface:lib/interface/state/mtu
1696 */
1697 static struct yang_data *
1698 lib_interface_state_mtu_get_elem(struct nb_cb_get_elem_args *args)
1699 {
1700 const struct interface *ifp = args->list_entry;
1701
1702 return yang_data_new_uint16(args->xpath, ifp->mtu);
1703 }
1704
1705 /*
1706 * XPath: /frr-interface:lib/interface/state/mtu6
1707 */
1708 static struct yang_data *
1709 lib_interface_state_mtu6_get_elem(struct nb_cb_get_elem_args *args)
1710 {
1711 const struct interface *ifp = args->list_entry;
1712
1713 return yang_data_new_uint32(args->xpath, ifp->mtu6);
1714 }
1715
1716 /*
1717 * XPath: /frr-interface:lib/interface/state/speed
1718 */
1719 static struct yang_data *
1720 lib_interface_state_speed_get_elem(struct nb_cb_get_elem_args *args)
1721 {
1722 const struct interface *ifp = args->list_entry;
1723
1724 return yang_data_new_uint32(args->xpath, ifp->speed);
1725 }
1726
1727 /*
1728 * XPath: /frr-interface:lib/interface/state/metric
1729 */
1730 static struct yang_data *
1731 lib_interface_state_metric_get_elem(struct nb_cb_get_elem_args *args)
1732 {
1733 const struct interface *ifp = args->list_entry;
1734
1735 return yang_data_new_uint32(args->xpath, ifp->metric);
1736 }
1737
1738 /*
1739 * XPath: /frr-interface:lib/interface/state/flags
1740 */
1741 static struct yang_data *
1742 lib_interface_state_flags_get_elem(struct nb_cb_get_elem_args *args)
1743 {
1744 /* TODO: implement me. */
1745 return NULL;
1746 }
1747
1748 /*
1749 * XPath: /frr-interface:lib/interface/state/type
1750 */
1751 static struct yang_data *
1752 lib_interface_state_type_get_elem(struct nb_cb_get_elem_args *args)
1753 {
1754 /* TODO: implement me. */
1755 return NULL;
1756 }
1757
1758 /*
1759 * XPath: /frr-interface:lib/interface/state/phy-address
1760 */
1761 static struct yang_data *
1762 lib_interface_state_phy_address_get_elem(struct nb_cb_get_elem_args *args)
1763 {
1764 const struct interface *ifp = args->list_entry;
1765 struct ethaddr macaddr;
1766
1767 memcpy(&macaddr.octet, ifp->hw_addr, ETH_ALEN);
1768
1769 return yang_data_new_mac(args->xpath, &macaddr);
1770 }
1771
1772 /* clang-format off */
1773 const struct frr_yang_module_info frr_interface_info = {
1774 .name = "frr-interface",
1775 .nodes = {
1776 {
1777 .xpath = "/frr-interface:lib/interface",
1778 .cbs = {
1779 .create = lib_interface_create,
1780 .destroy = lib_interface_destroy,
1781 .cli_show = cli_show_interface,
1782 .get_next = lib_interface_get_next,
1783 .get_keys = lib_interface_get_keys,
1784 .lookup_entry = lib_interface_lookup_entry,
1785 },
1786 },
1787 {
1788 .xpath = "/frr-interface:lib/interface/description",
1789 .cbs = {
1790 .modify = lib_interface_description_modify,
1791 .destroy = lib_interface_description_destroy,
1792 .cli_show = cli_show_interface_desc,
1793 },
1794 },
1795 {
1796 .xpath = "/frr-interface:lib/interface/state/if-index",
1797 .cbs = {
1798 .get_elem = lib_interface_state_if_index_get_elem,
1799 }
1800 },
1801 {
1802 .xpath = "/frr-interface:lib/interface/state/mtu",
1803 .cbs = {
1804 .get_elem = lib_interface_state_mtu_get_elem,
1805 }
1806 },
1807 {
1808 .xpath = "/frr-interface:lib/interface/state/mtu6",
1809 .cbs = {
1810 .get_elem = lib_interface_state_mtu6_get_elem,
1811 }
1812 },
1813 {
1814 .xpath = "/frr-interface:lib/interface/state/speed",
1815 .cbs = {
1816 .get_elem = lib_interface_state_speed_get_elem,
1817 }
1818 },
1819 {
1820 .xpath = "/frr-interface:lib/interface/state/metric",
1821 .cbs = {
1822 .get_elem = lib_interface_state_metric_get_elem,
1823 }
1824 },
1825 {
1826 .xpath = "/frr-interface:lib/interface/state/flags",
1827 .cbs = {
1828 .get_elem = lib_interface_state_flags_get_elem,
1829 }
1830 },
1831 {
1832 .xpath = "/frr-interface:lib/interface/state/type",
1833 .cbs = {
1834 .get_elem = lib_interface_state_type_get_elem,
1835 }
1836 },
1837 {
1838 .xpath = "/frr-interface:lib/interface/state/phy-address",
1839 .cbs = {
1840 .get_elem = lib_interface_state_phy_address_get_elem,
1841 }
1842 },
1843 {
1844 .xpath = NULL,
1845 },
1846 }
1847 };
FRRouting mirror