This library is deprecated.

Dependents:   HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more

Committer:
donatien
Date:
Thu Aug 05 15:09:22 2010 +0000
Revision:
5:bc7df6da7589
Parent:
0:422060928e37

        

Who changed what in which revision?

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