Interface.pm.in 56.4 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2005-2018 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
use English;
37
use Carp qw(cluck);
38 39 40 41 42 43 44 45 46 47
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  = ();
48 49 50
BEGIN { use emutil;
	emutil::AddCache(\%all_interfaces); 
	emutil::AddCache(\%node_interfaces); }
51 52 53 54 55 56

# Manual
my $debug = 0;

#
# Lookup interfaces for a node and create a list of class instances to return.
57 58
# When using this interface we assume that this is the node side and
# the corresponding wire is node_id1.
59
#
60
sub LookupAll($$$)
61
{
62
    my ($class, $nodeid, $pref) = @_;
63
    my $node;
64

65 66 67 68 69 70 71 72 73 74 75 76
    if (ref($nodeid)) {
	$node   = $nodeid;
	$nodeid = $node->node_id();
    }
    else {
	require Node;
	$node = Node->Lookup($nodeid);
	if (!defined($node)) {
	    print STDERR "No such node in the DB: $nodeid\n";
	    return -1;
	}
    }
77
    # Look in cache first
78 79 80 81 82
    if (exists($node_interfaces{$nodeid})) {
	@$pref = @{ $node_interfaces{$nodeid} };
	return 0;
    }
    @$pref = ();
83

84 85 86 87 88
    #
    # Interfaces on dynamic virtnodes are marked with the logical flag.
    # We want those. But we want to ignore them on physical nodes, since
    # those refer to MLE interfaces.
    #
89
    my $logical_clause = ($node->isvirtnode() ? "" : "and i.logical=0");
90

91
    my $query_result =
92 93 94 95
	DBQueryWarn("select i.*,w.card1,w.port1 from interfaces as i ".
		    "left join wires as w on ".
		    "     w.node_id1=i.node_id and w.iface1=i.iface ".
		    "where i.node_id='$nodeid' $logical_clause");
96

97
    return -1
98
	if (!$query_result);
99
    return 0
100 101 102 103 104 105
	if (!$query_result->numrows);

    my $results = [];

    while (my $rowref = $query_result->fetchrow_hashref()) {
	my $iface = $rowref->{'iface'};
106 107
	my $card1 = $rowref->{'card1'};
	my $port1 = $rowref->{'port1'};
108 109
	my $interface;

110 111 112 113
	# Clean up the array, not part of the interface.
	delete($rowref->{'card1'});
	delete($rowref->{'port1'});

114 115 116 117
	#
	# If we already have this in the interface cache, lets not create
	# another one. Just use that one.
	#
118 119 120 121 122 123
	if (exists($all_interfaces{"$nodeid:$iface"})) {
	    $interface = $all_interfaces{"$nodeid:$iface"};
	}
        elsif (defined($card1) && defined($port1) &&
	       exists($all_interfaces{"$nodeid:$card1:$port1"})) {
	    $interface = $all_interfaces{"$nodeid:$card1:$port1"};
124 125 126
	}
	else {
	    $interface = {};
127 128 129 130 131 132 133 134 135

	    #
	    # Remove card,port in the results in preparation for removal
	    # from the table.
	    #
	    delete($rowref->{'card'})
		if (exists($rowref->{'card'}));
	    delete($rowref->{'port'})
		if (exists($rowref->{'port'}));
136 137 138 139
	
	    $interface->{"DBROW"}  = $rowref;
	    bless($interface, $class);

140
	    #
141
	    # Grab the wires table entry if there is one.
142
	    #
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
	    if (defined($card1) && defined($port1)) {
		my $wire = Interface::Wire->Lookup("$nodeid:$card1:$port1");
		if (!defined($wire)) {
		    print STDERR "*** Could not look up wire: ".
			"$nodeid:$card1:$port1\n";
		    return -1;
		}
		$interface->{'WIRE'} = $wire;

		#
		# Since we have a wire, we can set the card/port slots
		# for the interface. Basically, if an interface is not
		# wired up, then asking for its card/port is a nonsensical
		# thing to do and we will spit out a warning when that
		# happens so we can clean up the code.
		#
		$interface->{'CARD'} = $card1;
		$interface->{'PORT'} = $port1;
		
		# Cache
		$all_interfaces{"$nodeid:$card1:$port1"} = $interface;
	    }
	    else {
		$interface->{'WIRE'} = undef;
	    }
168

169 170 171 172 173
	    #
	    # And the interface_state table.
	    #
	    my $state_result =
		DBQueryWarn("select * from interface_state ".
174
			    "where node_id='$nodeid' and iface='$iface'");
175 176 177

	    return -1
		if (!$state_result);
178 179 180
	    if (!$state_result->numrows) {
		print STDERR
		    "*** Missing interface_state table entry for interface\n".
181
		    "    $nodeid:$iface.\n";
182 183
		return -1;
	    }
184 185 186 187 188 189 190 191 192
	    #
	    # Remove card,port in the results in preparation for removal
	    # from the table.
	    #
	    delete($state_result->{'card'})
		if (exists($state_result->{'card'}));
	    delete($state_result->{'port'})
		if (exists($state_result->{'port'}));
	    
193 194
	    $interface->{'STATE'} = $state_result->fetchrow_hashref();

195 196
	    # Cache.
	    $all_interfaces{"$nodeid:$iface"} = $interface;
197 198 199 200 201 202
	}
	push(@{ $results }, $interface);
    }
    # Add to cache of node interfaces
    $node_interfaces{$nodeid} = $results;
    
203 204
    @$pref = @{ $results };
    return 0;
205 206 207 208 209 210 211 212 213
}
# accessors
sub field($$)  { return ((! ref($_[0])) ? -1 : $_[0]->{'DBROW'}->{$_[1]}); }
sub node_id($) { return field($_[0], 'node_id'); }
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'); }
214
sub logical($) { return field($_[0], 'logical'); }
Leigh Stoller's avatar
Leigh Stoller committed
215
sub speed($)   { return field($_[0], 'current_speed'); }
216 217
sub trunk_mode($) { return field($_[0], 'trunk_mode'); }
sub trunk($)   { return field($_[0], 'trunk'); }
218
sub whol($)    { return field($_[0], 'whol'); }
Leigh Stoller's avatar
Leigh Stoller committed
219
sub current_speed($) { return field($_[0], 'current_speed'); }
220
sub mask($)    { return field($_[0], 'mask'); }
221
sub uuid($)    { return field($_[0], 'uuid'); }
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
# These are special, now that interfaces no longer have card,port.
# There must be a wire to get that info.
sub card($)
{
    my ($self) = @_;

    if (!defined($self->{'CARD'})) {
	cluck("*** Wanted card, but no wire: $self");
	return undef;
    }
    return $self->{'CARD'};
}
sub port($)
{
    my ($self) = @_;

    if (!defined($self->{'PORT'})) {
	cluck("*** Wanted port, but no wire: $self");
	return undef;
    }
    return $self->{'PORT'};
}
244 245 246
# These are for the updatewires script.
sub card_saved($) { return field($_[0], 'card_saved'); }
sub port_saved($) { return field($_[0], 'port_saved'); }
247
# Wires table
248 249 250 251 252
sub wire($)    { return $_[0]->{'WIRE'}; }
sub wiredup($) { return (defined($_[0]->{'WIRE'}) ? 1 : 0); }
sub wirefield($$) {
    my ($self, $slot) = @_;
    if (!$self->wiredup()) {
253
	cluck("*** $self is not wired up, but asked for wire $slot!");
254 255 256 257 258 259 260 261 262
	return undef;
    }
    return $self->wire()->field($slot);
}
sub wire_type($)   { return $_[0]->wirefield('type'); }
sub wire_iface($)  { return $_[0]->wirefield('iface2'); }
sub switch_id($)   { return $_[0]->wirefield('node_id2'); }
sub switch_card($) { return $_[0]->wirefield('card2'); }
sub switch_port($) { return $_[0]->wirefield('port2'); }
263
sub wire_unused($) { return $_[0]->wire_type() eq "Unused" ? 1 : 0; }
264
# Interface State table
265 266 267 268
sub state($)       { return $_[0]->{'STATE'}; }
sub enabled($)     { return $_[0]->state()->{'enabled'}; }
sub tagged($)      { return $_[0]->state()->{'tagged'}; }
sub remaining_bandwidth { return $_[0]->state()->{'remaining_bandwidth'}; }
269 270 271 272 273 274 275

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

    return $self->role() eq TBDB_IFACEROLE_EXPERIMENT();
}
Leigh Stoller's avatar
Leigh Stoller committed
276 277 278 279 280 281
sub IsControl($)
{
    my ($self) = @_;

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

283 284 285 286 287 288 289
sub IsManagement($)
{
    my ($self) = @_;

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

290
#
291 292 293 294
# Lookup by card,port. When using this interface we assume that this
# is the node side and the corresponding wire is node_id1.
#
# This is a bit of a legacy interface.
295
#
296
sub Lookup($$$;$)
297 298 299
{
    my ($class, $nodeid, $card, $port) = @_;

300 301 302
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

303 304 305 306
    # XXX: the node side always uses port 1.
    $port = 1
	if (!defined($port));

307 308
    cluck("Legacy Interface->Lookup($nodeid,$card,$port)");

309 310 311 312
    # Look in cache first
    return $all_interfaces{"$nodeid:$card:$port"}
        if (exists($all_interfaces{"$nodeid:$card:$port"}));

313
    #
314 315
    # Look in the wires table, in preparation for removing card,port from
    # the interfaces table.
316
    #
317 318
    my $wire = Interface::Wire->Lookup("$nodeid:$card:$port");
	
319
    #
320
    # If no wires entry and a legacy lookup, warn.
321
    #
322 323 324
    if (!defined($wire)) {
	cluck("*** No wires entry for Interface->Lookup($nodeid,$card,$port)");
	return undef;
325
    }
326
    return Interface->LookupByIface($nodeid, $wire->iface1());
327 328
}

Leigh Stoller's avatar
Leigh Stoller committed
329 330 331 332 333 334 335
sub Flush($)
{
    my ($self) = @_;
    my $nodeid  = $self->node_id();
    my $iface   = $self->iface();

    delete($all_interfaces{"$nodeid:$iface"});
336 337 338 339 340 341 342 343 344

    #
    # Check for cache entry by wire card,port.
    #
    if ($self->wiredup()) {
	my $card    = $self->card();
	my $port    = $self->port();
	delete($all_interfaces{"$nodeid:$card:$port"});
    }
Leigh Stoller's avatar
Leigh Stoller committed
345 346
}

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
#
# 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 $query_result =
	DBQueryWarn("select * from interfaces ".
362
		    "where node_id='$nodeid' and iface='$iface'");
363 364
    return undef
	if (!$query_result || !$query_result->numrows);
365 366
    
    my $rowref = $query_result->fetchrow_hashref();    
367

368 369 370 371 372 373 374 375 376 377 378
    #
    # Remove card,port in the results in preparation for removal
    # from the table. If we have a wire, we do want card/port in
    # the interface.
    #
    delete($rowref->{'card'})
	if (exists($rowref->{'card'}));
    delete($rowref->{'port'})
	if (exists($rowref->{'port'}));

    $self->{"DBROW"} = $rowref;
379 380 381 382
    
    #
    # And the interface_state table.
    #
383 384 385
    if (defined($self->{'STATE'})) {
	$query_result =
	    DBQueryWarn("select * from interface_state ".
386
			"where node_id='$nodeid' and iface='$iface'");
387 388
	return undef
	    if (!$query_result || !$query_result->numrows);
389 390 391 392 393 394 395 396 397 398 399

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

	#
	# Remove card,port in the results in preparation for removal
	# from the table.
	#
	delete($state_result->{'card'})
	    if (exists($state_result->{'card'}));
	delete($state_result->{'port'})
	    if (exists($state_result->{'port'}));
400
	
401
	$self->{'STATE'} = $state_result;
402
    }
403 404 405
    return 0;
}

406 407 408 409 410 411
#
# Create a new interface record. This also handles the wires table entries.
#
sub Create($$$)
{
    my ($class, $node, $argref) = @_;
412
    my ($card,$port);
413 414 415 416

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

417 418 419 420 421
    if (exists($argref->{'switch_id'})) {
	print STDERR "*** Creating a wire in Interface->Create() is no ".
	    "longer supported!\n";
	return undef;
    }
422
    if (exists($argref->{'card'})) {
423 424 425 426 427 428 429 430
	if (!DBSlotExists("interfaces", "card")) {
	    print STDERR "*** Interface->Create(): ignoring card/port, these ".
		"are now set with the wire.\n";
	}
	else {
	    $card = $argref->{'card'};
	    $port = $argref->{'port'};
	}
431
    }
432

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

435
    my $MAC        = $argref->{'MAC'} || $argref->{'mac'};
436 437
    my $IP         = $argref->{'IP'};
    my $mask       = $argref->{'mask'};
Leigh Stoller's avatar
Leigh Stoller committed
438
    my $iftype     = $argref->{'type'} || $argref->{'interface_type'};
439 440 441 442
    my $ifrole     = $argref->{'role'};
    my $uuid       = $argref->{'uuid'};
    my $max_speed  = $argref->{'max_speed'};
    my $duplex     = $argref->{'duplex'};
443
    my $iface      = $argref->{'iface'};
444
    my $logical    = $argref->{'logical'};
445
    my $trunk      = $argref->{'trunk'};
446
    my $auto       = $argref->{'autocreated'};
447

448 449 450 451 452 453 454 455
    $IP = ""
	if (!defined($IP));
    $mask = ""
	if (!defined($mask));
    $duplex = "full"
	if (!defined($duplex));
    $max_speed = 0
	if (!defined($max_speed));
456 457
    $logical = 0
	if (!defined($logical));
458 459
    $auto = 0
	if (!defined($auto));
460 461
    $trunk = 0
	if (!defined($trunk));
462 463 464 465 466 467 468
    if (!defined($uuid)) {
	$uuid = NewUUID();
	if (!defined($uuid)) {
	    print STDERR "Could not generate a UUID!\n";
	    return undef;
	}
    }
469
    if (! (defined($ifrole) && defined($MAC) && defined($IP) && 
470 471 472 473 474 475
	   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;
    }
476

477 478 479 480 481 482 483
    # Lets make keep the special characters to a reasonable set.
    # Mike says no commas please.
    if ($iface !~ /^[-\w\/\.:]+$/) {
	print STDERR "Interface::Create: illegal characters in iface:\n";
	return undef;
    }

484 485 486 487 488
    #
    # Lock the tables to prevent concurrent creation
    #
    DBQueryWarn("lock tables interfaces write, ".
		"            interface_state write, ".
489 490
		"            vinterfaces read, ".
		"            node_history read, ".
491 492 493 494 495 496 497 498 499
		"            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 ".
500
		    "where node_id='$node_id' and iface='$iface'");
501 502
    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
503
	return Interface->LookupByIface($node_id, $iface);
504
    }
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

    #
    # 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);
	}
    }
531 532
    
    if (!DBQueryWarn("insert into interfaces set ".
533
		"  node_id='$node_id', logical='$logical', " .
534
		"  role='$ifrole', ".
535
	        (defined($card) ? "  card=$card, port=$port, " : "") .
536
		"  mac='$MAC', IP='$IP', autocreated='$auto', " .
Leigh Stoller's avatar
Leigh Stoller committed
537
		(defined($mask) ? "mask='$mask', " : "") .
538
		($trunk ? "trunk='1', " : "") .
539 540
		"  interface_type='$iftype', iface='$iface', " .
		"  current_speed='$max_speed', duplex='$duplex', ".
541 542 543 544
		"  uuid='$uuid'")) {
	DBQueryWarn("unlock tables");
	return undef;
    }
545

546 547
    if (!DBQueryWarn("insert into interface_state set ".
		     "  node_id='$node_id', " .
548
		     (defined($card) ? "  card=$card, port=$port, " : "") .
549
		     ($trunk ? "remaining_bandwidth='$max_speed', " : "") .
550
		     "  iface='$iface'")) {
551
	DBQueryWarn("delete from interfaces ".
552
		    "where node_id='$node_id' and iface='$iface' ");
553
	DBQueryWarn("unlock tables");
554 555 556
	return undef;
    }

557
    DBQueryWarn("unlock tables");
558
    return Interface->LookupByIface($node_id, $iface);
559 560
}

561 562 563
#
# Delete a logical interface.
#
564
sub Delete($;$)
565
{
566 567
    my ($self, $real) = @_;
    my $logical = ($real ? 0 : 1);
568

569
    if ($logical && !$self->logical()) {
570 571 572 573
	print STDERR "Refusing to delete real $self\n";
	return -1;
    }
    my $node_id = $self->node_id();
574
    my $iface   = $self->iface();
575 576 577

    return -1
	if (!DBQueryWarn("delete from interface_state ".
578
			 "where node_id='$node_id' and iface='$iface'"));
579 580
    return -1
	if (!DBQueryWarn("delete from port_counters ".
581
			 "where node_id='$node_id' and iface='$iface'"));
582 583
    return -1
	if (!DBQueryWarn("delete from interfaces ".
584
			 "where logical=$logical and ".
585
			 "      node_id='$node_id' and iface='$iface'"));
586 587 588
    return 0;
}

589 590 591 592 593 594
#
# Delete this interface's wire entry.
#
sub DeleteWire($)
{
    my ($self) = @_;
595 596 597 598

    return 0
	if (!$self->wiredup());
    
599 600 601 602 603 604 605 606 607 608 609
    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;
}

610 611
#
# Create a fake object, as for the mapper (assign_wrapper) during debugging.
612
# Port library uses this too.
613 614 615 616
#
sub MakeFake($$$)
{
    my ($class, $node, $argref) = @_;
617
    my ($card,$port);
618

619 620 621 622 623 624 625 626 627 628
    my $query_result =
	DBQueryWarn("show columns from interfaces");
    return undef
	if (!$query_result);
    
    while (my ($slot) = $query_result->fetchrow_array()) {
	if (!exists($argref->{$slot})) {
	    $argref->{$slot} = "";
	}
    }
629
    my $self            = {};
630
    my $nodeid = ref($node) ? $node->node_id() : $node;
631
    $argref->{'node_id'} = $nodeid;
632 633 634 635 636 637 638 639 640
    
    if (exists($argref->{'card'})) {
	$card = $argref->{'card'};
	$port = $argref->{'port'};
	delete($argref->{'card'});
	delete($argref->{'port'});
	$self->{'CARD'} = $card;
	$self->{'PORT'} = $port;
    }
641
    $self->{"DBROW"}    = $argref;
642
    $self->{"WIRE"}     = undef;
643 644 645 646 647 648
    $self->{"STATE"}    = {
	"node_id"  => $nodeid,
	"iface"    => $argref->{'iface'},
	"tagged"   => 0,
	"enabled"  => 1,
    };
649 650 651 652 653
    bless($self, $class);

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

    if (defined($card)) {
	$all_interfaces{"$nodeid:$card:$port"} = $self;
    }
658 659 660
    return $self;
}

661 662 663 664 665 666
#
# Lookup by iface
#
sub LookupByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;
667
    my $interface = {};
668
    my $state_row;
669
    my $wire;
670

671 672 673
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

674 675
    # Look in cache first
    return $all_interfaces{"$nodeid:$iface"}
676
    if (exists($all_interfaces{"$nodeid:$iface"}));
677

678
    # Used from Protogeni code, so be careful.
679 680
    return undef
	if (! ($nodeid =~ /^[-\w]+$/ && $iface =~ /^[-\w\/\.:]+$/));
681

682
    my $query_result =
683 684
	DBQueryWarn("select * from interfaces ".
		    "where node_id='$nodeid' and iface='$iface'");
685 686
    return undef
	if (!$query_result);
687 688 689 690 691

    #
    # If no interfaces entry, this is bad.
    #
    if (!$query_result->numrows) {
692 693 694
	if ($debug) {
	    cluck("*** No interface entry for ".
		  "Interface->LookupByIface($nodeid,$iface)");
695
	}
696 697 698 699 700 701 702 703
	return undef;
    }
    my $rowref = $query_result->fetchrow_hashref();

    #
    # Remove card,port in the results in preparation for removal
    # from the table.
    #
704 705 706 707 708 709 710 711
    if (exists($rowref->{'card'})) {	
	$rowref->{'card_saved'} = $rowref->{'card'};
	delete($rowref->{'card'})
    }
    if (exists($rowref->{'port'})) {
	$rowref->{'port_saved'} = $rowref->{'port'};
	delete($rowref->{'port'})
    }
712 713 714 715 716 717 718

    #
    # And the interface_state table.
    #
    $query_result =
	DBQueryWarn("select * from interface_state ".
		    "where node_id='$nodeid' and iface='$iface'");
719
    return undef
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
	if (!$query_result);

    #
    # If a management interface or a switch, the lack of an interface_state
    # record is not a big deal, so let it slide. If it is a real node, then
    # whine about it but keep going. 
    #
    if (!$query_result->numrows) {
	require Node;
	my $node = Node->Lookup($nodeid);
	if (! ($rowref->{'role'} eq TBDB_IFACEROLE_MANAGEMENT() ||
	       (defined($node) && $node->role() ne "testnode"))) {
	    print STDERR "*** Missing missing interface_state ".
		"for $nodeid:$iface\n";
	}
    }
    else {
	$state_row = $query_result->fetchrow_hashref();
738

739 740 741 742 743 744 745 746 747 748 749 750 751
	#
	# Remove card,port in the results in preparation for removal
	# from the table.
	#
	delete($state_row->{'card'})
	    if (exists($state_row->{'card'}));
	delete($state_row->{'port'})
	    if (exists($state_row->{'port'}));
    }
    $interface->{"DBROW"} = $rowref;
    $interface->{'STATE'} = $state_row;
    $interface->{'WIRE'}  = undef;
    bless($interface, $class);
752 753 754 755 756 757 758 759

    # Does not have to exist.
    if ($interface->logical()) {
	$wire = Interface::LogicalWire->Lookup($nodeid, $iface);
    }
    else {
	$wire = Interface::Wire->LookupAnyByIface($nodeid, $iface);
    }
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
    
    # Cache by card,port and by iface
    $all_interfaces{"$nodeid:$iface"} = $interface;

    if (defined($wire)) {
	my ($card,$port);
	
	#
	# We still have to assume that the node is the node_id1 side of
	# the wire, at least for now. So if the interface corresponds
	# to the node_id2 side, get the card/port, but do not stash the
	# wire (wireup() is false). Need to come back to this later.
	#
	if ($wire->node_id1() eq $nodeid) {
	    $card = $wire->card1();
	    $port = $wire->port1();
	    $interface->{'WIRE'} = $wire;
	}
	else {
	    $card = $wire->card2();
	    $port = $wire->port2();
	}
	$all_interfaces{"$nodeid:$card:$port"} = $interface;
783

784 785 786 787
	$interface->{'CARD'} = $card;
	$interface->{'PORT'} = $port;
    }
    return $interface;
788 789
}

790 791 792 793 794 795
#
# Lookup by mac
#
sub LookupByMAC($$)
{
    my ($class, $mac) = @_;
796
    my $safe_mac = DBQuoteSpecial($mac);
797 798

    my $query_result =
799 800
	DBQueryWarn("select node_id,iface from interfaces ".
		    "where mac=$safe_mac");
801 802 803 804 805 806

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
807
    my ($nodeid, $iface) = $query_result->fetchrow_array();
808

809
    return Interface->LookupByIface($nodeid, $iface);
810 811 812 813 814 815 816 817 818
}

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

    my $query_result =
822 823
	DBQueryWarn("select node_id,iface from interfaces ".
		    "where ip=$safe_ip and ".
824 825 826 827 828 829 830 831
		    "      (role='" . TBDB_IFACEROLE_CONTROL()  . "' or ".
		    "       role='" . TBDB_IFACEROLE_MANAGEMENT()  . "')");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
832
    my ($nodeid, $iface) = $query_result->fetchrow_array();
833

834
    return Interface->LookupByIface($nodeid, $iface);
835 836
}

837 838 839 840 841 842 843 844 845 846 847 848
#
# Lookup by uuid
#
sub LookupByUUID($$)
{
    my ($class, $uuid) = @_;

    if (! ($uuid =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	return undef;
    }
    
    my $query_result =
849
	DBQueryWarn("select node_id,iface from interfaces ".
850 851 852 853 854 855 856
		    "where uuid='$uuid'");

    return undef
	if (!$query_result);
    return undef
	if (!$query_result->numrows);
    
857
    my ($nodeid, $iface) = $query_result->fetchrow_array();
858

859
    return Interface->LookupByIface($nodeid, $iface);
860 861
}

862 863 864 865 866 867 868
#
# Lookup the control interface for a node, which is something we do a lot.
#
sub LookupControl($)
{
    my ($class, $nodeid) = @_;

869 870 871
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

872
    my $query_result =
873
	DBQueryWarn("select iface from interfaces ".
874 875 876 877 878 879 880 881
		    "where node_id='$nodeid' and ".
		    "      role='" . TBDB_IFACEROLE_CONTROL()  . "'");

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

882
    my ($iface) = $query_result->fetchrow_array();
883

884
    return Interface->LookupByIface($nodeid, $iface);
885 886
}

887 888 889 890 891 892 893 894 895 896 897
#
# Lookup the management interface for a node.
#
sub LookupManagement($)
{
    my ($class, $nodeid) = @_;

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

    my $query_result =
898
	DBQueryWarn("select iface from interfaces ".
899 900 901 902 903 904 905 906
		    "where node_id='$nodeid' and ".
		    "      role='" . TBDB_IFACEROLE_MANAGEMENT()  . "'");

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

907
    my ($iface) = $query_result->fetchrow_array();
908

909
    return Interface->LookupByIface($nodeid, $iface);
910 911
}

912 913 914 915 916 917 918 919 920 921 922 923 924
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $nodeid = $self->node_id();
    my $iface  = $self->iface();

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

925 926 927 928 929 930 931 932 933
#
# Dump for debugging.
#
sub Dump($)
{
    my ($self) = @_;

    print "Node:      " . $self->node_id() . "\n";
    print "Iface:     " . $self->iface() . "\n";
934 935 936 937
    if ($self->wiredup()) {
	print "Card:      " . $self->card() . "\n";
	print "Port:      " . $self->port() . "\n";
    }
938 939 940
    print "Type:      " . $self->type() . "\n";
    print "Role:      " . $self->role() . "\n";
    print "Trunk:     " . $self->trunk() . "\n";
Leigh Stoller's avatar
Leigh Stoller committed
941
    print "IP:        " . ($self->IP() || "") . "\n";
942 943 944 945
    print "MAC:       " . $self->mac() . "\n";
    return 0;
}

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
#
# 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;
}

972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
#
# 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);
}

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
#
# Lookup a specific attribute in the type capabilities table. 
#
sub TypeCapability($$$)
{
    my ($self, $capkey, $pcapval) = @_;
    
    return -1
	if (!ref($self));

1014
    my $itype = $self->type();
1015 1016 1017

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

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

1027
##############################################################################
1028 1029 1030
package Interface::VInterface;
use libdb;
use libtestbed;
1031
use emutil qw(GenFakeMac);
1032
use English;
1033
use Carp;
1034
use overload ('""' => 'Stringify');
1035
use vars qw($AUTOLOAD);
1036 1037 1038 1039 1040 1041

my $nextfake = 0;

#
# Lookup by node_id,unit
#
1042
sub Lookup($$$)
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
{
    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();
1061
    $vinterface->{"HASH"}  = {};
1062 1063
    bless($vinterface, $class);
}
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

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;
}
1095 1096 1097

# The virtual iface name is $type$unit
sub viface($)     { return $_[0]->type() . $_[0]->unit(); }
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121

#
# 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);
}
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
    
#
# 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'}));

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
    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;
	    }
	}
    }

1171 1172 1173 1174
    my $query = "insert into vinterfaces set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    my $query_result = DBQueryWarn($query);
1175
    DBQueryWarn("unlock tables");
1176 1177 1178
    return undef
	if (!defined($query_result));

1179
    my $unit= $query_result->insertid;
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    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));
1192
    $argref->{'node_id'}  = $nodeid;
1193 1194 1195
    foreach my $field (('vnode_id', 'iface', 'vlanid', 'bandwidth')) {
	$argref->{$field} = undef if (!exists($argref->{$field}));
    }
1196 1197

    # This is usually generated by the insert.
1198
    $argref->{'unit'}   = $nextfake++;
1199 1200 1201

    my $self            = {};
    $self->{"DBROW"}    = $argref;
1202
    $self->{"HASH"}     = {};
1203
    $self->{"FAKE"}     = 1;
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
    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));

    #
1240 1241
    # 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.
1242
    #
1243 1244
    DBQueryWarn("update vinterfaces set bandwidth=0-${bandwidth} ".
		"where node_id='$nodeid' and unit='$unit'")
1245
	or return -1;
1246 1247
	
    $self->{'DBROW'}->{'bandwidth'} = $bandwidth;
1248 1249 1250
    return 0;
}

1251 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
#
# 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));

1286 1287 1288 1289 1290 1291
    if (exists($self->{'FAKE'})) {
	foreach my $key (keys(%{$argref})) {
	    $self->{"DBROW"}->{$key} = $argref->{$key};
	}
	return 0;
    }
1292

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
    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);
}

1314 1315
##############################################################################
#
Leigh Stoller's avatar
Leigh Stoller committed
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
# 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) = @_;

1332 1333 1334 1335 1336 1337 1338
    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 {
1339
	my ($node_id1,$card1,$port1,$iface1);
1340
	
1341 1342 1343
	if (!ref($interface)) {
	    # Allow "nodeid:card:port" argument.
	    if ($interface =~ /^([-\w]*):(\w+):(\w+)$/) {
1344 1345 1346
		$node_id1 = $1;
		$card1    = $2;
		$port1    = $3;
1347 1348 1349 1350 1351

		$query_result =
		    DBQueryWarn("select * from wires ".
				"where node_id1='$node_id1' and ".
				"      card1='$card1' and port1='$port1'");
1352 1353 1354 1355
	    }
	    else {
		return undef;
	    }
Leigh Stoller's avatar
Leigh Stoller committed
1356
	}
1357 1358
	else {
	    $node_id1 = $interface->node_id();
1359 1360 1361 1362 1363 1364
	    $iface1   = $interface->iface();

	    $query_result =
		DBQueryWarn("select * from wires ".
			    "where node_id1='$node_id1' and ".
			    "      iface1='$iface1'");
1365
	}
Leigh Stoller's avatar
Leigh Stoller committed
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    }

    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'); }
1383 1384
sub iface1($)          { return $_[0]->field('iface1'); }
sub iface2($)          { return $_[0]->field('iface2'); }
Leigh Stoller's avatar
Leigh Stoller committed
1385
sub type($)            { return $_[0]->field('type'); }
1386 1387
sub cable($)           { return $_[0]->field('cable'); }
sub len($)             { return $_[0]->field('len'); }
Leigh Stoller's avatar
Leigh Stoller committed
1388
sub logical($)         { return $_[0]->field('logical'); }
1389
sub trunkid($)         { return $_[0]->field('trunkid'); }
1390 1391
sub IsActive($)        { return ($_[0]->type() eq "Unused" ? 0 : 1); }

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
#
# Create a wire by Interfaces.
#
sub Create($$$$$)
{
    my ($self, $interface1, $interface2, $type, $argref) = @_;

    my $node_id1  = $interface1->node_id();
    my $iface1    = $interface1->iface();
    my $node_id2  = $interface2->node_id();
    my $iface2    = $interface2->iface();
1403 1404 1405 1406 1407 1408 1409 1410 1411
    my $card1     = $argref->{'card1'};
    my $port1     = $argref->{'port1'};
    my $card2     = $argref->{'card2'};
    my $port2     = $argref->{'port2'};
    if (! (defined($card1) && defined($port1) &&
	   defined($card2) && defined($port2))) {
	print STDERR "*** Interface::Wire->Create(): missing arguments\n";
	return undef;
    }
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431

    my $command = "insert into wires set".
	"  type='$type', " .
	"  node_id1='$node_id1',card1=$card1,port1=$port1, " .
	"  iface1='$iface1', ".
	"  node_id2='$node_id2',card2=$card2,port2=$port2, ".
	"  iface2='$iface2'";
    $command .= ",cable=" . DBQuoteSpecial($argref->{'cable'})
	if (exists($argref->{'cable'}));
    $command .= ",len=" . DBQuoteSpecial($argref->{'cablelen'})
	if (exists($argref->{'cablelen'}));
    $command .= ",external_wire=" . DBQuoteSpecial($argref->{'external_wire'})
	if (exists($argref->{'external_wire'}));
    $command .= ",external_interface=" .
	DBQuoteSpecial($argref->{'external_interface'})
	if (exists($argref->{'external_interface'}));

    DBQueryWarn($command) or
	return undef;

1432
    return Interface::Wire->LookupByIface($node_id1, $iface1);
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
}

#
# Create a fake object. Port library uses this too.
#
sub MakeFake($$)
{
    my ($class, $argref) = @_;

    my $query_result =
	DBQueryWarn("show columns from wires");
    return undef
	if (!$query_result);
    
    while (my ($slot) = $query_result->fetchrow_array()) {
	if (!exists($argref->{$slot})) {
	    $argref->{$slot} = "";
	}
    }
    my $self            = {};
    $self->{"DBROW"}    = $argref;
    bless($self, $class);

    return $self;
}

1459 1460 1461
#
# Find me a wire from either side using nodeid,card,port.
#
Leigh Stoller's avatar
Leigh Stoller committed
1462
sub LookupAny($$$$)
1463 1464 1465
{
    my ($class, $nodeid, $card, $port) = @_;

1466 1467 1468
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
    my $query_result =
	DBQueryWarn("select * from wires ".
		    "where (node_id1='$nodeid' and ".
		    "       card1='$card' and port1='$port') or ".
		    "      (node_id2='$nodeid' and ".
		    "       card2='$card' and port2='$port')");

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

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
    return $wire;
}
1484 1485 1486 1487
sub LookupAnyByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;

1488 1489 1490
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
    my $query_result =
	DBQueryWarn("select * from wires ".
		    "where (node_id1='$nodeid' and iface1='$iface') or ".
		    "      (node_id2='$nodeid' and iface2='$iface')");

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

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
    return $wire;
}
1504 1505 1506 1507
sub LookupByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;

1508 1509 1510
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    my $query_result =
	DBQueryWarn("select * from wires ".
		    "where (node_id1='$nodeid' and iface1='$iface')");

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

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
    return $wire;
}
1523 1524 1525 1526 1527

sub LookupAnyByIfaces($$$$$)
{
    my ($class, $nodeid1, $iface1, $nodeid2, $iface2) = @_;

1528 1529 1530 1531 1532
    $nodeid1 = $nodeid1->node_id()
	if (ref($nodeid1));
    $nodeid2 = $nodeid2->node_id()
	if (ref($nodeid2));

1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
    my $query_result =
	DBQueryWarn("select * from wires ".
		    "where ((node_id1='$nodeid1' and iface1='$iface1') and ".
		    "       (node_id2='$nodeid2' and iface2='$iface2')) or ".
		    "      ((node_id2='$nodeid1' and iface2='$iface1') and ".
		    "       (node_id1='$nodeid2' and iface1='$iface2'))");

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

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
    return $wire;
}
1548

1549
#
1550
# Delete a wire. For safety refuse to delete a real wire unless flag given.
1551
#
1552
sub Delete($;$)
1553
{
1554 1555
    my ($self, $real) = @_;
    my $logical = ($real ? 0 : 1);
1556

1557
    if ($logical && !$self->logical()) {
1558 1559 1560 1561
	print STDERR "Refusing to delete real $self\n";
	return -1;
    }
    my $node_id1 = $self->node_id1();
1562 1563 1564
    my $iface1   = $self->iface1();
    my $node_id2 = $self->node_id2();
    my $iface2   = $self->iface2();
1565 1566 1567

    return -1
	if (!DBQueryWarn("delete from wires ".
1568 1569
			 "where node_id1='$node_id1' and iface1='$iface1' and ".
			 "      node_id2='$node_id2' and iface2='$iface2'"));
1570 1571
    return 0;
}
Leigh Stoller's avatar
Leigh Stoller committed
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581

#
# 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) = @_;

1582 1583
    return (Interface->LookupByIface($self->node_id1(), $self->iface1()),
	    Interface->LookupByIface($self->node_id2(), $self->iface2()));
Leigh Stoller's avatar
Leigh Stoller committed
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
}

#
# 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();
1599
    my $type    = ($self->logical() ? "LogicalWire" : "Wire");
Leigh Stoller's avatar
Leigh Stoller committed
1600

1601
    return "[$type: $node1:$card1:$port1/$node2:$card2:$port2]";
Leigh Stoller's avatar
Leigh Stoller committed
1602 1603
}

1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
#
# Dump for debugging.
#
sub Dump($)
{
    my ($self) = @_;

    print "Node1:      " . $self->node_id1() . "\n";
    print "Iface1:     " . $self->iface1() . "\n";
    print "Card1:      " . $self->card1() . "\n";
    print "Port1:      " . $self->port1() . "\n";
    print "Node2:      " . $self->node_id2() . "\n";
    print "Iface2:     " . $self->iface2() . "\n";
    print "Card2:      " . $self->card2() . "\n";
    print "Port2:      " . $self->port2() . "\n";
    print "Type:       " . $self->type() . "\n";
    if ($self->cable()) {
	print "Cable:      " . $self->cable() . "\n";
	print "Length:     " . $self->len() . "\n";
    }
    return 0;
}

1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
sub Update($$)
{
    my ($self, $argref) = @_;

    my $node_id1 = $self->node_id1();
    my $card1    = $self->card1();
    my $port1    = $self->port1();
    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 wires set " . join(",", @sets) .
	" where node_id1='$node_id1' and card1='$card1' and port1='$port1'";

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

    my $query_result =
	DBQueryWarn("select * from wires ".
		    "where node_id1='$node_id1' and ".
		    "      card1='$card1' and port1='$port1'");
    return -1
	if (!$query_result || !$query_result->numrows);

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

1660
##############################################################################
Leigh Stoller's avatar
Leigh Stoller committed
1661
#
1662 1663
# A wrapper class for a "logical wire". This is a wire that exists
# cause it was created with a layer 1 switch. 
Leigh Stoller's avatar
Leigh Stoller committed
1664
#
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
package Interface::LogicalWire;
use libdb;
use Node;
use libtestbed;
use English;
use overload ('""' => 'Stringify');

#
# Lookup a logical wire.
#
sub Lookup($$$)
Leigh Stoller's avatar
Leigh Stoller committed
1676
{
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
    my ($class, $nodeid, $iface) = @_;

    my $query_result =
	DBQueryWarn("select * from logical_wires ".
		    "where (node_id1='$nodeid' and iface1='$iface') or ".
		    "      (node_id2='$nodeid' and iface2='$iface')");

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

    my $wire = {};
    $wire->{"DBROW"}  = $query_result->fetchrow_hashref();
    bless($wire, $class);
Leigh Stoller's avatar
Leigh Stoller committed
1690

1691
    #
1692
    # Grab the physical wires.
1693
    #
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
    my $node_id1   = $wire->node_id1();
    my $node_id2   = $wire->node_id2();
    my $physiface1 = $wire->physiface1();
    my $physiface2 = $wire->physiface2();
    
    my $pwire1 = Interface::Wire->LookupAnyByIface($node_id1, $physiface1);
    if (!defined($pwire1)) {
	print STDERR "*** No physical wire for $node_id1:$physiface1\n";
	return undef;
    }
    my $pwire2 = Interface::Wire->LookupAnyByIface($node_id2, $physiface2);
    if (!defined($pwire2)) {
	print STDERR "*** No physical wire for $node_id2:$physiface2\n";
	return undef;
    }
    #
    # Now we can get the card,port for each side, and so it looks like
    # a real wire to the callers (say, Port.pm).
    #
    my ($card1,$port1,$card2,$port2);
    if ($pwire1->node_id1() eq $node_id1 && $pwire1->iface1() eq $physiface1) {
	$card1 = $pwire1->card1();
	$port1 = $pwire1->port1();
    }
    else {
	$card1 = $pwire1->card2();
	$port1 = $pwire1->port2();
    }
    if ($pwire2->node_id1() eq $node_id2 && $pwire2->iface1() eq $physiface2) {
	$card2 = $pwire2->card1();
	$port2 = $pwire2->port1();
1725
    }
1726 1727 1728 1729 1730 1731 1732 1733
    else {
	$card2 = $pwire2->card2();
	$port2 = $pwire2->port2();
    }
    $wire->{"CARD1"} = $card1;
    $wire->{"PORT1"} = $port1;
    $wire->{"CARD2"} = $card2;
    $wire->{"PORT2"} = $port2;
1734
    
1735
    return $wire;
Leigh Stoller's avatar
Leigh Stoller committed
1736
}
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
sub field($$)	       { return $_[0]->{'DBROW'}->{$_[1]}; }
sub node_id1($)        { return $_[0]->field('node_id1'); }
sub node_id2($)        { return $_[0]->field('node_id2'); }
sub iface1($)          { return $_[0]->field('iface1'); }
sub iface2($)          { return $_[0]->field('iface2'); }
sub physiface1($)      { return $_[0]->field('physiface1'); }
sub physiface2($)      { return $_[0]->field('physiface2'); }
sub type($)            { return $_[0]->field('type'); }
sub IsActive($)        { return ($_[0]->type() eq "Unused" ? 0 : 1); }
sub card1($)           { return $_[0]->{'CARD1'}; }
sub port1($)           { return $_[0]->{'PORT1'}; }
sub card2($)           { return $_[0]->{'CARD2'}; }
sub port2($)           { return $_[0]->{'PORT2'}; }
Leigh Stoller's avatar
Leigh Stoller committed
1750

1751
#
1752
# For snmpit.
1753
#
1754
sub LookupByWireID($$)
1755
{
1756 1757
    my ($class, $wireid) = @_;
    my ($nodeid,$iface) = split(":", $wireid);
1758

1759
    return Lookup($class, $nodeid, $iface);
1760 1761
}
#
1762
# For Port.pm
1763
#
1764
sub LookupByPhysIface($$)
1765
{
1766
    my ($self, $nodeid, $physiface) = @_;
1767

1768 1769 1770 1771 1772 1773
    my $query_result =
	DBQueryWarn("select node_id1,iface1 from logical_wires ".
		    "where (node_id1='$nodeid' and ".
		    "       physiface1='$physiface') or ".
		    "      (node_id2='$nodeid' and ".
		    "       physiface2='$physiface')");
1774

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

1778
    my ($node_id1,$iface1) = $query_result->fetchrow_array();
1779

1780 1781
    return Interface::LogicalWire->Lookup($node_id1, $iface1);
}
1782 1783 1784

#
# Create a pair of logical interfaces that will later be wired together
1785
# at layer 1 with logical wire. Called from the mapper only.
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
#
sub Create($$$$$$)
{
    my ($class, $impotent, $nodeA, $portA, $nodeB, $portB) = @_;

    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;
    }
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811

    #
    # For consistency and because we still have an implicit assumption
    # the node is node_id1 in the wires table and the switch is node_id2.
    #
    if ($pnodeA->isswitch() && !$pnodeB->isswitch()) {
	($nodeA,$nodeB)   = ($nodeB,$nodeA);
	($portA,$portB)   = ($portB,$portA);
	($pnodeA,$pnodeB) = ($pnodeB,$pnodeA);
    }
    
1812 1813 1814 1815 1816
    my $interfaceA = Interface->LookupByIface($pnodeA, $portA);
    if (!defined($interfaceA)) {
	print STDERR "Could not lookup '$pnodeA:$portA'\n";
	return undef;
    }
1817 1818 1819 1820
    if (!$interfaceA->wiredup()) {
	print STDERR "No wire for $interfaceA\n";
	return undef;
    }
1821 1822 1823 1824 1825
    my $interfaceB = Interface->LookupByIface($pnodeB, $portB);
    if (!defined($interfaceB)) {
	print STDERR "Could not lookup '$pnodeB:$portB'\n";
	return undef;
    }
1826 1827 1828 1829 1830 1831
    if (!$interfaceB->wiredup()) {
	print STDERR "No wire for $interfaceB\n";
	return undef;