Changeset 6131

Timestamp:

Mar 16, 2016 6:39:27 PM (8 years ago)

Author:

gah

Message:

initial changes for instant-on

Location:

branches/1.6

Files:

• configure (modified) (8 diffs)
• configure.in (modified) (1 diff)
• examples/zoo/string/string.tcl (modified) (1 diff)
• examples/zoo/string/tool.xml (modified) (1 diff)
• gui/configure (modified) (8 diffs)
• gui/configure.in (modified) (1 diff)
• gui/scripts/bugreport.tcl (modified) (1 diff)
• lang/tcl/scripts/task.tcl (modified) (10 diffs)
• src/core/config.h.in (modified) (1 diff)

branches/1.6/configure

@@ -1 +1 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for Rappture 1.5.
+# Generated by GNU Autoconf 2.69 for Rappture 1.6.
 #
 # Report bugs to <rappture@nanohub.org>.
@@ -581 +581 @@
 PACKAGE_NAME='Rappture'
 PACKAGE_TARNAME='rappture'
-PACKAGE_VERSION='1.5'
-PACKAGE_STRING='Rappture 1.5'
+PACKAGE_VERSION='1.6'
+PACKAGE_STRING='Rappture 1.6'
 PACKAGE_BUGREPORT='rappture@nanohub.org'
 PACKAGE_URL=''
@@ -1395 +1395 @@
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures Rappture 1.5 to adapt to many kinds of systems.
+\`configure' configures Rappture 1.6 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
@@ -1460 +1460 @@
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of Rappture 1.5:";;
+     short | recursive ) echo "Configuration of Rappture 1.6:";;
    esac
   cat <<\_ACEOF
@@ -1580 +1580 @@
 if $ac_init_version; then
   cat <<\_ACEOF
-Rappture configure 1.5
+Rappture configure 1.6
 generated by GNU Autoconf 2.69
 
@@ -2400 +2400 @@
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by Rappture $as_me 1.5, which was
+It was created by Rappture $as_me 1.6, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
@@ -10725 +10725 @@
 # values after options handling.
 ac_log="
-This file was extended by Rappture $as_me 1.5, which was
+This file was extended by Rappture $as_me 1.6, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
@@ -10787 +10787 @@
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-Rappture config.status 1.5
+Rappture config.status 1.6
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"

branches/1.6/configure.in

@@ -1 +1 @@
 
-AC_INIT([Rappture],[1.5],[rappture@nanohub.org])
+AC_INIT([Rappture],[1.6],[rappture@nanohub.org])
 AC_CONFIG_AUX_DIR(cf)
 AC_CONFIG_HEADER(src/core/config.h)

branches/1.6/examples/zoo/string/string.tcl

@@ -20 +20 @@
 $driver put output.string(outi).about.label "Echo of input"
 $driver put output.string(outi).current $indeck
+puts stderr "This is an error message."
+exit 10
 
 # save the updated XML describing the run...
 Rappture::result $driver
-exit 0

branches/1.6/examples/zoo/string/tool.xml

@@ -11 +11 @@
   </about>
   <command>
-    python @tool/string_test.py @driver
+    tclsh @tool/string.tcl @driver
   </command>
 </tool>

branches/1.6/gui/configure

@@ -1 +1 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for RapptureGUI 1.5.
+# Generated by GNU Autoconf 2.69 for RapptureGUI 1.6.
 #
 # Report bugs to <rappture@nanohub.org>.
@@ -580 +580 @@
 PACKAGE_NAME='RapptureGUI'
 PACKAGE_TARNAME='rappturegui'
-PACKAGE_VERSION='1.5'
-PACKAGE_STRING='RapptureGUI 1.5'
+PACKAGE_VERSION='1.6'
+PACKAGE_STRING='RapptureGUI 1.6'
 PACKAGE_BUGREPORT='rappture@nanohub.org'
 PACKAGE_URL=''
@@ -1226 +1226 @@
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures RapptureGUI 1.5 to adapt to many kinds of systems.
+\`configure' configures RapptureGUI 1.6 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
@@ -1292 +1292 @@
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of RapptureGUI 1.5:";;
+     short | recursive ) echo "Configuration of RapptureGUI 1.6:";;
    esac
   cat <<\_ACEOF
@@ -1383 +1383 @@
 if $ac_init_version; then
   cat <<\_ACEOF
-RapptureGUI configure 1.5
+RapptureGUI configure 1.6
 generated by GNU Autoconf 2.69
 
@@ -1438 +1438 @@
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by RapptureGUI $as_me 1.5, which was
+It was created by RapptureGUI $as_me 1.6, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
@@ -3697 +3697 @@
 # values after options handling.
 ac_log="
-This file was extended by RapptureGUI $as_me 1.5, which was
+This file was extended by RapptureGUI $as_me 1.6, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
@@ -3750 +3750 @@
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-RapptureGUI config.status 1.5
+RapptureGUI config.status 1.6
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"

branches/1.6/gui/configure.in

@@ -1 +1 @@
 
-AC_INIT([RapptureGUI],[1.5],[rappture@nanohub.org])
+AC_INIT([RapptureGUI],[1.6],[rappture@nanohub.org])
 AC_CONFIG_AUX_DIR(cf)
 #------------------------------------------------------------------------

branches/1.6/gui/scripts/bugreport.tcl

@@ -607 +607 @@
                 return 0
             }
-
+            set url [Rappture::Tool::resources -huburl]
+            if { $url == "" } {
+                return 0
+            }
             # if this is a problem launching a job and the tool
             # expects this, then don't bother with automatic reports.

branches/1.6/lang/tcl/scripts/task.tcl

@@ -19 +19 @@
 
 itcl::class Rappture::Task {
+    private method CheckCacheForRunFile { driverFile }
+    private method CollectUQResults {}
+    private method ExecuteSimulationCommand { cmd }
+    private method GetCommand {}
+    private method GetDriverFile {}
+    private method GetSignal { signal }
+    private method GetSimulationCommand { driverFile }
+    private method GetUQSimulationCommand { driverFile }
+    private method GetUQTemplateFile {}
+    private method IsCacheable {}
+    private method LogCachedSimulationUsage {}
+    private method LogSimulationUsage {}
+    private method SetCpuResourceLimit {}
+
     public variable logger ""
     public variable jobstats Rappture::Task::MiddlewareTime
@@ -35 +49 @@
     public method save {xmlobj {name ""}}
 
-    protected method _mkdir {dir}
     protected method _output {data}
-    protected method _log {args}
-    protected method _build_submit_cmd {cmd tfile params_file}
-    protected method _get_params {varlist uq_type uq_args}
-    private method GetSignal { signal }
+    protected method Log {args}
+    protected method BuildSubmitCommand {cmd tfile params_file}
+    protected method GetParamsForUQ {}
 
     private variable _xmlobj ""      ;# XML object with inputs/outputs
     private variable _origxml ""     ;# copy of original XML (for reset)
-    private variable _lastrun ""     ;# name of last run file
     private variable _installdir ""  ;# installation directory for this tool
     private variable _outputcb ""    ;# callback for tool output
-    private common job               ;# array var used for blt::bgexec jobs
     private common jobnum 0          ;# counter for unique job number
-
+    private variable _uq
+    
+    private variable _job
+    
     # get global resources for this tool session
     public proc resources {{option ""}}
@@ -60 +73 @@
     public proc setJobPrt {name}    { set _resources(-jobprotocol) $name }
     public proc setResultDir {name} { set _resources(-resultdir) $name }
+    public proc setCacheHost {name} { set _resources(-cachehost) $name }
 
     # default method for -jobstats control
@@ -74 +88 @@
         session_token     Rappture::Task::setSession \
         job_protocol      Rappture::Task::setJobPrt \
-        results_directory Rappture::Task::setResultDir
+        results_directory Rappture::Task::setResultDir \
+        cache_host        Rappture::Task::setCacheHost
 }
 
@@ -122 +137 @@
 itcl::body Rappture::Task::GetSignal {code} {
     set signals {
-        HUP INT QUIT ILL TRAP ABRT BUS FPE KILL USR1 SEGV
-        USR2 PIPE ALRM TERM STKFLT CHLD CONT STOP TSTP TTIN
-        TTOU URG XCPU XFSZ VTALRM PROF WINCH POLL PWR SYS
-        RTMIN RTMIN+1 RTMIN+2 RTMIN+3 RTMAX-3 RTMAX-2 RTMAX-1 RTMAX
+        HUP INT QUIT ILL TRAP ABRT BUS FPE KILL USR1 SEGV 
+        USR2 PIPE ALRM TERM STKFLT CHLD CONT STOP TSTP TTIN 
+        TTOU URG XCPU XFSZ VTALRM PROF WINCH POLL PWR SYS 
+        RTMIN RTMIN+1 RTMIN+2 RTMIN+3 RTMAX-3 RTMAX-2 RTMAX-1 RTMAX
     }
     set sigNum [expr $code - 128]
     if { $sigNum > 0 && $sigNum < [llength $signals] } {
-        return [lindex $signals $sigNum]
+        return [lindex $signals $sigNum]
     }
     return "unknown exit code \"$code\""
@@ -137 +152 @@
     foreach {path val} $args {
         if {$path == "-uq_type"} {
-            set uq_type $val
+            set _uq(type) $val
         } elseif {$path == "-uq_args"} {
-            set uq_args $val
+            set _uq(args) $val
         }
     }
     #set varlist [$_xmlobj uq_get_vars]
     foreach {varlist num} [$_xmlobj uq_get_vars] break
-    return [Rappture::UQ ::#auto $varlist $num $uq_type $uq_args]
+    return [Rappture::UQ ::#auto $varlist $num $_uq(type) $_uq(args)]
 }
 
@@ -173 +188 @@
 
     #
-    # Make sure that we save the proper application name.
-    # Actually, the best place to get this information is
-    # straight from the "installtool" script, but just in
-    # case we have an older tool, we should insert the
+    # Make sure that we save the proper application name.  Actually, the
+    # best place to get this information is straight from the "installtool"
+    # script, but just in case we have an older tool, we should insert the
     # tool name from the resources config file.
     #
-    if {[info exists _resources(-appname)]
-          && $_resources(-appname) ne ""
-          && [$_xmlobj get tool.name] eq ""} {
+    if {[info exists _resources(-appname)] && $_resources(-appname) ne "" &&
+        [$_xmlobj get tool.name] eq ""} {
         $_xmlobj put tool.name $_resources(-appname)
     }
@@ -187 +200 @@
     # if there are any args, use them to override parameters
     set _outputcb ""
-    set uq_type ""
+    set _uq(type) ""
     foreach {path val} $args {
         if {$path == "-output"} {
             set _outputcb $val
         } elseif {$path == "-uq_type"} {
-            set uq_type $val
+            set _uq(type) $val
         } elseif {$path == "-uq_args"} {
-            set uq_args $val
+            set _uq(args) $val
         } else {
             $_xmlobj put $path.current $val
@@ -200 +213 @@
     }
 
-    foreach item {control output error} { set job($item) "" }
-
+    # Initialize job array variables
+    array set _job { 
+        control ""
+        mesg    ""
+        runfile ""
+        stderr  ""
+        stdout  ""
+        success 0
+        xmlobj  ""
+    }
+
+    SetCpuResourceLimit 
+    set driverFile [GetDriverFile]
+    set cached 0
+    if { [IsCacheable] } {
+        set cached [CheckForCachedRunFile $driverFile] 
+    }
+    if { !$cached } {
+        if { $_uq(type) != "" } {
+            set _uq(tfile) [GetUQTemplateFile]
+        }
+        if { $_uq(type) == "" } {
+            set cmd [GetSimulationCommand $driverFile]
+        } else {
+            set cmd [GetUQSimulationCommand $driverFile]
+        }
+        if { $cmd == "" } {
+            puts stderr "cmd is empty"
+            append mesg "There is no command specified by\n\n"
+            append mesg "    <command>\n"
+            append mesg "    </command>\n\n"
+            append mesg "in the tool.xml file."
+            return [list 1 $mesg]
+        }
+        Rappture::rusage mark
+        if { ![ExecuteSimulationCommand $cmd] } {
+            return [list 1 $_job(mesg)]
+        }
+        if { $_uq(type) != "" } {
+            CollectUQResults
+        }
+        if { [resources -jobprotocol] != "submit" } {
+            LogSimulationUsage
+        }
+    } else {
+        LogCachedSimulationUsage
+    }
+    if { $_job(success) } {
+        file delete -force -- $driverFile
+        Log run finished
+        return [list 0 $_job(xmlobj)]
+    } else {
+        # See if the job was aborted.
+        if {[regexp {^KILLED} $_job(control)]} {
+            Log run aborted
+            return [list 1 "ABORT"]
+        }
+        Log run failed [list 0 $_job(mesg)]
+        return [list 1 $_job(mesg)]
+    }
+}
+
+# ----------------------------------------------------------------------
+#  Turn the command string from tool.xml into the proper syntax to use
+#  with a submit parameter sweep with a temlate file.  Proper quoting
+# of the template file is necessary to prevent submit from being too smart
+# and converting it to a full pathname.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::BuildSubmitCommand {cmd tfile params_file} {
+    set quote_next 0
+    set newcmd "submit --progress submit --runName=puq -l -i @:$tfile -d $params_file"
+    set cmds [split $cmd " "]
+    for {set i 0} {$i < [llength $cmds]} {incr i} {
+        set arg [lindex $cmds $i]
+        if {$quote_next == 1} {
+            set nc [string range $arg 0 0]
+            if {$nc != "\""} {
+                set arg "\"\\\"$arg\\\"\""
+            }
+        }
+        if {$arg == "--eval"} {
+            set quote_next 1
+        } else {
+            set quote_next 0
+        }
+        if {$arg == "@driver"} {
+            set arg "\"\\\"$tfile\\\"\""
+        }
+        append newcmd " " $arg
+    }
+    regsub -all @driver $newcmd $tfile newcmd
+    return $newcmd
+}
+
+# ----------------------------------------------------------------------
+# USAGE: abort
+#
+# Clients use this during a "run" to abort the current job.
+# Kills the job and forces the "run" method to return.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::abort {} {
+    Log run abort
+    set _job(control) "abort"
+}
+
+# ----------------------------------------------------------------------
+# USAGE: reset
+#
+# Resets all input values to their defaults.  Sometimes used just
+# before a run to reset to a clean state.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::reset {} {
+    $_xmlobj copy "" from $_origxml ""
+    foreach path [Rappture::entities -as path $_xmlobj input] {
+        if {[$_xmlobj element -as type $path.default] ne ""} {
+            set defval [$_xmlobj get $path.default]
+            $_xmlobj put $path.current $defval
+        }
+    }
+}
+
+# ----------------------------------------------------------------------
+# USAGE: xml <subcommand> ?<arg> <arg> ...?
+# USAGE: xml object
+#
+# Used by clients to manipulate the underlying XML data for this
+# tool.  The <subcommand> can be any operation supported by a
+# Rappture::library object.  Clients can also request the XML object
+# directly by using the "object" subcommand.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::xml {args} {
+    if {"object" == $args} {
+        return $_xmlobj
+    }
+    return [eval $_xmlobj $args]
+}
+
+# ----------------------------------------------------------------------
+# USAGE: save <xmlobj> ?<filename>?
+#
+# Used by clients to save the contents of an <xmlobj> representing
+# a run out to the given file.  If <filename> is not specified, then
+# it uses the -resultsdir and other settings to do what Rappture
+# would normally do with the output.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::save {xmlobj {filename ""}} {
+    if {$filename eq ""} {
+
+        # If there's a results_directory defined in the resources file,
+        # then move the run.xml file there for storage.
+
+        set rdir ""
+        if {$resultdir eq "@default"} {
+            if {[info exists _resources(-resultdir)]} {
+                set rdir $_resources(-resultdir)
+            } else {
+                global rapptureInfo
+                set rdir $rapptureInfo(cwd)
+            }
+        } elseif {$resultdir ne ""} {
+            set rdir $resultdir
+        }
+
+        # use the runfile name generated by the last run
+        if {$_job(runfile) ne ""} {
+            set filename [file join $rdir $_job(runfile)]
+        } else {
+            set filename [file join $rdir run.xml]
+        }
+    }
+
+    # add any last-minute metadata
+    $xmlobj put output.time [clock format [clock seconds]]
+
+    $xmlobj put tool.version.rappture.version $::Rappture::version
+    $xmlobj put tool.version.rappture.revision $::Rappture::build
+    $xmlobj put output.filename $filename
+    $xmlobj put output.version $Rappture::version
+    
+    if {[info exists ::tcl_platform(user)]} {
+        $xmlobj put output.user $::tcl_platform(user)
+    }
+
+    # save the output
+    set rdir [file dirname $filename]
+    file mkdir $rdir
+
+    set fid [open $filename w]
+    puts $fid "<?xml version=\"1.0\"?>"
+    puts $fid [$xmlobj xml]
+    close $fid
+
+    Log output saved in $filename
+}
+
+# ----------------------------------------------------------------------
+# USAGE: _output <data>
+#
+# Used internally to send each bit of output <data> coming from the
+# tool onto the caller, so the user can see progress.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::_output {data} {
+    if {[string length $_outputcb] > 0} {
+        uplevel #0 $_outputcb [list $data]
+    }
+}
+
+# ----------------------------------------------------------------------
+# USAGE: Log <cmd> <arg> <arg> ...
+#
+# Used internally to log interesting events during the run.  If the
+# -logger option is set (to Rappture::Logger::log, or something like
+# that), then the arguments to this method are passed along to the
+# logger and written out to a log file.  Logging is off by default,
+# so this method does nothing unless -logger is set.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::Log {args} {
+    if {[string length $logger] > 0} {
+        uplevel #0 $logger [list $args]
+    }
+}
+
+# ----------------------------------------------------------------------
+# USAGE: MiddlewareTime <key> <value> ...
+#
+# Used as the default method for reporting job status information.
+# Implements the old HUBzero method of reporting job status info to
+# stderr, which can then be picked up by the tool session container.
+# Most tools use the "submit" command, which talks directly to a
+# database to log job information, so this isn't really needed.  But
+# it doesn't hurt to have this and it can be useful in some cases.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::MiddlewareTime {args} {
+    set line "MiddlewareTime:"
+    foreach {key val} $args {
+        append line " $key=$val"
+    }
+    puts stderr $line
+}
+
+itcl::body Rappture::Task::IsCacheable {} {
+    if { ![info exists _resources(-cachehost)] ||
+         $_resources(-cachehost) == "" } {
+        return 0
+    }
+    set state [$_xmlobj get "tool.cached"]
+    if { $state == "" } {
+        return 0
+    }
+    if { ![string is boolean $state] } {
+        return 0
+    }
+    return $state
+}
+
+#
+# Send the list of parameters to a python program so it can call PUQ
+# and get a CSV file containing the parameter values to use for the runs.
+itcl::body Rappture::Task::GetParamsForUQ {} {
+    set pid [pid]
+    # puts "get_params.py $pid $_uq(varlist) $_uq(type) $_uq(args)"
+    if {[catch {
+        exec puq get_params $pid $_uq(varlist) $_uq(type) $_uq(args)
+    } errs] != 0 } {
+        set fp [open "uq_debug.err" r]
+        set contents [read $fp]
+        close $fp
+        puts stderr "get_params.py failed: $contents"
+        error "get_params.py: $errs\n$contents"
+    }
+    return "params[pid].csv"
+}
+
+itcl::body Rappture::Task::SetCpuResourceLimit {} {
     # Set limits for cpu time
     set limit [$_xmlobj get tool.limits.cputime]
@@ -216 +501 @@
     }
     Rappture::rlimit set cputime $limit
-
-    # write out the driver.xml file for the tool
+}
+
+# Write out the driver.xml file for the tool
+itcl::body Rappture::Task::GetDriverFile {} {
     global rapptureInfo
-    set file [file join $rapptureInfo(cwd) "driver[pid].xml"]
-    set status [catch {
-        set fid [open $file w]
-        puts $fid "<?xml version=\"1.0\"?>"
-        puts $fid [$_xmlobj xml]
-        close $fid
-    } result]
-
-    if {$uq_type != ""} {
-        # Copy xml into a new file
-        set tfile "template[pid].xml"
-        set fid [open $tfile w]
-        puts $fid "<?xml version=\"1.0\"?>"
-        puts $fid [$_xmlobj xml]
-        close $fid
-
-        # Return a list of the UQ variables and their PDFs.
-        # Also turns $tfile into a template file.
-        set uq_varlist [lindex [$_xmlobj uq_get_vars $tfile] 0]
-    }
-
-
-    # execute the tool using the path from the tool description
-    if {$status == 0} {
-        set cmd [$_xmlobj get tool.command]
-        regsub -all @tool $cmd $_installdir cmd
-        set cmd [string trimleft $cmd " "]
-
-        if { $cmd == "" } {
-            puts stderr "cmd is empty"
-            return [list 1 "Command is empty.\n\nThere is no command specified by\n\n <command>\n </command>\n\nin the tool.xml file."]
-        }
-
-        if {$uq_type == ""} {
-            regsub -all @driver $cmd $file cmd
-
-            switch -glob -- [resources -jobprotocol] {
-                "submit*" {
-                    # if job_protocol is "submit", then use use submit command
-                    set cmd "submit --local $cmd"
-                }
-                "mx" {
-                    # metachory submission
-                    set cmd "mx $cmd"
-                }
-                "exec" {
-                    # default -- nothing special
-                }
+    set fileName [file join $rapptureInfo(cwd) "driver[pid].xml"]
+    if { [catch {
+        set f [open $fileName w]
+        puts $f "<?xml version=\"1.0\"?>"
+        puts $f [$_xmlobj xml]
+        close $f
+    } errs] != 0 } {
+        error "can't create driver file \"$fileName\": $errs"
+    }
+    return $fileName
+}
+
+itcl::body Rappture::Task::GetCommand { } {
+    set cmd [$_xmlobj get tool.command]
+    regsub -all @tool $cmd $_installdir cmd
+    set cmd [string trimleft $cmd " "]
+    return $cmd
+}
+
+itcl::body Rappture::Task::GetSimulationCommand { driverFile } {
+    set cmd [GetCommand]
+    if { $cmd == "" } {
+        return ""
+    }
+    regsub -all @driver $cmd $driverFile cmd
+
+    switch -glob -- [resources -jobprotocol] {
+        "submit*" {
+            # if job_protocol is "submit", then use use submit command
+            set cmd "submit --local $cmd"
+        }
+        "mx" {
+            # metachory submission
+            set cmd "mx $cmd"
+        }
+        "exec" {
+            # default -- nothing special
+        }
+    }
+    return $cmd
+}
+
+itcl::body Rappture::Task::GetUQSimulationCommand { driverFile } {
+    set cmd [GetCommand]
+    if { $cmd == "" } {
+        return ""
+    }
+    set paramsFile [GetParamsForUQ]
+    set cmd [BuildSubmitCommand $cmd $_uq(tfile) $paramsFile]
+    file delete -force puq
+    return $cmd
+}
+
+itcl::body Rappture::Task::GetUQTemplateFile {} {
+    global rapptureInfo
+    # Copy xml into a new file
+    set templateFile [file join $rapptureInfo(cwd) "template[pid].xml"]
+    set fid [open $templateFile w]
+    puts $fid "<?xml version=\"1.0\"?>"
+    puts $fid [$_xmlobj xml]
+    close $fid
+
+    # Return a list of the UQ variables and their PDFs.
+    # Also turns $uq(tfile) into a template file.
+    set _uq(varlist) [lindex [$_xmlobj uq_get_vars $templateFile] 0]
+    set _uq(tfile) $templateFile
+    return $templateFile
+}
+
+itcl::body Rappture::Task::ExecuteSimulationCommand { cmd } {
+
+    set _job(runfile) ""
+    set _job(success) 0
+
+    # Step 1.  Write the command into the run file.
+    $_xmlobj put tool.execute $cmd
+
+    Log run started
+    Rappture::rusage mark
+
+    # Step 2.  Check if it is a special case "ECHO" command which always
+    #          succeeds.
+    if { [string compare -nocase -length 5 $cmd "ECHO "] == 0 } {
+        set _job(stdout) [string range $cmd 5 end]
+        set _job(success) 1
+        set _job(mesg) ""
+        return 1;                       # Success
+    } 
+
+    # Step 3. Execute the command, collecting its stdout and stderr.
+    catch {
+        eval blt::bgexec [list [itcl::scope _job(control)]] \
+            -keepnewline yes \
+            -killsignal  SIGTERM \
+            -onoutput    [list [itcl::code $this _output]] \
+            -output      [list [itcl::scope _job(stdout)]] \
+            -error       [list [itcl::scope _job(stderr)]] \
+            $cmd
+    } result
+
+    # Step 4. Check the token and the exit code.
+    set logmesg $result
+    foreach { token pid code mesg } $_job(control) break
+    if { $token == "EXITED" } {
+        if { $code != 0 } {
+            # This means that the program exited normally but returned a
+            # non-zero exitcode.  Consider this an invalid result from the
+            # program.  Append the stderr from the program to the message.
+            
+            if {$code > 128} {
+                set logmesg "Program signaled: signal was [GetSignal]"
+            } else { 
+                set logmesg "Program finished: non-zero exit code is $code"
             }
-        } else {
-            set params_file [_get_params $uq_varlist $uq_type $uq_args]
-            set cmd [_build_submit_cmd $cmd $tfile $params_file]
-            file delete -force puq
-        }
-
-        $_xmlobj put tool.execute $cmd
-
-        # starting job...
-        set _lastrun ""
-        _log run started
-        Rappture::rusage mark
-
-        if {0 == [string compare -nocase -length 5 $cmd "ECHO "] } {
-            set status 0;
-            set job(output) [string range $cmd 5 end]
-        } else {
-            set status [catch {
-                set ::Rappture::Task::job(control) ""
-                eval blt::bgexec \
-                ::Rappture::Task::job(control) \
-                -keepnewline yes \
-                -killsignal SIGTERM \
-                -onoutput [list [itcl::code $this _output]] \
-                -output ::Rappture::Task::job(output) \
-                -error ::Rappture::Task::job(error) \
-                $cmd
-            } result]
-
-            if { $status != 0 } {
-                # We're here because the exec-ed program failed
-                set logmesg $result
-                if { $::Rappture::Task::job(control) ne "" } {
-                    foreach { token pid code mesg } \
-                    $::Rappture::Task::job(control) break
-                    if { $token == "EXITED" } {
-                       # This means that the program exited normally but
-                       # returned a non-zero exitcode.  Consider this an
-                       # invalid result from the program.  Append the stderr
-                       # from the program to the message.
-                       if {$code > 128} {
-                          set logmesg "Program signaled: signal was [GetSignal $code]"
-                       } else {
-                          set logmesg "Program finished: exit code is $code"
-                       }
-                       set result "$logmesg\n\n$::Rappture::Task::job(error)"
-                    } elseif { $token == "abort" }  {
-                        # The user pressed the abort button.
-                        set logmesg "Program terminated by user."
-                        set result "$logmesg\n\n$::Rappture::Task::job(output)"
-                    } else {
-                        # Abnormal termination
-                        set logmesg "Abnormal program termination: $mesg"
-                        set result "$logmesg\n\n$::Rappture::Task::job(output)"
-                    }
-                }
-                _log run failed [list $logmesg]
-                return [list $status $result]
-            }
-        }
-        # ...job is finished
-        array set times [Rappture::rusage measure]
-
-        if {[resources -jobprotocol] ne "submit"} {
-            set id [$_xmlobj get tool.id]
-            set vers [$_xmlobj get tool.version.application.revision]
-            set simulation simulation
-            if { $id ne "" && $vers ne "" } {
-                set pid [pid]
-                set simulation ${pid}_${id}_r${vers}
-            }
-
-            # need to save job info? then invoke the callback
-            if {[string length $jobstats] > 0} {
-                uplevel #0 $jobstats [list job [incr jobnum] \
-                event $simulation start $times(start) \
-                walltime $times(walltime) cputime $times(cputime) \
-                status $status]
-            }
-
-            #
-            # Scan through stderr channel and look for statements that
-            # represent grid jobs that were executed.  The statements
-            # look like this:
-            #
-            # MiddlewareTime: job=1 event=simulation start=3.001094 ...
-            #
-            set subjobs 0
-            while {[regexp -indices {(^|\n)MiddlewareTime:( +[a-z]+=[^ \n]+)+(\n|$)} $job(error) match]} {
-                foreach {p0 p1} $match break
-                if {[string index $job(error) $p0] == "\n"} { incr p0 }
-
-                catch {unset data}
-                array set data {
-                    job 1
-                    event simulation
-                    start 0
-                    walltime 0
-                    cputime 0
-                    status 0
-                }
-                foreach arg [lrange [string range $job(error) $p0 $p1] 1 end] {
-                    foreach {key val} [split $arg =] break
-                    set data($key) $val
-                }
-                set data(job) [expr {$jobnum+$data(job)}]
-                set data(event) "subsimulation"
-                set data(start) [expr {$times(start)+$data(start)}]
-
-                set details ""
-                foreach key {job event start walltime cputime status} {
-                    # add required keys in a particular order
-                    lappend details $key $data($key)
-                    unset data($key)
-                }
-                foreach key [array names data] {
-                    # add anything else that the client gave -- venue, etc.
-                    lappend details $key $data($key)
-                }
-
-                if {[string length $jobstats] > 0} {
-                    uplevel #0 $jobstats $details
-                }
-
-                incr subjobs
-
-                # done -- remove this statement
-                set job(error) [string replace $job(error) $p0 $p1]
-            }
-            incr jobnum $subjobs
-        }
-
+            set _job(mesg) "$logmesg\n\n$_job(stderr)"
+            Log run failed [list $logmesg]
+            return 0;                   # Fail.
+        }
+        # Successful program termination with exit code of 0.
+    } elseif { $token == "abort" }  {
+        # The user pressed the abort button.
+        
+        set logmesg "Program terminated by user."
+        Log run failed [list $logmesg]
+        set _job(mesg) "$logmesg\n\n$_job(stdout)"
+        return 0;                       # Fail
     } else {
-        set job(error) "$result\n$errorInfo"
-    }
-    if {$status == 0} {
-        # file delete -force -- $file
-    }
-
-    # see if the job was aborted
-    if {[regexp {^KILLED} $job(control)]} {
-        _log run aborted
-        return [list 0 "ABORT"]
-    }
-
+        # Abnormal termination
+        
+        set logmesg "Abnormal program termination:"
+        Log run failed [list $logmesg]
+        set _job(mesg) "$logmesg\n\n$_job(stdout)"
+        return 0;                       # Fail
+    }
+    
+    # Step 5. Look in stdout for the name of the run file.
+    set pattern {=RAPPTURE-RUN=>([^\n]+)}
+    if {![regexp $pattern $_job(stdout) match fileName]} {
+        set _job(mesg) "Can't find result file in output.\n"
+        append _job(mesg) "Did you call Rappture::result in your simulator?"
+        return 0;                       # Fail
+    }
+    set _job(runfile) $fileName
+    set _job(success) 1
+    set _job(mesg) $_job(stdout)
+    return 1;                           # Success
+}
+
+itcl::body Rappture::Task::LogSimulationUsage {} {
+    array set times [Rappture::rusage measure]
+
+    set toolId     [$_xmlobj get tool.id]
+    set toolVers   [$_xmlobj get tool.version.application.revision]
+    set simulation "simulation"
+    if { $toolId ne "" && $toolVers ne "" } {
+        set simulation "[pid]_${toolId}_r${toolVers}"
+    }
+    
+    # Need to save job info? then invoke the callback
+    if { [string length $jobstats] > 0} {
+        lappend args \
+            "job"      [incr jobnum] \
+            "event"    $simulation \
+            "start"    $times(start) \
+            "walltime" $times(walltime) \
+            "cputime"  $times(cputime) \
+            "status"   $_job(success)
+        uplevel #0 $jobstats $args 
+    }
+        
     #
-    # If successful, return the output, which should include
-    # a reference to the run.xml file containing results.
+    # Scan through stderr channel and look for statements that
+    # represent grid jobs that were executed.  The statements look
+    # like this:
     #
-
-    if {$status == 0} {
-        set result [string trim $job(output)]
-
-        if {$uq_type != ""} {
-            # UQ. Collect data from all jobs and put it in one xml run file.
-            file delete -force -- run_uq.xml
-            if {[catch {exec puq analyze puq_[pid].hdf5} res]} {
-                set fp [open "uq_debug.err" r]
-                set rdata [read $fp]
-                close $fp
-                puts "PUQ analysis failed: $res\n$rdata"
-                error "UQ analysis failed: $res\n$rdata"
-            } else {
-                append result "\n" $res
-            }
-        }
-        if {[regexp {=RAPPTURE-RUN=>([^\n]+)} $result match file]} {
-            set _lastrun $file
-
-            set status [catch {Rappture::library $file} result]
-            if {$status == 0} {
-                # add cputime info to run.xml file
-                $result put output.walltime $times(walltime)
-                $result put output.cputime $times(cputime)
-                if {[info exists env(SESSION)]} {
-                    $result put output.session $env(SESSION)
-                }
-            } else {
-                global errorInfo
-                set result "$result\n$errorInfo"
-            }
-
-            file delete -force -- $file
-        } else {
-            set status 1
-            set result "Can't find result file in output.\nDid you call Rappture
-::result in your simulator?"
-        }
-    } elseif {$job(output) ne "" || $job(error) ne ""} {
-        set result [string trim "$job(output)\n$job(error)"]
-    }
-
-    # log final status for the run
-    if {$status == 0} {
-        _log run finished
+    # MiddlewareTime: job=1 event=simulation start=3.001094 ...
+    #
+    
+    set subjobs 0
+    set pattern {(^|\n)MiddlewareTime:( +[a-z]+=[^ \n]+)+(\n|$)}
+    while { [regexp -indices $pattern $_job(stderr) match] } {
+        foreach {p0 p1} $match break
+        if { [string index $_job(stderr) $p0] == "\n" } {
+            incr p0
+        }
+        array unset data
+        array set data {
+            job 1
+            event simulation
+            start 0
+            walltime 0
+            cputime 0
+            status 0
+        }
+        foreach arg [lrange [string range $_job(stderr) $p0 $p1] 1 end] {
+            foreach {key val} [split $arg =] break
+            set data($key) $val
+        }
+        set data(job)   [expr { $jobnum + $data(job) }]
+        set data(event) "subsimulation"
+        set data(start) [expr { $times(start) + $data(start) }]
+        
+        set details ""
+        foreach key {job event start walltime cputime status} {
+            # Add required keys in a particular order
+            lappend details $key $data($key)
+            unset data($key)
+        }
+        foreach key [array names data] {
+            # Add anything else that the client gave -- venue, etc.
+            lappend details $key $data($key)
+        }
+        
+        if {[string length $jobstats] > 0} {
+            uplevel #0 $jobstats $details
+        }
+        
+        incr subjobs
+        
+        # Done -- remove this statement
+        set _job(stderr) [string replace $_job(stderr) $p0 $p1]
+    }
+    incr jobnum $subjobs
+
+    # Add cputime info to run.xml file
+    if { [catch {
+        Rappture::library $_job(runfile)
+    } xmlobj] != 0 } {
+        error "Can't create rappture library: $xmlobj"
+    }
+    $xmlobj put output.walltime $times(walltime)
+    $xmlobj put output.cputime $times(cputime)
+    global env
+    if {[info exists env(SESSION)]} {
+        $xmlobj put output.session $env(SESSION)
+    }
+    set _job(xmlobj) $xmlobj
+}
+
+itcl::body Rappture::Task::LogCachedSimulationUsage {} {
+    if { [catch {
+        Rappture::library $_job(runfile)
+    } xmlobj] != 0 } {
+        error "Can't create rappture library: $xmlobj"
+    }
+    # Get the session from runfile 
+    set session [$xmlobj get "tool.session"]
+    catch exec {submit --cache $session} result
+    set _job(xmlobj) $xmlobj
+}
+
+
+itcl::body Rappture::Task::CheckCacheForRunFile { driverFile } {
+
+    # Read the driver file and collect its contents as the query.
+    set url http://$_resources(-cachehost)/cache/request
+    set f [open $driverFile "r"]
+    set query [read $f]
+    close $f
+
+    # Make the query
+    if { [catch {
+        http::geturl $url -query $query -timeout 60000 -binary yes
+    } token] != 0 } {
+        puts stderr "can't get query: token=$token"
+        return 0
+    }
+    # If the code isn't 200, we'll assume it's a cache miss.
+    if { [http::ncode $token] != 200} {
+        return 0
+    }
+    # Get contents of the run file. 
+    set contents [http::data $token]
+    if { $contents == "" } {
+        return 0
+    }
+    # Create a new run.xml file and write the results into it. 
+    set secs [clock seconds]
+    set millisecs [expr [clock clicks -milliseconds] % 1000]
+    set timestamp [format %d%03d%03d $secs $millisecs 0]
+
+    global rapptureInfo
+    set fileName [file join $rapptureInfo(cwd) "run${timestamp}.xml"]
+    set f [open $fileName "w"]
+    puts $f $contents
+    close $f
+    set _job(runfile) $fileName
+    return 1
+}
+
+# UQ. Collect data from all jobs and put it in one xml run file.
+itcl::body Rappture::Task::CollectUQResults {} {
+    file delete -force -- "run_uq.xml"
+    global rapptureInfo
+    set puqFileName [file join $rapptureInfo(cwd) puq_[pid].hdf5]
+    if {[catch {
+        exec puq analyze $puqFileName
+    } fileName] != 0 } {
+        set f [open "uq_debug.err" r]
+        set rdata [read $f]
+        close $f
+        puts "PUQ analysis failed: $fileName\n$rdata"
+        error "UQ analysis failed: $fileName\n$rdata"
     } else {
-        _log run failed [list $result]
-    }
-
-    return [list $status $result]
-}
-
-# ----------------------------------------------------------------------
-#  Turn the command string from tool.xml into the proper syntax to use
-#  with a submit parameter sweep with a temlate file.  Proper quoting
-# of the template file is necessary to prevent submit from being too smart
-# and converting it to a full pathname.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::_build_submit_cmd {cmd tfile params_file} {
-    set quote_next 0
-    set newcmd "submit --progress submit --runName=puq -l -i @:$tfile -d $params_file"
-    set cmds [split $cmd " "]
-    for {set i 0} {$i < [llength $cmds]} {incr i} {
-        set arg [lindex $cmds $i]
-        if {$quote_next == 1} {
-            set nc [string range $arg 0 0]
-            if {$nc != "\""} {
-                set arg "\"\\\"$arg\\\"\""
-            }
-        }
-        if {$arg == "--eval"} {
-            set quote_next 1
-        } else {
-            set quote_next 0
-        }
-        if {$arg == "@driver"} {
-            set arg "\"\\\"$tfile\\\"\""
-        }
-        append newcmd " " $arg
-    }
-    regsub -all @driver $newcmd $tfile newcmd
-    return $newcmd
-}
-
-# ----------------------------------------------------------------------
-# USAGE: _mkdir <directory>
-#
-# Used internally to create the <directory> in the file system.
-# The parent directory is also created, as needed.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::_mkdir {dir} {
-    set parent [file dirname $dir]
-    if {$parent ne "." && $parent ne "/"} {
-        if {![file exists $parent]} {
-            _mkdir $parent
-        }
-    }
-    file mkdir $dir
-}
-
-
-# ----------------------------------------------------------------------
-# USAGE: abort
-#
-# Clients use this during a "run" to abort the current job.
-# Kills the job and forces the "run" method to return.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::abort {} {
-    _log run abort
-    set job(control) "abort"
-}
-
-# ----------------------------------------------------------------------
-# USAGE: reset
-#
-# Resets all input values to their defaults.  Sometimes used just
-# before a run to reset to a clean state.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::reset {} {
-    $_xmlobj copy "" from $_origxml ""
-    foreach path [Rappture::entities -as path $_xmlobj input] {
-        if {[$_xmlobj element -as type $path.default] ne ""} {
-            set defval [$_xmlobj get $path.default]
-            $_xmlobj put $path.current $defval
-        }
-    }
-}
-
-# ----------------------------------------------------------------------
-# USAGE: xml <subcommand> ?<arg> <arg> ...?
-# USAGE: xml object
-#
-# Used by clients to manipulate the underlying XML data for this
-# tool.  The <subcommand> can be any operation supported by a
-# Rappture::library object.  Clients can also request the XML object
-# directly by using the "object" subcommand.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::xml {args} {
-    if {"object" == $args} {
-        return $_xmlobj
-    }
-    return [eval $_xmlobj $args]
-}
-
-# ----------------------------------------------------------------------
-# USAGE: save <xmlobj> ?<filename>?
-#
-# Used by clients to save the contents of an <xmlobj> representing
-# a run out to the given file.  If <filename> is not specified, then
-# it uses the -resultsdir and other settings to do what Rappture
-# would normally do with the output.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::save {xmlobj {filename ""}} {
-    if {$filename eq ""} {
-        # if there's a results_directory defined in the resources
-        # file, then move the run.xml file there for storage
-        set rdir ""
-        if {$resultdir eq "@default"} {
-            if {[info exists _resources(-resultdir)]} {
-                set rdir $_resources(-resultdir)
-            } else {
-                global rapptureInfo
-                set rdir $rapptureInfo(cwd)
-            }
-        } elseif {$resultdir ne ""} {
-            set rdir $resultdir
-        }
-
-        # use the runfile name generated by the last run
-        if {$_lastrun ne ""} {
-            set filename [file join $rdir $_lastrun]
-        } else {
-            set filename [file join $rdir run.xml]
-        }
-    }
-
-    # add any last-minute metadata
-    $xmlobj put output.time [clock format [clock seconds]]
-
-    $xmlobj put tool.version.rappture.version $::Rappture::version
-    $xmlobj put tool.version.rappture.revision $::Rappture::build
-    $xmlobj put output.filename $filename
-    $xmlobj put output.version $Rappture::version
-
-    if {[info exists ::tcl_platform(user)]} {
-        $xmlobj put output.user $::tcl_platform(user)
-    }
-
-    # save the output
-    set rdir [file dirname $filename]
-    if {![file exists $rdir]} {
-        _mkdir $rdir
-    }
-
-    set fid [open $filename w]
-    puts $fid "<?xml version=\"1.0\"?>"
-    puts $fid [$xmlobj xml]
-    close $fid
-
-    _log output saved in $filename
-}
-
-# ----------------------------------------------------------------------
-# USAGE: _output <data>
-#
-# Used internally to send each bit of output <data> coming from the
-# tool onto the caller, so the user can see progress.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::_output {data} {
-    if {[string length $_outputcb] > 0} {
-        uplevel #0 $_outputcb [list $data]
-    }
-}
-
-# ----------------------------------------------------------------------
-# USAGE: _log <cmd> <arg> <arg> ...
-#
-# Used internally to log interesting events during the run.  If the
-# -logger option is set (to Rappture::Logger::log, or something like
-# that), then the arguments to this method are passed along to the
-# logger and written out to a log file.  Logging is off by default,
-# so this method does nothing unless -logger is set.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::_log {args} {
-    if {[string length $logger] > 0} {
-        uplevel #0 $logger [list $args]
-    }
-}
-
-# ----------------------------------------------------------------------
-# USAGE: MiddlewareTime <key> <value> ...
-#
-# Used as the default method for reporting job status information.
-# Implements the old HUBzero method of reporting job status info to
-# stderr, which can then be picked up by the tool session container.
-# Most tools use the "submit" command, which talks directly to a
-# database to log job information, so this isn't really needed.  But
-# it doesn't hurt to have this and it can be useful in some cases.
-# ----------------------------------------------------------------------
-itcl::body Rappture::Task::MiddlewareTime {args} {
-    set line "MiddlewareTime:"
-    foreach {key val} $args {
-        append line " $key=$val"
-    }
-    puts stderr $line
-}
-
-
-#
-# Send the list of parameters to a python program so it can call PUQ
-# and get a CSV file containing the parameter values to use for the runs.
-itcl::body Rappture::Task::_get_params {varlist uq_type uq_args} {
-    set pid [pid]
-    # puts "puq get_params $pid $varlist $uq_type $uq_args"
-    if {[catch {exec puq get_params $pid $varlist $uq_type $uq_args}]} {
-        set fp [open "uq_debug.err" r]
-        set rdata [read $fp]
-        close $fp
-        puts "get_params.py failed: $rdata"
-        error "get_params.py: $rdata"
-    }
-    return params[pid].csv
-}
+        set _job(runfile) $fileName
+    }
+}

branches/1.6/src/core/config.h.in

@@ -240 +240 @@
 /* Define to the one symbol short name of this package. */
 #undef PACKAGE_TARNAME
+
+/* Define to the home page for this package. */
+#undef PACKAGE_URL
 
 /* Define to the version of this package. */