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