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   unsigned long 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_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_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   /* Flags for connected address. */
 150   u_char flags;
 151 #define ZEBRA_IFA_SECONDARY   (1 << 0)
 152
 153   /* Address of connected network. */
 154   struct prefix *address;
 155   struct prefix *destination; /* broadcast or peer address; may be NULL */
 156
 157   /* Label for Linux 2.2.X and upper. */
 158   char *label;
 159 };
 160
 161 /* Given an IPV4 struct connected, this macro determines whether a /32
 162    peer address has been supplied (i.e. there is no subnet assigned) */
 163 #define CONNECTED_DEST_HOST(C) \
 164         ((C)->destination && ((C)->address->prefixlen == IPV4_MAX_PREFIXLEN))
 165
 166 /* Given an IPV4 struct connected, this macro determins whether it is
 167    a point-to-point link with a /32 peer address (i.e. there
 168    is no dedicated subnet for the PtP link) */
 169 #define CONNECTED_POINTOPOINT_HOST(C) \
 170         (((C)->ifp->flags & IFF_POINTOPOINT) && CONNECTED_DEST_HOST(C))
 171
 172 /* Interface hook sort. */
 173 #define IF_NEW_HOOK   0
 174 #define IF_DELETE_HOOK 1
 175
 176 /* There are some interface flags which are only supported by some
 177    operating system. */
 178
 179 #ifndef IFF_NOTRAILERS
 180 #define IFF_NOTRAILERS 0x0
 181 #endif /* IFF_NOTRAILERS */
 182 #ifndef IFF_OACTIVE
 183 #define IFF_OACTIVE 0x0
 184 #endif /* IFF_OACTIVE */
 185 #ifndef IFF_SIMPLEX
 186 #define IFF_SIMPLEX 0x0
 187 #endif /* IFF_SIMPLEX */
 188 #ifndef IFF_LINK0
 189 #define IFF_LINK0 0x0
 190 #endif /* IFF_LINK0 */
 191 #ifndef IFF_LINK1
 192 #define IFF_LINK1 0x0
 193 #endif /* IFF_LINK1 */
 194 #ifndef IFF_LINK2
 195 #define IFF_LINK2 0x0
 196 #endif /* IFF_LINK2 */
 197 #ifndef IFF_NOXMIT
 198 #define IFF_NOXMIT 0x0
 199 #endif /* IFF_NOXMIT */
 200 #ifndef IFF_NORTEXCH
 201 #define IFF_NORTEXCH 0x0
 202 #endif /* IFF_NORTEXCH */
 203 #ifndef IFF_IPV4
 204 #define IFF_IPV4 0x0
 205 #endif /* IFF_IPV4 */
 206 #ifndef IFF_IPV6
 207 #define IFF_IPV6 0x0
 208 #endif /* IFF_IPV6 */
 209 #ifndef IFF_VIRTUAL
 210 #define IFF_VIRTUAL 0x0
 211 #endif /* IFF_VIRTUAL */
 212
 213 /* Prototypes. */
 214 int if_cmp_func (struct interface *, struct interface *);
 215 struct interface *if_create (const char *name, int namelen);
 216 struct interface *if_lookup_by_index (unsigned int);
 217 struct interface *if_lookup_exact_address (struct in_addr);
 218 struct interface *if_lookup_address (struct in_addr);
 219
 220 /* Currently, the code assumes that the interface name arguments to these
 221    functions have length <= INTERFACE_NAMSIZ, and they must be NUL-terminated
 222    if they are shorter than INTERFACE_NAMSIZ.  After code cleanup, the
 223    implementation will be changed to require the arguments to these functions
 224    to terminate with a NUL character (no length limitation). */
 225 struct interface *if_lookup_by_name (const char *);
 226 struct interface *if_get_by_name (const char *);
 227
 228 /* For these 2 functions, the 2nd argument should be the precise length
 229    of the interface name (not counting a trailing NUL which may or may
 230    not be present). */
 231 extern struct interface *if_lookup_by_name_len(const char *name,
 232                                                size_t namelen);
 233 extern struct interface *if_get_by_name_len(const char *name, size_t namelen);
 234
 235
 236 /* Delete the interface, but do not free the structure, and leave it in the
 237    interface list.  It is often advisable to leave the pseudo interface
 238    structure because there may be configuration information attached. */
 239 extern void if_delete_retain (struct interface *);
 240
 241 /* Delete and free the interface structure: calls if_delete_retain and then
 242    deletes it from the interface list and frees the structure. */
 243 extern void if_delete (struct interface *);
 244
 245 int if_is_up (struct interface *);
 246 int if_is_running (struct interface *);
 247 int if_is_operative (struct interface *);
 248 int if_is_loopback (struct interface *);
 249 int if_is_broadcast (struct interface *);
 250 int if_is_pointopoint (struct interface *);
 251 int if_is_multicast (struct interface *);
 252 void if_add_hook (int, int (*)(struct interface *));
 253 void if_init ();
 254 void if_dump_all ();
 255 extern const char *if_flag_dump(unsigned long);
 256
 257 /* Please use ifindex2ifname instead of if_indextoname where possible;
 258    ifindex2ifname uses internal interface info, whereas if_indextoname must
 259    make a system call. */
 260 extern char *ifindex2ifname (unsigned int);
 261
 262 /* Please use ifname2ifindex instead of if_nametoindex where possible;
 263    ifname2ifindex uses internal interface info, whereas if_nametoindex must
 264    make a system call. */
 265 extern unsigned int ifname2ifindex(const char *ifname);
 266
 267 /* Connected address functions. */
 268 struct connected *connected_new ();
 269 void connected_free (struct connected *);
 270 void connected_add (struct interface *, struct connected *);
 271 struct connected  *connected_add_by_prefix (struct interface *,
 272                                             struct prefix *,
 273                                             struct prefix *);
 274 struct connected  *connected_delete_by_prefix (struct interface *,
 275                                                struct prefix *);
 276 struct connected  *connected_lookup_address (struct interface *,
 277                                              struct in_addr);
 278
 279 #ifndef HAVE_IF_NAMETOINDEX
 280 unsigned int if_nametoindex (const char *);
 281 #endif
 282 #ifndef HAVE_IF_INDEXTONAME
 283 char *if_indextoname (unsigned int, char *);
 284 #endif
 285
 286 /* Exported variables. */
 287 extern struct list *iflist;
 288 extern struct cmd_element interface_desc_cmd;
 289 extern struct cmd_element no_interface_desc_cmd;
 290 extern struct cmd_element interface_cmd;
 291 extern struct cmd_element no_interface_cmd;
 292 extern struct cmd_element interface_pseudo_cmd;
 293 extern struct cmd_element no_interface_pseudo_cmd;
 294
 295 #endif /* _ZEBRA_IF_H */