FBI FRATER / Mbed 2 deprecated InetTest

Dependencies:   mbed

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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