Select Git revision
boinc_api.h
David Anderson authored
- update_versions: use __ (not :) as separator for plan class
- client: add plan_class to APP_VERSION;
an app version is now identified by platform/version/plan_class
- client CPU scheduler: don't assume apps use 1 CPU
- client: add avg_ncpus, max_cpus, flops, cmdline to RESULT
- scheduler: implement app planning scheme
Other changes:
- client: if symlink() fails, make a XML soft link instead
(for Unix running off a FAT32 FS)
- client: don't accept nonpositive resource share from AMS
- daemons and DB: check for error returns from enumerations,
and exit if so. Thus, if the MySQL server goes down,
all the daemons will soon exit.
The cron script will restart them every 5 min,
so when the DB server comes back up so will the project.
- web: show empty max CPU % as ---
- API: get rid of all_threads_cpu_time option (always the case now)
svn path=/trunk/boinc/; revision=14966 boinc_api.h 5.18 KiB
// 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.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#ifndef _BOINC_API_
#define _BOINC_API_
#ifdef __APPLE__
#include <Carbon/Carbon.h>
#endif
// ANSI C API BEGINS HERE
// Do not put implementation stuff here
#ifdef __cplusplus
extern "C" {
#endif
typedef struct BOINC_OPTIONS {
// the following are booleans, implemented as ints for portability
int main_program;
// this is the main program, so
// - lock a lock file in the slot directory
// - write finish file on successful boinc_finish()
int check_heartbeat;
// action is determined by direct_process_action (see below)
int handle_trickle_ups;
// this process is allowed to call boinc_send_trickle_up()
int handle_trickle_downs;
// this process is allowed to call boinc_receive_trickle_down()
int handle_process_control;
// action is determined by direct_process_action (see below)
int send_status_msgs;
// send CPU time / fraction done msgs
int direct_process_action;
// if heartbeat fail, or get process control msg, take
// direction action (exit, suspend, resume).
// Otherwise just set flag in BOINC status
int worker_thread_stack_size;
// if nonzero, the worker thread stack size limit
int backwards_compatible_graphics;
// V6 apps should set this so that "Show Graphics" will work
// with pre-V6 clients
} BOINC_OPTIONS;
typedef struct BOINC_STATUS {
int no_heartbeat;
int suspended;
int quit_request;
int reread_init_data_file;
int abort_request;
double working_set_size;
double max_working_set_size;
} BOINC_STATUS;
typedef void (*FUNC_PTR)();
struct APP_INIT_DATA;
extern int boinc_init(void);
extern int boinc_finish(int status);
extern int boinc_resolve_filename(const char*, char*, int len);
extern int boinc_get_init_data_p(struct APP_INIT_DATA*);
extern int boinc_parse_init_data_file(void);
extern int boinc_send_trickle_up(char* variety, char* text);
extern int boinc_checkpoint_completed(void);
extern int boinc_fraction_done(double);
extern int boinc_suspend_other_activities(void);
extern int boinc_resume_other_activities(void);
extern int boinc_report_app_status(double, double, double);
extern int boinc_time_to_checkpoint();
extern void boinc_begin_critical_section();
extern int boinc_try_critical_section();
extern void boinc_end_critical_section();
extern void boinc_need_network();
extern int boinc_network_poll();
extern void boinc_network_done();
extern int boinc_is_standalone(void);
extern void boinc_ops_per_cpu_sec(double fp, double integer);
extern void boinc_ops_cumulative(double fp, double integer);
extern int boinc_receive_trickle_down(char* buf, int len);
extern int boinc_init_options(BOINC_OPTIONS*);
extern int boinc_get_status(BOINC_STATUS*);
extern double boinc_get_fraction_done();
extern void boinc_register_timer_callback(FUNC_PTR);
extern double boinc_worker_thread_cpu_time();
extern void boinc_exit(int); // deprecated
#ifdef __APPLE__
extern int setMacPList(void);
extern int setMacIcon(char *filename, char *iconData, long iconSize);
#endif
#ifdef __cplusplus
} // extern "C" {
#endif
// C++ API follows
#ifdef __cplusplus
#include <string>
#include "app_ipc.h"
extern int boinc_resolve_filename_s(const char*, std::string&);
extern int boinc_get_init_data(APP_INIT_DATA&);
extern int boinc_wu_cpu_time(double&);
extern int boinc_upload_file(std::string& name);
extern int boinc_upload_status(std::string& name);
extern int boinc_write_init_data_file(APP_INIT_DATA&);
extern int suspend_activities(); // deprecated
extern int resume_activities(); // deprecated
extern int restore_activities(); //deprecated
/////////// API ENDS HERE
/////////// IMPLEMENTATION STUFF BEGINS HERE
extern void options_defaults(BOINC_OPTIONS&);
extern APP_CLIENT_SHM *app_client_shm;
#ifdef _WIN32
extern HANDLE worker_thread_handle;
#endif
extern int boinc_init_options_general(BOINC_OPTIONS& opt);
extern int start_timer_thread();
extern bool g_sleep;
inline void boinc_options_defaults(BOINC_OPTIONS& b) { b.main_program = 1;
b.check_heartbeat = 1;
b.handle_trickle_ups = 1;
b.handle_trickle_downs = 1;
b.handle_process_control = 1;
b.send_status_msgs = 1;
b.direct_process_action = 1;
b.worker_thread_stack_size = 0;
b.backwards_compatible_graphics = 1;
}
/////////// IMPLEMENTATION STUFF ENDS HERE
#endif // C++ part
#endif // double-inclusion protection