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 "linklist.h"
  25
  26 /*
  27   Interface name length.
  28
  29    Linux define value in /usr/include/linux/if.h.
  30    #define IFNAMSIZ        16
  31
  32    FreeBSD define value in /usr/include/net/if.h.
  33    #define IFNAMSIZ        16
  34 */
  35
  36 #define INTERFACE_NAMSIZ      20
  37 #define INTERFACE_HWADDR_MAX  20
  38
  39 #ifdef HAVE_PROC_NET_DEV
  40 struct if_stats
  41 {
  42   unsigned long rx_packets;   /* total packets received       */
  43   unsigned long tx_packets;   /* total packets transmitted    */
  44   unsigned long rx_bytes;     /* total bytes received         */
  45   unsigned long tx_bytes;     /* total bytes transmitted      */
  46   unsigned long rx_errors;    /* bad packets received         */
  47   unsigned long tx_errors;    /* packet transmit problems     */
  48   unsigned long rx_dropped;   /* no space in linux buffers    */
  49   unsigned long tx_dropped;   /* no space available in linux  */
  50   unsigned long rx_multicast; /* multicast packets received   */
  51   unsigned long rx_compressed;
  52   unsigned long tx_compressed;
  53   unsigned long collisions;
  54
  55   /* detailed rx_errors: */
  56   unsigned long rx_length_errors;
  57   unsigned long rx_over_errors;       /* receiver ring buff overflow  */
  58   unsigned long rx_crc_errors;        /* recved pkt with crc error    */
  59   unsigned long rx_frame_errors;      /* recv'd frame alignment error */
  60   unsigned long rx_fifo_errors;       /* recv'r fifo overrun          */
  61   unsigned long rx_missed_errors;     /* receiver missed packet     */
  62   /* detailed tx_errors */
  63   unsigned long tx_aborted_errors;
  64   unsigned long tx_carrier_errors;
  65   unsigned long tx_fifo_errors;
  66   unsigned long tx_heartbeat_errors;
  67   unsigned long tx_window_errors;
  68 };
  69 #endif /* HAVE_PROC_NET_DEV */
  70
  71 /* Interface structure */
  72 struct interface
  73 {
  74   /* Interface name.  This should probably never be changed after the
  75      interface is created, because the configuration info for this interface
  76      is associated with this structure.  For that reason, the interface
  77      should also never be deleted (to avoid losing configuration info).
  78      To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
  79      interface does not exist in the kernel.
  80    */
  81   char name[INTERFACE_NAMSIZ + 1];
  82
  83   /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
  84      deleted interfaces). */
  85   unsigned int ifindex;
  86 #define IFINDEX_INTERNAL        0
  87
  88   /* Zebra internal interface status */
  89   u_char status;
  90 #define ZEBRA_INTERFACE_ACTIVE     (1 << 0)
  91 #define ZEBRA_INTERFACE_SUB        (1 << 1)
  92 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
  93
  94   /* Interface flags. */
  95   uint64_t flags;
  96
  97   /* Interface metric */
  98   int metric;
  99
 100   /* Interface MTU. */
 101   unsigned int mtu;    /* IPv4 MTU */
 102   unsigned int mtu6;   /* IPv6 MTU - probably, but not neccessarily same as mtu */
 103
 104   /* Hardware address. */
 105 #ifdef HAVE_STRUCT_SOCKADDR_DL
 106   struct sockaddr_dl sdl;
 107 #else
 108   unsigned short hw_type;
 109   u_char hw_addr[INTERFACE_HWADDR_MAX];
 110   int hw_addr_len;
 111 #endif /* HAVE_STRUCT_SOCKADDR_DL */
 112
 113   /* interface bandwidth, kbits */
 114   unsigned int bandwidth;
 115
 116   /* description of the interface. */
 117   char *desc;
 118
 119   /* Distribute list. */
 120   void *distribute_in;
 121   void *distribute_out;
 122
 123   /* Connected address list. */
 124   struct list *connected;
 125
 126   /* Daemon specific interface data pointer. */
 127   void *info;
 128
 129   /* Statistics fileds. */
 130 #ifdef HAVE_PROC_NET_DEV
 131   struct if_stats stats;
 132 #endif /* HAVE_PROC_NET_DEV */
 133 #ifdef HAVE_NET_RT_IFLIST
 134   struct if_data stats;
 135 #endif /* HAVE_NET_RT_IFLIST */
 136 };
 137
 138 /* Connected address structure. */
 139 struct connected
 140 {
 141   /* Attached interface. */
 142   struct interface *ifp;
 143
 144   /* Flags for configuration. */
 145   u_char conf;
 146 #define ZEBRA_IFC_REAL         (1 << 0)
 147 #define ZEBRA_IFC_CONFIGURED   (1 << 1)
 148   /*
 149      The ZEBRA_IFC_REAL flag should be set if and only if this address
 150      exists in the kernel.
 151      The ZEBRA_IFC_CONFIGURED flag should be set if and only if this address
 152      was configured by the user from inside quagga.
 153    */
 154
 155   /* Flags for connected address. */
 156   u_char flags;
 157 #define ZEBRA_IFA_SECONDARY    (1 << 0)
 158 #define ZEBRA_IFA_PEER         (1 << 1)
 159   /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
 160      a peer address has been configured.  If this flag is set,
 161      the destination field must contain the peer address.
 162      Otherwise, if this flag is not set, the destination address
 163      will either contain a broadcast address or be NULL.
 164    */
 165
 166   /* Address of connected network. */
 167   struct prefix *address;
 168
 169   /* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is set.
 170      Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
 171   struct prefix *destination;
 172
 173   /* Label for Linux 2.2.X and upper. */
 174   char *label;
 175 };
 176
 177 /* Does the destination field contain a peer address? */
 178 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
 179
 180 /* Prefix to insert into the RIB */
 181 #define CONNECTED_PREFIX(C) \
 182         (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
 183
 184 /* Identifying address.  We guess that if there's a peer address, but the
 185    local address is in the same prefix, then the local address may be unique. */
 186 #define CONNECTED_ID(C) \
 187         ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) ?\
 188          (C)->destination : (C)->address)
 189
 190 /* Interface hook sort. */
 191 #define IF_NEW_HOOK   0
 192 #define IF_DELETE_HOOK 1
 193
 194 /* There are some interface flags which are only supported by some
 195    operating system. */
 196
 197 #ifndef IFF_NOTRAILERS
 198 #define IFF_NOTRAILERS 0x0
 199 #endif /* IFF_NOTRAILERS */
 200 #ifndef IFF_OACTIVE
 201 #define IFF_OACTIVE 0x0
 202 #endif /* IFF_OACTIVE */
 203 #ifndef IFF_SIMPLEX
 204 #define IFF_SIMPLEX 0x0
 205 #endif /* IFF_SIMPLEX */
 206 #ifndef IFF_LINK0
 207 #define IFF_LINK0 0x0
 208 #endif /* IFF_LINK0 */
 209 #ifndef IFF_LINK1
 210 #define IFF_LINK1 0x0
 211 #endif /* IFF_LINK1 */
 212 #ifndef IFF_LINK2
 213 #define IFF_LINK2 0x0
 214 #endif /* IFF_LINK2 */
 215 #ifndef IFF_NOXMIT
 216 #define IFF_NOXMIT 0x0
 217 #endif /* IFF_NOXMIT */
 218 #ifndef IFF_NORTEXCH
 219 #define IFF_NORTEXCH 0x0
 220 #endif /* IFF_NORTEXCH */
 221 #ifndef IFF_IPV4
 222 #define IFF_IPV4 0x0
 223 #endif /* IFF_IPV4 */
 224 #ifndef IFF_IPV6
 225 #define IFF_IPV6 0x0
 226 #endif /* IFF_IPV6 */
 227 #ifndef IFF_VIRTUAL
 228 #define IFF_VIRTUAL 0x0
 229 #endif /* IFF_VIRTUAL */
 230
 231 /* Prototypes. */
 232 extern int if_cmp_func (struct interface *, struct interface *);
 233 extern struct interface *if_create (const char *name, int namelen);
 234 extern struct interface *if_lookup_by_index (unsigned int);
 235 extern struct interface *if_lookup_exact_address (struct in_addr);
 236 extern struct interface *if_lookup_address (struct in_addr);
 237
 238 /* These 2 functions are to be used when the ifname argument is terminated
 239    by a '\0' character: */
 240 extern struct interface *if_lookup_by_name (const char *ifname);
 241 extern struct interface *if_get_by_name (const char *ifname);
 242
 243 /* For these 2 functions, the namelen argument should be the precise length
 244    of the ifname string (not counting any optional trailing '\0' character).
 245    In most cases, strnlen should be used to calculate the namelen value. */
 246 extern struct interface *if_lookup_by_name_len(const char *ifname,
 247                                                size_t namelen);
 248 extern struct interface *if_get_by_name_len(const char *ifname, size_t namelen);
 249
 250
 251 /* Delete the interface, but do not free the structure, and leave it in the
 252    interface list.  It is often advisable to leave the pseudo interface
 253    structure because there may be configuration information attached. */
 254 extern void if_delete_retain (struct interface *);
 255
 256 /* Delete and free the interface structure: calls if_delete_retain and then
 257    deletes it from the interface list and frees the structure. */
 258 extern void if_delete (struct interface *);
 259
 260 extern int if_is_up (struct interface *);
 261 extern int if_is_running (struct interface *);
 262 extern int if_is_operative (struct interface *);
 263 extern int if_is_loopback (struct interface *);
 264 extern int if_is_broadcast (struct interface *);
 265 extern int if_is_pointopoint (struct interface *);
 266 extern int if_is_multicast (struct interface *);
 267 extern void if_add_hook (int, int (*)(struct interface *));
 268 extern void if_init (void);
 269 extern void if_terminate (void);
 270 extern void if_dump_all (void);
 271 extern const char *if_flag_dump(unsigned long);
 272
 273 /* Please use ifindex2ifname instead of if_indextoname where possible;
 274    ifindex2ifname uses internal interface info, whereas if_indextoname must
 275    make a system call. */
 276 extern const char *ifindex2ifname (unsigned int);
 277
 278 /* Please use ifname2ifindex instead of if_nametoindex where possible;
 279    ifname2ifindex uses internal interface info, whereas if_nametoindex must
 280    make a system call. */
 281 extern unsigned int ifname2ifindex(const char *ifname);
 282
 283 /* Connected address functions. */
 284 extern struct connected *connected_new (void);
 285 extern void connected_free (struct connected *);
 286 extern void connected_add (struct interface *, struct connected *);
 287 extern struct connected  *connected_add_by_prefix (struct interface *,
 288                                             struct prefix *,
 289                                             struct prefix *);
 290 extern struct connected  *connected_delete_by_prefix (struct interface *,
 291                                                struct prefix *);
 292 extern struct connected  *connected_lookup_address (struct interface *,
 293                                              struct in_addr);
 294
 295 #ifndef HAVE_IF_NAMETOINDEX
 296 extern unsigned int if_nametoindex (const char *);
 297 #endif
 298 #ifndef HAVE_IF_INDEXTONAME
 299 extern char *if_indextoname (unsigned int, char *);
 300 #endif
 301
 302 /* Exported variables. */
 303 extern struct list *iflist;
 304 extern struct cmd_element interface_desc_cmd;
 305 extern struct cmd_element no_interface_desc_cmd;
 306 extern struct cmd_element interface_cmd;
 307 extern struct cmd_element no_interface_cmd;
 308 extern struct cmd_element interface_pseudo_cmd;
 309 extern struct cmd_element no_interface_pseudo_cmd;
 310 extern struct cmd_element show_address_cmd;
 311
 312 #endif /* _ZEBRA_IF_H */