snmpdefs.h

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

/* $Header: /usr/cvsroot/target/h/wrn/wm/snmp/engine/snmpdefs.h,v 1.7 2002/07/09 19:14:26 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: snmpdefs.h,v $
 * Revision 1.7  2002/07/09 19:14:26  josh
 * remove a namespace collision by renaming SNMP_community_lookup()
 * to SNMP_community_coexistence_lookup()
 *
 * Revision 1.6  2002/05/17 18:45:05  josh
 * add ENVOY_ERR_TOO_BIG to envoy_err_t enumeration
 *
 * Revision 1.5  2002/05/13 20:46:18  josh
 * encoding process now checks for 16-bit overflows in
 * calculating packet sizes
 *
 * Revision 1.4  2002/03/06 20:04:24  josh
 * make the default size of the SNMPADDR_T as large as a sockaddr_in6
 *
 * Revision 1.3  2001/11/09 17:57:18  josh
 * updated SNMPADDR_T structure to allow more room for storing
 * IPv6 information
 *
 * Revision 1.2  2001/11/06 21:35:04  josh
 * new revised path structure, first pass.  Also removing useless
 * shell include files.
 *
 * Revision 1.1.1.1  2001/11/05 17:47:23  tneale
 * Tornado shuffle
 *
 * Revision 9.20.4.9  2001/10/16 18:34:26  meister
 * Added some prototypes
 *
 * Revision 9.20.4.8  2001/09/21 19:16:06  josh
 * updating and expanding structures for use with coexistence
 *
 * Revision 9.20.4.7  2001/08/29 15:47:06  meister
 * declarations for vxworks snmpd component initialation functions
 * and task priorities
 *
 * Revision 9.20.4.6  2001/08/24 14:32:44  josh
 * we'll use the proxy_routine field in SNMP_PKT_T for V3 Proxies
 * as well
 *
 * Revision 9.20.4.5  2001/08/17 20:38:43  meister
 * Added prototypes for some agentx helper functions which were previously
 * declared statically. Added prototypes for agentx and v3 dynamic config init
 * functions.
 *
 * Revision 9.20.4.4  2001/08/07 18:33:57  josh
 * adding support for SNMPv1/v2c/v3 coexistence to SNMP Notify code
 *
 * Revision 9.20.4.3  2001/07/20 20:34:35  josh
 * a community table based validation routine that can
 * supercede existing community validation routines
 *
 * Revision 9.20.4.2  2001/07/16 18:02:12  josh
 * a first-round commit adding infrastructure support
 * for the SNMPv3 Coexistence RFC (2576)
 *
 * Revision 9.20.4.1  2001/06/28 18:22:57  josh
 * Seeding the Cormorant branch with the code from the old
 * cormorant branch
 *
 * Revision 9.20  2001/04/19 18:21:40  josh
 * changes to do bounds-checking on maxMsgSize, snmpVersion,
 * msgID, and snmpSecurityModel
 *
 * Revision 9.19  2001/04/11 21:01:49  josh
 * we are overwriting the trunk's copy of this file with
 * the file from the kingfisher branch
 *
 * Revision 9.18  2001/01/19 22:22:09  paul
 * Update copyright.
 *
 * Revision 9.17  2000/07/12 18:40:53  josh
 * adding a few new error codes to the envoy_err_t definition
 *
 * Revision 9.16  2000/06/09 14:54:12  josh
 * modifications due to new installation options, new proxy code
 * moved some definitions from sendntfy.h into v3_trgt.h so they'd
 * be built with the target code
 *
 * Revision 9.15.4.1  2001/04/11 20:48:31  josh
 * moving cormorant-specific changes off to the cormorant
 * branch
 *
 * Revision 9.15.2.2  2001/03/12 22:07:57  tneale
 * Updated copyright
 *
 * Revision 9.15.2.1  2000/09/21 21:14:53  josh
 * bringing branch include files in line with root
 *
 * Revision 9.15  2000/03/17 19:48:40  meister
 * Update copyright notice
 *
 * Revision 9.14  2000/03/17 00:03:01  josh
 * adding functions to Envoy that replace getproc_got_*() macros
 *
 * Revision 9.13  2000/03/09 20:58:34  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.12  2000/03/09 16:58:18  tneale
 *  Added #ifdef for C++ to declare extern C if needed
 *
 * Revision 9.11  2000/02/04 21:54:17  josh
 * prototyping functions that may need to be called by other modules
 * this is done primarily to make the vxWorks compiler happy.
 * Warning:  the prototypes added may be duplicated by a mib_hand.h
 * file generated by Emissary.
 *
 * Revision 9.10  1999/12/23 14:47:27  josh
 * cleaning up code per Shawn's comments -- removing extraneous
 * comments and doing proxy check before notify check
 *
 * Revision 9.9  1999/11/05 20:59:34  josh
 * fixing an unaligned access problem with SNMPADDR_Ts
 *
 * Revision 9.8  1999/10/02 01:41:52  sar
 * Update the vbp to index code to handle the get bulk error case
 *
 * Revision 9.7  1999/09/30 21:57:24  josh
 * RETRANS_CLEANUP_T function data type
 *
 * Revision 9.6  1999/09/14 19:46:13  josh
 * prototype for vblp_index_to_vbp()
 *
 * Revision 9.5  1999/09/09 19:31:22  sar
 * Update the error macros to set the error index
 *
 * Revision 9.4  1999/06/01 15:46:15  josh
 * Moving some installation option checking.
 *
 * Revision 9.3  1999/05/24 20:12:12  josh
 * 'compc' and 'compl' have been replaced by 'tcount' and 'tlist'
 * to avoid C++ compiler errors.
 *
 * Revision 9.2  1999/04/09 20:37:01  josh
 * Obsoleting ENVOY_SNMP_VERSON_USEC and ENVOY_40_VB_FREE_COMPAT
 *
 * Revision 9.1  1999/03/30 15:20:15  josh
 * feature to allow customer-driven context conversion into AgentX
 *
 * Revision 9.0  1998/10/16 22:10:19  sar
 * Update version stamp to match release
 *
 * Revision 8.8  1998/06/09 20:50:39  sar
 * Added unknown context error
 *
 * Revision 8.7  1998/06/01 20:38:00  sar
 * Removed the msg_con_name field from SNMP_PKT_T, we can use the
 * community field instead.
 *
 * Revision 8.6  1998/05/24 06:04:05  sar
 * Modified PTR_IP_ADDR call as it probably got stepped on when
 * doing my previous changes.
 *
 * Revision 8.5  1998/05/23 20:18:17  sar
 * Added fields and defines for v3 stuff, updated typee info and rearranged
 * some of the fields to be clearer.
 *
 * Revision 8.4  1998/03/09 23:11:06  paul
 * getproc_got_ipaddr now takes a pointer to the ipaddr struct
 *
 * Revision 8.3  1998/02/25 04:50:46  sra
 * Update copyrights.
 *
 * Revision 8.2  1997/12/17 21:13:22  paul
 * Removed unnecessary #define/#undef PTR_IPADDR_BITS from around
 * getproc_got_ipaddr.
 *
 * Revision 8.1  1997/12/13 00:08:00  paul
 * Added getproc_got_ipaddr macro.
 *
 * Revision 8.0  1997/11/18 00:56:28  sar
 * Updated revision to 8.0
 *
 * Revision 7.6  1997/10/22 03:07:29  sar
 * Mofied the agentx and older subagent schemes install options
 *
 * Revision 7.5  1997/10/16 23:52:54  sar
 * We need to document that using constant strings in the getproc_got_string
 * macro could lead to unhappiness.
 *
 * We added a macro to allow customers to define what SNMPADDR_T should be,
 * and increased the length of the string to 16 bytes in the default case.
 *
 * changed testproc_error to be a routine
 *
 * Revision 7.4  1997/10/16 00:25:18  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/03/20 06:48:17  sra
 * DFARS-safe copyright text.  Zap!
 *
 * Revision 7.2  1997/02/25 10:49:26  sra
 * Update copyright notice, dust under the bed.
 *
 * Revision 7.1  1996/10/15 14:40:22  sar
 * Added process_internal_snmp_packet
 *
 * Revision 7.0  1996/03/18  20:17:33  sar
 * Updated rev to 7.0 and copyright to 96
 *
 * Revision 6.5  1996/01/23  16:26:19  sar
 * Changed usec_report flag from 0x40 to 0x04
 *
 * Revision 6.4  1996/01/10  16:23:25  sar
 * USEC updates
 *
 * Revision 6.3  1995/11/14  22:42:26  sar
 * Replaced proxy_trap_{v1 v2} with proxy_traps_and_reports
 *
 * Revision 6.2  1995/11/04  01:52:03  sar
 * Added the proxy routine type and a proxy_routine field in
 * the snmp_pkt_t structure if proxy is installed.
 *
 * Revision 6.1  1995/10/20  22:53:35  sar
 * removed bitstring include file & macro
 * removed party info from snmp_pkt structure
 * added report pdu tag
 *
 * Revision 6.0  1995/05/31  21:46:51  sra
 * Release 6.0.
 *
 * Revision 5.10  1995/05/22  19:41:18  sar
 * Added error check to make sure that the lock option is installed
 * if the continue_reentrant option is installed.
 *
 * Revision 5.9  1995/05/08  20:31:09  sar
 * changed the args to nextproc_next_instance & getproc_got_object_id
 * to make compilers happier.
 *
 * Revision 5.8  1995/05/06  01:39:54  sar
 * We now include auxmth.h and some other method routine defs so that the
 * mib compiler won't need to generate defs for routines included in auxi.
 *
 * Revision 5.7  1995/05/05  23:26:09  sar
 * Set the vb_data_n_type flag for getproc_got_bitstring.
 *
 * Revision 5.6  1995/04/28  22:42:16  sar
 * Added definitions for use with the serialization (gatekeeper) code.
 *
 * Revision 5.5  1995/03/20  23:11:33  sar
 * Moved the vb specific information to vbdefs.h and included that file here.
 * Added declarations for the routines & macros that are used in the
 * new async scheme.  This included adding several variables to the
 * snmp_pkt structure and the std_pdu structure.
 * Modified the party names to be "for" and "loc" instead of "src" and "dest".
 *
 * Revision 5.4  1994/10/12  20:12:36  sar
 * made the trap_time_ticks a uint_32 instead of int_32
 *
 * Revision 5.3  1994/09/29  18:31:12  sar
 * Rearrange some items to deal with removing v2 types from v1 settings if
 * they aren't installed.
 *
 * Revision 5.2  1994/07/29  18:08:12  sar
 * Added MAX_V1_PDU for use in type checking v1 pdus.
 *
 * Revision 5.1  1994/07/28  23:29:12  sar
 * Added a field in the SNMP_PKT_T structure for holding a pointer to
 * the mib tree to use for this packet.
 *
 * Revision 5.0  1994/05/16  15:49:04  sar
 * Updated revision to 5.0 and copyright to include 1994
 *
 * Revision 4.7  1994/05/09  21:02:30  sar
 * Added sub_agent option to #if clause in deciding to include sa_flags and
 * vb_access.
 *
 * Revision 4.6  1994/05/06  20:29:54  sar
 * Took out the ifdef v1 for community string as we know use if to hold
 * the v2 localentity string.
 *
 * Revision 4.5  1994/05/04  23:47:31  sar
 * made VBPRIVPROC's always take a PTR_T as argument (SA_freeproc for one).
 *
 * Revision 4.4  1994/05/04  22:43:48  sar
 * modified the call_the_set_routine calling sequence.
 *
 * Revision 4.3  1994/05/02  21:19:26  sar
 * Added a localtimeobj in snmp_pkt_t for use with sub agent type stuff.
 *
 * Revision 4.2  1994/04/29  20:00:21  sar
 * Mostly sub agent stuff, added new fields to snmp_pkt structure
 * added externs for several routines, modified the vbprivproc definition
 * for use with the VB_FREE_COMPAT option.
 *
 * Revision 4.1  1993/10/06  19:47:11  sar
 * added the TPROC_READ_ONLY and TPROC_TOO_BIG flags for use with error_response
 * modified tproc_set_error to use vb_to_index + 1 to get the index's to
 * be 1 based (what snmp uses) rather than 0 based (what envoy internals use).
 *
 * Revision 4.0  1993/06/24  16:05:41  sar
 * Updated rev to 4.0 and coypright to 93
 *
 * Revision 3.20  1993/06/07  18:31:09  sar
 * Made SNMP_Decode_Packet a macro calling SNMP_Decode_Packet_WER
 * which is newly defined.
 *
 * Revision 3.19  1993/06/02  23:05:55  dab
 * Changed #ifdef's to #if's for things from install.h
 *
 * Revision 3.18  1993/05/31  17:45:26  sar
 * fixed a typo con_notloal to con_notlocal
 *
 * Revision 3.17  1993/05/19  20:07:52  sar
 * tiding up types to make compilers happy, (timestamps to UINT_32_T,
 * sizes to ALENGTH_T).
 *
 * Revision 3.16  1993/05/14  15:13:29  sar
 * renamed private field in packet structure to be user_private
 *
 * Revision 3.15  1993/05/03  17:14:17  sar
 * Modified context local time to allow it to be set and got rid of party and
 * context oids in the packet structure which leads to asn1len in the
 * party and context structure.
 *
 * Revision 3.14  1993/04/30  22:58:26  sar
 * Added mechanism for minimal proxies and coarse grained locks.
 *
 * Revision 3.13  1993/04/28  22:00:38  sar
 * Moved the definition of UINT_64_T to ui64.h and update others
 *
 * Revision 3.12  1993/04/27  21:06:48  sar
 * Removed index_to_vbp it is now in buildpkt.h
 * used qualifier for the include names (envoy/h/...)
 *
 * Revision 3.11  1993/04/26  20:33:14  sar
 * Added bitstrings, and have deletion of parties or contexts delete acls.
 *
 * Revision 3.10  1993/04/22  20:14:13  sar
 * Updating of macros and defines to use new naming scheme and get the
 * names to be more useful in general.  (use INSTALL_ENVOY_SNMP_VERSION_1
 * for example).
 *
 * Revision 3.9  1993/04/21  15:31:44  dab
 * removed define __() macro since everyone should get this from <types.h>
 *
 * Revision 3.8  1993/04/17  01:03:30  sar
 * changes for shadow area row creation and updating of some error codes.
 *
 * Revision 3.7  1993/03/25  21:15:21  sar
 * Added types for uint 64 (counter64) and nsapaddress (translates to string)
 *
 * Revision 3.6  1993/02/26  22:36:17  sar
 * Changed INCONISTENT_VALUE to INCONSISTENT_VALUE
 *
 * Revision 3.5  1993/02/26  20:27:30  sar
 * added inconsistent name to the list of pdu errors.
 *
 * Revision 3.4  1993/02/26  17:29:49  sar
 * added defines for MAX_PDU and ALL_CLASS to allow writing code that
 * won't have to change if we add new pdu types.
 *
 * Revision 3.3  1993/02/24  00:59:50  sar
 * Removed the name objid from the partyleaf and put a copy of it in the
 * pkt.  Also Updated many of the SNMP_(Party, Context, ACL)_* files
 * to use a OIDC_T/length instead of a OBJ_ID_T so we don't have to
 * allocate an OBJ_ID_T when we don't have one.
 *
 * Revision 3.2  1993/02/17  20:52:52  sar
 * Added no_pp definition (#define _(x) x stuff)
 * Added more tags (nsapaddress, counter64, uinteger32 and the exception
 * tags nosuchobj, nosuchins, and endofmib).
 * Added a VBL_S pointer to the VBL_S structure for get bulk chaining.
 * Added new defines for new classes and errors
 * Added SNMP_Encode_Auth_Msg - definition for encoding auth messages.
 * Updated SNMP_PKT_S to contain version 2 options.
 *
 * Revision 3.1  92/07/31  11:55:02  dab
 * Started changes for parties for Secure SNMP.
 * 
 * Revision 3.0  92/04/03  19:52:27  dab
 * Release 3.0
 * 
 * Revision 2.106  92/02/27  16:47:00  dab
 * Added return code #define's for the TESTPROC.
 * 
 * Revision 2.105  91/11/07  09:37:45  dab
 * Changed the view mask to be 32 bits.
 * 
 * Revision 2.104  91/11/05  17:32:12  dab
 * Added VB_TO_INDEX() macro.