GeniSliver.pm.in 26.5 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;
25
use GeniUsage;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
26
# Hate to import all this crap; need a utility library.
27
use libdb qw(TBGetUniqueIndex);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
28
use libtestbed;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
29
30
use Experiment;
use Node;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
31
use English;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
32
use XML::Simple;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
33
34
use Data::Dumper;
use File::Temp qw(tempfile);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
35
use overload ('""' => 'Stringify');
Leigh B. Stoller's avatar
Leigh B. Stoller committed
36
37
38
39
40
41
42
43

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

# 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
65
    my $idx;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
66
67

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

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

    # 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
90
91
92
    return undef
	if (!$query_result || !$query_result->numrows);

Leigh B. Stoller's avatar
Leigh B. Stoller committed
93
94
    my $self              = {};
    $self->{'SLIVER'}     = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
95
96
97
98
99
100
101
102
103
104
105
    $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"]);
    }
106
107
108
109
110
111
112
113
114
115
116

    #
    # 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;
117
118
119
120

    # Bless into sub package if called for.
    my $resource_type = $self->{'SLIVER'}->{'resource_type'};
    if (defined($resource_type) && $resource_type ne "") {
121
	bless($self, $class . "::" . $resource_type);
122
123
124
125
    }
    else {
	bless($self, $class);
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
    
    # 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
147
# Create a sliver record in the DB. On the client side we save the credential
Leigh B. Stoller's avatar
Leigh B. Stoller committed
148
# that allows control of it, for later operations.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
149
#
150
sub Create($$$$$$$$;$$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
151
{
152
    my ($class, $slice, $owner, $uuid, $resource_uuid, $resource_type,
153
	$hrn, $nickname,
Leigh B. Stoller's avatar
Leigh B. Stoller committed
154
	$rspec, $credential, $component) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
155
    my @insert_data = ();
156
    my $certificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
157
158
159

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

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
200
201
202
203
    # 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
204
    push(@insert_data, "component_uuid='" . $component->uuid() . "'")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
205
	if (defined($component));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
206

Leigh B. Stoller's avatar
Leigh B. Stoller committed
207
208
209
210
211
212
213
    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
214
    # Insert into DB.
215
216
217
    if (!DBQueryWarn("insert into geni_slivers set " .
		     join(",", @insert_data))) {
	$certificate->Delete();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
218
219
220
	return undef;
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
221
222
223
    my $sliver = GeniSliver->Lookup($idx);
    return undef
	if (!defined($sliver));
224
225
226
227
228

    if (GeniUsage->NewSliver($sliver, $slice, $owner)) {
	print STDERR
	    "GeniSliver::Create: GeniUsage->NewSliver($sliver) failed\n";
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
229
230
231
    
    $sliver->{'CREDENTIAL'} = $credential
	if (defined($credential));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
232
233
234
    $sliver->{'COMPONENT'} = $component
	if (defined($component));
    $sliver->{'AGGREGATE'} = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
235
    $sliver->{'SLICE'}     = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
236
237

    return $sliver;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
238
239
240
241
242
}
# accessors
sub field($$) { return ((! ref($_[0])) ? -1 : $_[0]->{'SLIVER'}->{$_[1]}); }
sub idx($)		{ return field($_[0], "idx"); }
sub uuid($)		{ return field($_[0], "uuid"); }
243
244
sub hrn($)		{ return field($_[0], "hrn"); }
sub nickname($)		{ return field($_[0], "nickname"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
245
246
247
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
248
sub credential_idx($)	{ return field($_[0], "credential_idx"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
249
sub resource_uuid($)	{ return field($_[0], "resource_uuid"); }
250
sub resource_type($)	{ return field($_[0], "resource_type"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
251
252
253
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
254
sub status($)		{ return field($_[0], "status"); }
255
256
sub cert($)		{ return $_[0]->{'CERTIFICATE'}->cert(); }
sub GetCertificate($)   { return $_[0]->{'CERTIFICATE'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
257
sub rspec($)            { return $_[0]->{'RSPEC'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
258
259
260
261

#
# Delete the sliver. The sliver should not be provisioned when this done.
#
262
sub Delete($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
263
{
264
    my ($self, $purge) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
265
266
267
268

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

269
270
    my $idx  = $self->idx();
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
271

272
273
274
275
    if (GeniUsage->DestroySliver($self, $purge)) {
	print STDERR
	    "GeniSliver::Delete: GeniUsage->DestroySliver($self) failed\n";
    }
276
277
278
279
    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
280
281
    DBQueryWarn("delete from geni_slivers where idx='$idx'")
	or return -1;
282

283
284
285
    # Delete from cache. 
    delete($slivers{$idx});
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
286
287
288
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
289
290
291
292
293
294
295
296
297
298
#
# 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
299
300
    my $idx      = $self->idx();
    my $agg_uuid = $aggregate->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
301
302
303

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
304
			 "  aggregate_uuid='$agg_uuid' ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
305
306
			 "where idx='$idx'"));
    
307
308
309
310
311
312
313
    if (!DBQueryWarn("update sliver_history set ".
		     "  aggregate_uuid='$agg_uuid' ".
		     "where idx='$idx'")) {
	print STDERR "GeniSliver::SetAggregate: ".
	    "Failed to update sliver_history for $self\n";
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
314
    $self->{'SLIVER'}->{'aggregate_uuid'} = $agg_uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
315
316
317
318
    $self->{'AGGREGATE'} = $aggregate;
    return 0;
}

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
#
# 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
341
342
343
344
345
346
347
348
349
350
351
352
#
# 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
353
	if (!defined($self->aggregate_uuid()));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
354

Leigh B. Stoller's avatar
Leigh B. Stoller committed
355
    my $aggregate = GeniAggregate->Lookup($self->aggregate_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
356
357
358
359
360
361
362
363
    if (!defined($aggregate)) {
	print STDERR "Could not get aggregate object associated with $self\n";
	return undef;
    }
    $self->{'AGGREGATE'} = $aggregate;
    return $aggregate;
}

364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
#
# 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
385
386
387
388
389
390
391
392
393
394
395
396
397
#
# 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
398
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
399
# Get the credential for the sliver.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
400
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
401
sub GetCredential($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
402
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
403
    my ($self, $user) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
404
405
406
407

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

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
410
    my $credential = GeniCredential->Lookup($self, $user);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
411
412
    if (!defined($credential)) {
	print STDERR "Could not get credential object associated with $self\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
413
414
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    $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
431
    if (!defined($self->component_uuid())) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
432
433
434
	print STDERR "No component associated with $self\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
435
    my $component = GeniComponent->Lookup($self->component_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
436
437
438
439
440
441
    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
442
443
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
#
# 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;
}

469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
#
# 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;
}

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
#
# 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;
}

529
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
530
531
# Create a signed credential for this sliver, issued to the provided user.
# The credential will grant all permissions for now.
532
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
533
534
535
# Should we store these credentials in the DB, recording what we hand out?
#
sub NewCredential($$)
536
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
537
    my ($self, $owner) = @_;
538

Leigh B. Stoller's avatar
Leigh B. Stoller committed
539
540
    return undef
	if (! (ref($self) && ref($owner)));
541

Leigh B. Stoller's avatar
Leigh B. Stoller committed
542
543
544
545
546
    my $credential = GeniCredential->Create($self, $owner);
    if (!defined($credential)) {
	print STDERR "Could not create credential for $self, $owner\n";
	return undef;
    }
547
548
549
    if (defined($self->nickname())) {
	$credential->AddExtension("nickname", $self->nickname());
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
550
551
552
553
554
555
    if ($credential->Sign($self->GetCertificate()) != 0) {
	print STDERR "Could not sign credential for $self, $owner\n";
	return undef;
    }
    return $credential;
}
556

Leigh B. Stoller's avatar
Leigh B. Stoller committed
557
558
559
560
561
562
563
############################################################################
#
# The client side methods are in packages which inherit from above.
#
package GeniSliver::Client;
use vars qw(@ISA);
@ISA = "GeniSliver";
564

Leigh B. Stoller's avatar
Leigh B. Stoller committed
565
566
567
568
569
570
571
use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;
use GeniAggregate;
use libdb qw(TBDB_ALLOCSTATE_RES_INIT_DIRTY);
572

Leigh B. Stoller's avatar
Leigh B. Stoller committed
573
574
sub Create()
{
575
    my ($class, $slice, $user, $rspec, $credential, $component) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
576

577
    return GeniSliver->Create($slice, $user, undef, undef,
578
			      "Client", undef, undef, $rspec, 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
579
			      $credential, $component);
580
581
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
#
# 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;
}

602
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
603
# Client side method to contact the sliver component and destroy it.
604
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
605
sub Destroy($$)
606
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
607
    my ($self, $user) = @_;
608

Leigh B. Stoller's avatar
Leigh B. Stoller committed
609
610
    return -1
	if (! ref($self));
611

Leigh B. Stoller's avatar
Leigh B. Stoller committed
612
613
614
615
616
617
618
619
    my $component = $self->GetComponent();
    return -1
	if (!defined($component));

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

    # Delete the local object from the DB.
620
    $self->Delete(1) == 0
Leigh B. Stoller's avatar
Leigh B. Stoller committed
621
622
623
	or return -1;

    return 0;
624
625
}

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
#
# 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;
}
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
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;
}
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
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;
}

680
681
682
683
684
685
686
687
688
689
690
691
692
############################################################################
#
# 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
693
use Experiment;
694
use GeniAggregate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
695
use XML::Simple;
696
697
use libdb qw(TBDB_ALLOCSTATE_RES_INIT_DIRTY);

Leigh B. Stoller's avatar
Leigh B. Stoller committed
698
sub Create($$$$$)
699
{
700
    my ($class, $slice, $user, $resource_uuid, $rspec) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
701
    my $virtualization_type = $rspec->{'virtualization_type'};
702
    my $uuid = $resource_uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
703
704
705
706

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
710
711
712
713
714
715
716
717
    #
    # 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";
718
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
719
    }
720
721
722
723
724
725
726
727
728
729
730
    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
731
    }
732
    my $hrn = "${PGENIDOMAIN}." . $node->node_id();
733
    my $nickname = $rspec->{'nickname'};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
734
735
736
737
738
739
    
    #
    # 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
740
741
742
743
744
745
746
747
748
749
750
	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;
	    }
	}
751
	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
752
	#
753
	# Create a virtual node on the physnode. 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
754
755
756
	#
	my @vnodes;
	if (Node::CreateVnodes(\@vnodes,
757
758
			       {"pid"      => $experiment->pid(),
				"eid"      => $experiment->eid(),
Leigh B. Stoller's avatar
Leigh B. Stoller committed
759
				"count"    => 1,
760
				"vtype"    => "$vtype",
Leigh B. Stoller's avatar
Leigh B. Stoller committed
761
				"nodeid"   => $node->node_id(),
Leigh B. Stoller's avatar
Leigh B. Stoller committed
762
				"verbose"  => 0 }) < 0) {
763
	    print STDERR "Could not create new virtual node on $node\n";
764
	    return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
765
766
	}
	my $vnode = Node->Lookup($vnodes[0]);
767
	$uuid = $vnode->uuid();
768
	$hrn = "${PGENIDOMAIN}." . $vnode->node_id()
Leigh B. Stoller's avatar
Leigh B. Stoller committed
769
    }
770
    return GeniSliver->Create($slice, $user, $uuid, $resource_uuid,
771
			      "Node", $hrn, $nickname, $rspec);
772
773
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
774
775
#
# Provision a slice. We actually did this when the ticket was requested.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
776
# We fill in some virt table stuff so that tbswap will work.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
777
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
778
sub Provision($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
779
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
780
    my ($self, $extraargs) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
781
782
783
784
785
786
787

    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
788
    # node will boot properly, and is otherwise controllable.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
789
790
791
792
793
794
    #
    my $experiment = Experiment->Lookup($self->slice_uuid());
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
795
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
796
    return 0
797
798
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
799
    if (!defined($node)) {
800
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
801
802
	return -1;
    }
803
    my $node_id     = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
804
805
    my $reservation = $node->Reservation();
    if (!defined($reservation)) {
806
	print STDERR "$node was already released from slice\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
807
808
	return -1;
    }
809
810
811
812
813
814
815
    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();
816
	
817
818
819
820
    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
821

822
    my $redirected = 0;
823
824
825
826
827
    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
828

829
830
	if ($node->ModifyReservation({"tmcd_redirect" => $tmcd_redirect})){
	    return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
831
	}
832
	$redirected = 1;
833
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
834

835
836
837
838
839
840
841
842
843
844
845
846
847
    #
    # 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
848
	}
849
850
851
	    
	if ($experiment->InsertVirtNode($pnode) != 0) {
	    print STDERR "Could not add virtnode entry for $pnode to $self\n";
852
853
	    return -1;
	}
854
	$pnode->ModifyReservation({"genisliver_idx" => $self->idx()});
855

856
857
858
859
	# Not redirected. Use local tmcd anyway.
	$node->ModifyReservation({"genisliver_idx" => $self->idx()})
	    if (!$redirected);

860
861
	# Set it to boot the default OS.
	if ($pnode->SelectOS() != 0) {
862
863
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
864
865
    }
    else {
866
867
868
869
870
871
872
873
	#
	# 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
874
875
876
877
878
879
880
881
882
883
884
885
886
887
    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
888
889
890
891
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
892
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
893
    return 0
894
895
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
896
    if (!defined($node)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
897
	# Lets call this nonfatal since it might be a virtnode that 
898
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
899
	return 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
900
901
902
903
904
905
906
    }
    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
907
	my $node_id = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
908
909
	my $pid = $experiment->pid();
	my $eid = $experiment->eid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
910

911
	if ($node->isremotenode()) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
912
	    system("$VNODESETUP -p -q -m -k $pid $eid $node_id");
913
	    if ($?) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
914
		print STDERR "$VNODESETUP failed\n";
915
916
917
918
		return -1;
	    }
	}

919
920
921
922
	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
923

924
925
	if (!$node->isremotenode() &&
	    $self->rspec()->{'virtualization_type'} eq "emulab-vnode") {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
926
927
928
929
930
931
932
933
934
935
936
	    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;
	    }
937
	    system("$NFREE -x -q $pid $eid $pnode_id");
938
	    $pnode->Refresh();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
939
940
	}
	else {
941
	    system("$NFREE -q $pid $eid $node_id");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
942
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
943
944
	if ($?) {
	    print STDERR "Could not deallocate $node from $self\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
945
	    $node->Refresh();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
946
947
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
948
	$node->Refresh();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
949
950
951
952
953
954
955
956
957
958
    }
    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
959
# Start a sliver, which means what?
Leigh B. Stoller's avatar
Leigh B. Stoller committed
960
#
961
sub Start($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
962
963
964
965
966
967
968
969
970
971
972
{
    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;
    }
973
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
974
    return 0
975
976
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
977
    if (!defined($node)) {
978
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
979
980
981
982
983
984
985
986
	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
987
	my $node_id = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
988

989
990
991
	# 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
992
	    goto done;
993
994
	}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
995
996
997
998
999
1000
1001
	#
	# 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
1002
1003
1004
	#
	# Reboot and wait?
	#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1005
1006
1007
1008
1009
	system("$NODEREBOOT -s $node_id");
	$self->SetStatus("ready")
	    if (!$?);
	return -1
	    if ($?);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1010
1011
1012
1013
1014
    }
    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
1015
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1016
  done:
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1017
1018
    return 0;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1019

1020
##########################################################################
1021
#
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
package GeniSliver::Interface;
use vars qw(@ISA);
@ISA = "GeniSliver";

use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;
use GeniAggregate;
1032
1033
1034
use Interface;
use Experiment;
use Node;
1035
1036
1037

sub Create()
{
1038
    my ($class, $slice, $user,
1039
1040
1041
	$interface_uuid, $node, $rspec) = @_;

    my $nickname = $rspec->{'nickname'};
1042
1043
    my $hrn = "${PGENIDOMAIN}." .
	$node->node_id() . "." . $rspec->{'iface_name'};
1044

1045
    return GeniSliver->Create($slice, $user, $interface_uuid,
1046
1047
			      $node->uuid(), "Interface",
			      $hrn, $nickname, $rspec);
1048
1049
1050
1051
1052
1053
}

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

1054
1055
1056
1057
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1058
1059
1060
1061
1062
1063
1064
    return -1
	if (! ref($self));

    return 0;
}

#
1065
# Unprovision a single interface from a link/lan. 
1066
1067
1068
1069
1070
1071
1072
1073
#
sub UnProvision($)
{
    my ($self) = @_;

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

1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
    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;
    }
1093
1094
1095
1096
    return 0;
}

#
1097
# Start a sliver.
1098
#
1099
sub Start($)
1100
1101
1102
{
    my ($self) = @_;

1103
1104
1105
1106
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1107
1108
1109
1110
1111
    return -1
	if (! ref($self));

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

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