Interface.pm.in 37.3 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2005-2012 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file 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 Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23 24 25 26 27 28 29 30 31 32 33 34
#
package Interface;

use strict;
use Exporter;
use vars qw(@ISA @EXPORT);

@ISA    = "Exporter";
@EXPORT = qw ( );

use libdb;
use libtestbed;
35
use emutil qw(GenFakeMac);
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
use English;
use Data::Dumper;
use overload ('""' => 'Stringify');

# Configure variables
my $TB		= "@prefix@";
my $BOSSNODE    = "@BOSSNODE@";

# Cache of instances to avoid regenerating them.
my %all_interfaces   = ();
my %node_interfaces  = ();

# Manual
my $debug = 0;

# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

    print STDERR "Running '$command'\n"
	if ($debug);
    return system($command);
}

#
# Lookup interfaces for a node and create a list of class instances to return.
#
64
sub LookupAll($$$)
65
{
66
    my ($class, $nodeid, $pref) = @_;
67

68 69 70
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

71
    # Look in cache first
72 73 74 75 76
    if (exists($node_interfaces{$nodeid})) {
	@$pref = @{ $node_interfaces{$nodeid} };
	return 0;
    }
    @$pref = ();
77 78 79

    my $query_result =
	DBQueryWarn("select * from interfaces ".
80
		    "where node_id='$nodeid' and logical=0");
81

82
    return -1
83
	if (!$query_result);
84
    return 0
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
	if (!$query_result->numrows);

    my $results = [];

    while (my $rowref = $query_result->fetchrow_hashref()) {
	my $card  = $rowref->{'card'};
	my $port  = $rowref->{'port'};
	my $iface = $rowref->{'iface'};
	my $interface;

	#
	# If we already have this in the interface cache, lets not create
	# another one. Just use that one.
	#
	if (exists($all_interfaces{"$nodeid:$card:$port"})) {
	    $interface = $all_interfaces{"$nodeid:$card:$port"};
	}
	else {
	    $interface = {};
	
	    $interface->{"DBROW"}  = $rowref;
	    bless($interface, $class);

108 109 110 111 112 113 114 115 116 117 118
	    #
	    # Grab the wires table entry.
	    #
	    my $wires_result =
		DBQueryWarn("select * from wires ".
			    "where node_id1='$nodeid' and ".
			    "      card1='$card' and port1='$port'");
	    if ($wires_result && $wires_result->numrows) {
		$interface->{'WIRES'} = $wires_result->fetchrow_hashref();
	    }

119 120 121 122 123 124 125 126 127 128
	    #
	    # And the interface_state table.
	    #
	    my $state_result =
		DBQueryWarn("select * from interface_state ".
			    "where node_id='$nodeid' and ".
			    "      card='$card' and port='$port'");

	    return -1
		if (!$state_result);
129 130 131 132 133 134
	    if (!$state_result->numrows) {
		print STDERR
		    "*** Missing interface_state table entry for interface\n".
		    "    card:port $card:$port on $nodeid.\n";
		return -1;
	    }
135 136
	    $interface->{'STATE'} = $state_result->fetchrow_hashref();

137 138 139 140 141 142 143 144 145
	    # Cache by card,port and by iface
	    $all_interfaces{"$nodeid:$card:$port"} = $interface;
	    $all_interfaces{"$nodeid:$iface"}      = $interface;
	}
	push(@{ $results }, $interface);
    }
    # Add to cache of node interfaces
    $node_interfaces{$nodeid} = $results;
    
146 147
    @$pref = @{ $results };
    return 0;
148 149 150 151 152 153 154 155 156 157 158
}
# accessors
sub field($$)  { return ((! ref($_[0])) ? -1 : $_[0]->{'DBROW'}->{$_[1]}); }
sub node_id($) { return field($_[0], 'node_id'); }
sub card($)    { return field($_[0], 'card'); }
sub port($)    { return field($_[0], 'port'); }
sub iface($)   { return field($_[0], 'iface'); }
sub mac($)     { return field($_[0], 'mac'); }
sub IP($)      { return field($_[0], 'IP'); }
sub role($)    { return field($_[0], 'role'); }
sub type($)    { return field($_[0], 'interface_type'); }
159
sub logical($) { return field($_[0], 'logical'); }
160
sub mask($)    { return field($_[0], 'mask'); }
161
sub uuid($)    { return field($_[0], 'uuid'); }
162
# Wires table
Leigh Stoller's avatar
Leigh Stoller committed
163
sub wiredup($)     { return (exists($_[0]->{'WIRES'}) ? 1 : 0); }
164 165 166 167
sub wire_type($)   { return $_[0]->{'WIRES'}->{'type'}; }
sub switch_id($)   { return $_[0]->{'WIRES'}->{'node_id2'}; }
sub switch_card($) { return $_[0]->{'WIRES'}->{'card2'}; }
sub switch_port($) { return $_[0]->{'WIRES'}->{'port2'}; }
168 169 170
# Interface State table
sub enabled($)     { return $_[0]->{'STATE'}->{'enabled'}; }
sub tagged($)      { return $_[0]->{'STATE'}->{'tagged'}; }
171
sub remaining_bandwidth { return $_[0]->{'STATE'}->{'remaining_bandwidth'}; }
172 173 174 175 176 177 178

sub IsExperimental($)
{
    my ($self) = @_;

    return $self->role() eq TBDB_IFACEROLE_EXPERIMENT();
}
Leigh Stoller's avatar
Leigh Stoller committed
179 180 181 182 183 184
sub IsControl($)
{
    my ($self) = @_;

    return $self->role() eq TBDB_IFACEROLE_CONTROL();
}
185

186 187 188 189 190 191 192
sub IsManagement($)
{
    my ($self) = @_;

    return $self->role() eq TBDB_IFACEROLE_MANAGEMENT();
}

193 194 195
#
# Lookup by card,port
#
196
sub Lookup($$$;$)
197 198 199
{
    my ($class, $nodeid, $card, $port) = @_;

200 201 202
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

203 204 205 206
    # XXX: the node side always uses port 1.
    $port = 1
	if (!defined($port));

207 208 209 210 211 212 213 214 215 216 217 218 219 220
    # Look in cache first
    return $all_interfaces{"$nodeid:$card:$port"}
        if (exists($all_interfaces{"$nodeid:$card:$port"}));

    my $query_result =
	DBQueryWarn("select * from interfaces ".
		    "where node_id='$nodeid' and ".
		    "      card='$card' and port='$port'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);

221
    my $iface_row = $query_result->fetchrow_hashref();
222

223 224 225 226 227 228 229 230
    #
    # And the interface_state table.
    #
    $query_result =
	DBQueryWarn("select * from interface_state ".
		    "where node_id='$nodeid' and ".
		    "      card='$card' and port='$port'");

231 232 233 234
    if (!$query_result) {
	print STDERR "*** Missing interface_state for $nodeid:$card:$port\n";
	return undef;
    }
235 236
    # If a management interface, the lack of an interface_state
    # record is not a big deal, so let it slide.
237
    return undef
238 239
	if (!$query_result->numrows &&
	    $iface_row->{'role'} ne TBDB_IFACEROLE_MANAGEMENT());
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270

    my $state_row = $query_result->fetchrow_hashref();

    my $interface = LookupRow($class, $iface_row, $state_row);

    #
    # Grab the wires table entry.
    #
    $query_result =
	DBQueryWarn("select * from wires ".
		    "where node_id1='$nodeid' and ".
		    "      card1='$card' and port1='$port'");
    if ($query_result && $query_result->numrows) {
	$interface->{'WIRES'} = $query_result->fetchrow_hashref();
    }

    return $interface;
}

sub LookupRow($$$)
{
    my ($class, $iface_row, $state_row) = @_;
    my $nodeid = $iface_row->{'node_id'};
    my $card = $iface_row->{'card'};
    my $port = $iface_row->{'port'};
    my $interface = {};
	
    $interface->{"DBROW"} = $iface_row;
    $interface->{'STATE'} = $state_row;
    bless($interface, $class);

271
    
272 273 274 275 276
    # Cache by card,port and by iface
    my $iface = $interface->iface();
    
    $all_interfaces{"$nodeid:$card:$port"} = $interface;
    $all_interfaces{"$nodeid:$iface"}      = $interface;
277

278 279 280
    return $interface;
}

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
#
# Refresh instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

    return -1
	if (! ref($self));

    my $nodeid  = $self->node_id();
    my $iface   = $self->iface();
    my $card    = $self->card();
    my $port    = $self->port();

    my $query_result =
	DBQueryWarn("select * from interfaces ".
		    "where node_id='$nodeid' and iface='$iface'");
    return undef
	if (!$query_result || !$query_result->numrows);

    $self->{"DBROW"} = $query_result->fetchrow_hashref();
    
    #
    # And the interface_state table.
    #
    $query_result =
	DBQueryWarn("select * from interface_state ".
		    "where node_id='$nodeid' and ".
		    "      card='$card' and port='$port'");
    return undef
	if (!$query_result || !$query_result->numrows);

    $self->{'STATE'} = $query_result->fetchrow_hashref();
    
    return 0;
}

319 320 321 322 323 324 325 326 327 328 329 330
#
# Create a new interface record. This also handles the wires table entries.
#
sub Create($$$)
{
    my ($class, $node, $argref) = @_;

    return undef
	if (! (ref($node) && ref($argref)));

    my $node_id = $node->node_id();

331
    my $MAC        = $argref->{'MAC'} || $argref->{'mac'};
332 333 334 335
    my $IP         = $argref->{'IP'};
    my $mask       = $argref->{'mask'};
    my $card       = $argref->{'card'};
    my $port       = $argref->{'port'};
Leigh Stoller's avatar
Leigh Stoller committed
336
    my $iftype     = $argref->{'type'} || $argref->{'interface_type'};
337 338 339 340 341 342 343 344 345 346
    my $ifrole     = $argref->{'role'};
    my $uuid       = $argref->{'uuid'};
    my $max_speed  = $argref->{'max_speed'};
    my $duplex     = $argref->{'duplex'};
    my $switch_id  = $argref->{'switch_id'};
    my $switch_card= $argref->{'switch_card'};
    my $switch_port= $argref->{'switch_port'};
    my $wire_type  = $argref->{'wire_type'};
    my $cable      = $argref->{'cable'};
    my $length     = $argref->{'length'};
347
    my $iface      = $argref->{'iface'};
348
    my $logical    = $argref->{'logical'};
349
    my $trunk      = $argref->{'trunk'};
350

351 352 353 354 355 356 357
    if (!defined($wire_type)) {
	if ($ifrole eq TBDB_IFACEROLE_MANAGEMENT()) {
	    $wire_type = "Management";
	}
	if ($ifrole eq TBDB_IFACEROLE_EXPERIMENT()) {
	    $wire_type = "Node";
	}
358
    }
359 360
    $iface = "eth$card"    
	if (!defined($iface));
361 362 363 364 365 366 367 368 369 370
    $port = 1
	if (!defined($port));
    $IP = ""
	if (!defined($IP));
    $mask = ""
	if (!defined($mask));
    $duplex = "full"
	if (!defined($duplex));
    $max_speed = 0
	if (!defined($max_speed));
371 372
    $logical = 0
	if (!defined($logical));
373 374
    $trunk = 0
	if (!defined($trunk));
375 376 377 378 379 380 381
    if (!defined($uuid)) {
	$uuid = NewUUID();
	if (!defined($uuid)) {
	    print STDERR "Could not generate a UUID!\n";
	    return undef;
	}
    }
382
    if (! (defined($card) && defined($ifrole) && defined($MAC) &&
Leigh Stoller's avatar
Leigh Stoller committed
383
	   defined($IP) && defined($port) && 
384 385 386 387 388 389
	   defined($iftype) && defined($iface) && defined($max_speed) &&
	   defined($duplex) && defined($uuid))) {
	print STDERR "Interface::Create: Missing fields in arguments:\n";
	print STDERR Dumper($argref);
	return undef;
    }
390

391 392 393 394 395
    #
    # Lock the tables to prevent concurrent creation
    #
    DBQueryWarn("lock tables interfaces write, ".
		"            interface_state write, ".
396 397
		"            vinterfaces read, ".
		"            node_history read, ".
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
		"            wires write")
	or return undef;

    #
    # See if we have a record; if we do, we can stop now. This is
    # not actually correct, since creating a node is not atomic.
    #
    my $query_result =
	DBQueryWarn("select node_id from interfaces ".
		    "where node_id='$node_id' and ".
		    "      card='$card' and port='$port'");
    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
	return Interface->Lookup($node_id, $card, $port);
    }
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

    #
    # Generate a fake mac if requested. 
    #
    if ($MAC eq "genfake") {
	while (1) {
	    $MAC = GenFakeMac();

	    # Check to make sure unique. If not, try again.
	    $query_result =
		DBQueryWarn("(select mac from interfaces ".
			    " where mac='$MAC') ".
			    "union ".
			    "(select mac from vinterfaces ".
			    " where mac='$MAC') ".
			    "union ".
			    "(select cnet_mac as mac from node_history ".
			    " where cnet_mac='$MAC')");
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return undef;
	    }
	    last
		if (!$query_result->numrows);
	}
    }
439 440
    
    if (!DBQueryWarn("insert into interfaces set ".
441
		"  node_id='$node_id', logical='$logical', " .
442
		"  card=$card, port=$port, role='$ifrole', ".
Leigh Stoller's avatar
Leigh Stoller committed
443 444
		"  mac='$MAC', IP='$IP', " .
		(defined($mask) ? "mask='$mask', " : "") .
445
		($trunk ? "trunk='1', " : "") .
446 447
		"  interface_type='$iftype', iface='$iface', " .
		"  current_speed='$max_speed', duplex='$duplex', ".
448 449 450 451
		"  uuid='$uuid'")) {
	DBQueryWarn("unlock tables");
	return undef;
    }
452

453 454
    if (!DBQueryWarn("insert into interface_state set ".
		     "  node_id='$node_id', " .
455
		     ($trunk ? "remaining_bandwidth='$max_speed', " : "") .
456 457 458 459
		     "  card=$card, port=$port, iface='$iface'")) {
	DBQueryWarn("delete from interfaces ".
		    "where node_id='$node_id' and card='$card' ".
		    "      and port='$port'");
460
	DBQueryWarn("unlock tables");
461 462 463
	return undef;
    }

464 465 466 467 468 469 470 471 472
    if (defined($switch_id)) {
	my $cable_len = "";
	if (defined($cable)) {
	    $cable_len .= ", cable=$cable";
	}
	if (defined($length)) {
	    $cable_len .= ", len=$length";
	}
	if (!DBQueryWarn("insert into wires set".
473
			 "  type='$wire_type', logical='$logical', " .
474 475 476
			 "  node_id1='$node_id', card1=$card, port1=$port, " .
			 "  node_id2='$switch_id', card2='$switch_card', " .
			 "  port2='$switch_port' $cable_len")) {
477 478 479
	    DBQueryWarn("delete from interface_state ".
			"where node_id='$node_id' and card='$card' ".
			"      and port='$port'");
480 481 482
	    DBQueryWarn("delete from interfaces ".
			"where node_id='$node_id' and card='$card' ".
			"      and port='$port'");
483
	    DBQueryWarn("unlock tables");
484 485 486
	    return undef;
	}
    }
487
    DBQueryWarn("unlock tables");
488 489 490
    return Interface->Lookup($node_id, $card, $port);
}

491 492 493
#
# Delete a logical interface.
#
494
sub Delete($;$)
495
{
496 497
    my ($self, $real) = @_;
    my $logical = ($real ? 0 : 1);
498

499
    if ($logical && !$self->logical()) {
500 501 502 503 504 505 506 507 508 509 510 511 512
	print STDERR "Refusing to delete real $self\n";
	return -1;
    }
    my $node_id = $self->node_id();
    my $card    = $self->card();
    my $port    = $self->port();

    return -1
	if (!DBQueryWarn("delete from interface_state ".
			 "where node_id='$node_id' and card='$card' and ".
			 "      port='$port'"));
    return -1
	if (!DBQueryWarn("delete from interfaces ".
513
			 "where logical=$logical and ".
514 515 516 517 518
			 "      node_id='$node_id' and card='$card' and ".
			 "      port='$port'"));
    return 0;
}

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
#
# Delete this interface's wire entry.
#
sub DeleteWire($)
{
    my ($self) = @_;
    my $node_id = $self->node_id();
    my $card    = $self->card();
    my $port    = $self->port();

    return -1
	if (!DBQueryWarn("delete from wires ".
			 "where node_id1='$node_id' and card1='$card' and ".
			 "      port1='$port'"));
    return 0;
}

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
#
# Create a fake object, as for the mapper (assign_wrapper) during debugging.
#
sub MakeFake($$$)
{
    my ($class, $node, $argref) = @_;

    my $nodeid = $node->node_id();
    $argref->{'node_id'} = $nodeid;

    my $self            = {};
    $self->{"DBROW"}    = $argref;
    bless($self, $class);

    # Cache by card,port and by iface
    my $iface = $argref->{'iface'};
    my $card  = $argref->{'card'};
    my $port  = $argref->{'port'};
    $all_interfaces{"$nodeid:$card:$port"} = $self;
    $all_interfaces{"$nodeid:$iface"}      = $self;
    
    return $self;
}

560 561 562 563 564 565 566
#
# Lookup by iface
#
sub LookupByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;

567 568 569
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

570 571 572 573
    # Look in cache first
    return $all_interfaces{"$nodeid:$iface"}
        if (exists($all_interfaces{"$nodeid:$iface"}));

574 575 576 577
    # Used from Protogeni code, so be careful.
    my $safe_nodeid = DBQuoteSpecial($nodeid);
    my $safe_iface  = DBQuoteSpecial($iface);

578
    my $query_result =
579
	DBQueryWarn("select card,port from interfaces ".
580
		    "where node_id=$safe_nodeid and iface=$safe_iface");
581 582 583 584 585 586

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);

587
    my ($card, $port) = $query_result->fetchrow_array();
588

589
    return Interface->Lookup($nodeid, $card, $port);
590 591
}

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
#
# Lookup by mac
#
sub LookupByMAC($$)
{
    my ($class, $mac) = @_;

    my $query_result =
	DBQueryWarn("select node_id,card,port from interfaces ".
		    "where mac='$mac'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
    my ($nodeid, $card, $port) = $query_result->fetchrow_array();

    return Interface->Lookup($nodeid, $card, $port);
}

#
# Lookup by IP, but only on control or management interfaces.
# Makes no sense for experimental.
#
sub LookupByIP($$)
{
    my ($class, $ip) = @_;

    my $query_result =
	DBQueryWarn("select node_id,card,port from interfaces ".
		    "where ip='$ip' and ".
		    "      (role='" . TBDB_IFACEROLE_CONTROL()  . "' or ".
		    "       role='" . TBDB_IFACEROLE_MANAGEMENT()  . "')");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
    my ($nodeid, $card, $port) = $query_result->fetchrow_array();

    return Interface->Lookup($nodeid, $card, $port);
}

637 638 639 640 641 642 643 644 645 646 647 648
#
# Lookup by uuid
#
sub LookupByUUID($$)
{
    my ($class, $uuid) = @_;

    if (! ($uuid =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	return undef;
    }
    
    my $query_result =
649
	DBQueryWarn("select node_id,card,port from interfaces ".
650 651 652 653 654 655 656
		    "where uuid='$uuid'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
657
    my ($nodeid, $card, $port) = $query_result->fetchrow_array();
658

659
    return Interface->Lookup($nodeid, $card, $port);
660 661
}

662 663 664 665 666 667 668
#
# Lookup the control interface for a node, which is something we do a lot.
#
sub LookupControl($)
{
    my ($class, $nodeid) = @_;

669 670 671
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

672
    my $query_result =
673
	DBQueryWarn("select card,port from interfaces ".
674 675 676 677 678 679 680 681
		    "where node_id='$nodeid' and ".
		    "      role='" . TBDB_IFACEROLE_CONTROL()  . "'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);

682
    my ($card, $port) = $query_result->fetchrow_array();
683

684
    return Interface->Lookup($nodeid, $card, $port);
685 686
}

687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
#
# Lookup the management interface for a node.
#
sub LookupManagement($)
{
    my ($class, $nodeid) = @_;

    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

    my $query_result =
	DBQueryWarn("select card,port from interfaces ".
		    "where node_id='$nodeid' and ".
		    "      role='" . TBDB_IFACEROLE_MANAGEMENT()  . "'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);

    my ($card, $port) = $query_result->fetchrow_array();

    return Interface->Lookup($nodeid, $card, $port);
}

712 713 714 715 716 717 718 719 720 721 722 723 724
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $nodeid = $self->node_id();
    my $iface  = $self->iface();

    return "[Interface: $nodeid:$iface]";
}

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
#
# Temporary cruft for geni widearea switches.
#
sub LookUpWideAreaSwitch($$)
{
    my ($class, $hrn) = @_;
    my $safe_hrn = DBQuoteSpecial($hrn);

    my $query_result =
	DBQueryWarn("select node_id from widearea_switches ".
		    "where hrn=$safe_hrn");
    return undef
	if (!$query_result);
    if ($query_result->numrows) {
	my ($switch_id) = $query_result->fetchrow_array();
	return $switch_id;
    }
    my $next_id   = TBGetUniqueIndex('next_switch', 1);
    my $switch_id = "widearea_switch$next_id";

    return $switch_id
	if (DBQueryWarn("insert into widearea_switches set ".
			" hrn=$safe_hrn, node_id='$switch_id'"));
    return undef;
}

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
#
# Perform some updates ...
#
sub Update($$)
{
    my ($self, $argref) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $nodeid  = $self->node_id();
    my $iface   = $self->iface();
    my @sets    = ();

    foreach my $key (keys(%{$argref})) {
	my $val = $argref->{$key};

	# Treat NULL special.
	push (@sets, "${key}=" . ($val eq "NULL" ?
				  "NULL" : DBQuoteSpecial($val)));
    }

    my $query = "update interfaces set " . join(",", @sets) .
	" where node_id='$nodeid' and iface='$iface'";

    return -1
	if (! DBQueryWarn($query));

    return Refresh($self);
}

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
#
# Lookup a specific attribute in the type capabilities table. 
#
sub TypeCapability($$$)
{
    my ($self, $capkey, $pcapval) = @_;
    
    return -1
	if (!ref($self));

    my $itype = $self->interface_type();

    my $query_result =
	DBQueryWarn("select capval from interface_capabilities ".
		    "where type='$itype' and capkey=$capkey");

    return -1
	if (!$query_result || !$query_result->numrows());
    my ($capval) = $query_result->fetchrow_array();
    $pcapval = $capval;
    return 0;
}

806
##############################################################################
807 808 809
package Interface::VInterface;
use libdb;
use libtestbed;
810
use emutil qw(GenFakeMac);
811
use English;
812
use Carp;
813
use overload ('""' => 'Stringify');
814
use vars qw($AUTOLOAD);
815 816 817 818 819 820

my $nextfake = 0;

#
# Lookup by node_id,unit
#
821
sub Lookup($$$)
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
{
    my ($class, $nodeid, $unit) = @_;

    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

    my $query_result =
	DBQueryWarn("select * from vinterfaces ".
		    "where node_id='$nodeid' and unit='$unit'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);

    my $vinterface = {};
	
    $vinterface->{"DBROW"} = $query_result->fetchrow_hashref();
840
    $vinterface->{"HASH"}  = {};
841 842
    bless($vinterface, $class);
}
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

AUTOLOAD {
    my $self  = $_[0];
    my $type  = ref($self) or croak "$self is not an object";
    my $name  = $AUTOLOAD;
    $name =~ s/.*://;   # strip fully-qualified portion

    # A DB row proxy method call.
    if (exists($self->{'DBROW'}->{$name})) {
	return $self->{'DBROW'}->{$name};
    }
    # Or it is for a local storage slot.
    if ($name =~ /^_.*$/) {
	if (scalar(@_) == 2) {
	    return $self->{'HASH'}->{$name} = $_[1];
	}
	elsif (exists($self->{'HASH'}->{$name})) {
	    return $self->{'HASH'}->{$name};
	}
    }
    carp("No such slot '$name' field in class $type");
    return undef;
}

# Break circular reference someplace to avoid exit errors.
sub DESTROY {
    my $self = shift;

    $self->{'DBROW'} = undef;
    $self->{'HASH'}  = undef;
}
874 875 876

# The virtual iface name is $type$unit
sub viface($)     { return $_[0]->type() . $_[0]->unit(); }
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900

#
# Lookup by the experiment/virtlan/vnode
#
sub LookupByVirtLan($$$$)
{
    my ($class, $experiment, $virtlan, $vnode) = @_;
    my $exptidx = $experiment->idx();

    $virtlan = DBQuoteSpecial($virtlan);
    $vnode   = DBQuoteSpecial($vnode);

    my $query_result =
	DBQueryWarn("select node_id,unit from vinterfaces as vif ".
		    "left join virt_lans as vl on vl.exptidx=vif.exptidx and ".
		    "  vl.ip=vif.IP ".
		    "where vif.exptidx='$exptidx' and ".
		    "      vl.vname=$virtlan and vl.vnode=$vnode");
    return undef
	if (!defined($query_result) || !$query_result->numrows);

    my ($node_id,$unit) = $query_result->fetchrow_array();
    return Interface::VInterface->Lookup($node_id, $unit);
}
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    
#
# Create a new vinterface
#
sub Create($$$)
{
    my ($class, $nodeid, $argref) = @_;

    $nodeid = $nodeid->node_id()
	if (ref($nodeid));
    $argref->{'node_id'} = $nodeid;

    # This is generated by the insert.
    delete($argref->{'unit'})
	if (exists($argref->{'unit'}));

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
    DBQueryWarn("lock tables interfaces read, ".
		"            vinterfaces write, ".
		"            node_history read")
	or return undef;

    #
    # Generate a fake mac if requested. 
    #
    if (exists($argref->{'mac'}) && $argref->{'mac'} eq "genfake") {
	while (1) {
	    my $mac = GenFakeMac();

	    # Check to make sure unique. If not, try again.
	    my $query_result =
		DBQueryWarn("(select mac from interfaces ".
			    " where mac='$mac') ".
			    "union ".
			    "(select mac from vinterfaces ".
			    " where mac='$mac') ".
			    "union ".
			    "(select cnet_mac as mac from node_history ".
			    " where cnet_mac='$mac')");
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return undef;
	    }
	    if (!$query_result->numrows) {
		$argref->{'mac'} = $mac;
		last;
	    }
	}
    }

950 951 952 953
    my $query = "insert into vinterfaces set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    my $query_result = DBQueryWarn($query);
954
    DBQueryWarn("unlock tables");
955 956 957
    return undef
	if (!defined($query_result));

958
    my $unit= $query_result->insertid;
959 960 961 962 963 964 965 966 967 968 969 970
    return Interface::VInterface->Lookup($nodeid, $unit);
}

#
# Create a fake object, as for the mapper (assign_wrapper) during debugging.
#
sub MakeFake($$$)
{
    my ($class, $nodeid, $argref) = @_;

    $nodeid = $nodeid->node_id()
	if (ref($nodeid));
971
    $argref->{'node_id'}  = $nodeid;
972 973 974
    foreach my $field (('vnode_id', 'iface', 'vlanid', 'bandwidth')) {
	$argref->{$field} = undef if (!exists($argref->{$field}));
    }
975 976

    # This is usually generated by the insert.
977
    $argref->{'unit'}   = $nextfake++;
978 979 980

    my $self            = {};
    $self->{"DBROW"}    = $argref;
981
    $self->{"HASH"}     = {};
982
    $self->{"FAKE"}     = 1;
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    bless($self, $class);
    return $self;
}

#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $nodeid  = $self->node_id();
    my $unit    = $self->unit();
    my $iface   = (defined($self->iface()) ? ":" . $self->iface() : "");
    my $vnodeid = (defined($self->vnode_id()) ? ":" . $self->vnode_id() : "");

    return "[VInterface: $nodeid:${unit}${iface}${vnodeid}]";
}

#
# On a shared node, we have to "reserve" the required bandwidth on
# the physical interface.
#
sub ReserveSharedBandwidth($$)
{
    my ($self, $bandwidth) = @_;

    my $nodeid  = $self->node_id();
    my $unit    = $self->unit();
    my $iface   = $self->iface();

    # Must be a trivial link.
    return 0
	if (!defined($iface));

    #
1019 1020
    # Set the bw to the negative value; this is the bw that we need
    # to reserve later. Negative indicates we have not done it yet.
1021
    #
1022 1023
    DBQueryWarn("update vinterfaces set bandwidth=0-${bandwidth} ".
		"where node_id='$nodeid' and unit='$unit'")
1024
	or return -1;
1025 1026
	
    $self->{'DBROW'}->{'bandwidth'} = $bandwidth;
1027 1028 1029
    return 0;
}

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
#
# Refresh instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

    return -1
	if (! ref($self));

    my $nodeid  = $self->node_id();
    my $unit    = $self->unit();

    my $query_result =
	DBQueryWarn("select * from vinterfaces ".
		    "where node_id='$nodeid' and unit='$unit'");
    return undef
	if (!$query_result || !$query_result->numrows);

    $self->{"DBROW"} = $query_result->fetchrow_hashref();
    
    return 0;
}

#
# Perform some updates ...
#
sub Update($$)
{
    my ($self, $argref) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

1065 1066 1067
    return 0
	if (exists($self->{'FAKE'}));

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
    my $nodeid  = $self->node_id();
    my $unit    = $self->unit();
    my @sets    = ();

    foreach my $key (keys(%{$argref})) {
	my $val = $argref->{$key};

	# Treat NULL special.
	push (@sets, "${key}=" . ($val eq "NULL" ?
				  "NULL" : DBQuoteSpecial($val)));
    }

    my $query = "update vinterfaces set " . join(",", @sets) .
	" where node_id='$nodeid' and unit='$unit'";

    return -1
	if (! DBQueryWarn($query));

    return Refresh($self);
}

1089 1090
##############################################################################
#
Leigh Stoller's avatar
Leigh Stoller committed
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
# A wrapper class for a wire. 
#
package Interface::Wire;
use libdb;
use Node;
use libtestbed;
use English;
use overload ('""' => 'Stringify');

#
# Lookup a wire, using the interface of the "pc" side.
#
sub Lookup($$)
{
    my ($class, $interface) = @_;

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    my $query_result;
    if (!ref($interface) && $interface =~ /^urn:publicid:IDN+/) {
	# Allow lookup by remote interface URN
	$query_result =
	    DBQueryWarn("select * from wires ".
			"where external_interface='$interface'");
    } else {
	if (!ref($interface)) {
	    # Allow "nodeid:card:port" argument.
	    if ($interface =~ /^([-\w]*):(\w+):(\w+)$/) {
		$interface = Interface->Lookup($1, $2, $3);
		return undef
		    if (!defined($interface));
	    }
	    else {
		return undef;
	    }
Leigh Stoller's avatar
Leigh Stoller committed
1124
	}
1125 1126 1127 1128 1129 1130 1131
	my $node_id1 = $interface->node_id();
	my $card1    = $interface->card();
	my $port1    = $interface->port();
	$query_result =
	    DBQueryWarn("select * from wires ".
			"where node_id1='$node_id1' and ".
			"      card1='$card1' and port1='$port1'");
Leigh Stoller's avatar
Leigh Stoller committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
    }

    return undef
	if (!$query_result || !$query_result->numrows);

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
    return $wire;
}
sub field($$)	       { return $_[0]->{'DBROW'}->{$_[1]}; }
sub node_id1($)        { return $_[0]->field('node_id1'); }
sub node_id2($)        { return $_[0]->field('node_id2'); }
sub card1($)           { return $_[0]->field('card1'); }
sub card2($)           { return $_[0]->field('card2'); }
sub port1($)           { return $_[0]->field('port1'); }
sub port2($)           { return $_[0]->field('port2'); }
sub type($)            { return $_[0]->field('type'); }
sub logical($)         { return $_[0]->field('logical'); }
1151
sub trunkid($)         { return $_[0]->field('trunkid'); }
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
sub IsActive($)        { return ($_[0]->type() eq "Unused" ? 0 : 1); }

#
# Delete a logical wire and its interfaces.
#
sub Delete($)
{
    my ($self) = @_;
    my ($interface1, $interface2) = $self->Interfaces();

    if (! $self->logical()) {
	print STDERR "Refusing to delete real $self\n";
	return -1;
    }
    if (defined($interface1) && $interface1->logical()) {
	$interface1->Delete() == 0
	    or return -1;
    }
    if (defined($interface2) && $interface2->logical()) {
	$interface2->Delete() == 0
	    or return -1;
    }
    my $node_id1 = $self->node_id1();
    my $card1    = $self->card1();
    my $port1    = $self->port1();

    return -1
	if (!DBQueryWarn("delete from wires ".
			 "where logical=1 and node_id1='$node_id1' and ".
			 "      card1=$card1 and port1=$port1"));
    return 0;
}
Leigh Stoller's avatar
Leigh Stoller committed
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212

#
# A wire has two interfaces, but we do not always create interface
# table entries for both sides; the switch side is generally not in
# the interfaces table. 
#
sub Interfaces($)
{
    my ($self) = @_;

    return (Interface->Lookup($self->node_id1(),
			      $self->card1(), $self->port1()),
	    Interface->Lookup($self->node_id2(),
			      $self->card2(), $self->port2()));
}

#
# Stringify for output. 
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $node1   = $self->node_id1();
    my $node2   = $self->node_id2();
    my $card1   = $self->card1();
    my $card2   = $self->card2();
    my $port1   = $self->port1();
    my $port2   = $self->port2();
1213
    my $type    = ($self->logical() ? "LogicalWire" : "Wire");
Leigh Stoller's avatar
Leigh Stoller committed
1214

1215
    return "[$type: $node1:$card1:$port1/$node2:$card2:$port2]";
Leigh Stoller's avatar
Leigh Stoller committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
}

#
# Activate a (logical) wire by setting the type. Default to "Node".
#
sub Activate($;$)
{
    my ($self, $type) = @_;
    my $node_id1 = $self->node_id1();
    my $card1    = $self->card1();
    my $port1    = $self->port1();
    $type = "Node" if (!defined($type));

    return -1
	if (!DBQueryWarn("update wires set type='$type' ".
			 "where node_id1='$node_id1' and ".
			 "      card1=$card1 and port1=$port1"));

    return 0;
}

sub DeActivate($)
{
    my ($self) = @_;
    my $node_id1 = $self->node_id1();
    my $card1    = $self->card1();
    my $port1    = $self->port1();

    return -1
	if (!DBQueryWarn("update wires set type='Unused' ".
			 "where node_id1='$node_id1' and ".
			 "      card1=$card1 and port1=$port1"));

    return 0;
}

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
#
# Find all logical wires for an experiment.
#
sub ExperimentLogicalWires($$$)
{
    my ($class, $experiment, $plist) = @_;

    return -1
	if (! (ref($plist) && ref($experiment)));
    
    my $exptidx = $experiment->idx();
    my @result  = ();

    # Note that a wire between two pc interfaces will cause this
    # query to return two results, one of which is bogus, since
    # the wires table is unique on node_id1,card1,port1. Need to
    # check for this in the where clause.
    my $query_result =
	DBQueryWarn("select r.node_id,w.card1,w.port1 from reserved as r ".
		    "left join interfaces as i on i.node_id=r.node_id ".
		    "left join wires as w on w.node_id1=r.node_id and ".
		    "     w.card1=i.card and w.port1=i.port ".
		    "where i.logical=1 and r.exptidx='$exptidx' and ".
		    "      card1 is not null");
    return -1
	if (!$query_result);

    while (my ($nodeid,$card,$port) = $query_result->fetchrow_array()) {
	my $wire = Interface::Wire->Lookup("$nodeid:$card:$port");
	if (!defined($wire)) {
	    print STDERR "Could not lookup wire: $nodeid:$card:$port\n";
	    return -1;
	}
	push(@result, $wire);
    }
    @$plist = @result;
    return 0;
}

#
# Delete all logical wires for an experiment, as for swapout.
#
sub DeleteLogicalWires($$)
{
    my ($class, $experiment) = @_;
    my @wires  = ();
    my $errors = 0;

    return -1
	if (! ref($experiment));
    
    return -1
	if (Interface::Wire->ExperimentLogicalWires($experiment, \@wires));
    return 0
	if (!@wires);

    foreach my $wire (@wires) {
	print STDERR "Deleting $wire\n";
	
	if ($wire->IsActive()) {
	    print STDERR "$wire is still active; cannot delete!\n";
	    $errors++;
	}
	if ($wire->Delete()) {
	    print STDERR "$wire could not be deleted!\n";
	    $errors++;
	}
    }
    return $errors;
}

Leigh Stoller's avatar
Leigh Stoller committed
1323 1324 1325 1326 1327 1328
##############################################################################
#
# A wrapper class for a "logical wire". This is a wire that exists
# cause it was created with a layer 1 switch. Basically the same as
# wire above, but this class is handy for the mapper and for display.
# Not really intended to be used outside the mapper. Use the class above.
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
#
package Interface::LogicalWire;
use libdb;
use Node;
use libtestbed;
use English;
use overload ('""' => 'Stringify');

#
# Create a pair of logical interfaces that will later be wired together
# at layer 1. 
#
sub Create($$$$$$)
{
    my ($class, $impotent, $nodeA, $portA, $nodeB, $portB) = @_;

    #
    # See if one is the switch; the switch is node_id2 in the wires table.
    #
    my $pnodeA = Node->Lookup($nodeA);
    if (!defined($pnodeA)) {
	print STDERR "Could not lookup '$nodeA'\n";
	return undef;
    }
    my $pnodeB = Node->Lookup($nodeB);
    if (!defined($pnodeB)) {
	print STDERR "Could not lookup '$nodeB'\n";
	return undef;
    }
    my $interfaceA = Interface->LookupByIface($pnodeA, $portA);
    if (!defined($interfaceA)) {
	print STDERR "Could not lookup '$pnodeA:$portA'\n";
	return undef;
    }
    my $interfaceB = Interface->LookupByIface($pnodeB, $portB);
    if (!defined($interfaceB)) {
	print STDERR "Could not lookup '$pnodeB:$portB'\n";
	return undef;
    }
    
    #
    # Create interfaces, but not for things that are marked as
    # switches since we do not put interfaces for switches into
    # the interfaces table.
    #
    if (!$pnodeA->isswitch()) {
	#
	# Create a logical interface. Note we have to force a hash copy.
	#
	my %argref = %{ $interfaceA->{'DBROW'} };
	my $argref = \%argref;

	# Update the card and iface.
	# XXX Need a better way to allocate the card numbers.
	$argref->{'card'}    = $interfaceA->card() + 200;
	$argref->{'iface'}   = "eth" . $argref->{'card'};
	$argref->{'logical'} = 1;
Leigh Stoller's avatar
Leigh Stoller committed
1386
	$argref->{'uuid'}    = undef;
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409

	if (!$impotent) {
	    $interfaceA = Interface->Create($pnodeA, $argref);
	    return undef
		if (!defined($interfaceA));
	}
	else {
	    # Fake things up.
	    $interfaceA = Interface->MakeFake($pnodeA, $argref);
	}
    }
    if (!$pnodeB->isswitch()) {
	#
	# Create a logical interface. Note we have to force a hash copy.
	#
	my %argref = %{ $interfaceB->{'DBROW'} };
	my $argref = \%argref;

	# Update the card and iface.
	# XXX Need a better way to allocate the card numbers.
	$argref->{'card'}    = $interfaceB->card() + 200;
	$argref->{'iface'}   = "eth" . $argref->{'card'};
	$argref->{'logical'} = 1;
Leigh Stoller's avatar
Leigh Stoller committed
1410
	$argref->{'uuid'}    = undef;
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421

	if (!$impotent) {
	    $interfaceB = Interface->Create($pnodeB, $argref);
	    return undef
		if (!defined($interfaceB));
	}
	else {
	    # Fake things up.
	    $interfaceB = Interface->MakeFake($pnodeB, $argref);
	}
    }
Leigh Stoller's avatar
Leigh Stoller committed
1422 1423 1424 1425 1426 1427 1428 1429 1430
    #
    # For consistency and because we still have an implicit assumption
    # the switch is node_id2 in the wires table. 
    #
    my ($interface1,$interface2) = ($interfaceA, $interfaceB);
    if ($pnodeA->isswitch() && !$pnodeB->isswitch()) {
	($interface1,$interface2) = ($interfaceB, $interfaceA);
    }
    # Create a wires table entry, ordered properly.
1431
    if (!$impotent) {
Leigh Stoller's avatar
Leigh Stoller committed
1432 1433 1434 1435 1436 1437
	my $node_id1 = $interface1->node_id();
	my $node_id2 = $interface2->node_id();
	my $card1    = $interface1->card();
	my $port1    = $interface1->port();
	my $card2    = $interface2->card();
	my $port2    = $interface2->port();
1438 1439 1440 1441 1442 1443 1444

	#
	# The wire is not active yet. When snmpit tuns and actually
	# wires things up at layer 1, it will update this wire to
	# reflect that. Use the 'Unused' type to indicate it is not
	# active.
	#
Leigh Stoller's avatar
Leigh Stoller committed
1445
	if (!DBQueryWarn("replace into wires set".
1446 1447 1448
			 "  type='Unused', logical=1, " .
			 "  node_id1='$node_id1',card1=$card1,port1=$port1, " .
			 "  node_id2='$node_id2',card2=$card2,port2=$port2")) {
Leigh Stoller's avatar
Leigh Stoller committed
1449
	    return undef;
1450 1451
	}
    }
Leigh Stoller's avatar
Leigh Stoller committed
1452 1453 1454 1455 1456 1457 1458 1459 1460
    my $self = {};
    #
    # Do not reorder here; the caller will just be confused.
    #
    $self->{"interfaceA"} = $interfaceA;
    $self->{"interfaceB"} = $interfaceB;
    $self->{"interface1"} = $interface1;
    $self->{"interface2"} = $interface2;

1461 1462 1463
    bless($self, $class);
    return $self;
}
Leigh Stoller's avatar
Leigh Stoller committed
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
sub interfaceA($)      { return $_[0]->{'interfaceA'}; }
sub interfaceB($)      { return $_[0]->{'interfaceB'}; }
sub nodeA($)           { return $_[0]->interfaceA()->node_id(); }
sub nodeB($)           { return $_[0]->interfaceB()->node_id(); }
sub ifaceA($)          { return $_[0]->interfaceA()->iface(); }
sub ifaceB($)          { return $_[0]->interfaceB()->iface(); }
# Wires table ordering.
sub interface1($)      { return $_[0]->{'interface1'}; }
sub interface2($)      { return $_[0]->{'interface2'}; }

#
# The wires table is indexed by node_id1,card1,port1 ... return
# something that allows us to find that wires table entry.
#
sub WireID($)
{
    my ($self) = @_;

    my $interface1 = $self->interface1();
    my $node_id1   = $interface1->node_id();
    my $card1      = $interface1->card();
    my $port1      = $interface1->port();

    return "$node_id1:$card1:$port1";
}
1489

1490 1491 1492 1493 1494 1495
#
# Stringify for output. 
#
sub Stringify($)
{
    my ($self) = @_;
Leigh Stoller's avatar
Leigh Stoller committed
1496 1497 1498

    my $interfaceA = $self->interfaceA();
    my $interfaceB = $self->interfaceB();
1499
    
Leigh Stoller's avatar
Leigh Stoller committed
1500 1501 1502 1503 1504 1505
    my $nodeA   = $self->nodeA();
    my $nodeB   = $self->nodeB();
    my $ifaceA  = $self->ifaceA();
    my $ifaceB  = $self->ifaceB();

    return "[LogicalWire: $nodeA:$ifaceA/$nodeB:$ifaceB]";
1506 1507 1508
}

# _Always_ make sure that this 1 is at the end of the file...
1509
1;
1510