Experiment.pm.in 55.8 KB
Newer Older
1
2
3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2005, 2006, 2007 University of Utah and the Flux Group.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# All rights reserved.
#
package Experiment;

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

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

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
use libtestbed;
20
use User;
21
22
use Project;
use Group;
23
use Node;
24
25
use English;
use Data::Dumper;
26
use File::Basename;
27
28
use overload ('""' => 'Stringify');

29
30
31
32
use vars qw($EXPT_PRELOAD $EXPT_START $EXPT_SWAPIN
	    $EXPT_SWAPOUT $EXPT_SWAPMOD
	    @EXPORT_OK);

33
34
35
# Configure variables
my $TB		= "@prefix@";
my $BOSSNODE    = "@BOSSNODE@";
36
my $CONTROL	= "@USERNODE@";
37
my $EVENTSYS    = @EVENTSYS@;
38
my $STAMPS      = @STAMPS@;
39
40
41
42
43
44
45
46
my $TEVC	= "$TB/bin/tevc";
my $DBCONTROL   = "$TB/sbin/opsdb_control";
my $RSYNC	= "/usr/local/bin/rsync";
my $MKEXPDIR    = "$TB/libexec/mkexpdir";
my $TBPRERUN    = "$TB/bin/tbprerun";
my $TBSWAP      = "$TB/bin/tbswap";
my $TBREPORT    = "$TB/bin/tbreport";
my $TBEND       = "$TB/bin/tbend";
47
my $DU          = "/usr/bin/du";
48

49
50
51
52
53
54
55
56
57
# 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();

# For stats gathering code.
my $EXPT_STARTCLOCK;
58
my $EXPT_RESOURCESHOSED = 0;
59
60
61
62
63

# Why, why, why?
@EXPORT_OK = qw($EXPT_PRELOAD $EXPT_START
		$EXPT_SWAPIN $EXPT_SWAPOUT $EXPT_SWAPMOD);

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Hmm, this is silly. 
if ($EVENTSYS) {
    require event;
    import event;
}

# Cache of instances to avoid regenerating them.
my %experiments   = ();
my $debug	  = 0;

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

79
80
81
82
    my $cwd;
    chomp($cwd = `pwd`);

    print STDERR "Running '$command' in $cwd\n"
83
84
85
86
87
88
89
	if ($debug);
    return system($command);
}

#
# Lookup an experiment and create a class instance to return.
#
90
sub Lookup($$;$)
91
{
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
    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;
	}
	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();
    }
128
129

    # Look in cache first
130
131
    return $experiments{"$idx"}
        if (exists($experiments{"$idx"}));
132
133
    
    my $query_result =
134
135
136
	DBQueryWarn("select e.*,i.parent_guid,t.guid from experiments as e ".
		    "left join experiment_templates as t on ".
		    "     t.exptidx=e.idx ".
137
138
139
		    "left join experiment_template_instances as i on ".
		    "     i.exptidx=e.idx ".
		    "where e.idx='$idx'");
140
141
142
143
144
145

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

    my $self         = {};
    $self->{'EXPT'}  = $query_result->fetchrow_hashref();
146
147
    # An Instance?
    $self->{'ISINSTANCE'} = defined($self->{'EXPT'}->{'parent_guid'});
148
149
    # The experiment underlying a template.
    $self->{'ISTEMPLATE'} = defined($self->{'EXPT'}->{'guid'});
150
151
152
153
154
155
156
157
158

    $query_result =
	DBQueryWarn("select * from experiment_stats where exptidx='$idx'");
	
    return undef
	if (!$query_result || !$query_result->numrows);
    
    $self->{'STATS'} = $query_result->fetchrow_hashref();
    
159
160
161
162
163
164
    my $rsrcidx = $self->{'STATS'}->{'rsrcidx'};

    $query_result =
	DBQueryWarn("select * from experiment_resources ".
		    "where idx='$rsrcidx'");
	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
165
    return undef
166
167
168
	if (!$query_result || !$query_result->numrows);
    
    $self->{'RSRC'} = $query_result->fetchrow_hashref();
169
170
171
172

    bless($self, $class);
    
    # Add to cache. 
173
    $experiments{"$idx"} = $self;
174
175
176
177
    
    return $self;
}
# accessors
178
179
180
sub field($$)     { return ((! ref($_[0])) ? -1 : $_[0]->{'EXPT'}->{$_[1]}); }
sub stats($$)     { return ((! ref($_[0])) ? -1 : $_[0]->{'STATS'}->{$_[1]});}
sub resources($$) { return ((! ref($_[0])) ? -1 : $_[0]->{'RSRC'}->{$_[1]}); }
181

182
183
184
185
186
187
188
189
190
191
192
sub pid($)		{ return field($_[0], 'pid'); }
sub gid($)		{ return field($_[0], 'gid'); }
sub pid_idx($)		{ return field($_[0], 'pid_idx'); }
sub gid_idx($)		{ return field($_[0], 'gid_idx'); }
sub eid($)		{ return field($_[0], 'eid'); }
sub idx($)		{ return field($_[0], 'idx'); }
sub path($)		{ return field($_[0], 'path'); }
sub state($)		{ return field($_[0], 'state'); }
sub batchstate($)	{ return field($_[0], 'batchstate'); }
sub batchmode($)	{ return field($_[0], 'batchmode'); }
sub rsrcidx($)		{ return stats($_[0], 'rsrcidx'); }
193
sub lastrsrc($)		{ return stats($_[0], 'lastrsrc'); }
194
195
196
197
198
199
200
201
202
203
204
205
206
sub creator($)		{ return field($_[0], 'expt_head_uid');}
sub canceled($)		{ return field($_[0], 'canceled'); }
sub locked($)		{ return field($_[0], 'expt_locked'); }
sub elabinelab($)	{ return field($_[0], 'elab_in_elab');}
sub elabinelab_eid($)   { return field($_[0], 'elabinelab_eid');}
sub elabinelab_exptidx($){return field($_[0], 'elabinelab_exptidx');}
sub lockdown($)		{ return field($_[0], 'lockdown'); }
sub created($)		{ return field($_[0], 'expt_created'); }
sub swapper($)		{ return field($_[0], 'expt_swap_uid');}
sub swappable($)	{ return field($_[0], 'swappable');}
sub idleswap($)		{ return field($_[0], 'idleswap');}
sub autoswap($)		{ return field($_[0], 'autoswap');}
sub noswap_reason($)	{ return field($_[0], 'noswap_reason');}
207
208
209
210
sub noidleswap_reason($){ return field($_[0], 'noidleswap_reason');}
sub idleswap_timeout($) { return field($_[0], 'idleswap_timeout');}
sub autoswap_timeout($) { return field($_[0], 'autoswap_timeout');}
sub prerender_pid($)    { return field($_[0], 'prerender_pid');}
211
212
sub dpdb($)		{ return field($_[0], 'dpdb');}
sub dpdbname($)         { return field($_[0], 'dpdbname');}
213
sub dpdbpassword($)     { return field($_[0], 'dpdbpassword');}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
214
sub instance_idx($)     { return field($_[0], 'instance_idx'); }
215
216
sub creator_idx($)      { return field($_[0], 'creator_idx');}
sub swapper_idx($)      { return field($_[0], 'swapper_idx');}
217
218
219
sub use_ipassign($)     { return field($_[0], 'use_ipassign');}
sub ipassign_args($)    { return field($_[0], 'ipassign_args');}
sub security_level($)   { return field($_[0], 'security_level');}
220
sub archive_idx($)	{ return stats($_[0], 'archive_idx'); }
221
222
sub swapin_count($)	{ return stats($_[0], 'swapin_count'); }
sub destroyed($)	{ return stats($_[0], 'destroyed'); }
223
sub archive_tag($)	{ return resources($_[0], 'archive_tag'); }
224
225
226
227
sub thumbnail($)	{ return resources($_[0], 'thumbnail'); }
sub swapin_time($)	{ return resources($_[0], 'swapin_time'); }
sub swapout_time($)	{ return resources($_[0], 'swapout_time'); }
sub lastidx($)	        { return resources($_[0], 'lastidx'); }
228
229

#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
230
# Lookup an experiment given an experiment index.
231
232
233
234
235
#
sub LookupByIndex($$)
{
    my ($class, $exptidx) = @_;

236
    return Experiment->Lookup($exptidx);
237
238
}

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
#
# 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;
}

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# 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();
}

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
#
# 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";
293
    $spec .= ", experiment_resources read";
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
    
    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;
}

313
314
315
316
317
318
#
# 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($$$$)
{
319
    my ($class, $group, $eid, $argref) = @_;
320
    my $exptidx;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
321
    my $now = time();
322
323

    return undef
324
325
326
327
328
329
	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();
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421

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

422
423
424
425
426
427
428
    # And a UUID (universally unique identifier).
    my $uuid = NewUUID();
    if (!defined($uuid)) {
	print "*** WARNING: Could not generate a UUID!\n";
	return undef;
    }

429
430
431
432
433
434
435
436
437
438
439
440
    #
    # 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
441
442
443
444
    # we override this below
    delete($argref->{'idx'})
	if (exists($argref->{'idx'}));

445
446
447
448
    my $query = "insert into experiments set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    # Append the rest
Leigh B. Stoller's avatar
Leigh B. Stoller committed
449
    $query .= ",expt_created=FROM_UNIXTIME('$now')";
450
    $query .= ",expt_locked=now(),pid='$pid',eid='$eid',eid_uuid='$uuid'";
451
    $query .= ",pid_idx='$pid_idx',gid='$gid',gid_idx='$gid_idx'";
452
453
454
    $query .= ",expt_name=$description";
    $query .= ",noswap_reason=$noswap_reason";
    $query .= ",noidleswap_reason=$noidleswap_reason";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
455
    $query .= ",idx=$exptidx";
456
457
458
459
460
461
462

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

463
464
465
466
    my $creator_uid = $argref->{'expt_head_uid'};
    my $creator_idx = $argref->{'creator_idx'};
    my $batchmode   = $argref->{'batchmode'};

467
468
469
470
    #
    # Create an experiment_resources record for the above record.
    #
    $query_result =
471
472
473
	DBQueryWarn("insert into experiment_resources ".
		    "(tstamp, exptidx, uid_idx) ".
		    "values (FROM_UNIXTIME('$now'), $exptidx, $creator_idx)");
474
475
476
477
478
479
480

    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;
    }
481
    my $rsrcidx     = $query_result->insertid;
482
    
483
484
485
486
    #
    # Now create an experiment_stats record to match.
    #
    if (! DBQueryWarn("insert into experiment_stats ".
487
		      "(eid, pid, creator, creator_idx, gid, created, ".
488
		      " batch, exptidx, rsrcidx, pid_idx, gid_idx, eid_uuid) ".
489
490
		      "values('$eid', '$pid', '$creator_uid', '$creator_idx',".
		      "       '$gid', FROM_UNIXTIME('$now'), ".
491
		      "        $batchmode, $exptidx, $rsrcidx, ".
492
		      "        $pid_idx, $gid_idx, '$uuid')")) {
493
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
	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));

525
526
527
    my $pid     = $self->pid();
    my $eid     = $self->eid();
    my $exptidx = $self->idx();
528
529
530
531
532
533

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

    TBExptDestroy($pid, $eid);

534
535
536
537
538
539
540
541
542
    #
    # 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();
    }
543
    return 0
544
545
546
547
548
549
550
551
	if (! $purge);
    
    #
    # Now we can clean up the stats records. 
    #
    my $rsrcidx = $self->rsrcidx();
    
    DBQueryWarn("DELETE from experiment_resources ".
552
		"WHERE idx=$rsrcidx")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
553
	if (defined($rsrcidx) && $rsrcidx);
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
	
    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;
}

#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

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

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

577
    my $query_result =
578
	DBQueryWarn("select * from experiments where idx=$idx");
579
580
581
582
583
584
585
586
587
588
589
590
591
592

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

    $self->{'EXPT'}  = $query_result->fetchrow_hashref();

    $query_result =
	DBQueryWarn("select * from experiment_stats where exptidx='$idx'");
	
    return -1
	if (!$query_result || !$query_result->numrows);
    
    $self->{'STATS'} = $query_result->fetchrow_hashref();

593
594
595
596
597
598
599
600
601
602
    my $rsrcidx = $self->rsrcidx();

    $query_result =
	DBQueryWarn("select * from experiment_resources ".
		    "where idx='$rsrcidx'");
	
    return -1
	if (!$query_result || !$query_result->numrows);
    
    $self->{'RSRC'} = $query_result->fetchrow_hashref();
603
604
605
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
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
#
# Perform some updates ...
#
sub Update($$)
{
    my ($self, $argref) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    my $query = "update experiments set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where pid='$pid' and eid='$eid'";

    return -1
	if (! DBQueryWarn($query));

    return Refresh($self);
}

631
632
633
634
635
636
637
638
639
640
641
642
643
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $pid   = $self->pid();
    my $eid   = $self->eid();

    return "[Experiment: $pid/$eid]";
}

644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
#
# Generic function to look up some table values given a set of desired
# fields and some conditions. Pretty simple, not widely useful, but it
# helps to avoid spreading queries around then we need to. 
#
sub TableLookUp($$$;$)
{
    my ($self, $table, $fields, $conditions) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));
    
    my $exptidx = $self->idx();

    if (defined($conditions) && "$conditions" ne "") {
	$conditions = "and ($conditions)";
    }
    else {
	$conditions = "";
    }

    return DBQueryWarn("select distinct $fields from $table ".
		       "where exptidx='$exptidx' $conditions");
}

#
# Ditto for update.
#
sub TableUpdate($$$;$)
{
    my ($self, $table, $sets, $conditions) = @_;

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

    if (ref($sets) eq "HASH") {
	$sets = join(",", map("$_='" . $sets->{$_} . "'", keys(%{$sets})));
    }
    my $exptidx = $self->idx();

    if (defined($conditions) && "$conditions" ne "") {
	$conditions = "and ($conditions)";
    }
    else {
	$conditions = "";
    }

    return 0
	if (DBQueryWarn("update $table set $sets ".
			"where exptidx='$exptidx' $conditions"));
    return -1;
}

699
#
700
701
# Check permissions. Allow for either uid or a user ref until all code
# updated.
702
703
704
#
sub AccessCheck($$$)
{
705
    my ($self, $user, $access_type) = @_;
706
707
708
709
710

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

711
    my $uid = (ref($user) ? $user->uid() : $user);
712
713
714
715
716
717
    my $pid = $self->pid();
    my $eid = $self->eid();

    return TBExptAccessCheck($uid, $pid, $eid, $access_type);
}

718
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
719
720
721
722
# Create the directory structure. A template_mode experiment is the one
# that is created for the template wrapper, not one created for an
# instance of the experiment. The path changes slightly, although that
# happens down in the mkexpdir script.
723
724
725
726
727
728
729
730
731
#
sub CreateDirectory($)
{
    my ($self) = @_;

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

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

734
    mysystem("$MKEXPDIR $idx");
735
736
737
738
739
740
    return -1
	if ($?);
    # mkexpdir sets the path in the DB. 
    return Refresh($self)
}

741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
#
# Load the project object for an experiment.
#
sub GetProject($)
{
    my ($self) = @_;

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

    my $project = Project->Lookup($self->pid_idx());
    
    if (! defined($project)) {
	print("*** WARNING: Could not lookup project object for $self!", 1);
	return undef;
    }
    return $project;
}

#
# Load the group object for an experiment.
#
sub GetGroup($)
{
    my ($self) = @_;

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

    my $group = Group->Lookup($self->gid_idx());
    
    if (! defined($group)) {
	print("*** WARNING: Could not lookup group object for $self!\n");
	return undef;
    }
    return $group;
}

781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
#
# Return the user and work directories. The workdir in on boss and where
# scripts chdir to when they run. The userdir is across NFS on ops, and
# where files are copied to. 
#
sub WorkDir($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    return TBDB_EXPT_WORKDIR() . "/${pid}/${eid}";
}
sub UserDir($)
{
    my ($self) = @_;

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

    return $self->path();
}

# Event/Web key filenames.
sub EventKeyPath($)
{
    my ($self) = @_;

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

    return UserDir($self) . "/tbdata/eventkey"; 
}
sub WebKeyPath($)
{
    my ($self) = @_;

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

    return UserDir($self) . "/tbdata/webkey"; 
}

832
833
834
#
# Add an environment variable.
#
835
sub AddEnvVariable($$$;$)
836
{
837
    my ($self, $name, $value, $index) = @_;
838
839
840
841
842
843
844

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

    my $pid = $self->pid();
    my $eid = $self->eid();
845
    my $exptidx = $self->idx();
846

847
848
849
850
851
852
853
    if (defined($value)) {
	$value = DBQuoteSpecial($value);
    }
    else {
	$value = "''";
    }

854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
    #
    # Look to see if the variable exists, since a replace will actually
    # create a new row cause there is an auto_increment in the table that
    # is used to maintain order of the variables as specified in the NS file.
    #
    my $query_result =
	DBQueryWarn("select idx from virt_user_environment ".
		    "where name='$name' and pid='$pid' and eid='$eid'");

    return -1
	if (!$query_result);

    if ($query_result->numrows) {
	my $idx = (defined($index) ? $index :
		   ($query_result->fetchrow_array())[0]);
	    
	DBQueryWarn("replace into virt_user_environment set ".
		    "   name='$name', value=$value, idx=$idx, ".
872
		    "   exptidx='$exptidx', pid='$pid', eid='$eid'")
873
874
875
876
877
	    or return -1;
    }
    else {
	DBQueryWarn("insert into virt_user_environment set ".
		    "   name='$name', value=$value, idx=NULL, ".
878
		    "   exptidx='$exptidx', pid='$pid', eid='$eid'")
879
880
	    or return -1;
    }
881
    
882
883
884
    return 0;
}

885
886
887
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
#
# Write the environment strings into a little script in the user directory.
#
sub WriteEnvVariables($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    my $query_result =
	DBQueryWarn("select name,value from virt_user_environment ".
		    "where  pid='$pid' and eid='$eid' order by idx");
    return -1
	if (!defined($query_result));

    my $userdir = $self->UserDir();
    my $envfile = "$userdir/tbdata/environment";

    if (!open(FP, "> $envfile")) {
	print "Could not open $envfile for writing: $!\n";
	return -1;
    }
    while (my ($name,$value) = $query_result->fetchrow_array()) {
	print FP "${name}=\"$value\"\n";
    }
    if (! close(FP)) {
	print "Could not close $envfile: $!\n";
	return -1;
    }
    
    return 0;
}

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
#
# Experiment locking and state changes.
#
sub Unlock($;$)
{
    my ($self, $newstate) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    my $sclause = (defined($newstate) ? ",state='$newstate' " : "");

    my $query_result =
	DBQueryWarn("update experiments set expt_locked=NULL $sclause ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return -1;
    }
    
    if (defined($newstate)) {
	$self->{'EXPT'}->{'state'} = $newstate;

	if ($EVENTSYS) {
	    EventSendWarn(objtype   => libdb::TBDB_TBEVENT_EXPTSTATE(),
			  objname   => "$pid/$eid",
			  eventtype => $newstate,
			  expt      => "$pid/$eid",
			  host      => $BOSSNODE);
	}
    }
    
    return 0;
}

962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
sub Lock(;$)
{
    my ($self, $newstate) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    my $sclause = (defined($newstate) ? ",state='$newstate' " : "");

    my $query_result =
	DBQueryWarn("update experiments set expt_locked=now() $sclause ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return -1;
    }
    
    if (defined($newstate)) {
	$self->{'EXPT'}->{'state'} = $newstate;

	if ($EVENTSYS) {
	    EventSendWarn(objtype   => libdb::TBDB_TBEVENT_EXPTSTATE(),
			  objname   => "$pid/$eid",
			  eventtype => $newstate,
			  expt      => "$pid/$eid",
			  host      => $BOSSNODE);
	}
    }
    return 0;
}

997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
sub SetState($$)
{
    my ($self, $newstate) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    my $query_result =
	DBQueryWarn("update experiments set state='$newstate' ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return -1;
    }
    
    if (defined($newstate)) {
	$self->{'EXPT'}->{'state'} = $newstate;

	if ($EVENTSYS) {
	    EventSendWarn(objtype   => libdb::TBDB_TBEVENT_EXPTSTATE(),
			  objname   => "$pid/$eid",
			  eventtype => $newstate,
			  expt      => "$pid/$eid",
			  host      => $BOSSNODE);
	}
    }
    
    return 0;
}

#
# Logfiles. This all needs to change.
#
# Open a new logfile and return its name.
#
sub CreateLogFile($$$)
{
    my ($self, $prefix, $pref) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    # Need to deal with errors.
    $$pref = TBExptCreateLogFile($pid, $eid, $prefix);
    return 0;
}

1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
#
# Set the experiments nsfiles table entry.
#
sub SetNSFile($$)
{
    my ($self, $nsfile) = @_;

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

    my $nsfile_string = `cat $nsfile`;
    return 0
	if (!$nsfile_string);

    my $pid = $self->pid();
    my $eid = $self->eid();
    my $idx = $self->idx();
    $nsfile_string = DBQuoteSpecial($nsfile_string);
    
    if (length($nsfile_string) >= DBLIMIT_NSFILESIZE()) {
	print "NS file is way too big!\n";
	return -1;
    }

    return -1    
	if (!DBQueryWarn("delete from nsfiles where exptidx='$idx'") ||
	    !DBQueryWarn("insert into nsfiles (exptidx, pid, eid, nsfile) ".
			 "values ($idx, '$pid', '$eid', $nsfile_string)"));

    return 0;
}

1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
#
# Set the experiment to use the logfile. It becomes the "current" spew.
#
sub SetLogFile($$)
{
    my ($self, $logname) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    TBExptSetLogFile($pid, $eid, $logname);    
    return 0;
}

#
# Mark the log as open so that the spew keeps looking for more output.
# 
sub OpenLogFile($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    TBExptOpenLogFile($pid, $eid);    
    return 0;
}

#
# And close it ...
#
sub CloseLogFile($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    TBExptCloseLogFile($pid, $eid);    
    return 0;
}

1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
#
# And clear it ...
#
sub ClearLogFile($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    TBExptClearLogFile($pid, $eid);    
    return 0;
}

1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
#
# Run scripts over an experiment.
#
sub PreRun($;$$)
{
    my ($self, $nsfile, $options) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
1171
    my $idx = $self->idx();
1172
1173
1174
1175
1176
1177

    $nsfile = ""
	if (!defined($nsfile));
    $options = ""
	if (!defined($options));

1178
1179
    print "Running 'tbprerun $options -e $idx $nsfile'\n";
    mysystem("$TBPRERUN $options -e $idx $nsfile");
1180
1181
1182
1183
1184
    return -1
	if ($?);
    return 0;
}

1185
1186
1187
1188
#
# Initialiaize bookkeeping for a swap operation.
#
sub PreSwap($$$)
1189
{
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
    my ($self, $swapper, $which) = @_;

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

    my $exptidx  = $self->idx();
    my $rsrcidx  = $self->rsrcidx();
    my $lastrsrc = $rsrcidx;
    my $uid_idx  = $swapper->uid_idx();
    # XXX state is no longer "active" for swapmod of active experiment.
    my $isactive = $self->swapin_time(); 

    #
    # We should never get here with a lastrsrc in the stats record; it
    # indicates something went wrong, and we need to clean up the DB
    # state by hand.
    #
    if ($self->lastrsrc()) {
	print STDERR "Inconsistent lastrsrc in stats record for $self!\n";
1210
1211
	# XXX
	$EXPT_RESOURCESHOSED = 1;
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
	return -1;
    }

    #
    # Generate a new resource record, but watch for the unused one that
    # we got when the experiment was first created.
    #
    if ($which eq $EXPT_SWAPMOD || $which eq $EXPT_SWAPIN) {
	#
	# In SWAPIN, copy over the thumbnail. This is temporary; I think
	# the thumbnail is going to end up going someplace else. 
	#
	my $thumbdata = (defined($self->thumbnail()) ?
			 DBQuoteSpecial($self->thumbnail()) : "NULL");
	my $byswapmod = ($which eq $EXPT_SWAPMOD ? 1 : 0);
	my $byswapin  = ($which eq $EXPT_SWAPIN  ? 1 : 0);

	my $query_result =
	    DBQueryWarn("insert into experiment_resources ".
			" (idx, uid_idx, tstamp, exptidx, lastidx, ".
			"  byswapmod, byswapin, thumbnail) ".
			"values (0, '$uid_idx', now(), $exptidx, $rsrcidx,".
			"        $byswapmod, $byswapin, $thumbdata)");
	return -1
	    if (! $query_result ||
		! $query_result->insertid);
	
	my $newrsrc = $query_result->insertid;
	
	DBQueryWarn("update experiment_stats set ".
		    "  rsrcidx=$newrsrc,lastrsrc=$rsrcidx ".
		    "where exptidx=$exptidx")
	    or goto failed;

	$self->Refresh() == 0
	    or goto failed;

	$rsrcidx = $newrsrc;
    }

    #
    # Update the timestamps in the current resource record to reflect
    # the official start of the operation.
    #
    if ($which eq $EXPT_SWAPIN) {
	DBQueryWarn("update experiment_resources set ".
		    "  swapin_time=UNIX_TIMESTAMP(now()) ".
		    "where idx='$rsrcidx'")
	    or goto failed;
    }
    elsif ($which eq $EXPT_SWAPOUT && ! $self->swapout_time()) {
	# Do not overwrite it; means a previously failed swapout, but for
	# accounting purposes, we want the original time.
	DBQueryWarn("update experiment_resources set ".
		    "  swapout_time=UNIX_TIMESTAMP(now()) ".
		    "where idx='$rsrcidx'")
	    or goto failed;
    }
    elsif ($which eq $EXPT_SWAPMOD && $isactive) {
	DBQueryWarn("update experiment_resources set ".
		    "  swapin_time=UNIX_TIMESTAMP(now()) ".
		    "where idx='$rsrcidx'")
	    or goto failed;
	#
	# If this swapmod fails, the record is deleted of course.
	# But if it succeeds, we will also change the previous record
	# to reflect the swapmod time. See PostSwap() below.
	#
    }

    # Old swap gathering stuff.
    $self->GatherSwapStats($swapper, $which, 0,
			   libdb::TBDB_STATS_FLAGS_START()) == 0
	or goto failed;

    # We do these here since even failed operations implies activity.
    # No worries if they fail; just informational.
    $swapper->BumpActivity();
    $self->GetProject()->BumpActivity();
    $self->GetGroup()->BumpActivity();
    return 0;

  failed:
    $self->SwapFail($which, 55);
    return -1;
}

#
# Rollback after a failed swap operation; cleans up the stats and resources.
#
sub SwapFail($$$$)
{
    my ($self, $swapper, $which, $ecode) = @_;

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

1310
1311
1312
1313
    # Do not proceed if we got here via a hosed resources record.
    return 0
	if ($EXPT_RESOURCESHOSED);

1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
    # Old swap gathering stuff.
    $self->GatherSwapStats($swapper, $which, $ecode);

    my $exptidx = $self->idx();
    my $session = libtblog::tblog_session();
    $session = 'NULL' unless defined $session;

    # This is pointless.
    DBQueryWarn("update experiment_stats set ".
		"  swap_errors=swap_errors+1, ".
		"  swap_exitcode=$ecode, ".
		"  last_error=$session ".
		"where exptidx=$exptidx");

    #
    # Get current and last rsrc record direct from DB to avoid local cache.
    #
    my $query_result =
	DBQueryWarn("select rsrcidx,lastrsrc from experiment_stats ".
		    "where exptidx=$exptidx");

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

    my ($rsrcidx, $lastrsrc) = $query_result->fetchrow_array();

    #
    # Special case; The first swapin does not get a new resource record,
    # and so there will be nothing to delete. So, clear the swapin time.
    # I think we can get rid of this special case, and also the case of
    # creating a new resource record when doing a swapmod to an inactive
    # experiment, but do not want to tackle that at this time
    #
    if (! $lastrsrc && $which eq $EXPT_SWAPIN) {
	DBQueryWarn("update experiment_resources set swapin_time=0 ".
		    "where idx='$rsrcidx'")
	or return -1;
    }
    
    return 0
	if (! $lastrsrc);

    #
    # If there is a lastrsrc record, it means the current one is bogus and
    # needs to be deleted, and the stats record repointed to the last one.
    # If this reset operation fails, lets be sure to set the timestamps in
    # the bogus resource record to 0 so that we have an indication that
    # something went wrong when we later traverse the chain of records. 
    #
    DBQueryWarn("update experiment_resources set ".
		"  swapin_time=0,swapmod_time=0,swapout_time=0 ".
		"where idx='$rsrcidx'")
	or return -1;

    if ($which eq $EXPT_SWAPMOD &&
	$self->state() eq libdb::EXPTSTATE_ACTIVE()) {
	DBQueryWarn("update experiment_resources set swapmod_time=0 ".
		    "where idx='$lastrsrc'")
	    or return -1;
    }

    DBQueryWarn("delete from experiment_resources ".
		"where idx=$rsrcidx")
	or return -1;

    #
    # This last step clears lastrsrc, which is how we know that the record
    # is consistent and that we can do another swap operation on it.
    #
    DBQueryWarn("update experiment_stats set ".
		"  rsrcidx=$lastrsrc,lastrsrc=NULL ".
		"where exptidx=$exptidx")
	or return -1;

    $self->Refresh();

    #
    # If we fail to clear the lastrsrc record, the next swap operation will
    # fail until the DB is cleaned up.
    #
    return 0;
}

#
# Finalize bookkeeping for a swap operation.
#
sub PostSwap($$$$)
{
    my ($self, $swapper, $which, $flags) = @_;

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

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

    # Old swap gathering stuff.
    $self->GatherSwapStats($swapper, $which, 0) == 0
	or return -1;

    #
    # On a swapout/modify complete, update the duration counters. We
    # want to update the aggregates too below, so get the numbers we
    # need for that first. Modify is a bit of a complication since we
    # want to charge for the experiment as it *was* until this point,
    # since the number of nodes has changed.
    #
    my $pnodes       = 0;
    my $vnodes       = 0;
    my $duration     = 0;
    my $prev_uid_idx = 0;
    my $prev_swapper = $swapper;

    if ($which eq $EXPT_SWAPOUT ||
	($which eq $EXPT_SWAPMOD &&
	 $self->state() eq libdb::EXPTSTATE_ACTIVE())) {
	my $query_result;
	
	#
	# If this is a swapout, we use the current resource record. If this
	# is a swapmod, we have to back to the previous resource record,
	# since the current one reflects usage for the new swap.
	#
	if ($which eq $EXPT_SWAPOUT) {
	    $query_result =
		DBQueryWarn("select r.pnodes,r.vnodes,r.uid_idx, ".
			    "  r.swapout_time - r.swapin_time ".
			    " from experiment_resources as r ".
			    "where r.idx='$rsrcidx'");
	}
	else {
	    $query_result =
		DBQueryWarn("select r.pnodes,r.vnodes,r.uid_idx, ".
			    "  r.swapmod_time - r.swapin_time ".
			    " from experiment_resources as r ".
			    "where r.idx='$rsrcidx'");
	}
	return -1
	    if (!$query_result);
	
	if ($query_result->numrows) {
	    ($pnodes,$vnodes,$prev_uid_idx,$duration) =
		$query_result->fetchrow_array;
	    # Might happen if swapin stats got losts.
	    $duration = 0
		if (! defined($duration));

	    $prev_swapper = User->Lookup($prev_uid_idx);
	    $prev_swapper = $swapper
		if (!defined($prev_swapper));
	}
    }

    if ($which eq $EXPT_SWAPMOD) {
	my $when = "UNIX_TIMESTAMP(now())";
	# unless its active, in which case pick up swapin time.
	$when = $self->swapin_time()
	    if ($self->state() eq libdb::EXPTSTATE_ACTIVE());
	
	DBQueryWarn("update experiment_resources set ".
		    "  swapmod_time=$when ".
		    "where idx='$lastrsrc'")
	    or return -1;
    }

    # Special case for initial record. Needs to be fixed.
    if ($which eq $EXPT_SWAPIN && !$self->lastidx()) {
	DBQueryWarn("update experiment_resources set byswapin=1 ".
		    "where idx='$rsrcidx'")
	    or return -1;
    }

    #
    # Increment idleswap indicator, but only valid on swapout. Harmless
    # if this fails, so do not worry about it.
    #
    if ($which eq $EXPT_SWAPOUT &&
	$flags & libdb::TBDB_STATS_FLAGS_IDLESWAP()) {
	DBQueryWarn("update experiment_stats ".
		    "set idle_swaps=idle_swaps+1 ".
		    "where exptidx=$exptidx");
    }

    #
    # On successful swapin, get the number of pnodes. assign_wrapper
    # has filled in everything else, but until the experiment actually
    # succeeds in swapping, do not set the pnode count. The intent
    # is to avoid counting experiments that ultimately fail as taking
    # up physical resources.
    #
    if ($which eq $EXPT_START ||
	$which eq $EXPT_SWAPIN ||
	$which eq $EXPT_SWAPMOD) {
	my $query_result =
	    DBQueryWarn("select r.node_id from reserved as r ".
			"left join nodes as n on r.node_id=n.node_id ".
			"where r.exptidx='$exptidx' and n.role='testnode'");

	return -1
	    if (! $query_result);

	$pnodes = $query_result->numrows;

	DBQueryWarn("update experiment_resources set pnodes=$pnodes ".
		    "where idx=$rsrcidx")
	    or return -1;
    }
    
    #
    # Per project/group/user aggregates. These can now be recalculated,
    # so if this fails, do not worry about it.
    #
    if ($which eq $EXPT_PRELOAD ||
	$which eq $EXPT_START ||
	$which eq $EXPT_SWAPOUT ||
	$which eq $EXPT_SWAPIN ||
	$which eq $EXPT_SWAPMOD) {
	$self->GetProject()->UpdateStats($which, $duration, $pnodes, $vnodes);
	$self->GetGroup()->UpdateStats($which, $duration, $pnodes, $vnodes);
	if ($which eq $EXPT_SWAPOUT ||
	    $which eq $EXPT_SWAPMOD) {
	    $prev_swapper->UpdateStats($which, $duration, $pnodes, $vnodes);
	}
	else {
	    $swapper->UpdateStats($which, 0, 0, 0);
	}

	#
	# Update the per-experiment record.
	# Note that we map start into swapin.
	#
	if ($which eq $EXPT_SWAPOUT ||
	    $which eq $EXPT_SWAPIN ||
	    $which eq $EXPT_START ||
	    $which eq $EXPT_SWAPMOD) {
	    my $tmp = $which;
	    if ($which eq $EXPT_START) {
		$tmp = $EXPT_SWAPIN;
	    }
	    DBQueryWarn("update experiment_stats ".
			"set ${tmp}_count=${tmp}_count+1, ".
			"    ${tmp}_last=now(), ".
			"    swapin_duration=swapin_duration+${duration}, ".
			"    swap_exitcode=0, ".
			"    last_error=NULL ".
			"where exptidx=$exptidx");
	}

	# Batch mode info.
	if ($which eq $EXPT_SWAPIN || $which eq $EXPT_START) {
	    my $batchmode = $self->batchmode();
	    
	    DBQueryWarn("update experiment_resources set ".
			"    batchmode=$batchmode ".
			"where idx=$rsrcidx");
	}
    }

    #
    # This last step clears lastrsrc, which is how we know that the record
    # is consistent and that we can do another swap operation on it.
    #
    DBQueryWarn("update experiment_stats set lastrsrc=NULL ".
		"where exptidx=$exptidx");
    
    $self->Refresh();
    
    return 0;
}

#
# Gather Stats. This is the original stats code, which has been partly
# replaced by the code above.
#
sub GatherSwapStats($$$;$$)
{
    my ($self, $user, $mode, $ecode, $flags) = @_;

    # Optional argument to modify the stats gathering.
    $flags = 0
	if (!defined($flags));
    $ecode = 0
	if (!defined($ecode));

    #
    # If this is a start time marker, then just record the time in a global
    # variable and return. This is cheezy, but the interface I'm providing
    # allows for fancier stuff later if desired.
    #
    if ($flags & libdb::TBDB_STATS_FLAGS_START()) {
	$EXPT_STARTCLOCK = time();
	return 0;
    }
    my $session = libtblog::tblog_session();
    $session = 'NULL' unless defined $session;

    my $exptidx   = $self->idx();
    my $rsrcidx   = $self->rsrcidx();
    my $uid       = $user->uid();
    my $uid_idx   = $user->uid_idx();
    my $starttime = (!defined($EXPT_STARTCLOCK) ? "NULL" :
		     "FROM_UNIXTIME($EXPT_STARTCLOCK)");

    #
    # Okay, Jay wants a log file but I am not crazy about that. Instead we
    # have a tiny table of testbed wide stats, which cross indexes with the
    # experiment_stats table via the idx field (which comes from the
    # experiments table of course). For each operation insert a record. We
    # can then construct a complete record of what happened from this
    # table, when correlated with experiment_stats. We could probably not
    # have an errorcode in experiment_stats, but since its a tinyint, not
    # worth worrying about.
    #
    DBQueryWarn("insert into testbed_stats ".
		"(idx, uid, uid_idx, start_time, end_time, exptidx, rsrcidx, ".
		" action, exitcode, log_session) ".
		"values (0, '$uid', '$uid_idx',  $starttime, now(), ".
		"        $exptidx, $rsrcidx, '$mode', $ecode, $session)")
	or return -1;

    return 0;
}

sub Swap($$;$$)
{
    my ($self, $which, $options, $flags) = @_;
1643
1644
1645
1646
1647
1648
1649

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

    my $pid = $self->pid();
    my $eid = $self->eid();
1650
1651
    my $idx = $self->idx();
    my $op;
1652
1653
1654
1655

    $options = ""
	if (!defined($options));

1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
    if ($which eq $EXPT_SWAPIN) {
	$op = "in";
    }
    elsif ($which eq $EXPT_SWAPOUT) {
	$op = "out";
    }
    elsif ($which eq $EXPT_SWAPMOD) {
	$op = "update";
    }

    print "Running 'tbswap $op $options $pid $eid'\n";
    mysystem("$TBSWAP $op $options $pid $eid");
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
    return -1
	if ($?);
    return 0;
}

sub End($;$)
{
    my ($self, $options) = @_;

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

1681
    my $exptidx = $self->idx();
1682
1683
1684
1685

    $options = ""
	if (!defined($options));

1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
    #
    # If the destroyed field is already set, leave it alone since it means
    # the operation failed the first time.
    #
    if (! defined($self->destroyed())) {
	DBQueryWarn("update experiment_stats set ".
		    "   destroyed=now() ".
		    "where exptidx=$exptidx")
	    or return -1;
	$self->Refresh() == 0
	    or return -1;
    }
    
    print "Running 'tbend $options -e $exptidx'\n";
    mysystem("$TBEND $options -e $exptidx");
1701
1702
    return -1
	if ($?);
1703

1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
    return 0;
}

sub Report($;$$)
{
    my ($self, $filename, $options) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    $options = ""
	if (!defined($options));

1721
    print "Running 'tbreport $options $pid $eid'\n";
1722
1723
1724
1725
1726
1727
1728
1729
1730
    mysystem("$TBREPORT $options $pid $eid 2>&1 > $filename");
    return -1
	if ($?);
    return 0;
}

#
# Return list of local nodes.
# 
1731
sub LocalNodeListNames($$)
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
{
    my ($self, $lref) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    @$lref = ExpNodes($pid, $eid, 1, 0);
    return 0;
}

1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
#
# Return list of experiment nodes (objects or just names)
# 
sub NodeList($;$)
{
    my ($self, $namesonly) = @_;
    my @nodenames = ();

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

    my $pid = $self->pid();
    my $eid = $self->eid();

    @nodenames = ExpNodes($pid, $eid);

    return @nodenames
	if (defined($namesonly) && $namesonly);

    my @nodes = ();

1768
1769
    foreach my $nodeid (@nodenames) {
	my $node = Node->Lookup($nodeid);
1770
	if (!defined($node)) {
1771
	    print STDERR "*** Could not map $nodeid to its object\n";
1772
1773
1774
1775
1776
1777
1778
	    return undef;
	}
	push(@nodes, $node);
    }
    return @nodes;
}

1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
#
# Copy log files to long term storage.
#
sub SaveLogFiles($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
1792
1793
1794
1795
1796
    my $workdir = $self->WorkDir();
    my $logdir  = TBExptLogDir($pid, $eid);

    # What the hell is this file! Very annoying.
    if (-e "$workdir/.rnd") {
1797
	mysystem("/bin/rm -f $workdir/.rnd");
1798
    }
1799
    mysystem("/bin/cp -Rpf $workdir/ $logdir");
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
    return 0;
}

#
# Remove old logfiles from the wordir.
#
sub CleanLogFiles($)
{
    my ($self) = @_;

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

    my $workdir = $self->WorkDir();
    
1816
1817
1818
1819
1820
1821
1822
    opendir(DIR, $workdir) or
	return -1;
    my @files   = readdir(DIR);
    my @delete  = ();
    closedir(DIR);

    foreach my $file (@files) {
1823
1824
1825
1826
	# Just in case ...
	next
	    if ($file =~ /^.*\.ns$/);
	
1827
1828
1829
1830
1831
	push(@delete, "${workdir}/$1")
	    if ($file =~ /^(.*\.(log|ptop|top|assign))$/);

	push(@delete, "${workdir}/$1")
	    if ($file =~ /^((swap|start|cancel|newrun).*\..*)$/);
1832
    }
1833
    mysystem("/bin/rm -f @delete") == 0
1834
	or return -1;
1835
1836
1837
1838
1839
1840
1841

    return 0;
}

#
# Copy log files to user visible space. Maybe not such a good idea anymore?
#
1842
sub CopyLogFiles($;@)
1843
{
1844
    my ($self, @files) = @_;
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    my $workdir = $self->WorkDir();
    my $userdir = $self->UserDir();

1855
1856
1857
1858
1859
1860
    # Specific files, then return.
    if (@files) {
	mysystem("/bin/cp -fp @files $userdir/tbdata");
	return 0;
    }

1861
1862
    opendir(DIR, $workdir) or
	return -1;
1863
    @files  = readdir(DIR);
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
    closedir(DIR);
    my @copy   = ();

    foreach my $file (@files) {
	push(@copy, "${workdir}/$1")
	    if ($file =~ /^(.*\.(log|report|ns|png))$/);
    }

    mysystem("/bin/cp -fp @copy $userdir/tbdata");
    return 0;
}

#
# Backup the user directory for debugging. 
#
sub BackupUserData($)
{
    my ($self) = @_;
    
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $userdir = $self->UserDir();
    my $path    = dirname($userdir);
    my $dir     = basename($userdir);
    my $backup  = "${path}/.${dir}-failed";

    if (-e $backup) {
	mysystem("/bin/rm -rf $backup");
    }
    mysystem("/bin/mv $userdir $backup");
1896
1897
1898
1899
1900
1901
1902
1903
    return 0;
}

#
# Swapinfo accounting stuff.
#
sub SetSwapInfo($$)
{
1904
    my ($self, $user) = @_;
1905
1906
1907
1908
1909
1910
1911
1912
1913

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    
    TBSetExpSwapTime($pid, $eid);
1914
    $self->SetSwapper($user);
1915
1916
1917
    return $self->Refresh();
}

1918
#
1919
# Just the swap uid.
1920
1921
1922
#
sub SetSwapper($$)
{
1923
    my ($self, $user) = @_;
1924
1925
1926
1927
1928

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

1929
1930
1931
1932
1933
1934
1935
1936
1937
    my $pid  = $self->pid();
    my $eid  = $self->eid();
    my $uid  = $user->uid();
    my $dbid = $user->dbid();

    DBQueryWarn("update experiments set ".
		"   expt_swap_uid='$uid', swapper_idx='$dbid' ".
		"where pid='$pid' and eid='$eid'");

1938
1939
1940
    return $self->Refresh();
}

1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
#
# Get swapper (user) object.
#
sub GetSwapper($)
{
    my ($self) = @_;

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

    return User->Lookup($self->swapper_idx());
}

1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
#
# Just the swap time.
#
sub SetSwapTime($)
{
    my ($self) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    
    TBSetExpSwapTime($pid, $eid);
    return 0;
}

1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
#
# Set the cancel flag.
#
sub SetCancelFlag($$)
{
    my ($self, $flag) = @_;

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

    my $pid = $self->pid();
    my $eid = $self->eid();
    
    TBSetCancelFlag($pid, $eid, $flag);
    return $self->Refresh();
}

1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111