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 {
 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 /* Link Parameters Status: 0: unset, 1: set, */
 150 #define LP_UNSET                0x0000
 151 #define LP_TE                   0x0001
 152 #define LP_MAX_BW               0x0002
 153 #define LP_MAX_RSV_BW           0x0004
 154 #define LP_UNRSV_BW             0x0008
 155 #define LP_ADM_GRP              0x0010
 156 #define LP_RMT_AS               0x0020
 157 #define LP_DELAY                0x0040
 158 #define LP_MM_DELAY             0x0080
 159 #define LP_DELAY_VAR            0x0100
 160 #define LP_PKT_LOSS             0x0200
 161 #define LP_RES_BW               0x0400
 162 #define LP_AVA_BW               0x0800
 163 #define LP_USE_BW               0x1000
 164
 165 #define IS_PARAM_UNSET(lp, st) !(lp->lp_status & st)
 166 #define IS_PARAM_SET(lp, st) (lp->lp_status & st)
 167 #define IS_LINK_PARAMS_SET(lp) (lp->lp_status != LP_UNSET)
 168
 169 #define SET_PARAM(lp, st) (lp->lp_status) |= (st)
 170 #define UNSET_PARAM(lp, st) (lp->lp_status) &= ~(st)
 171 #define RESET_LINK_PARAM(lp) (lp->lp_status = LP_UNSET)
 172
 173 /* Link Parameters for Traffic Engineering */
 174 struct if_link_params {
 175   u_int32_t lp_status;   /* Status of Link Parameters: */
 176   u_int32_t te_metric;   /* Traffic Engineering metric */
 177   float max_bw;          /* Maximum Bandwidth */
 178   float max_rsv_bw;      /* Maximum Reservable Bandwidth */
 179   float unrsv_bw[MAX_CLASS_TYPE];     /* Unreserved Bandwidth per Class Type (8) */
 180   u_int32_t admin_grp;   /* Administrative group */
 181   u_int32_t rmt_as;      /* Remote AS number */
 182   struct in_addr rmt_ip; /* Remote IP address */
 183   u_int32_t av_delay;    /* Link Average Delay */
 184   u_int32_t min_delay;   /* Link Min Delay */
 185   u_int32_t max_delay;   /* Link Max Delay */
 186   u_int32_t delay_var;   /* Link Delay Variation */
 187   float pkt_loss;        /* Link Packet Loss */
 188   float res_bw;          /* Residual Bandwidth */
 189   float ava_bw;          /* Available Bandwidth */
 190   float use_bw;          /* Utilized Bandwidth */
 191 };
 192
 193 #define INTERFACE_LINK_PARAMS_SIZE   sizeof(struct if_link_params)
 194 #define HAS_LINK_PARAMS(ifp)  ((ifp)->link_params != NULL)
 195
 196 /* Interface structure */
 197 struct interface
 198 {
 199   /* Interface name.  This should probably never be changed after the
 200      interface is created, because the configuration info for this interface
 201      is associated with this structure.  For that reason, the interface
 202      should also never be deleted (to avoid losing configuration info).
 203      To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
 204      interface does not exist in the kernel.
 205    */
 206   char name[INTERFACE_NAMSIZ + 1];
 207
 208   /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
 209      deleted interfaces). */
 210   ifindex_t ifindex;
 211 #define IFINDEX_INTERNAL        0
 212 #define IFINDEX_DELETED         INT_MAX
 213
 214   /* Zebra internal interface status */
 215   u_char status;
 216 #define ZEBRA_INTERFACE_ACTIVE     (1 << 0)
 217 #define ZEBRA_INTERFACE_SUB        (1 << 1)
 218 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
 219 #define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
 220
 221   /* Interface flags. */
 222   uint64_t flags;
 223
 224   /* Interface metric */
 225   int metric;
 226
 227   /* Interface MTU. */
 228   unsigned int mtu;    /* IPv4 MTU */
 229   unsigned int mtu6;   /* IPv6 MTU - probably, but not neccessarily same as mtu */
 230
 231   /* Link-layer information and hardware address */
 232   enum zebra_link_type ll_type;
 233   u_char hw_addr[INTERFACE_HWADDR_MAX];
 234   int hw_addr_len;
 235
 236   /* interface bandwidth, kbits */
 237   unsigned int bandwidth;
 238
 239   /* Link parameters for Traffic Engineering */
 240   struct if_link_params *link_params;
 241
 242   /* description of the interface. */
 243   char *desc;
 244
 245   /* Distribute list. */
 246   void *distribute_in;
 247   void *distribute_out;
 248
 249   /* Connected address list. */
 250   struct list *connected;
 251
 252   /* Neighbor connected address list. */
 253   struct list *nbr_connected;
 254
 255   /* Daemon specific interface data pointer. */
 256   void *info;
 257
 258   char ptm_enable;             /* Should we look at ptm_status ? */
 259   char ptm_status;
 260
 261   /* Statistics fileds. */
 262 #ifdef HAVE_PROC_NET_DEV
 263   struct if_stats stats;
 264 #endif /* HAVE_PROC_NET_DEV */
 265 #ifdef HAVE_NET_RT_IFLIST
 266   struct if_data stats;
 267 #endif /* HAVE_NET_RT_IFLIST */
 268
 269   struct route_node *node;
 270   vrf_id_t vrf_id;
 271
 272   QOBJ_FIELDS
 273 };
 274 DECLARE_QOBJ_TYPE(interface)
 275
 276 /* Connected address structure. */
 277 struct connected
 278 {
 279   /* Attached interface. */
 280   struct interface *ifp;
 281
 282   /* Flags for configuration. */
 283   u_char conf;
 284 #define ZEBRA_IFC_REAL         (1 << 0)
 285 #define ZEBRA_IFC_CONFIGURED   (1 << 1)
 286 #define ZEBRA_IFC_QUEUED       (1 << 2)
 287   /*
 288      The ZEBRA_IFC_REAL flag should be set if and only if this address
 289      exists in the kernel and is actually usable. (A case where it exists but
 290      is not yet usable would be IPv6 with DAD)
 291      The ZEBRA_IFC_CONFIGURED flag should be set if and only if this address
 292      was configured by the user from inside quagga.
 293      The ZEBRA_IFC_QUEUED flag should be set if and only if the address exists
 294      in the kernel. It may and should be set although the address might not be
 295      usable yet. (compare with ZEBRA_IFC_REAL)
 296    */
 297
 298   /* Flags for connected address. */
 299   u_char flags;
 300 #define ZEBRA_IFA_SECONDARY    (1 << 0)
 301 #define ZEBRA_IFA_PEER         (1 << 1)
 302 #define ZEBRA_IFA_UNNUMBERED   (1 << 2)
 303   /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
 304      a peer address has been configured.  If this flag is set,
 305      the destination field must contain the peer address.
 306      Otherwise, if this flag is not set, the destination address
 307      will either contain a broadcast address or be NULL.
 308    */
 309
 310   /* Address of connected network. */
 311   struct prefix *address;
 312
 313   /* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is set.
 314      Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
 315   struct prefix *destination;
 316
 317   /* Label for Linux 2.2.X and upper. */
 318   char *label;
 319 };
 320
 321 /* Nbr Connected address structure. */
 322 struct nbr_connected
 323 {
 324   /* Attached interface. */
 325   struct interface *ifp;
 326
 327   /* Address of connected network. */
 328   struct prefix *address;
 329 };
 330
 331 /* Does the destination field contain a peer address? */
 332 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
 333
 334 /* Prefix to insert into the RIB */
 335 #define CONNECTED_PREFIX(C) \
 336         (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
 337
 338 /* Identifying address.  We guess that if there's a peer address, but the
 339    local address is in the same prefix, then the local address may be unique. */
 340 #define CONNECTED_ID(C) \
 341         ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) ?\
 342          (C)->destination : (C)->address)
 343
 344 /* Interface hook sort. */
 345 #define IF_NEW_HOOK   0
 346 #define IF_DELETE_HOOK 1
 347
 348 /* There are some interface flags which are only supported by some
 349    operating system. */
 350
 351 #ifndef IFF_NOTRAILERS
 352 #define IFF_NOTRAILERS 0x0
 353 #endif /* IFF_NOTRAILERS */
 354 #ifndef IFF_OACTIVE
 355 #define IFF_OACTIVE 0x0
 356 #endif /* IFF_OACTIVE */
 357 #ifndef IFF_SIMPLEX
 358 #define IFF_SIMPLEX 0x0
 359 #endif /* IFF_SIMPLEX */
 360 #ifndef IFF_LINK0
 361 #define IFF_LINK0 0x0
 362 #endif /* IFF_LINK0 */
 363 #ifndef IFF_LINK1
 364 #define IFF_LINK1 0x0
 365 #endif /* IFF_LINK1 */
 366 #ifndef IFF_LINK2
 367 #define IFF_LINK2 0x0
 368 #endif /* IFF_LINK2 */
 369 #ifndef IFF_NOXMIT
 370 #define IFF_NOXMIT 0x0
 371 #endif /* IFF_NOXMIT */
 372 #ifndef IFF_NORTEXCH
 373 #define IFF_NORTEXCH 0x0
 374 #endif /* IFF_NORTEXCH */
 375 #ifndef IFF_IPV4
 376 #define IFF_IPV4 0x0
 377 #endif /* IFF_IPV4 */
 378 #ifndef IFF_IPV6
 379 #define IFF_IPV6 0x0
 380 #endif /* IFF_IPV6 */
 381 #ifndef IFF_VIRTUAL
 382 #define IFF_VIRTUAL 0x0
 383 #endif /* IFF_VIRTUAL */
 384
 385 /* Prototypes. */
 386 extern int if_cmp_name_func (char *, char *);
 387 extern struct interface *if_create (const char *name, int namelen);
 388 extern struct interface *if_lookup_by_index (ifindex_t);
 389 extern struct interface *if_lookup_exact_address (void *matchaddr, int family);
 390 extern struct interface *if_lookup_address (void *matchaddr, int family);
 391 extern struct interface *if_lookup_prefix (struct prefix *prefix);
 392
 393 extern void if_update_vrf (struct interface *, const char *name, int namelen,
 394                                 vrf_id_t vrf_id);
 395 extern struct interface *if_create_vrf (const char *name, int namelen,
 396                                 vrf_id_t vrf_id);
 397 extern struct interface *if_lookup_by_index_vrf (ifindex_t, vrf_id_t vrf_id);
 398 extern struct interface *if_lookup_exact_address_vrf (void *matchaddr, int family,
 399                                 vrf_id_t vrf_id);
 400 extern struct interface *if_lookup_address_vrf (void *matchaddr, int family,
 401                                 vrf_id_t vrf_id);
 402 extern struct interface *if_lookup_prefix_vrf (struct prefix *prefix,
 403                                 vrf_id_t vrf_id);
 404
 405 /* These 2 functions are to be used when the ifname argument is terminated
 406    by a '\0' character: */
 407 extern struct interface *if_lookup_by_name (const char *ifname);
 408 extern struct interface *if_get_by_name (const char *ifname);
 409
 410 extern struct interface *if_lookup_by_name_all_vrf (const char *ifname);
 411 extern struct interface *if_lookup_by_name_vrf (const char *ifname,
 412                                 vrf_id_t vrf_id);
 413 extern struct interface *if_get_by_name_vrf (const char *ifname,
 414                                 vrf_id_t vrf_id);
 415
 416 /* For these 2 functions, the namelen argument should be the precise length
 417    of the ifname string (not counting any optional trailing '\0' character).
 418    In most cases, strnlen should be used to calculate the namelen value. */
 419 extern struct interface *if_lookup_by_name_len(const char *ifname,
 420                                               size_t namelen);
 421 extern struct interface *if_get_by_name_len(const char *ifname,size_t namelen);
 422
 423 extern struct interface *if_lookup_by_name_len_vrf(const char *ifname,
 424                                 size_t namelen, vrf_id_t vrf_id);
 425 extern struct interface *if_get_by_name_len_vrf(const char *ifname,
 426                                 size_t namelen, 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 extern void vrf_cmd_init (void);
 455
 456 /* Please use ifindex2ifname instead of if_indextoname where possible;
 457    ifindex2ifname uses internal interface info, whereas if_indextoname must
 458    make a system call. */
 459 extern const char *ifindex2ifname (ifindex_t);
 460 extern const char *ifindex2ifname_vrf (ifindex_t, vrf_id_t vrf_id);
 461
 462 /* Please use ifname2ifindex instead of if_nametoindex where possible;
 463    ifname2ifindex uses internal interface info, whereas if_nametoindex must
 464    make a system call. */
 465 extern ifindex_t ifname2ifindex(const char *ifname);
 466 extern ifindex_t ifname2ifindex_vrf(const char *ifname, vrf_id_t vrf_id);
 467
 468 /* Connected address functions. */
 469 extern struct connected *connected_new (void);
 470 extern void connected_free (struct connected *);
 471 extern void connected_add (struct interface *, struct connected *);
 472 extern struct connected  *connected_add_by_prefix (struct interface *,
 473                                             struct prefix *,
 474                                             struct prefix *);
 475 extern struct connected  *connected_delete_by_prefix (struct interface *,
 476                                                struct prefix *);
 477 extern struct connected  *connected_lookup_prefix (struct interface *,
 478                                                    struct prefix *);
 479 extern struct connected  *connected_lookup_prefix_exact (struct interface *,
 480                                                    struct prefix *);
 481 extern struct nbr_connected *nbr_connected_new (void);
 482 extern void nbr_connected_free (struct nbr_connected *);
 483 struct nbr_connected *nbr_connected_check (struct interface *, struct prefix *);
 484
 485 /* link parameters */
 486 struct if_link_params *if_link_params_get (struct interface *);
 487 void if_link_params_free (struct interface *);
 488
 489 #endif /* _ZEBRA_IF_H */