boinc/sched/handle_request.C

766 lines
23 KiB
C

// The contents of this file are subject to the Mozilla Public License
// Version 1.0 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://www.mozilla.org/MPL/
//
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
// License for the specific language governing rights and limitations
// under the License.
//
// The Original Code is the Berkeley Open Infrastructure for Network Computing.
//
// The Initial Developer of the Original Code is the SETI@home project.
// Portions created by the SETI@home project are Copyright (C) 2002
// University of California at Berkeley. All Rights Reserved.
//
// Contributor(s):
//
// Handle a scheduling server RPC
#include <iostream>
#include <vector>
#include <string>
using namespace std;
#include <stdio.h>
#include <unistd.h>
#include <sys/wait.h>
#include <time.h>
#include <assert.h>
#include <math.h>
#include "boinc_db.h"
#include "backend_lib.h"
#include "parse.h"
#include "util.h"
#include "server_types.h"
#include "main.h"
#include "handle_request.h"
#define MIN_SECONDS_TO_SEND 0
#define MAX_SECONDS_TO_SEND (28*SECONDS_PER_DAY)
#define MAX_WUS_TO_SEND 10
// return true if the WU can be executed on the host
//
bool wu_is_feasible(WORKUNIT& wu, HOST& host) {
char buf[256];
if(host.d_free && wu.rsc_disk > host.d_free) {
sprintf(buf, "WU %d needs %f disk; host %d has %f\n",
wu.id, wu.rsc_disk, host.id, host.d_free
);
write_log(buf);
return false;
}
if (host.m_nbytes && wu.rsc_memory > host.m_nbytes) {
sprintf(buf, "WU %d needs %f mem; host %d has %f\n",
wu.id, wu.rsc_memory, host.id, host.m_nbytes
);
write_log(buf);
return false;
}
return true;
}
// estimate the time that a WU will take on a host
// TODO: improve this. take memory bandwidth into account
//
double estimate_duration(WORKUNIT& wu, HOST& host) {
if (host.p_fpops <= 0) host.p_fpops = 1e9;
if (host.p_iops <= 0) host.p_iops = 1e9;
if (wu.rsc_fpops <= 0) wu.rsc_fpops = 1e12;
if (wu.rsc_iops <= 0) wu.rsc_iops = 1e12;
return wu.rsc_fpops/host.p_fpops + wu.rsc_iops/host.p_iops;
}
// insert "text" right after "after" in the given buffer
//
int insert_after(char* buffer, char* after, char* text) {
char* p;
char temp[MAX_BLOB_SIZE];
if (strlen(buffer) + strlen(text) > MAX_BLOB_SIZE-1) {
write_log("insert_after: overflow\n");
return -1;
}
p = strstr(buffer, after);
if (!p) {
sprintf(temp, "insert_after: %s not found in %s\n", after, buffer);
write_log(temp);
return -1;
}
p += strlen(after);
strcpy(temp, p);
strcpy(p, text);
strcat(p, temp);
return 0;
}
// add elements to WU's xml_doc, in preparation for sending
// it to a client
//
int insert_wu_tags(WORKUNIT& wu, APP& app) {
char buf[256];
sprintf(buf,
" <rsc_fpops>%f</rsc_fpops>\n"
" <rsc_iops>%f</rsc_iops>\n"
" <rsc_memory>%f</rsc_memory>\n"
" <rsc_disk>%f</rsc_disk>\n"
" <name>%s</name>\n"
" <app_name>%s</app_name>\n",
wu.rsc_fpops,
wu.rsc_iops,
wu.rsc_memory,
wu.rsc_disk,
wu.name,
app.name
);
return insert_after(wu.xml_doc, "<workunit>\n", buf);
}
void parse_project_prefs(char* prefs, vector<APP_FILE>& app_files) {
char buf[256];
APP_FILE af;
while (sgets(buf, 256, prefs)) {
if (match_tag(buf, "<app_file>")) {
af.parse(prefs);
app_files.push_back(af);
}
}
}
// if the user's project prefs include elements of the form
// <app_file>
// <url>X</url>
// <open_name>Y</open_name>
// </app_file>
// then insert appropriate elements in app_version XML doc, namely:
// <file_info>
// <name>X'</name>
// <url>X</url>
// </file_info>
// ... (in the <app_version> element)
// <file_ref>
// <file_name>X'</file_name>
// <open_name>Y</open_name>
// </file_ref>
// where X' is the escaped version of X
//
int insert_app_file_tags(APP_VERSION& av, USER& user) {
vector<APP_FILE> app_files;
APP_FILE af;
unsigned int i;
char buf[256], namebuf[256];
int retval;
parse_project_prefs(user.project_prefs, app_files);
for (i=0; i<app_files.size(); i++) {
af = app_files[i];
escape_url_readable(af.url, namebuf);
sprintf(buf,
"<file_info>\n"
" <name>%s</name>\n"
" <url>%s</url>\n"
"</file_info>\n",
namebuf, af.url
);
retval = insert_after(av.xml_doc, "", buf);
if (retval) return retval;
sprintf(buf,
" <file_ref>\n"
" <file_name>%s</file_name>\n"
" <open_name>%s</open_name>\n"
" </file_ref>\n",
namebuf, af.open_name
);
retval = insert_after(av.xml_doc, "<app_version>\n", buf);
if (retval) return retval;
}
return 0;
}
// add the given workunit to a reply.
// look up its app, and make sure there's a version for this platform.
// Add the app and app_version to the reply also.
//
int add_wu_to_reply(
WORKUNIT& wu, SCHEDULER_REPLY& reply, PLATFORM& platform, SCHED_SHMEM& ss,
double seconds_to_complete
) {
APP* app;
APP_VERSION* avp, app_version;
int retval;
WORKUNIT wu2;
char buf[256];
app = ss.lookup_app(wu.appid);
if (!app) {
sprintf(buf, "Can't find app w/ ID %d\n", wu.appid);
write_log(buf);
return -1;
}
avp = ss.lookup_app_version(app->id, platform.id, app->min_version);
if (!avp) {
sprintf(buf,
"Can't find app version: appid %d platformid %d min_version %d\n",
app->id, platform.id, app->min_version
);
write_log(buf);
return -1;
}
// add the app, app_version, and workunit to the reply,
// but only if they aren't already there
//
reply.insert_app_unique(*app);
// If the user's project prefs include any <app_file> tags,
// make appropriate modifications to the app_version XML
// DO THIS IN A COPY OF THE STRUCTURE
//
app_version = *avp;
retval = insert_app_file_tags(app_version, reply.user);
if (retval) {
write_log("insert_app_file_tags failed\n");
return retval;
}
reply.insert_app_version_unique(app_version);
// add time estimate to reply
//
wu2 = wu; // make copy since we're going to modify its XML field
retval = insert_wu_tags(wu2, *app);
if (retval) {
write_log("insert_wu_tags failed\n");
return retval;
}
reply.insert_workunit_unique(wu2);
return 0;
}
// Look up the host and its user, and make sure the authenticator matches.
// If no host ID is supplied, or if RPC seqno mismatch,
// create a new host record and return its ID
//
int authenticate_user(SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply) {
int retval;
char buf[256];
DB_HOST host;
DB_USER user;
DB_TEAM team;
if (sreq.hostid) {
retval = host.lookup_id(sreq.hostid);
if (retval) {
strcpy(reply.message, "Can't find host record");
strcpy(reply.message_priority, "low");
sprintf(buf, "can't find host %d\n", sreq.hostid);
write_log(buf);
sreq.hostid = 0;
goto new_host;
}
reply.host = host;
retval = user.lookup_id(reply.host.userid);
if (retval) {
strcpy(reply.message, "Can't find user record");
strcpy(reply.message_priority, "low");
reply.request_delay = 120;
reply.nucleus_only = true;
sprintf(buf, "can't find user %d\n", reply.host.userid);
write_log(buf);
return -1;
}
reply.user = user;
if (strcmp(sreq.authenticator, reply.user.authenticator)) {
strcpy(reply.message,
"Invalid or missing authenticator. "
"Visit this project's web site to get an authenticator."
);
strcpy(reply.message_priority, "low");
reply.request_delay = 120;
reply.nucleus_only = true;
sprintf(buf, "Bad authenticator [%s]\n", sreq.authenticator);
write_log(buf);
return -1;
}
// If the seqno from the host is less than what we expect,
// the user must have copied the state file to a different host.
// Make a new host record.
if (sreq.rpc_seqno < reply.host.rpc_seqno) {
sreq.hostid = 0;
goto new_host;
}
reply.host.rpc_seqno = sreq.rpc_seqno;
reply.host.rpc_time = time(0);
} else {
// here no hostid was given; we'll have to create a new host record
//
strncpy(
user.authenticator, sreq.authenticator,
sizeof(user.authenticator)
);
sprintf(buf, "where authenticator='%s'", user.authenticator);
retval = user.lookup(buf);
if (retval) {
strcpy(reply.message,
"Invalid or missing account ID. "
"Visit this project's web site to get an account ID."
);
strcpy(reply.message_priority, "low");
reply.request_delay = 120;
sprintf(buf, "Bad authenticator [%s]\n", sreq.authenticator);
write_log(buf);
return -1;
}
reply.user = user;
new_host:
// reply.user is filled in and valid at this point
//
host = sreq.host;
host.id = 0;
host.create_time = time(0);
host.userid = reply.user.id;
host.rpc_seqno = 0;
host.rpc_time = time(0);
strcpy(host.venue, reply.user.venue);
retval = host.insert();
if (retval) {
strcpy(reply.message, "server database error");
strcpy(reply.message_priority, "low");
boinc_db_print_error("host.insert()");
write_log("host.insert() failed\n");
return -1;
}
host.id = boinc_db_insert_id();
reply.host = host;
reply.hostid = reply.host.id;
// this tells client to updates its host ID
}
if (reply.user.teamid) {
retval = team.lookup_id(reply.user.teamid);
if (!retval) reply.team = team;
}
return 0;
}
// somewhat arbitrary formula for credit as a function of CPU time.
// Could also include terms for RAM size, network speed etc.
//
static void compute_credit_rating(HOST& host) {
host.credit_per_cpu_sec =
(fabs(host.p_fpops)/1e9 + fabs(host.p_iops)/1e9 + fabs(host.p_membw)/4e9)/(3*SECONDS_PER_DAY);
}
// Update host record based on request.
// Copy all fields that are determined by the client.
//
int update_host_record(SCHEDULER_REQUEST& sreq, HOST& xhost) {
int retval;
char buf[256];
DB_HOST host;
host = xhost;
host.timezone = sreq.host.timezone;
strncpy(host.domain_name, sreq.host.domain_name, sizeof(host.domain_name));
strncpy(host.serialnum, sreq.host.serialnum, sizeof(host.serialnum));
if (strcmp(host.last_ip_addr, sreq.host.last_ip_addr)) {
strncpy(host.last_ip_addr, sreq.host.last_ip_addr, sizeof(host.last_ip_addr));
} else {
host.nsame_ip_addr++;
}
host.on_frac = sreq.host.on_frac;
host.connected_frac = sreq.host.connected_frac;
host.active_frac = sreq.host.active_frac;
host.p_ncpus = sreq.host.p_ncpus;
strncpy(host.p_vendor, sreq.host.p_vendor, sizeof(host.p_vendor));
// unlikely this will change
strncpy(host.p_model, sreq.host.p_model, sizeof(host.p_model));
host.p_fpops = sreq.host.p_fpops;
host.p_iops = sreq.host.p_iops;
host.p_membw = sreq.host.p_membw;
host.p_calculated = sreq.host.p_calculated;
strncpy(host.os_name, sreq.host.os_name, sizeof(host.os_name));
strncpy(host.os_version, sreq.host.os_version, sizeof(host.os_version));
host.m_nbytes = sreq.host.m_nbytes;
host.m_cache = sreq.host.m_cache;
host.m_swap = sreq.host.m_swap;
host.d_total = sreq.host.d_total;
host.d_free = sreq.host.d_free;
host.n_bwup = sreq.host.n_bwup;
host.n_bwdown = sreq.host.n_bwdown;
compute_credit_rating(host);
retval = host.update();
if (retval) {
sprintf(buf, "host.update() failed: %d\n", retval);
write_log(buf);
}
return 0;
}
// Deal with global preferences.
// If the client sent global prefs, and they're more recent than ours,
// update user record in DB.
// If DB has more recent global prefs than client's, send them.
//
int handle_global_prefs(SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply) {
unsigned int req_mod_time, db_mod_time;
bool need_update;
DB_USER user;
reply.send_global_prefs = false;
if (strlen(sreq.global_prefs_xml)) {
need_update = false;
parse_int(sreq.global_prefs_xml, "<mod_time>", (int)req_mod_time);
if (strlen(reply.user.global_prefs)) {
parse_int(reply.user.global_prefs, "<mod_time>", (int)db_mod_time);
if (req_mod_time > db_mod_time) {
need_update = true;
} else if (req_mod_time < db_mod_time) {
reply.send_global_prefs = true;
}
} else {
need_update = true;
}
if (need_update) {
safe_strcpy(reply.user.global_prefs, sreq.global_prefs_xml);
user = reply.user;
user.update();
}
} else {
if (strlen(reply.user.global_prefs)) {
reply.send_global_prefs = true;
}
}
return 0;
}
// handle completed results
//
int handle_results(
SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply, HOST& host
) {
unsigned int i;
int retval;
DB_RESULT result;
RESULT* rp;
DB_WORKUNIT wu;
char buf[256];
for (i=0; i<sreq.results.size(); i++) {
rp = &sreq.results[i];
// acknowledge the result even if we couldn't find it --
// don't want it to keep coming back
//
reply.result_acks.push_back(*rp);
sprintf(buf, "got result %s\n", rp->name);
write_log(buf);
strncpy(result.name, rp->name, sizeof(result.name));
sprintf(buf, "where name='%s'", result.name);
retval = result.lookup(buf);
if (retval) {
sprintf(buf, "can't find result %s\n", rp->name);
write_log(buf);
continue;
}
if (result.server_state == RESULT_SERVER_STATE_UNSENT) {
sprintf(buf,
"got unexpected result for %s: server state is %d\n",
rp->name, result.server_state
);
write_log(buf);
continue;
}
if (result.server_state == RESULT_SERVER_STATE_OVER) {
result.file_delete_state = FILE_DELETE_READY;
}
if (result.server_state == RESULT_SERVER_STATE_IN_PROGRESS) {
result.server_state = RESULT_SERVER_STATE_OVER;
}
if (result.hostid != sreq.hostid) {
sprintf(buf,
"got result from wrong host: %d %d\n",
result.hostid, sreq.hostid
);
write_log(buf);
continue;
}
result.hostid = reply.host.id;
result.received_time = time(0);
result.client_state = rp->client_state;
result.cpu_time = rp->cpu_time;
result.claimed_credit = result.cpu_time * host.credit_per_cpu_sec;
result.server_state = RESULT_SERVER_STATE_OVER;
if (result.client_state == RESULT_FILES_UPLOADED) {
result.outcome = RESULT_OUTCOME_SUCCESS;
retval = wu.lookup_id(result.workunitid);
if (retval) {
sprintf(buf,
"can't find WU %d for result %d\n",
result.workunitid, result.id
);
write_log(buf);
} else {
wu.need_validate = 1;
retval = wu.update();
if (retval) {
write_log("Can't update WU\n");
}
}
} else {
result.outcome = RESULT_OUTCOME_CLIENT_ERROR;
result.validate_state = VALIDATE_STATE_INVALID;
}
strncpy(result.stderr_out, rp->stderr_out, sizeof(result.stderr_out));
strncpy(result.xml_doc_out, rp->xml_doc_out, sizeof(result.xml_doc_out));
retval = result.update();
if (retval) {
sprintf(buf,
"can't update result %d: %s\n",
result.id, boinc_db_error_string()
);
write_log(buf);
}
}
return 0;
}
int insert_name_tags(RESULT& result, WORKUNIT& wu) {
char buf[256];
int retval;
sprintf(buf, "<name>%s</name>\n", result.name);
retval = insert_after(result.xml_doc_in, "<result>\n", buf);
if (retval) return retval;
sprintf(buf, "<wu_name>%s</wu_name>\n", wu.name);
retval = insert_after(result.xml_doc_in, "<result>\n", buf);
if (retval) return retval;
return 0;
}
int send_work(
SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply, PLATFORM& platform,
SCHED_SHMEM& ss
) {
int i, retval, nresults = 0, seconds_to_fill;
WORKUNIT wu;
DB_RESULT result, result_copy;
char buf[256];
if (sreq.work_req_seconds <= 0) return 0;
sprintf(buf, "got request for %d seconds of work\n", sreq.work_req_seconds);
write_log(buf);
seconds_to_fill = sreq.work_req_seconds;
if (seconds_to_fill > MAX_SECONDS_TO_SEND) {
seconds_to_fill = MAX_SECONDS_TO_SEND;
}
if (seconds_to_fill < MIN_SECONDS_TO_SEND) {
seconds_to_fill = MIN_SECONDS_TO_SEND;
}
for (i=0; i<ss.nwu_results && seconds_to_fill>0; i++) {
// the following should be a critical section
//
if (!ss.wu_results[i].present) {
continue;
}
if (!wu_is_feasible(ss.wu_results[i].workunit, reply.host)) {
sprintf(buf, "WU %s is infeasible\n", ss.wu_results[i].workunit.name);
write_log(buf);
continue;
}
wu = ss.wu_results[i].workunit;
result = ss.wu_results[i].result;
ss.wu_results[i].present = false;
retval = add_wu_to_reply(wu, reply, platform, ss,
estimate_duration(wu, reply.host)
);
if (retval) continue;
#if 1
char buf[256];
sprintf(buf,
"sending result name %s, id %d\n",
result.name, result.id
);
write_log(buf);
#endif
// copy the result so we don't overwrite its XML fields
//
result_copy = result;
retval = insert_name_tags(result_copy, wu);
if (retval) {
write_log("send_work: can't insert name tags\n");
}
reply.insert_result(result_copy);
seconds_to_fill -= (int)estimate_duration(wu, reply.host);
result.server_state = RESULT_SERVER_STATE_IN_PROGRESS;
result.hostid = reply.host.id;
result.sent_time = time(0);
result.report_deadline = result.sent_time + wu.delay_bound;
result.update();
nresults++;
if (nresults == MAX_WUS_TO_SEND) break;
}
sprintf(buf, "sending %d results\n", nresults);
write_log(buf);
if (nresults == 0) {
strcpy(reply.message, "no work available");
strcpy(reply.message_priority, "low");
reply.request_delay = 10;
}
return 0;
}
// if the client has an old code sign public key,
// send it the new one, with a signature based on the old one.
// If they don't have a code sign key, send them one
//
void send_code_sign_key(
SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply, char* code_sign_key
) {
char* oldkey, *signature;
int i, retval;
char path[256];
if (strlen(sreq.code_sign_key)) {
if (strcmp(sreq.code_sign_key, code_sign_key)) {
write_log("received old code sign key\n");
// look for a signature file
//
for (i=0; ; i++) {
sprintf(path, "%s/old_key_%d", config.key_dir, i);
retval = read_file_malloc(path, oldkey);
if (retval) {
strcpy(reply.message,
"Can't update code signing key. "
"Please report this to project."
);
return;
}
if (!strcmp(oldkey, sreq.code_sign_key)) {
sprintf(path, "%s/signature_%d", config.key_dir, i);
retval = read_file_malloc(path, signature);
if (retval) {
strcpy(reply.message,
"Can't update code signing key. "
"Please report this to project."
);
} else {
safe_strcpy(reply.code_sign_key, code_sign_key);
safe_strcpy(reply.code_sign_key_signature, signature);
free(signature);
}
}
free(oldkey);
return;
}
}
} else {
safe_strcpy(reply.code_sign_key, code_sign_key);
}
}
bool wrong_major_version(SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply) {
char buf[256];
if (sreq.core_client_major_version != MAJOR_VERSION) {
reply.nucleus_only = true;
sprintf(reply.message,
"To participate in this project, "
"you must use major version %d of the BOINC core client. "
"Your core client is major version %d.",
MAJOR_VERSION,
sreq.core_client_major_version
);
strcpy(reply.message_priority, "low");
sprintf(buf, "Wrong major version: wanted %d, got %d\n",
MAJOR_VERSION, sreq.core_client_major_version
);
write_log(buf);
return true;
}
return false;
}
void process_request(
SCHEDULER_REQUEST& sreq, SCHEDULER_REPLY& reply, SCHED_SHMEM& ss,
char* code_sign_key
) {
PLATFORM* platform;
int retval;
char buf[256];
// if different major version of BOINC, just send a message
//
if (wrong_major_version(sreq, reply)) return;
retval = authenticate_user(sreq, reply);
if (retval) return;
retval = update_host_record(sreq, reply.host);
// look up the client's platform in the DB
//
platform = ss.lookup_platform(sreq.platform_name);
if (!platform) {
sprintf(buf, "platform [%s] not found\n", sreq.platform_name);
strcpy(reply.message, buf);
strcpy(reply.message_priority, "low");
write_log(buf);
return;
}
handle_global_prefs(sreq, reply);
handle_results(sreq, reply, reply.host);
send_work(sreq, reply, *platform, ss);
send_code_sign_key(sreq, reply, code_sign_key);
}
void handle_request(
FILE* fin, FILE* fout, SCHED_SHMEM& ss, char* code_sign_key
) {
SCHEDULER_REQUEST sreq;
SCHEDULER_REPLY sreply;
write_log("Handling request\n");
memset(&sreq, 0, sizeof(sreq));
sreq.parse(fin);
process_request(sreq, sreply, ss, code_sign_key);
sreply.write(fout);
}