Subversion Repositories openrisc

//==========================================================================

//

//      ./agent/current/src/agent_registry.c

//

//

//==========================================================================

// ####ECOSGPLCOPYRIGHTBEGIN####                                            

// -------------------------------------------                              

// This file is part of eCos, the Embedded Configurable Operating System.   

// Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.

//

// eCos is free software; you can redistribute it and/or modify it under    

// the terms of the GNU General Public License as published by the Free     

// Software Foundation; either version 2 or (at your option) any later      

// version.                                                                 

//

// eCos is distributed in the hope that it will be useful, but WITHOUT      

// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or    

// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License    

// for more details.                                                        

//

// You should have received a copy of the GNU General Public License        

// along with eCos; if not, write to the Free Software Foundation, Inc.,    

// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.            

//

// As a special exception, if other files instantiate templates or use      

// macros or inline functions from this file, or you compile this file      

// and link it with other works to produce a work based on this file,       

// this file does not by itself cause the resulting work to be covered by   

// the GNU General Public License. However the source code for this file    

// must still be made available in accordance with section (3) of the GNU   

// General Public License v2.                                               

//

// This exception does not invalidate any other reasons why a work based    

// on this file might be covered by the GNU General Public License.         

// -------------------------------------------                              

// ####ECOSGPLCOPYRIGHTEND####                                              

//####UCDSNMPCOPYRIGHTBEGIN####

//

// -------------------------------------------

//

// Portions of this software may have been derived from the UCD-SNMP

// project,  <http://ucd-snmp.ucdavis.edu/>  from the University of

// California at Davis, which was originally based on the Carnegie Mellon

// University SNMP implementation.  Portions of this software are therefore

// covered by the appropriate copyright disclaimers included herein.

//

// The release used was version 4.1.2 of May 2000.  "ucd-snmp-4.1.2"

// -------------------------------------------

//

//####UCDSNMPCOPYRIGHTEND####

//==========================================================================

//#####DESCRIPTIONBEGIN####

//

// Author(s):    hmt

// Contributors: hmt

// Date:         2000-05-30

// Purpose:      Port of UCD-SNMP distribution to eCos.

// Description:  

//              

//

//####DESCRIPTIONEND####

//

//==========================================================================

/********************************************************************

       Copyright 1989, 1991, 1992 by Carnegie Mellon University

                          Derivative Work -

Copyright 1996, 1998, 1999, 2000 The Regents of the University of California

                         All Rights Reserved

Permission to use, copy, modify and distribute this software and its

documentation for any purpose and without fee is hereby granted,

provided that the above copyright notice appears in all copies and

that both that copyright notice and this permission notice appear in

supporting documentation, and that the name of CMU and The Regents of

the University of California not be used in advertising or publicity

pertaining to distribution of the software without specific written

permission.

CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIM ALL

WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL CMU OR

THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BE LIABLE FOR ANY SPECIAL,

INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING

FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF

CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN

CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

*********************************************************************/

/*

 * agent_registry.c

 *

 * Maintain a registry of MIB subtrees, together

 *   with related information regarding mibmodule, sessions, etc

 */

#define IN_SNMP_VARS_C

#include <config.h>

#if HAVE_STRING_H

#include <string.h>

#endif

#if HAVE_STDLIB_H

#include <stdlib.h>

#endif

#include <sys/types.h>

#include <stdio.h>

#if HAVE_FCNTL_H

#include <fcntl.h>

#endif

#if HAVE_WINSOCK_H

#include <winsock.h>

#endif

#if TIME_WITH_SYS_TIME

# ifdef WIN32

#  include <sys/timeb.h>

# else

#  include <sys/time.h>

# endif

# include <time.h>

#else

# if HAVE_SYS_TIME_H

#  include <sys/time.h>

# else

#  include <time.h>

# endif

#endif

#if HAVE_DMALLOC_H

#include <dmalloc.h>

#endif

#include "mibincl.h"

#include "snmp_client.h"

#include "default_store.h"

#include "ds_agent.h"

#include "callback.h"

#include "agent_callbacks.h"

#include "agent_registry.h"

#include "snmp_alarm.h"

#include "snmpd.h"

#include "mibgroup/struct.h"

#include "mib_module_includes.h"

#ifdef USING_AGENTX_SUBAGENT_MODULE

#include "agentx/subagent.h"

#include "agentx/client.h"

#endif

struct snmp_index {

    struct variable_list        varbind;        /* or pointer to var_list ? */

    struct snmp_session         *session;       /* NULL implies unused  ? */

    struct snmp_index           *next_oid;

    struct snmp_index           *prev_oid;

    struct snmp_index           *next_idx;

} *snmp_index_head = NULL;

struct subtree *subtrees;

int tree_compare(const struct subtree *ap, const struct subtree *bp)

{

  return snmp_oid_compare(ap->name,ap->namelen,bp->name,bp->namelen);

}

        /*

         *  Split the subtree into two at the specified point,

         *    returning the new (second) subtree

         */

struct subtree *

split_subtree(struct subtree *current, oid name[], int name_len )

{

    struct subtree *new_sub, *ptr;

    int i;

    char *cp;

    if ( snmp_oid_compare(name, name_len,

                          current->end, current->end_len) > 0 )

        return NULL;    /* Split comes after the end of this subtree */

    new_sub = (struct subtree *)malloc(sizeof(struct subtree));

    if ( new_sub == NULL )

        return NULL;

    memcpy(new_sub, current, sizeof(struct subtree));

        /* Set up the point of division */

    memcpy(current->end,   name, name_len*sizeof(oid));

    memcpy(new_sub->start, name, name_len*sizeof(oid));

    current->end_len   = name_len;

    new_sub->start_len = name_len;

        /*

         * Split the variables between the two new subtrees

         */

    i = current->variables_len;

    current->variables_len = 0;

    for ( ; i > 0 ; i-- ) {

                /* Note that the variable "name" field omits

                   the prefix common to the whole registration,

                   hence the strange comparison here */

        if ( snmp_oid_compare( new_sub->variables[0].name,

                               new_sub->variables[0].namelen,

                               name     + current->namelen,

                               name_len - current->namelen ) >= 0 )

            break;      /* All following variables belong to the second subtree */

        current->variables_len++;

        new_sub->variables_len--;

        cp = (char *)new_sub->variables;

        new_sub->variables = (struct variable *)(cp + new_sub->variables_width);

    }

        /* Delegated trees should retain their variables regardless */

    if ( current->variables_len > 0 &&

                IS_DELEGATED((u_char)current->variables[0].type)) {

        new_sub->variables_len = 1;

        new_sub->variables     = current->variables;

    }

        /* Propogate this split down through any children */

    if ( current->children )

        new_sub->children = split_subtree(current->children, name, name_len);

        /* Retain the correct linking of the list */

    for ( ptr = current ; ptr != NULL ; ptr=ptr->children )

          ptr->next = new_sub;

    for ( ptr = new_sub ; ptr != NULL ; ptr=ptr->children )

          ptr->prev = current;

    for ( ptr = new_sub->next ; ptr != NULL ; ptr=ptr->children )

          ptr->prev = new_sub;

    return new_sub;

}

int

load_subtree( struct subtree *new_sub )

{

    struct subtree *tree1, *tree2, *new2;

    struct subtree *prev, *next;

    int res;

    if ( new_sub == NULL )

        return MIB_REGISTERED_OK;       /* Degenerate case */

                /*

                 * Find the subtree that contains the start of

                 *  the new subtree (if any)...

                 */

    tree1 = find_subtree( new_sub->start, new_sub->start_len, NULL );

                /*

                 * ...and the subtree that follows the new one

                 *      (NULL implies this is the final region covered)

                 */

    if ( tree1 == NULL )

        tree2 = find_subtree_next( new_sub->start, new_sub->start_len, NULL );

    else

        tree2 = tree1->next;

        /*

         * Handle new subtrees that start in virgin territory.

         */

    if ( tree1 == NULL ) {

        new2 = NULL;

                /* Is there any overlap with later subtrees ? */

        if ( tree2 && snmp_oid_compare( new_sub->end, new_sub->end_len,

                                        tree2->start, tree2->start_len ) > 0 )

            new2 = split_subtree( new_sub, tree2->start, tree2->start_len );

                /*

                 * Link the new subtree (less any overlapping region)

                 *  with the list of existing registrations

                 */

        if ( tree2 ) {

            new_sub->prev = tree2->prev;

            tree2->prev       = new_sub;

        }

        else

            new_sub->prev = find_subtree_previous( new_sub->start, new_sub->start_len, NULL );

        if ( new_sub->prev )

            new_sub->prev->next = new_sub;

        else

            subtrees = new_sub;

        new_sub->next     = tree2;

                /*

                 * If there was any overlap,

                 *  recurse to merge in the overlapping region

                 *  (including anything that may follow the overlap)

                 */

        if ( new2 )

            return load_subtree( new2 );

    }

    else {

        /*

         *  If the new subtree starts *within* an existing registration

         *    (rather than at the same point as it), then split the

         *    existing subtree at this point.

         */

        if ( snmp_oid_compare( new_sub->start, new_sub->start_len,

                               tree1->start,   tree1->start_len) != 0 )

            tree1 = split_subtree( tree1, new_sub->start, new_sub->start_len);

            if ( tree1 == NULL )

                return MIB_REGISTRATION_FAILED;

        /*  Now consider the end of this existing subtree:

         *      If it matches the new subtree precisely,

         *        simply merge the new one into the list of children

         *      If it includes the whole of the new subtree,

         *        split it at the appropriate point, and merge again

         *

         *      If the new subtree extends beyond this existing region,

         *        split it, and recurse to merge the two parts.

         */

         switch ( snmp_oid_compare( new_sub->end, new_sub->end_len,

                                    tree1->end,   tree1->end_len))  {

                case -1:        /* Existing subtree contains new one */

                        (void) split_subtree( tree1,

                                        new_sub->end, new_sub->end_len);

                        /* Fall Through */

                case  0: /* The two trees match precisely */

                        /*

                         * Note: This is the only point where the original

                         *       registration OID ("name") is used

                         */

                        prev = NULL;

                        next = tree1;

                        while ( next && next->namelen > new_sub->namelen ) {

                                prev = next;

                                next = next->children;

                        }

                        while ( next && next->namelen == new_sub->namelen &&

                                        next->priority < new_sub->priority ) {

                                prev = next;

                                next = next->children;

                        }

                        if ( next &&    next->namelen  == new_sub->namelen &&

                                        next->priority == new_sub->priority )

                           return MIB_DUPLICATE_REGISTRATION;

                        if ( prev ) {

                            new_sub->children = next;

                            prev->children    = new_sub;

                            new_sub->prev = prev->prev;

                            new_sub->next = prev->next;

                        }

                        else {

                            new_sub->children = next;

                            new_sub->prev = next->prev;

                            new_sub->next = next->next;

                            for ( next = new_sub->next ;

                                  next != NULL ;

                                  next = next->children )

                                        next->prev = new_sub;

                            for ( prev = new_sub->prev ;

                                  prev != NULL ;

                                  prev = prev->children )

                                        prev->next = new_sub;

                        }

                        break;

                case  1:        /* New subtree contains the existing one */

                        new2 = split_subtree( new_sub,

                                        tree1->end, tree1->end_len);

                        res = load_subtree( new_sub );

                        if ( res != MIB_REGISTERED_OK )

                            return res;

                        return load_subtree( new2 );

         }

    }

    return 0;

}

int

register_mib_range(const char *moduleName,

             struct variable *var,

             size_t varsize,

             size_t numvars,

             oid *mibloc,

             size_t mibloclen,

             int priority,

             int range_subid,

             oid range_ubound,

             struct snmp_session *ss)

{

  struct subtree *subtree, *sub2;

  int res, i;

  struct register_parameters reg_parms;

  subtree = (struct subtree *) malloc(sizeof(struct subtree));

  if ( subtree == NULL )

    return MIB_REGISTRATION_FAILED;

  memset(subtree, 0, sizeof(struct subtree));

  DEBUGMSGTL(("register_mib", "registering \"%s\" at ", moduleName));

  DEBUGMSGOID(("register_mib", mibloc, mibloclen));

  DEBUGMSG(("register_mib","\n"));

        /*

         * Create the new subtree node being registered

         */

  memcpy(subtree->name, mibloc, mibloclen*sizeof(oid));

  subtree->namelen = (u_char) mibloclen;

  memcpy(subtree->start, mibloc, mibloclen*sizeof(oid));

  subtree->start_len = (u_char) mibloclen;

  memcpy(subtree->end, mibloc, mibloclen*sizeof(oid));

  subtree->end[ mibloclen-1 ]++;        /* XXX - or use 'variables' info ? */

  subtree->end_len = (u_char) mibloclen;

  memcpy(subtree->label, moduleName, strlen(moduleName)+1);

  if ( var ) {

    subtree->variables = (struct variable *) malloc(varsize*numvars);

    memcpy(subtree->variables, var, numvars*varsize);

    subtree->variables_len = numvars;

    subtree->variables_width = varsize;

  }

  subtree->priority = priority;

  subtree->session = ss;

  res = load_subtree(subtree);

        /*

         * If registering a range,

         *   use the first subtree as a template

         *   for the rest of the range

         */

  if (( res == MIB_REGISTERED_OK ) && ( range_subid != 0 )) {

    for ( i = mibloc[range_subid-1] +1 ; i < (int)range_ubound ; i++ ) {

        sub2 = (struct subtree *) malloc(sizeof(struct subtree));

        if ( sub2 == NULL ) {

            unregister_mib_range( mibloc, mibloclen, priority,

                                  range_subid, range_ubound);

            return MIB_REGISTRATION_FAILED;

        }

        memcpy( sub2, subtree, sizeof(struct subtree));

        sub2->start[range_subid-1] = i;

        sub2->end[  range_subid-1] = i;         /* XXX - ???? */

        res = load_subtree(sub2);

        if ( res != MIB_REGISTERED_OK ) {

            unregister_mib_range( mibloc, mibloclen, priority,

                                  range_subid, range_ubound);

            return MIB_REGISTRATION_FAILED;

        }

    }

  }

  reg_parms.name = mibloc;

  reg_parms.namelen = mibloclen;

  reg_parms.priority = priority;

  reg_parms.range_subid  = range_subid;

  reg_parms.range_ubound = range_ubound;

  snmp_call_callbacks(SNMP_CALLBACK_APPLICATION, SNMPD_CALLBACK_REGISTER_OID,

                      &reg_parms);

  return res;

}

int

register_mib_priority(const char *moduleName,

             struct variable *var,

             size_t varsize,

             size_t numvars,

             oid *mibloc,

             size_t mibloclen,

             int priority)

{

  return register_mib_range( moduleName, var, varsize, numvars,

                                mibloc, mibloclen, priority, 0, 0, NULL );

}

int

register_mib(const char *moduleName,

             struct variable *var,

             size_t varsize,

             size_t numvars,

             oid *mibloc,

             size_t mibloclen)

{

  return register_mib_priority( moduleName, var, varsize, numvars,

                                mibloc, mibloclen, DEFAULT_MIB_PRIORITY );

}

void

unload_subtree( struct subtree *sub, struct subtree *prev)

{

    struct subtree *ptr;

    if ( prev != NULL ) {       /* non-leading entries are easy */

        prev->children = sub->children;

        return;

    }

                        /* otherwise, we need to amend our neighbours as well */

    if ( sub->children == NULL) {       /* just remove this node completely */

        for (ptr = sub->prev ; ptr ; ptr=ptr->children )

            ptr->next = sub->next;

        for (ptr = sub->next ; ptr ; ptr=ptr->children )

            ptr->prev = sub->prev;

        return;

    }

    else {

        for (ptr = sub->prev ; ptr ; ptr=ptr->children )

            ptr->next = sub->children;

        for (ptr = sub->next ; ptr ; ptr=ptr->children )

            ptr->prev = sub->children;

        return;

    }

}

int

unregister_mib_range( oid *name, size_t len, int priority,

                        int range_subid, oid range_ubound)

{

  struct subtree *list, *myptr;

  struct subtree *prev, *child;             /* loop through children */

  struct register_parameters reg_parms;

  list = find_subtree( name, len, subtrees );

  if ( list == NULL )

        return MIB_NO_SUCH_REGISTRATION;

  for ( child=list, prev=NULL;  child != NULL;

                                prev=child, child=child->children ) {

      if (( snmp_oid_compare( child->name, child->namelen, name, len) == 0 )

          && ( child->priority == priority ))

                break;  /* found it */

  }

  if ( child == NULL )

        return MIB_NO_SUCH_REGISTRATION;

  unload_subtree( child, prev );

  myptr = child;        /* remember this for later */

                /*

                 *  Now handle any occurances in the following subtrees,

                 *      as a result of splitting this range.  Due to the

                 *      nature of the way such splits work, the first

                 *      subtree 'slice' that doesn't refer to the given

                 *      name marks the end of the original region.

                 *

                 *  This should also serve to register ranges.

                 */

  for ( list = myptr->next ; list != NULL ; list=list->next ) {

        for ( child=list, prev=NULL;  child != NULL;

                                      prev=child, child=child->children ) {

            if (( snmp_oid_compare( child->name, child->namelen,

                                                        name, len) == 0 )

                && ( child->priority == priority )) {

                    unload_subtree( child, prev );

                    free_subtree( child );

                    break;

            }

        }

        if ( child == NULL )    /* Didn't find the given name */

            break;

  }

  free_subtree( myptr );

  reg_parms.name = name;

  reg_parms.namelen = len;

  reg_parms.priority = priority;

  reg_parms.range_subid  = range_subid;

  reg_parms.range_ubound = range_ubound;

  snmp_call_callbacks(SNMP_CALLBACK_APPLICATION, SNMPD_CALLBACK_UNREGISTER_OID,

                      &reg_parms);

  return MIB_UNREGISTERED_OK;

}

int

unregister_mib_priority(oid *name, size_t len, int priority)

{

  return unregister_mib_range( name, len, priority, 0, 0 );

}

int

unregister_mib(oid *name,

               size_t len)

{

  return unregister_mib_priority( name, len, DEFAULT_MIB_PRIORITY );

}

void

unregister_mibs_by_session (struct snmp_session *ss)

{

  struct subtree *list, *list2;

  struct subtree *child, *prev, *next_child;

  for( list = subtrees; list != NULL; list = list2) {

    list2 = list->next;

    for ( child=list, prev=NULL;  child != NULL; child=next_child ) {

      next_child = child->children;

      if (( (ss->flags & SNMP_FLAGS_SUBSESSION) && child->session == ss ) ||

          (!(ss->flags & SNMP_FLAGS_SUBSESSION) &&

                                      child->session->subsession == ss )) {

              unload_subtree( child, prev );

              free_subtree( child );

      }

      else

          prev = child;

    }

  }

}

struct subtree *

free_subtree(struct subtree *st)

{

  struct subtree *ret = NULL;

  if ((snmp_oid_compare(st->name, st->namelen, st->start, st->start_len) == 0)

       && (st->variables != NULL))

    free(st->variables);

  if (st->next != NULL)

    ret = st->next;

  free(st);

  return ret;

}

/* in_a_view: determines if a given snmp_pdu is allowed to see a

   given name/namelen OID pointer

   name         IN - name of var, OUT - name matched

   nameLen      IN -number of sub-ids in name, OUT - subid-is in matched name

   pi           IN - relevant auth info re PDU

   cvp          IN - relevant auth info re mib module

*/

int

in_a_view(oid             *name,      /* IN - name of var, OUT - name matched */

          size_t          *namelen,   /* IN -number of sub-ids in name*/

          struct snmp_pdu *pdu,       /* IN - relevant auth info re PDU */

          int              type)      /* IN - variable type being checked */

{

  struct view_parameters view_parms;

  view_parms.pdu = pdu;

  view_parms.name = name;

  if (namelen)

      view_parms.namelen = *namelen;

  else

      view_parms.namelen = 0;

  view_parms.errorcode = 0;

  if (pdu->flags & UCD_MSG_FLAG_ALWAYS_IN_VIEW)

    return 0;            /* Enable bypassing of view-based access control */

  /* check for v1 and counter64s, since snmpv1 doesn't support it */

  if (pdu->version == SNMP_VERSION_1 && type == ASN_COUNTER64)

    return 5;

  switch (pdu->version) {

  case SNMP_VERSION_1:

  case SNMP_VERSION_2c:

#ifdef CYGPKG_SNMPAGENT_V3_SUPPORT

  case SNMP_VERSION_3:

#endif

    snmp_call_callbacks(SNMP_CALLBACK_APPLICATION, SNMPD_CALLBACK_ACM_CHECK,

                        &view_parms);

    return view_parms.errorcode;

  }

  return 1;

}

/* in_a_view: determines if a given snmp_pdu is ever going to be allowed to do

   anynthing or if it's not going to ever be authenticated. */

int

check_access(struct snmp_pdu *pdu)      /* IN - pdu being checked */

{

  struct view_parameters view_parms;

  view_parms.pdu = pdu;

  view_parms.name = 0;

  view_parms.namelen = 0;

  view_parms.errorcode = 0;

  if (pdu->flags & UCD_MSG_FLAG_ALWAYS_IN_VIEW)

    return 0;            /* Enable bypassing of view-based access control */