GeniSliver.pm.in 26.6 KB
Newer Older
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1
2
#!/usr/bin/perl -wT
#
3
# GENIPUBLIC-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
# All rights reserved.
#
package GeniSliver;

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

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

use GeniDB;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
18
use GeniComponent;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
19
use GeniSlice;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
20
use GeniCredential;
21
use GeniCertificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
22
use GeniAggregate;
23
use GeniUsage;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
24
# Hate to import all this crap; need a utility library.
25
use emutil qw(TBGetUniqueIndex);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
26
use Experiment;
27
use OSinfo;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
28
use English;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
29
use XML::Simple;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30
31
use Data::Dumper;
use File::Temp qw(tempfile);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
32
use overload ('""' => 'Stringify');
Leigh B. Stoller's avatar
Leigh B. Stoller committed
33
34
35
36
37
38
39
40

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

# Cache of instances to avoid regenerating them.
my %slivers      = ();
54
BEGIN { use GeniUtil; GeniUtil::AddCache(\%slivers); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
55
56
57
58
59
60
61
62

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

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

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

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

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

    #
    # 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;
115
116
117
118

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

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

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

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

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

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

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

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

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

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

    return -1
	if (!DBQueryWarn("update geni_slivers set ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
302
			 "  aggregate_uuid='$agg_uuid' ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
303
304
			 "where idx='$idx'"));
    
305
306
307
308
309
310
311
    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
312
    $self->{'SLIVER'}->{'aggregate_uuid'} = $agg_uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
313
314
315
316
    $self->{'AGGREGATE'} = $aggregate;
    return 0;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
606
607
    return -1
	if (! ref($self));
608

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

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

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

    return 0;
621
622
}

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

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

695
sub Create($$$$$$)
696
{
697
    my ($class, $slice, $user, $resource_uuid, $sliver_uuid, $rspec) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
698
699
700
701
702
    my $virtualization_type = $rspec->{'virtualization_type'};

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
706
707
708
709
710
711
712
713
    #
    # 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";
714
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
715
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
716
    if (! ($node->isremotenode() || $node->sharing_mode())) {
717
718
719
720
721
722
	my $reservation = $node->Reservation();
	if (!defined($reservation)) {
	    print STDERR "$node was already released from $slice\n";
	    return undef;
	}
	if (! $reservation->SameExperiment($experiment)) {
723
	    print STDERR "$node is reserved to another, not $experiment\n";
724
725
726
	    # Signal error so we can look at what happened.
	    return undef;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
727
    }
728
    my $hrn = "${PGENIDOMAIN}." . $node->node_id();
729
    my $nickname = $rspec->{'virtual_id'};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
730
    $sliver_uuid = $node->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
731
732
733
734
735
736
    
    #
    # 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
737
738
739
	my $vnode = $experiment->VnameToNode($nickname);
	if (!defined($vnode)) {
	    print STDERR "Could not lookup node $nickname in $experiment\n";
740
	    return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
741
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
742
743
	$hrn = "${PGENIDOMAIN}." . $vnode->node_id();
	$sliver_uuid = $vnode->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
744
    }
745
    return GeniSliver->Create($slice, $user, $sliver_uuid, $resource_uuid,
746
			      "Node", $hrn, $nickname, $rspec);
747
748
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
749
750
#
# Provision a slice. We actually did this when the ticket was requested.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
751
# We fill in some virt table stuff so that tbswap will work.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
752
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
753
sub Provision($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
754
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
755
    my ($self, $extraargs) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
756
757
758
759
760
761
762

    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
763
    # node will boot properly, and is otherwise controllable.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
764
765
766
767
768
769
    #
    my $experiment = Experiment->Lookup($self->slice_uuid());
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
770
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
771
    return 0
772
773
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
774
    if (!defined($node)) {
775
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
776
777
	return -1;
    }
778
    my $node_id     = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
779
780
    my $reservation = $node->Reservation();
    if (!defined($reservation)) {
781
	print STDERR "$node was already released from slice\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
782
783
	return -1;
    }
784
    if (! $reservation->SameExperiment($experiment)) {
785
	print STDERR "$node is reserved to another, not $experiment\n";
786
787
788
789
790
	# Signal error so we can look at what happened.
	return -1;
    }
    my $pid = $experiment->pid();
    my $eid = $experiment->eid();
791

792
    my $redirected = 0;
793
794
795
796
797
    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
798

799
800
	if ($node->ModifyReservation({"tmcd_redirect" => $tmcd_redirect})){
	    return -1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
801
	}
802
	$redirected = 1;
803
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
804

805
806
807
808
809
810
811
812
813
814
815
816
817
    #
    # 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
818
	}
819

820
821
822
823
	# Not redirected. Use local tmcd anyway.
	$node->ModifyReservation({"genisliver_idx" => $self->idx()})
	    if (!$redirected);

Leigh B. Stoller's avatar
Leigh B. Stoller committed
824
825
826
827
828
829
	if (exists($self->rspec()->{'virtualization_subtype'})) {
	    my $subtype = $self->rspec()->{'virtualization_subtype'};
	    
	    if (!$pnode->sharing_mode()) {
		$pnode->ModifyReservation({"genisliver_idx" => $self->idx()});
	    }
830
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
831
832
    }
    else {
833
834
835
836
837
838
839
840
	#
	# 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;
	}
    }
841
842
843
    # See below; remote nodes are currently assumed to be running.
    $self->SetStatus("ready")
	if (!$node->isremotenode());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
844
845
846
847
848
849
    return 0;
}

#
# Unprovision a sliver. 
#
850
sub UnProvision($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
851
{
852
    my ($self, $nophysfree) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
853
854
855

    return -1
	if (! ref($self));
856
857
    $nophysfree = 0
	if (!defined($nophysfree));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
858
859

    my $experiment = Experiment->Lookup($self->slice_uuid());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
860
861
862
863
    if (!defined($experiment)) {
	print STDERR "Could not map $self to its experiment\n";
	return -1;
    }
864
    my $uuid = $self->uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
865
    return 0
866
867
	if (!defined($uuid));
    my $node       = Node->Lookup($uuid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
868
    if (!defined($node)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
869
	# Lets call this nonfatal since it might be a virtnode that 
870
	print STDERR "Could not map node $uuid to its object\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
871
	return 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
872
873
874
875
876
877
878
    }
    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
879
	my $node_id = $node->node_id();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
880
881
	my $pid = $experiment->pid();
	my $eid = $experiment->eid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
882

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

898
899
	if (!$node->isremotenode() &&
	    $self->rspec()->{'virtualization_type'} eq "emulab-vnode") {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
900
901
902
903
904
905
	    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;
	    }
906
907
908

	    #
	    # If this is the last virtnode on the physnode, release the
Leigh B. Stoller's avatar
Leigh B. Stoller committed
909
910
	    # physnode too. Unless its a shared host, in which case just
	    # deallocate the virtnode.
911
	    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
912
913
914
915
916
917
	    my @vnodes = ();
	    
	    if ($pnode->sharing_mode()) {
		$nophysfree = 1;
	    }
	    elsif ($pnode->VirtualNodes(\@vnodes) != 0) {
918
		print STDERR "Could not get vnode list for $pnode\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
919
920
		return -1;
	    }
921

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

985
986
987
	# 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
988
	    goto done;
989
990
	}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
991
992
993
	#
	# Reboot and wait?
	#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
994
995
996
997
998
999
1000
1001
	if ($node->isvirtnode() && $node->sharing_mode()) {
	    if ($node->eventstate() eq TBDB_NODESTATE_SHUTDOWN()) {
		system("$VNODESETUP -j -q -m $pid $eid $node_id");
	    }
	}
	else {
	    system("$NODEREBOOT -s $node_id");
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1002
1003
	return -1
	    if ($?);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1004
1005
1006
1007
1008
    }
    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
1009
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1010
  done:
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1011
1012
    return 0;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1013

1014
##########################################################################
1015
#
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
package GeniSliver::Interface;
use vars qw(@ISA);
@ISA = "GeniSliver";

use GeniDB;
use GeniComponent;
use GeniSlice;
use GeniCredential;
use GeniCertificate;

sub Create()
{
1028
    my ($class, $slice, $user,
1029
	$interface_uuid, $node, $linkname, $rspec) = @_;
1030

1031
1032
1033
    my $nickname = $node->node_id() . ".$linkname." .
	$rspec->{'virtual_interface_id'};
    my $hrn = "${PGENIDOMAIN}.$nickname";
1034

1035
    return GeniSliver->Create($slice, $user, $interface_uuid,
1036
1037
			      $node->uuid(), "Interface",
			      $hrn, $nickname, $rspec);
1038
1039
1040
1041
1042
1043
}

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

1044
1045
1046
1047
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1048
1049
1050
1051
1052
1053
1054
    return -1
	if (! ref($self));

    return 0;
}

#
1055
# Unprovision a single interface from a link/lan. 
1056
1057
1058
1059
1060
1061
1062
1063
#
sub UnProvision($)
{
    my ($self) = @_;

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

1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
    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;
    }
1083
1084
1085
1086
    return 0;
}

#
1087
# Start a sliver.
1088
#
1089
sub Start($)
1090
1091
1092
{
    my ($self) = @_;

1093
1094
1095
1096
    #
    # This is actually implemented in GeniAggregate since currently "link"
    # is the smallest entity; you cannot operate on an individual interface.
    #
1097
1098
1099
1100
1101
    return -1
	if (! ref($self));

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

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