// 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): // #include "windows_cpp.h" #include #include #include "error_numbers.h" #include "file_names.h" #include "filesys.h" #include "parse.h" #include "util.h" #include "pers_file_xfer.h" #include "client_types.h" PROJECT::PROJECT() { strcpy(master_url, ""); strcpy(authenticator, ""); strcpy(project_specific_prefs, ""); resource_share = 100; strcpy(project_name, ""); strcpy(user_name, ""); strcpy(team_name, ""); user_total_credit = 0; user_expavg_credit = 0; user_create_time = 0; rpc_seqno = 0; hostid = 0; host_total_credit = 0; host_expavg_credit = 0; host_create_time = 0; exp_avg_cpu = 0; exp_avg_mod_time = 0; strcpy(code_sign_key, ""); nrpc_failures = 0; min_rpc_time = 0; master_fetch_failures = 0; resource_debt = 0; debt_order = 0; master_url_fetch_pending = false; sched_rpc_pending = false; tentative = false; } PROJECT::~PROJECT() { } // write account_*.xml file // int PROJECT::write_account_file() { char path[256]; FILE* f; int retval; get_account_filename(master_url, path); f = fopen(TEMP_FILE_NAME, "w"); if (!f) return ERR_FOPEN; fprintf(f, "\n" " %s\n" " %s\n", master_url, authenticator ); if (strlen(project_specific_prefs)) { fprintf(f, "%s", project_specific_prefs); } if (tentative) { fprintf(f, " \n"); } fprintf(f, "\n"); fclose(f); retval = boinc_rename(TEMP_FILE_NAME, path); if (retval) return ERR_RENAME; return 0; } // parse project fields from account_*.xml // int PROJECT::parse_account(FILE* in) { char buf[256]; int retval; // Assume master_url_fetch_pending, sched_rpc_pending are // true until we read client_state.xml // master_url_fetch_pending = true; sched_rpc_pending = true; strcpy(master_url, ""); strcpy(authenticator, ""); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) continue; if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", master_url, sizeof(master_url))) { case_format_url(master_url); continue; } else if (parse_str(buf, "", authenticator, sizeof(authenticator))) continue; else if (parse_double(buf, "", resource_share)) continue; else if (match_tag(buf, "")) continue; else if (match_tag(buf, "")) continue; else if (match_tag(buf, "")) { tentative = true; continue; } else if (match_tag(buf, "")) { retval = copy_element_contents( in, "", project_specific_prefs, sizeof(project_specific_prefs) ); if (retval) return ERR_XML_PARSE; continue; } else fprintf(stderr, "PROJECT::parse_account(): unrecognized: %s\n", buf); } return ERR_XML_PARSE; } // parse project fields from client_state.xml // int PROJECT::parse_state(FILE* in) { char buf[256]; STRING256 string; strcpy(project_name, ""); strcpy(user_name, ""); strcpy(team_name, ""); resource_share = 100; exp_avg_cpu = 0; exp_avg_mod_time = 0; min_rpc_time = 0; nrpc_failures = 0; master_url_fetch_pending = false; sched_rpc_pending = false; scheduler_urls.clear(); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", string.text, sizeof(string.text))) { scheduler_urls.push_back(string); continue; } else if (parse_str(buf, "", master_url, sizeof(master_url))) continue; else if (parse_str(buf, "", project_name, sizeof(project_name))) continue; else if (parse_str(buf, "", user_name, sizeof(user_name))) continue; else if (parse_str(buf, "", team_name, sizeof(team_name))) continue; else if (parse_double(buf, "", user_total_credit)) continue; else if (parse_double(buf, "", user_expavg_credit)) continue; else if (parse_int(buf, "", (int &)user_create_time)) continue; else if (parse_int(buf, "", rpc_seqno)) continue; else if (parse_int(buf, "", hostid)) continue; else if (parse_double(buf, "", host_total_credit)) continue; else if (parse_double(buf, "", host_expavg_credit)) continue; else if (parse_int(buf, "", (int &)host_create_time)) continue; else if (parse_double(buf, "", exp_avg_cpu)) continue; else if (parse_int(buf, "", exp_avg_mod_time)) continue; else if (match_tag(buf, "")) { copy_element_contents( in, "", code_sign_key, sizeof(code_sign_key) ); //fprintf(stderr, "code_sign_key: %s\n", code_sign_key); } else if (parse_int(buf, "", nrpc_failures)) continue; else if (parse_int(buf, "", master_fetch_failures)) continue; else if (parse_int(buf, "", min_rpc_time)) continue; else if (match_tag(buf, "")) master_url_fetch_pending = true; else if (match_tag(buf, "")) sched_rpc_pending = true; else fprintf(stderr, "PROJECT::parse_state(): unrecognized: %s\n", buf); } return ERR_XML_PARSE; } // Write the project information to client state file // int PROJECT::write_state(FILE* out) { unsigned int i; fprintf(out, "\n" ); for (i=0; i%s\n", scheduler_urls[i].text ); } fprintf(out, " %s\n" " %s\n" " %s\n" " %s\n" " %f\n" " %f\n" " %d\n" " %d\n" " %d\n" " %f\n" " %f\n" " %d\n" " %f\n" " %d\n" " %d\n" " %d\n" " %d\n" "%s%s", master_url, project_name, user_name, team_name, user_total_credit, user_expavg_credit, user_create_time, rpc_seqno, hostid, host_total_credit, host_expavg_credit, host_create_time, exp_avg_cpu, exp_avg_mod_time, nrpc_failures, master_fetch_failures, min_rpc_time, master_url_fetch_pending?" \n":"", sched_rpc_pending?" \n":"" ); if (strlen(code_sign_key)) { fprintf(out, " \n%s\n", code_sign_key ); } fprintf(out, "\n" ); return 0; } // copy fields from "p" into "this" that are stored in client_state.xml // void PROJECT::copy_state_fields(PROJECT& p) { scheduler_urls = p.scheduler_urls; safe_strcpy(project_name, p.project_name); safe_strcpy(user_name, p.user_name); safe_strcpy(team_name, p.team_name); user_total_credit = p.user_total_credit; user_expavg_credit = p.user_expavg_credit; user_create_time = p.user_create_time; rpc_seqno = p.rpc_seqno; hostid = p.hostid; host_total_credit = p.host_total_credit; host_expavg_credit = p.host_expavg_credit; host_create_time = p.host_create_time; exp_avg_cpu = p.exp_avg_cpu; exp_avg_mod_time = p.exp_avg_mod_time; nrpc_failures = p.nrpc_failures; master_fetch_failures = p.master_fetch_failures; min_rpc_time = p.min_rpc_time; master_url_fetch_pending = p.master_url_fetch_pending; sched_rpc_pending = p.sched_rpc_pending; safe_strcpy(code_sign_key, p.code_sign_key); } char* PROJECT::get_project_name() { if (strlen(project_name)) { return project_name; } else { return master_url; } } int APP::parse(FILE* in) { char buf[256]; strcpy(name, ""); project = NULL; while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", name, sizeof(name))) continue; else fprintf(stderr, "APP::parse(): unrecognized: %s\n", buf); } return ERR_XML_PARSE; } int APP::write(FILE* out) { fprintf(out, "\n" " %s\n" "\n", name ); return 0; } FILE_INFO::FILE_INFO() { } FILE_INFO::~FILE_INFO() { } // Set the appropriate permissions depending on whether // it's an executable file // This doesn't seem to exist in Windows // int FILE_INFO::set_permissions() { #ifdef _WIN32 return 0; #else int retval; char pathname[256]; get_pathname(this, pathname); if (executable) { retval = chmod(pathname, S_IEXEC|S_IREAD|S_IWRITE); } else { retval = chmod(pathname, S_IREAD|S_IWRITE); } return retval; #endif } // If from server, make an exact copy of everything // except the start/end tags and the element. // int FILE_INFO::parse(FILE* in, bool from_server) { char buf[256]; STRING256 url; PERS_FILE_XFER *pfxp; int retval; strcpy(name, ""); strcpy(md5_cksum, ""); max_nbytes = 0; nbytes = 0; upload_offset = -1; generated_locally = false; status = FILE_NOT_PRESENT; executable = false; uploaded = false; upload_when_present = false; sticky = false; signature_required = false; pers_file_xfer = NULL; result = NULL; project = NULL; urls.clear(); start_url = -1; current_url = -1; strcpy(signed_xml, ""); strcpy(xml_signature, ""); strcpy(file_signature, ""); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (match_tag(buf, "")) { copy_element_contents( in, "", xml_signature, sizeof(xml_signature) ); continue; } if (from_server) { strcat(signed_xml, buf); } if (parse_str(buf, "", name, sizeof(name))) continue; else if (parse_str(buf, "", url.text, sizeof(url.text))) { urls.push_back(url); continue; } else if (match_tag(buf, "")) { copy_element_contents( in, "", file_signature, sizeof(file_signature) ); continue; } else if (parse_str(buf, "", md5_cksum, sizeof(md5_cksum))) continue; else if (parse_double(buf, "", nbytes)) continue; else if (parse_double(buf, "", max_nbytes)) continue; else if (match_tag(buf, "")) generated_locally = true; else if (parse_int(buf, "", status)) continue; else if (match_tag(buf, "")) executable = true; else if (match_tag(buf, "")) uploaded = true; else if (match_tag(buf, "")) upload_when_present = true; else if (match_tag(buf, "")) sticky = true; else if (match_tag(buf, "")) signature_required = true; else if (match_tag(buf, "")) { pfxp = new PERS_FILE_XFER; retval = pfxp->parse(in); if (!retval) { pers_file_xfer = pfxp; } else { delete pfxp; } } else if (!from_server && match_tag(buf, "")) { copy_element_contents( in, "", signed_xml, sizeof(signed_xml) ); continue; } else { fprintf(stderr, "FILE_INFO::parse(): unrecognized: %s\n", buf); } } return 1; } // Write out XML based file info // int FILE_INFO::write(FILE* out, bool to_server) { unsigned int i; int retval; fprintf(out, "\n" " %s\n" " %f\n" " %f\n", name, nbytes, max_nbytes ); if (strlen(md5_cksum)) { fprintf(out, " %s\n", md5_cksum ); } if (!to_server) { if (generated_locally) fprintf(out, " \n"); fprintf(out, " %d\n", status); if (executable) fprintf(out, " \n"); if (uploaded) fprintf(out, " \n"); if (upload_when_present) fprintf(out, " \n"); if (sticky) fprintf(out, " \n"); if (signature_required) fprintf(out, " \n"); if (file_signature) fprintf(out," \n%s\n", file_signature); } for (i=0; i%s\n", urls[i].text); } if (!to_server && pers_file_xfer) { retval = pers_file_xfer->write(out); if (retval) return retval; } if (!to_server) { if (strlen(signed_xml) && strlen(xml_signature)) { fprintf(out, " \n%s \n", signed_xml); } if (strlen(xml_signature)) { fprintf(out, " \n%s \n", xml_signature); } } fprintf(out, "\n"); return 0; } // delete physical underlying file associated with FILE_INFO // int FILE_INFO::delete_file() { char path[256]; get_pathname(this, path); status = FILE_NOT_PRESENT; return file_delete(path); } // get the currently selected url to download/upload file, or // select one if none is chosen yet // char* FILE_INFO::get_url() { double temp; if (current_url < 0) { temp = rand(); temp *= urls.size(); temp /= RAND_MAX; current_url = (int)temp; start_url = current_url; } return urls[current_url].text; } // Returns true if the file had an unrecoverable error // (couldn't download, RSA/MD5 check failed, etc) // bool FILE_INFO::had_failure(int& failnum) { if (status != FILE_NOT_PRESENT && status != FILE_PRESENT) { failnum = status; return true; } return false; } // Parse XML based app_version information, usually from client_state.xml // int APP_VERSION::parse(FILE* in) { char buf[256]; FILE_REF file_ref; strcpy(app_name, ""); version_num = 0; app = NULL; project = NULL; while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", app_name, sizeof(app_name))) continue; else if (match_tag(buf, "")) { file_ref.parse(in); app_files.push_back(file_ref); continue; } else if (parse_int(buf, "", version_num)) continue; else fprintf(stderr, "APP_VERSION::parse(): unrecognized: %s\n", buf); } return 1; } int APP_VERSION::write(FILE* out) { unsigned int i; int retval; fprintf(out, "\n" " %s\n" " %d\n", app_name, version_num ); for (i=0; i\n" ); return 0; } int FILE_REF::parse(FILE* in) { char buf[256]; strcpy(file_name, ""); strcpy(open_name, ""); fd = -1; main_program = false; while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", file_name, sizeof(file_name))) continue; else if (parse_str(buf, "", open_name, sizeof(open_name))) continue; else if (parse_int(buf, "", fd)) continue; else if (match_tag(buf, "")) main_program = true; else fprintf(stderr, "FILE_REF::parse(): unrecognized: %s\n", buf); } return 1; } int FILE_REF::write(FILE* out) { fprintf(out, " \n" " %s\n", file_name ); if (strlen(open_name)) { fprintf(out, " %s\n", open_name); } if (fd >= 0) { fprintf(out, " %d\n", fd); } if (main_program) { fprintf(out, " \n"); } fprintf(out, " \n"); return 0; } int WORKUNIT::parse(FILE* in) { char buf[256]; FILE_REF file_ref; strcpy(name, ""); strcpy(app_name, ""); version_num = 0; strcpy(command_line, ""); strcpy(env_vars, ""); app = NULL; project = NULL; // Default these to very large values (1 week on a 1 cobblestone machine) // so we don't keep asking the server for more work rsc_fpops = 1e9*SECONDS_PER_DAY*7; rsc_iops = 1e9*SECONDS_PER_DAY*7; rsc_memory = 4e9*SECONDS_PER_DAY*7; rsc_disk = 1024*1024*1024; // 1 GB while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", name, sizeof(name))) continue; else if (parse_str(buf, "", app_name, sizeof(app_name))) continue; else if (parse_int(buf, "", version_num)) continue; else if (parse_str(buf, "", command_line, sizeof(command_line))) continue; else if (parse_str(buf, "", env_vars, sizeof(env_vars))) continue; else if (parse_double(buf, "", rsc_fpops)) continue; else if (parse_double(buf, "", rsc_iops)) continue; else if (parse_double(buf, "", rsc_memory)) continue; else if (parse_double(buf, "", rsc_disk)) continue; else if (match_tag(buf, "")) { file_ref.parse(in); input_files.push_back(file_ref); continue; } else fprintf(stderr, "WORKUNIT::parse(): unrecognized: %s\n", buf); } return 1; } int WORKUNIT::write(FILE* out) { unsigned int i; fprintf(out, "\n" " %s\n" " %s\n" " %d\n" " %s\n" " %s\n" " %f\n" " %f\n" " %f\n" " %f\n", name, app_name, version_num, command_line, env_vars, rsc_fpops, rsc_iops, rsc_memory, rsc_disk ); for (i=0; i\n"); return 0; } bool WORKUNIT::had_failure(int& failnum) { unsigned int i; for (i=0;ihad_failure(failnum)) { return true; } } return false; } int RESULT::parse_ack(FILE* in) { char buf[256]; strcpy(name, ""); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; else if (parse_str(buf, "", name, sizeof(name))) continue; else fprintf(stderr, "RESULT::parse(): unrecognized: %s\n", buf); } return 1; } void RESULT::clear() { strcpy(name, ""); strcpy(wu_name, ""); report_deadline = 0; output_files.clear(); is_active = false; state = RESULT_NEW; ready_to_ack = false; server_ack = false; final_cpu_time = 0; exit_status = 0; active_task_state = 0; signal = 0; strcpy(stderr_out, ""); app = NULL; wup = NULL; project = NULL; } // parse a element from scheduling server. // int RESULT::parse_server(FILE* in) { char buf[256]; FILE_REF file_ref; clear(); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; if (parse_str(buf, "", name, sizeof(name))) continue; if (parse_str(buf, "", wu_name, sizeof(wu_name))) continue; if (parse_int(buf, "", report_deadline)) continue; if (match_tag(buf, "")) { file_ref.parse(in); output_files.push_back(file_ref); continue; } else fprintf(stderr, "RESULT::parse(): unrecognized: %s\n", buf); } return 1; } // parse a element from state file // int RESULT::parse_state(FILE* in) { char buf[256]; FILE_REF file_ref; clear(); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) return 0; if (parse_str(buf, "", name, sizeof(name))) continue; if (parse_str(buf, "", wu_name, sizeof(wu_name))) continue; if (parse_int(buf, "", report_deadline)) continue; if (match_tag(buf, "")) { file_ref.parse(in); output_files.push_back(file_ref); continue; } else if (parse_double(buf, "", final_cpu_time)) continue; else if (parse_int(buf, "", exit_status)) continue; else if (match_tag(buf, "")) server_ack = true; else if (match_tag(buf, "")) ready_to_ack = true; else if (parse_int(buf, "", state)) continue; else if (match_tag(buf, "")) { while (fgets(buf, 256, in)) { if (match_tag(buf, "")) break; strcat(stderr_out, buf); } continue; } else fprintf(stderr, "RESULT::parse(): unrecognized: %s\n", buf); } return 1; } int RESULT::write(FILE* out, bool to_server) { unsigned int i; FILE_INFO* fip; int n, retval; fprintf(out, "\n" " %s\n" " %f\n" " %d\n", name, final_cpu_time, state ); n = strlen(stderr_out); if (n) { fprintf(out, "\n" "%s", stderr_out ); if (stderr_out[n-1] != '\n') fprintf(out, "\n"); fprintf(out, "\n" ); } if (!to_server) { if (server_ack) fprintf(out, " \n"); if (ready_to_ack) fprintf(out, " \n"); fprintf(out, " %s\n" " %d\n", wu_name, report_deadline ); for (i=0; iuploaded) { retval = fip->write(out, to_server); if (retval) return retval; } } } fprintf(out, "\n"); return 0; } // this is called after the result state is RESULT_COMPUTE_DONE. // Returns true if the result's output files are all either // successfully uploaded or have unrecoverable errors // bool RESULT::is_upload_done() { unsigned int i; FILE_INFO* fip; int retval; for (i=0; iupload_when_present) { if (fip->had_failure(retval)) continue; if (!fip->uploaded) { return false; } } } return true; }