Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

lwip/include/lwip/snmp_structs.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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