GeniSliver.pm.in 25.8 KB
Newer Older
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1
2
3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2008-2009 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# All rights reserved.
#
package GeniSliver;

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

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

# Must come after package declaration
use lib '@prefix@/lib';
use GeniDB;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
20
use GeniComponent;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
21
use GeniSlice;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
22
use GeniCredential;
23
use GeniCertificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
24
use GeniAggregate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
25
# Hate to import all this crap; need a utility library.
26
use libdb qw(TBGetUniqueIndex);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
27
use libtestbed;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
28
29
use Experiment;
use Node;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30
use English;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
31
use XML::Simple;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
32
33
use Data::Dumper;
use File::Temp qw(tempfile);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34
use overload ('""' => 'Stringify');
Leigh B. Stoller's avatar
Leigh B. Stoller committed
35
36
37
38
39
40
41
42

# Configure variables
my $TB		   = "@prefix@";
my $TBOPS          = "@TBOPSEMAIL@";
my $TBAPPROVAL     = "@TBAPPROVALEMAIL@";
my $TBAUDIT   	   = "@TBAUDITEMAIL@";
my $BOSSNODE       = "@BOSSNODE@";
my $OURDOMAIN      = "@OURDOMAIN@";
43
my $PGENIDOMAIN    = "@PROTOGENI_DOMAIN@";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
44
my $SIGNCRED	   = "$TB/sbin/signgenicred";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
45
46
47
my $AVAIL	   = "$TB/sbin/avail";
my $NALLOC	   = "$TB/bin/nalloc";
my $NFREE	   = "$TB/bin/nfree";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
48
my $NODEREBOOT	   = "$TB/bin/node_reboot";
49
my $NAMEDSETUP     = "$TB/sbin/named_setup";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
50
51
my $PLABNODE       = "$TB/sbin/plabnodewrapper";
my $VNODESETUP     = "$TB/sbin/vnode_setup";
52
my $GENTOPOFILE    = "$TB/libexec/gentopofile";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
53
54
55
56
57
58
59
60
61
62
63

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

#
# Lookup by idx, or uuid.
#
sub Lookup($$)
{
    my ($class, $token) = @_;
    my $query_result;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
64
    my $idx;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
65
66

    if ($token =~ /^\d+$/) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
67
	$idx = $token;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
68
69
70
    }
    elsif ($token =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
	$query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
71
	    DBQueryWarn("select idx from geni_slivers ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
72
			"where uuid='$token'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
73
74
75
76
	    return undef
		if (! $query_result || !$query_result->numrows);

	    ($idx) = $query_result->fetchrow_array();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
77
78
79
80
    }
    else {
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
81
82
83
84
85
86
87
88

    # Look in cache first
    return $slivers{"$idx"}
        if (exists($slivers{"$idx"}));

    $query_result = DBQueryWarn("select * from geni_slivers ".
				"where idx='$idx'");

Leigh B. Stoller's avatar
Leigh B. Stoller committed
89
90
91
    return undef
	if (!$query_result || !$query_result->numrows);

Leigh B. Stoller's avatar
Leigh B. Stoller committed
92
93
    my $self              = {};
    $self->{'SLIVER'}     = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
94
95
96
97
98
99
100
101
102
103
104
    $self->{'COMPONENT'}  = undef;	# client
    $self->{'SLICE'}      = undef;	# client/server
    $self->{'CREDENTIAL'} = undef;	# client
    $self->{'AGGREGATE'}  = undef;	# server
    $self->{'RSPEC'}      = undef;	# client/server

    my $rspec_string = $self->{'SLIVER'}->{'rspec_string'};
    if (defined($rspec_string) && $rspec_string ne "") {
	$self->{'RSPEC'} = XMLin($rspec_string,
				 ForceArray => ["node", "link"]);
    }
105
106
107
108
109
110
111
112
113
114
115

    #
    # Grab the certificate, since we will probably want it.
    #
    my $uuid = $self->{'SLIVER'}->{'uuid'};
    my $certificate = GeniCertificate->Lookup($uuid);
    if (!defined($certificate)) {
	print STDERR "Could not find certificate for sliver $idx ($uuid)\n";
	return undef;
    }
    $self->{'CERTIFICATE'} = $certificate;
116
117
118
119

    # Bless into sub package if called for.
    my $resource_type = $self->{'SLIVER'}->{'resource_type'};
    if (defined($resource_type) && $resource_type ne "") {
120
	bless($self, $class . "::" . $resource_type);
121
122
123
124
    }
    else {
	bless($self, $class);
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
    
    # Add to cache. 
    $slivers{$self->{'SLIVER'}->{'idx'}} = $self;
    
    return $self;
}

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

    return "[GeniSliver: $uuid, IDX: $idx]";
}

#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
146
# Create a sliver record in the DB. On the client side we save the credential
Leigh B. Stoller's avatar
Leigh B. Stoller committed
147
# that allows control of it, for later operations.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
148
#
149
sub Create($$$$$$$$;$$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
150
{
151
    my ($class, $slice, $owner_uuid, $uuid, $resource_uuid, $resource_type,
152
	$hrn, $nickname,
Leigh B. Stoller's avatar
Leigh B. Stoller committed
153
	$rspec, $credential, $component) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
154
    my @insert_data = ();
155
    my $certificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
156
157
158

    # Every sliver gets a new unique index.
    my $idx = TBGetUniqueIndex('next_sliver', 1);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
159
    if (defined($credential)) {
160
	$certificate = $credential->target_cert();
161
	# Store the certificate for later use.
162
	if ($certificate->Store() != 0) {
163
164
165
	    print STDERR "Could not store certificate\n";
	    return undef;
	}
166
	$resource_uuid = $uuid = $credential->this_uuid();
167
168
169
170
171
	$hrn = $credential->hrn();
	if (defined($credential->extensions()) &&
	    exists($credential->extensions()->{'nickname'})) {
	    $nickname = $credential->extensions()->{'nickname'};
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
172
173
174
175
176
	# Store the credential
	return undef
	    if ($credential->Store() != 0);
    }
    else {
177
	# Create a cert pair, for this resource uuid. 
178
	$certificate = GeniCertificate->Create("sliver", $hrn, $TBOPS, $uuid);
179
180
	if (!defined($certificate)) {
	    print STDERR "Could not generate new certificate and UUID!\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
181
182
	    return undef;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
183
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
184
    my $slice_uuid     = $slice->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
185
186
187
188

    # Now tack on other stuff we need.
    push(@insert_data, "created=now()");
    push(@insert_data, "idx='$idx'");
189
190
191
    push(@insert_data, "hrn=" . DBQuoteSpecial($hrn));
    push(@insert_data, "nickname=" . DBQuoteSpecial($nickname))
	if (defined($nickname));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
192
    push(@insert_data, "uuid='$uuid'");
193
194
    push(@insert_data, "resource_uuid='$resource_uuid'");
    push(@insert_data, "resource_type='$resource_type'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
195
196
197
    push(@insert_data, "creator_uuid='$owner_uuid'");
    push(@insert_data, "slice_uuid='$slice_uuid'");

Leigh B. Stoller's avatar
Leigh B. Stoller committed
198
199
200
201
    # Only on the client side.
    push(@insert_data, "credential_idx=" . $credential->idx())
	if (defined($credential));
    # Only on the client side.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
202
    push(@insert_data, "component_uuid='" . $component->uuid() . "'")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
203
	if (defined($component));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
204

Leigh B. Stoller's avatar
Leigh B. Stoller committed
205
206
207
208
209
210
211
    if (defined($rspec)) {
	my $rspec_string = XMLout($rspec, RootName => "rspec");
	my $safe_rspec   = DBQuoteSpecial($rspec_string);

	push(@insert_data, "rspec_string=$safe_rspec");
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
212
    # Insert into DB.
213
214
215
    if (!DBQueryWarn("insert into geni_slivers set " .
		     join(",", @insert_data))) {
	$certificate->Delete();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
216
217
218
	return undef;
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
219
220
221
    my $sliver = GeniSliver->Lookup($idx);
    return undef
	if (!defined($sliver));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
222
223
224
    
    $sliver->{'CREDENTIAL'} = $credential
	if (defined($credential));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
225
226
227
    $sliver->{'COMPONENT'} = $component
	if (defined($component));
    $sliver->{'AGGREGATE'} = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
228
    $sliver->{'SLICE'}     = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
229
230

    return $sliver;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
231
232
233
234
235
}
# accessors
sub field($$) { return ((! ref($_[0])) ? -1 : $_[0]->{'SLIVER'}->{$_[1]}); }
sub idx($)		{ return field($_[0], "idx"); }
sub uuid($)		{ return field($_[0], "uuid"); }
236
237
sub hrn($)		{ return field($_[0], "hrn"); }
sub nickname($)		{ return field($_[0], "nickname"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
238
239
240
sub slice_uuid($)	{ return field($_[0], "slice_uuid"); }
sub creator_uuid($)	{ return field($_[0], "creator_uuid"); }
sub created($)		{ return field($_[0], "created"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
241
sub credential_idx($)	{ return field($_[0], "credential_idx"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
242
sub resource_uuid($)	{ return field($_[0], "resource_uuid"); }
243
sub resource_type($)	{ return field($_[0], "resource_type"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
244
245
246
sub component_uuid($)	{ return field($_[0], "component_uuid"); }
sub aggregate_uuid($)	{ return field($_[0], "aggregate_uuid"); }
sub rspec_string($)     { return field($_[0], "rspec_string"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
247
sub status($)		{ return field($_[0], "status"); }
248
249
sub cert($)		{ return $_[0]->{'CERTIFICATE'}->cert(); }
sub GetCertificate($)   { return $_[0]->{'CERTIFICATE'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
250
sub rspec($)            { return $_[0]->{'RSPEC'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
251
252
253
254
255
256
257
258
259
260
261

#
# Delete the sliver. The sliver should not be provisioned when this done.
#
sub Delete($)
{
    my ($self) = @_;

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

262
263
    my $idx  = $self->idx();
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
264

265
266
267
268
    DBQueryWarn("delete from geni_credentials where this_uuid='$uuid'")
	or return -1;
    DBQueryWarn("delete from geni_certificates where uuid='$uuid'")
	or return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
269
270
271
    DBQueryWarn("delete from geni_slivers where idx='$idx'")
	or return -1;
    
272
273
274
    # Delete from cache. 
    delete($slivers{$idx});
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
275
276
277
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
278
279
280
281
282
283
284
285
286
287
#
# Set the aggregate for a sliver.
#
sub SetAggregate($$)
{
    my ($self, $aggregate) = @_;

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
288
289
    my $idx      = $self->idx();
    my $agg_uuid = $aggregate->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
290
291
292

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
293
			 "  aggregate_uuid='$agg_uuid' ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
294
295
			 "where idx='$idx'"));
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
296
    $self->{'SLIVER'}->{'aggregate_uuid'} = $agg_uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
297
298
299
300
    $self->{'AGGREGATE'} = $aggregate;
    return 0;
}

301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#
# And clear the aggregate.
#
sub ClearAggregate($$)
{
    my ($self) = @_;

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

    my $idx      = $self->idx();

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
			 "  aggregate_uuid=NULL ".
			 "where idx='$idx'"));
    
    $self->{'SLIVER'}->{'aggregate_uuid'} = undef;
    $self->{'AGGREGATE'} = undef;
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
323
324
325
326
327
328
329
330
331
332
333
334
#
# Get the aggregate for a sliver.
#
sub GetAggregate($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return $self->{'AGGREGATE'} if (defined($self->{'AGGREGATE'}));
    return undef
Leigh B. Stoller's avatar
Leigh B. Stoller committed
335
	if (!defined($self->aggregate_uuid()));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
336

Leigh B. Stoller's avatar
Leigh B. Stoller committed
337
    my $aggregate = GeniAggregate->Lookup($self->aggregate_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
338
339
340
341
342
343
344
345
    if (!defined($aggregate)) {
	print STDERR "Could not get aggregate object associated with $self\n";
	return undef;
    }
    $self->{'AGGREGATE'} = $aggregate;
    return $aggregate;
}

346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
#
# Set the status for the sliver.
#
sub SetStatus($$)
{
    my ($self, $status) = @_;

    return undef
	if (! ref($self));

    my $idx = $self->idx();
    
    return -1
	if (!DBQueryWarn("update geni_slivers set ".
			 "  status='$status' ".
			 "where idx='$idx'"));
    
    $self->{'SLIVER'}->{'status'} = $status;
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
367
368
369
370
371
372
373
374
375
376
377
378
379
#
# Get the experiment for the slice this sliver belongs to.
#
sub GetExperiment($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return Experiment->Lookup($self->slice_uuid());
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
380
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
381
# Get the credential for the sliver.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
382
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
383
sub GetCredential($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
384
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
385
    my ($self, $user) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
386
387
388
389

    return undef
	if (! ref($self));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
390
391
    return $self->{'CREDENTIAL'} if (defined($self->{'CREDENTIAL'}));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
392
    my $credential = GeniCredential->Lookup($self, $user);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
393
394
    if (!defined($credential)) {
	print STDERR "Could not get credential object associated with $self\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
395
396
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    $self->{'CREDENTIAL'} = $credential;
    return $credential;
}

#
# Get the component for the sliver.
#
sub GetComponent($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return $self->{'COMPONENT'} if (defined($self->{'COMPONENT'}));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
413
    if (!defined($self->component_uuid())) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
414
415
416
	print STDERR "No component associated with $self\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
417
    my $component = GeniComponent->Lookup($self->component_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
418
419
420
421
422
423
    if (!defined($component)) {
	print STDERR "Could not get component object associated with $self\n";
	return undef;
    }
    $self->{'COMPONENT'} = $component;
    return $component;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
424
425
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
#
# Get the slice for the sliver.
#
sub GetSlice($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return $self->{'SLICE'} if (defined($self->{'SLICE'}));

    if (!defined($self->slice_uuid())) {
	print STDERR "No slice associated with $self\n";
	return undef;
    }
    my $slice = GeniSlice->Lookup($self->slice_uuid());
    if (!defined($slice)) {
	print STDERR "Could not get slice object associated with $self\n";
	return undef;
    }
    $self->{'SLICE'} = $slice;
    return $slice;
}

451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
#
# Look up a list of slivers for a locally instantiated slice. 
# Used by the CM.
#
sub SliceSlivers($$$)
{
    my ($class, $slice, $pref) = @_;

    my $slice_uuid = $slice->uuid();
    my @result = ();

    my $query_result =
	DBQueryWarn("select idx from geni_slivers ".
		    "where slice_uuid='$slice_uuid'");
    return -1
	if (!$query_result);

    while (my ($idx) = $query_result->fetchrow_array()) {
	my $sliver = GeniSliver->Lookup($idx);
	return -1
	    if (!defined($sliver));
	push(@result, $sliver);
    }
    @$pref = @result;
    return 0;
}

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
504
505
506
507
508
509
510
#
# Find slivers "dependent" on this sliver, as for interfaces on nodes.
#
sub DependentSlivers($$)
{
    my ($self, $pref) = @_;

    return -1
	if (! (ref($self) && ref($pref)));
    @$pref = ();

    my $idx = $self->idx();
    my $resource_uuid = $self->resource_uuid();

    my $query_result =
	DBQueryWarn("select idx from geni_slivers ".
		    "where idx!='$idx' and resource_uuid='$resource_uuid'");
    return -1
	if (!$query_result);

    my @result = ();
    while (my ($idx) = $query_result->fetchrow_array()) {
	my $sliver = GeniSliver->Lookup($idx);
	if (!defined($sliver)) {
	    print STDERR "Could not get sliver object for $idx\n";
	    return -1;
	}
	push(@result, $sliver);
    }
    @$pref = @result;
    return 0;
}

511
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
512
513
# Create a signed credential for this sliver, issued to the provided user.
# The credential will grant all permissions for now.
514
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
515
516
517
# Should we store these credentials in the DB, recording what we hand out?
#
sub NewCredential($$)
518
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
519
    my ($self, $owner) = @_;
520

Leigh B. Stoller's avatar
Leigh B. Stoller committed
521
522
    return undef
	if (! (ref($self) && ref($owner)));
523

Leigh B. Stoller's avatar
Leigh B. Stoller committed
524
525
526
527
528
    my $credential = GeniCredential->Create($self, $owner);
    if (!defined($credential)) {
	print STDERR "Could not create credential for $self, $owner\n";
	return undef;
    }
529
530
531
    if (defined($self->nickname())) {
	$credential->AddExtension("nickname", $self->nickname());
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
532
533
534
535
536
537
    if ($credential->Sign($self->GetCertificate()) != 0) {
	print STDERR "Could not sign credential for $self, $owner\n";
	return undef;
    }
    return $credential;
}
538

Leigh B. Stoller's avatar
Leigh B. Stoller committed
539
540
541
542
543
544
545
############################################################################
#
# The client side methods are in packages which inherit from above.
#
package GeniSliver::Client;
use vars qw(@ISA);
@ISA = "GeniSliver";
546

Leigh B. Stoller's avatar
Leigh B. Stoller committed
547
548
549
550
551
552
553
use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;
use GeniAggregate;
use libdb qw(TBDB_ALLOCSTATE_RES_INIT_DIRTY);
554

Leigh B. Stoller's avatar
Leigh B. Stoller committed
555
556
557
558
sub Create()
{
    my ($class, $slice, $user_uuid, $rspec, $credential, $component) = @_;

559
    return GeniSliver->Create($slice, $user_uuid, undef, undef,
560
			      "Client", undef, undef, $rspec, 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
561
			      $credential, $component);
562
563
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
#
# Client side method to contact the sliver component and start it.
#
sub Start($$)
{
    my ($self, $user) = @_;

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

    my $component = $self->GetComponent();
    return -1
	if (!defined($component));

    return -1
	if ($component->StartSliver($self, $user) != 0);

    return 0;
}

584
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
585
# Client side method to contact the sliver component and destroy it.
586
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
587
sub Destroy($$)
588
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
589
    my ($self, $user) = @_;
590

Leigh B. Stoller's avatar
Leigh B. Stoller committed
591
592
    return -1
	if (! ref($self));
593

Leigh B. Stoller's avatar
Leigh B. Stoller committed
594
595
596
597
598
599
600
601
602
603
604
605
    my $component = $self->GetComponent();
    return -1
	if (!defined($component));

    return -1
	if ($component->DestroySliver($self, $user) != 0);

    # Delete the local object from the DB.
    $self->Delete() == 0
	or return -1;

    return 0;
606
607
}

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
#
# On the client side, the aggregate points to the parent sliver when it
# contains multiple resources.
#
sub SetAggregate($$)
{
    my ($self, $parent) = @_;

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

    my $idx         = $self->idx();
    my $parent_uuid = $parent->uuid();

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
			 "  aggregate_uuid='$parent_uuid' ".
			 "where idx='$idx'"));

    return 0;
}
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
sub ClearAggregate($)
{
    my ($self) = @_;

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

    my $idx         = $self->idx();

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
			 "  aggregate_uuid=NULL ".
			 "where idx='$idx'"));
    return 0;
}
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
sub GetAggregate($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return undef
	if (!defined($self->aggregate_uuid()));

    my $parent = GeniSliver->Lookup($self->aggregate_uuid());
    if (!defined($parent)) {
	print STDERR "Could not get parent object associated with $self\n";
	return undef;
    }
    return $parent;
}

662
663
664
665
666
667
668
669
670
671
672
673
674
############################################################################
#
# The server side methods are in packages which inherit from above.
#
package GeniSliver::Node;
use vars qw(@ISA);
@ISA = "GeniSliver";

use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
675
use Experiment;
676
use GeniAggregate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
677
use XML::Simple;
678
679
use libdb qw(TBDB_ALLOCSTATE_RES_INIT_DIRTY);

Leigh B. Stoller's avatar
Leigh B. Stoller committed
680
sub Create($$$$$)
681
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
682
    my ($class, $slice, $user_uuid, $resource_uuid, $rspec) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
683
    my $virtualization_type = $rspec->{'virtualization_type'};
684
    my $uuid = $resource_uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
685
686
687
688

    my $experiment = $slice->GetExperiment();
    if (!defined($experiment)) {
	print STDERR "Could not map $slice to its experiment\n";
689
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
690
    }
691

Leigh B. Stoller's avatar
Leigh B. Stoller committed
692
693
694
695
696
697
698
699
    #
    # the node is already allocated to the sliver, but still need to enter
    # a virt_nodes entry, and possibly more virt table entries, so that the
    # node will boot properly, and is otherwise controllable.
    #
    my $node = Node->Lookup($resource_uuid);
    if (!defined($node)) {
	print STDERR "Could not map node $resource_uuid to its object\n";
700
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
701
    }
702
703
704
705
706
707
708
709
710
711
712
    if (! $node->isremotenode()) {
	my $reservation = $node->Reservation();
	if (!defined($reservation)) {
	    print STDERR "$node was already released from $slice\n";
	    return undef;
	}
	if (! $reservation->SameExperiment($experiment)) {
	    print STDERR "$node is reserved to another, not $reservation\n";
	    # Signal error so we can look at what happened.
	    return undef;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
713
    }
714
    my $hrn = "${PGENIDOMAIN}." . $node->node_id();
715
    my $nickname = $rspec->{'nickname'};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
716
717
718
719
720
721
    
    #
    # The resource UUID refers to the physical node, but the virtualization
    # type might require a vnode.
    # 
    if ($virtualization_type eq "emulab-vnode") {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
722
723
724
725
726
727
728
729
730
731
732
	my $vtype = "pcfake";

	if ($node->isplabphysnode()) {
	    if ($node->type() =~ /^(\w*)phys$/) {
		$vtype = $1;
	    }
	    else {
		print STDERR "Could not determine vtype for $node\n";
		return undef;
	    }
	}
733
	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
734
	#
735
	# Create a virtual node on the physnode. 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
736
737
738
	#
	my @vnodes;
	if (Node::CreateVnodes(\@vnodes,
739
740
			       {"pid"      => $experiment->pid(),
				"eid"      => $experiment->eid(),
Leigh B. Stoller's avatar
Leigh B. Stoller committed
741
				"count"    => 1,
742
				"vtype"    => "$vtype",
Leigh B. Stoller's avatar
Leigh B. Stoller committed
743
				"nodeid"   => $node->node_id(),
Leigh B. Stoller's avatar
Leigh B. Stoller committed
744
				"verbose"  => 0 }) < 0) {
745
	    print STDERR "Could not create new virtual node on $node\n";
746
	    return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
747
748
	}
	my $vnode = Node->Lookup($vnodes[0]);
749
	$uuid = $vnode->uuid();
750
	$hrn = "${PGENIDOMAIN}." . $vnode->node_id()
Leigh B. Stoller's avatar
Leigh B. Stoller committed
751
    }
752
    return GeniSliver->Create($slice, $user_uuid, $uuid, $resource_uuid,
753
			      "Node", $hrn, $nickname, $rspec);
754
755
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
756
757
#
# Provision a slice. We actually did this when the ticket was requested.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
758
# We fill in some virt table stuff so that tbswap will work.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
759
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
760
sub Provision($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
761
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
762
    my ($self, $extraargs) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
763
764
765
766
767
768
769

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

    #
    # the node is already allocated to the sliver, but still need to enter
    # a virt_nodes entry, and possibly more virt table entries, so that the
Leigh B. Stoller's avatar
Leigh B. Stoller committed
770
    # node will boot properly, and is otherwise controllable.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
771
772
773
774
775
776
    #
    my $experiment = Experiment->Lookup($self->slice_uuid());
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
777
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
778
    return 0
779
780
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
781
    if (!defined($node)) {
782
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
783
784
	return -1;
    }
785
    my $node_id     = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
786
787
    my $reservation = $node->Reservation();
    if (!defined($reservation)) {
788
	print STDERR "$node was already released from slice\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
789
790
	return -1;
    }
791
792
793
794
795
796
797
    if (! $reservation->SameExperiment($experiment)) {
	print STDERR "$node is reserved to another, not $reservation\n";
	# Signal error so we can look at what happened.
	return -1;
    }
    my $pid = $experiment->pid();
    my $eid = $experiment->eid();
798
	
799
800
801
802
    if ($experiment->InsertVirtNode($node) != 0) {
	print STDERR "Could not add virtnode entry for $node to $self\n";
	return -1;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
803

804
805
806
807
808
    if (exists($self->rspec()->{'tmcd_server'}) &&
	exists($self->rspec()->{'tmcd_nodeid'})) {
	my $tmcd_redirect =
	    $self->rspec()->{'tmcd_server'} . ":" .
	    $self->rspec()->{'tmcd_nodeid'};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
809

810
811
	if ($node->ModifyReservation({"tmcd_redirect" => $tmcd_redirect})){
	    return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
812
	}
813
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
814

815
816
817
818
819
820
821
822
823
824
825
826
827
    #
    # An emulab cluster node uses a vnode on the physnode, even for a
    # dedicated physical nodes. We need to tell tmcd about the pnode,
    # but not the vnode since it is going to redirect to tmcd on the
    # remote Emulab controlling the experiment.
    #
    if (!$node->isremotenode() &&
	exists($self->rspec()->{'virtualization_type'}) &&
	$self->rspec()->{'virtualization_type'} eq "emulab-vnode") {
	my $pnode = Node->Lookup($node->phys_nodeid());
	if (!defined($pnode)) {
	    print STDERR "Could not get pnode object for $node\n";
	    return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
828
	}
829
830
831
	    
	if ($experiment->InsertVirtNode($pnode) != 0) {
	    print STDERR "Could not add virtnode entry for $pnode to $self\n";
832
833
	    return -1;
	}
834
	$pnode->ModifyReservation({"genisliver_idx" => $self->idx()});
835

836
837
	# Set it to boot the default OS.
	if ($pnode->SelectOS() != 0) {
838
839
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
840
841
    }
    else {
842
843
844
845
846
847
848
849
	#
	# For a "raw" node, there is no vnode, so this is the pnode
	# we need to mark for tmcd.
	#
	if ($node->ModifyReservation({"genisliver_idx" => $self->idx()})) {
	    return -1;
	}
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
850
851
852
853
854
855
856
857
858
859
860
861
862
863
    return 0;
}

#
# Unprovision a sliver. 
#
sub UnProvision($)
{
    my ($self) = @_;

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

    my $experiment = Experiment->Lookup($self->slice_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
864
865
866
867
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
868
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
869
    return 0
870
871
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
872
    if (!defined($node)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
873
	# Lets call this nonfatal since it might be a virtnode that 
874
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
875
	return 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
876
877
878
879
880
881
882
    }
    my $reservation = $node->Reservation();
    if (!defined($reservation)) {
	print STDERR "$node was already released from $self\n";
	return 0;
    }
    if ($reservation->SameExperiment($experiment)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
883
	my $node_id = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
884
885
	my $pid = $experiment->pid();
	my $eid = $experiment->eid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
886

887
	if ($node->isremotenode()) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
888
	    system("$VNODESETUP -p -q -m -k $pid $eid $node_id");
889
	    if ($?) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
890
		print STDERR "$VNODESETUP failed\n";
891
892
893
894
		return -1;
	    }
	}

895
896
897
898
	if ($experiment->DeleteVirtNode($node) != 0) {
	    print STDERR "Could remove virtnode entry for $node from $self\n";
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
899

900
901
	if (!$node->isremotenode() &&
	    $self->rspec()->{'virtualization_type'} eq "emulab-vnode") {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
902
903
904
905
906
907
908
909
910
911
912
	    my $pnode_id = $node->phys_nodeid();
	    my $pnode = Node->Lookup($pnode_id);
	    if (!defined($pnode)) {
		print STDERR "Could not get pnode object for $pnode_id\n";
		return -1;
	    }
	    if ($experiment->DeleteVirtNode($pnode) != 0) {
		print STDERR
		    "Could remove virtnode entry for $pnode from $self\n";
		return -1;
	    }
913
	    system("$NFREE -x -q $pid $eid $pnode_id");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
914
915
	}
	else {
916
	    system("$NFREE -q $pid $eid $node_id");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
917
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
918
919
	if ($?) {
	    print STDERR "Could not deallocate $node from $self\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
920
	    $node->Refresh();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
921
922
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
923
	$node->Refresh();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
924
925
926
927
928
929
930
931
932
933
    }
    else {
	print STDERR "$node is reserved to another, not $self\n";
	# Signal error so we can look at what happened.
	return -1;
    }
    return 0;
}

#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
934
# Start a sliver, which means what?
Leigh B. Stoller's avatar
Leigh B. Stoller committed
935
#
936
sub Start($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
937
938
939
940
941
942
943
944
945
946
947
{
    my ($self) = @_;

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

    my $experiment = Experiment->Lookup($self->slice_uuid());
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
948
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
949
    return 0
950
951
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
952
    if (!defined($node)) {
953
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
954
955
956
957
958
959
960
961
	return -1;
    }
    my $reservation = $node->Reservation();
    if (!defined($reservation)) {
	print STDERR "$node was already released from $self\n";
	return -1;
    }
    if ($reservation->SameExperiment($experiment)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
962
	my $node_id = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
963

964
965
966
	# XXX Need to fix up this status stuff.
	if ($node->isremotenode() && $self->status() eq "created") {
	    $self->SetStatus("ready");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
967
	    goto done;
968
969
	}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
970
971
972
973
974
975
976
	#
	# Reboot pnode if not already running. 
	#
	if ($self->rspec()->{'virtualization_type'} eq "emulab-vnode" &&
	    $self->status() eq "created") {
	    $node_id = $node->phys_nodeid();
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
977
978
979
	#
	# Reboot and wait?
	#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
980
981
982
983
984
	system("$NODEREBOOT -s $node_id");
	$self->SetStatus("ready")
	    if (!$?);
	return -1
	    if ($?);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
985
986
987
988
989
    }
    else {
	print STDERR "$node is reserved to another, not $self\n";
	# Signal error so we can look at what happened.
	return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
990
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
991
  done:
Leigh B. Stoller's avatar
Leigh B. Stoller committed
992
993
    return 0;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
994

995
##########################################################################
996
#
997
998
999
1000
1001
1002
1003
1004
1005
1006
package GeniSliver::Interface;
use vars qw(@ISA);
@ISA = "GeniSliver";

use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;
use GeniAggregate;
1007
1008
1009
use Interface;
use Experiment;
use Node;
1010
1011
1012

sub Create()
{
1013
    my ($class, $slice, $user_uuid,
1014
1015
1016
	$interface_uuid, $node, $rspec) = @_;

    my $nickname = $rspec->{'nickname'};
1017
1018
    my $hrn = "${PGENIDOMAIN}." .
	$node->node_id() . "." . $rspec->{'iface_name'};
1019

1020
    return GeniSliver->Create($slice, $user_uuid, $interface_uuid,
1021
1022
			      $node->uuid(), "Interface",
			      $hrn, $nickname, $rspec);
1023
1024
1025
1026
1027
1028
}

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

1029
1030
1031
1032
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1033
1034
1035
1036
1037
1038
1039
    return -1
	if (! ref($self));

    return 0;
}

#
1040
# Unprovision a single interface from a link/lan. 
1041
1042
1043
1044
1045
1046
1047
1048
#
sub UnProvision($)
{
    my ($self) = @_;

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

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
    my $aggregate = $self->GetAggregate();
    if (!defined($aggregate)) {
	print STDERR "Could not find aggregate for $self\n";
	return -1;
    }

    #
    # This is terrible; we need an interface to remove ports form vlans,
    # so that we do not have to tear down the entire vlan and recreate.
    #
    if ($aggregate->UnProvision() != 0) {
	print STDERR "Could not unprovision $aggregate\n";
	return -1;
    }
    $self->ClearAggregate();
    if ($aggregate->Provision() != 0) {
	print STDERR "Could not provision $aggregate\n";
	return -1;
    }
1068
1069
1070
1071
    return 0;
}

#
1072
# Start a sliver.
1073
#
1074
sub Start($)
1075
1076
1077
{
    my ($self) = @_;

1078
1079
1080
1081
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1082
1083
1084
1085
1086
    return -1
	if (! ref($self));

    return 0;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1087

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1088
1089
# _Always_ make sure that this 1 is at the end of the file...
1;