lib/if.h

   1 /* Interface related header.
   2  * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published
   8  * by the Free Software Foundation; either version 2, or (at your
   9  * option) any later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for 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 _ZEBRA_IF_H
  22 #define _ZEBRA_IF_H
  23
  24 #include "zebra.h"
  25 #include "linklist.h"
  26 #include "memory.h"
  27 #include "qobj.h"
  28 #include "hook.h"
  29
  30 DECLARE_MTYPE(IF)
  31 DECLARE_MTYPE(CONNECTED_LABEL)
  32
  33 /* Interface link-layer type, if known. Derived from:
  34  *
  35  * net/if_arp.h on various platforms - Linux especially.
  36  * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
  37  *
  38  * Some of the more obviously defunct technologies left out.
  39  */
  40 enum zebra_link_type {
  41         ZEBRA_LLT_UNKNOWN = 0,
  42         ZEBRA_LLT_ETHER,
  43         ZEBRA_LLT_EETHER,
  44         ZEBRA_LLT_AX25,
  45         ZEBRA_LLT_PRONET,
  46         ZEBRA_LLT_IEEE802,
  47         ZEBRA_LLT_ARCNET,
  48         ZEBRA_LLT_APPLETLK,
  49         ZEBRA_LLT_DLCI,
  50         ZEBRA_LLT_ATM,
  51         ZEBRA_LLT_METRICOM,
  52         ZEBRA_LLT_IEEE1394,
  53         ZEBRA_LLT_EUI64,
  54         ZEBRA_LLT_INFINIBAND,
  55         ZEBRA_LLT_SLIP,
  56         ZEBRA_LLT_CSLIP,
  57         ZEBRA_LLT_SLIP6,
  58         ZEBRA_LLT_CSLIP6,
  59         ZEBRA_LLT_RSRVD,
  60         ZEBRA_LLT_ADAPT,
  61         ZEBRA_LLT_ROSE,
  62         ZEBRA_LLT_X25,
  63         ZEBRA_LLT_PPP,
  64         ZEBRA_LLT_CHDLC,
  65         ZEBRA_LLT_LAPB,
  66         ZEBRA_LLT_RAWHDLC,
  67         ZEBRA_LLT_IPIP,
  68         ZEBRA_LLT_IPIP6,
  69         ZEBRA_LLT_FRAD,
  70         ZEBRA_LLT_SKIP,
  71         ZEBRA_LLT_LOOPBACK,
  72         ZEBRA_LLT_LOCALTLK,
  73         ZEBRA_LLT_FDDI,
  74         ZEBRA_LLT_SIT,
  75         ZEBRA_LLT_IPDDP,
  76         ZEBRA_LLT_IPGRE,
  77         ZEBRA_LLT_IP6GRE,
  78         ZEBRA_LLT_PIMREG,
  79         ZEBRA_LLT_HIPPI,
  80         ZEBRA_LLT_ECONET,
  81         ZEBRA_LLT_IRDA,
  82         ZEBRA_LLT_FCPP,
  83         ZEBRA_LLT_FCAL,
  84         ZEBRA_LLT_FCPL,
  85         ZEBRA_LLT_FCFABRIC,
  86         ZEBRA_LLT_IEEE802_TR,
  87         ZEBRA_LLT_IEEE80211,
  88         ZEBRA_LLT_IEEE80211_RADIOTAP,
  89         ZEBRA_LLT_IEEE802154,
  90         ZEBRA_LLT_IEEE802154_PHY,
  91 };
  92
  93 /*
  94   Interface name length.
  95
  96    Linux define value in /usr/include/linux/if.h.
  97    #define IFNAMSIZ        16
  98
  99    FreeBSD define value in /usr/include/net/if.h.
 100    #define IFNAMSIZ        16
 101 */
 102
 103 #define INTERFACE_NAMSIZ      20
 104 #define INTERFACE_HWADDR_MAX  20
 105
 106 typedef signed int ifindex_t;
 107
 108 #ifdef HAVE_PROC_NET_DEV
 109 struct if_stats {
 110         unsigned long rx_packets;   /* total packets received       */
 111         unsigned long tx_packets;   /* total packets transmitted    */
 112         unsigned long rx_bytes;     /* total bytes received         */
 113         unsigned long tx_bytes;     /* total bytes transmitted      */
 114         unsigned long rx_errors;    /* bad packets received         */
 115         unsigned long tx_errors;    /* packet transmit problems     */
 116         unsigned long rx_dropped;   /* no space in linux buffers    */
 117         unsigned long tx_dropped;   /* no space available in linux  */
 118         unsigned long rx_multicast; /* multicast packets received   */
 119         unsigned long rx_compressed;
 120         unsigned long tx_compressed;
 121         unsigned long collisions;
 122
 123         /* detailed rx_errors: */
 124         unsigned long rx_length_errors;
 125         unsigned long rx_over_errors;   /* receiver ring buff overflow  */
 126         unsigned long rx_crc_errors;    /* recved pkt with crc error    */
 127         unsigned long rx_frame_errors;  /* recv'd frame alignment error */
 128         unsigned long rx_fifo_errors;   /* recv'r fifo overrun          */
 129         unsigned long rx_missed_errors; /* receiver missed packet     */
 130         /* detailed tx_errors */
 131         unsigned long tx_aborted_errors;
 132         unsigned long tx_carrier_errors;
 133         unsigned long tx_fifo_errors;
 134         unsigned long tx_heartbeat_errors;
 135         unsigned long tx_window_errors;
 136 };
 137 #endif /* HAVE_PROC_NET_DEV */
 138
 139 /* Here are "non-official" architectural constants. */
 140 #define TE_EXT_MASK             0x0FFFFFFF
 141 #define TE_EXT_ANORMAL          0x80000000
 142 #define LOSS_PRECISION          0.000003
 143 #define TE_KILO_BIT             1000
 144 #define TE_BYTE                 8
 145 #define DEFAULT_BANDWIDTH       10000
 146 #define MAX_CLASS_TYPE          8
 147 #define MAX_PKT_LOSS            50.331642
 148
 149 /*
 150  * Link Parameters Status:
 151  *  equal to 0: unset
 152  *  different from 0: set
 153  */
 154 #define LP_UNSET                0x0000
 155 #define LP_TE_METRIC            0x0001
 156 #define LP_MAX_BW               0x0002
 157 #define LP_MAX_RSV_BW           0x0004
 158 #define LP_UNRSV_BW             0x0008
 159 #define LP_ADM_GRP              0x0010
 160 #define LP_RMT_AS               0x0020
 161 #define LP_DELAY                0x0040
 162 #define LP_MM_DELAY             0x0080
 163 #define LP_DELAY_VAR            0x0100
 164 #define LP_PKT_LOSS             0x0200
 165 #define LP_RES_BW               0x0400
 166 #define LP_AVA_BW               0x0800
 167 #define LP_USE_BW               0x1000
 168
 169 #define IS_PARAM_UNSET(lp, st) !(lp->lp_status & st)
 170 #define IS_PARAM_SET(lp, st) (lp->lp_status & st)
 171 #define IS_LINK_PARAMS_SET(lp) (lp->lp_status != LP_UNSET)
 172
 173 #define SET_PARAM(lp, st) (lp->lp_status) |= (st)
 174 #define UNSET_PARAM(lp, st) (lp->lp_status) &= ~(st)
 175 #define RESET_LINK_PARAM(lp) (lp->lp_status = LP_UNSET)
 176
 177 /* Link Parameters for Traffic Engineering */
 178 struct if_link_params {
 179         uint32_t lp_status; /* Status of Link Parameters: */
 180         uint32_t te_metric; /* Traffic Engineering metric */
 181         float default_bw;
 182         float max_bw;                   /* Maximum Bandwidth */
 183         float max_rsv_bw;               /* Maximum Reservable Bandwidth */
 184         float unrsv_bw[MAX_CLASS_TYPE]; /* Unreserved Bandwidth per Class Type
 185                                            (8) */
 186         uint32_t admin_grp;             /* Administrative group */
 187         uint32_t rmt_as;                /* Remote AS number */
 188         struct in_addr rmt_ip;          /* Remote IP address */
 189         uint32_t av_delay;              /* Link Average Delay */
 190         uint32_t min_delay;             /* Link Min Delay */
 191         uint32_t max_delay;             /* Link Max Delay */
 192         uint32_t delay_var;             /* Link Delay Variation */
 193         float pkt_loss;                 /* Link Packet Loss */
 194         float res_bw;                   /* Residual Bandwidth */
 195         float ava_bw;                   /* Available Bandwidth */
 196         float use_bw;                   /* Utilized Bandwidth */
 197 };
 198
 199 #define INTERFACE_LINK_PARAMS_SIZE   sizeof(struct if_link_params)
 200 #define HAS_LINK_PARAMS(ifp)  ((ifp)->link_params != NULL)
 201
 202 /* Interface structure */
 203 struct interface {
 204         RB_ENTRY(interface) name_entry, index_entry;
 205
 206         /* Interface name.  This should probably never be changed after the
 207            interface is created, because the configuration info for this
 208            interface
 209            is associated with this structure.  For that reason, the interface
 210            should also never be deleted (to avoid losing configuration info).
 211            To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
 212            interface does not exist in the kernel.
 213          */
 214         char name[INTERFACE_NAMSIZ];
 215
 216         /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
 217            deleted interfaces).
 218            WARNING: the ifindex needs to be changed using the if_set_index()
 219            function. Failure to respect this will cause corruption in the data
 220            structure used to store the interfaces and if_lookup_by_index() will
 221            not work as expected.
 222          */
 223         ifindex_t ifindex;
 224 #define IFINDEX_INTERNAL        0
 225
 226         /* Zebra internal interface status */
 227         uint8_t status;
 228 #define ZEBRA_INTERFACE_ACTIVE     (1 << 0)
 229 #define ZEBRA_INTERFACE_SUB        (1 << 1)
 230 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
 231 #define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
 232
 233         /* Interface flags. */
 234         uint64_t flags;
 235
 236         /* Interface metric */
 237         uint32_t metric;
 238
 239         /* Interface Speed in Mb/s */
 240         uint32_t speed;
 241
 242         /* Interface MTU. */
 243         unsigned int mtu; /* IPv4 MTU */
 244         unsigned int
 245                 mtu6; /* IPv6 MTU - probably, but not neccessarily same as mtu
 246                          */
 247
 248         /* Link-layer information and hardware address */
 249         enum zebra_link_type ll_type;
 250         uint8_t hw_addr[INTERFACE_HWADDR_MAX];
 251         int hw_addr_len;
 252
 253         /* interface bandwidth, kbits */
 254         unsigned int bandwidth;
 255
 256         /* Link parameters for Traffic Engineering */
 257         struct if_link_params *link_params;
 258
 259         /* description of the interface. */
 260         char *desc;
 261
 262         /* Distribute list. */
 263         void *distribute_in;
 264         void *distribute_out;
 265
 266         /* Connected address list. */
 267         struct list *connected;
 268
 269         /* Neighbor connected address list. */
 270         struct list *nbr_connected;
 271
 272         /* Daemon specific interface data pointer. */
 273         void *info;
 274
 275         char ptm_enable; /* Should we look at ptm_status ? */
 276         char ptm_status;
 277
 278 /* Statistics fileds. */
 279 #ifdef HAVE_PROC_NET_DEV
 280         struct if_stats stats;
 281 #endif /* HAVE_PROC_NET_DEV */
 282 #ifdef HAVE_NET_RT_IFLIST
 283         struct if_data stats;
 284 #endif /* HAVE_NET_RT_IFLIST */
 285
 286         struct route_node *node;
 287         vrf_id_t vrf_id;
 288
 289         QOBJ_FIELDS
 290 };
 291
 292 RB_HEAD(if_name_head, interface);
 293 RB_PROTOTYPE(if_name_head, interface, name_entry, if_cmp_func);
 294 RB_HEAD(if_index_head, interface);
 295 RB_PROTOTYPE(if_index_head, interface, index_entry, if_cmp_func);
 296 DECLARE_QOBJ_TYPE(interface)
 297
 298 #define IFNAME_RB_INSERT(vrf, ifp)                                             \
 299         if (RB_INSERT(if_name_head, &vrf->ifaces_by_name, (ifp)))              \
 300                 flog_err(                                                     \
 301                         LIB_ERR_INTERFACE,                                     \
 302                         "%s(%s): corruption detected -- interface with this "  \
 303                         "name exists already in VRF %u!",                      \
 304                         __func__, (ifp)->name, (ifp)->vrf_id);
 305
 306 #define IFNAME_RB_REMOVE(vrf, ifp)                                             \
 307         if (RB_REMOVE(if_name_head, &vrf->ifaces_by_name, (ifp)) == NULL)      \
 308                 flog_err(                                                     \
 309                         LIB_ERR_INTERFACE,                                     \
 310                         "%s(%s): corruption detected -- interface with this "  \
 311                         "name doesn't exist in VRF %u!",                       \
 312                         __func__, (ifp)->name, (ifp)->vrf_id);
 313
 314 #define IFINDEX_RB_INSERT(vrf, ifp)                                            \
 315         if (RB_INSERT(if_index_head, &vrf->ifaces_by_index, (ifp)))            \
 316                 flog_err(                                                     \
 317                         LIB_ERR_INTERFACE,                                     \
 318                         "%s(%u): corruption detected -- interface with this "  \
 319                         "ifindex exists already in VRF %u!",                   \
 320                         __func__, (ifp)->ifindex, (ifp)->vrf_id);
 321
 322 #define IFINDEX_RB_REMOVE(vrf, ifp)                                            \
 323         if (RB_REMOVE(if_index_head, &vrf->ifaces_by_index, (ifp)) == NULL)    \
 324                 flog_err(                                                     \
 325                         LIB_ERR_INTERFACE,                                     \
 326                         "%s(%u): corruption detected -- interface with this "  \
 327                         "ifindex doesn't exist in VRF %u!",                    \
 328                         __func__, (ifp)->ifindex, (ifp)->vrf_id);
 329
 330 #define FOR_ALL_INTERFACES(vrf, ifp)                                           \
 331         if (vrf)                                                               \
 332                 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name)
 333
 334 #define FOR_ALL_INTERFACES_ADDRESSES(ifp, connected, node)                     \
 335         for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected))
 336
 337 /* called from the library code whenever interfaces are created/deleted
 338  * note: interfaces may not be fully realized at that point; also they
 339  * may not exist in the system (ifindex = IFINDEX_INTERNAL)
 340  *
 341  * priority values are important here, daemons should be at 0 while modules
 342  * can use 1000+ so they run after the daemon has initialised daemon-specific
 343  * interface data
 344  */
 345 DECLARE_HOOK(if_add, (struct interface * ifp), (ifp))
 346 DECLARE_KOOH(if_del, (struct interface * ifp), (ifp))
 347
 348 /* Connected address structure. */
 349 struct connected {
 350         /* Attached interface. */
 351         struct interface *ifp;
 352
 353         /* Flags for configuration. */
 354         uint8_t conf;
 355 #define ZEBRA_IFC_REAL         (1 << 0)
 356 #define ZEBRA_IFC_CONFIGURED   (1 << 1)
 357 #define ZEBRA_IFC_QUEUED       (1 << 2)
 358         /*
 359            The ZEBRA_IFC_REAL flag should be set if and only if this address
 360            exists in the kernel and is actually usable. (A case where it exists
 361            but
 362            is not yet usable would be IPv6 with DAD)
 363            The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
 364            address
 365            was configured by the user from inside quagga.
 366            The ZEBRA_IFC_QUEUED flag should be set if and only if the address
 367            exists
 368            in the kernel. It may and should be set although the address might
 369            not be
 370            usable yet. (compare with ZEBRA_IFC_REAL)
 371          */
 372
 373         /* Flags for connected address. */
 374         uint8_t flags;
 375 #define ZEBRA_IFA_SECONDARY    (1 << 0)
 376 #define ZEBRA_IFA_PEER         (1 << 1)
 377 #define ZEBRA_IFA_UNNUMBERED   (1 << 2)
 378         /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
 379            a peer address has been configured.  If this flag is set,
 380            the destination field must contain the peer address.
 381            Otherwise, if this flag is not set, the destination address
 382            will either contain a broadcast address or be NULL.
 383          */
 384
 385         /* Address of connected network. */
 386         struct prefix *address;
 387
 388         /* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is
 389            set.
 390            Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
 391         struct prefix *destination;
 392
 393         /* Label for Linux 2.2.X and upper. */
 394         char *label;
 395 };
 396
 397 /* Nbr Connected address structure. */
 398 struct nbr_connected {
 399         /* Attached interface. */
 400         struct interface *ifp;
 401
 402         /* Address of connected network. */
 403         struct prefix *address;
 404 };
 405
 406 /* Does the destination field contain a peer address? */
 407 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
 408
 409 /* Prefix to insert into the RIB */
 410 #define CONNECTED_PREFIX(C)                                                    \
 411         (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
 412
 413 /* Identifying address.  We guess that if there's a peer address, but the
 414    local address is in the same prefix, then the local address may be unique. */
 415 #define CONNECTED_ID(C)                                                        \
 416         ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address))  \
 417                  ? (C)->destination                                            \
 418                  : (C)->address)
 419
 420 /* There are some interface flags which are only supported by some
 421    operating system. */
 422
 423 #ifndef IFF_NOTRAILERS
 424 #define IFF_NOTRAILERS 0x0
 425 #endif /* IFF_NOTRAILERS */
 426 #ifndef IFF_OACTIVE
 427 #define IFF_OACTIVE 0x0
 428 #endif /* IFF_OACTIVE */
 429 #ifndef IFF_SIMPLEX
 430 #define IFF_SIMPLEX 0x0
 431 #endif /* IFF_SIMPLEX */
 432 #ifndef IFF_LINK0
 433 #define IFF_LINK0 0x0
 434 #endif /* IFF_LINK0 */
 435 #ifndef IFF_LINK1
 436 #define IFF_LINK1 0x0
 437 #endif /* IFF_LINK1 */
 438 #ifndef IFF_LINK2
 439 #define IFF_LINK2 0x0
 440 #endif /* IFF_LINK2 */
 441 #ifndef IFF_NOXMIT
 442 #define IFF_NOXMIT 0x0
 443 #endif /* IFF_NOXMIT */
 444 #ifndef IFF_NORTEXCH
 445 #define IFF_NORTEXCH 0x0
 446 #endif /* IFF_NORTEXCH */
 447 #ifndef IFF_IPV4
 448 #define IFF_IPV4 0x0
 449 #endif /* IFF_IPV4 */
 450 #ifndef IFF_IPV6
 451 #define IFF_IPV6 0x0
 452 #endif /* IFF_IPV6 */
 453 #ifndef IFF_VIRTUAL
 454 #define IFF_VIRTUAL 0x0
 455 #endif /* IFF_VIRTUAL */
 456
 457 /* Prototypes. */
 458 extern int if_cmp_name_func(char *, char *);
 459
 460 /*
 461  * Passing in VRF_UNKNOWN is a valid thing to do, unless we
 462  * are creating a new interface.
 463  *
 464  * This is useful for vrf route-leaking.  So more than anything
 465  * else think before you use VRF_UNKNOWN
 466  */
 467 extern void if_update_to_new_vrf(struct interface *, vrf_id_t vrf_id);
 468 extern struct interface *if_create(const char *name, vrf_id_t vrf_id);
 469 extern struct interface *if_lookup_by_index(ifindex_t, vrf_id_t vrf_id);
 470 extern struct interface *if_lookup_exact_address(void *matchaddr, int family,
 471                                                  vrf_id_t vrf_id);
 472 extern struct connected *if_lookup_address(void *matchaddr, int family,
 473                                            vrf_id_t vrf_id);
 474 extern struct interface *if_lookup_prefix(struct prefix *prefix,
 475                                           vrf_id_t vrf_id);
 476
 477 /* These 3 functions are to be used when the ifname argument is terminated
 478    by a '\0' character: */
 479 extern struct interface *if_lookup_by_name_all_vrf(const char *ifname);
 480 extern struct interface *if_lookup_by_name(const char *ifname, vrf_id_t vrf_id);
 481 extern struct interface *if_get_by_name(const char *ifname, vrf_id_t vrf_id,
 482                                         int vty);
 483 extern void if_set_index(struct interface *ifp, ifindex_t ifindex);
 484
 485 /* Delete the interface, but do not free the structure, and leave it in the
 486    interface list.  It is often advisable to leave the pseudo interface
 487    structure because there may be configuration information attached. */
 488 extern void if_delete_retain(struct interface *);
 489
 490 /* Delete and free the interface structure: calls if_delete_retain and then
 491    deletes it from the interface list and frees the structure. */
 492 extern void if_delete(struct interface *);
 493
 494 extern int if_is_up(struct interface *);
 495 extern int if_is_running(struct interface *);
 496 extern int if_is_operative(struct interface *);
 497 extern int if_is_no_ptm_operative(struct interface *);
 498 extern int if_is_loopback(struct interface *);
 499 extern int if_is_vrf(struct interface *ifp);
 500 extern int if_is_broadcast(struct interface *);
 501 extern int if_is_pointopoint(struct interface *);
 502 extern int if_is_multicast(struct interface *);
 503 extern void if_cmd_init(void);
 504 struct vrf;
 505 extern void if_terminate(struct vrf *vrf);
 506 extern void if_dump_all(void);
 507 extern const char *if_flag_dump(unsigned long);
 508 extern const char *if_link_type_str(enum zebra_link_type);
 509
 510 /* Please use ifindex2ifname instead of if_indextoname where possible;
 511    ifindex2ifname uses internal interface info, whereas if_indextoname must
 512    make a system call. */
 513 extern const char *ifindex2ifname(ifindex_t, vrf_id_t vrf_id);
 514
 515 /* Please use ifname2ifindex instead of if_nametoindex where possible;
 516    ifname2ifindex uses internal interface info, whereas if_nametoindex must
 517    make a system call. */
 518 extern ifindex_t ifname2ifindex(const char *ifname, vrf_id_t vrf_id);
 519
 520 /* Connected address functions. */
 521 extern struct connected *connected_new(void);
 522 extern void connected_free(struct connected *);
 523 extern void connected_add(struct interface *, struct connected *);
 524 extern struct connected *
 525 connected_add_by_prefix(struct interface *, struct prefix *, struct prefix *);
 526 extern struct connected *connected_delete_by_prefix(struct interface *,
 527                                                     struct prefix *);
 528 extern struct connected *connected_lookup_prefix(struct interface *,
 529                                                  struct prefix *);
 530 extern struct connected *connected_lookup_prefix_exact(struct interface *,
 531                                                        struct prefix *);
 532 extern struct nbr_connected *nbr_connected_new(void);
 533 extern void nbr_connected_free(struct nbr_connected *);
 534 struct nbr_connected *nbr_connected_check(struct interface *, struct prefix *);
 535
 536 /* link parameters */
 537 struct if_link_params *if_link_params_get(struct interface *);
 538 void if_link_params_free(struct interface *);
 539
 540 #endif /* _ZEBRA_IF_H */