template_analyze.in 7.91 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2006, 2007 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#
use English;
use strict;
use Getopt::Std;
use POSIX qw(isatty setsid);
use POSIX qw(strftime);
use Errno qw(EDQUOT);
use Data::Dumper;

#
# Setup analysis of a template record.
#
# Exit codes are important; they tell the web page what has happened so
# it can say something useful to the user. Fatal errors are mostly done
# with die(), but expected errors use this routine. At some point we will
# use the DB to communicate the actual error.
#
# $status < 0 - Fatal error. Something went wrong we did not expect.
# $status = 0 - Everything okay.
# $status > 0 - Expected error. User not allowed for some reason. 
# 
sub usage()
{
    print(STDERR
47
	  "Usage: template_analyze [-q] [-s] [-r runidx] -i <exptidx> <guid/vers>\n".
48 49 50 51 52 53
	  "switches and arguments:\n".
	  "-q           - be less chatty\n".
	  "-i <exptidx> - Experiment index to work on\n".
	  "<guid/vers>  - GUID and version\n");
    exit(-1);
}
54
my $optlist	 = "qi:dr:";
55 56 57 58 59
my %options      = ();
my $quiet        = 0;
my $debug        = 0;
my $eid;
my $exptidx;
60
my $runidx;
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
my $guid;
my $version;

#
# Configure variables
#
my $TB		= "@prefix@";
my $EVENTSYS	= @EVENTSYS@;
my $TBOPS	= "@TBOPSEMAIL@";
my $TBLOGS	= "@TBLOGSEMAIL@";
my $TBDOCBASE	= "@TBDOCBASE@";
my $TBBASE	= "@TBBASE@";
my $CONTROL     = "@USERNODE@";
my $checkquota  = "$TB/sbin/checkquota";
my $dbcontrol   = "$TB/sbin/opsdb_control";

# Locals
my $template;
my $instance;
my $archive_tag;

# Protos
sub ParseArgs();
sub fatal($$);
sub cleanup();

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use libtblog;
94
use libaudit;
95
use Template;
96
use User;
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

# In libdb
my $projroot = PROJROOT();

#
# Turn off line buffering on output
#
$| = 1;

#
# Set umask for start/swap. We want other members in the project to be
# able to swap/end experiments, so the log and intermediate files need
# to be 664 since some are opened for append.
#
umask(0002);

#
# Untaint the path
#
# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Verify user and get his DB uid.
#
123 124 125 126 127 128
#
# Verify user and get his DB uid and other info for later.
#
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
129
}
130
my $user_uid   = $this_user->uid();
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

# Now parse arguments.
ParseArgs();

# Temporary
libArchive::setdebug($debug);

#
# Grab template info and do access check.
#
$template = Template->Lookup($guid, $version);

if (!defined($template)) {
    tbdie("Experiment template $guid/$version does not exist!");
}
146 147 148

my $project = $template->GetProject();
if (! $project->AccessCheck($this_user, TB_PROJECT_READINFO)) {
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
    tberror("You do not have permission to export template $guid/$version");
    exit(1);
}
my $pid = $template->pid();
my $gid = $template->gid();

$instance = Template::Instance->LookupByExptidx($exptidx);
if (!defined($instance)) {
    fatal(-1, "Could not get instance record for experiment $exptidx!");
}

if ($instance->ArchiveTag(\$archive_tag) < 0) {
    fatal(-1, "Could not get current archive tag for instance $exptidx!");
}

164
if (system("$checkquota $user_uid") != 0) {
165 166
    tberror("You are over your disk quota on $CONTROL; ".
	    "please login there and cleanup!");
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    exit(1);
}

# Get the the runs.
my %runlist;
$instance->RunList(\%runlist) == 0
    or fatal(-1, "Could not get runlist for $instance");

#
# It is an error to analyze an instance with no runs; it sorta implies
# the the initial run is still active.
#
if (! keys(%runlist)) {
    tberror("There are no experiment runs in instance $instance!");
    exit(1);
}

#
# Checkout to the project tree.
#
my $checkout = "$projroot/$pid/export/$guid/$version/$exptidx";

# Cleanup existing goo.
if (-e $checkout) {
    system("/bin/rm -rf $checkout");
}
system("mkdir -p $checkout") == 0
    or fatal(-1, "Could not mkdir $checkout");

# Use the logonly option to audit so that we get a record mailed.
LogStart(0);

#
# Now dump a checkout of the dbdata directory for each run, in its own
# directory. 
#
foreach my $name (keys(%runlist)) {
    my $rowref = $runlist{$name};
205 206
    my $idx    = $rowref->{"idx"};
    my $dir    = "$checkout/run${idx}";
207
    my $subdir = "dbdata/";
208
    my $tag    = $rowref->{"ending_archive_tag"};
209
    my $dbdump = "$dir/$subdir/dbdump.gz";
210 211 212 213

    # This could happen if template is still instantiated (last run).
    next
	if (!defined($tag) || $tag eq "");
214 215 216 217

    # A specific run?
    next
	if (defined($runidx) && $runidx != $idx);
218 219 220 221 222 223 224 225 226 227
	
    system("mkdir -p $dir") == 0
	or fatal(-1, "Could not mkdir $dir");

    print "Checking out files from archive using tag $tag ...\n";
    
    libArchive::TBCheckoutExperimentArchivebyExptIDX($exptidx, $dir,
						     $tag, $subdir) == 0 or
        fatal(-1, "Could not checkout $tag to $dir");

228
    if (! -e "$dbdump") {
229
	$subdir = "exp/dbdata/";
230
	$dbdump = "$dir/$subdir/dbdump.gz";
231 232 233 234 235
	
	libArchive::TBCheckoutExperimentArchivebyExptIDX($exptidx, $dir,
							 $tag, $subdir) == 0 or
            fatal(-1, "Could not checkout $tag to $dir");
    }
236 237 238
    if (! -e "$dbdump") {
	fatal(-1, "Could not find the dbdump file in the archive!");
    }
239

240 241 242
    #
    # Now we need to create a DB on ops to hold the DB dump.
    #
243
    my $dbname = "${guid},${version}," . $instance->idx() . ",$idx";
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

    if (system("$dbcontrol deltempdb $dbname")) {
	fatal(-1, "$dbcontrol deltempdb failed!");
    }
    if (system("$dbcontrol addtempdb $pid $gid $dbname")) {
	fatal(-1, "$dbcontrol addtempdb failed!");
    }

    #
    # Load it up.
    #
    if (system("$dbcontrol loadtempdb $dbname $dbdump")) {
	fatal(-1, "$dbcontrol loadtempdb failed!");
    }
}
LogEnd();
exit(0);

#
# Parse command arguments. Once we return from getopts, all that are
# left are the required arguments.
#
sub ParseArgs()
{
    if (! getopts($optlist, \%options)) {
	usage();
    }

    if (@ARGV != 1) {
	usage();
    }
    
    #
    # Pick up guid/version first and untaint.
    #
    my $tmp = shift(@ARGV);

    if ($tmp =~ /^([\w]*)\/([\d]*)$/) {
	$guid = $1;
	$version = $2;
    }
    else {
	tbdie("Bad data in argument: $tmp");
    }

    if (defined($options{"i"})) {
	$exptidx = $options{"i"};
    
	if (! TBcheck_dbslot($exptidx, "default", "int",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper experiment index!");
	}
	# real check.
	if ($exptidx =~ /^([\w]*)$/) {
	    $exptidx = $1;
	}
	else {
	    tbdie("Bad data in argument: $exptidx");
	}
    }
    else {
	tbdie("You must supply the -i option!");
    }

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
    if (defined($options{"r"})) {
	$runidx = $options{"r"};
    
	if (! TBcheck_dbslot($exptidx, "default", "int",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper run index!");
	}
	# real check.
	if ($runidx =~ /^([\w]*)$/) {
	    $runidx = $1;
	}
	else {
	    tbdie("Bad data in argument: $runidx");
	}
    }
    
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
    if (defined($options{"q"})) {
	$quiet = 1;
    }
    if (defined($options{"d"})) {
	$debug = 2;
    }
}

#
# Cleanup the mess.
#
sub cleanup()
{
    if (defined($checkout) && -e $checkout) {
	system("/bin/rm -rf $checkout");
    }
}

sub fatal($$)
{
    my ($errorstat, $msg) = @_;
    
    tberror $msg;
    tbinfo "Cleaning up and exiting with status $errorstat ...";

    exit($errorstat);
}