boinc/wrapper/wrapper.C

// Berkeley Open Infrastructure for Network Computing
// http://boinc.berkeley.edu
// Copyright (C) 2005 University of California
//
// This is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation;
// either version 2.1 of the License, or (at your option) any later version.
//
// This software 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 Lesser General Public License for more details.
//
// To view the GNU Lesser General Public License visit
// http://www.gnu.org/copyleft/lesser.html
// or write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

// wrapper.C
// wrapper program - lets you use a non-BOINC app with BOINC
//
// Handles:
// - suspend/resume/quit/abort
// - copying input/output files
// - reporting CPU time
// - loss of heartbeat from core client
//
// Does NOT handle:
// - checkpointing
// If your app does checkpointing,
// and there's some way to figure out when it's done it,
// this program could be modified to report to the core client.
//
// Takes an input file "job.xml" of the form
// <job_desc>
//    <application>NAME</application>
//    <input_file>NAME0</input_file>
//    ...
//    <output_file>NAME0</output_file>
//    ...
// </job_desc>

#include <stdio.h>
#include <vector>
#include <string>
#ifdef _WIN32
#include "boinc_win.h"
#else
#include <unistd.h>
#include <sys/wait.h>
#endif

#include "boinc_api.h"
#include "filesys.h"
#include "parse.h"
#include "util.h"
#include "error_numbers.h"

using std::vector;
using std::string;

vector<string> input_files;
vector<string> output_files;
string application;
bool first = true;
#ifdef _WIN32
HANDLE pid_handle;
HANDLE thread_handle;
#else
int pid;
#endif
bool app_suspended = false;

int copy_input_files() {
    int retval;
    for (unsigned int i=0; i<input_files.size(); i++) {
        string filename;
        boinc_resolve_filename_s(input_files[i].c_str(), filename);
        retval = boinc_copy(filename.c_str(), input_files[i].c_str());
        if (retval) return retval;
    }
    return 0;
}

int copy_output_files() {
    int retval;
    for (unsigned int i=0; i<output_files.size(); i++) {
        string filename;
        boinc_resolve_filename_s(output_files[i].c_str(), filename);
        retval = boinc_copy(input_files[i].c_str(), filename.c_str());
        if (retval) return retval;
    }
    return 0;
}

int parse_job_file() {
    char tag[256], contents[1024], buf[256];
    boinc_resolve_filename("job.xml", buf, 1024);
    FILE* f = boinc_fopen(buf, "r");
    if (!f) return ERR_FOPEN;
    get_tag(f, tag);
    if (strstr(tag, "?xml")) get_tag(f, tag);
    if (strcmp(tag, "job_desc")) return ERR_XML_PARSE;
    while(get_tag(f, tag, contents)) {
        if (!strcmp(tag, "/job_desc")) {
            return 0;
        }
        if (!strcmp(tag, "application")) {
            application = contents;
            continue;
        }
        if (!strcmp(tag, "input_file")) {
            string temp = contents;
            input_files.push_back(temp);
            continue;
        }
        if (!strcmp(tag, "output_file")) {
            string temp = contents;
            output_files.push_back(temp);
            continue;
        }
    }
    return ERR_XML_PARSE;
}

// the "state file" might tell us which app we're in the middle of,
// what the starting CPU time is, etc.
//
void parse_state_file() {
}

int run_application(char** argv) {
#ifdef _WIN32
    PROCESS_INFORMATION process_info;
    STARTUPINFO startup_info;
    memset(&process_info, 0, sizeof(process_info));
    memset(&startup_info, 0, sizeof(startup_info));
             
    if (!CreateProcess(application.c_str(),
        (LPSTR)application.c_str(),
        NULL,
        NULL,
        FALSE,
        CREATE_NO_WINDOW|IDLE_PRIORITY_CLASS,
        NULL,
        NULL,
        &startup_info,
        &process_info
    )) {
        return ERR_EXEC;
    }
    pid_handle = process_info.hProcess;
    thread_handle = process_info.hThread;
#else
    int retval;
    char progname[256], buf[256];
    pid = fork();
    if (pid == -1) {
        boinc_finish(ERR_FORK);
    }
    if (pid == 0) {
        strcpy(progname, application.c_str());
        boinc_resolve_filename(progname, buf, sizeof(buf));
        printf("running %s\n", buf);
        argv[0] = buf;
        retval = execv(buf, argv);
        exit(ERR_EXEC);
    }
#endif
    return 0;
}

bool poll_application(int& status) {
#ifdef _WIN32
    unsigned long exit_code;
    if (GetExitCodeProcess(pid_handle, &exit_code)) {
        if (exit_code != STILL_ACTIVE) {
            return true;
            status = exit_code;
        }
    }
#else
    int wpid, stat;
    wpid = waitpid(pid, &stat, WNOHANG);
    if (wpid) {
        status = stat;
        return true;
    }
#endif
    return false;
}

void kill_app() {
#ifdef _WIN32
    TerminateProcess(pid_handle, -1);
#else
    kill(pid, SIGKILL);
#endif
}

void stop_app() {
#ifdef _WIN32
    SuspendThread(thread_handle);
#else
    kill(pid, SIGSTOP);
#endif
}

void resume_app() {
#ifdef _WIN32
    ResumeThread(thread_handle);
#else
    kill(pid, SIGCONT);
#endif
}

void poll_boinc_messages() {
    BOINC_STATUS status;
    boinc_get_status(&status);
    if (status.no_heartbeat) {
        kill_app();
        exit(0);
    }
    if (status.quit_request) {
        kill_app();
        exit(0);
    }
    if (status.abort_request) {
        kill_app();
        exit(0);
    }
    if (status.suspended) {
        if (!app_suspended) {
            stop_app();
            app_suspended = true;
        }
    } else {
        if (app_suspended) {
            resume_app();
            app_suspended = false;
        }
    }
}

double cpu_time() {
#ifdef _WIN32
    FILETIME creation_time, exit_time, kernel_time, user_time;
    ULARGE_INTEGER tKernel, tUser;
    LONGLONG totTime;

    GetProcessTimes(
        pid_handle, &creation_time, &exit_time, &kernel_time, &user_time
    );

    tKernel.LowPart  = kernel_time.dwLowDateTime;
    tKernel.HighPart = kernel_time.dwHighDateTime;
    tUser.LowPart    = user_time.dwLowDateTime;
    tUser.HighPart   = user_time.dwHighDateTime;
    totTime = tKernel.QuadPart + tUser.QuadPart;

    double cpu = totTime / 1.e7;
    return cpu;
#else
    static double t=0, cpu;
    if (t) {
        double now = dtime();
        cpu += now-t;
        t = now;
    } else {
        t = dtime();
    }
    return cpu;
#endif
}

void send_status_message() {
    boinc_report_app_status(cpu_time(), 0, 0);
}

int main(int argc, char** argv) {
    BOINC_OPTIONS options;
    int retval;

    memset(&options, 0, sizeof(options));
    options.main_program = true;
    options.check_heartbeat = true;
    options.handle_process_control = true;

    boinc_init_options(&options);
    retval = parse_job_file();
    if (retval) {
        fprintf(stderr, "can't parse job file: %d\n", retval);
        boinc_finish(retval);
    }

    parse_state_file();

    if (first) {
        retval = copy_input_files();
    }

    retval = run_application(argv);
    if (retval) {
        fprintf(stderr, "can't run app: %d\n", retval);
        boinc_finish(retval);
    }
    while(1) {
        int status;
        if (poll_application(status)) {
            copy_output_files();
            boinc_finish(status);
        }
        poll_boinc_messages();
        send_status_message();
        boinc_sleep(1.);
    }
}

#ifdef _WIN32

int WINAPI WinMain(HINSTANCE hInst, HINSTANCE hPrevInst, LPSTR Args, int WinMode) {
    LPSTR command_line;
    char* argv[100];
    int argc;

    command_line = GetCommandLine();
    argc = parse_command_line( command_line, argv );
    return main(argc, argv);
}
#endif