git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/include/lwip/snmp_structs.h

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