Mihail Stoyanov / HTTPServer

My fork of the HTTPServer (working)

Dependents:   DGWWebServer LAN2

Core/lwIP/include/lwip/snmp_structs.h@0:7a64fbb4069d, 2012-08-06 (annotated)

Committer:
screamer
Date:
Mon Aug 06 09:23:14 2012 +0000
Revision:
0:7a64fbb4069d
[mbed] converted /DGWWebServer/HTTPServer

Who changed what in which revision?

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