Experiment.pm.in 116 KB
Newer Older
1
2
3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2005-2011 University of Utah and the Flux Group.
5
6
7
8
9
10
# All rights reserved.
#
package Experiment;

use strict;
use Exporter;
11
use SelfLoader ();
12
use vars qw(@ISA @EXPORT $AUTOLOAD);
13
@ISA    = qw(Exporter SelfLoader);
14
15
16
@EXPORT = qw ( );

use libdb;
17
use EmulabConstants;
18
use libtestbed;
19
use Node;
20
use Logfile;
21
22
use English;
use Data::Dumper;
23
use File::Basename;
24
use overload ('""' => 'Stringify');
25
use libtblog_simple;
26

27
use vars qw($EXPT_PRELOAD $EXPT_START $EXPT_SWAPIN $EXPT_SWAPUPDATE
28
	    $EXPT_SWAPOUT $EXPT_SWAPMOD %physicalTables @virtualTables
29
	    $EXPT_FLAGS_NAMESONLY $EXPT_FLAGS_INCLUDEVIRT
30
31
	    $EXPT_FLAGS_LOCALONLY
	    $EXPT_GENIFLAGS_EXPT $EXPT_GENIFLAGS_COOKED
32
33
34
35
36
37
38
	    @nodetable_fields %experiments
	    $EXPT_STARTCLOCK $EXPT_RESOURCESHOSED
	    @EXPORT_OK
	    $TB $BOSSNODE $CONTROL $TBOPS $PROJROOT $STAMPS $TBBASE  
	    $TEVC $DBCONTROL $RSYNC $MKEXPDIR $TBPRERUN $TBSWAP   
	    $TBREPORT $TBEND $DU $MD5);
	  
39
# Configure variables
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
$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

    # A DB row proxy method call.
    if (exists($self->{'EXPT'}->{$name})) {
	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;
}
84

85
86
87
88
89
90
# 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();
91
$EXPT_SWAPUPDATE	= TBDB_STATS_SWAPUPDATE();
92

93
94
95
96
97
# Other flags.
$EXPT_FLAGS_LOCALONLY   = 0x01;
$EXPT_FLAGS_NAMESONLY   = 0x02;
$EXPT_FLAGS_INCLUDEVIRT = 0x04;

98
99
100
$EXPT_GENIFLAGS_EXPT    = 0x01;
$EXPT_GENIFLAGS_COOKED  = 0x02;

101
# For stats gathering code.
102
103
$EXPT_STARTCLOCK        = undef;
$EXPT_RESOURCESHOSED    = 0;
104
105

# Why, why, why?
106
107
@EXPORT_OK = qw($EXPT_PRELOAD $EXPT_START $EXPT_SWAPUPDATE
		$EXPT_SWAPIN $EXPT_SWAPOUT $EXPT_SWAPMOD
108
		$EXPT_GENIFLAGS_EXPT $EXPT_GENIFLAGS_COOKED
109
		%physicalTables  @virtualTables);
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

#
# 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",
		   "virt_node_desires",
		   "virt_node_startloc",
		   "virt_simnode_attributes",
		   "virt_user_environment",
		   "virt_parameters",
129
		   "virt_paths",
130
131
132
133
134
135
136
137
138
		   # 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",
139
		   "elabinelab_attributes",
140
		   "virt_tiptunnels",
141
142
143
144
145
		   "ipsubnets",
		   "virt_blobs",
		   "virt_client_service_ctl",
		   "virt_client_service_hooks",
		   "virt_client_service_opts");
146

147
148
149
150
%physicalTables = ("delays"     => ["node_id", "vname", "vnode0", "vnode1"],
		   "ipport_ranges" => undef,
		   "v2pmap"        => ["node_id", "vname"],
		   "linkdelays"    => ["node_id", "vlan", "vnode"],
151
		   "traces"        => ["node_id", "idx"],
152
153
		   "portmap"       => undef,
		   "bridges"       => ["node_id", "bridx", "iface"]); 
154
155

# These are slots in the node table that need to be restored. 
156
@nodetable_fields = ("def_boot_osid",
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
			"def_boot_path",
			"def_boot_cmd_line",
			"temp_boot_osid",
			"next_boot_osid",
			"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");
184

185
# Cache of instances to avoid regenerating them.
186
%experiments   = ();
187
188
189
190
191
192

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

193
194
195
196
197
    if (0) {
	my $cwd;
	chomp($cwd = `/bin/pwd`);
	print STDERR "Running '$command' in $cwd\n";
    }
198
199
200
201
202
203
    return system($command);
}

#
# Lookup an experiment and create a class instance to return.
#
204
sub Lookup($$;$)
205
{
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    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;
	}
221
222
223
224
225
226
227
228
229
230
	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();
	}
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
	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();
    }
252
253

    # Look in cache first
254
255
    return $experiments{"$idx"}
        if (exists($experiments{"$idx"}));
256
257
    
    my $query_result =
258
259
260
	DBQueryWarn("select e.*,i.parent_guid,t.guid from experiments as e ".
		    "left join experiment_templates as t on ".
		    "     t.exptidx=e.idx ".
261
262
263
		    "left join experiment_template_instances as i on ".
		    "     i.exptidx=e.idx ".
		    "where e.idx='$idx'");
264
265
266
267
268
269

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

    my $self         = {};
    $self->{'EXPT'}  = $query_result->fetchrow_hashref();
270
271
    # An Instance?
    $self->{'ISINSTANCE'} = defined($self->{'EXPT'}->{'parent_guid'});
272
273
    # The experiment underlying a template.
    $self->{'ISTEMPLATE'} = defined($self->{'EXPT'}->{'guid'});
274
275
276
277
278
279
280
281
282

    $query_result =
	DBQueryWarn("select * from experiment_stats where exptidx='$idx'");
	
    return undef
	if (!$query_result || !$query_result->numrows);
    
    $self->{'STATS'} = $query_result->fetchrow_hashref();
    
283
284
285
286
287
288
    my $rsrcidx = $self->{'STATS'}->{'rsrcidx'};

    $query_result =
	DBQueryWarn("select * from experiment_resources ".
		    "where idx='$rsrcidx'");
	
Leigh B. Stoller's avatar
Leigh B. Stoller committed
289
    return undef
290
291
292
	if (!$query_result || !$query_result->numrows);
    
    $self->{'RSRC'} = $query_result->fetchrow_hashref();
293

294
295
296
    # Virt Experiment; load lazy.
    $self->{'VIRTEXPT'} = undef;

297
298
299
    bless($self, $class);
    
    # Add to cache. 
300
    $experiments{"$idx"} = $self;
301
302
303
    
    return $self;
}
304

305
306
# Break circular reference someplace to avoid exit errors.
sub DESTROY {
307
308
    my $self = shift;

309
310
311
312
313
    $self->{"EXPT"}     = undef;
    $self->{"STATS"}    = undef;
    $self->{"RSRC"}     = undef;
    $self->{'VIRTEXPT'} = undef;
}
314

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
#
# 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]";
342
}
343
344
345
# 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(); }
346
347

1;
348
@SELFLOADER_DATA@
349

350
sub dbrow($$)     { return $_[0]->{'EXPT'}; }
351
sub locked($)     { return $_[0]->expt_locked(); }
352
353
354
355
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(); }
356

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
#
# For canceled, goto to the DB.
#
sub canceled($)
{
    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;
}

378
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
379
# Lookup an experiment given an experiment index.
380
381
382
383
384
#
sub LookupByIndex($$)
{
    my ($class, $exptidx) = @_;

385
    return Experiment->Lookup($exptidx);
386
387
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
#
# 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();
}

402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
#
# 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;
}

424
425
426
427
428
429
430
431
432
433
434
#
# 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
435
436
		    "where creator_idx='$uid_idx' or ".
		    "      (swapper_idx='$uid_idx' and ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
437
		    "       state!='" . EXPTSTATE_SWAPPED() . "')");
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
    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;
}

455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# 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();
}

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
#
# 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";
487
    $spec .= ", experiment_resources read";
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
    
    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;
}

507
508
509
510
511
512
#
# 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($$$$)
{
513
    my ($class, $group, $eid, $argref) = @_;
514
    my $exptidx;
515
    my $uuid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
516
    my $now = time();
517
518

    return undef
519
520
521
522
523
524
	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();
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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

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

617
    # And a UUID (universally unique identifier).
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
    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;
	}
635
636
    }

637
638
639
640
    #
    # Lets be real sure that the UUID is really unique.
    #
    $query_result =
641
	DBQueryWarn("select pid,eid from experiments ".
642
643
644
645
646
647
648
649
650
651
652
653
		    "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;
    }

654
655
656
657
658
659
660
661
662
663
664
665
    #
    # 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
666
667
668
669
    # we override this below
    delete($argref->{'idx'})
	if (exists($argref->{'idx'}));

670
671
672
673
    my $query = "insert into experiments set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    # Append the rest
Leigh B. Stoller's avatar
Leigh B. Stoller committed
674
    $query .= ",expt_created=FROM_UNIXTIME('$now')";
675
    $query .= ",expt_locked=now(),pid='$pid',eid='$eid',eid_uuid='$uuid'";
676
    $query .= ",pid_idx='$pid_idx',gid='$gid',gid_idx='$gid_idx'";
677
678
679
    $query .= ",expt_name=$description";
    $query .= ",noswap_reason=$noswap_reason";
    $query .= ",noidleswap_reason=$noidleswap_reason";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
680
    $query .= ",idx=$exptidx";
681
682
683
684
685
686
687

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

688
689
690
691
    my $creator_uid = $argref->{'expt_head_uid'};
    my $creator_idx = $argref->{'creator_idx'};
    my $batchmode   = $argref->{'batchmode'};

692
693
694
695
    #
    # Create an experiment_resources record for the above record.
    #
    $query_result =
696
697
698
	DBQueryWarn("insert into experiment_resources ".
		    "(tstamp, exptidx, uid_idx) ".
		    "values (FROM_UNIXTIME('$now'), $exptidx, $creator_idx)");
699
700
701
702
703
704
705

    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;
    }
706
    my $rsrcidx     = $query_result->insertid;
707
    
708
709
710
711
    #
    # Now create an experiment_stats record to match.
    #
    if (! DBQueryWarn("insert into experiment_stats ".
712
		      "(eid, pid, creator, creator_idx, gid, created, ".
713
714
		      " batch, exptidx, rsrcidx, pid_idx, gid_idx, eid_uuid, ".
		      " last_activity) ".
715
716
		      "values('$eid', '$pid', '$creator_uid', '$creator_idx',".
		      "       '$gid', FROM_UNIXTIME('$now'), ".
717
		      "        $batchmode, $exptidx, $rsrcidx, ".
718
719
		      "        $pid_idx, $gid_idx, '$uuid', ".
		      "        FROM_UNIXTIME('$now'))")) {
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
	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));

752
753
754
    my $pid     = $self->pid();
    my $eid     = $self->eid();
    my $exptidx = $self->idx();
755
756
    my $workdir = $self->WorkDir();
    my $userdir = $self->UserDir();
757
758
759
760

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

761
762
    $self->UnBindNonLocalUsers();

763
764
765
766
767
768
769
770
771
772
773
    #
    # 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";
774

775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
	# 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",
			     "Could not remove $userdir.\n".
			     "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);
    }
792
793
794
795
    my $logfile = $self->GetLogFile();
    if (defined($logfile)) {
	$logfile->Delete();
    }
796
797
798
799
    libArchive::TBDeleteExperimentArchive($pid, $eid);

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

801
802
803
    # Delete from cache. 
    delete($experiments{"$exptidx"});

804
805
806
807
808
809
810
811
812
    #
    # 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();
    }
813
    return 0
814
815
816
	if (! $purge);
    
    #
817
    # Now we can clean up the stats and resource records. 
818
819
    #
    my $rsrcidx = $self->rsrcidx();
820
821
822
823
824
825
826

    $self->DeleteInputFiles();

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

827
    DBQueryWarn("DELETE from experiment_resources ".
828
		"WHERE idx=$rsrcidx")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
829
	if (defined($rsrcidx) && $rsrcidx);
830

831
832
833
834
835
836
837
838
839
840
    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;
}

841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
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
923
924
925
#
# 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",
926
			       "input_data_idx='$input_data_idx'",
Leigh B. Stoller's avatar
Leigh B. Stoller committed
927
			       "idx='$rsrcidx'") != 0) {
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
973
974
975
976
977
978
979
980
981
982
	    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;

    #
    # Get all input files for this rsrc record.
    #
    my $query_result =
	DBQueryWarn("select input_data_idx from experiment_inputs ".
		    "where rsrcidx='$rsrcidx'");
    goto bad
	if (! $query_result);
    goto done
	if (! $query_result->numrows);

    while (my ($input_data_idx) = $query_result->fetchrow_array()) {
	#
	# Delete but only if not in use.
	#
	my $query_result =
	    DBQueryWarn("select count(rsrcidx) from experiment_inputs ".
			"where input_data_idx='$input_data_idx' and ".
			"      rsrcidx!='$rsrcidx'");
	goto bad
	    if (! $query_result);

	DBQueryWarn("delete from experiment_inputs ".
		    "where input_data_idx='$input_data_idx'")
	    or goto bad;

	if (defined($nsidx) && $nsidx == $input_data_idx) {
	    DBQueryWarn("update experiment_resources set input_data_idx=NULL ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
983
			"where idx='$rsrcidx'")
984
985
		or goto bad;
	}
986
987
988
989
990
991
	next
	    if ($query_result->numrows);

	DBQueryWarn("delete from experiment_input_data ".
		    "where idx='$input_data_idx'")
	    or goto bad;
992
993
994
995
996
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
    }
  done:
    DBQueryWarn("unlock tables");
    return 0;

  bad:
    DBQueryWarn("unlock tables");
    return 1;
}

#
# Grab an input file.
#
sub GetInputFile($$$)
{
    my ($self, $idx, $pref) = @_;

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

    my $query_result =
	DBQueryWarn("select input from experiment_input_data ".
		    "where idx='$idx'");
    return -1
	if (! $query_result || !$query_result->numrows);

    my ($nsfile) = $query_result->fetchrow_array();
    $$pref = $nsfile;
    return 0;
}

1024
1025
1026
1027
1028
1029
#
# Get the virt experiment object;
#
sub GetVirtExperiment($)
{
    my ($self) = @_;
1030
    require VirtExperiment;
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048

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

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

    require VirtExperiment;

    my $virtexperiment = VirtExperiment->Lookup($self);
    if (!defined($virtexperiment)) {
	print STDERR "*** Could not get virtual experiment object for $self\n";
	return undef;
    }
    $self->{'VIRTEXPT'} = $virtexperiment;
    return $virtexperiment;
}

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

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

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

1061
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1062
	DBQueryWarn("select * from experiments where idx=$idx");
1063
1064
1065
1066

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

1067
    $self->{'EXPT'}       = $query_result->fetchrow_hashref();
1068
    $self->{'VIRTEXPT'}   = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1069
1070
    $self->{'ISINSTANCE'} = undef;
    $self->{'ISTEMPLATE'} = undef;
1071
1072
1073
1074
1075
1076
1077
1078
1079

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

1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
    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();
1090
1091
1092
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
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
#
# 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);
}

1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
#
# Worker class method to change experiment info.
# Assumes most argument checking was done elsewhere.
#
sub EditExp($$$$$$)
{
    my ($class, $experiment, $user, $doemail, $argref, $usrerr_ref) = @_;

    my %mods;
    my $noreport;
    my %updates;

    #
    # Converting the batchmode is tricky, but we can let the DB take care
    # of it by requiring that the experiment not be locked, and it be in
    # the swapped state. If the query fails, we know that the experiment
    # was in transition.
    #
1136
1137

    if (exists($argref->{"batchmode"}) && $experiment->batchmode() != $argref->{"batchmode"}) {
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
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
	my $success  = 0;

	my $batchmode;
	if ($argref->{"batchmode"} ne "1") {
	    $batchmode = 0;
	    $argref->{"batchmode"} = 0;
	}
	else {
	    $batchmode = 1;
	    $argref->{"batchmode"} = 1;
	}

	if ($experiment->SetBatchMode($batchmode) != 0) {
	    $$usrerr_ref = "Batch Mode: Experiment is running or in transition; ".
		"try again later";
	    return undef;
	}
	$mods{"batchmode"} = $batchmode;
    }

    #
    # Now update the rest of the information in the DB.
    #

    # Name change for experiment description.
    if (exists($argref->{"description"})) {
	$updates{"expt_name"} = ($mods{"description"} = $argref->{"description"});
    }

    # Note that timeouts are in hours in the UI, but in minutes in the DB. 
    if (exists($argref->{"idleswap_timeout"})) {
	$updates{"idleswap_timeout"} = 60 * 
	    ($mods{"idleswap_timeout"} = $argref->{"idleswap_timeout"});
    }
    if (exists($argref->{"autoswap_timeout"})) {
	$updates{"autoswap_timeout"} = 60 * 
	    ($mods{"autoswap_timeout"} = $argref->{"autoswap_timeout"});
    }

    foreach my $col ("idle_ignore", "swappable", "noswap_reason",
		     "idleswap", "noidleswap_reason", "autoswap", "savedisk",
		     "cpu_usage", "mem_usage", "linktest_level") {
	# Copy args we want so that others can't get through.
	if (exists($argref->{$col})) {
	    $updates{$col} = $mods{$col} = $argref->{$col};
	}
    }

    # Save state before change for the email message below.
    my $olds = ($experiment->swappable() ? "Yes" : "No");
    my $oldsr= $experiment->noswap_reason();
    my $oldi = ($experiment->idleswap() ? "Yes" : "No");
    my $oldit= $experiment->idleswap_timeout() / 60.0;
    my $oldir= $experiment->noidleswap_reason();
    my $olda = ($experiment->autoswap() ? "Yes" : "No");
    my $oldat= $experiment->autoswap_timeout() / 60.0;

    if (keys %updates) {
	if ($experiment->Update(\%updates)) {
	    return undef;
	}
    }

    my $creator = $experiment->creator();
    my $swapper = $experiment->swapper();
    my $uid = $user->uid();
    my $pid = $experiment->pid();
    my $eid = $experiment->eid();

    if (!keys %mods) {
	if (!$noreport) {
	    # Warn the user that the submit button was pressed with no effect.
	    $$usrerr_ref = "Submit: Nothing changed";
	    return undef;
	}
    }
    # Do not send this email if the user is an administrator
    # (adminmode does not matter), and is changing an expt he created
    # or swapped in. Pointless email.
    elsif ( $doemail &&
	     ! ($user->admin() &&
		($uid eq $creator || $uid eq $swapper)) ) {

	# Send an audit e-mail reporting what is being changed.
	my $target_creator = $experiment->GetCreator();
	my $target_swapper = $experiment->GetSwapper();

	my $user_name  = $user->name();
	my $user_email = $user->email();
	my $cname      = $target_creator->name();
	my $cemail     = $target_creator->email();
	my $sname      = $target_swapper->name();
	my $semail     = $target_swapper->email();

	my $s    = ($experiment->swappable() ? "Yes" : "No");
	my $sr   = $experiment->noswap_reason();
	my $i    = ($experiment->idleswap() ? "Yes" : "No");
	my $it   = $experiment->idleswap_timeout() / 60.0;
	my $ir   = $experiment->noidleswap_reason();
	my $a    = ($experiment->autoswap() ? "Yes" : "No");
	my $at   = $experiment->autoswap_timeout() / 60.0;

	my $msg = "\n".
	    "The swap settings for $pid/$eid have changed\n".
	    "\nThe old settings were:\n".
	    "Swappable:\t$olds\t($oldsr)\n".
	    "Idleswap:\t$oldi\t(after $oldit hrs)\t($oldir)\n".
	    "MaxDuration:\t$olda\t(after $oldat hrs)\n".
	    "\nThe new settings are:\n".
	    "Swappable:\t$s\t($sr)\n".
	    "Idleswap:\t$i\t(after $it hrs)\t($ir)\n".
	    "MaxDuration:\t$a\t(after $at hrs)\n".
	    "\nCreator:\t$creator ($cname <$cemail>)\n".
	    "Swapper:\t$swapper ($sname <$semail>)\n".
            "\nDifferences were:\n";
	my @report = 
	    ("Description:description", "Idle Ignore:idle_ignore",
	     "Swappable:swappable", "Noswap Reason:noswap_reason",
	     "Idleswap:idleswap", "Idleswap Timeout:idleswap_timeout",
	     "Noidleswap Reason:noidleswap_reason", "Autoswap:autoswap",
	     "Autoswap timeout:autoswap_timeout", "Savedisk:savedisk",
	     "Cpu Usage:cpu_usage", "Mem Usage:mem_usage",
	     "Batch Mode:batchmode", "Linktest Level:linktest_level");
	foreach my $line (@report) {
	    my ($label, $field) = split /:/, $line;
	    if (exists($mods{$field})) {
		$msg .= sprintf "%-20s%s\n", $label .":", $mods{$field};
	    }
	}
	$msg .= "\n".
	   "\nIf it is necessary to change these settings, ".
	   "please reply to this message \nto notify the user, ".
	   "then change the settings here:\n\n".
	   "$TBBASE/showexp.php3?pid=$pid&eid=$eid\n\n".
	   "Thanks,\nTestbed WWW\n";

	SENDMAIL("$user_name <$user_email>",
		 "$pid/$eid swap settings changed",
		 $msg, TBMAIL_OPS(), sprintf("Bcc: %s\nErrors-To:%s", 
					     TBMAIL_AUDIT(), TBMAIL_WWW()));
    }
    return 1;
}

sub SetBatchMode($$) {
    my ($self, $mode) = @_;

    my $reqstate = EXPTSTATE_SWAPPED();
    my $idx      = $self->idx();
    $mode        = ($mode ? 1 : 0);

    DBQueryFatal("lock tables experiments write");

    my $query_result =
	DBQueryFatal("update experiments set ".
		     "   batchmode=$mode ".
		     "where idx='$idx' and ".
		     "     expt_locked is NULL and state='$reqstate'");

    my $success = $query_result->numrows;    # XXX Was DBAffectedRows().
Russ Fish's avatar
Russ Fish committed
1298
    DBQueryFatal("unlock tables");
1299
1300
1301
1302

    return ($success ? 0 : -1);
}

1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
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
#
# 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;
}

1358
#
1359
1360
# Check permissions. Allow for either uid or a user ref until all code
# updated.
1361
1362
1363
#
sub AccessCheck($$$)
{
1364
    my ($self, $user, $access_type) = @_;
1365
1366

    # Must be a real reference. 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1367
    return 0
1368
1369
	if (! ref($self));

1370
1371
    if ($access_type < TB_EXPT_MIN() ||
	$access_type > TB_EXPT_MAX()) {
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
	die("*** Invalid access type: $access_type!");
    }

    # Admins do whatever they want.
    return 1
	if ($user->IsAdmin());

    my $group = $self->GetGroup();
    return 0
	if (!defined($group));
    my $project = $self->GetProject();
    return 0
	if (!defined($project));

    #
    # An experiment may be destroyed by the experiment creator or the
    # project/group leader.
    #
    my $mintrust;
    
1392
1393
    if ($access_type == TB_EXPT_READINFO()) {
	$mintrust = PROJMEMBERTRUST_USER();
1394
1395
    }
    else {
1396
	$mintrust = PROJMEMBERTRUST_LOCALROOT();
1397
    }
1398

1399
1400
1401
1402
1403
1404
    #
    # Either proper permission in the group, or group_root in the project.
    # This lets group_roots muck with other people's experiments, including
    # those in groups they do not belong to.
    #
    return TBMinTrust($group->Trust($user), $mintrust) ||
1405
	TBMinTrust($project->Trust($user), PROJMEMBERTRUST_GROUPROOT());
1406
1407
}

1408
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1409
1410
1411
1412
# 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.
1413
1414
1415
1416
1417
1418
1419
1420
1421
#
sub CreateDirectory($)
{
    my ($self) = @_;

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

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

1424
    mysystem("$MKEXPDIR $idx");
1425
1426
1427
1428
1429
1430
    return -1
	if ($?);
    # mkexpdir sets the path in the DB. 
    return Refresh($self)
}

1431
1432
1433
1434
1435
1436
#
# Load the project object for an experiment.
#
sub GetProject($)
{
    my ($self) = @_;
1437
    require Project;
1438
1439

    # Must be a real reference. 
1440
    return undef
1441
1442
1443
1444
1445
	if (! ref($self));

    my $project = Project->Lookup($self->pid_idx());
    
    if (! defined($project)) {
1446
	print("*** WARNING: Could not lookup project object for $self!\n");
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
	return undef;
    }
    return $project;
}

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

    # Must be a real reference. 
1461
    return undef
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
	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;
}

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
#
# 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();
}
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
# Long term storage.
sub InfoDir($$)
{
    my ($self) = @_;

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

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

    return "$TB/expinfo/$pid/$eid/$idx";
}
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538

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

1539
1540
1541
#
# Add an environment variable.
#
1542
sub AddEnvVariable($$$;$)
1543
{
1544
    my ($self, $name, $value, $index) = @_;
1545
1546
1547
1548
1549
1550
1551

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

    my $pid = $self->pid();
    my $eid = $self->eid();
1552
    my $exptidx = $self->idx();
1553

1554
1555
1556
1557
1558
1559
1560
    if (defined($value)) {
	$value = DBQuoteSpecial($value);
    }
    else {
	$value = "''";
    }

1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
    #
    # 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, ".
1579
		    "   exptidx='$exptidx', pid='$pid', eid='$eid'")
1580
1581
1582
1583
1584
	    or return -1;
    }
    else {
	DBQueryWarn("insert into virt_user_environment set ".
		    "   name='$name', value=$value, idx=NULL, ".
1585
		    "   exptidx='$exptidx', pid='$pid', eid='$eid'")
1586
1587
	    or return -1;
    }
1588
    
1589
1590
1591
    return 0;
}

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

1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
#
# Get value of a specific env variable
#
sub GetEnvVariable($$)
{
    my ($self, $var) = @_;

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

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

    my $query_result =
	DBQueryWarn("select value from virt_user_environment ".
		    "where  pid='$pid' and eid='$eid' and name='$var'");
    return undef
	if (!defined($query_result) || !$query_result->numrows);

    my ($value) = $query_result->fetchrow_array();
    return $value;
}

1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
#
# 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)) {
1679
1680
	require event;
	
1681
1682
	$self->{'EXPT'}->{'state'} = $newstate;

1683
1684
1685
1686
1687
	event::EventSendWarn(objtype   => TBDB_TBEVENT_EXPTSTATE(),
			     objname   => "$pid/$eid",
			     eventtype => $newstate,
			     expt      => "$pid/$eid",
			     host      => $BOSSNODE);
1688
1689
1690
1691
1692
    }
    
    return 0;
}

1693
sub Lock(;$$)
1694
{
1695
    my ($self, $newstate, $unlocktables) = @_;
1696
1697
1698
1699
1700
1701
1702
1703
1704

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

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

1705
1706
1707
1708
    # flag to indicate tables should be unlocked. 
    $unlocktables = 0
	if (!defined($unlocktables));

1709
1710
1711
1712
1713
1714
    my $query_result =
	DBQueryWarn("update experiments set expt_locked=now() $sclause ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
1715
1716
	$self->UnLockTables()
	    if ($unlocktables);
1717
1718
	return -1;
    }
1719
1720
1721
1722
1723
1724
1725

    #
    # We do this before calling out to the event system to avoid livelock
    # in case the event system goes down.
    #
    $self->UnLockTables()
	if ($unlocktables);
1726
1727
    
    if (defined($newstate)) {
1728
1729
	require event;
	
1730
1731
	$self->{'EXPT'}->{'state'} = $newstate;

1732
1733
1734
1735
1736
	event::EventSendWarn(objtype   => TBDB_TBEVENT_EXPTSTATE(),
			     objname   => "$pid/$eid",
			     eventtype => $newstate,
			     expt      => "$pid/$eid",
			     host      => $BOSSNODE);
1737
1738
1739
1740
    }
    return 0;
}

1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
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)) {
1762
1763
	require event;
	
1764
1765
	$self->{'EXPT'}->{'state'} = $newstate;

1766
1767
1768
1769
1770
	event::EventSendWarn(objtype   => TBDB_TBEVENT_EXPTSTATE(),
			     objname   => "$pid/$eid",
			     eventtype => $newstate,
			     expt      => "$pid/$eid",
			     host      => $BOSSNODE);
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
    }
    
    return 0;
}

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

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

1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
    my $pid      = $self->pid();
    my $eid      = $self->eid();
    my $gid_idx  = $self->gid_idx();
    my $logdir   = $self->WorkDir();
    my $linkname = "$logdir/${prefix}.log";
    my $logname  = `mktemp $logdir/${prefix}.XXXXXX`;
    return undef
	if ($?);
    
    # Untaint to avoid silly warnings
    if ($logname =~ /^([-\w\.\/]+)$/) {
	$logname = $1;
    }
    else {
	print STDERR "Bad data in filename: $logname\n";
	return undef;
    }
1806

1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
    # Create a Logfile.
    my $logfile = Logfile->Create($gid_idx, $logname);
    if (!defined($logfile)) {
	unlink($logname);
	return undef;
    }
    # This is untainted.
    $logname = $logfile->filename();

    # So tbops people can read the files ...
    if (!chmod(0664, $logname)) {
	print STDERR "Could not chmod $logname to 0644: $!\n";
	$logfile->Delete();
	unlink($logname);
	return undef;
    }

    # Link it to $prefix.log so that the most recent is well known.
    if (-e $linkname) {
	unlink($linkname);
    }
    if (! link($logname, $linkname)) {
	print STDERR "CreateLogFile: Cannot link $logname,$linkname: $!\n";
	$logfile->Delete();
	unlink($logname);
	return undef;
    }
    return $logfile;
1835
1836
}

1837
#
1838
# Set the experiments NS file using AddInputFile() above
1839
1840
1841
1842
1843
1844
1845
1846
1847
#
sub SetNSFile($$)
{
    my ($self, $nsfile) = @_;

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

1848
1849
    return $self->AddInputFile($nsfile, 1);
}
1850

1851
1852
1853
sub GetNSFile($$)
{
    my ($self, $pref) = @_;
1854

1855
1856