// 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 . #ifndef _BOINC_DB_ #define _BOINC_DB_ // Structures corresponding to database records. // Some of these types have counterparts in client/types.h, // but don't be deceived - client and server have different variants. // The parse and write functions are for use in scheduler RPC. // They don't necessarily serialize the entire records. #include #include #include #include "db_base.h" #include "boinc_db_types.h" extern DB_CONN boinc_db; struct TRANSITIONER_ITEM { int id; // WARNING: this is the WU ID char name[256]; int appid; int min_quorum; bool need_validate; int canonical_resultid; int transition_time; int delay_bound; int error_mask; int max_error_results; int max_total_results; int file_delete_state; int assimilate_state; int target_nresults; char result_template_file[64]; int priority; int hr_class; int batch; int app_version_id; int transitioner_flags; int res_id; // This is the RESULT ID char res_name[256]; int res_report_deadline; int res_server_state; int res_outcome; int res_validate_state; int res_file_delete_state; int res_sent_time; int res_hostid; int res_received_time; int res_app_version_id; void clear(); void parse(MYSQL_ROW&); }; struct DB_HOST_APP_VERSION : public DB_BASE, public HOST_APP_VERSION { DB_HOST_APP_VERSION(DB_CONN* p=0); void db_print(char*); void db_parse(MYSQL_ROW &row); int update_scheduler(DB_HOST_APP_VERSION&); int update_validator(DB_HOST_APP_VERSION&); }; struct STATE_COUNTS { int appid; int last_update_time; int result_server_state_2; int result_server_state_4; int result_file_delete_state_1; int result_file_delete_state_2; int result_server_state_5_and_file_delete_state_0; int workunit_need_validate_1; int workunit_assimilate_state_1; int workunit_file_delete_state_1; int workunit_file_delete_state_2; void clear(); }; struct DB_STATE_COUNTS : public DB_BASE, public STATE_COUNTS { DB_STATE_COUNTS(DB_CONN* p=0); int get_id(); void db_print(char *); void db_parse(MYSQL_ROW &row); }; struct VALIDATOR_ITEM { WORKUNIT wu; RESULT res; void clear(); void parse(MYSQL_ROW&); }; class DB_PLATFORM : public DB_BASE, public PLATFORM { public: DB_PLATFORM(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; class DB_APP : public DB_BASE, public APP { public: DB_APP(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; class DB_APP_VERSION : public DB_BASE, public APP_VERSION { public: DB_APP_VERSION(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(APP_VERSION& w) {APP_VERSION::operator=(w);} }; class DB_USER : public DB_BASE, public USER { public: DB_USER(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(USER& r) {USER::operator=(r);} }; class DB_TEAM : public DB_BASE, public TEAM { public: DB_TEAM(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; class DB_HOST : public DB_BASE, public HOST { public: DB_HOST(DB_CONN* p=0); int get_id(); int update_diff_sched(HOST&); int update_diff_validator(HOST&); int fpops_percentile(double percentile, double& fpops); // return the given percentile of p_fpops int fpops_mean(double& mean); int fpops_stddev(double& stddev); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(HOST& r) {HOST::operator=(r);} }; class DB_RESULT : public DB_BASE, public RESULT { public: DB_RESULT(DB_CONN* p=0); int get_id(); int mark_as_sent(int old_server_state, int report_grace_period); void db_print(char*); void db_print_values(char*); void db_parse(MYSQL_ROW &row); void operator=(RESULT& r) {RESULT::operator=(r);} }; class DB_WORKUNIT : public DB_BASE, public WORKUNIT { public: DB_WORKUNIT(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(WORKUNIT& w) {WORKUNIT::operator=(w);} }; class DB_CREDITED_JOB : public DB_BASE, public CREDITED_JOB { public: DB_CREDITED_JOB(DB_CONN* p=0); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(CREDITED_JOB& wh) {CREDITED_JOB::operator=(wh);} }; class DB_MSG_FROM_HOST : public DB_BASE, public MSG_FROM_HOST { public: DB_MSG_FROM_HOST(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; class DB_MSG_TO_HOST : public DB_BASE, public MSG_TO_HOST { public: DB_MSG_TO_HOST(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; class DB_ASSIGNMENT : public DB_BASE, public ASSIGNMENT { public: DB_ASSIGNMENT(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW& row); }; // The transitioner uses this to get (WU, result) pairs efficiently. // Each call to enumerate() returns a list of the pairs for a single WU // class DB_TRANSITIONER_ITEM_SET : public DB_BASE_SPECIAL { public: DB_TRANSITIONER_ITEM_SET(DB_CONN* p=0); TRANSITIONER_ITEM last_item; int nitems_this_query; int enumerate( int transition_time, int nresult_limit, int wu_id_modulus, int wu_id_remainder, std::vector& items ); int update_result(TRANSITIONER_ITEM&); int update_workunit(TRANSITIONER_ITEM&, TRANSITIONER_ITEM&); }; // The validator uses this to get (WU, result) pairs efficiently. // Each call to enumerate() returns a list of the pairs for a single WU // class DB_VALIDATOR_ITEM_SET : public DB_BASE_SPECIAL { public: DB_VALIDATOR_ITEM_SET(DB_CONN* p=0); VALIDATOR_ITEM last_item; int nitems_this_query; int enumerate( int appid, int nresult_limit, int wu_id_modulus, int wu_id_remainder, std::vector& items ); int update_result(RESULT&); int update_workunit(WORKUNIT&); }; // used by the feeder and scheduler for outgoing work // struct WORK_ITEM { int res_id; int res_priority; int res_server_state; double res_report_deadline; WORKUNIT wu; void parse(MYSQL_ROW& row); }; class DB_WORK_ITEM : public WORK_ITEM, public DB_BASE_SPECIAL { int start_id; // when enumerate_all is used, keeps track of which ID to start from public: DB_WORK_ITEM(DB_CONN* p=0); int enumerate( int limit, const char* select_clause, const char* order_clause ); // used by feeder int enumerate_all( int limit, const char* select_clause ); // used by feeder when HR is used. // Successive calls cycle through all results. int read_result(); // used by scheduler to read result server state int update(); // used by scheduler to update WU transition time // and various result fields }; // Used by the scheduler to send or // messages if the result is no longer needed. // struct IN_PROGRESS_RESULT { char result_name[256]; int assimilate_state; int error_mask; int server_state; int outcome; void parse(MYSQL_ROW& row); }; class DB_IN_PROGRESS_RESULT : public IN_PROGRESS_RESULT, public DB_BASE_SPECIAL { public: DB_IN_PROGRESS_RESULT(DB_CONN* p=0); int enumerate(int hostid, const char* result_names); }; // Used by the scheduler to handle results reported by clients // The read and the update of these results are combined // into single SQL queries. struct SCHED_RESULT_ITEM { char queried_name[256]; // name as reported by client int id; char name[256]; int workunitid; int appid; int server_state; int client_state; int validate_state; int outcome; int hostid; int userid; int teamid; int sent_time; int received_time; double cpu_time; char xml_doc_out[BLOB_SIZE]; char stderr_out[BLOB_SIZE]; int app_version_num; int exit_status; int file_delete_state; double elapsed_time; int app_version_id; void clear(); void parse(MYSQL_ROW& row); }; class DB_SCHED_RESULT_ITEM_SET : public DB_BASE_SPECIAL { public: DB_SCHED_RESULT_ITEM_SET(DB_CONN* p=0); std::vector results; int add_result(char* result_name); int enumerate(); // using a single SQL query, look up all the reported results, // (based on queried_name) // and fill in the rest of the entries in the results vector int lookup_result(char* result_name, SCHED_RESULT_ITEM** result); int update_result(SCHED_RESULT_ITEM& result); int update_workunits(); }; struct FILE_ITEM { int id; char name[254]; char md5sum[34]; double size; void clear(); }; class DB_FILE : public DB_BASE, public FILE_ITEM { public: DB_FILE(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(FILE_ITEM& f) {FILE_ITEM::operator=(f);} }; struct FILESET_ITEM { int id; char name[254]; void clear(); }; class DB_FILESET : public DB_BASE, public FILESET_ITEM { public: DB_FILESET(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(FILESET_ITEM& f) {FILESET_ITEM::operator=(f);} // retrieve fileset instance (populate object) int select_by_name(const char* name); }; struct FILESET_FILE_ITEM { int fileset_id; int file_id; void clear(); }; class DB_FILESET_FILE : public DB_BASE, public FILESET_FILE_ITEM { public: DB_FILESET_FILE(DB_CONN* p=0); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(FILESET_FILE_ITEM& tf) {FILESET_FILE_ITEM::operator=(tf);} }; struct SCHED_TRIGGER_ITEM { int id; int fileset_id; bool need_work; bool work_available; bool no_work_available; bool working_set_removal; void clear(); }; class DB_SCHED_TRIGGER : public DB_BASE, public SCHED_TRIGGER_ITEM { public: DB_SCHED_TRIGGER(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); void operator=(SCHED_TRIGGER_ITEM& t) {SCHED_TRIGGER_ITEM::operator=(t);} typedef enum { none = 0, state_need_work = 1, state_work_available = 2, state_no_work_available = 3, state_working_set_removal = 4 } STATE; // retrieve trigger instance (populate object) int select_unique_by_fileset_name(const char* fileset_name); // set single trigger state int update_single_state(const DB_SCHED_TRIGGER::STATE state, const bool value); }; struct FILESET_SCHED_TRIGGER_ITEM { FILESET_ITEM fileset; SCHED_TRIGGER_ITEM trigger; void clear(); }; class DB_FILESET_SCHED_TRIGGER_ITEM : public DB_BASE_SPECIAL, public FILESET_SCHED_TRIGGER_ITEM { public: DB_FILESET_SCHED_TRIGGER_ITEM(DB_CONN* p=0); void db_parse(MYSQL_ROW &row); void operator=(FILESET_SCHED_TRIGGER_ITEM& fst) {FILESET_SCHED_TRIGGER_ITEM::operator=(fst);} }; class DB_FILESET_SCHED_TRIGGER_ITEM_SET : public DB_BASE_SPECIAL { public: DB_FILESET_SCHED_TRIGGER_ITEM_SET(DB_CONN* p=0); // select available triggers based on name and/or state // -> name filter optional (set string, default NULL) // -> pattern search optional (set use_regexp to true, default false)) // -> state filter optional (set state, default none) // -> state_value (default true) int select_by_name_state( const char* fileset_name, const bool use_regexp, const DB_SCHED_TRIGGER::STATE state, const bool state_value); // check if given trigger (fileset name) is part of set and return position (1-indexed) int contains_trigger(const char* fileset_name); // storage vector std::vector items; }; struct VDA_FILE { int id; double create_time; char dir[256]; char name[256]; double size; bool need_update; bool initialized; bool retrieving; void clear(); }; struct VDA_CHUNK_HOST { double create_time; int vda_file_id; int host_id; char name[256]; // C1.C2.Cn double size; bool present_on_host; bool transfer_in_progress; bool transfer_wait; double transfer_request_time; // when vdad assigned this chunk to this host double transfer_send_time; // when transfer request was sent to host // the following not in DB // bool found; void clear(); inline bool download_in_progress() { return (transfer_in_progress && !present_on_host); } }; struct DB_VDA_FILE : public DB_BASE, public VDA_FILE { DB_VDA_FILE(DB_CONN* p=0); int get_id(); void db_print(char*); void db_parse(MYSQL_ROW &row); }; struct DB_VDA_CHUNK_HOST : public DB_BASE, public VDA_CHUNK_HOST { DB_VDA_CHUNK_HOST(DB_CONN* p=0); void db_print(char*); void db_parse(MYSQL_ROW &row); }; #endif