Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity
boinc/api/boinc_api.C

665 lines
19 KiB
C
Raw Blame History

// Berkeley Open Infrastructure for Network Computing
// http://boinc.berkeley.edu
// Copyright (C) 2005 University of California
//
// This 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 2.1 of the License, or (at your option) any later version.
//
// This software 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.
//
// To view the GNU Lesser General Public License visit
// http://www.gnu.org/copyleft/lesser.html
// or write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
// Code that's in the BOINC app library (but NOT in the core client)
// graphics-related code goes in graphics_api.C, not here
#ifdef _WIN32
#include "boinc_win.h"
#include "version.h"
#else
#include "config.h"
#include <cstdlib>
#include <cstdio>
#include <cstdarg>
#include <sys/types.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
using namespace std;
#endif
#include "diagnostics.h"
#include "parse.h"
#include "shmem.h"
#include "util.h"
#include "filesys.h"
#include "mem_usage.h"
#include "error_numbers.h"
#include "app_ipc.h"
#include "boinc_api.h"
// The BOINC API communicates CPU time and fraction done to the core client.
// Currently this is done using a timer.
// Remember that the processing of a result can be divided
// into multiple "episodes" (executions of the app),
// each of which resumes from the checkpointed state of the previous episode.
// Unless otherwise noted, "CPU time" refers to the sum over all episodes
// (not counting the part after the last checkpoint in an episode).
static APP_INIT_DATA aid;
APP_CLIENT_SHM *app_client_shm = 0;
static double timer_period = 1.0;
// period of API timer
// This determines the resolution of fraction done and CPU time reporting
// to the core client, and of checkpoint enabling.
// It doesn't influence graphics, so 1 sec is enough.
static double time_until_checkpoint;
// time until enable checkpoint
static double time_until_fraction_done_update;
// time until report fraction done to core client
static double fraction_done;
static double last_checkpoint_cpu_time;
static bool ready_to_checkpoint = false;
static double last_wu_cpu_time;
static bool standalone = false;
static double initial_wu_cpu_time;
static bool have_new_trickle_up = false;
static bool have_trickle_down = true;
// on first call, scan slot dir for msgs
static double heartbeat_giveup_time;
static bool heartbeat_active;
// if false, suppress heartbeat mechanism
static int nrunning_ticks = 0;
#define HEARTBEAT_GIVEUP_PERIOD 30.0
// quit if no heartbeat from core in this #secs
#define HEARTBEAT_TIMEOUT_PERIOD 35.0
// quit if we cannot aquire slot resource in this #secs
#ifdef _WIN32
//HANDLE hErrorNotification;
//HANDLE hQuitRequest;
//HANDLE hSuspendRequest;
//HANDLE hResumeRequest;
static HANDLE hSharedMem;
HANDLE worker_thread_handle;
static MMRESULT timer_id;
#endif
static int setup_shared_mem();
static int update_app_progress(double cpu_t, double cp_cpu_t, double ws_t);
static BOINC_OPTIONS options;
static BOINC_STATUS boinc_status;
// the following 2 functions are used when there's no graphics
//
int boinc_init() {
boinc_options_defaults(options);
return boinc_init_options(options);
}
int boinc_init_options(BOINC_OPTIONS& opt) {
int retval;
retval = boinc_init_options_general(opt);
if (retval) return retval;
return set_worker_timer();
}
// the following can be called by either graphics or worker thread
//
int boinc_init_options_general(BOINC_OPTIONS& opt) {
int retval;
options = opt;
memset(&boinc_status, 0, sizeof(boinc_status));
if (options.main_program) {
// make sure we're the only app running in this slot
//
retval = lock_file(LOCKFILE);
if (retval) {
// give any previous occupant a chance to timeout and exit
//
boinc_sleep(HEARTBEAT_TIMEOUT_PERIOD);
retval = lock_file(LOCKFILE);
}
if (retval) {
fprintf(stderr, "Can't acquire lockfile - exiting\n");
boinc_exit(0); // not un-recoverable ==> status=0
}
}
#ifdef _WIN32
DuplicateHandle(
GetCurrentProcess(),
GetCurrentThread(),
GetCurrentProcess(),
&worker_thread_handle,
0,
FALSE,
DUPLICATE_SAME_ACCESS
);
#endif
retval = boinc_parse_init_data_file();
if (retval) {
standalone = true;
} else {
if (aid.core_version && (aid.core_version/100 != BOINC_MAJOR_VERSION)) {
fprintf(stderr, "Core client has wrong major version: wanted %d, got %d\n",
BOINC_MAJOR_VERSION, aid.core_version/100
);
boinc_exit(ERR_MAJOR_VERSION); // un-recoverable==> exit with nonzero status
}
retval = setup_shared_mem();
if (retval) {
fprintf(stderr, "Can't set up shared mem: %d\n", retval);
standalone = true;
}
}
// copy the WU CPU time to a separate var,
// since we may reread the structure again later.
//
initial_wu_cpu_time = aid.wu_cpu_time;
// the following may not be needed, but do it anyway
//
fraction_done = -1;
time_until_checkpoint = aid.checkpoint_period;
last_checkpoint_cpu_time = aid.wu_cpu_time;
time_until_fraction_done_update = aid.fraction_done_update_period;
last_wu_cpu_time = aid.wu_cpu_time;
heartbeat_active = !standalone;
heartbeat_giveup_time = dtime() + HEARTBEAT_GIVEUP_PERIOD;
return 0;
}
int boinc_get_status(BOINC_STATUS& s) {
s = boinc_status;
return 0;
}
static void send_trickle_up_msg() {
if (have_new_trickle_up) {
if (app_client_shm->shm->trickle_up.send_msg("<have_new_trickle_up/>\n")) {
have_new_trickle_up = false;
}
}
}
// NOTE: a non-zero status tells a running client that we're exiting with
// an "unrecoverable error", which will be reported back to server.
// A zero exit-status will tell the client we've successfully finished the result.
int boinc_finish(int status) {
if (options.send_status_msgs) {
boinc_calling_thread_cpu_time(last_checkpoint_cpu_time);
last_checkpoint_cpu_time += aid.wu_cpu_time;
update_app_progress(last_checkpoint_cpu_time, last_checkpoint_cpu_time, 0);
}
if (options.handle_trickle_ups) {
send_trickle_up_msg();
}
#ifdef _WIN32
// Stop the timer
timeKillEvent(timer_id);
CloseHandle(worker_thread_handle);
#endif
if (options.main_program && status==0) {
FILE* f = fopen(BOINC_FINISH_CALLED_FILE, "w");
if (f) fclose(f);
}
if (options.send_status_msgs) {
aid.wu_cpu_time = last_checkpoint_cpu_time;
boinc_write_init_data_file();
}
// now remove lockfile+exit
boinc_exit(status);
return(0); // doh... we never get here
} // boinc_finish()
// exit a boinc-app
// this simply closes, then removes the app's lockfile and
// calls the appropriate exit-function
#if (!defined _WIN32) && (!defined HANDLE)
typedef int HANDLE;
#endif
extern HANDLE app_lockfile_handle;
void
boinc_exit (int status)
{
#ifdef _WIN32
if ( !CloseHandle ( app_lockfile_handle ) )
perror ( "Failed to close the application-lockfile.");
#else
if ( close ( app_lockfile_handle ) )
perror ( "Failed to close the application-lockfile " LOCKFILE);
#endif
// remove the lockfile
if ( boinc_delete_file (LOCKFILE) != 0)
perror ("boinc_finish(): failed to remove lockfile");
// on Mac, calling exit() can lead to infinite exit-atexit loops, while _exit() seems
// to behave nicely. This is not pretty but unless someone finds a cleaner solution,
// we handle the Mac-case separately .
#ifdef __APPLE_CC__
_exit(status);
#else
exit(status);
#endif
} // boinc_exit()
bool boinc_is_standalone() {
return standalone;
}
// parse the init data file.
// This is done at startup, and also if a "reread prefs" message is received
//
int boinc_parse_init_data_file() {
FILE* f;
int retval;
memset(&aid, 0, sizeof(aid));
safe_strncpy(aid.user_name, "Unknown user", sizeof(aid.user_name));
safe_strncpy(aid.team_name, "Unknown team", sizeof(aid.team_name));
aid.wu_cpu_time = 1000;
aid.user_total_credit = 1000;
aid.user_expavg_credit = 500;
aid.host_total_credit = 1000;
aid.host_expavg_credit = 500;
aid.checkpoint_period = DEFAULT_CHECKPOINT_PERIOD;
aid.fraction_done_update_period = DEFAULT_FRACTION_DONE_UPDATE_PERIOD;
if (!boinc_file_exists(INIT_DATA_FILE)) {
fprintf(stderr,
"Can't open init data file - running in standalone mode\n"
);
return ERR_FOPEN;
}
f = boinc_fopen(INIT_DATA_FILE, "r");
retval = parse_init_data_file(f, aid);
fclose(f);
if (retval) {
fprintf(stderr,
"Can't parse init data file - running in standalone mode\n"
);
return retval;
}
return 0;
}
int boinc_write_init_data_file() {
FILE* f = boinc_fopen(INIT_DATA_FILE, "w");
if (!f) return ERR_FOPEN;
int retval = write_init_data_file(f, aid);
fclose(f);
return retval;
}
int boinc_report_app_status(
double cpu_time,
double checkpoint_cpu_time,
double fraction_done
) {
char msg_buf[MSG_CHANNEL_SIZE];
sprintf(msg_buf,
"<current_cpu_time>%10.4f</current_cpu_time>\n"
"<checkpoint_cpu_time>%.15e</checkpoint_cpu_time>\n"
"<fraction_done>%2.8f</fraction_done>\n",
cpu_time,
checkpoint_cpu_time,
fraction_done
);
app_client_shm->shm->app_status.send_msg(msg_buf);
return 0;
}
// communicate to the core client (via shared mem)
// the current CPU time and fraction done
//
static int update_app_progress(
double cpu_t, double cp_cpu_t, double ws_t
) {
char msg_buf[MSG_CHANNEL_SIZE], buf[256];
double vm, rs;
if (!app_client_shm) return 0;
sprintf(msg_buf,
"<current_cpu_time>%10.4f</current_cpu_time>\n"
"<checkpoint_cpu_time>%.15e</checkpoint_cpu_time>\n",
cpu_t, cp_cpu_t
);
if (fraction_done >= 0) {
double range = aid.fraction_done_end - aid.fraction_done_start;
double fdone = aid.fraction_done_start + fraction_done*range;
sprintf(buf, "<fraction_done>%2.8f</fraction_done>\n", fdone);
strcat(msg_buf, buf);
}
if (!mem_usage(vm, rs)) {
sprintf(buf,
"<vm_bytes>%f</vm_bytes>\n"
"<rss_bytes>%flu</rss_bytes>\n",
vm, rs
);
strcat(msg_buf, buf);
}
app_client_shm->shm->app_status.send_msg(msg_buf);
return 0;
}
int boinc_get_init_data(APP_INIT_DATA& app_init_data) {
app_init_data = aid;
return 0;
}
// this can be called from the graphics thread
//
int boinc_wu_cpu_time(double& cpu_t) {
cpu_t = last_wu_cpu_time;
return 0;
}
#ifdef _WIN32
int boinc_worker_thread_cpu_time(double& cpu) {
if (boinc_thread_cpu_time(worker_thread_handle, cpu)) {
cpu = nrunning_ticks * timer_period; // for Win9x
}
return 0;
}
#else
int boinc_worker_thread_cpu_time(double& cpu) {
return boinc_calling_thread_cpu_time(cpu);
}
#endif // _WIN32
static void handle_heartbeat_msg() {
char buf[MSG_CHANNEL_SIZE];
if (app_client_shm->shm->heartbeat.get_msg(buf)) {
if (match_tag(buf, "<heartbeat/>")) {
heartbeat_giveup_time = dtime() + HEARTBEAT_GIVEUP_PERIOD;
}
if (match_tag(buf, "<enable_heartbeat/>")) {
heartbeat_active = true;
}
if (match_tag(buf, "<disable_heartbeat/>")) {
heartbeat_active = false;
}
}
}
static void handle_trickle_down_msg() {
char buf[MSG_CHANNEL_SIZE];
if (app_client_shm->shm->trickle_down.get_msg(buf)) {
if (match_tag(buf, "<have_trickle_down/>")) {
have_trickle_down = true;
}
}
}
static void handle_process_control_msg() {
char buf[MSG_CHANNEL_SIZE];
if (app_client_shm->shm->process_control_request.get_msg(buf)) {
if (match_tag(buf, "<suspend/>")) {
boinc_status.suspended = true;
if (options.direct_process_action) {
#ifdef _WIN32
SuspendThread(worker_thread_handle);
#else
while (1) {
if (app_client_shm->shm->process_control_request.get_msg(buf)) {
if (match_tag(buf, "<resume/>")) {
break;
}
if (match_tag(buf, "<quit/>")) {
boinc_exit(0); // NOTE: exit-status = 0 ==> recoverable exit!
}
}
boinc_sleep(1.0);
}
heartbeat_giveup_time = dtime() + HEARTBEAT_GIVEUP_PERIOD;
#endif
}
}
if (match_tag(buf, "<resume/>")) {
boinc_status.suspended = false;
if (options.direct_process_action) {
#ifdef _WIN32
ResumeThread(worker_thread_handle);
#endif
}
}
if (match_tag(buf, "<quit/>")) {
boinc_status.quit_request = true;
if (options.direct_process_action) {
boinc_exit(0); // NOTE: exit-status == 0!
}
}
}
}
#ifdef _WIN32
static void CALLBACK worker_timer(
UINT uTimerID, UINT uMsg, DWORD dwUser, DWORD dw1, DWORD dw2
) {
#else
static void worker_timer(int a) {
#endif
if (!ready_to_checkpoint) {
time_until_checkpoint -= timer_period;
if (time_until_checkpoint <= 0) {
ready_to_checkpoint = true;
}
}
// handle messages from the core client
//
if (app_client_shm) {
if (options.check_heartbeat) {
handle_heartbeat_msg();
}
if (options.handle_trickle_downs) {
handle_trickle_down_msg();
}
if (options.handle_process_control) {
handle_process_control_msg();
}
}
// see if the core client has died, which means we need to die too
//
if (options.check_heartbeat && heartbeat_active) {
double now = dtime();
if (heartbeat_giveup_time < now) {
fprintf(stderr,
"No heartbeat from core client for %f sec - exiting\n",
now - (heartbeat_giveup_time - HEARTBEAT_GIVEUP_PERIOD)
);
if (options.direct_process_action) {
boinc_exit(0); // NOTE: exit-status == 0! (recoverable error)
} else {
boinc_status.no_heartbeat = true;
}
}
}
if (options.send_status_msgs) {
time_until_fraction_done_update -= timer_period;
if (time_until_fraction_done_update <= 0) {
double cur_cpu;
boinc_worker_thread_cpu_time(cur_cpu);
last_wu_cpu_time = cur_cpu + initial_wu_cpu_time;
update_app_progress(last_wu_cpu_time, last_checkpoint_cpu_time, 0);
time_until_fraction_done_update = aid.fraction_done_update_period;
}
}
if (options.handle_trickle_ups) {
send_trickle_up_msg();
}
#ifdef _WIN32
// poor man's CPU time accounting for Win9x
//
if (!boinc_status.suspended) {
nrunning_ticks++;
}
#endif
}
int set_worker_timer() {
int retval=0;
#ifdef _WIN32
// Use Windows multimedia timer, since it is more accurate
// than SetTimer and doesn't require an associated event loop
//
timer_id = timeSetEvent(
(int)(timer_period*1000), // uDelay
(int)(timer_period*1000), // uResolution
worker_timer, // lpTimeProc
NULL, // dwUser
TIME_PERIODIC // fuEvent
);
#else
struct sigaction sa;
itimerval value;
sa.sa_handler = worker_timer;
sa.sa_flags = SA_RESTART;
retval = sigaction(SIGALRM, &sa, NULL);
if (retval) {
perror("boinc set_worker_timer() sigaction");
return retval;
}
value.it_value.tv_sec = (int)timer_period;
value.it_value.tv_usec = ((int)(timer_period*1000000))%1000000;
value.it_interval = value.it_value;
retval = setitimer(ITIMER_REAL, &value, NULL);
if (retval) {
perror("boinc set_worker_timer() setitimer");
}
#endif
return retval;
}
static int setup_shared_mem() {
if (standalone) {
fprintf(stderr, "Standalone mode, so not using shared memory.\n");
return 0;
}
app_client_shm = new APP_CLIENT_SHM;
#ifdef _WIN32
char buf[256];
sprintf(buf, "%s%s", SHM_PREFIX, aid.shmem_seg_name);
hSharedMem = attach_shmem(buf, (void**)&app_client_shm->shm);
if (hSharedMem == NULL) {
delete app_client_shm;
app_client_shm = NULL;
}
#else
if (attach_shmem(aid.shmem_seg_name, (void**)&app_client_shm->shm)) {
delete app_client_shm;
app_client_shm = NULL;
}
#endif
if (app_client_shm == NULL) return -1;
return 0;
}
int boinc_send_trickle_up(char* variety, char* p) {
if (!options.handle_trickle_ups) return ERR_NO_OPTION;
FILE* f = boinc_fopen(TRICKLE_UP_FILENAME, "wb");
if (!f) return ERR_FOPEN;
fprintf(f, "<variety>%s</variety>\n", variety);
size_t n = fwrite(p, strlen(p), 1, f);
fclose(f);
if (n != 1) return ERR_WRITE;
have_new_trickle_up = true;
return 0;
}
// logically this should be a bool. But it need to be an int to be
// compatible with C API.
int boinc_time_to_checkpoint() {
// If the application has received a quit request it should checkpoint
//
if (ready_to_checkpoint) {
return 1;
}
return 0;
}
int boinc_checkpoint_completed() {
double cur_cpu;
boinc_calling_thread_cpu_time(cur_cpu);
last_wu_cpu_time = cur_cpu + aid.wu_cpu_time;
last_checkpoint_cpu_time = last_wu_cpu_time;
update_app_progress(last_checkpoint_cpu_time, last_checkpoint_cpu_time, 0);
ready_to_checkpoint = false;
time_until_checkpoint = aid.checkpoint_period;
return 0;
}
int boinc_fraction_done(double x) {
fraction_done = x;
return 0;
}
bool boinc_receive_trickle_down(char* buf, int len) {
std::string filename;
char path[256];
if (!options.handle_trickle_downs) return false;
if (have_trickle_down) {
relative_to_absolute("", path);
DirScanner dirscan(path);
fprintf(stderr, "starting scan of %s\n", path);
while (dirscan.scan(filename)) {
fprintf(stderr, "scan: %s\n", filename.c_str());
if (strstr(filename.c_str(), "trickle_down")) {
strncpy(buf, filename.c_str(), len);
return true;
}
}
have_trickle_down = false;
}
return false;
}
const char *BOINC_RCSID_0fa0410386 = "$Id$";
Reference in New Issue View Git Blame Copy Permalink