Daniel Peter / Net

lwip/include/lwip/snmp_structs.h@0:d616ece2d859, 2010-09-18 (annotated)

Committer:
mbed714
Date:
Sat Sep 18 23:05:49 2010 +0000
Revision:
0:d616ece2d859

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


mbed714

0:d616ece2d859


     1

/**





mbed714

0:d616ece2d859


     2

 * @file





mbed714

0:d616ece2d859


     3

 * Generic MIB tree structures.





mbed714

0:d616ece2d859


     4

 *





mbed714

0:d616ece2d859


     5

 * @todo namespace prefixes





mbed714

0:d616ece2d859


     6

 */





mbed714

0:d616ece2d859


     7







mbed714

0:d616ece2d859


     8

/*





mbed714

0:d616ece2d859


     9

 * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands.





mbed714

0:d616ece2d859


    10

 * All rights reserved.





mbed714

0:d616ece2d859


    11

 *





mbed714

0:d616ece2d859


    12

 * Redistribution and use in source and binary forms, with or without modification,





mbed714

0:d616ece2d859


    13

 * are permitted provided that the following conditions are met:





mbed714

0:d616ece2d859


    14

 *





mbed714

0:d616ece2d859


    15

 * 1. Redistributions of source code must retain the above copyright notice,





mbed714

0:d616ece2d859


    16

 *    this list of conditions and the following disclaimer.





mbed714

0:d616ece2d859


    17

 * 2. Redistributions in binary form must reproduce the above copyright notice,





mbed714

0:d616ece2d859


    18

 *    this list of conditions and the following disclaimer in the documentation





mbed714

0:d616ece2d859


    19

 *    and/or other materials provided with the distribution.





mbed714

0:d616ece2d859


    20

 * 3. The name of the author may not be used to endorse or promote products





mbed714

0:d616ece2d859


    21

 *    derived from this software without specific prior written permission.





mbed714

0:d616ece2d859


    22

 *





mbed714

0:d616ece2d859


    23

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED





mbed714

0:d616ece2d859


    24

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF





mbed714

0:d616ece2d859


    25

 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT





mbed714

0:d616ece2d859


    26

 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,





mbed714

0:d616ece2d859


    27

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT





mbed714

0:d616ece2d859


    28

 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS





mbed714

0:d616ece2d859


    29

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN





mbed714

0:d616ece2d859


    30

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING





mbed714

0:d616ece2d859


    31

 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY





mbed714

0:d616ece2d859


    32

 * OF SUCH DAMAGE.





mbed714

0:d616ece2d859


    33

 *





mbed714

0:d616ece2d859


    34

 * Author: Christiaan Simons <christiaan.simons@axon.tv>





mbed714

0:d616ece2d859


    35

 */





mbed714

0:d616ece2d859


    36







mbed714

0:d616ece2d859


    37

#ifndef __LWIP_SNMP_STRUCTS_H__





mbed714

0:d616ece2d859


    38

#define __LWIP_SNMP_STRUCTS_H__





mbed714

0:d616ece2d859


    39







mbed714

0:d616ece2d859


    40

#include "lwip/opt.h"





mbed714

0:d616ece2d859


    41







mbed714

0:d616ece2d859


    42

#if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */





mbed714

0:d616ece2d859


    43







mbed714

0:d616ece2d859


    44

#include "lwip/snmp.h"





mbed714

0:d616ece2d859


    45







mbed714

0:d616ece2d859


    46

#if SNMP_PRIVATE_MIB





mbed714

0:d616ece2d859


    47

/* When using a private MIB, you have to create a file 'private_mib.h' that contains





mbed714

0:d616ece2d859


    48

 * a 'struct mib_array_node mib_private' which contains your MIB. */





mbed714

0:d616ece2d859


    49

#include "private_mib.h"





mbed714

0:d616ece2d859


    50

#endif





mbed714

0:d616ece2d859


    51







mbed714

0:d616ece2d859


    52

#ifdef __cplusplus





mbed714

0:d616ece2d859


    53

extern "C" {





mbed714

0:d616ece2d859


    54

#endif





mbed714

0:d616ece2d859


    55







mbed714

0:d616ece2d859


    56

/* MIB object instance */





mbed714

0:d616ece2d859


    57

#define MIB_OBJECT_NONE 0 





mbed714

0:d616ece2d859


    58

#define MIB_OBJECT_SCALAR 1





mbed714

0:d616ece2d859


    59

#define MIB_OBJECT_TAB 2





mbed714

0:d616ece2d859


    60







mbed714

0:d616ece2d859


    61

/* MIB access types */





mbed714

0:d616ece2d859


    62

#define MIB_ACCESS_READ   1





mbed714

0:d616ece2d859


    63

#define MIB_ACCESS_WRITE  2





mbed714

0:d616ece2d859


    64







mbed714

0:d616ece2d859


    65

/* MIB object access */





mbed714

0:d616ece2d859


    66

#define MIB_OBJECT_READ_ONLY      MIB_ACCESS_READ





mbed714

0:d616ece2d859


    67

#define MIB_OBJECT_READ_WRITE     (MIB_ACCESS_READ | MIB_ACCESS_WRITE)





mbed714

0:d616ece2d859


    68

#define MIB_OBJECT_WRITE_ONLY     MIB_ACCESS_WRITE





mbed714

0:d616ece2d859


    69

#define MIB_OBJECT_NOT_ACCESSIBLE 0





mbed714

0:d616ece2d859


    70







mbed714

0:d616ece2d859


    71

/** object definition returned by (get_object_def)() */





mbed714

0:d616ece2d859


    72

struct obj_def





mbed714

0:d616ece2d859


    73

{





mbed714

0:d616ece2d859


    74

  /* MIB_OBJECT_NONE (0), MIB_OBJECT_SCALAR (1), MIB_OBJECT_TAB (2) */





mbed714

0:d616ece2d859


    75

  u8_t instance;





mbed714

0:d616ece2d859


    76

  /* 0 read-only, 1 read-write, 2 write-only, 3 not-accessible */





mbed714

0:d616ece2d859


    77

  u8_t access;





mbed714

0:d616ece2d859


    78

  /* ASN type for this object */





mbed714

0:d616ece2d859


    79

  u8_t asn_type;





mbed714

0:d616ece2d859


    80

  /* value length (host length) */





mbed714

0:d616ece2d859


    81

  u16_t v_len;





mbed714

0:d616ece2d859


    82

  /* length of instance part of supplied object identifier */





mbed714

0:d616ece2d859


    83

  u8_t  id_inst_len;





mbed714

0:d616ece2d859


    84

  /* instance part of supplied object identifier */





mbed714

0:d616ece2d859


    85

  s32_t *id_inst_ptr;





mbed714

0:d616ece2d859


    86

};





mbed714

0:d616ece2d859


    87







mbed714

0:d616ece2d859


    88

struct snmp_name_ptr





mbed714

0:d616ece2d859


    89

{





mbed714

0:d616ece2d859


    90

  u8_t ident_len;





mbed714

0:d616ece2d859


    91

  s32_t *ident;





mbed714

0:d616ece2d859


    92

};





mbed714

0:d616ece2d859


    93







mbed714

0:d616ece2d859


    94

/** MIB const scalar (.0) node */





mbed714

0:d616ece2d859


    95

#define MIB_NODE_SC 0x01





mbed714

0:d616ece2d859


    96

/** MIB const array node */





mbed714

0:d616ece2d859


    97

#define MIB_NODE_AR 0x02





mbed714

0:d616ece2d859


    98

/** MIB array node (mem_malloced from RAM) */





mbed714

0:d616ece2d859


    99

#define MIB_NODE_RA 0x03





mbed714

0:d616ece2d859


   100

/** MIB list root node (mem_malloced from RAM) */





mbed714

0:d616ece2d859


   101

#define MIB_NODE_LR 0x04





mbed714

0:d616ece2d859


   102

/** MIB node for external objects */





mbed714

0:d616ece2d859


   103

#define MIB_NODE_EX 0x05





mbed714

0:d616ece2d859


   104







mbed714

0:d616ece2d859


   105

/** node "base class" layout, the mandatory fields for a node  */





mbed714

0:d616ece2d859


   106

struct mib_node





mbed714

0:d616ece2d859


   107

{





mbed714

0:d616ece2d859


   108

  /** returns struct obj_def for the given object identifier */





mbed714

0:d616ece2d859


   109

  void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   110

  /** returns object value for the given object identifier,





mbed714

0:d616ece2d859


   111

     @note the caller must allocate at least len bytes for the value */





mbed714

0:d616ece2d859


   112

  void (*get_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   113

  /** tests length and/or range BEFORE setting */





mbed714

0:d616ece2d859


   114

  u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   115

  /** sets object value, only to be called when set_test()  */





mbed714

0:d616ece2d859


   116

  void (*set_value)(struct obj_def *od, u16_t len, void *value);  





mbed714

0:d616ece2d859


   117

  /** One out of MIB_NODE_AR, MIB_NODE_LR or MIB_NODE_EX */





mbed714

0:d616ece2d859


   118

  u8_t node_type;





mbed714

0:d616ece2d859


   119

  /* array or max list length */





mbed714

0:d616ece2d859


   120

  u16_t maxlength;





mbed714

0:d616ece2d859


   121

};





mbed714

0:d616ece2d859


   122







mbed714

0:d616ece2d859


   123

/** derived node for scalars .0 index */





mbed714

0:d616ece2d859


   124

typedef struct mib_node mib_scalar_node;





mbed714

0:d616ece2d859


   125







mbed714

0:d616ece2d859


   126

/** derived node, points to a fixed size const array





mbed714

0:d616ece2d859


   127

    of sub-identifiers plus a 'child' pointer */





mbed714

0:d616ece2d859


   128

struct mib_array_node





mbed714

0:d616ece2d859


   129

{





mbed714

0:d616ece2d859


   130

  /* inherited "base class" members */





mbed714

0:d616ece2d859


   131

  void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   132

  void (*get_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   133

  u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   134

  void (*set_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   135







mbed714

0:d616ece2d859


   136

  u8_t node_type;





mbed714

0:d616ece2d859


   137

  u16_t maxlength;





mbed714

0:d616ece2d859


   138







mbed714

0:d616ece2d859


   139

  /* additional struct members */





mbed714

0:d616ece2d859


   140

  const s32_t *objid;





mbed714

0:d616ece2d859


   141

  struct mib_node* const *nptr;





mbed714

0:d616ece2d859


   142

};





mbed714

0:d616ece2d859


   143







mbed714

0:d616ece2d859


   144

/** derived node, points to a fixed size mem_malloced array





mbed714

0:d616ece2d859


   145

    of sub-identifiers plus a 'child' pointer */





mbed714

0:d616ece2d859


   146

struct mib_ram_array_node





mbed714

0:d616ece2d859


   147

{





mbed714

0:d616ece2d859


   148

  /* inherited "base class" members */





mbed714

0:d616ece2d859


   149

  void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   150

  void (*get_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   151

  u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   152

  void (*set_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   153







mbed714

0:d616ece2d859


   154

  u8_t node_type;





mbed714

0:d616ece2d859


   155

  u16_t maxlength;





mbed714

0:d616ece2d859


   156







mbed714

0:d616ece2d859


   157

  /* aditional struct members */





mbed714

0:d616ece2d859


   158

  s32_t *objid;





mbed714

0:d616ece2d859


   159

  struct mib_node **nptr;





mbed714

0:d616ece2d859


   160

};





mbed714

0:d616ece2d859


   161







mbed714

0:d616ece2d859


   162

struct mib_list_node





mbed714

0:d616ece2d859


   163

{





mbed714

0:d616ece2d859


   164

  struct mib_list_node *prev;  





mbed714

0:d616ece2d859


   165

  struct mib_list_node *next;





mbed714

0:d616ece2d859


   166

  s32_t objid;





mbed714

0:d616ece2d859


   167

  struct mib_node *nptr;





mbed714

0:d616ece2d859


   168

};





mbed714

0:d616ece2d859


   169







mbed714

0:d616ece2d859


   170

/** derived node, points to a doubly linked list





mbed714

0:d616ece2d859


   171

    of sub-identifiers plus a 'child' pointer */





mbed714

0:d616ece2d859


   172

struct mib_list_rootnode





mbed714

0:d616ece2d859


   173

{





mbed714

0:d616ece2d859


   174

  /* inherited "base class" members */





mbed714

0:d616ece2d859


   175

  void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   176

  void (*get_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   177

  u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   178

  void (*set_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   179







mbed714

0:d616ece2d859


   180

  u8_t node_type;





mbed714

0:d616ece2d859


   181

  u16_t maxlength;





mbed714

0:d616ece2d859


   182







mbed714

0:d616ece2d859


   183

  /* additional struct members */





mbed714

0:d616ece2d859


   184

  struct mib_list_node *head;





mbed714

0:d616ece2d859


   185

  struct mib_list_node *tail;





mbed714

0:d616ece2d859


   186

  /* counts list nodes in list  */





mbed714

0:d616ece2d859


   187

  u16_t count;





mbed714

0:d616ece2d859


   188

};





mbed714

0:d616ece2d859


   189







mbed714

0:d616ece2d859


   190

/** derived node, has access functions for mib object in external memory or device





mbed714

0:d616ece2d859


   191

    using 'tree_level' and 'idx', with a range 0 .. (level_length() - 1) */





mbed714

0:d616ece2d859


   192

struct mib_external_node





mbed714

0:d616ece2d859


   193

{





mbed714

0:d616ece2d859


   194

  /* inherited "base class" members */





mbed714

0:d616ece2d859


   195

  void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   196

  void (*get_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   197

  u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   198

  void (*set_value)(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   199







mbed714

0:d616ece2d859


   200

  u8_t node_type;





mbed714

0:d616ece2d859


   201

  u16_t maxlength;





mbed714

0:d616ece2d859


   202







mbed714

0:d616ece2d859


   203

  /* additional struct members */





mbed714

0:d616ece2d859


   204

  /** points to an external (in memory) record of some sort of addressing





mbed714

0:d616ece2d859


   205

      information, passed to and interpreted by the funtions below */





mbed714

0:d616ece2d859


   206

  void* addr_inf;





mbed714

0:d616ece2d859


   207

  /** tree levels under this node */





mbed714

0:d616ece2d859


   208

  u8_t tree_levels;





mbed714

0:d616ece2d859


   209

  /** number of objects at this level */





mbed714

0:d616ece2d859


   210

  u16_t (*level_length)(void* addr_inf, u8_t level);





mbed714

0:d616ece2d859


   211

  /** compares object sub identifier with external id





mbed714

0:d616ece2d859


   212

      return zero when equal, nonzero when unequal */





mbed714

0:d616ece2d859


   213

  s32_t (*ident_cmp)(void* addr_inf, u8_t level, u16_t idx, s32_t sub_id);





mbed714

0:d616ece2d859


   214

  void (*get_objid)(void* addr_inf, u8_t level, u16_t idx, s32_t *sub_id);





mbed714

0:d616ece2d859


   215







mbed714

0:d616ece2d859


   216

  /** async Questions */





mbed714

0:d616ece2d859


   217

  void (*get_object_def_q)(void* addr_inf, u8_t rid, u8_t ident_len, s32_t *ident);





mbed714

0:d616ece2d859


   218

  void (*get_value_q)(u8_t rid, struct obj_def *od);





mbed714

0:d616ece2d859


   219

  void (*set_test_q)(u8_t rid, struct obj_def *od);





mbed714

0:d616ece2d859


   220

  void (*set_value_q)(u8_t rid, struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   221

  /** async Answers */





mbed714

0:d616ece2d859


   222

  void (*get_object_def_a)(u8_t rid, u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   223

  void (*get_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   224

  u8_t (*set_test_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   225

  void (*set_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   226

  /** async Panic Close (agent returns error reply, 





mbed714

0:d616ece2d859


   227

      e.g. used for external transaction cleanup) */





mbed714

0:d616ece2d859


   228

  void (*get_object_def_pc)(u8_t rid, u8_t ident_len, s32_t *ident);





mbed714

0:d616ece2d859


   229

  void (*get_value_pc)(u8_t rid, struct obj_def *od);





mbed714

0:d616ece2d859


   230

  void (*set_test_pc)(u8_t rid, struct obj_def *od);





mbed714

0:d616ece2d859


   231

  void (*set_value_pc)(u8_t rid, struct obj_def *od);





mbed714

0:d616ece2d859


   232

};





mbed714

0:d616ece2d859


   233







mbed714

0:d616ece2d859


   234

/** export MIB tree from mib2.c */





mbed714

0:d616ece2d859


   235

extern const struct mib_array_node internet;





mbed714

0:d616ece2d859


   236







mbed714

0:d616ece2d859


   237

/** dummy function pointers for non-leaf MIB nodes from mib2.c */





mbed714

0:d616ece2d859


   238

void noleafs_get_object_def(u8_t ident_len, s32_t *ident, struct obj_def *od);





mbed714

0:d616ece2d859


   239

void noleafs_get_value(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   240

u8_t noleafs_set_test(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   241

void noleafs_set_value(struct obj_def *od, u16_t len, void *value);





mbed714

0:d616ece2d859


   242







mbed714

0:d616ece2d859


   243

void snmp_oidtoip(s32_t *ident, ip_addr_t *ip);





mbed714

0:d616ece2d859


   244

void snmp_iptooid(ip_addr_t *ip, s32_t *ident);





mbed714

0:d616ece2d859


   245

void snmp_ifindextonetif(s32_t ifindex, struct netif **netif);





mbed714

0:d616ece2d859


   246

void snmp_netiftoifindex(struct netif *netif, s32_t *ifidx);





mbed714

0:d616ece2d859


   247







mbed714

0:d616ece2d859


   248

struct mib_list_node* snmp_mib_ln_alloc(s32_t id);





mbed714

0:d616ece2d859


   249

void snmp_mib_ln_free(struct mib_list_node *ln);





mbed714

0:d616ece2d859


   250

struct mib_list_rootnode* snmp_mib_lrn_alloc(void);





mbed714

0:d616ece2d859


   251

void snmp_mib_lrn_free(struct mib_list_rootnode *lrn);





mbed714

0:d616ece2d859


   252







mbed714

0:d616ece2d859


   253

s8_t snmp_mib_node_insert(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **insn);





mbed714

0:d616ece2d859


   254

s8_t snmp_mib_node_find(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **fn);





mbed714

0:d616ece2d859


   255

struct mib_list_rootnode *snmp_mib_node_delete(struct mib_list_rootnode *rn, struct mib_list_node *n);





mbed714

0:d616ece2d859


   256







mbed714

0:d616ece2d859


   257

struct mib_node* snmp_search_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_name_ptr *np);





mbed714

0:d616ece2d859


   258

struct mib_node* snmp_expand_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);





mbed714

0:d616ece2d859


   259

u8_t snmp_iso_prefix_tst(u8_t ident_len, s32_t *ident);





mbed714

0:d616ece2d859


   260

u8_t snmp_iso_prefix_expand(u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);





mbed714

0:d616ece2d859


   261







mbed714

0:d616ece2d859


   262

#ifdef __cplusplus





mbed714

0:d616ece2d859


   263

}





mbed714

0:d616ece2d859


   264

#endif





mbed714

0:d616ece2d859


   265







mbed714

0:d616ece2d859


   266

#endif /* LWIP_SNMP */





mbed714

0:d616ece2d859


   267







mbed714

0:d616ece2d859


   268

#endif /* __LWIP_SNMP_STRUCTS_H__ */