snmp.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  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. #include "lwip/opt.h"
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. #include "lwip/ip_addr.h"
  40. struct udp_pcb;
  41. struct netif;
  42. /**
  43. * @see RFC1213, "MIB-II, 6. Definitions"
  44. */
  45. enum snmp_ifType {
  46. snmp_ifType_other=1, /* none of the following */
  47. snmp_ifType_regular1822,
  48. snmp_ifType_hdh1822,
  49. snmp_ifType_ddn_x25,
  50. snmp_ifType_rfc877_x25,
  51. snmp_ifType_ethernet_csmacd,
  52. snmp_ifType_iso88023_csmacd,
  53. snmp_ifType_iso88024_tokenBus,
  54. snmp_ifType_iso88025_tokenRing,
  55. snmp_ifType_iso88026_man,
  56. snmp_ifType_starLan,
  57. snmp_ifType_proteon_10Mbit,
  58. snmp_ifType_proteon_80Mbit,
  59. snmp_ifType_hyperchannel,
  60. snmp_ifType_fddi,
  61. snmp_ifType_lapb,
  62. snmp_ifType_sdlc,
  63. snmp_ifType_ds1, /* T-1 */
  64. snmp_ifType_e1, /* european equiv. of T-1 */
  65. snmp_ifType_basicISDN,
  66. snmp_ifType_primaryISDN, /* proprietary serial */
  67. snmp_ifType_propPointToPointSerial,
  68. snmp_ifType_ppp,
  69. snmp_ifType_softwareLoopback,
  70. snmp_ifType_eon, /* CLNP over IP [11] */
  71. snmp_ifType_ethernet_3Mbit,
  72. snmp_ifType_nsip, /* XNS over IP */
  73. snmp_ifType_slip, /* generic SLIP */
  74. snmp_ifType_ultra, /* ULTRA technologies */
  75. snmp_ifType_ds3, /* T-3 */
  76. snmp_ifType_sip, /* SMDS */
  77. snmp_ifType_frame_relay
  78. };
  79. #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
  80. /** SNMP "sysuptime" Interval */
  81. #define SNMP_SYSUPTIME_INTERVAL 10
  82. /** fixed maximum length for object identifier type */
  83. #define LWIP_SNMP_OBJ_ID_LEN 32
  84. /** internal object identifier representation */
  85. struct snmp_obj_id
  86. {
  87. u8_t len;
  88. s32_t id[LWIP_SNMP_OBJ_ID_LEN];
  89. };
  90. /* system */
  91. void snmp_set_sysdesr(u8_t* str, u8_t* len);
  92. void snmp_set_sysobjid(struct snmp_obj_id *oid);
  93. void snmp_get_sysobjid_ptr(struct snmp_obj_id **oid);
  94. void snmp_inc_sysuptime(void);
  95. void snmp_add_sysuptime(u32_t value);
  96. void snmp_get_sysuptime(u32_t *value);
  97. void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen);
  98. void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen);
  99. void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen);
  100. /* network interface */
  101. void snmp_add_ifinoctets(struct netif *ni, u32_t value);
  102. void snmp_inc_ifinucastpkts(struct netif *ni);
  103. void snmp_inc_ifinnucastpkts(struct netif *ni);
  104. void snmp_inc_ifindiscards(struct netif *ni);
  105. void snmp_add_ifoutoctets(struct netif *ni, u32_t value);
  106. void snmp_inc_ifoutucastpkts(struct netif *ni);
  107. void snmp_inc_ifoutnucastpkts(struct netif *ni);
  108. void snmp_inc_ifoutdiscards(struct netif *ni);
  109. void snmp_inc_iflist(void);
  110. void snmp_dec_iflist(void);
  111. /* ARP (for atTable and ipNetToMediaTable) */
  112. void snmp_insert_arpidx_tree(struct netif *ni, ip_addr_t *ip);
  113. void snmp_delete_arpidx_tree(struct netif *ni, ip_addr_t *ip);
  114. /* IP */
  115. void snmp_inc_ipinreceives(void);
  116. void snmp_inc_ipinhdrerrors(void);
  117. void snmp_inc_ipinaddrerrors(void);
  118. void snmp_inc_ipforwdatagrams(void);
  119. void snmp_inc_ipinunknownprotos(void);
  120. void snmp_inc_ipindiscards(void);
  121. void snmp_inc_ipindelivers(void);
  122. void snmp_inc_ipoutrequests(void);
  123. void snmp_inc_ipoutdiscards(void);
  124. void snmp_inc_ipoutnoroutes(void);
  125. void snmp_inc_ipreasmreqds(void);
  126. void snmp_inc_ipreasmoks(void);
  127. void snmp_inc_ipreasmfails(void);
  128. void snmp_inc_ipfragoks(void);
  129. void snmp_inc_ipfragfails(void);
  130. void snmp_inc_ipfragcreates(void);
  131. void snmp_inc_iproutingdiscards(void);
  132. void snmp_insert_ipaddridx_tree(struct netif *ni);
  133. void snmp_delete_ipaddridx_tree(struct netif *ni);
  134. void snmp_insert_iprteidx_tree(u8_t dflt, struct netif *ni);
  135. void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni);
  136. /* ICMP */
  137. void snmp_inc_icmpinmsgs(void);
  138. void snmp_inc_icmpinerrors(void);
  139. void snmp_inc_icmpindestunreachs(void);
  140. void snmp_inc_icmpintimeexcds(void);
  141. void snmp_inc_icmpinparmprobs(void);
  142. void snmp_inc_icmpinsrcquenchs(void);
  143. void snmp_inc_icmpinredirects(void);
  144. void snmp_inc_icmpinechos(void);
  145. void snmp_inc_icmpinechoreps(void);
  146. void snmp_inc_icmpintimestamps(void);
  147. void snmp_inc_icmpintimestampreps(void);
  148. void snmp_inc_icmpinaddrmasks(void);
  149. void snmp_inc_icmpinaddrmaskreps(void);
  150. void snmp_inc_icmpoutmsgs(void);
  151. void snmp_inc_icmpouterrors(void);
  152. void snmp_inc_icmpoutdestunreachs(void);
  153. void snmp_inc_icmpouttimeexcds(void);
  154. void snmp_inc_icmpoutparmprobs(void);
  155. void snmp_inc_icmpoutsrcquenchs(void);
  156. void snmp_inc_icmpoutredirects(void);
  157. void snmp_inc_icmpoutechos(void);
  158. void snmp_inc_icmpoutechoreps(void);
  159. void snmp_inc_icmpouttimestamps(void);
  160. void snmp_inc_icmpouttimestampreps(void);
  161. void snmp_inc_icmpoutaddrmasks(void);
  162. void snmp_inc_icmpoutaddrmaskreps(void);
  163. /* TCP */
  164. void snmp_inc_tcpactiveopens(void);
  165. void snmp_inc_tcppassiveopens(void);
  166. void snmp_inc_tcpattemptfails(void);
  167. void snmp_inc_tcpestabresets(void);
  168. void snmp_inc_tcpinsegs(void);
  169. void snmp_inc_tcpoutsegs(void);
  170. void snmp_inc_tcpretranssegs(void);
  171. void snmp_inc_tcpinerrs(void);
  172. void snmp_inc_tcpoutrsts(void);
  173. /* UDP */
  174. void snmp_inc_udpindatagrams(void);
  175. void snmp_inc_udpnoports(void);
  176. void snmp_inc_udpinerrors(void);
  177. void snmp_inc_udpoutdatagrams(void);
  178. void snmp_insert_udpidx_tree(struct udp_pcb *pcb);
  179. void snmp_delete_udpidx_tree(struct udp_pcb *pcb);
  180. /* SNMP */
  181. void snmp_inc_snmpinpkts(void);
  182. void snmp_inc_snmpoutpkts(void);
  183. void snmp_inc_snmpinbadversions(void);
  184. void snmp_inc_snmpinbadcommunitynames(void);
  185. void snmp_inc_snmpinbadcommunityuses(void);
  186. void snmp_inc_snmpinasnparseerrs(void);
  187. void snmp_inc_snmpintoobigs(void);
  188. void snmp_inc_snmpinnosuchnames(void);
  189. void snmp_inc_snmpinbadvalues(void);
  190. void snmp_inc_snmpinreadonlys(void);
  191. void snmp_inc_snmpingenerrs(void);
  192. void snmp_add_snmpintotalreqvars(u8_t value);
  193. void snmp_add_snmpintotalsetvars(u8_t value);
  194. void snmp_inc_snmpingetrequests(void);
  195. void snmp_inc_snmpingetnexts(void);
  196. void snmp_inc_snmpinsetrequests(void);
  197. void snmp_inc_snmpingetresponses(void);
  198. void snmp_inc_snmpintraps(void);
  199. void snmp_inc_snmpouttoobigs(void);
  200. void snmp_inc_snmpoutnosuchnames(void);
  201. void snmp_inc_snmpoutbadvalues(void);
  202. void snmp_inc_snmpoutgenerrs(void);
  203. void snmp_inc_snmpoutgetrequests(void);
  204. void snmp_inc_snmpoutgetnexts(void);
  205. void snmp_inc_snmpoutsetrequests(void);
  206. void snmp_inc_snmpoutgetresponses(void);
  207. void snmp_inc_snmpouttraps(void);
  208. void snmp_get_snmpgrpid_ptr(struct snmp_obj_id **oid);
  209. void snmp_set_snmpenableauthentraps(u8_t *value);
  210. void snmp_get_snmpenableauthentraps(u8_t *value);
  211. /* LWIP_SNMP support not available */
  212. /* define everything to be empty */
  213. #else
  214. /* system */
  215. #define snmp_set_sysdesr(str, len)
  216. #define snmp_set_sysobjid(oid);
  217. #define snmp_get_sysobjid_ptr(oid)
  218. #define snmp_inc_sysuptime()
  219. #define snmp_add_sysuptime(value)
  220. #define snmp_get_sysuptime(value)
  221. #define snmp_set_syscontact(ocstr, ocstrlen);
  222. #define snmp_set_sysname(ocstr, ocstrlen);
  223. #define snmp_set_syslocation(ocstr, ocstrlen);
  224. /* network interface */
  225. #define snmp_add_ifinoctets(ni,value)
  226. #define snmp_inc_ifinucastpkts(ni)
  227. #define snmp_inc_ifinnucastpkts(ni)
  228. #define snmp_inc_ifindiscards(ni)
  229. #define snmp_add_ifoutoctets(ni,value)
  230. #define snmp_inc_ifoutucastpkts(ni)
  231. #define snmp_inc_ifoutnucastpkts(ni)
  232. #define snmp_inc_ifoutdiscards(ni)
  233. #define snmp_inc_iflist()
  234. #define snmp_dec_iflist()
  235. /* ARP */
  236. #define snmp_insert_arpidx_tree(ni,ip)
  237. #define snmp_delete_arpidx_tree(ni,ip)
  238. /* IP */
  239. #define snmp_inc_ipinreceives()
  240. #define snmp_inc_ipinhdrerrors()
  241. #define snmp_inc_ipinaddrerrors()
  242. #define snmp_inc_ipforwdatagrams()
  243. #define snmp_inc_ipinunknownprotos()
  244. #define snmp_inc_ipindiscards()
  245. #define snmp_inc_ipindelivers()
  246. #define snmp_inc_ipoutrequests()
  247. #define snmp_inc_ipoutdiscards()
  248. #define snmp_inc_ipoutnoroutes()
  249. #define snmp_inc_ipreasmreqds()
  250. #define snmp_inc_ipreasmoks()
  251. #define snmp_inc_ipreasmfails()
  252. #define snmp_inc_ipfragoks()
  253. #define snmp_inc_ipfragfails()
  254. #define snmp_inc_ipfragcreates()
  255. #define snmp_inc_iproutingdiscards()
  256. #define snmp_insert_ipaddridx_tree(ni)
  257. #define snmp_delete_ipaddridx_tree(ni)
  258. #define snmp_insert_iprteidx_tree(dflt, ni)
  259. #define snmp_delete_iprteidx_tree(dflt, ni)
  260. /* ICMP */
  261. #define snmp_inc_icmpinmsgs()
  262. #define snmp_inc_icmpinerrors()
  263. #define snmp_inc_icmpindestunreachs()
  264. #define snmp_inc_icmpintimeexcds()
  265. #define snmp_inc_icmpinparmprobs()
  266. #define snmp_inc_icmpinsrcquenchs()
  267. #define snmp_inc_icmpinredirects()
  268. #define snmp_inc_icmpinechos()
  269. #define snmp_inc_icmpinechoreps()
  270. #define snmp_inc_icmpintimestamps()
  271. #define snmp_inc_icmpintimestampreps()
  272. #define snmp_inc_icmpinaddrmasks()
  273. #define snmp_inc_icmpinaddrmaskreps()
  274. #define snmp_inc_icmpoutmsgs()
  275. #define snmp_inc_icmpouterrors()
  276. #define snmp_inc_icmpoutdestunreachs()
  277. #define snmp_inc_icmpouttimeexcds()
  278. #define snmp_inc_icmpoutparmprobs()
  279. #define snmp_inc_icmpoutsrcquenchs()
  280. #define snmp_inc_icmpoutredirects()
  281. #define snmp_inc_icmpoutechos()
  282. #define snmp_inc_icmpoutechoreps()
  283. #define snmp_inc_icmpouttimestamps()
  284. #define snmp_inc_icmpouttimestampreps()
  285. #define snmp_inc_icmpoutaddrmasks()
  286. #define snmp_inc_icmpoutaddrmaskreps()
  287. /* TCP */
  288. #define snmp_inc_tcpactiveopens()
  289. #define snmp_inc_tcppassiveopens()
  290. #define snmp_inc_tcpattemptfails()
  291. #define snmp_inc_tcpestabresets()
  292. #define snmp_inc_tcpinsegs()
  293. #define snmp_inc_tcpoutsegs()
  294. #define snmp_inc_tcpretranssegs()
  295. #define snmp_inc_tcpinerrs()
  296. #define snmp_inc_tcpoutrsts()
  297. /* UDP */
  298. #define snmp_inc_udpindatagrams()
  299. #define snmp_inc_udpnoports()
  300. #define snmp_inc_udpinerrors()
  301. #define snmp_inc_udpoutdatagrams()
  302. #define snmp_insert_udpidx_tree(pcb)
  303. #define snmp_delete_udpidx_tree(pcb)
  304. /* SNMP */
  305. #define snmp_inc_snmpinpkts()
  306. #define snmp_inc_snmpoutpkts()
  307. #define snmp_inc_snmpinbadversions()
  308. #define snmp_inc_snmpinbadcommunitynames()
  309. #define snmp_inc_snmpinbadcommunityuses()
  310. #define snmp_inc_snmpinasnparseerrs()
  311. #define snmp_inc_snmpintoobigs()
  312. #define snmp_inc_snmpinnosuchnames()
  313. #define snmp_inc_snmpinbadvalues()
  314. #define snmp_inc_snmpinreadonlys()
  315. #define snmp_inc_snmpingenerrs()
  316. #define snmp_add_snmpintotalreqvars(value)
  317. #define snmp_add_snmpintotalsetvars(value)
  318. #define snmp_inc_snmpingetrequests()
  319. #define snmp_inc_snmpingetnexts()
  320. #define snmp_inc_snmpinsetrequests()
  321. #define snmp_inc_snmpingetresponses()
  322. #define snmp_inc_snmpintraps()
  323. #define snmp_inc_snmpouttoobigs()
  324. #define snmp_inc_snmpoutnosuchnames()
  325. #define snmp_inc_snmpoutbadvalues()
  326. #define snmp_inc_snmpoutgenerrs()
  327. #define snmp_inc_snmpoutgetrequests()
  328. #define snmp_inc_snmpoutgetnexts()
  329. #define snmp_inc_snmpoutsetrequests()
  330. #define snmp_inc_snmpoutgetresponses()
  331. #define snmp_inc_snmpouttraps()
  332. #define snmp_get_snmpgrpid_ptr(oid)
  333. #define snmp_set_snmpenableauthentraps(value)
  334. #define snmp_get_snmpenableauthentraps(value)
  335. #endif /* LWIP_SNMP */
  336. #ifdef __cplusplus
  337. }
  338. #endif
  339. #endif /* __LWIP_SNMP_H__ */