// This file is part of BOINC. // http://boinc.berkeley.edu // Copyright (C) 2008 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 . #ifdef _WIN32 #include "boinc_win.h" #else #include "config.h" #endif #include #include #include "parse.h" #include "str_util.h" #include "util.h" #include "error_numbers.h" #include "filesys.h" #include "file_names.h" #include "client_msgs.h" #include "client_state.h" #define MAX_STATE_FILE_WRITE_ATTEMPTS 2 void CLIENT_STATE::set_client_state_dirty(const char* source) { if (log_flags.statefile_debug) { msg_printf(0, MSG_INFO, "[statefile_debug] set dirty: %s\n", source); } client_state_dirty = true; } static bool valid_state_file(const char* fname) { char buf[256]; FILE* f = boinc_fopen(fname, "r"); if (!f) return false; if (!fgets(buf, 256, f)) { fclose(f); return false; } if (!match_tag(buf, "")) { fclose(f); return false; } while (fgets(buf, 256, f)) { if (match_tag(buf, "")) { fclose(f); return true; } } fclose(f); return false; } // Parse the client_state.xml file // int CLIENT_STATE::parse_state_file() { PROJECT *project=NULL; char buf[256]; int retval=0; int failnum; const char *fname; // Look for a valid state file: // First the regular one, then the "next" one. // if (valid_state_file(STATE_FILE_NEXT)) { fname = STATE_FILE_NEXT; } else if (valid_state_file(STATE_FILE_NAME)) { fname = STATE_FILE_NAME; } else if (valid_state_file(STATE_FILE_PREV)) { fname = STATE_FILE_PREV; } else { if (log_flags.statefile_debug) { msg_printf(0, MSG_INFO, "[statefile_debug] CLIENT_STATE::parse_state_file(): No state file; will create one" ); } // avoid warning messages about version // old_major_version = BOINC_MAJOR_VERSION; old_minor_version = BOINC_MINOR_VERSION; old_release = BOINC_RELEASE; return ERR_FOPEN; } FILE* f = fopen(fname, "r"); MIOFILE mf; mf.init_file(f); while (fgets(buf, 256, f)) { if (match_tag(buf, "")) { break; } if (match_tag(buf, "")) { continue; } if (match_tag(buf, "")) { PROJECT temp_project; retval = temp_project.parse_state(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse project in state file"); } else { project = lookup_project(temp_project.master_url); if (project) { project->copy_state_fields(temp_project); } else { msg_printf(&temp_project, MSG_INTERNAL_ERROR, "Project %s is in state file but no account file found", temp_project.get_project_name() ); } } continue; } if (match_tag(buf, "")) { APP* app = new APP; retval = app->parse(mf); if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Application %s outside project in state file", app->name ); delete app; continue; } if (project->anonymous_platform) { delete app; continue; } if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse application in state file" ); delete app; continue; } retval = link_app(project, app); if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't handle application %s in state file", app->name ); delete app; continue; } apps.push_back(app); continue; } if (match_tag(buf, "")) { FILE_INFO* fip = new FILE_INFO; retval = fip->parse(mf, false); if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "File info outside project in state file" ); delete fip; continue; } if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't handle file info in state file" ); delete fip; continue; } retval = link_file_info(project, fip); if (project->anonymous_platform && retval == ERR_NOT_UNIQUE) { delete fip; continue; } if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't handle file info %s in state file", fip->name ); delete fip; continue; } file_infos.push_back(fip); // If the file had a failure before, // don't start another file transfer // if (fip->had_failure(failnum)) { if (fip->pers_file_xfer) { delete fip->pers_file_xfer; fip->pers_file_xfer = NULL; } } if (fip->pers_file_xfer) { retval = fip->pers_file_xfer->init(fip, fip->upload_when_present); if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't initialize file transfer for %s", fip->name ); } retval = pers_file_xfers->insert(fip->pers_file_xfer); if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't start persistent file transfer for %s", fip->name ); } } continue; } if (match_tag(buf, "")) { APP_VERSION* avp = new APP_VERSION; retval = avp->parse(mf); if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Application version outside project in state file" ); delete avp; continue; } if (project->anonymous_platform) { delete avp; continue; } if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse application version in state file" ); delete avp; continue; } if (strlen(avp->platform) == 0) { strcpy(avp->platform, get_primary_platform()); } else { if (!is_supported_platform(avp->platform)) { // if it's a platform we haven't heard of, // must be that the user tried out a 64 bit client // and then reverted to a 32-bit client. // Let's not throw away the app version and its WUs // msg_printf(project, MSG_INTERNAL_ERROR, "App version has unsupported platform %s; changing to %s", avp->platform, get_primary_platform() ); strcpy(avp->platform, get_primary_platform()); } } if (avp->missing_coproc()) { delete avp; continue; } retval = link_app_version(project, avp); if (retval) { delete avp; continue; } app_versions.push_back(avp); continue; } if (match_tag(buf, "")) { WORKUNIT* wup = new WORKUNIT; retval = wup->parse(mf); if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Workunit outside project in state file" ); delete wup; continue; } if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse workunit in state file" ); delete wup; continue; } retval = link_workunit(project, wup); if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't handle workunit in state file" ); delete wup; continue; } workunits.push_back(wup); continue; } if (match_tag(buf, "")) { RESULT* rp = new RESULT; retval = rp->parse_state(mf); if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Task %s outside project in state file", rp->name ); delete rp; continue; } if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse task in state file" ); delete rp; continue; } retval = link_result(project, rp); if (retval) { msg_printf(project, MSG_INTERNAL_ERROR, "Can't link task %s in state file", rp->name ); delete rp; continue; } if (!strlen(rp->platform) || !is_supported_platform(rp->platform)) { strcpy(rp->platform, get_primary_platform()); rp->version_num = latest_version(rp->wup->app, rp->platform); } rp->avp = lookup_app_version( rp->wup->app, rp->platform, rp->version_num, rp->plan_class ); if (!rp->avp) { msg_printf(project, MSG_INTERNAL_ERROR, "No application found for task: %s %d %s; discarding", rp->platform, rp->version_num, rp->plan_class ); delete rp; continue; } rp->wup->version_num = rp->version_num; results.push_back(rp); continue; } if (match_tag(buf, "")) { if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Project files outside project in state file" ); skip_unrecognized(buf, mf); continue; } project->parse_project_files(mf, false); project->link_project_files(false); continue; } if (match_tag(buf, "")) { retval = host_info.parse(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse host info in state file" ); } continue; } if (match_tag(buf, "")) { retval = time_stats.parse(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse time stats in state file" ); } continue; } if (match_tag(buf, "")) { retval = net_stats.parse(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse network stats in state file" ); } continue; } if (match_tag(buf, "")) { retval = active_tasks.parse(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse active tasks in state file" ); } continue; } if (parse_str(buf, "", statefile_platform_name)) { continue; } if (match_tag(buf, "")) { continue; } if (parse_int(buf, "", retval)) { run_mode.set(retval, 0); continue; } if (parse_int(buf, "", retval)) { network_mode.set(retval, 0); continue; } if (parse_int(buf, "", old_major_version)) { continue; } if (parse_int(buf, "", old_minor_version)) { continue; } if (parse_int(buf, "", old_release)) { continue; } if (match_tag(buf, "")) { run_cpu_benchmarks = true; continue; } if (match_tag(buf, "")) { work_fetch_no_new_work = true; continue; } if (match_tag(buf, "")) { retval = proxy_info.parse(mf); if (retval) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Can't parse proxy info in state file" ); } continue; } if (parse_str(buf, "", main_host_venue, sizeof(main_host_venue))) { continue; } if (parse_double(buf, "", new_version_check_time)) { continue; } if (parse_double(buf, "", all_projects_list_check_time)) { continue; } if (parse_str(buf, "", newer_version)) { continue; } if (match_tag(buf, "")) { if (!project) { msg_printf(NULL, MSG_INTERNAL_ERROR, "auto update outside project in state file" ); skip_unrecognized(buf, mf); continue; } if (!auto_update.parse(mf) && !auto_update.validate_and_link(project)) { auto_update.present = true; } continue; } if (log_flags.unparsed_xml) { msg_printf(0, MSG_INFO, "[unparsed_xml] state_file: unrecognized: %s", buf ); } skip_unrecognized(buf, mf); } fclose(f); return 0; } // Write the client_state.xml file // int CLIENT_STATE::write_state_file() { MFILE mf; int retval, ret1, ret2, attempt; #ifdef _WIN32 char win_error_msg[4096]; #endif for (attempt=1; attempt<=MAX_STATE_FILE_WRITE_ATTEMPTS; attempt++) { if (attempt > 1) boinc_sleep(1.0); if (log_flags.statefile_debug) { msg_printf(0, MSG_INFO, "[statefile_debug] Writing state file" ); } #ifdef _WIN32 retval = mf.open(STATE_FILE_NEXT, "wc"); #else retval = mf.open(STATE_FILE_NEXT, "w"); #endif if (retval) { if ((attempt == MAX_STATE_FILE_WRITE_ATTEMPTS) || log_flags.statefile_debug) { msg_printf(0, MSG_INTERNAL_ERROR, "Can't open %s: %s", STATE_FILE_NEXT, boincerror(retval) ); } if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; return ERR_FOPEN; } MIOFILE miof; miof.init_mfile(&mf); ret1 = write_state(miof); ret2 = mf.close(); if (ret1) { if ((attempt == MAX_STATE_FILE_WRITE_ATTEMPTS) || log_flags.statefile_debug) { msg_printf(NULL, MSG_INTERNAL_ERROR, "Couldn't write state file: %s", boincerror(retval) ); } if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; return ret1; } if (ret2) { if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; return ret2; } // only attempt to rename the current state file if it exists. // if (boinc_file_exists(STATE_FILE_NAME)) { if (boinc_file_exists(STATE_FILE_PREV)) { retval = boinc_delete_file(STATE_FILE_PREV); if (retval) { if ((attempt == MAX_STATE_FILE_WRITE_ATTEMPTS) || log_flags.statefile_debug) { #ifdef _WIN32 msg_printf(0, MSG_USER_ERROR, "Can't delete previous state file; %s", windows_error_string(win_error_msg, sizeof(win_error_msg)) ); #else msg_printf(0, MSG_USER_ERROR, "Can't delete previous state file; error %d: %s", errno, strerror(errno) ); #endif } if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; } } retval = boinc_rename(STATE_FILE_NAME, STATE_FILE_PREV); if (retval) { if ((attempt == MAX_STATE_FILE_WRITE_ATTEMPTS) || log_flags.statefile_debug) { #ifdef _WIN32 msg_printf(0, MSG_USER_ERROR, "Can't rename current state file to previous state file; %s", windows_error_string(win_error_msg, sizeof(win_error_msg)) ); #else msg_printf(0, MSG_USER_ERROR, "rename current state file to previous state file returned error %d: %s", errno, strerror(errno) ); #endif } if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; } } retval = boinc_rename(STATE_FILE_NEXT, STATE_FILE_NAME); if (log_flags.statefile_debug) { msg_printf(0, MSG_INFO, "[statefile_debug] Done writing state file" ); } if (!retval) break; // Success! if ((attempt == MAX_STATE_FILE_WRITE_ATTEMPTS) || log_flags.statefile_debug) { #ifdef _WIN32 if (retval == ERROR_ACCESS_DENIED) { msg_printf(0, MSG_USER_ERROR, "Can't rename state file; access denied; check file and directory permissions" ); } else { msg_printf(0, MSG_USER_ERROR, "Can't rename state file; %s", windows_error_string(win_error_msg, sizeof(win_error_msg)) ); } #elif defined (__APPLE__) msg_printf(0, MSG_USER_ERROR, "Can't rename %s to %s; check file and directory permissions\n" "rename returned error %d: %s", STATE_FILE_NEXT, STATE_FILE_NAME, errno, strerror(errno) ); if (log_flags.statefile_debug) { system("ls -al /Library/Application\\ Support/BOINC\\ Data/client*.*"); } #else msg_printf(0, MSG_USER_ERROR, "Can't rename %s to %s; check file and directory permissions", STATE_FILE_NEXT, STATE_FILE_NAME ); #endif } if (attempt < MAX_STATE_FILE_WRITE_ATTEMPTS) continue; return ERR_RENAME; } return 0; } int CLIENT_STATE::write_state(MIOFILE& f) { unsigned int i, j; int retval; f.printf("\n"); retval = host_info.write(f, false); if (retval) return retval; retval = time_stats.write(f, false); if (retval) return retval; retval = net_stats.write(f); if (retval) return retval; for (j=0; jwrite_state(f); if (retval) return retval; for (i=0; iproject == p) { retval = apps[i]->write(f); if (retval) return retval; } } for (i=0; iproject == p) { retval = file_infos[i]->write(f, false); if (retval) return retval; } } for (i=0; iproject == p) { app_versions[i]->write(f); } } for (i=0; iproject == p) workunits[i]->write(f); } for (i=0; iproject == p) results[i]->write(f, false); } p->write_project_files(f); if (auto_update.present && auto_update.project==p) { auto_update.write(f); } } active_tasks.write(f); f.printf( "%s\n" "%d\n" "%d\n" "%d\n" "%d\n" "%d\n" "%s" "%f\n" "%f\n", get_primary_platform(), core_client_version.major, core_client_version.minor, core_client_version.release, run_mode.get_perm(), network_mode.get_perm(), cpu_benchmarks_pending?"\n":"", new_version_check_time, all_projects_list_check_time ); if (newer_version.size()) { f.printf("%s\n", newer_version.c_str()); } for (i=1; i%s\n", platforms[i].name.c_str()); } proxy_info.write(f); if (strlen(main_host_venue)) { f.printf("%s\n", main_host_venue); } f.printf("\n"); return 0; } // Write the client_state.xml file if necessary // TODO: write no more often than X seconds // int CLIENT_STATE::write_state_file_if_needed() { int retval; if (client_state_dirty) { client_state_dirty = false; retval = write_state_file(); if (retval) return retval; } return 0; } // look for app_versions.xml file in project dir. // If find, get app versions from there, // and use "anonymous platform" mechanism for this project // void CLIENT_STATE::check_anonymous() { unsigned int i; char dir[256], path[256]; FILE* f; int retval; for (i=0; ianonymous_platform = true; // flag as anonymous even if can't parse file retval = parse_app_info(p, f); if (retval) { msg_printf(p, MSG_USER_ERROR, "parse error in app_info.xml; check XML syntax" ); } fclose(f); } } // parse a project's app_info.xml (anonymous platform) file // int CLIENT_STATE::parse_app_info(PROJECT* p, FILE* in) { char buf[256]; MIOFILE mf; mf.init_file(in); while (fgets(buf, 256, in)) { if (match_tag(buf, "")) continue; if (match_tag(buf, "")) return 0; if (match_tag(buf, "")) { FILE_INFO* fip = new FILE_INFO; if (fip->parse(mf, false)) { delete fip; continue; } if (link_file_info(p, fip)) { delete fip; continue; } fip->status = FILE_PRESENT; file_infos.push_back(fip); continue; } if (match_tag(buf, "")) { APP* app = new APP; if (app->parse(mf)) { delete app; continue; } if (lookup_app(p, app->name)) { delete app; continue; } link_app(p, app); apps.push_back(app); continue; } if (match_tag(buf, "")) { APP_VERSION* avp = new APP_VERSION; if (avp->parse(mf)) { delete avp; continue; } if (strlen(avp->platform) == 0) { strcpy(avp->platform, get_primary_platform()); } if (link_app_version(p, avp)) { delete avp; continue; } app_versions.push_back(avp); continue; } if (log_flags.unparsed_xml) { msg_printf(p, MSG_USER_ERROR, "Unparsed line in app_info.xml: %s", buf ); } } return ERR_XML_PARSE; } int CLIENT_STATE::write_state_gui(MIOFILE& f) { unsigned int i, j; int retval; f.printf("\n"); #if 1 // NOTE: the following stuff is not in CC_STATE. // However, BoincView (which does its own parsing) expects it // to be in the get_state() reply, so leave it in for now // retval = host_info.write(f, false); if (retval) return retval; retval = time_stats.write(f, false); if (retval) return retval; retval = net_stats.write(f); if (retval) return retval; #endif for (j=0; jwrite_state(f, true); if (retval) return retval; for (i=0; iproject == p) { retval = apps[i]->write(f); if (retval) return retval; } } for (i=0; iproject == p) app_versions[i]->write(f); } for (i=0; iproject == p) workunits[i]->write(f); } for (i=0; iproject == p) results[i]->write_gui(f); } } f.printf( "%s\n" "%d\n" "%d\n" "%d\n" "%d\n" "%d\n", get_primary_platform(), core_client_version.major, core_client_version.minor, core_client_version.release, executing_as_daemon?1:0, coproc_cuda?1:0 ); for (i=0; i%s\n", platforms[i].name.c_str() ); } global_prefs.write(f); // the following used by BoincView - don't remove // if (strlen(main_host_venue)) { f.printf("%s\n", main_host_venue); } f.printf("\n"); return 0; } int CLIENT_STATE::write_tasks_gui(MIOFILE& f) { unsigned int i; for (i=0; iwrite_gui(f); } return 0; } int CLIENT_STATE::write_file_transfers_gui(MIOFILE& f) { unsigned int i; f.printf("\n"); for (i=0; ipers_file_xfer || (fip->upload_when_present && fip->status == FILE_PRESENT && !fip->uploaded) ) { fip->write_gui(f); } } f.printf("\n"); return 0; } const char *BOINC_RCSID_375ec798cc = "$Id$";