// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2018 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 .
#include "cc_config.h"
#ifdef _WIN32
#include "boinc_win.h"
#else
#include "config.h"
#include
#include
#include
#include
#endif
#include "common_defs.h"
#include "diagnostics.h"
#include "error_numbers.h"
#include "filesys.h"
#include "parse.h"
#include "str_util.h"
#include "url.h"
#include "cc_config.h"
using std::string;
void LOG_FLAGS::init() {
static const LOG_FLAGS x;
*this = x;
}
// Parse log flag preferences
//
int LOG_FLAGS::parse(XML_PARSER& xp) {
init();
while (!xp.get_tag()) {
if (!xp.is_tag) {
continue;
}
if (xp.match_tag("/log_flags")) return 0;
if (xp.parse_bool("file_xfer", file_xfer)) continue;
if (xp.parse_bool("sched_ops", sched_ops)) continue;
if (xp.parse_bool("task", task)) continue;
#ifdef ANDROID
if (xp.parse_bool("android_debug", android_debug)) continue;
#endif
if (xp.parse_bool("app_msg_receive", app_msg_receive)) continue;
if (xp.parse_bool("app_msg_send", app_msg_send)) continue;
if (xp.parse_bool("async_file_debug", async_file_debug)) continue;
if (xp.parse_bool("benchmark_debug", benchmark_debug)) continue;
if (xp.parse_bool("checkpoint_debug", checkpoint_debug)) continue;
if (xp.parse_bool("coproc_debug", coproc_debug)) continue;
if (xp.parse_bool("cpu_sched", cpu_sched)) continue;
if (xp.parse_bool("cpu_sched_debug", cpu_sched_debug)) continue;
if (xp.parse_bool("cpu_sched_status", cpu_sched_status)) continue;
if (xp.parse_bool("dcf_debug", dcf_debug)) continue;
if (xp.parse_bool("disk_usage_debug", disk_usage_debug)) continue;
if (xp.parse_bool("file_xfer_debug", file_xfer_debug)) continue;
if (xp.parse_bool("gui_rpc_debug", gui_rpc_debug)) continue;
if (xp.parse_bool("heartbeat_debug", heartbeat_debug)) continue;
if (xp.parse_bool("http_debug", http_debug)) continue;
if (xp.parse_bool("http_xfer_debug", http_xfer_debug)) continue;
if (xp.parse_bool("idle_detection_debug", idle_detection_debug)) continue;
if (xp.parse_bool("mem_usage_debug", mem_usage_debug)) continue;
if (xp.parse_bool("network_status_debug", network_status_debug)) continue;
if (xp.parse_bool("notice_debug", notice_debug)) continue;
if (xp.parse_bool("poll_debug", poll_debug)) continue;
if (xp.parse_bool("priority_debug", priority_debug)) continue;
if (xp.parse_bool("proxy_debug", proxy_debug)) continue;
if (xp.parse_bool("rr_simulation", rr_simulation)) continue;
if (xp.parse_bool("rrsim_detail", rrsim_detail)) continue;
if (xp.parse_bool("sched_op_debug", sched_op_debug)) continue;
if (xp.parse_bool("scrsave_debug", scrsave_debug)) continue;
if (xp.parse_bool("slot_debug", slot_debug)) continue;
if (xp.parse_bool("sporadic_debug", sporadic_debug)) continue;
if (xp.parse_bool("state_debug", state_debug)) continue;
if (xp.parse_bool("statefile_debug", statefile_debug)) continue;
if (xp.parse_bool("suspend_debug", suspend_debug)) continue;
if (xp.parse_bool("task_debug", task_debug)) continue;
if (xp.parse_bool("time_debug", time_debug)) continue;
if (xp.parse_bool("trickle_debug", trickle_debug)) continue;
if (xp.parse_bool("unparsed_xml", unparsed_xml)) continue;
if (xp.parse_bool("work_fetch_debug", work_fetch_debug)) continue;
xp.skip_unexpected(true, "LOG_FLAGS::parse");
}
return ERR_XML_PARSE;
}
int LOG_FLAGS::write(MIOFILE& out) {
out.printf(
" \n"
" %d\n"
" %d\n"
" %d\n"
#ifdef ANDROID
" %d\n"
#endif
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" \n",
file_xfer ? 1 : 0,
sched_ops ? 1 : 0,
task ? 1 : 0,
#ifdef ANDROID
android_debug ? 1 : 0,
#endif
app_msg_receive ? 1 : 0,
app_msg_send ? 1 : 0,
async_file_debug ? 1 : 0,
benchmark_debug ? 1 : 0,
checkpoint_debug ? 1 : 0,
coproc_debug ? 1 : 0,
cpu_sched ? 1 : 0,
cpu_sched_debug ? 1 : 0,
cpu_sched_status ? 1 : 0,
dcf_debug ? 1 : 0,
disk_usage_debug ? 1 : 0,
file_xfer_debug ? 1 : 0,
gui_rpc_debug ? 1 : 0,
heartbeat_debug ? 1 : 0,
http_debug ? 1 : 0,
http_xfer_debug ? 1 : 0,
idle_detection_debug ? 1 : 0,
mem_usage_debug ? 1 : 0,
network_status_debug ? 1 : 0,
notice_debug ? 1 : 0,
poll_debug ? 1 : 0,
priority_debug ? 1 : 0,
proxy_debug ? 1 : 0,
rr_simulation ? 1 : 0,
rrsim_detail ? 1 : 0,
sched_op_debug ? 1 : 0,
scrsave_debug ? 1 : 0,
slot_debug ? 1 : 0,
sporadic_debug ? 1 : 0,
state_debug ? 1 : 0,
statefile_debug ? 1 : 0,
suspend_debug ? 1 : 0,
task_debug ? 1 : 0,
time_debug ? 1 : 0,
trickle_debug ? 1 : 0,
unparsed_xml ? 1 : 0,
work_fetch_debug ? 1 : 0
);
return 0;
}
CC_CONFIG::CC_CONFIG() {
defaults();
}
// this is called first thing by client
//
void CC_CONFIG::defaults() {
abort_jobs_on_exit = false;
allow_gui_rpc_get = false;
allow_multiple_clients = false;
allow_remote_gui_rpc = false;
alt_platforms.clear();
config_coprocs.clear();
disallow_attach = false;
dont_check_file_sizes = false;
dont_contact_ref_site = false;
dont_suspend_nci = false;
dont_use_vbox = false;
dont_use_wsl = false;
exclude_gpus.clear();
exclusive_apps.clear();
exclusive_gpu_apps.clear();
exit_after_finish = false;
exit_before_start = false;
exit_when_idle = false;
fetch_minimal_work = false;
fetch_on_update = false;
force_auth = "default";
http_1_0 = false;
http_transfer_timeout = 300;
http_transfer_timeout_bps = 10;
for (int i=1; i= MAX_COPROC_INSTANCES) {
return ERR_XML_PARSE;
}
return 0;
}
if (xp.parse_string("url", url)) {
canonicalize_master_url(url);
found_url = true;
continue;
}
if (xp.parse_int("device_num", device_num)) continue;
if (xp.parse_string("type", type)) continue;
if (xp.parse_string("app", appname)) continue;
}
return ERR_XML_PARSE;
}
// This is used by GUI RPC clients, NOT by the BOINC client
// KEEP IN SYNCH WITH CC_CONFIG::parse_options_client()!!
//
int CC_CONFIG::parse_options(XML_PARSER& xp) {
string s;
int n, retval;
//clear();
// don't do this here because some options are set by cmdline args,
// which are parsed first
// but do clear these, which aren't accessable via cmdline:
//
alt_platforms.clear();
exclusive_apps.clear();
exclusive_gpu_apps.clear();
for (int i=1; i\n"
" %s\n"
" %d\n",
url.c_str(),
device_num
);
if (type.length()) {
out.printf(
" %s\n",
type.c_str()
);
}
if (appname.length()) {
out.printf(
" %s\n",
appname.c_str()
);
}
out.printf(
" \n"
);
}
int CC_CONFIG::write(MIOFILE& out, LOG_FLAGS& log_flags) {
int j;
unsigned int i;
out.printf("\n");
log_flags.write(out);
out.printf(
" \n"
" %d\n"
" %d\n"
" %d\n"
" %d\n",
abort_jobs_on_exit ? 1 : 0,
allow_gui_rpc_get ? 1 : 0,
allow_multiple_clients ? 1 : 0,
allow_remote_gui_rpc ? 1 : 0
);
for (i=0; i%s\n",
alt_platforms[i].c_str()
);
}
for (int k=1; k\n"
" %s\n"
" %d\n"
" %f\n"
" ",
config_coprocs.coprocs[k].type,
config_coprocs.coprocs[k].count,
config_coprocs.coprocs[k].peak_flops
);
for (j=0; j\n"
" \n"
);
}
out.printf(
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n",
disallow_attach,
dont_check_file_sizes,
dont_contact_ref_site,
lower_client_priority,
dont_suspend_nci,
dont_use_vbox,
dont_use_wsl
);
for (i=0; i%s\n",
exclusive_apps[i].c_str()
);
}
for (i=0; i%s\n",
exclusive_gpu_apps[i].c_str()
);
}
out.printf(
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %s\n"
" %d\n"
" %d\n"
" %d\n",
exit_after_finish,
exit_before_start,
exit_when_idle,
fetch_minimal_work,
fetch_on_update,
force_auth.c_str(),
http_1_0,
http_transfer_timeout,
http_transfer_timeout_bps
);
for (i=0; i%d\n",
ignore_gpu_instance[PROC_TYPE_NVIDIA_GPU][i]
);
}
for (i=0; i%d\n",
ignore_gpu_instance[PROC_TYPE_AMD_GPU][i]
);
}
for (i=0; i%d\n",
ignore_gpu_instance[PROC_TYPE_INTEL_GPU][i]
);
}
out.printf(
" %d\n"
" %d\n"
" %d\n"
" %f\n"
" %f\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n",
max_event_log_lines,
max_file_xfers,
max_file_xfers_per_project,
max_stderr_file_size,
max_stdout_file_size,
max_tasks_reported,
ncpus,
no_alt_platform,
no_gpus,
no_info_fetch,
no_opencl,
no_priority_change,
no_rdp_check,
os_random_only,
process_priority,
process_priority_special
);
proxy_info.write(out);
out.printf(
" %f\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %f\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n"
" %d\n",
rec_half_life/86400,
report_results_immediately,
run_apps_manually,
save_stats_days,
skip_cpu_benchmarks,
simple_gui_only,
start_delay,
stderr_head,
suppress_net_info,
unsigned_apps_ok,
use_all_gpus,
use_certs,
use_certs_only,
vbox_window
);
for (i=0; i%s\n",
ignore_tty[i].c_str()
);
}
out.printf(" \n\n");
return 0;
}
// app_config.xml stuff
bool have_max_concurrent = false;
// does any project have a max concurrent restriction?
int APP_CONFIG::parse_gpu_versions(
XML_PARSER& xp, MSG_VEC& mv, LOG_FLAGS& log_flags
) {
double x;
char buf[1024];
while (!xp.get_tag()) {
if (xp.match_tag("/gpu_versions")) return 0;
else if (xp.parse_double("gpu_usage", x)) {
if (x <= 0) {
mv.push_back(string("gpu_usage must be positive in app_config.xml"));
} else {
gpu_gpu_usage = x;
}
continue;
}
else if (xp.parse_double("cpu_usage", x)) {
if (x < 0) {
mv.push_back(string("cpu_usage must be non-negative in app_config.xml"));
} else {
gpu_cpu_usage = x;
}
continue;
}
if (log_flags.unparsed_xml) {
snprintf(buf, sizeof(buf), "Unparsed line in app_config.xml: %.128s", xp.parsed_tag);
mv.push_back(string(buf));
}
}
mv.push_back(string("Missing in app_config.xml"));
return ERR_XML_PARSE;
}
int APP_CONFIG::parse(XML_PARSER& xp, MSG_VEC& mv, LOG_FLAGS& log_flags) {
char buf[1024];
static const APP_CONFIG init;
*this = init;
while (!xp.get_tag()) {
if (xp.match_tag("/app")) return 0;
if (xp.parse_str("name", name, 256)) continue;
if (xp.parse_int("max_concurrent", max_concurrent)) {
if (max_concurrent) {
have_max_concurrent = true;
}
continue;
}
if (xp.match_tag("gpu_versions")) {
int retval = parse_gpu_versions(xp, mv, log_flags);
if (retval) return retval;
continue;
}
if (xp.parse_bool("fraction_done_exact", fraction_done_exact)) {
continue;
}
if (xp.parse_bool("report_results_immediately", report_results_immediately)) {
continue;
}
// unparsed XML not considered an error; maybe it should be?
//
if (log_flags.unparsed_xml) {
snprintf(buf, sizeof(buf), "Unparsed line in app_config.xml: %.128s", xp.parsed_tag);
mv.push_back(string(buf));
}
xp.skip_unexpected(log_flags.unparsed_xml, "APP_CONFIG::parse");
}
mv.push_back(string("Missing in app_config.xml"));
return ERR_XML_PARSE;
}
int APP_VERSION_CONFIG::parse(
XML_PARSER& xp, MSG_VEC& mv, LOG_FLAGS& log_flags
) {
char buf[1024];
static const APP_VERSION_CONFIG init;
*this = init;
while (!xp.get_tag()) {
if (!xp.is_tag) {
snprintf(buf, sizeof(buf), "unexpected text '%.128s' in app_config.xml", xp.parsed_tag);
mv.push_back(string(buf));
return ERR_XML_PARSE;
}
if (xp.match_tag("/app_version")) return 0;
if (xp.parse_str("app_name", app_name, 256)) continue;
if (xp.parse_str("plan_class", plan_class, 256)) continue;
if (xp.parse_str("cmdline", cmdline, 256)) continue;
if (xp.parse_double("avg_ncpus", avg_ncpus)) continue;
if (xp.parse_double("ngpus", ngpus)) continue;
if (log_flags.unparsed_xml) {
snprintf(buf, sizeof(buf), "Unparsed line in app_config.xml: %.128s", xp.parsed_tag);
mv.push_back(string(buf));
}
xp.skip_unexpected(log_flags.unparsed_xml, "APP_VERSION_CONFIG::parse");
}
mv.push_back(string("Missing in app_config.xml"));
return ERR_XML_PARSE;
}
int APP_CONFIGS::parse(XML_PARSER& xp, MSG_VEC& mv, LOG_FLAGS& log_flags) {
char buf[1024];
int n;
clear();
while (!xp.get_tag()) {
if (!xp.is_tag) {
snprintf(buf, sizeof(buf), "unexpected text '%.128s' in app_config.xml", xp.parsed_tag);
mv.push_back(string(buf));
return ERR_XML_PARSE;
}
if (xp.match_tag("/app_config")) return 0;
if (xp.match_tag("app")) {
APP_CONFIG ac;
int retval = ac.parse(xp, mv, log_flags);
if (retval) return retval;
app_configs.push_back(ac);
if (ac.max_concurrent) {
project_has_mc = true;
project_min_mc = project_min_mc?std::min(project_min_mc, ac.max_concurrent):ac.max_concurrent;
}
continue;
}
if (xp.match_tag("app_version")) {
APP_VERSION_CONFIG avc;
int retval = avc.parse(xp, mv, log_flags);
if (retval) return retval;
app_version_configs.push_back(avc);
continue;
}
if (xp.parse_int("project_max_concurrent", n)) {
if (n > 0) {
have_max_concurrent = true;
project_has_mc = true;
project_max_concurrent = n;
project_min_mc = project_min_mc?std::min(project_min_mc, n):n;
}
continue;
}
if (xp.parse_bool("report_results_immediately", report_results_immediately)) {
continue;
}
snprintf(buf, sizeof(buf), "Unknown tag in app_config.xml: %.128s", xp.parsed_tag);
mv.push_back(string(buf));
xp.skip_unexpected(log_flags.unparsed_xml, "APP_CONFIGS::parse");
}
mv.push_back(string("Missing in app_config.xml"));
return ERR_XML_PARSE;
}
int APP_CONFIGS::parse_file(FILE* f, MSG_VEC& mv, LOG_FLAGS& log_flags) {
MIOFILE mf;
XML_PARSER xp(&mf);
mf.init_file(f);
if (!xp.parse_start("app_config")) {
mv.push_back(string("Missing in app_config.xml"));
return ERR_XML_PARSE;
}
return parse(xp, mv, log_flags);
}
void APP_CONFIGS::write(MIOFILE& out) {
out.printf(
"\n"
);
for (unsigned int i=0; i\n"
" %s\n"
" %d\n"
" \n"
" %f\n"
" %f\n"
" \n"
" %d\n"
" %d\n"
" \n",
ac.name,
ac.max_concurrent,
ac.gpu_gpu_usage,
ac.gpu_cpu_usage,
ac.fraction_done_exact?1:0,
ac.report_results_immediately?1:0
);
}
for (unsigned int i=0; i\n"
" %s\n"
" %s\n"
" %s\n"
" %f\n"
" %f\n"
" \n",
avc.app_name,
avc.plan_class,
avc.cmdline,
avc.avg_ncpus,
avc.ngpus
);
}
out.printf(
" %d\n"
" %d\n"
"\n",
project_max_concurrent,
report_results_immediately?1:0
);
}