Rod Coleman / lwip-mbed-2010

Port of LwIP performed by Ralf in 2010. Not recommended for use with recent mbed libraries, but good demos of raw LwIP possible

Dependents:   LwIP_raw_API_serverExample tiny-dtls

Core/lwIP/include/lwip/snmp_structs.h@0:0791c1fece8e, 2012-09-18 (annotated)

Committer:
RodColeman
Date:
Tue Sep 18 14:41:24 2012 +0000
Revision:
0:0791c1fece8e
[mbed] converted /Eth_TCP_Wei_Server/lwip

Who changed what in which revision?

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