plugins/cbqos/Collector/Cisco_cbQoS.pm

   1 #  Copyright (C) 2002  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  16
  17 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  18
  19 ## no critic (Modules::RequireFilenameMatchesPackage)
  20
  21
  22 package Torrus::Collector::Cisco_cbQoS;
  23
  24 use Torrus::Collector::Cisco_cbQoS_Params;
  25
  26 use strict;
  27 use warnings;
  28
  29 use Torrus::ConfigTree;
  30 use Torrus::Collector::SNMP;
  31 use Torrus::Log;
  32 use Net::hostent;
  33 use Socket;
  34 use Net::SNMP qw(:snmp);
  35
  36 # Register the collector type
  37 $Torrus::Collector::collectorTypes{'cisco-cbqos'} = 1;
  38
  39
  40 # List of needed parameters and default values
  41
  42 $Torrus::Collector::params{'cisco-cbqos'} =
  43     \%Torrus::Collector::Cisco_cbQoS_Params::requiredLeafParams;
  44
  45 # Copy parameters from SNMP collector
  46 while( my($key, $val) = each %{$Torrus::Collector::params{'snmp'}} )
  47 {
  48     $Torrus::Collector::params{'cisco-cbqos'}{$key} = $val;
  49 }
  50
  51 my %oiddef =
  52     (
  53      # IF-MIB
  54      'ifDescr'          => '1.3.6.1.2.1.2.2.1.2',
  55
  56      # CISCO-CLASS-BASED-QOS-MIB
  57      'cbQosServicePolicyTable'         => '1.3.6.1.4.1.9.9.166.1.1.1',
  58      'cbQosPolicyIndex'                => '1.3.6.1.4.1.9.9.166.1.1.1.1.1',
  59      'cbQosIfType'                     => '1.3.6.1.4.1.9.9.166.1.1.1.1.2',
  60      'cbQosPolicyDirection'            => '1.3.6.1.4.1.9.9.166.1.1.1.1.3',
  61      'cbQosIfIndex'                    => '1.3.6.1.4.1.9.9.166.1.1.1.1.4',
  62      'cbQosFrDLCI'                     => '1.3.6.1.4.1.9.9.166.1.1.1.1.5',
  63      'cbQosAtmVPI'                     => '1.3.6.1.4.1.9.9.166.1.1.1.1.6',
  64      'cbQosAtmVCI'                     => '1.3.6.1.4.1.9.9.166.1.1.1.1.7',
  65      # These two are accepted and ignored, probably will be supported later.
  66      # In some older IOSes these object don't present in the table
  67      'cbQosEntityIndex'                => '1.3.6.1.4.1.9.9.166.1.1.1.1.8',
  68      'cbQosVlanIndex'                  => '1.3.6.1.4.1.9.9.166.1.1.1.1.9',
  69
  70      'cbQosObjectsTable'               => '1.3.6.1.4.1.9.9.166.1.5.1',
  71      'cbQosObjectsIndex'               => '1.3.6.1.4.1.9.9.166.1.5.1.1.1',
  72      'cbQosConfigIndex'                => '1.3.6.1.4.1.9.9.166.1.5.1.1.2',
  73      'cbQosObjectsType'                => '1.3.6.1.4.1.9.9.166.1.5.1.1.3',
  74      'cbQosParentObjectsIndex'         => '1.3.6.1.4.1.9.9.166.1.5.1.1.4',
  75
  76      'cbQosPolicyMapName'              => '1.3.6.1.4.1.9.9.166.1.6.1.1.1',
  77      'cbQosCMName'                     => '1.3.6.1.4.1.9.9.166.1.7.1.1.1',
  78      'cbQosMatchStmtName'              => '1.3.6.1.4.1.9.9.166.1.8.1.1.1',
  79      'cbQosQueueingCfgBandwidth'       => '1.3.6.1.4.1.9.9.166.1.9.1.1.1',
  80      'cbQosPoliceCfgRate'              => '1.3.6.1.4.1.9.9.166.1.12.1.1.1',
  81      'cbQosTSCfgRate'                  => '1.3.6.1.4.1.9.9.166.1.13.1.1.1',
  82      );
  83
  84 my %oidrev;
  85
  86 while( my($name, $oid) = each %oiddef )
  87 {
  88     $oidrev{$oid} = $name;
  89 }
  90
  91 my $policyActionTranslation = {
  92     'transmit'          => 1,
  93     'setIpDSCP'         => 2,
  94     'setIpPrecedence'   => 3,
  95     'setQosGroup'       => 4,
  96     'drop'              => 5,
  97     'setMplsExp'        => 6,
  98     'setAtmClp'         => 7,
  99     'setFrDe'           => 8,
 100     'setL2Cos'          => 9,
 101     'setDiscardClass'   => 10
 102     };
 103
 104 my %cbQosValueTranslation =
 105     (
 106      'cbQosIfType' => {
 107          'mainInterface'  => 1,
 108          'subInterface'   => 2,
 109          'frDLCI'         => 3,
 110          'atmPVC'         => 4,
 111          'controlPlane'   => 5,
 112          'vlanPort'       => 6 },
 113
 114      'cbQosPolicyDirection' => {
 115          'input'          => 1,
 116          'output'         => 2 },
 117
 118      'cbQosObjectsType' => {
 119          'policymap'      => 1,
 120          'classmap'       => 2,
 121          'matchStatement' => 3,
 122          'queueing'       => 4,
 123          'randomDetect'   => 5,
 124          'trafficShaping' => 6,
 125          'police'         => 7,
 126          'set'            => 8 },
 127
 128      'cbQosPoliceCfgConformAction'  => $policyActionTranslation,
 129      'cbQosPoliceCfgExceedAction'   => $policyActionTranslation,
 130      'cbQosPoliceCfgViolateAction'  => $policyActionTranslation
 131      );
 132
 133
 134 sub translateCbQoSValue
 135 {
 136     my $value = shift;
 137     my $name = shift;
 138
 139     if( defined( $cbQosValueTranslation{$name} ) )
 140     {
 141         if( not defined( $cbQosValueTranslation{$name}{$value} ) )
 142         {
 143             die('Unknown value to translate for ' . $name .
 144                 ': "' . $value . '"');
 145         }
 146
 147         $value = $cbQosValueTranslation{$name}{$value};
 148     }
 149
 150     return $value;
 151 }
 152
 153
 154 my %servicePolicyTableParams =
 155     (
 156      'cbQosIfType'                     => 'cbqos-interface-type',
 157      'cbQosPolicyDirection'            => 'cbqos-direction',
 158      'cbQosFrDLCI'                     => 'cbqos-fr-dlci',
 159      'cbQosAtmVPI'                     => 'cbqos-atm-vpi',
 160      'cbQosAtmVCI'                     => 'cbqos-atm-vci'
 161      );
 162
 163
 164 # This list defines the order for entries mapping in
 165 # $ServicePolicyMapping
 166
 167 my @servicePolicyTableEntries =
 168     ( 'cbQosIfType', 'cbQosPolicyDirection', 'cbQosIfIndex',
 169       'cbQosFrDLCI', 'cbQosAtmVPI', 'cbQosAtmVCI' );
 170
 171
 172 my %objTypeAttributes =
 173     (
 174      # 'policymap'
 175      1 => {
 176          'name-oid'   => 'cbQosPolicyMapName' },
 177
 178      # 'classmap'
 179      2 => {
 180          'name-param' => 'cbqos-class-map-name',
 181          'name-oid'   => 'cbQosCMName' },
 182
 183      # 'matchStatement'
 184      3 => {
 185          'name-param' => 'cbqos-match-statement-name',
 186          'name-oid'   => 'cbQosMatchStmtName' },
 187
 188      # 'queueing'
 189      4 => {
 190          'name-param' => 'cbqos-queueing-bandwidth',
 191          'name-oid'   => 'cbQosQueueingCfgBandwidth' },
 192
 193      # 'randomDetect'
 194      5 => {},
 195
 196      # 'trafficShaping'
 197      6 => {
 198          'name-param' => 'cbqos-shaping-rate',
 199          'name-oid'   => 'cbQosTSCfgRate' },
 200
 201      # 'police'
 202      7 => {
 203          'name-param' => 'cbqos-police-rate',
 204          'name-oid'   => 'cbQosPoliceCfgRate' }
 205      );
 206
 207 my %ServicePolicyTable;
 208 my %ServicePolicyMapping;
 209 my %ObjectsTable;
 210 my %CfgTable;
 211
 212
 213 # This is first executed per target
 214
 215 $Torrus::Collector::initTarget{'cisco-cbqos'} =
 216     \&Torrus::Collector::Cisco_cbQoS::initTarget;
 217
 218 # Derive 'snmp-object' from cbQoS maps and pass the control to SNMP collector
 219
 220 sub initTarget
 221 {
 222     my $collector = shift;
 223     my $token = shift;
 224
 225     my $tref = $collector->tokenData( $token );
 226     my $cref = $collector->collectorData( 'cisco-cbqos' );
 227
 228     $cref->{'QosEnabled'}{$token} = 1;
 229
 230     $collector->registerDeleteCallback
 231         ( $token, \&Torrus::Collector::Cisco_cbQoS::deleteTarget );
 232
 233     my $hosthash =
 234         Torrus::Collector::SNMP::getHostHash( $collector, $token );
 235     if( not defined( $hosthash ) )
 236     {
 237         $collector->deleteTarget($token);
 238         return 0;
 239     }
 240     $tref->{'hosthash'} = $hosthash;
 241
 242     return Torrus::Collector::Cisco_cbQoS::initTargetAttributes
 243         ( $collector, $token );
 244 }
 245
 246
 247 # Recursively create the object name
 248
 249 sub make_full_name
 250 {
 251     my $objhash = shift;
 252     my $hosthash = shift;
 253     my $attr = shift;
 254     my $cref = shift;
 255
 256
 257     # Compose the object ID as "parent:type:name" string
 258     my $objectID = '';
 259
 260     my $parentIndex = $attr->{'cbQosParentObjectsIndex'};
 261     if( $parentIndex > 0 )
 262     {
 263         $objectID =
 264             make_full_name($objhash, $hosthash,
 265                            $objhash->{$parentIndex}, $cref);
 266     }
 267
 268     if( $objectID ) {
 269         $objectID .= ':';
 270     }
 271
 272     my $objType = $attr->{'cbQosObjectsType'};
 273
 274     my $objCfgIndex = $attr->{'cbQosConfigIndex'};
 275
 276     my $objNameOid = $objTypeAttributes{$objType}{'name-oid'};
 277
 278     if( defined($objNameOid) )
 279     {
 280         $objectID .= $CfgTable{$hosthash}{
 281             $objCfgIndex}{$objNameOid};
 282     }
 283
 284     $objectID .= ':' . $objType;
 285
 286     return $objectID;
 287 }
 288
 289
 290 sub initTargetAttributes
 291 {
 292     my $collector = shift;
 293     my $token = shift;
 294
 295     my $tref = $collector->tokenData( $token );
 296     my $cref = $collector->collectorData( 'cisco-cbqos' );
 297
 298     if( Torrus::Collector::SNMP::activeMappingSessions() > 0 )
 299     {
 300         # ifDescr mapping tables are not yet ready
 301         $cref->{'cbQoSNeedsRemapping'}{$token} = 1;
 302         return 1;
 303     }
 304
 305     my $hosthash = $tref->{'hosthash'};
 306
 307     if( Torrus::Collector::SNMP::isHostDead( $collector, $hosthash ) )
 308     {
 309         return 0;
 310     }
 311
 312     if( not Torrus::Collector::SNMP::checkUnreachableRetry
 313         ( $collector, $hosthash ) )
 314     {
 315         return 1;
 316     }
 317
 318     my $ifDescr = $collector->param($token, 'cbqos-interface-name');
 319     my $ifIndex =
 320         Torrus::Collector::SNMP::lookupMap( $collector, $token,
 321                                             $hosthash,
 322                                             $oiddef{'ifDescr'}, $ifDescr );
 323
 324     if( not defined( $ifIndex ) )
 325     {
 326         Debug('ifDescr mapping tables are not yet ready for ' . $hosthash);
 327         $cref->{'cbQoSNeedsRemapping'}{$token} = 1;
 328         return 1;
 329     }
 330     elsif( $ifIndex eq 'notfound' )
 331     {
 332         Error("Cannot find ifDescr mapping for $ifDescr at $hosthash");
 333         return
 334     }
 335
 336     my $session = Torrus::Collector::SNMP::openBlockingSession
 337         ( $collector, $token, $hosthash );
 338     if( not defined($session) )
 339     {
 340         return 0;
 341     }
 342
 343     my $maxrepetitions = $collector->param($token, 'snmp-maxrepetitions');
 344
 345     # Retrieve and translate cbQosServicePolicyTable
 346
 347     if( not defined $ServicePolicyTable{$hosthash} )
 348     {
 349         Debug('Retrieving Cisco cbQoS maps from ' . $hosthash);
 350
 351         my $ref = {};
 352         $ServicePolicyTable{$hosthash} = $ref;
 353
 354         my $result =
 355             $session->get_table
 356             ( -baseoid => $oiddef{'cbQosServicePolicyTable'},
 357               -maxrepetitions => $maxrepetitions );
 358         if( not defined( $result ) )
 359         {
 360             Error('Error retrieving cbQosServicePolicyTable from ' .
 361                   $hosthash . ': ' . $session->error());
 362
 363             # When the remote agent is reacheable, but system objecs are
 364             # not implemented, we get a positive error_status
 365             if( $session->error_status() == 0 )
 366             {
 367                 return Torrus::Collector::SNMP::probablyDead
 368                     ( $collector, $hosthash );
 369             }
 370             else
 371             {
 372                 return 0;
 373             }
 374         }
 375
 376         while( my( $oid, $val ) = each %{$result} )
 377         {
 378             my $prefixlen = rindex( $oid, '.' );
 379             my $prefixOid = substr( $oid, 0, $prefixlen );
 380             my $policyIndex = substr( $oid, $prefixlen + 1 );
 381
 382             my $entryName = $oidrev{$prefixOid};
 383             if( not defined $entryName )
 384             {
 385                 Warn("Unknown OID: $prefixOid");
 386             }
 387             else
 388             {
 389                 $ref->{$policyIndex}{$entryName} = $val;
 390             }
 391         }
 392
 393         my $mapRef = {};
 394         $ServicePolicyMapping{$hosthash} = $mapRef;
 395
 396         for my $policyIndex ( keys %{$ref} )
 397         {
 398             my $mapString = '';
 399             for my $entryName ( @servicePolicyTableEntries )
 400             {
 401                 $mapString .=
 402                     sprintf( '%d:', $ref->{$policyIndex}{$entryName} );
 403             }
 404             $mapRef->{$mapString} = $policyIndex;
 405         }
 406     }
 407
 408     # Retrieve config information from cbQosxxxCfgTable
 409
 410     if( not defined $CfgTable{$hosthash} )
 411     {
 412         my $ref = {};
 413         $CfgTable{$hosthash} = $ref;
 414
 415         for my $table ( 'cbQosPolicyMapName', 'cbQosCMName',
 416                             'cbQosMatchStmtName', 'cbQosQueueingCfgBandwidth',
 417                             'cbQosTSCfgRate', 'cbQosPoliceCfgRate' )
 418         {
 419             my $result =
 420                 $session->get_table( -baseoid => $oiddef{$table},
 421                                      -maxrepetitions => $maxrepetitions );
 422             if( defined( $result ) )
 423             {
 424                 while( my( $oid, $val ) = each %{$result} )
 425                 {
 426                     # Chop heading and trailing space
 427                     $val =~ s/^\s+//;
 428                     $val =~ s/\s+$//;
 429
 430                     my $prefixlen = rindex( $oid, '.' );
 431                     my $prefixOid = substr( $oid, 0, $prefixlen );
 432                     my $cfgIndex = substr( $oid, $prefixlen + 1 );
 433
 434                     my $entryName = $oidrev{$prefixOid};
 435                     if( not defined $entryName )
 436                     {
 437                         Warn("Unknown OID: $prefixOid");
 438                     }
 439                     else
 440                     {
 441                         $ref->{$cfgIndex}{$entryName} = $val;
 442                     }
 443                 }
 444             }
 445         }
 446     }
 447
 448     # Retrieve and translate cbQosObjectsTable
 449
 450     if( not defined $ObjectsTable{$hosthash} )
 451     {
 452         my $ref = {};
 453         $ObjectsTable{$hosthash} = $ref;
 454
 455         my $result =
 456             $session->get_table( -baseoid => $oiddef{'cbQosObjectsTable'},
 457                                  -maxrepetitions => $maxrepetitions );
 458         if( not defined( $result ) )
 459         {
 460             Error('Error retrieving cbQosObjectsTable from ' . $hosthash .
 461                   ': ' . $session->error());
 462
 463             # When the remote agent is reacheable, but system objecs are
 464             # not implemented, we get a positive error_status
 465             if( $session->error_status() == 0 )
 466             {
 467                 return Torrus::Collector::SNMP::probablyDead
 468                     ( $collector, $hosthash );
 469             }
 470             else
 471             {
 472                 return 0;
 473             }
 474         }
 475
 476         my $confIndexOid = $oiddef{'cbQosConfigIndex'};
 477         my $objTypeOid = $oiddef{'cbQosObjectsType'};
 478
 479         my %objects;
 480
 481         while( my( $oid, $val ) = each %{$result} )
 482         {
 483             my $prefixlen = rindex( $oid, '.' );
 484             my $objIndex = substr( $oid, $prefixlen + 1 );
 485             my $prefixOid = substr( $oid, 0, $prefixlen );
 486
 487             $prefixlen = rindex( $prefixOid, '.' );
 488             my $policyIndex = substr( $prefixOid, $prefixlen + 1 );
 489             $prefixOid = substr( $prefixOid, 0, $prefixlen );
 490
 491             my $entryName = $oidrev{$prefixOid};
 492
 493             $objects{$policyIndex}{$objIndex}{$entryName} = $val;
 494         }
 495
 496         while( my( $policyIndex, $objhash ) = each %objects )
 497         {
 498             while( my( $objIndex, $attr ) = each %{$objhash} )
 499             {
 500                 my $objType = $attr->{'cbQosObjectsType'};
 501                 next if not defined( $objTypeAttributes{$objType} );
 502
 503                 my $objectID =
 504                     make_full_name( $objhash, $hosthash, $attr, $cref );
 505
 506                 $ref->{$policyIndex}{$objectID} = $objIndex;
 507             }
 508         }
 509     }
 510
 511     # Finished retrieving tables
 512     # now find the snmp-object from token parameters
 513
 514     # Prepare values for cbQosServicePolicyTable match
 515
 516     my %policyParamValues = ( 'cbQosIfIndex' => $ifIndex );
 517     while( my($name, $param) = each %servicePolicyTableParams )
 518     {
 519         my $val = $collector->param($token, $param);
 520         $val = translateCbQoSValue( $val, $name );
 521         $policyParamValues{$name} = $val;
 522     }
 523
 524     # Find the entry in cbQosServicePolicyTable
 525
 526     my $mapRef = $ServicePolicyMapping{$hosthash};
 527
 528     my $mapString = '';
 529     for my $entryName ( @servicePolicyTableEntries )
 530     {
 531         $mapString .=
 532             sprintf( '%d:', $policyParamValues{$entryName} );
 533     }
 534
 535     my $thePolicyIndex = $mapRef->{$mapString};
 536     if( not defined( $thePolicyIndex ) )
 537     {
 538         Error('Cannot find cbQosServicePolicyTable mapping for ' .
 539               $mapString);
 540         return
 541     }
 542
 543     # compose the object ID from token parameters as "parent:type:name" string
 544
 545     my $theObjectID = $collector->param($token, 'cbqos-full-name');
 546
 547     my $theObjectIndex = $ObjectsTable{$hosthash}->{
 548         $thePolicyIndex}{$theObjectID};
 549
 550     if( not defined( $theObjectIndex ) )
 551     {
 552         Error('Cannot find object index for ' . $thePolicyIndex . ':' .
 553               '--' . $theObjectID);
 554         return
 555     }
 556
 557     # Finally we got the object to monitor!
 558
 559     # Prepare the object for snmp collector
 560     my $theOid = $collector->param( $token, 'snmp-object' );
 561     $theOid =~ s/POL/$thePolicyIndex/;
 562     $theOid =~ s/OBJ/$theObjectIndex/;
 563     $collector->setParam( $token, 'snmp-object', $theOid );
 564
 565     return Torrus::Collector::SNMP::initTargetAttributes( $collector, $token );
 566 }
 567
 568
 569 # Main collector cycle is actually the SNMP collector
 570
 571 $Torrus::Collector::runCollector{'cisco-cbqos'} =
 572     \&Torrus::Collector::SNMP::runCollector;
 573
 574
 575 # Execute this after the collector has finished
 576
 577 $Torrus::Collector::postProcess{'cisco-cbqos'} =
 578     \&Torrus::Collector::Cisco_cbQoS::postProcess;
 579
 580 sub postProcess
 581 {
 582     my $collector = shift;
 583     my $cref = shift;
 584
 585     # We use some SNMP collector internals
 586     my $scref = $collector->collectorData( 'snmp' );
 587
 588     my %remapping_hosts;
 589
 590     # Flush all QoS object mapping
 591     for my $token ( keys %{$scref->{'needsRemapping'}},
 592                         keys %{$cref->{'cbQoSNeedsRemapping'}} )
 593     {
 594         if( $cref->{'QosEnabled'}{$token} )
 595         {
 596             my $tref = $collector->tokenData( $token );
 597             my $hosthash = $tref->{'hosthash'};
 598
 599             if( not defined($remapping_hosts{$hosthash}) )
 600             {
 601                 $remapping_hosts{$hosthash} = [];
 602             }
 603             push(@{$remapping_hosts{$hosthash}}, $token);
 604         }
 605     }
 606
 607     while(my ($hosthash, $tokens) = each %remapping_hosts )
 608     {
 609         delete $ServicePolicyTable{$hosthash};
 610         delete $ServicePolicyMapping{$hosthash};
 611         delete $ObjectsTable{$hosthash};
 612         delete $CfgTable{$hosthash};
 613
 614         for my $token (@{$tokens})
 615         {
 616             delete $scref->{'needsRemapping'}{$token};
 617             delete $cref->{'cbQoSNeedsRemapping'}{$token};
 618             if( not Torrus::Collector::Cisco_cbQoS::initTargetAttributes
 619                 ( $collector, $token ) )
 620             {
 621                 $collector->deleteTarget($token);
 622             }
 623         }
 624     }
 625
 626     return;
 627 }
 628
 629
 630 # Callback executed by Collector
 631
 632 sub deleteTarget
 633 {
 634     my $collector = shift;
 635     my $token = shift;
 636
 637     my $cref = $collector->collectorData( 'cisco-cbqos' );
 638
 639     delete $cref->{'QosEnabled'}{$token};
 640
 641     Torrus::Collector::SNMP::deleteTarget( $collector, $token );
 642
 643     return;
 644 }
 645
 646
 647
 648 1;
 649
 650
 651 # Local Variables:
 652 # mode: perl
 653 # indent-tabs-mode: nil
 654 # perl-indent-level: 4
 655 # End: