Interface.pm.in 49 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
Leigh Stoller's avatar
Leigh Stoller committed
3
# Copyright (c) 2005-2017 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
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  = ();
47 48 49
BEGIN { use emutil;
	emutil::AddCache(\%all_interfaces); 
	emutil::AddCache(\%node_interfaces); }
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

# 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.
#
67
sub LookupAll($$$)
68
{
69
    my ($class, $nodeid, $pref) = @_;
70
    my $node;
71

72 73 74 75 76 77 78 79 80 81 82 83
    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;
	}
    }
84
    # Look in cache first
85 86 87 88 89
    if (exists($node_interfaces{$nodeid})) {
	@$pref = @{ $node_interfaces{$nodeid} };
	return 0;
    }
    @$pref = ();
90

91 92 93 94 95 96 97
    #
    # 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.
    #
    my $logical_clause = ($node->isvirtnode() ? "" : "and logical=0");

98 99
    my $query_result =
	DBQueryWarn("select * from interfaces ".
100
		    "where node_id='$nodeid' $logical_clause");
101

102
    return -1
103
	if (!$query_result);
104
    return 0
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
	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);

128 129 130
	    #
	    # Grab the wires table entry.
	    #
131
	    $interface->{'WIRE'} = Interface::Wire->Lookup($interface);	    
132

133 134 135 136 137 138 139 140 141 142
	    #
	    # 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);
143 144 145 146 147 148
	    if (!$state_result->numrows) {
		print STDERR
		    "*** Missing interface_state table entry for interface\n".
		    "    card:port $card:$port on $nodeid.\n";
		return -1;
	    }
149 150
	    $interface->{'STATE'} = $state_result->fetchrow_hashref();

151 152 153 154 155 156 157 158 159
	    # 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;
    
160 161
    @$pref = @{ $results };
    return 0;
162 163 164 165 166 167 168 169 170 171 172
}
# 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'); }
173
sub logical($) { return field($_[0], 'logical'); }
Leigh Stoller's avatar
Leigh Stoller committed
174
sub speed($)   { return field($_[0], 'current_speed'); }
175 176
sub trunk_mode($) { return field($_[0], 'trunk_mode'); }
sub trunk($)   { return field($_[0], 'trunk'); }
Leigh Stoller's avatar
Leigh Stoller committed
177
sub current_speed($) { return field($_[0], 'current_speed'); }
178
sub mask($)    { return field($_[0], 'mask'); }
179
sub uuid($)    { return field($_[0], 'uuid'); }
180
# Wires table
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
sub wire($)    { return $_[0]->{'WIRE'}; }
sub wiredup($) { return (defined($_[0]->{'WIRE'}) ? 1 : 0); }
sub wirefield($$) {
    my ($self, $slot) = @_;
    if (!$self->wiredup()) {
	warn "*** $self is not wired up, but asked for wire $slot!\n";
	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'); }
196
sub wire_unused($) { return $_[0]->wire_type() eq "Unused" ? 1 : 0; }
197
# Interface State table
198 199 200 201
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'}; }
202 203 204 205 206 207 208

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

    return $self->role() eq TBDB_IFACEROLE_EXPERIMENT();
}
Leigh Stoller's avatar
Leigh Stoller committed
209 210 211 212 213 214
sub IsControl($)
{
    my ($self) = @_;

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

216 217 218 219 220 221 222
sub IsManagement($)
{
    my ($self) = @_;

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

223 224 225
#
# Lookup by card,port
#
226
sub Lookup($$$;$)
227 228 229
{
    my ($class, $nodeid, $card, $port) = @_;

230 231 232
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

233 234 235 236
    # XXX: the node side always uses port 1.
    $port = 1
	if (!defined($port));

237 238 239 240 241 242 243 244 245 246 247 248 249 250
    # 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);

251
    my $iface_row = $query_result->fetchrow_hashref();
252
    my $state_row;
253

254 255 256 257 258 259 260 261
    #
    # And the interface_state table.
    #
    $query_result =
	DBQueryWarn("select * from interface_state ".
		    "where node_id='$nodeid' and ".
		    "      card='$card' and port='$port'");
    return undef
262
	if (!$query_result);
263 264

    #
265 266 267
    # 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
    # create it. 
268
    #
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
    if (!$query_result->numrows) {
	require Node;
	my $node = Node->Lookup($nodeid);
	if (! ($iface_row->{'role'} eq TBDB_IFACEROLE_MANAGEMENT() ||
	       (defined($node) && $node->role() ne "testnode"))) {
	    print STDERR "*** Inserting missing interface_state ".
		"for $nodeid:$card:$port\n";
	    my $iface = $iface_row->{'iface'};
	    DBQueryWarn("insert into interface_state set ".
			"  node_id='$nodeid',card='$card',".
			"  port='$port',iface='$iface'")
		or return undef;
	    $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);
	    
	    $state_row = $query_result->fetchrow_hashref();
	}
290
    }
291 292 293 294
    else {
	$state_row = $query_result->fetchrow_hashref();
    }
    my $interface = LookupRow($class, $iface_row, $state_row);
295

296 297 298 299 300
    #
    # Grab the wires table entry. It is okay for this to not exist, although
    # that is a little unusual since interfaces are usually the node side.
    #
    $interface->{'WIRE'} = Interface::Wire->Lookup($interface);
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
    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);

316
    
317 318 319 320 321
    # Cache by card,port and by iface
    my $iface = $interface->iface();
    
    $all_interfaces{"$nodeid:$card:$port"} = $interface;
    $all_interfaces{"$nodeid:$iface"}      = $interface;
322

323 324 325
    return $interface;
}

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

    delete($all_interfaces{"$nodeid:$card:$port"});
    delete($all_interfaces{"$nodeid:$iface"});
}

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
#
# 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 ".
355 356
		    "where node_id='$nodeid' and card='$card' and ".
		    "      port='$port'");
357 358 359 360 361 362 363 364
    return undef
	if (!$query_result || !$query_result->numrows);

    $self->{"DBROW"} = $query_result->fetchrow_hashref();
    
    #
    # And the interface_state table.
    #
365 366 367 368 369 370 371 372 373 374
    if (defined($self->{'STATE'})) {
	$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();
    }
375 376 377
    return 0;
}

378 379 380 381 382 383 384 385 386 387 388 389
#
# 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();

390
    my $MAC        = $argref->{'MAC'} || $argref->{'mac'};
391 392 393 394
    my $IP         = $argref->{'IP'};
    my $mask       = $argref->{'mask'};
    my $card       = $argref->{'card'};
    my $port       = $argref->{'port'};
Leigh Stoller's avatar
Leigh Stoller committed
395
    my $iftype     = $argref->{'type'} || $argref->{'interface_type'};
396 397 398 399 400 401 402 403 404 405
    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'};
406
    my $iface      = $argref->{'iface'};
407
    my $logical    = $argref->{'logical'};
408
    my $trunk      = $argref->{'trunk'};
409
    my $auto       = $argref->{'autocreated'};
410

411 412 413 414
    if (!defined($wire_type)) {
	if ($ifrole eq TBDB_IFACEROLE_MANAGEMENT()) {
	    $wire_type = "Management";
	}
415
	elsif ($ifrole eq TBDB_IFACEROLE_EXPERIMENT()) {
416 417
	    $wire_type = "Node";
	}
418 419 420
	elsif ($ifrole eq TBDB_IFACEROLE_CONTROL()) {
	    $wire_type = "Control";
	}
421
    }
422 423
    $iface = "eth$card"    
	if (!defined($iface));
424 425 426 427 428 429 430 431 432 433
    $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));
434 435
    $logical = 0
	if (!defined($logical));
436 437
    $auto = 0
	if (!defined($auto));
438 439
    $trunk = 0
	if (!defined($trunk));
440 441 442 443 444 445 446
    if (!defined($uuid)) {
	$uuid = NewUUID();
	if (!defined($uuid)) {
	    print STDERR "Could not generate a UUID!\n";
	    return undef;
	}
    }
447
    if (! (defined($card) && defined($ifrole) && defined($MAC) &&
Leigh Stoller's avatar
Leigh Stoller committed
448
	   defined($IP) && defined($port) && 
449 450 451 452 453 454
	   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;
    }
455

456 457 458 459 460
    #
    # Lock the tables to prevent concurrent creation
    #
    DBQueryWarn("lock tables interfaces write, ".
		"            interface_state write, ".
461 462
		"            vinterfaces read, ".
		"            node_history read, ".
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
		"            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);
    }
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

    #
    # 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);
	}
    }
504 505
    
    if (!DBQueryWarn("insert into interfaces set ".
506
		"  node_id='$node_id', logical='$logical', " .
507
		"  card=$card, port=$port, role='$ifrole', ".
508
		"  mac='$MAC', IP='$IP', autocreated='$auto', " .
Leigh Stoller's avatar
Leigh Stoller committed
509
		(defined($mask) ? "mask='$mask', " : "") .
510
		($trunk ? "trunk='1', " : "") .
511 512
		"  interface_type='$iftype', iface='$iface', " .
		"  current_speed='$max_speed', duplex='$duplex', ".
513 514 515 516
		"  uuid='$uuid'")) {
	DBQueryWarn("unlock tables");
	return undef;
    }
517

518 519
    if (!DBQueryWarn("insert into interface_state set ".
		     "  node_id='$node_id', " .
520
		     ($trunk ? "remaining_bandwidth='$max_speed', " : "") .
521 522 523 524
		     "  card=$card, port=$port, iface='$iface'")) {
	DBQueryWarn("delete from interfaces ".
		    "where node_id='$node_id' and card='$card' ".
		    "      and port='$port'");
525
	DBQueryWarn("unlock tables");
526 527 528
	return undef;
    }

529 530 531 532 533 534 535 536 537
    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".
538
			 "  type='$wire_type', logical='$logical', " .
539 540 541
			 "  node_id1='$node_id', card1=$card, port1=$port, " .
			 "  node_id2='$switch_id', card2='$switch_card', " .
			 "  port2='$switch_port' $cable_len")) {
542 543 544
	    DBQueryWarn("delete from interface_state ".
			"where node_id='$node_id' and card='$card' ".
			"      and port='$port'");
545 546 547
	    DBQueryWarn("delete from interfaces ".
			"where node_id='$node_id' and card='$card' ".
			"      and port='$port'");
548
	    DBQueryWarn("unlock tables");
549 550 551
	    return undef;
	}
    }
552
    DBQueryWarn("unlock tables");
553 554 555
    return Interface->Lookup($node_id, $card, $port);
}

556 557 558
#
# Delete a logical interface.
#
559
sub Delete($;$)
560
{
561 562
    my ($self, $real) = @_;
    my $logical = ($real ? 0 : 1);
563

564
    if ($logical && !$self->logical()) {
565 566 567 568 569 570 571 572 573 574 575
	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'"));
576 577 578 579
    return -1
	if (!DBQueryWarn("delete from port_counters ".
			 "where node_id='$node_id' and card='$card' and ".
			 "      port='$port'"));
580 581
    return -1
	if (!DBQueryWarn("delete from interfaces ".
582
			 "where logical=$logical and ".
583 584 585 586 587
			 "      node_id='$node_id' and card='$card' and ".
			 "      port='$port'"));
    return 0;
}

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
#
# 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;
}

605 606
#
# Create a fake object, as for the mapper (assign_wrapper) during debugging.
607
# Port library uses this too.
608 609 610 611 612
#
sub MakeFake($$$)
{
    my ($class, $node, $argref) = @_;

613 614 615 616 617 618 619 620 621 622 623
    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} = "";
	}
    }
    my $nodeid = ref($node) ? $node->node_id() : $node;
624 625 626 627
    $argref->{'node_id'} = $nodeid;

    my $self            = {};
    $self->{"DBROW"}    = $argref;
628 629 630 631 632 633 634 635
    $self->{"STATE"}    = {
	"node_id"  => $nodeid,
	"card"     => $argref->{'card'},
	"port"     => $argref->{'port'},
	"iface"    => $argref->{'iface'},
	"tagged"   => 0,
	"enabled"  => 1,
    };
636 637 638 639 640 641 642 643 644 645 646 647
    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;
}

648 649 650 651 652 653 654
#
# Lookup by iface
#
sub LookupByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;

655 656 657
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

658 659 660 661
    # Look in cache first
    return $all_interfaces{"$nodeid:$iface"}
        if (exists($all_interfaces{"$nodeid:$iface"}));

662 663 664 665
    # Used from Protogeni code, so be careful.
    my $safe_nodeid = DBQuoteSpecial($nodeid);
    my $safe_iface  = DBQuoteSpecial($iface);

666
    my $query_result =
667
	DBQueryWarn("select card,port from interfaces ".
668
		    "where node_id=$safe_nodeid and iface=$safe_iface");
669 670 671 672 673 674

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

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

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

680 681 682 683 684 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 712 713 714 715 716 717 718 719 720 721 722 723 724
#
# 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);
}

725 726 727 728 729 730 731 732 733 734 735 736
#
# Lookup by uuid
#
sub LookupByUUID($$)
{
    my ($class, $uuid) = @_;

    if (! ($uuid =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	return undef;
    }
    
    my $query_result =
737
	DBQueryWarn("select node_id,card,port from interfaces ".
738 739 740 741 742 743 744
		    "where uuid='$uuid'");

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

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

750 751 752 753 754 755 756
#
# Lookup the control interface for a node, which is something we do a lot.
#
sub LookupControl($)
{
    my ($class, $nodeid) = @_;

757 758 759
    $nodeid = $nodeid->node_id()
	if (ref($nodeid));

760
    my $query_result =
761
	DBQueryWarn("select card,port from interfaces ".
762 763 764 765 766 767 768 769
		    "where node_id='$nodeid' and ".
		    "      role='" . TBDB_IFACEROLE_CONTROL()  . "'");

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

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

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

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
#
# 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);
}

800 801 802 803 804 805 806 807 808 809 810 811 812
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $nodeid = $self->node_id();
    my $iface  = $self->iface();

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

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
#
# Dump for debugging.
#
sub Dump($)
{
    my ($self) = @_;

    print "Node:      " . $self->node_id() . "\n";
    print "Iface:     " . $self->iface() . "\n";
    print "Card:      " . $self->card() . "\n";
    print "Port:      " . $self->port() . "\n";
    print "Type:      " . $self->type() . "\n";
    print "Role:      " . $self->role() . "\n";
    print "Trunk:     " . $self->trunk() . "\n";
    print "IP:        " . $self->IP() . "\n";
    print "MAC:       " . $self->mac() . "\n";
    return 0;
}

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
#
# 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;
}

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
#
# 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);
}

890 891 892 893 894 895 896 897 898 899
#
# Lookup a specific attribute in the type capabilities table. 
#
sub TypeCapability($$$)
{
    my ($self, $capkey, $pcapval) = @_;
    
    return -1
	if (!ref($self));

900
    my $itype = $self->type();
901 902 903

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

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

913
##############################################################################
914 915 916
package Interface::VInterface;
use libdb;
use libtestbed;
917
use emutil qw(GenFakeMac);
918
use English;
919
use Carp;
920
use overload ('""' => 'Stringify');
921
use vars qw($AUTOLOAD);
922 923 924 925 926 927

my $nextfake = 0;

#
# Lookup by node_id,unit
#
928
sub Lookup($$$)
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
{
    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();
947
    $vinterface->{"HASH"}  = {};
948 949
    bless($vinterface, $class);
}
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980

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;
}
981 982 983

# The virtual iface name is $type$unit
sub viface($)     { return $_[0]->type() . $_[0]->unit(); }
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007

#
# 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);
}
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
    
#
# 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'}));

1024 1025 1026 1027 1028 1029 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
    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;
	    }
	}
    }

1057 1058 1059 1060
    my $query = "insert into vinterfaces set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    my $query_result = DBQueryWarn($query);
1061
    DBQueryWarn("unlock tables");
1062 1063 1064
    return undef
	if (!defined($query_result));

1065
    my $unit= $query_result->insertid;
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
    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));
1078
    $argref->{'node_id'}  = $nodeid;
1079 1080 1081
    foreach my $field (('vnode_id', 'iface', 'vlanid', 'bandwidth')) {
	$argref->{$field} = undef if (!exists($argref->{$field}));
    }
1082 1083

    # This is usually generated by the insert.
1084
    $argref->{'unit'}   = $nextfake++;
1085 1086 1087

    my $self            = {};
    $self->{"DBROW"}    = $argref;
1088
    $self->{"HASH"}     = {};
1089
    $self->{"FAKE"}     = 1;
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
    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));

    #
1126 1127
    # 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.
1128
    #
1129 1130
    DBQueryWarn("update vinterfaces set bandwidth=0-${bandwidth} ".
		"where node_id='$nodeid' and unit='$unit'")
1131
	or return -1;
1132 1133
	
    $self->{'DBROW'}->{'bandwidth'} = $bandwidth;
1134 1135 1136
    return 0;
}

1137 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 1171
#
# 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));

1172 1173 1174 1175 1176 1177
    if (exists($self->{'FAKE'})) {
	foreach my $key (keys(%{$argref})) {
	    $self->{"DBROW"}->{$key} = $argref->{$key};
	}
	return 0;
    }
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    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);
}

1200 1201
##############################################################################
#
Leigh Stoller's avatar
Leigh Stoller committed
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
# 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) = @_;

1218 1219 1220 1221 1222 1223 1224
    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 {
1225 1226
	my ($node_id1,$card1,$port1);
	
1227 1228 1229
	if (!ref($interface)) {
	    # Allow "nodeid:card:port" argument.
	    if ($interface =~ /^([-\w]*):(\w+):(\w+)$/) {
1230 1231 1232
		$node_id1 = $1;
		$card1    = $2;
		$port1    = $3;
1233 1234 1235 1236
	    }
	    else {
		return undef;
	    }
Leigh Stoller's avatar
Leigh Stoller committed
1237
	}
1238 1239 1240 1241 1242
	else {
	    $node_id1 = $interface->node_id();
	    $card1    = $interface->card();
	    $port1    = $interface->port();
	}
1243 1244 1245 1246
	$query_result =
	    DBQueryWarn("select * from wires ".
			"where node_id1='$node_id1' and ".
			"      card1='$card1' and port1='$port1'");
Leigh Stoller's avatar
Leigh Stoller committed
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    }

    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'); }
1264 1265
sub iface1($)          { return $_[0]->field('iface1'); }
sub iface2($)          { return $_[0]->field('iface2'); }
Leigh Stoller's avatar
Leigh Stoller committed
1266
sub type($)            { return $_[0]->field('type'); }
1267 1268
sub cable($)           { return $_[0]->field('cable'); }
sub len($)             { return $_[0]->field('len'); }
Leigh Stoller's avatar
Leigh Stoller committed
1269
sub logical($)         { return $_[0]->field('logical'); }
1270
sub trunkid($)         { return $_[0]->field('trunkid'); }
1271 1272
sub IsActive($)        { return ($_[0]->type() eq "Unused" ? 0 : 1); }

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 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
#
# Create a wire by Interfaces.
#
sub Create($$$$$)
{
    my ($self, $interface1, $interface2, $type, $argref) = @_;

    my $node_id1  = $interface1->node_id();
    my $card1     = $interface1->card();
    my $port1     = $interface1->port();
    my $iface1    = $interface1->iface();
    my $node_id2  = $interface2->node_id();
    my $card2     = $interface2->card();
    my $port2     = $interface2->port();
    my $iface2    = $interface2->iface();

    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;

    return Interface::Wire->Lookup($interface1);
}

#
# 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;
}

1335 1336 1337
#
# Find me a wire from either side using nodeid,card,port.
#
1338
sub LookupAny($$$;$)
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
{
    my ($class, $nodeid, $card, $port) = @_;

    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;
}
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 1386 1387 1388 1389 1390 1391 1392 1393
sub LookupAnyByIface($$$)
{
    my ($class, $nodeid, $iface) = @_;

    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;
}

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

    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;
}
1394

1395
#
1396
# Delete a wire. For safety refuse to delete a real wire unless flag given.
1397
#
1398
sub Delete($;$)
1399
{
1400 1401
    my ($self, $real) = @_;
    my $logical = ($real ? 0 : 1);
1402

1403
    if ($logical && !$self->logical()) {
1404 1405 1406 1407
	print STDERR "Refusing to delete real $self\n";
	return -1;
    }
    my $node_id1 = $self->node_id1();
1408 1409 1410
    my $iface1   = $self->iface1();
    my $node_id2 = $self->node_id2();
    my $iface2   = $self->iface2();
1411 1412 1413

    return -1
	if (!DBQueryWarn("delete from wires ".
1414 1415
			 "where node_id1='$node_id1' and iface1='$iface1' and ".
			 "      node_id2='$node_id2' and iface2='$iface2'"));
1416 1417
    return 0;
}
Leigh Stoller's avatar
Leigh Stoller committed
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446

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

1449
    return "[$type: $node1:$card1:$port1/$node2:$card2:$port2]";
Leigh Stoller's avatar
Leigh Stoller committed
1450 1451
}

1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
#
# 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;
}

1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
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;
}

Leigh Stoller's avatar
Leigh Stoller committed
1508 1509 1510
#
# Activate a (logical) wire by setting the type. Default to "Node".
#
1511
sub Activate($$)
Leigh Stoller's avatar
Leigh Stoller committed
1512
{
1513
    my ($self, $vlan) = @_;
Leigh Stoller's avatar
Leigh Stoller committed
1514 1515 1516
    my $node_id1 = $self->node_id1();
    my $card1    = $self->card1();
    my $port1    = $self->port1();
1517
    my $type     = "Node";
Leigh Stoller's avatar
Leigh Stoller committed
1518

1519 1520 1521 1522 1523 1524 1525
    #
    # Unless it is supposed to be a trunk
    #
    if ($vlan->GetRole() eq "trunk") {
	$type = "Trunk";
    }
    
Leigh Stoller's avatar
Leigh Stoller committed
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
    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;
}

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
#
# 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++;
	}
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
	my ($interface1, $interface2) = $wire->Interfaces();

	if (defined($interface1) && $interface1->logical()) {
	    $interface1->Delete() == 0
		or return -1;
	}
	if (defined($interface2) && $interface2->logical()) {
	    $interface2->Delete() == 0
		or return -1;
	}
	if ($wire->Delete(0)) {
1623 1624 1625 1626 1627 1628 1629
	    print STDERR "$wire could not be deleted!\n";
	    $errors++;
	}
    }
    return $errors;
}

Leigh Stoller's avatar
Leigh Stoller committed
1630 1631 1632 1633 1634 1635
##############################################################################
#
# 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.
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
#
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;
    }
    
    #
1677
    # Create logical interfaces
1678
    #
1679 1680 1681 1682
    # Must create a real copy, especially for MakeFake();
    my $argref = {};
    foreach my $key (keys(%{ $interfaceA->{'DBROW'} })) {
	$argref->{$key} = $interfaceA->{'DBROW'}->{$key};
1683
    }
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
    # Update the card and iface.
    # XXX Need a better way to allocate the card numbers.
    $argref->{'card'}    = $interfaceA->card() + 200;
    $argref->{'iface'}   = sprintf("eth%d%03d",
				   $argref->{'card'}, $argref->{'port'});
    $argref->{'logical'} = 1;
    $argref->{'uuid'}    = undef;

    if (!$impotent) {
	$interfaceA = Interface->Create($pnodeA, $argref);
	return undef
	    if (!defined($interfaceA));
    }
    else {
	# Fake things up.
	$interfaceA = Interface->MakeFake($pnodeA, $argref);
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

    # Must create a real copy, especially for MakeFake();
    $argref = {};
    foreach my $key (keys(%{ $interfaceB->{'DBROW'} })) {
	$argref->{$key} = $interfaceB->{'DBROW'}->{$key};
    }
    # Update the card and iface.
    # XXX Need a better way to allocate the card numbers.
    $argref->{'card'}    = $interfaceB->card() + 200;
    $argref->{'iface'}   = sprintf("eth%d%03d",
				   $argref->{'card'}, $argref->{'port'});
    $argref->{'logical'} = 1;
    $argref->{'uuid'}    = undef;

    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
1725 1726
    #
    # For consistency and because we still have an implicit assumption
1727
    # the node is node_id1 in the wires table. 
Leigh Stoller's avatar
Leigh Stoller committed
1728 1729
    #
    my ($interface1,$interface2) = ($interfaceA, $interfaceB);
1730
    my ($pnode1,$pnode2) = ($pnodeA, $pnodeB);
Leigh Stoller's avatar
Leigh Stoller committed
1731 1732
    if ($pnodeA->isswitch() && !$pnodeB->isswitch()) {
	($interface1,$interface2) = ($interfaceB, $interfaceA);
1733
	($pnode1,$pnode2) = ($pnodeB, $pnodeA);
Leigh Stoller's avatar
Leigh Stoller committed
1734 1735
    }
    # Create a wires table entry, ordered properly.
1736
    if (!$impotent) {
Leigh Stoller's avatar
Leigh Stoller committed
1737 1738 1739 1740 1741 1742
	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();
1743 1744
	my $iface1   = $interface1->iface();
	my $iface2   = $interface2->iface();
1745 1746 1747 1748 1749 1750 1751

	#
	# 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.
	#
1752
	if (!DBQueryWarn("insert into wires set".
1753 1754
			 "  type='Unused', logical=1, " .
			 "  node_id1='$node_id1',card1=$card1,port1=$port1, " .
1755 1756 1757
			 "  iface1='$iface1', ".
			 "  node_id2='$node_id2',card2=$card2,port2=$port2, ".
			 "  iface2='$iface2'")) {
Leigh Stoller's avatar
Leigh Stoller committed
1758
	    return undef;
1759 1760
	}
    }
Leigh Stoller's avatar
Leigh Stoller committed
1761 1762 1763 1764 1765 1766 1767 1768
    my $self = {};
    #
    # Do not reorder here; the caller will just be confused.
    #
    $self->{"interfaceA"} = $interfaceA;
    $self->{"interfaceB"} = $interfaceB;
    $self->{"interface1"} = $interface1;
    $self->{"interface2"} = $interface2;
1769 1770 1771 1772
    $self->{"pnodeA"}     = $pnodeA;
    $self->{"pnodeB"}     = $pnodeB;
    $self->{"pnode1"}     = $pnode1;
    $self->{"pnode2"}     = $pnode2;
Leigh Stoller's avatar
Leigh Stoller committed
1773

1774 1775 1776
    bless($self, $class);
    return $self;
}
Leigh Stoller's avatar
Leigh Stoller committed
1777 1778 1779 1780 1781 1782 1783 1784 1785
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'}; }
1786 1787 1788 1789 1790 1791 1792
sub iface1($)          { return $_[0]->interface1()->iface(); }
sub iface2($)          { return $_[0]->interface2()->iface(); }
# Convience
sub pnodeA($)          { return $_[0]->{'pnodeA'}; }
sub pnodeB($)          { return $_[0]->{'pnodeB'}; }
sub pnode1($)          { return $_[0]->{'pnode1'}; }
sub pnode2($)          { return $_[0]->{'pnode2'}; }
Leigh Stoller's avatar
Leigh Stoller committed
1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808

#
# 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";
}
1809

1810 1811 1812 1813 1814 1815
#
# Stringify for output. 
#
sub Stringify($)
{
    my ($self) = @_;
Leigh Stoller's avatar
Leigh Stoller committed
1816 1817 1818

    my $interfaceA = $self->interfaceA();
    my $interfaceB = $self->interfaceB();
1819
    
Leigh Stoller's avatar
Leigh Stoller committed
1820 1821 1822 1823 1824 1825
    my $nodeA   = $self->nodeA();
    my $nodeB   = $self->nodeB();
    my $ifaceA  = $self->ifaceA();
    my $ifaceB  = $self->ifaceB();

    return "[LogicalWire: $nodeA:$ifaceA/$nodeB:$ifaceB]";
1826 1827
}

1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
##############################################################################
#
# A trivial wrapper class for interface_types.
#
package Interface::Type;
use libdb;
use Node;
use libtestbed;
use English;
use overload ('""' => 'Stringify');

#
# Lookup by interface type name.
#
sub Lookup($$)
{
    my ($class, $type) = @_;

    if ($type !~ /^[-\w]+$/) {
	return undef;
    }
    my $query_result =
	DBQueryWarn("select * from interface_types where type='$type'");
    return undef
	if (!$query_result || !$query_result->numrows);
    
    my $blob = {};
    $blob->{"DBROW"}  = $query_result->fetchrow_hashref();
    $blob->{"CAPS"}   = {};

    # Load capabilities.
    $query_result =
	DBQueryWarn("select * from interface_capabilities where type='$type'");
    return undef
	if (!$query_result);
    while (my $row = $query_result->fetchrow_hashref()) {
	my $key = $row->{'capkey'};
	my $val = $row->{'capval'};
	$blob->{"CAPS"}->{$key} = $val;
    }
    bless($blob, $class);
    return $blob;
}
sub field($$)	       { return $_[0]->{'DBROW'}->{$_[1]}; }
sub type($)            { return $_[0]->field('type'); }
sub max_speed($)       { return $_[0]->field('max_speed'); }
sub manufacturer($)    { return $_[0]->field('manufacturer'); }
sub model($)           { return $_[0]->field('model'); }
sub ports($)           { return $_[0]->field('ports'); }
sub connector($)       { return $_[0]->field('connector'); }
sub capability($$)
{
    my ($self, $capkey) = @_;

    return undef
	if (!exists($self->{'CAPS'}->{$capkey}));

    return $self->{'CAPS'}->{$capkey};
}

#
# Stringify for output. 
#
sub Stringify($)
{
    my ($self) = @_;

    my $type    = $self->type();
    my $speed   = $self->max_speed();

    return "[InterfaceType: $type:$speed]";
}

#
# Find me the generic type given a speed.
#
sub GenericType($$)
{
    my ($class, $speed) = @_;
    my $itype;
    
    if ($speed eq "100Mb" || "$speed" eq "100000") {
	$itype = "generic";
    }
    elsif ($speed eq "1Gb" || "$speed" eq "1000000") {
	$itype = "generic_1G";
    }
    elsif ($speed eq "10Gb" || "$speed" eq "10000000") {
	$itype = "generic_10G";
    }
    elsif ($speed eq "25Gb" || "$speed" eq "25000000") {
	$itype = "generic_25G";
    }
    elsif ($speed eq "40Gb" || "$speed" eq "40000000") {
	$itype = "generic_40G";
    }
    elsif ($speed eq "56Gb" || "$speed" eq "56000000") {
	$itype = "generic_56G";
    }
    elsif ($speed eq "100Gb" || "$speed" eq "100000000") {
	$itype = "generic_100G";
    }
    else {
	return undef;
    }
    return Interface::Type->Lookup($itype);
}

1936
# _Always_ make sure that this 1 is at the end of the file...
1937
1;
1938