Experiment.pm.in 147 KB
Newer Older
1
2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2005-2014 University of Utah and the Flux Group.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23
24
25
26
27
#
package Experiment;

use strict;
use Exporter;
28
use SelfLoader ();
29
use vars qw(@ISA @EXPORT $AUTOLOAD);
30
@ISA    = qw(Exporter SelfLoader);
31
32
33
@EXPORT = qw ( );

use libdb;
34
use EmulabConstants;
35
use libtestbed;
36
use Socket;
37
use Node;
Leigh B Stoller's avatar
Leigh B Stoller committed
38
use emutil;
39
use Logfile;
40
41
use English;
use Data::Dumper;
42
use File::Basename;
43
use overload ('""' => 'Stringify');
44
use libtblog_simple;
45

46
use vars qw($EXPT_PRELOAD $EXPT_START $EXPT_SWAPIN $EXPT_SWAPUPDATE
47
	    $EXPT_SWAPOUT $EXPT_SWAPMOD %physicalTables @virtualTables
48
	    $EXPT_FLAGS_NAMESONLY $EXPT_FLAGS_INCLUDEVIRT
49
	    $EXPT_FLAGS_LOCALONLY $EXPT_FLAGS_FIXRESOURCES
50
	    $EXPT_GENIFLAGS_EXPT $EXPT_GENIFLAGS_COOKED
51
	    @nodetable_fields %experiments
52
	    $EXPT_STARTCLOCK $EXPT_RESOURCESHOSED 
53
54
55
	    @EXPORT_OK
	    $TB $BOSSNODE $CONTROL $TBOPS $PROJROOT $STAMPS $TBBASE  
	    $TEVC $DBCONTROL $RSYNC $MKEXPDIR $TBPRERUN $TBSWAP   
Leigh B Stoller's avatar
Leigh B Stoller committed
56
57
58
	    $TBREPORT $TBEND $DU $MD5
	    $EXPT_ACCESS_READINFO $EXPT_ACCESS_MODIFY $EXPT_ACCESS_DESTROY
	    $EXPT_ACCESS_UPDATE $EXPT_ACCESS_MIN $EXPT_ACCESS_MAX);
59
	  
60
# Configure variables
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
$TB	     = "@prefix@";
$BOSSNODE    = "@BOSSNODE@";
$CONTROL     = "@USERNODE@";
$TBOPS       = "@TBOPSEMAIL@";
$PROJROOT    = "@PROJROOT_DIR@";
$STAMPS      = @STAMPS@;
$TBBASE      = "@TBBASE@";
$TEVC	     = "$TB/bin/tevc";
$DBCONTROL   = "$TB/sbin/opsdb_control";
$RSYNC	     = "/usr/local/bin/rsync";
$MKEXPDIR    = "$TB/libexec/mkexpdir";
$TBPRERUN    = "$TB/bin/tbprerun";
$TBSWAP      = "$TB/bin/tbswap";
$TBREPORT    = "$TB/bin/tbreport";
$TBEND       = "$TB/bin/tbend";
$DU          = "/usr/bin/du";
$MD5         = "/sbin/md5";

# To avoid writting out all the methods.
AUTOLOAD {
    #print STDERR "$AUTOLOAD\n";

    if (!ref($_[0])) {
	$SelfLoader::AUTOLOAD = $AUTOLOAD;
	return SelfLoader::AUTOLOAD(@_);
    }
    my $self  = $_[0];
    my $name  = $AUTOLOAD;
    $name =~ s/.*://;   # strip fully-qualified portion

91
92
    # canceled is a special case.
    if ($name eq "canceled") {
93
	return Canceled($self);
94
    }
95
    # A DB row proxy method call.
96
    elsif (exists($self->{'EXPT'}->{$name})) {
97
98
99
100
101
102
103
104
105
106
107
108
	return $self->{'EXPT'}->{$name};
    }
    elsif (exists($self->{'STATS'}->{$name})) {
	return $self->{'STATS'}->{$name};
    }
    elsif (exists($self->{'RSRC'}->{$name})) {
	return $self->{'RSRC'}->{$name};
    }
    $SelfLoader::AUTOLOAD = $AUTOLOAD;
    my $ref = \&SelfLoader::AUTOLOAD;
    goto &$ref;
}
109

110
111
112
113
114
115
# Swap Actions
$EXPT_PRELOAD		= TBDB_STATS_PRELOAD();
$EXPT_START		= TBDB_STATS_START();
$EXPT_SWAPIN		= TBDB_STATS_SWAPIN();
$EXPT_SWAPOUT		= TBDB_STATS_SWAPOUT();
$EXPT_SWAPMOD		= TBDB_STATS_SWAPMODIFY();
116
$EXPT_SWAPUPDATE	= TBDB_STATS_SWAPUPDATE();
117

Leigh B Stoller's avatar
Leigh B Stoller committed
118
119
120
121
122
123
124
125
# Experiment Access.
$EXPT_ACCESS_READINFO   = TB_EXPT_READINFO();
$EXPT_ACCESS_MODIFY     = TB_EXPT_MODIFY();
$EXPT_ACCESS_DESTROY    = TB_EXPT_DESTROY();
$EXPT_ACCESS_UPDATE     = TB_EXPT_UPDATE();
$EXPT_ACCESS_MIN	= $EXPT_ACCESS_READINFO;
$EXPT_ACCESS_MAX	= $EXPT_ACCESS_UPDATE;

126
# Other flags.
127
128
129
130
$EXPT_FLAGS_LOCALONLY    = 0x01;
$EXPT_FLAGS_NAMESONLY    = 0x02;
$EXPT_FLAGS_INCLUDEVIRT  = 0x04;
$EXPT_FLAGS_FIXRESOURCES = 0x10;
131

132
133
134
$EXPT_GENIFLAGS_EXPT    = 0x01;
$EXPT_GENIFLAGS_COOKED  = 0x02;

135
# For stats gathering code.
136
137
$EXPT_STARTCLOCK        = undef;
$EXPT_RESOURCESHOSED    = 0;
138
139

# Why, why, why?
140
141
@EXPORT_OK = qw($EXPT_PRELOAD $EXPT_START $EXPT_SWAPUPDATE
		$EXPT_SWAPIN $EXPT_SWAPOUT $EXPT_SWAPMOD
142
		$EXPT_GENIFLAGS_EXPT $EXPT_GENIFLAGS_COOKED
143
		%physicalTables  @virtualTables);
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#
# List of tables used for experiment removal/backup/restore.
#
@virtualTables  = ("virt_nodes",
		   "virt_lans",
		   "virt_lan_lans",
		   "virt_lan_settings",
		   "virt_lan_member_settings",
		   "virt_trafgens",
		   "virt_agents",
		   "virt_routes",
		   "virt_vtypes",
		   "virt_programs",
158
		   "virt_node_attributes",
159
		   "virt_node_disks",
160
161
162
163
164
		   "virt_node_desires",
		   "virt_node_startloc",
		   "virt_simnode_attributes",
		   "virt_user_environment",
		   "virt_parameters",
165
		   "virt_paths",
166
		   "virt_bridges",
167
168
169
170
171
172
173
174
175
		   # vis_nodes is locked during update in prerender, so we
		   # will get a consistent dataset when we backup.
		   "vis_nodes",
		   "vis_graphs",
		   "nseconfigs",
		   "eventlist",
		   "event_groups",
		   "virt_firewalls",
		   "firewall_rules",
176
		   "elabinelab_attributes",
177
		   "virt_tiptunnels",
178
179
180
181
		   "ipsubnets",
		   "virt_blobs",
		   "virt_client_service_ctl",
		   "virt_client_service_hooks",
182
183
184
		   "virt_client_service_opts",
		   "virt_blockstores",
		   "virt_blockstore_attributes");
185

186
187
188
%physicalTables = ("delays"     => ["node_id", "vname", "vnode0", "vnode1"],
		   "v2pmap"        => ["node_id", "vname"],
		   "linkdelays"    => ["node_id", "vlan", "vnode"],
189
		   "traces"        => ["node_id", "idx"],
190
		   "portmap"       => undef,
191
192
		   "bridges"       => ["node_id", "bridx", "iface"],
                   "reserved_addresses" => undef); 
193
194

# These are slots in the node table that need to be restored. 
195
@nodetable_fields = ("def_boot_osid",
196
		        "def_boot_osid_vers",
197
198
199
			"def_boot_path",
			"def_boot_cmd_line",
			"temp_boot_osid",
200
			"temp_boot_osid_vers",
201
			"next_boot_osid",
202
			"next_boot_osid_vers",
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
			"next_boot_path",
			"next_boot_cmd_line",
			"pxe_boot_path",
			"bootstatus",
			"ready",
			"rpms",
			"deltas",
			"tarballs",
			"startupcmd",
			"startstatus",
			"failureaction",
			"routertype",
			"op_mode",
			"op_mode_timestamp",
			"allocstate",
			"allocstate_timestamp",
			"next_op_mode",
			"osid",
			"ipport_low",
			"ipport_next",
			"ipport_high",
			"sshdport",
			"rtabid");
226

227
# Cache of instances to avoid regenerating them.
228
%experiments   = ();
229
230
231
232
233
234

# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

235
236
237
238
239
    if (0) {
	my $cwd;
	chomp($cwd = `/bin/pwd`);
	print STDERR "Running '$command' in $cwd\n";
    }
240
241
242
243
244
245
    return system($command);
}

#
# Lookup an experiment and create a class instance to return.
#
246
sub Lookup($$;$)
247
{
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
    my ($class, $arg1, $arg2) = @_;
    my $idx;

    #
    # A single arg is either an index or a "pid,eid" or "pid/eid" string.
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^(\d*)$/) {
	    $idx = $1;
	}
	elsif ($arg1 =~ /^([-\w]*),([-\w]*)$/ ||
	       $arg1 =~ /^([-\w]*)\/([-\w]*)$/) {
	    $arg1 = $1;
	    $arg2 = $2;
	}
263
264
265
266
267
268
269
270
271
272
	elsif ($arg1 =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
	    my $result =
		DBQueryWarn("select idx from experiments ".
			    "where eid_uuid='$arg1'");

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

	    ($idx) = $result->fetchrow_array();
	}
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
	else {
	    return undef;
	}
    }
    elsif (! (($arg1 =~ /^[-\w]*$/) && ($arg2 =~ /^[-\w]*$/))) {
	return undef;
    }

    #
    # Two args means lookup by pid,eid instead of exptidx.
    #
    if (defined($arg2)) {
	my $result =
	    DBQueryWarn("select idx from experiments ".
			"where pid='$arg1' and eid='$arg2'");

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

	($idx) = $result->fetchrow_array();
    }
294
295

    # Look in cache first
296
297
    return $experiments{"$idx"}
        if (exists($experiments{"$idx"}));
298
299
    
    my $query_result =
300
301
302
	DBQueryWarn("select e.*,i.parent_guid,t.guid from experiments as e ".
		    "left join experiment_templates as t on ".
		    "     t.exptidx=e.idx ".
303
304
305
		    "left join experiment_template_instances as i on ".
		    "     i.exptidx=e.idx ".
		    "where e.idx='$idx'");
306
307
308
309
310
311

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

    my $self         = {};
    $self->{'EXPT'}  = $query_result->fetchrow_hashref();
312
313
    # An Instance?
    $self->{'ISINSTANCE'} = defined($self->{'EXPT'}->{'parent_guid'});
314
315
    # The experiment underlying a template.
    $self->{'ISTEMPLATE'} = defined($self->{'EXPT'}->{'guid'});
316
317
318
319
320
321
322
323
324

    $query_result =
	DBQueryWarn("select * from experiment_stats where exptidx='$idx'");
	
    return undef
	if (!$query_result || !$query_result->numrows);
    
    $self->{'STATS'} = $query_result->fetchrow_hashref();
    
325
326
327
328
329
330
    my $rsrcidx = $self->{'STATS'}->{'rsrcidx'};

    $query_result =
	DBQueryWarn("select * from experiment_resources ".
		    "where idx='$rsrcidx'");
	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
331
    return undef
332
333
334
	if (!$query_result || !$query_result->numrows);
    
    $self->{'RSRC'} = $query_result->fetchrow_hashref();
335

336
337
338
    # Virt Experiment; load lazy.
    $self->{'VIRTEXPT'} = undef;

339
340
341
    bless($self, $class);
    
    # Add to cache. 
342
    $experiments{"$idx"} = $self;
343
344
345
    
    return $self;
}
346

347
348
# Break circular reference someplace to avoid exit errors.
sub DESTROY {
349
350
    my $self = shift;

351
352
353
354
355
    $self->{"EXPT"}     = undef;
    $self->{"STATS"}    = undef;
    $self->{"RSRC"}     = undef;
    $self->{'VIRTEXPT'} = undef;
}
356

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
#
# Flush from our little cache, as for the expire daemon.
#
sub Flush($)
{
    my ($self) = @_;

    delete($experiments{$self->idx()});
}
sub FlushAll($)
{
    my ($class) = @_;

    %experiments = ();
}

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

    return "[Experiment: $pid/$eid]";
384
}
385
386
387
# Keep this above @SELFLOADER_DATA@ ... elabinelab is a slot in
# the stats stats record, but was not being updated
sub elabinelab($) { return $_[0]->elab_in_elab(); }
388

389
#
390
# For canceled, goto to the DB. See AUTOLOAD above.
391
#
392
sub Canceled($)
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
{
    my ($self) = @_;
    
    my $idx = $self->idx();

    my $query_result =
	DBQueryWarn("select canceled from experiments where idx='$idx'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }
    my ($canceled) = $query_result->fetchrow_array();
    $self->{'EXPT'}->{'canceled'} = $canceled;
    return $canceled;
}

410
411
412
413
414
415
416
417
418
419
1;
@SELFLOADER_DATA@

sub dbrow($$)     { return $_[0]->{'EXPT'}; }
sub locked($)     { return $_[0]->expt_locked(); }
sub description($){ return $_[0]->expt_name(); }
sub creator($)    { return $_[0]->expt_head_uid(); }
sub created($)	  { return $_[0]->expt_created(); }
sub swapper($)	  { return $_[0]->expt_swap_uid(); }

420
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
421
# Lookup an experiment given an experiment index.
422
423
424
425
426
#
sub LookupByIndex($$)
{
    my ($class, $exptidx) = @_;

427
    return Experiment->Lookup($exptidx);
428
429
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
430
431
432
433
434
435
436
437
438
439
440
441
442
443
#
# Equality test. Not strictly necessary in perl, but good form.
#
sub SameExperiment($$)
{
    my ($self, $other) = @_;

    # Must be a real reference. 
    return -1
	if (! (ref($self) && ref($other)));

    return $self->idx() == $other->idx();
}

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
#
# All active experiments.
#
sub AllActive($)
{
    my ($class) = @_;
    my @result  = ();
    
    my $query_result =
	DBQueryFatal("select idx from experiments where state='active'");

    while (my ($idx) = $query_result->fetchrow_array()) {
	my $experiment = Experiment->Lookup($idx);

	if (!defined($experiment)) {
	    print STDERR "Experiment::AllActive: No object for $idx!\n";
	}
	push(@result, $experiment);
    }
    return @result;
}

466
467
468
469
470
471
472
473
474
475
476
#
# All experiments for a particular user. Class method.
#
sub UserExperimentList($$$)
{
    my ($class, $user, $plist) = @_;
    my @result  = ();
    my $uid_idx = $user->uid_idx();
    
    my $query_result =
	DBQueryWarn("select idx from experiments ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
477
478
		    "where creator_idx='$uid_idx' or ".
		    "      (swapper_idx='$uid_idx' and ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
479
		    "       state!='" . EXPTSTATE_SWAPPED() . "')");
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
    return -1
	if (! $query_result);

    while (my ($idx) = $query_result->fetchrow_array()) {
	my $experiment = Experiment->Lookup($idx);

	if (!defined($experiment)) {
	    print STDERR "Experiment::UserExperimentList: ".
		"No object for $idx!\n";
	    return -1;
	}
	push(@result, $experiment);
    }
    @$plist = @result;
    return 0;
}

497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# This is needed a lot.
sub unix_gid($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $group = $self->GetGroup();
    return -1
	if (!defined($group));

    return $group->unix_gid();
}

513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
#
# LockTables simple locks the given tables, and then refreshes the
# experiment instance (thereby getting the data from the DB after
# the tables are locked).
#
sub LockTables($;$)
{
    my ($self, $spec) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    $spec  = "experiments write"
	if (!defined($spec));
    $spec .= ", experiment_stats read";
529
    $spec .= ", experiment_resources read";
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
    
    DBQueryWarn("lock tables $spec")
	or return -1;
	
    return $self->Refresh();
}
sub UnLockTables($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    DBQueryWarn("unlock tables")
	or return -1;
    return 0;
}

549
550
551
552
553
554
#
# Create a new experiment. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
#
sub Create($$$$)
{
555
    my ($class, $group, $eid, $argref) = @_;
556
    my $exptidx;
557
    my $uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
558
    my $now = time();
559
560

    return undef
561
562
563
564
565
566
	if (ref($class) || !ref($group));

    my $pid     = $group->pid();
    my $gid     = $group->gid();
    my $pid_idx = $group->pid_idx();
    my $gid_idx = $group->gid_idx();
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658

    #
    # The pid/eid has to be unique, so lock the table for the check/insert.
    #
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_stats write, ".
		"            experiment_resources write, ".
		"            emulab_indicies write, ".
		"            testbed_stats read")
	or return undef;

    my $query_result =
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");

    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
	tberror("Experiment $eid in project $pid already exists!");
	return undef;
    }

    #
    # Grab the next highest index to use. We used to use an auto_increment
    # field in the table, but if the DB is ever "dropped" and recreated,
    # it will reuse indicies that are crossed referenced in the other two
    # tables.
    #
    $query_result = 
	DBQueryWarn("select idx from emulab_indicies ".
		    "where name='next_exptidx'");

    if (!$query_result) {
	DBQueryWarn("unlock tables");
	return undef;
    }

    # Seed with a proper value.
    if (! $query_result->num_rows) {
	$query_result =
	    DBQueryWarn("select MAX(exptidx) + 1 from experiment_stats");

	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
	($exptidx) = $query_result->fetchrow_array();

	# First ever experiment!
	$exptidx = 1
	    if (!defined($exptidx));

	if (! DBQueryWarn("insert into emulab_indicies (name, idx) ".
			  "values ('next_exptidx', $exptidx)")) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}

    }
    else {
	($exptidx) = $query_result->fetchrow_array();
    }
    my $nextidx = $exptidx + 1;
    
    if (! DBQueryWarn("update emulab_indicies set idx='$nextidx' ".
		      "where name='next_exptidx'")) {
	DBQueryWarn("unlock tables");
	return undef;
    }

    #
    # Lets be really sure!
    #
    foreach my $table ("experiments", "experiment_stats",
		       "experiment_resources", "testbed_stats") {

	my $slot = (($table eq "experiments") ? "idx" : "exptidx");
	
	$query_result =
	    DBQueryWarn("select * from $table where ${slot}=$exptidx");

	if (! $query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
	if ($query_result->numrows) {
	    DBQueryWarn("unlock tables");
	    tberror("Experiment index $exptidx exists in $table; ".
		    "this is bad!");
	    return undef;
	}
    }

659
    # And a UUID (universally unique identifier).
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
    if (exists($argref->{'eid_uuid'})) {
	$uuid = $argref->{'eid_uuid'};
	delete($argref->{'eid_uuid'});

	if (! ($uuid =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	    DBQueryWarn("unlock tables");
	    print "*** WARNING: Bad format in UUID!\n";
	    return undef;
	}
    }
    else {
	$uuid = NewUUID();
	if (!defined($uuid)) {
	    DBQueryWarn("unlock tables");
	    print "*** WARNING: Could not generate a UUID!\n";
	    return undef;
	}
677
678
    }

679
680
681
682
    #
    # Lets be real sure that the UUID is really unique.
    #
    $query_result =
683
	DBQueryWarn("select pid,eid from experiments ".
684
685
686
687
688
689
690
691
692
693
694
695
		    "where eid_uuid='$uuid'");
    if (! $query_result) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
	tberror("Experiment uuid $uuid already exists; ".
		"this is bad!");
	return undef;
    }

696
697
698
699
700
701
702
703
704
705
706
707
    #
    # Insert the record. This reserves the pid/eid for us. 
    #
    # Some fields special cause of quoting.
    #
    my $description = DBQuoteSpecial($argref->{'expt_name'});
    delete($argref->{'expt_name'});
    my $noswap_reason = DBQuoteSpecial($argref->{'noswap_reason'});
    delete($argref->{'noswap_reason'});
    my $noidleswap_reason = DBQuoteSpecial($argref->{'noidleswap_reason'});
    delete($argref->{'noidleswap_reason'});

Leigh B. Stoller's avatar
Leigh B. Stoller committed
708
709
710
711
    # we override this below
    delete($argref->{'idx'})
	if (exists($argref->{'idx'}));

712
713
714
715
    my $query = "insert into experiments set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    # Append the rest
Leigh B. Stoller's avatar
Leigh B. Stoller committed
716
    $query .= ",expt_created=FROM_UNIXTIME('$now')";
717
    $query .= ",expt_locked=now(),pid='$pid',eid='$eid',eid_uuid='$uuid'";
718
    $query .= ",pid_idx='$pid_idx',gid='$gid',gid_idx='$gid_idx'";
719
720
721
    $query .= ",expt_name=$description";
    $query .= ",noswap_reason=$noswap_reason";
    $query .= ",noidleswap_reason=$noidleswap_reason";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
722
    $query .= ",idx=$exptidx";
723
724
725
726
727
728
729

    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	tberror("Error inserting experiment record for $pid/$eid!");	
	return undef;
    }

730
731
732
733
    my $creator_uid = $argref->{'expt_head_uid'};
    my $creator_idx = $argref->{'creator_idx'};
    my $batchmode   = $argref->{'batchmode'};

734
735
736
737
    #
    # Create an experiment_resources record for the above record.
    #
    $query_result =
738
739
740
	DBQueryWarn("insert into experiment_resources ".
		    "(tstamp, exptidx, uid_idx) ".
		    "values (FROM_UNIXTIME('$now'), $exptidx, $creator_idx)");
741
742
743
744
745
746
747

    if (!$query_result) {
	DBQueryWarn("delete from experiments where pid='$pid' and eid='$eid'");
	DBQueryWarn("unlock tables");
	tberror("Error inserting experiment resources record for $pid/$eid!");
	return undef;
    }
748
    my $rsrcidx     = $query_result->insertid;
749
    
750
751
752
753
    #
    # Now create an experiment_stats record to match.
    #
    if (! DBQueryWarn("insert into experiment_stats ".
754
		      "(eid, pid, creator, creator_idx, gid, created, ".
755
756
		      " batch, exptidx, rsrcidx, pid_idx, gid_idx, eid_uuid, ".
		      " last_activity) ".
757
758
		      "values('$eid', '$pid', '$creator_uid', '$creator_idx',".
		      "       '$gid', FROM_UNIXTIME('$now'), ".
759
		      "        $batchmode, $exptidx, $rsrcidx, ".
760
761
		      "        $pid_idx, $gid_idx, '$uuid', ".
		      "        FROM_UNIXTIME('$now'))")) {
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
	DBQueryWarn("delete from experiments where pid='$pid' and eid='$eid'");
	DBQueryWarn("delete from experiment_resources where idx=$rsrcidx");
	DBQueryWarn("unlock tables");
	tberror("Error inserting experiment stats record for $pid/$eid!");
	return undef;
    }

    #
    # Safe to unlock; all tables consistent.
    #
    if (! DBQueryWarn("unlock tables")) {
	DBQueryWarn("delete from experiments where pid='$pid' and eid='$eid'");
	DBQueryWarn("delete from experiment_resources where idx=$rsrcidx");
	DBQueryWarn("delete from experiment_stats where exptidx=$exptidx");
	tberror("Error unlocking tables!");
	return undef
    }

    return Experiment->Lookup($pid, $eid);
}

#
# Delete experiment. Optional purge argument says to remove all trace
# (typically, the stats are kept).
#
sub Delete($;$)
{
    my ($self, $purge) = @_;

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

794
795
796
    my $pid     = $self->pid();
    my $eid     = $self->eid();
    my $exptidx = $self->idx();
797
798
    my $workdir = $self->WorkDir();
    my $userdir = $self->UserDir();
799
800
801
802

    $purge = 0
	if (!defined($purge));

803
804
    $self->UnBindNonLocalUsers();

805
806
807
808
809
810
811
812
813
814
815
    #
    # Try to remove experiment directory. We allow for it not being there
    # cause we often run the tb programs directly. We also allow for not
    # having permission, in the case that an admin type is running this,
    # in which case it won't be allowed cause of directory permissions. Thats
    # okay since admin types should rarely end experiments in other projects.
    #
    print "Removing experiment directories ... \n";
    if (defined($userdir) && system("/bin/rm -rf $userdir")) {
	print "*** WARNING: Not able to remove $userdir\n";
	print "             Someone will need to do this by hand.\n";
816

817
818
819
	# Try to move the directory.
	my $moved = (system("/bin/mv -f $userdir ${userdir}.$$") == 0);

820
821
822
823
	# NFS errors usually the result. Sometimes its cause there is
	# someone in the directory, so its being held open.
        libtestbed::SENDMAIL($TBOPS,
			     "Experiment::Delete: Could not remove directory",
824
825
826
			     "Could not remove $userdir. ".
			     ($moved ?
			      "Renamed to ${userdir}.$$ ..." : "") . "\n" .
827
828
829
830
831
832
833
834
835
836
837
838
			     "Someone will need to do this by hand.\n");
    }
    if (system("/bin/rm -rf $workdir")) {
	print "*** WARNING: Not able to remove $workdir\n";
	print "             Someone will need to do this by hand.\n";
    }
    # Yuck.
    if ($pid ne $self->gid()) {
	my $eidlink = "$PROJROOT/$pid/exp/$eid";
	unlink($eidlink)
	    if (-l $eidlink);
    }
839
840
841
842
    my $logfile = $self->GetLogFile();
    if (defined($logfile)) {
	$logfile->Delete();
    }
843
844
845
846
    libArchive::TBDeleteExperimentArchive($pid, $eid);

    DBQueryWarn("DELETE from experiments ".
		"WHERE eid='$eid' and pid='$pid'");
847

848
849
850
    # Delete from cache. 
    delete($experiments{"$exptidx"});

851
852
853
854
855
856
857
858
859
    #
    # Mark experiment destroyed. This is a backup to End() below.
    #
    if (! defined($self->destroyed())) {
	DBQueryWarn("update experiment_stats set ".
		    "   destroyed=now() ".
		    "where exptidx=$exptidx");
	$self->Refresh();
    }
860
    return 0
861
862
863
	if (! $purge);
    
    #
864
    # Now we can clean up the stats and resource records. 
865
866
    #
    my $rsrcidx = $self->rsrcidx();
867
868
869
870
871
872
873

    $self->DeleteInputFiles();

    DBQueryWarn("DELETE from experiment_pmapping ".
		"WHERE rsrcidx=$rsrcidx")
	if (defined($rsrcidx) && $rsrcidx);

874
    DBQueryWarn("DELETE from experiment_resources ".
875
		"WHERE idx=$rsrcidx")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
876
	if (defined($rsrcidx) && $rsrcidx);
877

878
879
880
881
882
883
884
885
886
887
    DBQueryWarn("DELETE from testbed_stats ".
		"WHERE exptidx=$exptidx");

    # This must be last cause it provides the unique exptidx above.
    DBQueryWarn("DELETE from experiment_stats ".
		"WHERE eid='$eid' and pid='$pid' and exptidx=$exptidx");

    return 0;
}

888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
#
# Add an input file to the template. The point of this is to reduce
# duplication by taking an md5 of the input file, and sharing that
# record/file.
# 
sub AddInputFile($$;$)
{
    my ($self, $inputfile, $isnsfile) = @_;
    my $input_data_idx;
    my $isnew = 0;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    $isnsfile = 0
	if (! defined($isnsfile));

    return -1
	if (! -r $inputfile);

    my $data_string = `cat $inputfile`;
    return -1
	if ($?);

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

    if ($data_string) {
	# As you can see, we md5 the raw data.
	$data_string = DBQuoteSpecial($data_string);
	if (length($data_string) >= DBLIMIT_NSFILESIZE()) {
	    tberror("Input file is too big (> " . DBLIMIT_NSFILESIZE() . ")!");
	    return -1;
	}

	#
	# Grab an MD5 of the file to see if we already have a copy of it.
	# Avoids needless duplication.
	#
	my $md5 = `$MD5 -q $inputfile`;
	chomp($md5);

	DBQueryWarn("lock tables experiment_input_data write, ".
		    "            experiment_inputs write, ".
		    "            experiment_resources write")
	    or return -1;

	my $query_result =
	    DBQueryWarn("select idx from experiment_input_data ".
			"where md5='$md5'");

	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}

	if ($query_result->numrows) {
	    ($input_data_idx) = $query_result->fetchrow_array();
	    $isnew = 0;
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
	    $isnew = 1;
	}
	if (! DBQueryWarn("insert into experiment_inputs ".
			  " (rsrcidx, exptidx, input_data_idx) values ".
			  " ($rsrcidx, $exptidx, '$input_data_idx')")) {
	    DBQueryWarn("delete from experiment_input_data ".
			"where idx='$input_data_idx'")
		if ($isnew);
	    DBQueryWarn("unlock tables");
	    return -1;
	}
	if ($isnsfile &&
	    $self->TableUpdate("experiment_resources",
973
			       "input_data_idx='$input_data_idx'",
Leigh B. Stoller's avatar
Leigh B. Stoller committed
974
			       "idx='$rsrcidx'") != 0) {
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
	    DBQueryWarn("unlock tables");
	    return -1;
	}
	DBQueryWarn("unlock tables");
    }
    return 0;
}

#
# Delete the input files, but only if not in use.
#
sub DeleteInputFiles($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $rsrcidx = $self->rsrcidx();
    my $nsidx   = $self->input_data_idx();

    DBQueryWarn("lock tables experiment_input_data write, ".
		"            experiment_resources write, ".
		"            experiment_inputs write")
	or return -1;
For faster browsing, not all history is shown. View entire blame