windows-server-2003/net/snmp/subagent/lmmib2/srvc_tbl.c

/*++

Copyright (c) 1992-1996  Microsoft Corporation

Module Name:

    srvc_tbl.c

Abstract:

    All routines to support operations on the LM MIB Service Table.

Environment:

    User Mode - Win32

Revision History:

    10-May-1996 DonRyan
        Removed banner from Technology Dynamics, Inc.

--*/
 
//--------------------------- WINDOWS DEPENDENCIES --------------------------

//--------------------------- STANDARD DEPENDENCIES -- #include<xxxxx.h> ----

#include <stdio.h>
#include <memory.h>

//--------------------------- MODULE DEPENDENCIES -- #include"xxxxx.h" ------

#include <snmp.h>
#include <snmputil.h>

#include "mibfuncs.h"

//--------------------------- SELF-DEPENDENCY -- ONE #include"module.h" -----

#include "srvc_tbl.h"

//--------------------------- PUBLIC VARIABLES --(same as in module.h file)--

   // Prefix to the Service table
static UINT                srvcSubids[] = { 2, 3, 1 };
static AsnObjectIdentifier MIB_SrvcPrefix = { 3, srvcSubids };

SRVC_TABLE   MIB_SrvcTable = { 0, NULL };

//--------------------------- PRIVATE CONSTANTS -----------------------------

#define SRVC_FIELD_SUBID       (MIB_SrvcPrefix.idLength+MIB_OidPrefix.idLength)

#define SRVC_FIRST_FIELD       SRVC_NAME_FIELD
#define SRVC_LAST_FIELD        SRVC_PAUSED_FIELD

//--------------------------- PRIVATE STRUCTS -------------------------------

//--------------------------- PRIVATE VARIABLES -----------------------------

//--------------------------- PRIVATE PROTOTYPES ----------------------------

UINT MIB_srvcs_get(
        IN OUT RFC1157VarBind *VarBind
    );

int MIB_srvcs_match(
       IN AsnObjectIdentifier *Oid,
       OUT UINT *Pos
       );

UINT MIB_srvcs_copyfromtable(
        IN UINT Entry,
        IN UINT Field,
        OUT RFC1157VarBind *VarBind
        );

//--------------------------- PRIVATE PROCEDURES ----------------------------

//--------------------------- PUBLIC PROCEDURES -----------------------------

//
// MIB_srvcs_func
//    High level routine for handling operations on the Service table
//
// Notes:
//
// Return Codes:
//    None.
//
// Error Codes:
//    None.
//
UINT MIB_srvcs_func(
    IN UINT Action,
    IN MIB_ENTRY *MibPtr,
    IN OUT RFC1157VarBind *VarBind
    )

{
    int     Found;
    UINT    Entry;
    UINT    Field;
    UINT    ErrStat;


    switch ( Action )
    {
        case MIB_ACTION_GETFIRST:
            // Fill the Service table with the info from server
            if ( SNMPAPI_ERROR == MIB_srvcs_lmget() )
            {
                ErrStat = SNMP_ERRORSTATUS_GENERR;
                goto Exit;
            }

            // If no elements in table, then return next MIB var, if one
            if ( MIB_SrvcTable.Len == 0 )
            {
                if ( MibPtr->MibNext == NULL )
                {
                    ErrStat = SNMP_ERRORSTATUS_NOSUCHNAME;
                    goto Exit;
                }

                // Do get first on the next MIB var
                ErrStat = (*MibPtr->MibNext->MibFunc)( Action, MibPtr->MibNext,
                                                       VarBind );
                break;
            }

            //
            // Place correct OID in VarBind
            // Assuming the first field in the first record is the "start"
            {
                UINT temp_subs[] = { SRVC_FIRST_FIELD };
                AsnObjectIdentifier FieldOid = { 1, temp_subs };
                AsnObjectIdentifier tmpOid;
         
                tmpOid = VarBind->name; // keep a copy (structure copy)
                if (! SnmpUtilOidCpy( &VarBind->name, &MIB_OidPrefix ))
                {
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &MIB_SrvcPrefix ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &FieldOid ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &MIB_SrvcTable.Table[0].Oid ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                // free the original VarBind->name
                SnmpUtilOidFree(&tmpOid);
         }

         //
         // Let fall through on purpose
         //

        case MIB_ACTION_GET:
            ErrStat = MIB_srvcs_get( VarBind );
            break;

        case MIB_ACTION_GETNEXT:
            // Fill the Service Table with the info from server
            if ( SNMPAPI_ERROR == MIB_srvcs_lmget() )
            {
                ErrStat = SNMP_ERRORSTATUS_GENERR;
                goto Exit;
            }

            // Determine which field
            Field = VarBind->name.ids[SRVC_FIELD_SUBID];

            // Lookup OID in table
            if (Field < SRVC_FIRST_FIELD)
            {
                Entry = 0;                 // will take the first entry into the table
                Field = SRVC_FIRST_FIELD;  // and the first column of the table
                Found = MIB_TBL_POS_BEFORE;
            }
            else if (Field > SRVC_LAST_FIELD)
                Found = MIB_TBL_POS_END;
            else
                Found = MIB_srvcs_match( &VarBind->name, &Entry );

            // Index not found, but could be more fields to base GET on
            if ((Found == MIB_TBL_POS_BEFORE && MIB_SrvcTable.Len == 0) ||
                  Found == MIB_TBL_POS_END )
            {
                // Index not found in table, get next from field
                // Field ++;

                // Make sure not past last field
//            if ( Field > SRVC_LAST_FIELD )
//               {
               // Get next VAR in MIB
                ErrStat = (*MibPtr->MibNext->MibFunc)( MIB_ACTION_GETFIRST,
                                                       MibPtr->MibNext,
                                                       VarBind );
                break;
//               }
            }

            // Get next TABLE entry
            if ( Found == MIB_TBL_POS_FOUND )
            {
                Entry ++;
                if ( Entry > MIB_SrvcTable.Len-1 )
                {
                    Entry = 0;
                    Field ++;
                    if ( Field > SRVC_LAST_FIELD )
                    {
                        // Get next VAR in MIB
                        ErrStat = (*MibPtr->MibNext->MibFunc)( MIB_ACTION_GETFIRST,
                                                             MibPtr->MibNext,
                                                             VarBind );
                        break;
                    }
                }
            }

            //
            // Place correct OID in VarBind
            // Assuming the first field in the first record is the "start"
            {
                UINT temp_subs[1];
                AsnObjectIdentifier FieldOid;
                AsnObjectIdentifier tmpOid;

                temp_subs[0]      = Field;
                FieldOid.idLength = 1;
                FieldOid.ids      = temp_subs;
                
                tmpOid = VarBind->name; // keep a copy (structure copy)
                if (! SnmpUtilOidCpy( &VarBind->name, &MIB_OidPrefix ))
                {
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &MIB_SrvcPrefix ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &FieldOid ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                if (! SnmpUtilOidAppend( &VarBind->name, &MIB_SrvcTable.Table[Entry].Oid ))
                {
                    SnmpUtilOidFree(&VarBind->name);
                    VarBind->name = tmpOid; // restore
                    ErrStat = SNMP_ERRORSTATUS_RESOURCEUNAVAILABLE;
                    goto Exit;
                }
                // free the original VarBind->name
                SnmpUtilOidFree(&tmpOid);
            }

            ErrStat = MIB_srvcs_copyfromtable( Entry, Field, VarBind );

            break;

        case MIB_ACTION_SET:
            ErrStat = SNMP_ERRORSTATUS_NOSUCHNAME;
            break;

        default:
            ErrStat = SNMP_ERRORSTATUS_GENERR;
    }

Exit:
    return ErrStat;
} // MIB_srvcs_func



//
// MIB_srvcs_get
//    Retrieve Service Table information.
//
// Notes:
//
// Return Codes:
//    None.
//
// Error Codes:
//    None.
//
UINT MIB_srvcs_get(
        IN OUT RFC1157VarBind *VarBind
    )

{
UINT   Entry;
int    Found;
UINT   ErrStat;

   if (VarBind->name.ids[SRVC_FIELD_SUBID] < SRVC_FIRST_FIELD ||
       VarBind->name.ids[SRVC_FIELD_SUBID] > SRVC_LAST_FIELD)
       {
       ErrStat = SNMP_ERRORSTATUS_NOSUCHNAME;
       goto Exit;
       }

   // Fill the Service Table with the info from server
   if ( SNMPAPI_ERROR == MIB_srvcs_lmget() )
      {
      ErrStat = SNMP_ERRORSTATUS_GENERR;
      goto Exit;
      }

   Found = MIB_srvcs_match( &VarBind->name, &Entry );

   // Look for a complete OID match
   if ( Found != MIB_TBL_POS_FOUND )
      {
      ErrStat = SNMP_ERRORSTATUS_NOSUCHNAME;
      goto Exit;
      }

   // Copy data from table
   ErrStat = MIB_srvcs_copyfromtable( Entry, VarBind->name.ids[SRVC_FIELD_SUBID],
                                     VarBind );

Exit:
   return ErrStat;
} // MIB_srvcs_get



//
// MIB_srvcs_match
//    Match the target OID with a location in the Service Table
//
// Notes:
//
// Return Codes:
//    None.
//
// Error Codes:
//    None
//
int MIB_srvcs_match(
       IN AsnObjectIdentifier *Oid,
       OUT UINT *Pos
       )

{
AsnObjectIdentifier TempOid;
int                 nResult;


   // Remove prefix including field reference
   TempOid.idLength = Oid->idLength - MIB_OidPrefix.idLength -
                      MIB_SrvcPrefix.idLength - 1;
   TempOid.ids = &Oid->ids[MIB_OidPrefix.idLength+MIB_SrvcPrefix.idLength+1];

   *Pos = 0;
   while ( *Pos < MIB_SrvcTable.Len )
      {
      nResult = SnmpUtilOidCmp( &TempOid, &MIB_SrvcTable.Table[*Pos].Oid );
      if ( !nResult )
         {
         nResult = MIB_TBL_POS_FOUND;

         goto Exit;
         }

      if ( nResult < 0 )
         {
         nResult = MIB_TBL_POS_BEFORE;

         goto Exit;
         }

      (*Pos)++;
      }

   nResult = MIB_TBL_POS_END;

Exit:
   return nResult;
}



//
// MIB_srvcs_copyfromtable
//    Copy requested data from table structure into Var Bind.
//
// Notes:
//
// Return Codes:
//    None.
//
// Error Codes:
//    None.
//
UINT MIB_srvcs_copyfromtable(
        IN UINT Entry,
        IN UINT Field,
        OUT RFC1157VarBind *VarBind
        )

{
UINT ErrStat;


   // Get the requested field and save in var bind
   switch( Field )
      {
      case SRVC_NAME_FIELD:
         // Alloc space for string
         VarBind->value.asnValue.string.stream = SnmpUtilMemAlloc( sizeof(char)
                       * MIB_SrvcTable.Table[Entry].svSvcName.length );
         if ( VarBind->value.asnValue.string.stream == NULL )
            {
            ErrStat = SNMP_ERRORSTATUS_GENERR;
            goto Exit;
            }

         // Copy string into return position
         memcpy( VarBind->value.asnValue.string.stream,
                       MIB_SrvcTable.Table[Entry].svSvcName.stream,
                       MIB_SrvcTable.Table[Entry].svSvcName.length );

         // Set string length
         VarBind->value.asnValue.string.length =
                          MIB_SrvcTable.Table[Entry].svSvcName.length;
         VarBind->value.asnValue.string.dynamic = TRUE;

         // Set type of var bind
         VarBind->value.asnType = ASN_RFC1213_DISPSTRING;
         break;

      case SRVC_INSTALLED_FIELD:
         // Set value of var bind
         VarBind->value.asnValue.number =
                            MIB_SrvcTable.Table[Entry].svSvcInstalledState;
         VarBind->value.asnType = ASN_INTEGER;
         break;

      case SRVC_OPERATING_FIELD:
         // Set value of var bind
         VarBind->value.asnValue.number =
                            MIB_SrvcTable.Table[Entry].svSvcOperatingState;
         VarBind->value.asnType = ASN_INTEGER;
         break;

      case SRVC_UNINSTALLED_FIELD:
         // Set value of var bind
         VarBind->value.asnValue.number =
                      MIB_SrvcTable.Table[Entry].svSvcCanBeUninstalled;
         VarBind->value.asnType = ASN_INTEGER;
         break;

      case SRVC_PAUSED_FIELD:
         // Set value of var bind
         VarBind->value.asnValue.number =
                                MIB_SrvcTable.Table[Entry].svSvcCanBePaused;
         VarBind->value.asnType = ASN_INTEGER;
         break;

      default:
         SNMPDBG(( SNMP_LOG_TRACE, "LMMIB2: Internal Error Services Table\n" ));
         ErrStat = SNMP_ERRORSTATUS_GENERR;

         goto Exit;
      }

   ErrStat = SNMP_ERRORSTATUS_NOERROR;

Exit:
   return ErrStat;
} // MIB_srvcs_copyfromtable

//-------------------------------- END --------------------------------------