1 | /*
|
---|
2 | * Copyright (c) 2001, 2002 Leon Woestenberg <leon.woestenberg@axon.tv>
|
---|
3 | * Copyright (c) 2001, 2002 Axon Digital Design B.V., The Netherlands.
|
---|
4 | * All rights reserved.
|
---|
5 | *
|
---|
6 | * Redistribution and use in source and binary forms, with or without modification,
|
---|
7 | * are permitted provided that the following conditions are met:
|
---|
8 | *
|
---|
9 | * 1. Redistributions of source code must retain the above copyright notice,
|
---|
10 | * this list of conditions and the following disclaimer.
|
---|
11 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
12 | * this list of conditions and the following disclaimer in the documentation
|
---|
13 | * and/or other materials provided with the distribution.
|
---|
14 | * 3. The name of the author may not be used to endorse or promote products
|
---|
15 | * derived from this software without specific prior written permission.
|
---|
16 | *
|
---|
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
---|
18 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
---|
19 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
---|
20 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
---|
21 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
---|
22 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
---|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
---|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
---|
25 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
---|
26 | * OF SUCH DAMAGE.
|
---|
27 | *
|
---|
28 | * This file is part of the lwIP TCP/IP stack.
|
---|
29 | *
|
---|
30 | * Author: Leon Woestenberg <leon.woestenberg@axon.tv>
|
---|
31 | *
|
---|
32 | */
|
---|
33 | #ifndef __LWIP_SNMP_H__
|
---|
34 | #define __LWIP_SNMP_H__
|
---|
35 |
|
---|
36 | #include "lwip/opt.h"
|
---|
37 |
|
---|
38 | #ifdef __cplusplus
|
---|
39 | extern "C" {
|
---|
40 | #endif
|
---|
41 |
|
---|
42 | #include "lwip/ip_addr.h"
|
---|
43 |
|
---|
44 | struct udp_pcb;
|
---|
45 | struct netif;
|
---|
46 |
|
---|
47 | /**
|
---|
48 | * @see RFC1213, "MIB-II, 6. Definitions"
|
---|
49 | */
|
---|
50 | enum snmp_ifType {
|
---|
51 | snmp_ifType_other=1, /* none of the following */
|
---|
52 | snmp_ifType_regular1822,
|
---|
53 | snmp_ifType_hdh1822,
|
---|
54 | snmp_ifType_ddn_x25,
|
---|
55 | snmp_ifType_rfc877_x25,
|
---|
56 | snmp_ifType_ethernet_csmacd,
|
---|
57 | snmp_ifType_iso88023_csmacd,
|
---|
58 | snmp_ifType_iso88024_tokenBus,
|
---|
59 | snmp_ifType_iso88025_tokenRing,
|
---|
60 | snmp_ifType_iso88026_man,
|
---|
61 | snmp_ifType_starLan,
|
---|
62 | snmp_ifType_proteon_10Mbit,
|
---|
63 | snmp_ifType_proteon_80Mbit,
|
---|
64 | snmp_ifType_hyperchannel,
|
---|
65 | snmp_ifType_fddi,
|
---|
66 | snmp_ifType_lapb,
|
---|
67 | snmp_ifType_sdlc,
|
---|
68 | snmp_ifType_ds1, /* T-1 */
|
---|
69 | snmp_ifType_e1, /* european equiv. of T-1 */
|
---|
70 | snmp_ifType_basicISDN,
|
---|
71 | snmp_ifType_primaryISDN, /* proprietary serial */
|
---|
72 | snmp_ifType_propPointToPointSerial,
|
---|
73 | snmp_ifType_ppp,
|
---|
74 | snmp_ifType_softwareLoopback,
|
---|
75 | snmp_ifType_eon, /* CLNP over IP [11] */
|
---|
76 | snmp_ifType_ethernet_3Mbit,
|
---|
77 | snmp_ifType_nsip, /* XNS over IP */
|
---|
78 | snmp_ifType_slip, /* generic SLIP */
|
---|
79 | snmp_ifType_ultra, /* ULTRA technologies */
|
---|
80 | snmp_ifType_ds3, /* T-3 */
|
---|
81 | snmp_ifType_sip, /* SMDS */
|
---|
82 | snmp_ifType_frame_relay
|
---|
83 | };
|
---|
84 |
|
---|
85 | #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
|
---|
86 |
|
---|
87 | /** SNMP "sysuptime" Interval */
|
---|
88 | #define SNMP_SYSUPTIME_INTERVAL 10
|
---|
89 |
|
---|
90 | /** fixed maximum length for object identifier type */
|
---|
91 | #define LWIP_SNMP_OBJ_ID_LEN 32
|
---|
92 |
|
---|
93 | /** internal object identifier representation */
|
---|
94 | struct snmp_obj_id
|
---|
95 | {
|
---|
96 | u8_t len;
|
---|
97 | s32_t id[LWIP_SNMP_OBJ_ID_LEN];
|
---|
98 | };
|
---|
99 |
|
---|
100 | /* system */
|
---|
101 | void snmp_set_sysdesr(u8_t* str, u8_t* len);
|
---|
102 | void snmp_set_sysobjid(struct snmp_obj_id *oid);
|
---|
103 | void snmp_get_sysobjid_ptr(struct snmp_obj_id **oid);
|
---|
104 | void snmp_inc_sysuptime(void);
|
---|
105 | void snmp_add_sysuptime(u32_t value);
|
---|
106 | void snmp_get_sysuptime(u32_t *value);
|
---|
107 | void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen);
|
---|
108 | void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen);
|
---|
109 | void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen);
|
---|
110 |
|
---|
111 | /* network interface */
|
---|
112 | void snmp_add_ifinoctets(struct netif *ni, u32_t value);
|
---|
113 | void snmp_inc_ifinucastpkts(struct netif *ni);
|
---|
114 | void snmp_inc_ifinnucastpkts(struct netif *ni);
|
---|
115 | void snmp_inc_ifindiscards(struct netif *ni);
|
---|
116 | void snmp_add_ifoutoctets(struct netif *ni, u32_t value);
|
---|
117 | void snmp_inc_ifoutucastpkts(struct netif *ni);
|
---|
118 | void snmp_inc_ifoutnucastpkts(struct netif *ni);
|
---|
119 | void snmp_inc_ifoutdiscards(struct netif *ni);
|
---|
120 | void snmp_inc_iflist(void);
|
---|
121 | void snmp_dec_iflist(void);
|
---|
122 |
|
---|
123 | /* ARP (for atTable and ipNetToMediaTable) */
|
---|
124 | void snmp_insert_arpidx_tree(struct netif *ni, ip_addr_t *ip);
|
---|
125 | void snmp_delete_arpidx_tree(struct netif *ni, ip_addr_t *ip);
|
---|
126 |
|
---|
127 | /* IP */
|
---|
128 | void snmp_inc_ipinreceives(void);
|
---|
129 | void snmp_inc_ipinhdrerrors(void);
|
---|
130 | void snmp_inc_ipinaddrerrors(void);
|
---|
131 | void snmp_inc_ipforwdatagrams(void);
|
---|
132 | void snmp_inc_ipinunknownprotos(void);
|
---|
133 | void snmp_inc_ipindiscards(void);
|
---|
134 | void snmp_inc_ipindelivers(void);
|
---|
135 | void snmp_inc_ipoutrequests(void);
|
---|
136 | void snmp_inc_ipoutdiscards(void);
|
---|
137 | void snmp_inc_ipoutnoroutes(void);
|
---|
138 | void snmp_inc_ipreasmreqds(void);
|
---|
139 | void snmp_inc_ipreasmoks(void);
|
---|
140 | void snmp_inc_ipreasmfails(void);
|
---|
141 | void snmp_inc_ipfragoks(void);
|
---|
142 | void snmp_inc_ipfragfails(void);
|
---|
143 | void snmp_inc_ipfragcreates(void);
|
---|
144 | void snmp_inc_iproutingdiscards(void);
|
---|
145 | void snmp_insert_ipaddridx_tree(struct netif *ni);
|
---|
146 | void snmp_delete_ipaddridx_tree(struct netif *ni);
|
---|
147 | void snmp_insert_iprteidx_tree(u8_t dflt, struct netif *ni);
|
---|
148 | void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni);
|
---|
149 |
|
---|
150 | /* ICMP */
|
---|
151 | void snmp_inc_icmpinmsgs(void);
|
---|
152 | void snmp_inc_icmpinerrors(void);
|
---|
153 | void snmp_inc_icmpindestunreachs(void);
|
---|
154 | void snmp_inc_icmpintimeexcds(void);
|
---|
155 | void snmp_inc_icmpinparmprobs(void);
|
---|
156 | void snmp_inc_icmpinsrcquenchs(void);
|
---|
157 | void snmp_inc_icmpinredirects(void);
|
---|
158 | void snmp_inc_icmpinechos(void);
|
---|
159 | void snmp_inc_icmpinechoreps(void);
|
---|
160 | void snmp_inc_icmpintimestamps(void);
|
---|
161 | void snmp_inc_icmpintimestampreps(void);
|
---|
162 | void snmp_inc_icmpinaddrmasks(void);
|
---|
163 | void snmp_inc_icmpinaddrmaskreps(void);
|
---|
164 | void snmp_inc_icmpoutmsgs(void);
|
---|
165 | void snmp_inc_icmpouterrors(void);
|
---|
166 | void snmp_inc_icmpoutdestunreachs(void);
|
---|
167 | void snmp_inc_icmpouttimeexcds(void);
|
---|
168 | void snmp_inc_icmpoutparmprobs(void);
|
---|
169 | void snmp_inc_icmpoutsrcquenchs(void);
|
---|
170 | void snmp_inc_icmpoutredirects(void);
|
---|
171 | void snmp_inc_icmpoutechos(void);
|
---|
172 | void snmp_inc_icmpoutechoreps(void);
|
---|
173 | void snmp_inc_icmpouttimestamps(void);
|
---|
174 | void snmp_inc_icmpouttimestampreps(void);
|
---|
175 | void snmp_inc_icmpoutaddrmasks(void);
|
---|
176 | void snmp_inc_icmpoutaddrmaskreps(void);
|
---|
177 |
|
---|
178 | /* TCP */
|
---|
179 | void snmp_inc_tcpactiveopens(void);
|
---|
180 | void snmp_inc_tcppassiveopens(void);
|
---|
181 | void snmp_inc_tcpattemptfails(void);
|
---|
182 | void snmp_inc_tcpestabresets(void);
|
---|
183 | void snmp_inc_tcpinsegs(void);
|
---|
184 | void snmp_inc_tcpoutsegs(void);
|
---|
185 | void snmp_inc_tcpretranssegs(void);
|
---|
186 | void snmp_inc_tcpinerrs(void);
|
---|
187 | void snmp_inc_tcpoutrsts(void);
|
---|
188 |
|
---|
189 | /* UDP */
|
---|
190 | void snmp_inc_udpindatagrams(void);
|
---|
191 | void snmp_inc_udpnoports(void);
|
---|
192 | void snmp_inc_udpinerrors(void);
|
---|
193 | void snmp_inc_udpoutdatagrams(void);
|
---|
194 | void snmp_insert_udpidx_tree(struct udp_pcb *pcb);
|
---|
195 | void snmp_delete_udpidx_tree(struct udp_pcb *pcb);
|
---|
196 |
|
---|
197 | /* SNMP */
|
---|
198 | void snmp_inc_snmpinpkts(void);
|
---|
199 | void snmp_inc_snmpoutpkts(void);
|
---|
200 | void snmp_inc_snmpinbadversions(void);
|
---|
201 | void snmp_inc_snmpinbadcommunitynames(void);
|
---|
202 | void snmp_inc_snmpinbadcommunityuses(void);
|
---|
203 | void snmp_inc_snmpinasnparseerrs(void);
|
---|
204 | void snmp_inc_snmpintoobigs(void);
|
---|
205 | void snmp_inc_snmpinnosuchnames(void);
|
---|
206 | void snmp_inc_snmpinbadvalues(void);
|
---|
207 | void snmp_inc_snmpinreadonlys(void);
|
---|
208 | void snmp_inc_snmpingenerrs(void);
|
---|
209 | void snmp_add_snmpintotalreqvars(u8_t value);
|
---|
210 | void snmp_add_snmpintotalsetvars(u8_t value);
|
---|
211 | void snmp_inc_snmpingetrequests(void);
|
---|
212 | void snmp_inc_snmpingetnexts(void);
|
---|
213 | void snmp_inc_snmpinsetrequests(void);
|
---|
214 | void snmp_inc_snmpingetresponses(void);
|
---|
215 | void snmp_inc_snmpintraps(void);
|
---|
216 | void snmp_inc_snmpouttoobigs(void);
|
---|
217 | void snmp_inc_snmpoutnosuchnames(void);
|
---|
218 | void snmp_inc_snmpoutbadvalues(void);
|
---|
219 | void snmp_inc_snmpoutgenerrs(void);
|
---|
220 | void snmp_inc_snmpoutgetrequests(void);
|
---|
221 | void snmp_inc_snmpoutgetnexts(void);
|
---|
222 | void snmp_inc_snmpoutsetrequests(void);
|
---|
223 | void snmp_inc_snmpoutgetresponses(void);
|
---|
224 | void snmp_inc_snmpouttraps(void);
|
---|
225 | void snmp_get_snmpgrpid_ptr(struct snmp_obj_id **oid);
|
---|
226 | void snmp_set_snmpenableauthentraps(u8_t *value);
|
---|
227 | void snmp_get_snmpenableauthentraps(u8_t *value);
|
---|
228 |
|
---|
229 | /* LWIP_SNMP support not available */
|
---|
230 | /* define everything to be empty */
|
---|
231 | #else
|
---|
232 |
|
---|
233 | /* system */
|
---|
234 | #define snmp_set_sysdesr(str, len)
|
---|
235 | #define snmp_set_sysobjid(oid);
|
---|
236 | #define snmp_get_sysobjid_ptr(oid)
|
---|
237 | #define snmp_inc_sysuptime()
|
---|
238 | #define snmp_add_sysuptime(value)
|
---|
239 | #define snmp_get_sysuptime(value)
|
---|
240 | #define snmp_set_syscontact(ocstr, ocstrlen);
|
---|
241 | #define snmp_set_sysname(ocstr, ocstrlen);
|
---|
242 | #define snmp_set_syslocation(ocstr, ocstrlen);
|
---|
243 |
|
---|
244 | /* network interface */
|
---|
245 | #define snmp_add_ifinoctets(ni,value)
|
---|
246 | #define snmp_inc_ifinucastpkts(ni)
|
---|
247 | #define snmp_inc_ifinnucastpkts(ni)
|
---|
248 | #define snmp_inc_ifindiscards(ni)
|
---|
249 | #define snmp_add_ifoutoctets(ni,value)
|
---|
250 | #define snmp_inc_ifoutucastpkts(ni)
|
---|
251 | #define snmp_inc_ifoutnucastpkts(ni)
|
---|
252 | #define snmp_inc_ifoutdiscards(ni)
|
---|
253 | #define snmp_inc_iflist()
|
---|
254 | #define snmp_dec_iflist()
|
---|
255 |
|
---|
256 | /* ARP */
|
---|
257 | #define snmp_insert_arpidx_tree(ni,ip)
|
---|
258 | #define snmp_delete_arpidx_tree(ni,ip)
|
---|
259 |
|
---|
260 | /* IP */
|
---|
261 | #define snmp_inc_ipinreceives()
|
---|
262 | #define snmp_inc_ipinhdrerrors()
|
---|
263 | #define snmp_inc_ipinaddrerrors()
|
---|
264 | #define snmp_inc_ipforwdatagrams()
|
---|
265 | #define snmp_inc_ipinunknownprotos()
|
---|
266 | #define snmp_inc_ipindiscards()
|
---|
267 | #define snmp_inc_ipindelivers()
|
---|
268 | #define snmp_inc_ipoutrequests()
|
---|
269 | #define snmp_inc_ipoutdiscards()
|
---|
270 | #define snmp_inc_ipoutnoroutes()
|
---|
271 | #define snmp_inc_ipreasmreqds()
|
---|
272 | #define snmp_inc_ipreasmoks()
|
---|
273 | #define snmp_inc_ipreasmfails()
|
---|
274 | #define snmp_inc_ipfragoks()
|
---|
275 | #define snmp_inc_ipfragfails()
|
---|
276 | #define snmp_inc_ipfragcreates()
|
---|
277 | #define snmp_inc_iproutingdiscards()
|
---|
278 | #define snmp_insert_ipaddridx_tree(ni)
|
---|
279 | #define snmp_delete_ipaddridx_tree(ni)
|
---|
280 | #define snmp_insert_iprteidx_tree(dflt, ni)
|
---|
281 | #define snmp_delete_iprteidx_tree(dflt, ni)
|
---|
282 |
|
---|
283 | /* ICMP */
|
---|
284 | #define snmp_inc_icmpinmsgs()
|
---|
285 | #define snmp_inc_icmpinerrors()
|
---|
286 | #define snmp_inc_icmpindestunreachs()
|
---|
287 | #define snmp_inc_icmpintimeexcds()
|
---|
288 | #define snmp_inc_icmpinparmprobs()
|
---|
289 | #define snmp_inc_icmpinsrcquenchs()
|
---|
290 | #define snmp_inc_icmpinredirects()
|
---|
291 | #define snmp_inc_icmpinechos()
|
---|
292 | #define snmp_inc_icmpinechoreps()
|
---|
293 | #define snmp_inc_icmpintimestamps()
|
---|
294 | #define snmp_inc_icmpintimestampreps()
|
---|
295 | #define snmp_inc_icmpinaddrmasks()
|
---|
296 | #define snmp_inc_icmpinaddrmaskreps()
|
---|
297 | #define snmp_inc_icmpoutmsgs()
|
---|
298 | #define snmp_inc_icmpouterrors()
|
---|
299 | #define snmp_inc_icmpoutdestunreachs()
|
---|
300 | #define snmp_inc_icmpouttimeexcds()
|
---|
301 | #define snmp_inc_icmpoutparmprobs()
|
---|
302 | #define snmp_inc_icmpoutsrcquenchs()
|
---|
303 | #define snmp_inc_icmpoutredirects()
|
---|
304 | #define snmp_inc_icmpoutechos()
|
---|
305 | #define snmp_inc_icmpoutechoreps()
|
---|
306 | #define snmp_inc_icmpouttimestamps()
|
---|
307 | #define snmp_inc_icmpouttimestampreps()
|
---|
308 | #define snmp_inc_icmpoutaddrmasks()
|
---|
309 | #define snmp_inc_icmpoutaddrmaskreps()
|
---|
310 | /* TCP */
|
---|
311 | #define snmp_inc_tcpactiveopens()
|
---|
312 | #define snmp_inc_tcppassiveopens()
|
---|
313 | #define snmp_inc_tcpattemptfails()
|
---|
314 | #define snmp_inc_tcpestabresets()
|
---|
315 | #define snmp_inc_tcpinsegs()
|
---|
316 | #define snmp_inc_tcpoutsegs()
|
---|
317 | #define snmp_inc_tcpretranssegs()
|
---|
318 | #define snmp_inc_tcpinerrs()
|
---|
319 | #define snmp_inc_tcpoutrsts()
|
---|
320 |
|
---|
321 | /* UDP */
|
---|
322 | #define snmp_inc_udpindatagrams()
|
---|
323 | #define snmp_inc_udpnoports()
|
---|
324 | #define snmp_inc_udpinerrors()
|
---|
325 | #define snmp_inc_udpoutdatagrams()
|
---|
326 | #define snmp_insert_udpidx_tree(pcb)
|
---|
327 | #define snmp_delete_udpidx_tree(pcb)
|
---|
328 |
|
---|
329 | /* SNMP */
|
---|
330 | #define snmp_inc_snmpinpkts()
|
---|
331 | #define snmp_inc_snmpoutpkts()
|
---|
332 | #define snmp_inc_snmpinbadversions()
|
---|
333 | #define snmp_inc_snmpinbadcommunitynames()
|
---|
334 | #define snmp_inc_snmpinbadcommunityuses()
|
---|
335 | #define snmp_inc_snmpinasnparseerrs()
|
---|
336 | #define snmp_inc_snmpintoobigs()
|
---|
337 | #define snmp_inc_snmpinnosuchnames()
|
---|
338 | #define snmp_inc_snmpinbadvalues()
|
---|
339 | #define snmp_inc_snmpinreadonlys()
|
---|
340 | #define snmp_inc_snmpingenerrs()
|
---|
341 | #define snmp_add_snmpintotalreqvars(value)
|
---|
342 | #define snmp_add_snmpintotalsetvars(value)
|
---|
343 | #define snmp_inc_snmpingetrequests()
|
---|
344 | #define snmp_inc_snmpingetnexts()
|
---|
345 | #define snmp_inc_snmpinsetrequests()
|
---|
346 | #define snmp_inc_snmpingetresponses()
|
---|
347 | #define snmp_inc_snmpintraps()
|
---|
348 | #define snmp_inc_snmpouttoobigs()
|
---|
349 | #define snmp_inc_snmpoutnosuchnames()
|
---|
350 | #define snmp_inc_snmpoutbadvalues()
|
---|
351 | #define snmp_inc_snmpoutgenerrs()
|
---|
352 | #define snmp_inc_snmpoutgetrequests()
|
---|
353 | #define snmp_inc_snmpoutgetnexts()
|
---|
354 | #define snmp_inc_snmpoutsetrequests()
|
---|
355 | #define snmp_inc_snmpoutgetresponses()
|
---|
356 | #define snmp_inc_snmpouttraps()
|
---|
357 | #define snmp_get_snmpgrpid_ptr(oid)
|
---|
358 | #define snmp_set_snmpenableauthentraps(value)
|
---|
359 | #define snmp_get_snmpenableauthentraps(value)
|
---|
360 |
|
---|
361 | #endif /* LWIP_SNMP */
|
---|
362 |
|
---|
363 | #ifdef __cplusplus
|
---|
364 | }
|
---|
365 | #endif
|
---|
366 |
|
---|
367 | #endif /* __LWIP_SNMP_H__ */
|
---|