bruno LARNAUDIE / Mbed 2 deprecated HTTPServer

Dependencies:   mbed

Dependents:   TCP

EthernetNetIf/LPC1768/lwip/include/lwip/snmp_structs.h@0:58c3d014a4e7, 2011-09-06 (annotated)

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


slowness

0:58c3d014a4e7


     1

/**





slowness

0:58c3d014a4e7


     2

 * @file





slowness

0:58c3d014a4e7


     3

 * Generic MIB tree structures.





slowness

0:58c3d014a4e7


     4

 *





slowness

0:58c3d014a4e7


     5

 * @todo namespace prefixes





slowness

0:58c3d014a4e7


     6

 */





slowness

0:58c3d014a4e7


     7







slowness

0:58c3d014a4e7


     8

/*





slowness

0:58c3d014a4e7


     9

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





slowness

0:58c3d014a4e7


    10

 * All rights reserved.





slowness

0:58c3d014a4e7


    11

 *





slowness

0:58c3d014a4e7


    12

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





slowness

0:58c3d014a4e7


    13

 * are permitted provided that the following conditions are met:





slowness

0:58c3d014a4e7


    14

 *





slowness

0:58c3d014a4e7


    15

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





slowness

0:58c3d014a4e7


    16

 *    this list of conditions and the following disclaimer.





slowness

0:58c3d014a4e7


    17

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





slowness

0:58c3d014a4e7


    18

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





slowness

0:58c3d014a4e7


    19

 *    and/or other materials provided with the distribution.





slowness

0:58c3d014a4e7


    20

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





slowness

0:58c3d014a4e7


    21

 *    derived from this software without specific prior written permission.





slowness

0:58c3d014a4e7


    22

 *





slowness

0:58c3d014a4e7


    23

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





slowness

0:58c3d014a4e7


    24

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





slowness

0:58c3d014a4e7


    25

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





slowness

0:58c3d014a4e7


    26

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





slowness

0:58c3d014a4e7


    27

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





slowness

0:58c3d014a4e7


    28

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





slowness

0:58c3d014a4e7


    29

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





slowness

0:58c3d014a4e7


    30

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





slowness

0:58c3d014a4e7


    31

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





slowness

0:58c3d014a4e7


    32

 * OF SUCH DAMAGE.





slowness

0:58c3d014a4e7


    33

 *





slowness

0:58c3d014a4e7


    34

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





slowness

0:58c3d014a4e7


    35

 */





slowness

0:58c3d014a4e7


    36







slowness

0:58c3d014a4e7


    37

#ifndef __LWIP_SNMP_STRUCTS_H__





slowness

0:58c3d014a4e7


    38

#define __LWIP_SNMP_STRUCTS_H__





slowness

0:58c3d014a4e7


    39







slowness

0:58c3d014a4e7


    40

#include "lwip/opt.h"





slowness

0:58c3d014a4e7


    41







slowness

0:58c3d014a4e7


    42

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





slowness

0:58c3d014a4e7


    43







slowness

0:58c3d014a4e7


    44

#include "lwip/snmp.h"





slowness

0:58c3d014a4e7


    45







slowness

0:58c3d014a4e7


    46

#if SNMP_PRIVATE_MIB





slowness

0:58c3d014a4e7


    47

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





slowness

0:58c3d014a4e7


    48

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





slowness

0:58c3d014a4e7


    49

#include "private_mib.h"





slowness

0:58c3d014a4e7


    50

#endif





slowness

0:58c3d014a4e7


    51







slowness

0:58c3d014a4e7


    52

#ifdef __cplusplus





slowness

0:58c3d014a4e7


    53

extern "C" {





slowness

0:58c3d014a4e7


    54

#endif





slowness

0:58c3d014a4e7


    55







slowness

0:58c3d014a4e7


    56

/* MIB object instance */





slowness

0:58c3d014a4e7


    57

#define MIB_OBJECT_NONE 0 





slowness

0:58c3d014a4e7


    58

#define MIB_OBJECT_SCALAR 1





slowness

0:58c3d014a4e7


    59

#define MIB_OBJECT_TAB 2





slowness

0:58c3d014a4e7


    60







slowness

0:58c3d014a4e7


    61

/* MIB access types */





slowness

0:58c3d014a4e7


    62

#define MIB_ACCESS_READ   1





slowness

0:58c3d014a4e7


    63

#define MIB_ACCESS_WRITE  2





slowness

0:58c3d014a4e7


    64







slowness

0:58c3d014a4e7


    65

/* MIB object access */





slowness

0:58c3d014a4e7


    66

#define MIB_OBJECT_READ_ONLY      MIB_ACCESS_READ





slowness

0:58c3d014a4e7


    67

#define MIB_OBJECT_READ_WRITE     (MIB_ACCESS_READ | MIB_ACCESS_WRITE)





slowness

0:58c3d014a4e7


    68

#define MIB_OBJECT_WRITE_ONLY     MIB_ACCESS_WRITE





slowness

0:58c3d014a4e7


    69

#define MIB_OBJECT_NOT_ACCESSIBLE 0





slowness

0:58c3d014a4e7


    70







slowness

0:58c3d014a4e7


    71

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





slowness

0:58c3d014a4e7


    72

struct obj_def





slowness

0:58c3d014a4e7


    73

{





slowness

0:58c3d014a4e7


    74

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





slowness

0:58c3d014a4e7


    75

  u8_t instance;





slowness

0:58c3d014a4e7


    76

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





slowness

0:58c3d014a4e7


    77

  u8_t access;





slowness

0:58c3d014a4e7


    78

  /* ASN type for this object */





slowness

0:58c3d014a4e7


    79

  u8_t asn_type;





slowness

0:58c3d014a4e7


    80

  /* value length (host length) */





slowness

0:58c3d014a4e7


    81

  u16_t v_len;





slowness

0:58c3d014a4e7


    82

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





slowness

0:58c3d014a4e7


    83

  u8_t  id_inst_len;





slowness

0:58c3d014a4e7


    84

  /* instance part of supplied object identifier */





slowness

0:58c3d014a4e7


    85

  s32_t *id_inst_ptr;





slowness

0:58c3d014a4e7


    86

};





slowness

0:58c3d014a4e7


    87







slowness

0:58c3d014a4e7


    88

struct snmp_name_ptr





slowness

0:58c3d014a4e7


    89

{





slowness

0:58c3d014a4e7


    90

  u8_t ident_len;





slowness

0:58c3d014a4e7


    91

  s32_t *ident;





slowness

0:58c3d014a4e7


    92

};





slowness

0:58c3d014a4e7


    93







slowness

0:58c3d014a4e7


    94

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





slowness

0:58c3d014a4e7


    95

#define MIB_NODE_SC 0x01





slowness

0:58c3d014a4e7


    96

/** MIB const array node */





slowness

0:58c3d014a4e7


    97

#define MIB_NODE_AR 0x02





slowness

0:58c3d014a4e7


    98

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





slowness

0:58c3d014a4e7


    99

#define MIB_NODE_RA 0x03





slowness

0:58c3d014a4e7


   100

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





slowness

0:58c3d014a4e7


   101

#define MIB_NODE_LR 0x04





slowness

0:58c3d014a4e7


   102

/** MIB node for external objects */





slowness

0:58c3d014a4e7


   103

#define MIB_NODE_EX 0x05





slowness

0:58c3d014a4e7


   104







slowness

0:58c3d014a4e7


   105

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





slowness

0:58c3d014a4e7


   106

struct mib_node





slowness

0:58c3d014a4e7


   107

{





slowness

0:58c3d014a4e7


   108

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





slowness

0:58c3d014a4e7


   109

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





slowness

0:58c3d014a4e7


   110

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





slowness

0:58c3d014a4e7


   111

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





slowness

0:58c3d014a4e7


   112

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





slowness

0:58c3d014a4e7


   113

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





slowness

0:58c3d014a4e7


   114

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





slowness

0:58c3d014a4e7


   115

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





slowness

0:58c3d014a4e7


   116

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





slowness

0:58c3d014a4e7


   117

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





slowness

0:58c3d014a4e7


   118

  u8_t node_type;





slowness

0:58c3d014a4e7


   119

  /* array or max list length */





slowness

0:58c3d014a4e7


   120

  u16_t maxlength;





slowness

0:58c3d014a4e7


   121

};





slowness

0:58c3d014a4e7


   122







slowness

0:58c3d014a4e7


   123

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





slowness

0:58c3d014a4e7


   124

typedef struct mib_node mib_scalar_node;





slowness

0:58c3d014a4e7


   125







slowness

0:58c3d014a4e7


   126

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





slowness

0:58c3d014a4e7


   127

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





slowness

0:58c3d014a4e7


   128

struct mib_array_node





slowness

0:58c3d014a4e7


   129

{





slowness

0:58c3d014a4e7


   130

  /* inherited "base class" members */





slowness

0:58c3d014a4e7


   131

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





slowness

0:58c3d014a4e7


   132

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





slowness

0:58c3d014a4e7


   133

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





slowness

0:58c3d014a4e7


   134

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





slowness

0:58c3d014a4e7


   135







slowness

0:58c3d014a4e7


   136

  u8_t node_type;





slowness

0:58c3d014a4e7


   137

  u16_t maxlength;





slowness

0:58c3d014a4e7


   138







slowness

0:58c3d014a4e7


   139

  /* additional struct members */





slowness

0:58c3d014a4e7


   140

  const s32_t *objid;





slowness

0:58c3d014a4e7


   141

  struct mib_node* const *nptr;





slowness

0:58c3d014a4e7


   142

};





slowness

0:58c3d014a4e7


   143







slowness

0:58c3d014a4e7


   144

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





slowness

0:58c3d014a4e7


   145

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





slowness

0:58c3d014a4e7


   146

struct mib_ram_array_node





slowness

0:58c3d014a4e7


   147

{





slowness

0:58c3d014a4e7


   148

  /* inherited "base class" members */





slowness

0:58c3d014a4e7


   149

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





slowness

0:58c3d014a4e7


   150

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





slowness

0:58c3d014a4e7


   151

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





slowness

0:58c3d014a4e7


   152

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





slowness

0:58c3d014a4e7


   153







slowness

0:58c3d014a4e7


   154

  u8_t node_type;





slowness

0:58c3d014a4e7


   155

  u16_t maxlength;





slowness

0:58c3d014a4e7


   156







slowness

0:58c3d014a4e7


   157

  /* aditional struct members */





slowness

0:58c3d014a4e7


   158

  s32_t *objid;





slowness

0:58c3d014a4e7


   159

  struct mib_node **nptr;





slowness

0:58c3d014a4e7


   160

};





slowness

0:58c3d014a4e7


   161







slowness

0:58c3d014a4e7


   162

struct mib_list_node





slowness

0:58c3d014a4e7


   163

{





slowness

0:58c3d014a4e7


   164

  struct mib_list_node *prev;  





slowness

0:58c3d014a4e7


   165

  struct mib_list_node *next;





slowness

0:58c3d014a4e7


   166

  s32_t objid;





slowness

0:58c3d014a4e7


   167

  struct mib_node *nptr;





slowness

0:58c3d014a4e7


   168

};





slowness

0:58c3d014a4e7


   169







slowness

0:58c3d014a4e7


   170

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





slowness

0:58c3d014a4e7


   171

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





slowness

0:58c3d014a4e7


   172

struct mib_list_rootnode





slowness

0:58c3d014a4e7


   173

{





slowness

0:58c3d014a4e7


   174

  /* inherited "base class" members */





slowness

0:58c3d014a4e7


   175

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





slowness

0:58c3d014a4e7


   176

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





slowness

0:58c3d014a4e7


   177

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





slowness

0:58c3d014a4e7


   178

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





slowness

0:58c3d014a4e7


   179







slowness

0:58c3d014a4e7


   180

  u8_t node_type;





slowness

0:58c3d014a4e7


   181

  u16_t maxlength;





slowness

0:58c3d014a4e7


   182







slowness

0:58c3d014a4e7


   183

  /* additional struct members */





slowness

0:58c3d014a4e7


   184

  struct mib_list_node *head;





slowness

0:58c3d014a4e7


   185

  struct mib_list_node *tail;





slowness

0:58c3d014a4e7


   186

  /* counts list nodes in list  */





slowness

0:58c3d014a4e7


   187

  u16_t count;





slowness

0:58c3d014a4e7


   188

};





slowness

0:58c3d014a4e7


   189







slowness

0:58c3d014a4e7


   190

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





slowness

0:58c3d014a4e7


   191

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





slowness

0:58c3d014a4e7


   192

struct mib_external_node





slowness

0:58c3d014a4e7


   193

{





slowness

0:58c3d014a4e7


   194

  /* inherited "base class" members */





slowness

0:58c3d014a4e7


   195

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





slowness

0:58c3d014a4e7


   196

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





slowness

0:58c3d014a4e7


   197

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





slowness

0:58c3d014a4e7


   198

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





slowness

0:58c3d014a4e7


   199







slowness

0:58c3d014a4e7


   200

  u8_t node_type;





slowness

0:58c3d014a4e7


   201

  u16_t maxlength;





slowness

0:58c3d014a4e7


   202







slowness

0:58c3d014a4e7


   203

  /* additional struct members */





slowness

0:58c3d014a4e7


   204

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





slowness

0:58c3d014a4e7


   205

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





slowness

0:58c3d014a4e7


   206

  void* addr_inf;





slowness

0:58c3d014a4e7


   207

  /** tree levels under this node */





slowness

0:58c3d014a4e7


   208

  u8_t tree_levels;





slowness

0:58c3d014a4e7


   209

  /** number of objects at this level */





slowness

0:58c3d014a4e7


   210

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





slowness

0:58c3d014a4e7


   211

  /** compares object sub identifier with external id





slowness

0:58c3d014a4e7


   212

      return zero when equal, nonzero when unequal */





slowness

0:58c3d014a4e7


   213

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





slowness

0:58c3d014a4e7


   214

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





slowness

0:58c3d014a4e7


   215







slowness

0:58c3d014a4e7


   216

  /** async Questions */





slowness

0:58c3d014a4e7


   217

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





slowness

0:58c3d014a4e7


   218

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





slowness

0:58c3d014a4e7


   219

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





slowness

0:58c3d014a4e7


   220

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





slowness

0:58c3d014a4e7


   221

  /** async Answers */





slowness

0:58c3d014a4e7


   222

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





slowness

0:58c3d014a4e7


   223

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





slowness

0:58c3d014a4e7


   224

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





slowness

0:58c3d014a4e7


   225

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





slowness

0:58c3d014a4e7


   226

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





slowness

0:58c3d014a4e7


   227

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





slowness

0:58c3d014a4e7


   228

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





slowness

0:58c3d014a4e7


   229

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





slowness

0:58c3d014a4e7


   230

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





slowness

0:58c3d014a4e7


   231

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





slowness

0:58c3d014a4e7


   232

};





slowness

0:58c3d014a4e7


   233







slowness

0:58c3d014a4e7


   234

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





slowness

0:58c3d014a4e7


   235

extern const struct mib_array_node internet;





slowness

0:58c3d014a4e7


   236







slowness

0:58c3d014a4e7


   237

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





slowness

0:58c3d014a4e7


   238

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





slowness

0:58c3d014a4e7


   239

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





slowness

0:58c3d014a4e7


   240

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





slowness

0:58c3d014a4e7


   241

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





slowness

0:58c3d014a4e7


   242







slowness

0:58c3d014a4e7


   243

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





slowness

0:58c3d014a4e7


   244

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





slowness

0:58c3d014a4e7


   245

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





slowness

0:58c3d014a4e7


   246

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





slowness

0:58c3d014a4e7


   247







slowness

0:58c3d014a4e7


   248

struct mib_list_node* snmp_mib_ln_alloc(s32_t id);





slowness

0:58c3d014a4e7


   249

void snmp_mib_ln_free(struct mib_list_node *ln);





slowness

0:58c3d014a4e7


   250

struct mib_list_rootnode* snmp_mib_lrn_alloc(void);





slowness

0:58c3d014a4e7


   251

void snmp_mib_lrn_free(struct mib_list_rootnode *lrn);





slowness

0:58c3d014a4e7


   252







slowness

0:58c3d014a4e7


   253

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





slowness

0:58c3d014a4e7


   254

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





slowness

0:58c3d014a4e7


   255

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





slowness

0:58c3d014a4e7


   256







slowness

0:58c3d014a4e7


   257

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





slowness

0:58c3d014a4e7


   258

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





slowness

0:58c3d014a4e7


   259

u8_t snmp_iso_prefix_tst(u8_t ident_len, s32_t *ident);





slowness

0:58c3d014a4e7


   260

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





slowness

0:58c3d014a4e7


   261







slowness

0:58c3d014a4e7


   262

#ifdef __cplusplus





slowness

0:58c3d014a4e7


   263

}





slowness

0:58c3d014a4e7


   264

#endif





slowness

0:58c3d014a4e7


   265







slowness

0:58c3d014a4e7


   266

#endif /* LWIP_SNMP */





slowness

0:58c3d014a4e7


   267







slowness

0:58c3d014a4e7


   268

#endif /* __LWIP_SNMP_STRUCTS_H__ */