Dependents:   SNMPAgent HTTPServer think_speak_a cyassl-client ... more

Committer:
mamezu
Date:
Thu Dec 09 01:33:56 2010 +0000
Revision:
0:0f6c82fcde82

        

Who changed what in which revision?

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