boinc/doc/sim/sim_web.php

<?php
// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2011 University of California
//
// BOINC 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 3 of the License, or (at your option) any later version.
//
// BOINC 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.
//
// You should have received a copy of the GNU Lesser General Public License
// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.

// web interface to client simulator
//
// to use this, symlink to it from the html/user dir of a BOINC project,
// create an apache-writable dir called "scenarios" there,
// and symlink from html/inc to sim_util.inc

require_once("../inc/util.inc");
require_once("../inc/sim_util.inc");

function nsims($scen) {
    echo "kjf";
    $d = opendir("scenarios/$scen/simulations");
    echo "blah";
    $n = 0;
    while (false !== ($f = readdir($d))) {
        if ($f == ".") continue;
        if ($f == "..") continue;
        $n++;
    }
    return $n;
}

function show_scenario_summary($f) {
    $desc = file_get_contents("scenarios/$f/description");
    $userid = (int)file_get_contents("scenarios/$f/userid");
    $user = BoincUser::lookup_id($userid);
    echo "aaa";
    $date = date_str(filemtime("scenarios/$f"));
    echo "kjf";
    $nsims = nsims($f);
    echo "<tr>
        <td><a href=sim_web.php?action=show_scenario&name=$f>$f</a></td>
        <td>$user->name</td>
        <td>$date</td>
        <td>$nsims</td>
        <td>$desc</td>
        </tr>
    ";
}

// show existing scenarios, "create scenario" button
//
function show_scenarios() {
    page_head("The BOINC Client Emulator");
    echo "
        Welcome to the BOINC Client Emulator (BCE).
        BCE <b>emulates</b> a BOINC client attached to one or more projects.
        It predicts, in a few seconds,  what the BOINC client will do
        over a period of day or months.
        This allows BOINC developers to fix bugs and improve performance.
        <p>
        The inputs to BCE, called <b>scenarios</b>,
        describe a particular computer and the project to which it's attached.
        A scenario consists of 4 files:
        <ul>
        <li> <b>client_state.xml</b>: describes the host and projects.
        <li> <b>global_prefs.xml</b> and <b>global_prefs_override.xml</b>:
            computing preferences (optional).
        <li> <b>cc_config.xml</b>: client configuration (optional).
        </ul>
        You can use the files from a running BOINC client
        to emulate that client.
        You can modify these files, or create new ones, to study hypothetical hosts
        (e.g. ones with a large number of CPUs,
        attached to a large number of projects, and so on).
        See <a href=http://boinc.berkeley.edu/trac/wiki/ClientSim>The
        BCE documentation</a> for details.
        <p>
        You create a scenario by uploading these files to the BOINC server.
        Then you can run any number of <b>simulations</b> based on the scenario.
        The parameters of a simulation include
        <ul>
        <li> The duration and time resolution of the simulation.
        <li> Choices for various client policy alternatives.
        <li> The client version.
        </ul>
        The outputs of a simulation include
        <ul>
        <li> A graphical 'time line' showing CPU and GPU usage.
        <li> The client's message log
        <li> graphs of scheduling-related data (debt, REC).
        <li> A summary of several 'figures of merit',
            including idle and wasted processing fraction,
            resource share violation, and monotony.
        </ul>
        <p>
        <a href=sim_web.php?action=create_scenario_form>Create a scenario</a>
        <hr>
        <h3>Existing scenarios</h3>
        <table>
        <tr>
            <th>Number</th>
            <th>Creator</th>
            <th>When</th>
            <th># simulations</th>
            <th>Description</th>
        </tr>
    ";
    system("ls scenarios");
    $d = opendir("scenarios");
    while (false !== ($f = readdir($d))) {
        if ($f === ".") continue;
        if ($f === "..") continue;
        echo "showing $f";
        show_scenario_summary($f);
        echo "ret";
    }
    echo "</table>\n";
    page_tail();
}

// show form for creating a scenario
//
function create_scenario_form() {
    get_logged_in_user();
    page_head("Create a scenario");
    echo "
        To create a scenario:
        choose the input files,
        enter a short description, and click OK
        (items with * are required).
        <form action=sim_web.php method=post enctype=\"multipart/form-data\">
        <input type=hidden name=action value=create_scenario>
        <table>
    ";
    row2("* client_state.xml", "<input name=client_state type=file>");
    row2("global_prefs.xml", "<input name=prefs type=file>");
    row2("global_prefs_override.xml", "<input name=prefs_override type=file>");
    row2("cc_config.xml", "<input name=cc_config type=file>");
    row2("* Description", "<textarea name=description cols=40></textarea>");
    row2("", "<input type=submit value=OK>");
    echo "
        </table>
        </form>
    ";
    page_tail();
}

// create a subdir $dir/N for the first available N
//
function create_dir_seqno($dir) {
    $i = -1;
    $d = opendir($dir);
    while (false !== ($f = readdir($d))) {
        $j = -1;
        $n = sscanf($f, "%d", $j);
        if ($n == 1 && $j >= 0) {
            if ($j > $i) {
                $i = $j;
            }
        }
    }
    $i++;
    $p = "$dir/$i";
    mkdir($p);
    return "$i";
}

// choose scenario name
// create dir, put files there
// create meta-data file
// redirect to show scenario
//
function create_scenario() {
    $user = get_logged_in_user();
    $csname = $_FILES['client_state']['tmp_name'];
    if (!is_uploaded_file($csname)) {
        error_page("You must specify a client_state.xml file.");
    }
    $desc = post_str("description", true);
    if (!strlen($desc)) {
        error_page("You must supply a description.");
    }
    $desc = strip_tags($desc);
    $sname = create_dir_seqno("scenarios");
    $d = "scenarios/$sname";
    move_uploaded_file($csname, "$d/client_state.xml");
    $gp = $_FILES['global_prefs']['tmp_name'];
    if (is_uploaded_file($gp)) {
        move_uploaded_file($gp, "$d/global_prefs.xml");
    }
    $gpo = $_FILES['global_prefs_override']['tmp_name'];
    if (is_uploaded_file($gpo)) {
        move_uploaded_file($gpo, "$d/global_prefs_override.xml");
    }
    $cc = $_FILES['cc_config']['tmp_name'];
    if (is_uploaded_file($cc)) {
        move_uploaded_file($cc, "$d/cc_config.xml");
    }
    file_put_contents("$d/userid", "$user->id");
    file_put_contents("$d/description", $desc);
    mkdir("$d/simulations");
    header("Location: sim_web.php?action=show_scenario&name=$sname");
}

// show:
// links to files
// list of existing simulations
// link for new simulation
//
function show_scenario() {
    $name = get_str("name");
    $d = "scenarios/$name";
    if (!is_dir($d)) {
        error_page("No such scenario");
    }
    page_head("Scenario $name");
    $desc = file_get_contents("scenarios/$name/description");
    $userid = (int)file_get_contents("scenarios/$name/userid");
    $user = BoincUser::lookup_id($userid);
    $date = date_str(filemtime("scenarios/$name"));
    echo "Creator: $user->name
        <p>When: $date
        <p>Description: $desc
    ";
    echo "<p>Input files:
        <p>
        <a href=$d/client_state.xml>client_state.xml</a>
    ";
    if (file_exists("$d/global_prefs.xml")) {
        echo "<p><a href=$d/global_prefs.xml>global_prefs.xml</a>\n";
    }
    if (file_exists("$d/global_prefs_override.xml")) {
        echo "<p><a href=$d/global_prefs_override.xml>global_prefs_override.xml</a>\n";
    }
    if (file_exists("$d/cc_config.xml")) {
        echo "<p><a href=$d/cc_config.xml>cc_config.xml</a>\n";
    }
    echo "<p><a href=sim_web.php?action=simulation_form&scen=$name>Do new simulation</a>\n";
    echo "<hr>Simulations";
    $s = opendir("$d/simulations");
    while (false !== ($f = readdir($s))) {
        if (!is_numeric($f)) continue;
        echo "<p><a href=sim_web.php?action=show_simulation&scen=$name&sim=$f>$f</a>\n";
    }

    page_tail();
}

// form for simulation parameters:
// duration, time step, policy options
//
function simulation_form() {
    $scen = get_str("scen");
    page_head("Do simulation");
    echo "<form action=sim_web.php>
        <input type=hidden name=action value=simulation_action>
        <input type=hidden name=scen value=$scen>
        <table>
    ";
    row2("Duration", "<input name=duration value=86400> seconds");
    row2("Time step", "<input name=delta value=60> seconds");
    row2("Recent Estimated Credit", "<input type=checkbox name=use_rec>");
    row2("Server EDF simulation?", "<input type=checkbox name=server_uses_workload>");
    row2("Client uses pure RR?", "<input type=checkbox name=cpu_sched_rr_only>");
    row2("", "<input type=submit value=OK>");
    echo "</table>";
    page_tail();
}

// create directory for simulation,
// run simulation,
// redirect to simulation page
//
function simulation_action() {
    $scen = get_str("scen");
    if (!is_dir("scenarios/$scen")) {
        error_page("no such scenario");
    }
    $sim_dir = "scenarios/$scen/simulations";
    $sim_name = create_dir_seqno($sim_dir);
    $sim_path = "$sim_dir/$sim_name";
    $policy = new POLICY("");
    $policy->use_rec = get_str("use_rec", true);
    $policy->use_hyst_fetch = get_str("use_hyst_fetch", true);
    $policy->cpu_sched_rr_only = get_str("cpu_sched_rr_only", true);
    $policy->server_uses_workload = get_str("server_uses_workload", true);

    do_sim("scenarios/$scen", $sim_path, $policy);
}

// show links to files in simulation directory
//
function show_simulation() {
    $scen = get_str("scen");
    $sim = get_str("sim");
    $path = "scenarios/$scen/simulations/$sim";
    if (!is_dir($path)) {
        error_page("No such simulation");
    }
    page_head("Simulation result");
    $d = opendir($path);
    while (false !== ($f = readdir($d))) {
        if ($f == ".") continue;
        if ($f == "..") continue;
        $p = "$path/$f";
        echo "<a href=$p>$f</a>";
    }
    page_tail();
}

$action = get_str("action", true);
if (!$action) $action = post_str("action", true);

switch ($action) {
case "create_scenario_form":
    create_scenario_form();
    break;
case "create_scenario":
    create_scenario();
    break;
case "show_scenario":
    show_scenario();
    break;
case "simulation_form":
    simulation_form();
    break;
case "simulation_action":
    simulation_action();
    break;
case "show_simulation":
    show_simulation();
    break;
default:
    show_scenarios();
}

?>