Merge pull request #6394 from BOINC/dpa_wsl_wrapper3

WSL wrapper enhancements

Author: AenBleidd

samples/docker_wrapper/docker_wrapper.cpp

@@ -193,7 +193,7 @@ DOCKER_CONN docker_conn;
 vector<string> app_args;
 DOCKER_TYPE docker_type;
 
-// parse job config file
+// parse job config file (job.toml)
 //
 int parse_config_file() {
     // defaults
@@ -684,7 +684,16 @@ int main(int argc, char** argv) {
     options.check_heartbeat = true;
     options.handle_process_control = true;
     boinc_init_options(&options);
+
+    // don't write to stderr before this; it won't go to stderr.txt
+
+    // parse job.toml
     retval = parse_config_file();
+    if (retval) {
+        fprintf(stderr, "can't parse config file\n");
+        exit(1);
+    }
+
     if (boinc_is_standalone()) {
         config.verbose = VERBOSE_STD;
         strcpy(image_name, "boinc");
@@ -697,10 +706,6 @@ int main(int argc, char** argv) {
         get_container_name();
     }
 
-    if (retval) {
-        fprintf(stderr, "can't parse config file\n");
-        exit(1);
-    }
     if (config.verbose) config.print();
 
     if (sporadic) {

samples/wsl_wrapper/main.sh

@@ -0,0 +1,10 @@
+#! /bin/bash
+
+# Shim for running worker with wsl_wrapper or docker_wrapper.
+# Resolves exec/in/out filenames, and passes cmdline args to worker.
+
+resolve () {
+    sed 's/<soft_link>//; s/<\/soft_link>//' $1 | tr -d '\r\n'
+}
+
+$(resolve worker) $@ $(resolve in) $(resolve out)

samples/wsl_wrapper/wsl_wrapper.cpp

@@ -17,10 +17,11 @@
 
 // wsl_wrapper: wrapper for WSL apps on Windows.
 //
-// cmdline options:
+// wsl_wrapper [options] arg1 arg2
+// arg1 arg2 ... are passed to the main program on cmdline
+// options:
 //
 // --main_prog X        name of main program (default "main")
-// --pass_thru args     additional cmdline arg for main program
 // --os_name_regex      use only distros w/ matching OS name
 // --os_version_regex
 // --min_libc_version MMmm      e.g. 235 means 2.35
@@ -34,11 +35,11 @@
 //   and relays this to the client.
 
 // implementation:
-// We use two WSL_CMDs (connections into the WSL container):
-// one to run the app, get its process group ID,
+// We use two WSL_CMDs (connections to shells the WSL container):
+// app_wc: run the app, get its process group ID,
 //      and capture its stdout and stderr
-// another to run a shell for monitoring and control operations (ps, kill)
-//      (this has less overhead than creating a shell per op)
+// ctl_wc: monitoring and control operations (ps, kill)
+//      this has less overhead than creating a shell per op
 //
 // Typically, the app has a control script as well as an executable.
 //      This might be written in bash or perl,
@@ -57,6 +58,7 @@
 
 #include <cstdio>
 #include <string>
+#include <vector>
 
 #include "boinc_win.h"
 #include "util.h"
@@ -65,6 +67,7 @@
 #include "app_ipc.h"
 
 using std::string;
+using std::vector;
 
 WSL_CMD app_wc;
 WSL_CMD ctl_wc;
@@ -110,8 +113,8 @@ int launch(const char* distro, const char* cmd) {
     retval = read_from_pipe(app_wc.out_read, app_wc.proc_handle, reply, CMD_TIMEOUT, "\n");
     if (retval) return error("app read_from_pipe", retval);
     pgid = atoi(reply.c_str());
+    fprintf(stderr, "launch reply: [%s]\n", reply.c_str());
     if (verbose) {
-        fprintf(stderr, "launch reply: [%s]\n", reply.c_str());
         fprintf(stderr, "pgid: %d\n", pgid);
     }
     running = true;
@@ -223,36 +226,48 @@ void poll_client_msgs() {
     }
 }
 
+// copy app_wc to our stderr;
+// called when job finishes
+//
+void copy_output() {
+    string reply;
+    read_from_pipe(
+        app_wc.out_read, app_wc.proc_handle, reply, CMD_TIMEOUT, NULL
+    );
+    fprintf(stderr, "output from container:\n%s\n", reply.c_str());
+}
+
 int main(int argc, char** argv) {
-    const char *os_name_regexp=".*", *os_version_regexp=".*", *pass_thru=NULL;
+    const char *os_name_regexp=".*", *os_version_regexp=".*";
     const char *main_prog = "main";
     int min_libc_version = 0;
+    vector<string> app_args;
+
+    // do this before writing to stderr, else the messages will be lost
+    //
+    BOINC_OPTIONS options;
+    memset(&options, 0, sizeof(options));
+    options.main_program = true;
+    options.check_heartbeat = true;
+    options.handle_process_control = true;
+    boinc_init_options(&options);
+
     for (int i=1; i<argc; i++) {
         if (!strcmp(argv[i], "--os_name_regexp")) {
             os_name_regexp = argv[++i];
         } else if (!strcmp(argv[i], "--os_version_regexp")) {
             os_version_regexp = argv[++i];
-        } else if (!strcmp(argv[i], "--pass_thru")) {
-            pass_thru = argv[++i];
         } else if (!strcmp(argv[i], "--min_libc_version")) {
             min_libc_version = atoi(argv[++i]);
         } else if (!strcmp(argv[i], "--verbose")) {
             verbose = true;
         } else if (!strcmp(argv[i], "--main_prog")) {
             main_prog = argv[++i];
         } else {
-            fprintf(stderr, "unknown option %s\n", argv[i]);
-            exit(1);
+            app_args.push_back(argv[i]);
         }
     }
 
-    BOINC_OPTIONS options;
-    memset(&options, 0, sizeof(options));
-    options.main_program = true;
-    options.check_heartbeat = true;
-    options.handle_process_control = true;
-    boinc_init_options(&options);
-
     string distro_name;
     if (boinc_is_standalone()) {
         SetCurrentDirectoryA("C:/ProgramData/BOINC/slots/test");
@@ -271,9 +286,9 @@ int main(int argc, char** argv) {
 
     string main_cmd = "./";
     main_cmd += main_prog;
-    if (pass_thru){
+    for (string s: app_args) {
         main_cmd += " ";
-        main_cmd += pass_thru;
+        main_cmd += s;
     }
     if (launch(distro_name.c_str(), main_cmd.c_str())) {
         fprintf(stderr, "launch failed\n");
@@ -287,10 +302,12 @@ int main(int argc, char** argv) {
         switch (poll_app(ru)) {
         case JOB_FAIL:
             fprintf(stderr, "job failed\n");
+            copy_output();
             boinc_finish(1);
             goto done;
         case JOB_SUCCESS:
             fprintf(stderr, "job succeeded\n");
+            copy_output();
             boinc_finish(0);
             goto done;
         }

tools/process_input_template.cpp

@@ -397,7 +397,10 @@ static int process_file_info(
     return 0;
 }
 
-// parse the <workunit> elements, which includes file refs and job params
+// Process the <workunit> section of an input template.
+// Copy resource usage and replication params to 'wu'.
+// Append XML (the workunit's xml_doc) to 'out'.
+// Add the given command line and additional XML.
 //
 static int process_workunit(
     XML_PARSER& xp, WORKUNIT& wu, string& out,

tools/submit_job

@@ -3,13 +3,24 @@
 
 // submit a job and show the WU name
 //
-// usage: submit_job [options] appname [infile ...]
-// options:
-//      --templates in out: specify in/out template files
-//      --verbose
-//      --target_user ID
-//
-// If the app uses a sample assimilator,
+
+function usage() {
+    return "
+usage: submit_job [options] appname [infile ...]
+options:
+     --templates in out     specify in/out template files
+     --verbose
+     --target_user ID
+     --command_line "X"     cmdline args to program
+";
+}
+
+// Note: to pass cmdline args to some apps you may need e.g.
+// bin/submit_job --command_line "--pass_thru \"--nsecs 17\"" worker infile
+// ... but this doesn't work with csh; use bash instead
+
+// This is basically create_work with nicer syntax, and it stages files.
+// Note: if the app uses a sample assimilator,
 // you can use query_job to query the job status and see output files.
 
 $appname = null;
@@ -18,6 +29,7 @@ $output_template = null;
 $infiles = [];
 $verbose = false;
 $target_user = null;
+$command_line = null;
 
 for ($i=1; $i<$argc; $i++) {
     if ($argv[$i] == '--templates') {
@@ -27,6 +39,8 @@ for ($i=1; $i<$argc; $i++) {
         $verbose = true;
     } else if ($argv[$i] == '--target_user') {
         $target_user = $argv[++$i];
+    } else if ($argv[$i] == '--command_line') {
+        $command_line = $argv[++$i];
     } else if (!$appname) {
         $appname = $argv[$i];
     } else {
@@ -35,7 +49,7 @@ for ($i=1; $i<$argc; $i++) {
 }
 
 if (!$appname) {
-    die("usage: demo_submit [--template fname] [--dir dir] appname [infile ...]\n");
+    die(usage());
 }
 
 chdir("html/ops");
@@ -96,6 +110,11 @@ if ($output_template) {
 if ($target_user) {
     $x .= " --target_user $target_user";
 }
+if ($command_line) {
+    $command_line = str_replace('"', '\"', $command_line);
+    $x .= sprintf('--command_line "%s"', $command_line);
+}
+
 $cmd = sprintf('bin/create_work --appname %s --wu_name %s %s %s',
     $appname, $wu_name, $x, implode(' ', $fnames)
 );

version.h

@@ -29,7 +29,10 @@
 // worker version number
 #define WORKER_RELEASE 5
 
-// dockerwrapper version number
+// wsl_wrapper
+#define WSL_WRAPPER_RELEASE 4
+
+// docker_wrapper version number
 #define DOCKERWRAPPER_RELEASE 6
 
 // client version number as string

win_build/wsl_wrapper.vcxproj

@@ -9,6 +9,12 @@
     <CharacterSet>MultiByte</CharacterSet>
   </PropertyGroup>
   <Import Project="boinc.props" />
+  <PropertyGroup>
+    <PlatformSuffix Condition="'$(Platform)'=='x64'">x86_64</PlatformSuffix>
+    <PlatformSuffix Condition="'$(Platform)'=='ARM64'">ARM64</PlatformSuffix>
+    <TargetVersion>4</TargetVersion>
+    <TargetName>$(ProjectName)_$(TargetVersion)_windows_$(PlatformSuffix)</TargetName>
+  </PropertyGroup>
   <ItemDefinitionGroup>
     <ClCompile>
       <AdditionalIncludeDirectories>.;..;../api;../lib;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>