1 /* Interface related header.
2 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
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.
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.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
30 DECLARE_MTYPE(CONNECTED_LABEL
)
32 /* Interface link-layer type, if known. Derived from:
34 * net/if_arp.h on various platforms - Linux especially.
35 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
37 * Some of the more obviously defunct technologies left out.
39 enum zebra_link_type
{
40 ZEBRA_LLT_UNKNOWN
= 0,
87 ZEBRA_LLT_IEEE80211_RADIOTAP
,
89 ZEBRA_LLT_IEEE802154_PHY
,
93 Interface name length.
95 Linux define value in /usr/include/linux/if.h.
98 FreeBSD define value in /usr/include/net/if.h.
102 #define INTERFACE_NAMSIZ 20
103 #define INTERFACE_HWADDR_MAX 20
105 typedef signed int ifindex_t
;
107 #ifdef HAVE_PROC_NET_DEV
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
;
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
;
136 #endif /* HAVE_PROC_NET_DEV */
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
144 #define DEFAULT_BANDWIDTH 10000
145 #define MAX_CLASS_TYPE 8
146 #define MAX_PKT_LOSS 50.331642
149 * Link Parameters Status:
151 * different from 0: set
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
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)
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)
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 */
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
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 */
198 #define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
199 #define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
201 /* Interface structure */
203 /* Interface name. This should probably never be changed after the
204 interface is created, because the configuration info for this
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.
211 char name
[INTERFACE_NAMSIZ
+ 1];
213 /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
214 deleted interfaces). */
216 #define IFINDEX_INTERNAL 0
217 #define IFINDEX_DELETED INT_MAX
219 /* Zebra internal interface 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)
226 /* Interface flags. */
229 /* Interface metric */
232 /* Interface Speed in Mb/s */
236 unsigned int mtu
; /* IPv4 MTU */
238 mtu6
; /* IPv6 MTU - probably, but not neccessarily same as mtu
241 /* Link-layer information and hardware address */
242 enum zebra_link_type ll_type
;
243 u_char hw_addr
[INTERFACE_HWADDR_MAX
];
246 /* interface bandwidth, kbits */
247 unsigned int bandwidth
;
249 /* Link parameters for Traffic Engineering */
250 struct if_link_params
*link_params
;
252 /* description of the interface. */
255 /* Distribute list. */
257 void *distribute_out
;
259 /* Connected address list. */
260 struct list
*connected
;
262 /* Neighbor connected address list. */
263 struct list
*nbr_connected
;
265 /* Daemon specific interface data pointer. */
268 char ptm_enable
; /* Should we look at ptm_status ? */
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 */
279 struct route_node
*node
;
284 DECLARE_QOBJ_TYPE(interface
)
286 /* Connected address structure. */
288 /* Attached interface. */
289 struct interface
*ifp
;
291 /* Flags for configuration. */
293 #define ZEBRA_IFC_REAL (1 << 0)
294 #define ZEBRA_IFC_CONFIGURED (1 << 1)
295 #define ZEBRA_IFC_QUEUED (1 << 2)
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
300 is not yet usable would be IPv6 with DAD)
301 The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
303 was configured by the user from inside quagga.
304 The ZEBRA_IFC_QUEUED flag should be set if and only if the address
306 in the kernel. It may and should be set although the address might
308 usable yet. (compare with ZEBRA_IFC_REAL)
311 /* Flags for connected address. */
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.
323 /* Address of connected network. */
324 struct prefix
*address
;
326 /* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is
328 Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
329 struct prefix
*destination
;
331 /* Label for Linux 2.2.X and upper. */
335 /* Nbr Connected address structure. */
336 struct nbr_connected
{
337 /* Attached interface. */
338 struct interface
*ifp
;
340 /* Address of connected network. */
341 struct prefix
*address
;
344 /* Does the destination field contain a peer address? */
345 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
347 /* Prefix to insert into the RIB */
348 #define CONNECTED_PREFIX(C) \
349 (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
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)) \
358 /* Interface hook sort. */
359 #define IF_NEW_HOOK 0
360 #define IF_DELETE_HOOK 1
362 /* There are some interface flags which are only supported by some
365 #ifndef IFF_NOTRAILERS
366 #define IFF_NOTRAILERS 0x0
367 #endif /* IFF_NOTRAILERS */
369 #define IFF_OACTIVE 0x0
370 #endif /* IFF_OACTIVE */
372 #define IFF_SIMPLEX 0x0
373 #endif /* IFF_SIMPLEX */
375 #define IFF_LINK0 0x0
376 #endif /* IFF_LINK0 */
378 #define IFF_LINK1 0x0
379 #endif /* IFF_LINK1 */
381 #define IFF_LINK2 0x0
382 #endif /* IFF_LINK2 */
384 #define IFF_NOXMIT 0x0
385 #endif /* IFF_NOXMIT */
387 #define IFF_NORTEXCH 0x0
388 #endif /* IFF_NORTEXCH */
391 #endif /* IFF_IPV4 */
394 #endif /* IFF_IPV6 */
396 #define IFF_VIRTUAL 0x0
397 #endif /* IFF_VIRTUAL */
400 extern int if_cmp_name_func(char *, char *);
402 extern void if_update_to_new_vrf(struct interface
*, vrf_id_t vrf_id
);
403 extern struct interface
*if_create(const char *name
, int namelen
,
405 extern struct interface
*if_lookup_by_index(ifindex_t
, vrf_id_t vrf_id
);
406 extern struct interface
*if_lookup_exact_address(void *matchaddr
, int family
,
408 extern struct connected
*if_lookup_address(void *matchaddr
, int family
,
410 extern struct interface
*if_lookup_prefix(struct prefix
*prefix
,
413 /* These 3 functions are to be used when the ifname argument is terminated
414 by a '\0' character: */
415 extern struct interface
*if_lookup_by_name_all_vrf(const char *ifname
);
416 extern struct interface
*if_lookup_by_name(const char *ifname
, vrf_id_t vrf_id
);
417 extern struct interface
*if_get_by_name(const char *ifname
, vrf_id_t vrf_id
);
419 /* For these 2 functions, the namelen argument should be the precise length
420 of the ifname string (not counting any optional trailing '\0' character).
421 In most cases, strnlen should be used to calculate the namelen value. */
422 extern struct interface
*if_lookup_by_name_len(const char *ifname
,
423 size_t namelen
, vrf_id_t vrf_id
);
424 extern struct interface
*if_get_by_name_len(const char *ifname
, size_t namelen
,
425 vrf_id_t vrf_id
, int vty
);
428 /* Delete the interface, but do not free the structure, and leave it in the
429 interface list. It is often advisable to leave the pseudo interface
430 structure because there may be configuration information attached. */
431 extern void if_delete_retain(struct interface
*);
433 /* Delete and free the interface structure: calls if_delete_retain and then
434 deletes it from the interface list and frees the structure. */
435 extern void if_delete(struct interface
*);
437 extern int if_is_up(struct interface
*);
438 extern int if_is_running(struct interface
*);
439 extern int if_is_operative(struct interface
*);
440 extern int if_is_no_ptm_operative(struct interface
*);
441 extern int if_is_loopback(struct interface
*);
442 extern int if_is_broadcast(struct interface
*);
443 extern int if_is_pointopoint(struct interface
*);
444 extern int if_is_multicast(struct interface
*);
445 extern void if_add_hook(int, int (*)(struct interface
*));
446 extern void if_init(struct list
**);
447 extern void if_cmd_init(void);
448 extern void if_terminate(struct list
**);
449 extern void if_dump_all(void);
450 extern const char *if_flag_dump(unsigned long);
451 extern const char *if_link_type_str(enum zebra_link_type
);
453 /* Please use ifindex2ifname instead of if_indextoname where possible;
454 ifindex2ifname uses internal interface info, whereas if_indextoname must
455 make a system call. */
456 extern const char *ifindex2ifname(ifindex_t
, vrf_id_t vrf_id
);
458 /* Please use ifname2ifindex instead of if_nametoindex where possible;
459 ifname2ifindex uses internal interface info, whereas if_nametoindex must
460 make a system call. */
461 extern ifindex_t
ifname2ifindex(const char *ifname
, vrf_id_t vrf_id
);
463 /* Connected address functions. */
464 extern struct connected
*connected_new(void);
465 extern void connected_free(struct connected
*);
466 extern void connected_add(struct interface
*, struct connected
*);
467 extern struct connected
*
468 connected_add_by_prefix(struct interface
*, struct prefix
*, struct prefix
*);
469 extern struct connected
*connected_delete_by_prefix(struct interface
*,
471 extern struct connected
*connected_lookup_prefix(struct interface
*,
473 extern struct connected
*connected_lookup_prefix_exact(struct interface
*,
475 extern struct nbr_connected
*nbr_connected_new(void);
476 extern void nbr_connected_free(struct nbr_connected
*);
477 struct nbr_connected
*nbr_connected_check(struct interface
*, struct prefix
*);
479 /* link parameters */
480 struct if_link_params
*if_link_params_get(struct interface
*);
481 void if_link_params_free(struct interface
*);
483 #endif /* _ZEBRA_IF_H */