Scenarios

• client_state.xml: describes the host and projects. Any projects that don't currently have tasks are ignored.
• global_prefs.xml and global_prefs_override.xml: computing preferences (optional).
• cc_config.xml: options such as GPU exclusions

You can modify these files, or create new ones, to study hypothetical scenarios (e.g. hosts with a large number of CPUs, hosts attached to a large number of projects, projects with very short or long jobs, and so on). See The BCE documentation for details.

Simulations

• The duration and time resolution of the simulation.
• Log flags

• A 'time line' showing CPU and GPU usage.
• The client's message log
• graphs of scheduling-related data (REC).
• A summary of several figures of merit, including
  • idle fraction: the fraction of processing power that was unused
  • wasted fraction: the fraction of processing power that was 'wasted' on jobs that missed their deadline
  • resource share violation: a measure [0..1] of the extent to which resource shares were disobeyed.
  • monotony: a measure [0..1] of the extent to which the client ran jobs of a single project for long periods

Comments and reports

Please post to the boinc_dev email list if

• a simulation reveals a bug or bad scheduling decision
• you have problems using BCE
• BCE doesn't do more or less the same thing as your client
• you have suggestions for new features.

Existing scenarios

".file_get_contents("$dir/inputs.txt")."
        
".file_get_contents("$dir/results.txt")."
        ".get_comments($dir)."
        
    ";
}

// 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"));
    start_table();
    row2("Creator", $user->name);
    row2("When", $date);
    row2("Description", $desc);
    $x = "client_state.xml";
    if (file_exists("$d/global_prefs.xml")) {
        $x .= "
global_prefs.xml\n";
    }
    if (file_exists("$d/global_prefs_override.xml")) {
        $x .= "
global_prefs_override.xml\n";
    }
    if (file_exists("$d/cc_config.xml")) {
        $x .= "
cc_config.xml\n";
    }
    row2("Input files", $x);
    end_table();
    show_button("sim_web.php?action=simulation_form&scen=$name",
        "Do new simulation",
        "Do new simulation"
    );
    echo "
Simulations
";
    start_table();
    echo "
            ID
Click for details
            Who
            When
            Parameters
            Results
            Comments
        
    ";

    $dirs = array();
    $s = opendir("$d/simulations");
    while (false !== ($f = readdir($s))) {
        if (!is_numeric($f)) continue;
        $dirs[] = $f;
    }
    rsort($dirs);
    foreach ($dirs as $f) {
        show_simulation_summary($name, $f);
    }
    end_table();

    page_tail();
}

function log_flag_boxes() {
    return "
         CPU scheduling debug
        
  Round-robin simulation info
        
  Round-robin simulation details
        
  Work fetch debug
    ";
}

function simulation_form() {
    $scen = get_str("scen");
    $detail = get_str("detail", true);
    page_head("Do simulation");
    start_table();
    echo "
        

        
        
        
        
        
        
        
    ";
    row2("Duration", " seconds");
    row2("Time step", " seconds");
    if ($detail) {
        row2("Half life of average-credit decay",
            " days"
        );
        row2("Existing jobs only?
            
If checked, simulate only the
            jobs in the client state file.
            Otherwise, simulate an infinite stream of jobs
            modeled after those in the state file.",
            ""
        );
        row2("Scheduler does detailed deadline check?
            
If checked, the scheduler's deadline
            decisions will use a detailed EDF simulation
            rather than an approximation.",
            ""
        );
        row2("Client uses pure Round-robin?
            
If checked, job scheduling will
            use a simple round-robin policy.",
            ""
        );
        row2("Include projects without apps",
            ""
        );
    } else {
        row2("", "More options");
    }
    row2("Log flags", log_flag_boxes());
    row2("", "");
    echo "\n";
    end_table();
    page_tail();
}

// create directory for simulation,
// run simulation,
// redirect to simulation page
//
function simulation_action() {
    $user = get_logged_in_user();
    $scen = post_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->duration = (double)post_str("duration");
    $policy->delta = (double)post_str("delta");
    $policy->rec_half_life = (double)post_str("rec_half_life_days")*86400;
    $policy->existing_jobs_only = post_str("existing_jobs_only", true);
    $policy->cpu_sched_rr_only = post_str("cpu_sched_rr_only", true);
    $policy->include_empty_projects = post_str("include_empty_projects", true);
    $policy->server_uses_workload = post_str("server_uses_workload", true);
    file_put_contents("$sim_path/userid", "$user->id");

    $x = "\n";
    if (post_str("cpu_sched_debug", true)) {
        $x .= "\n";
    }
    if (post_str("rr_simulation", true)) {
        $x .= "\n";
    }
    if (post_str("rrsim_detail", true)) {
        $x .= "\n";
    }
    if (post_str("work_fetch_debug", true)) {
        $x .= "\n";
    }
    $x .= "\n";
    file_put_contents("$sim_path/log_flags.xml", $x);

    do_sim("scenarios/$scen", $sim_path, $policy);
    header("Location: sim_web.php?action=show_simulation&scen=$scen&sim=$sim_name");
}

// show links to files in simulation directory
//
function show_simulation() {
    $scen = get_str("scen");
    $sim = get_str("sim");
    $dir = "scenarios/$scen/simulations/$sim";
    if (!is_dir($dir)) {
        error_page("No such simulation");
    }
    page_head("Simulation $sim");
    start_table();
    $userid = (int)file_get_contents("$dir/userid");
    $user = BoincUser::lookup_id($userid);
    $date = date_str(filemtime($dir));

    row2("Scenario", "$scen");
    row2("Who", $user->name);
    row2("When", $date);
    row2("Parameters", "
".file_get_contents("$dir/inputs.txt")."
");
    row2("Results", "
".file_get_contents("$dir/results.txt")."
");

    $x = file_get_contents("$dir/index.html");
    $x = str_replace("
Output files
", "", $x);
    $x = str_replace("href=", "href=scenarios/$scen/simulations/$sim/", $x);
    row2("Output files", $x);
    $x = get_comments($dir);
    if ($x) {
        row2("Comments", $x);
    }
    echo "

        
        
        
    ";
    row2("",
        ""
    );
    echo "
";
    end_table();
    page_tail();
}

function add_comment() {
    $user = get_logged_in_user();
    $scen = get_str("scen");
    $sim = get_str("sim");
    $dir = "scenarios/$scen/simulations/$sim";
    if (!is_dir($dir)) {
        error_page("No such simulation");
    }
    $cdir = "$dir/comments";
    @mkdir($cdir);
    $c = create_dir_seqno($cdir);
    $p = "$cdir/$c";
    file_put_contents("$p/userid", "$user->id");
    file_put_contents("$p/comment", get_str("comment"));

    header("Location: sim_web.php?action=show_simulation&scen=$scen&sim=$sim");
}

$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;
case "add_comment":
    add_comment();
    break;
case null:
    show_scenarios();
    break;
default:
    die("unknown action $action");
}

?>