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