2 * Copyright (c) 2001-2003
3 * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
6 * Author: Harti Brandt <harti@freebsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $Begemot: bsnmp/snmp_mibII/snmp_mibII.h,v 1.18 2006/02/14 09:04:19 brandt_h Exp $
31 * Implementation of the interfaces and IP groups of MIB-II.
36 /* forward declaration */
43 typedef void (*mibif_notify_f)(struct mibif *, enum mibif_notify, void *);
46 * Interfaces. This structure describes one interface as seen in the MIB.
47 * Interfaces are indexed by ifindex. This is not the same as the index
48 * used by the system because of the rules in RFC-2863 section 3.1.5. This
49 * RFC requires, that an ifindex is not to be re-used for ANOTHER dynamically
50 * interfaces once the interface was deleted. The system's ifindex is in
51 * sysindex. Mapping is via the mapping table below.
54 TAILQ_ENTRY(mibif) link;
56 u_int index; /* the logical ifindex */
68 uint64_t counter_disc;
71 * This is needed to handle interface type specific information
72 * in sub-modules. It contains a function pointer which handles
73 * notifications and a data pointer to arbitrary data.
74 * Should be set via the mibif_notify function.
76 mibif_notify_f xnotify;
78 const struct lmodule *xnotify_mod;
80 /* to be set by ifType specific modules. This is ifSpecific. */
81 struct asn_oid spec_oid;
83 /* private data - don't touch */
88 * Interface IP-address table.
91 TAILQ_ENTRY(mibifa) link;
92 struct in_addr inaddr;
93 struct in_addr inmask;
94 struct in_addr inbcast;
95 struct asn_oid index; /* index for table search */
101 * Interface receive addresses. Interface link-level multicast, broadcast
102 * and hardware addresses are handled automatically.
105 TAILQ_ENTRY(mibrcvaddr) link;
106 struct asn_oid index;
108 u_char addr[ASN_MAXOIDLEN];
113 MIBRCVADDR_VOLATILE = 0x00000001,
114 MIBRCVADDR_BCAST = 0x00000002,
115 MIBRCVADDR_HW = 0x00000004,
119 extern int mib_netsock;
121 /* set an interface name to dynamic mode */
122 void mib_if_set_dyn(const char *);
124 /* re-read the systems interface list */
125 void mib_refresh_iflist(void);
127 /* find interface by index */
128 struct mibif *mib_find_if(u_int);
129 struct mibif *mib_find_if_sys(u_int);
130 struct mibif *mib_find_if_name(const char *);
132 /* iterate through all interfaces */
133 struct mibif *mib_first_if(void);
134 struct mibif *mib_next_if(const struct mibif *);
136 /* register for interface creations */
137 int mib_register_newif(int (*)(struct mibif *), const struct lmodule *);
138 void mib_unregister_newif(const struct lmodule *);
140 /* get fresh MIB data */
141 int mib_fetch_ifmib(struct mibif *);
143 /* change the ADMIN status of an interface and refresh the MIB */
144 int mib_if_admin(struct mibif *, int up);
146 /* find interface address by address */
147 struct mibifa *mib_find_ifa(struct in_addr);
149 /* find first/next address for a given interface */
150 struct mibifa *mib_first_ififa(const struct mibif *);
151 struct mibifa *mib_next_ififa(struct mibifa *);
153 /* create/delete stacking entries */
154 int mib_ifstack_create(const struct mibif *lower, const struct mibif *upper);
155 void mib_ifstack_delete(const struct mibif *lower, const struct mibif *upper);
157 /* find receive address */
158 struct mibrcvaddr *mib_find_rcvaddr(u_int, const u_char *, size_t);
160 /* create/delete receive addresses */
161 struct mibrcvaddr *mib_rcvaddr_create(struct mibif *, const u_char *, size_t);
162 void mib_rcvaddr_delete(struct mibrcvaddr *);
164 /* register for interface notification */
165 void *mibif_notify(struct mibif *, const struct lmodule *, mibif_notify_f,
167 void mibif_unnotify(void *);