mib.h

wm PNE 3.3 source code, running at more than vxworks6.x version.

/* $Header: /usr/cvsroot/target/h/wrn/wm/snmp/engine/mib.h,v 1.2 2001/11/06 21:35:02 josh Exp $ */

/*
 * Copyright (C) 1999-2005 Wind River Systems, Inc.
 * All rights reserved.  Provided under license only.
 * Distribution or other use of this software is only
 * permitted pursuant to the terms of a license agreement
 * from Wind River Systems (and is otherwise prohibited).
 * Refer to that license agreement for terms of use.
 */


/****************************************************************************
 *  Copyright 1988-1997 Epilogue Technology Corporation.
 *  Copyright 1998 Integrated Systems, Inc.
 *  All rights reserved.
 ****************************************************************************/

/*
 * $Log: mib.h,v $
 * Revision 1.2  2001/11/06 21:35:02  josh
 * new revised path structure, first pass.  Also removing useless
 * shell include files.
 *
 * Revision 1.1.1.1  2001/11/05 17:47:22  tneale
 * Tornado shuffle
 *
 * Revision 9.9.4.1  2001/08/24 14:11:25  josh
 * make sure that standard declaration of NODE_NT zeroes all fields
 *
 * Revision 9.9  2001/04/11 20:12:00  josh
 * merging changes from the kingfisher branch back onto
 * the trunk
 *
 * Revision 9.8  2001/01/19 22:22:05  paul
 * Update copyright.
 *
 * Revision 9.7.2.2  2001/03/12 22:07:54  tneale
 * Updated copyright
 *
 * Revision 9.7.2.1  2000/10/13 21:17:33  josh
 * function prototypes and static declarations to eliminate warnings
 * from the Tornado compiler
 *
 * Revision 9.7  2000/03/17 19:48:35  meister
 * Update copyright notice
 *
 * Revision 9.6  2000/03/09 20:58:33  tneale
 * All structure definitions are now bracketted with a test that
 * potentially sets an alignment pragma.  This is to maintain compatibility
 * with the code base that had been distributed by Wind River.
 *
 * Revision 9.5  2000/03/09 16:56:42  tneale
 *  Added #ifdef for C++ to declare extern C if needed
 *
 * Revision 9.4  1999/12/23 14:47:26  josh
 * cleaning up code per Shawn's comments -- removing extraneous
 * comments and doing proxy check before notify check
 *
 * Revision 9.3  1999/11/12 23:20:28  josh
 * fixing synchronous function prototypes
 *
 * Revision 9.2  1999/10/26 20:07:33  josh
 * fix indeterminate function prototyping with forward declarations
 *
 * Revision 9.1  1999/05/24 20:12:11  josh
 * 'compc' and 'compl' have been replaced by 'tcount' and 'tlist'
 * to avoid C++ compiler errors.
 *
 * Revision 9.0  1998/10/16 22:10:15  sar
 * Update version stamp to match release
 *
 * Revision 8.1  1998/02/25 04:50:40  sra
 * Update copyrights.
 *
 * Revision 8.0  1997/11/18 00:56:26  sar
 * Updated revision to 8.0
 *
 * Revision 7.6  1997/10/29 01:33:28  sar
 * Only define the two character macros ("NO", "RW" etc) if the user
 * asks for them via an installation option.
 *
 * Revision 7.5  1997/10/22 03:07:29  sar
 * Mofied the agentx and older subagent schemes install options
 *
 * Revision 7.4  1997/10/16 00:25:17  sar
 * Primarily this set of modifications is for the agentx protocol.
 * Most of the work was in the agentx.h and ax_mth.h files.  Most
 * other files (snmpdefs.h, vbdefs.h and mib.h) received updates
 * to their structures and snmp got some new lock macros.
 *
 * One other change of note was the modification of continue
 * processing.  Previously we called a specific continue routine
 * directly, now we store a pointer to the corret continue
 * function in the snmp packet structure and call that.  We include
 * macros for backwards compatibility.
 *
 * Revision 7.3  1997/09/16 19:19:23  sar
 * Added the NT macros for leaves and nodes, these add a flag
 * word to allow the mib compiler to set some flags in the mib
 * tree structure.  Emissary 7.0 can make use of these macros.
 *
 * Revision 7.2  1997/03/20 06:48:13  sra
 * DFARS-safe copyright text.  Zap!
 *
 * Revision 7.1  1997/02/25 10:49:26  sra
 * Update copyright notice, dust under the bed.
 *
 * Revision 7.0  1996/03/18 20:17:33  sar
 * Updated rev to 7.0 and copyright to 96
 *
 * Revision 6.0  1995/05/31  21:46:58  sra
 * Release 6.0.
 *
 * Revision 5.4  1995/05/03  21:01:22  sar
 * Added CREATE_ACCESS & NOTIFY_ACCESS
 *
 * Revision 5.3  1995/03/24  17:35:34  sar
 * Added scalar/tabular arg to the leaf_asy and leaf_com macros, currently
 * we just throw it away.
 *
 * Revision 5.2  1995/03/20  23:11:33  sar
 * Added the ASY_*PROC_T method routines
 * Updated the MIBLEAF_T structure to use the async method routine typedefs
 * Added a compatibility structure for backwards compatibility
 * Added a new series of macros to populate the mibleaf and compat structure.
 *
 * Revision 5.1  1994/08/04  22:05:29  sar
 * Added multiple mib tree capability, including macros to translate the
 * old apis into the new api's
 *
 * Revision 5.0  1994/05/16  15:49:04  sar
 * Updated revision to 5.0 and copyright to include 1994
 *
 * Revision 4.3  1994/04/29  20:06:04  sar
 * Added LEAF_INACTIVE flag and modified calling sequence for Find_Node.
 *
 * Revision 4.2  1994/02/01  23:37:07  sar
 * Added flags for use with the Find, Add and Remove_Node routines.
 *
 * Revision 4.1  1993/09/30  19:32:16  sar
 * Added a definition for TEST_CREATE in the list of defines for
 * the form parameter to the testproc routine.  TEST_CREATE specified
 * that this call is to check if the given object can be created.
 *
 * Revision 4.0  1993/06/24  16:05:41  sar
 * Updated rev to 4.0 and coypright to 93
 *
 * Revision 3.2  1993/05/03  17:54:14  sar
 * Modified #include <foo> to be #include <envoy/h/foo.h> where it was correct.
 *
 * Revision 3.1  1993/03/02  18:16:06  dab
 * Removed __() macro since this is defined in <types.h>
 *
 * Revision 3.0  1992/04/03  19:52:27  dab
 * Release 3.0
 *
 * Revision 2.103  92/01/30  14:00:17  dab
 * Added function parameter prototypes for the test, get, set, and next
 * functions.  Also added casts inthe LEAF and LEAFM macros to cast the
 * routines to those prototypes.
 * 
 * Revision 2.102  91/12/05  15:02:59  dab
 * LEAF macro initializes mib view masks to 0xFFFFFFFF instead of just 0xFF.
 * 
 * Revision 2.101  91/11/07  09:37:23  dab
 * Made the view and write masks be 32 bits.
 * 
 * Revision 2.100  91/08/09  14:09:47  dab
 * Update version.
 * 
 * Revision 1.1  91/07/30  02:24:28  romkey
 * Initial revision
 * 
 * 
 *    Rev 2.0   31 Mar 1990 15:11:24
 * Release 2.00
 * 
 *    Rev 1.8   24 Sep 1989 22:06:34
 * Renamed mib_root to mib_root_node to support the MIB compiler.
 * 
 *    Rev 1.7   11 Jan 1989 11:59:48
 * Updated copyright dates.
 * 
 *    Rev 1.6   11 Jan 1989 11:09:20
 * Added definitions of find_object_node() and find_next_object() for non-
 * ANSI compilers.
 * 
 *    Rev 1.5   10 Oct 1988 21:47:00
 * Reorganized source modules
 * 
 *    Rev 1.4   21 Sep 1988 16:34:00
 * Revised spelling to conform to the usage "MGMT" in the MIB.
 * 
 *    Rev 1.3   20 Sep 1988 15:50:10
 * Revised END_OF_ARC macro to avoid an improper type cast.
 * 
 *    Rev 1.2   19 Sep 1988 19:56:06
 * Revised MIBARC structure and ARC macro to avoid casting structure
 * pointers to a (char *) which, on machines like the Cray, could
 * destroy the meaning of the pointer.
 * 
 *    Rev 1.1   19 Sep 1988 17:27:06
 * Made changes to make the Sun C compiler happy.
 * 
 *    Rev 1.0   12 Sep 1988 10:46:18
 * Initial revision.
*/

/* [clearcase]
modification history
-------------------
01a,19apr05,job  update copyright notices
*/


#if (!defined(mib_inc))
#define mib_inc

#ifdef __cplusplus
extern"C" {
#endif

#if (!defined(asn1_inc))
#include <wrn/wm/snmp/engine/asn1.h>
#endif

/* Definitions for "form" parameter to the "testproc" found in leaf nodes */
#define	TEST_GET	0
#define	TEST_SET	1
#define TEST_CREATE	2

/* Definitions for node_type in MIBNODE_T and MIBLEAF_T */
#define NODE_TYPE	0x01
#define	INNER_NODE	0x00
#define	LEAF_NODE	0x01
#define REMOVABLE	0x02
#define REPLACEABLE	0x04
#define SYSTEM_OWNED	0x08
#define NODE_DYNAMIC	0x10
#define LEAF_DYNAMIC	0x10
#define ARC_DYNAMIC	0x20
#define COOKIE_DYNAMIC	0x20
#define LEAF_INACTIVE	0x40
#define AGENTX_LEAF     0x80

struct SNMP_PKT_S;
struct VB_S;
typedef void ASY_TESTPROC_T __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				struct SNMP_PKT_S *pktp, struct VB_S *vbp));
typedef void ASY_GETPROC_T  __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				struct SNMP_PKT_S *pktp, struct VB_S *vbp));
typedef void ASY_SETPROC_T  __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				struct SNMP_PKT_S *pktp, struct VB_S *vbp));
typedef void ASY_NEXTPROC_T __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				struct SNMP_PKT_S *pktp, struct VB_S *vbp));

typedef int	 TESTPROC_T __((int form, OIDC_T lastmatch, int tcount,
				OIDC_T *tlist, char *cookie, 
				struct SNMP_PKT_S *pktp, int indx));
typedef INT_32_T GETPROC_T  __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				char *cookie,
				struct SNMP_PKT_S *pktp));
typedef void	 SETPROC_T  __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				char *cookie, INT_32_T value,
				struct SNMP_PKT_S *pktp, int vb_index));
typedef int	 NEXTPROC_T __((OIDC_T lastmatch, int tcount, OIDC_T *tlist,
				OIDC_T *rlist, char *cookie,
				struct SNMP_PKT_S *pktp));

#ifdef WINDNET_STRUCT_ALIGN
#pragma align 1
#endif

/* Define a MIB leaf node */
typedef	struct	MIBLEAF_S
	{
	unsigned short	node_type;	/* See above			*/
	OCTET_T		expected_tag;	/* VT_xxx from snmp.h		*/
	OCTET_T		access_type;	/* See below			*/

	ASY_TESTPROC_T *testproc;	/* Routine to check whether the	*/
					/* indicated data object exists */
	ASY_GETPROC_T  *getproc; 	/* Routine to get the data	*/