Hendrik Lipka / NetServicesMin

Stripped down version of Segundos NetService library (http://mbed.org/users/segundo/libraries/NetServices ). I have removed all NetServices, and all functions which had been disabled. Use this version when you need only pure TCP or UDP functions - this library compiles faster.

Dependencies:   lwip lwip-sys

Dependents:   christmasLights device_server pop3demo device_server_udp ... more

lwip/include/lwip/snmp_structs.h@0:8b387bed54c2, 2011-01-10 (annotated)

Committer:
hlipka
Date:
Mon Jan 10 21:03:11 2011 +0000
Revision:
0:8b387bed54c2
initial version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hlipka 0:8b387bed54c2 1 /**
hlipka 0:8b387bed54c2 2 * @file
hlipka 0:8b387bed54c2 3 * Generic MIB tree structures.
hlipka 0:8b387bed54c2 4 *
hlipka 0:8b387bed54c2 5 * @todo namespace prefixes
hlipka 0:8b387bed54c2 6 */
hlipka 0:8b387bed54c2 7
hlipka 0:8b387bed54c2 8 /*
hlipka 0:8b387bed54c2 9 * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands.
hlipka 0:8b387bed54c2 10 * All rights reserved.
hlipka 0:8b387bed54c2 11 *
hlipka 0:8b387bed54c2 12 * Redistribution and use in source and binary forms, with or without modification,
hlipka 0:8b387bed54c2 13 * are permitted provided that the following conditions are met:
hlipka 0:8b387bed54c2 14 *
hlipka 0:8b387bed54c2 15 * 1. Redistributions of source code must retain the above copyright notice,
hlipka 0:8b387bed54c2 16 * this list of conditions and the following disclaimer.
hlipka 0:8b387bed54c2 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
hlipka 0:8b387bed54c2 18 * this list of conditions and the following disclaimer in the documentation
hlipka 0:8b387bed54c2 19 * and/or other materials provided with the distribution.
hlipka 0:8b387bed54c2 20 * 3. The name of the author may not be used to endorse or promote products
hlipka 0:8b387bed54c2 21 * derived from this software without specific prior written permission.
hlipka 0:8b387bed54c2 22 *
hlipka 0:8b387bed54c2 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
hlipka 0:8b387bed54c2 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
hlipka 0:8b387bed54c2 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
hlipka 0:8b387bed54c2 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
hlipka 0:8b387bed54c2 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
hlipka 0:8b387bed54c2 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
hlipka 0:8b387bed54c2 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
hlipka 0:8b387bed54c2 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
hlipka 0:8b387bed54c2 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
hlipka 0:8b387bed54c2 32 * OF SUCH DAMAGE.
hlipka 0:8b387bed54c2 33 *
hlipka 0:8b387bed54c2 34 * Author: Christiaan Simons <christiaan.simons@axon.tv>
hlipka 0:8b387bed54c2 35 */
hlipka 0:8b387bed54c2 36
hlipka 0:8b387bed54c2 37 #ifndef __LWIP_SNMP_STRUCTS_H__
hlipka 0:8b387bed54c2 38 #define __LWIP_SNMP_STRUCTS_H__
hlipka 0:8b387bed54c2 39
hlipka 0:8b387bed54c2 40 #include "lwip/opt.h"
hlipka 0:8b387bed54c2 41
hlipka 0:8b387bed54c2 42 #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
hlipka 0:8b387bed54c2 43
hlipka 0:8b387bed54c2 44 #include "lwip/snmp.h"
hlipka 0:8b387bed54c2 45
hlipka 0:8b387bed54c2 46 #if SNMP_PRIVATE_MIB
hlipka 0:8b387bed54c2 47 /* When using a private MIB, you have to create a file 'private_mib.h' that contains
hlipka 0:8b387bed54c2 48 * a 'struct mib_array_node mib_private' which contains your MIB. */
hlipka 0:8b387bed54c2 49 #include "private_mib.h"
hlipka 0:8b387bed54c2 50 #endif
hlipka 0:8b387bed54c2 51
hlipka 0:8b387bed54c2 52 #ifdef __cplusplus
hlipka 0:8b387bed54c2 53 extern "C" {
hlipka 0:8b387bed54c2 54 #endif
hlipka 0:8b387bed54c2 55
hlipka 0:8b387bed54c2 56 /* MIB object instance */
hlipka 0:8b387bed54c2 57 #define MIB_OBJECT_NONE 0
hlipka 0:8b387bed54c2 58 #define MIB_OBJECT_SCALAR 1
hlipka 0:8b387bed54c2 59 #define MIB_OBJECT_TAB 2
hlipka 0:8b387bed54c2 60
hlipka 0:8b387bed54c2 61 /* MIB access types */
hlipka 0:8b387bed54c2 62 #define MIB_ACCESS_READ 1
hlipka 0:8b387bed54c2 63 #define MIB_ACCESS_WRITE 2
hlipka 0:8b387bed54c2 64
hlipka 0:8b387bed54c2 65 /* MIB object access */
hlipka 0:8b387bed54c2 66 #define MIB_OBJECT_READ_ONLY MIB_ACCESS_READ
hlipka 0:8b387bed54c2 67 #define MIB_OBJECT_READ_WRITE (MIB_ACCESS_READ | MIB_ACCESS_WRITE)
hlipka 0:8b387bed54c2 68 #define MIB_OBJECT_WRITE_ONLY MIB_ACCESS_WRITE
hlipka 0:8b387bed54c2 69 #define MIB_OBJECT_NOT_ACCESSIBLE 0
hlipka 0:8b387bed54c2 70
hlipka 0:8b387bed54c2 71 /** object definition returned by (get_object_def)() */
hlipka 0:8b387bed54c2 72 struct obj_def
hlipka 0:8b387bed54c2 73 {
hlipka 0:8b387bed54c2 74 /* MIB_OBJECT_NONE (0), MIB_OBJECT_SCALAR (1), MIB_OBJECT_TAB (2) */
hlipka 0:8b387bed54c2 75 u8_t instance;
hlipka 0:8b387bed54c2 76 /* 0 read-only, 1 read-write, 2 write-only, 3 not-accessible */
hlipka 0:8b387bed54c2 77 u8_t access;
hlipka 0:8b387bed54c2 78 /* ASN type for this object */
hlipka 0:8b387bed54c2 79 u8_t asn_type;
hlipka 0:8b387bed54c2 80 /* value length (host length) */
hlipka 0:8b387bed54c2 81 u16_t v_len;
hlipka 0:8b387bed54c2 82 /* length of instance part of supplied object identifier */
hlipka 0:8b387bed54c2 83 u8_t id_inst_len;
hlipka 0:8b387bed54c2 84 /* instance part of supplied object identifier */
hlipka 0:8b387bed54c2 85 s32_t *id_inst_ptr;
hlipka 0:8b387bed54c2 86 };
hlipka 0:8b387bed54c2 87
hlipka 0:8b387bed54c2 88 struct snmp_name_ptr
hlipka 0:8b387bed54c2 89 {
hlipka 0:8b387bed54c2 90 u8_t ident_len;
hlipka 0:8b387bed54c2 91 s32_t *ident;
hlipka 0:8b387bed54c2 92 };
hlipka 0:8b387bed54c2 93
hlipka 0:8b387bed54c2 94 /** MIB const scalar (.0) node */
hlipka 0:8b387bed54c2 95 #define MIB_NODE_SC 0x01
hlipka 0:8b387bed54c2 96 /** MIB const array node */
hlipka 0:8b387bed54c2 97 #define MIB_NODE_AR 0x02
hlipka 0:8b387bed54c2 98 /** MIB array node (mem_malloced from RAM) */
hlipka 0:8b387bed54c2 99 #define MIB_NODE_RA 0x03
hlipka 0:8b387bed54c2 100 /** MIB list root node (mem_malloced from RAM) */
hlipka 0:8b387bed54c2 101 #define MIB_NODE_LR 0x04
hlipka 0:8b387bed54c2 102 /** MIB node for external objects */
hlipka 0:8b387bed54c2 103 #define MIB_NODE_EX 0x05
hlipka 0:8b387bed54c2 104
hlipka 0:8b387bed54c2 105 /** node "base class" layout, the mandatory fields for a node */
hlipka 0:8b387bed54c2 106 struct mib_node
hlipka 0:8b387bed54c2 107 {
hlipka 0:8b387bed54c2 108 /** returns struct obj_def for the given object identifier */
hlipka 0:8b387bed54c2 109 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 110 /** returns object value for the given object identifier,
hlipka 0:8b387bed54c2 111 @note the caller must allocate at least len bytes for the value */
hlipka 0:8b387bed54c2 112 void (*get_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 113 /** tests length and/or range BEFORE setting */
hlipka 0:8b387bed54c2 114 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 115 /** sets object value, only to be called when set_test() */
hlipka 0:8b387bed54c2 116 void (*set_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 117 /** One out of MIB_NODE_AR, MIB_NODE_LR or MIB_NODE_EX */
hlipka 0:8b387bed54c2 118 u8_t node_type;
hlipka 0:8b387bed54c2 119 /* array or max list length */
hlipka 0:8b387bed54c2 120 u16_t maxlength;
hlipka 0:8b387bed54c2 121 };
hlipka 0:8b387bed54c2 122
hlipka 0:8b387bed54c2 123 /** derived node for scalars .0 index */
hlipka 0:8b387bed54c2 124 typedef struct mib_node mib_scalar_node;
hlipka 0:8b387bed54c2 125
hlipka 0:8b387bed54c2 126 /** derived node, points to a fixed size const array
hlipka 0:8b387bed54c2 127 of sub-identifiers plus a 'child' pointer */
hlipka 0:8b387bed54c2 128 struct mib_array_node
hlipka 0:8b387bed54c2 129 {
hlipka 0:8b387bed54c2 130 /* inherited "base class" members */
hlipka 0:8b387bed54c2 131 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 132 void (*get_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 133 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 134 void (*set_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 135
hlipka 0:8b387bed54c2 136 u8_t node_type;
hlipka 0:8b387bed54c2 137 u16_t maxlength;
hlipka 0:8b387bed54c2 138
hlipka 0:8b387bed54c2 139 /* additional struct members */
hlipka 0:8b387bed54c2 140 const s32_t *objid;
hlipka 0:8b387bed54c2 141 struct mib_node* const *nptr;
hlipka 0:8b387bed54c2 142 };
hlipka 0:8b387bed54c2 143
hlipka 0:8b387bed54c2 144 /** derived node, points to a fixed size mem_malloced array
hlipka 0:8b387bed54c2 145 of sub-identifiers plus a 'child' pointer */
hlipka 0:8b387bed54c2 146 struct mib_ram_array_node
hlipka 0:8b387bed54c2 147 {
hlipka 0:8b387bed54c2 148 /* inherited "base class" members */
hlipka 0:8b387bed54c2 149 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 150 void (*get_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 151 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 152 void (*set_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 153
hlipka 0:8b387bed54c2 154 u8_t node_type;
hlipka 0:8b387bed54c2 155 u16_t maxlength;
hlipka 0:8b387bed54c2 156
hlipka 0:8b387bed54c2 157 /* aditional struct members */
hlipka 0:8b387bed54c2 158 s32_t *objid;
hlipka 0:8b387bed54c2 159 struct mib_node **nptr;
hlipka 0:8b387bed54c2 160 };
hlipka 0:8b387bed54c2 161
hlipka 0:8b387bed54c2 162 struct mib_list_node
hlipka 0:8b387bed54c2 163 {
hlipka 0:8b387bed54c2 164 struct mib_list_node *prev;
hlipka 0:8b387bed54c2 165 struct mib_list_node *next;
hlipka 0:8b387bed54c2 166 s32_t objid;
hlipka 0:8b387bed54c2 167 struct mib_node *nptr;
hlipka 0:8b387bed54c2 168 };
hlipka 0:8b387bed54c2 169
hlipka 0:8b387bed54c2 170 /** derived node, points to a doubly linked list
hlipka 0:8b387bed54c2 171 of sub-identifiers plus a 'child' pointer */
hlipka 0:8b387bed54c2 172 struct mib_list_rootnode
hlipka 0:8b387bed54c2 173 {
hlipka 0:8b387bed54c2 174 /* inherited "base class" members */
hlipka 0:8b387bed54c2 175 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 176 void (*get_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 177 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 178 void (*set_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 179
hlipka 0:8b387bed54c2 180 u8_t node_type;
hlipka 0:8b387bed54c2 181 u16_t maxlength;
hlipka 0:8b387bed54c2 182
hlipka 0:8b387bed54c2 183 /* additional struct members */
hlipka 0:8b387bed54c2 184 struct mib_list_node *head;
hlipka 0:8b387bed54c2 185 struct mib_list_node *tail;
hlipka 0:8b387bed54c2 186 /* counts list nodes in list */
hlipka 0:8b387bed54c2 187 u16_t count;
hlipka 0:8b387bed54c2 188 };
hlipka 0:8b387bed54c2 189
hlipka 0:8b387bed54c2 190 /** derived node, has access functions for mib object in external memory or device
hlipka 0:8b387bed54c2 191 using 'tree_level' and 'idx', with a range 0 .. (level_length() - 1) */
hlipka 0:8b387bed54c2 192 struct mib_external_node
hlipka 0:8b387bed54c2 193 {
hlipka 0:8b387bed54c2 194 /* inherited "base class" members */
hlipka 0:8b387bed54c2 195 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 196 void (*get_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 197 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 198 void (*set_value)(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 199
hlipka 0:8b387bed54c2 200 u8_t node_type;
hlipka 0:8b387bed54c2 201 u16_t maxlength;
hlipka 0:8b387bed54c2 202
hlipka 0:8b387bed54c2 203 /* additional struct members */
hlipka 0:8b387bed54c2 204 /** points to an external (in memory) record of some sort of addressing
hlipka 0:8b387bed54c2 205 information, passed to and interpreted by the funtions below */
hlipka 0:8b387bed54c2 206 void* addr_inf;
hlipka 0:8b387bed54c2 207 /** tree levels under this node */
hlipka 0:8b387bed54c2 208 u8_t tree_levels;
hlipka 0:8b387bed54c2 209 /** number of objects at this level */
hlipka 0:8b387bed54c2 210 u16_t (*level_length)(void* addr_inf, u8_t level);
hlipka 0:8b387bed54c2 211 /** compares object sub identifier with external id
hlipka 0:8b387bed54c2 212 return zero when equal, nonzero when unequal */
hlipka 0:8b387bed54c2 213 s32_t (*ident_cmp)(void* addr_inf, u8_t level, u16_t idx, s32_t sub_id);
hlipka 0:8b387bed54c2 214 void (*get_objid)(void* addr_inf, u8_t level, u16_t idx, s32_t *sub_id);
hlipka 0:8b387bed54c2 215
hlipka 0:8b387bed54c2 216 /** async Questions */
hlipka 0:8b387bed54c2 217 void (*get_object_def_q)(void* addr_inf, u8_t rid, u8_t ident_len, s32_t *ident);
hlipka 0:8b387bed54c2 218 void (*get_value_q)(u8_t rid, struct obj_def *od);
hlipka 0:8b387bed54c2 219 void (*set_test_q)(u8_t rid, struct obj_def *od);
hlipka 0:8b387bed54c2 220 void (*set_value_q)(u8_t rid, struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 221 /** async Answers */
hlipka 0:8b387bed54c2 222 void (*get_object_def_a)(u8_t rid, u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 223 void (*get_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 224 u8_t (*set_test_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 225 void (*set_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 226 /** async Panic Close (agent returns error reply,
hlipka 0:8b387bed54c2 227 e.g. used for external transaction cleanup) */
hlipka 0:8b387bed54c2 228 void (*get_object_def_pc)(u8_t rid, u8_t ident_len, s32_t *ident);
hlipka 0:8b387bed54c2 229 void (*get_value_pc)(u8_t rid, struct obj_def *od);
hlipka 0:8b387bed54c2 230 void (*set_test_pc)(u8_t rid, struct obj_def *od);
hlipka 0:8b387bed54c2 231 void (*set_value_pc)(u8_t rid, struct obj_def *od);
hlipka 0:8b387bed54c2 232 };
hlipka 0:8b387bed54c2 233
hlipka 0:8b387bed54c2 234 /** export MIB tree from mib2.c */
hlipka 0:8b387bed54c2 235 extern const struct mib_array_node internet;
hlipka 0:8b387bed54c2 236
hlipka 0:8b387bed54c2 237 /** dummy function pointers for non-leaf MIB nodes from mib2.c */
hlipka 0:8b387bed54c2 238 void noleafs_get_object_def(u8_t ident_len, s32_t *ident, struct obj_def *od);
hlipka 0:8b387bed54c2 239 void noleafs_get_value(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 240 u8_t noleafs_set_test(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 241 void noleafs_set_value(struct obj_def *od, u16_t len, void *value);
hlipka 0:8b387bed54c2 242
hlipka 0:8b387bed54c2 243 void snmp_oidtoip(s32_t *ident, ip_addr_t *ip);
hlipka 0:8b387bed54c2 244 void snmp_iptooid(ip_addr_t *ip, s32_t *ident);
hlipka 0:8b387bed54c2 245 void snmp_ifindextonetif(s32_t ifindex, struct netif **netif);
hlipka 0:8b387bed54c2 246 void snmp_netiftoifindex(struct netif *netif, s32_t *ifidx);
hlipka 0:8b387bed54c2 247
hlipka 0:8b387bed54c2 248 struct mib_list_node* snmp_mib_ln_alloc(s32_t id);
hlipka 0:8b387bed54c2 249 void snmp_mib_ln_free(struct mib_list_node *ln);
hlipka 0:8b387bed54c2 250 struct mib_list_rootnode* snmp_mib_lrn_alloc(void);
hlipka 0:8b387bed54c2 251 void snmp_mib_lrn_free(struct mib_list_rootnode *lrn);
hlipka 0:8b387bed54c2 252
hlipka 0:8b387bed54c2 253 s8_t snmp_mib_node_insert(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **insn);
hlipka 0:8b387bed54c2 254 s8_t snmp_mib_node_find(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **fn);
hlipka 0:8b387bed54c2 255 struct mib_list_rootnode *snmp_mib_node_delete(struct mib_list_rootnode *rn, struct mib_list_node *n);
hlipka 0:8b387bed54c2 256
hlipka 0:8b387bed54c2 257 struct mib_node* snmp_search_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_name_ptr *np);
hlipka 0:8b387bed54c2 258 struct mib_node* snmp_expand_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);
hlipka 0:8b387bed54c2 259 u8_t snmp_iso_prefix_tst(u8_t ident_len, s32_t *ident);
hlipka 0:8b387bed54c2 260 u8_t snmp_iso_prefix_expand(u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);
hlipka 0:8b387bed54c2 261
hlipka 0:8b387bed54c2 262 #ifdef __cplusplus
hlipka 0:8b387bed54c2 263 }
hlipka 0:8b387bed54c2 264 #endif
hlipka 0:8b387bed54c2 265
hlipka 0:8b387bed54c2 266 #endif /* LWIP_SNMP */
hlipka 0:8b387bed54c2 267
hlipka 0:8b387bed54c2 268 #endif /* __LWIP_SNMP_STRUCTS_H__ */