// 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 _APP_IPC_
#define _APP_IPC_
#ifdef __cplusplus
#include
#include
#include
#include "hostinfo.h"
#include "proxy_info.h"
#include "prefs.h"
#include "common_defs.h"
// Communication between the core client and the BOINC app library.
// This code is linked into both core client and app lib.
//
// Some apps may involve separate "coordinator" and "worker" programs.
// The coordinator runs one or more worker programs in sequence,
// and don't do work themselves.
//
// Includes the following:
// - shared memory (APP_CLIENT_SHM)
// - main init file
// - fd init file
// - graphics init file
// - conversion of symbolic links
// Shared memory is a set of MSG_CHANNELs.
// First byte of a channel is nonzero if
// the channel contains an unread data.
// This is set by the sender and cleared by the receiver.
// The sender doesn't write if the flag is set.
// Remaining 1023 bytes contain data.
//
#define MSG_CHANNEL_SIZE 1024
struct MSG_CHANNEL {
char buf[MSG_CHANNEL_SIZE];
bool get_msg(char*); // returns a message and clears pending flag
inline bool has_msg() {
return buf[0]?true:false;
}
bool send_msg(const char*); // if there is not a message in the segment,
// writes specified message and sets pending flag
void send_msg_overwrite(const char*);
// write message, overwriting any msg already there
};
struct SHARED_MEM {
MSG_CHANNEL process_control_request;
// core->app
//
//
//
MSG_CHANNEL process_control_reply;
// app->core
MSG_CHANNEL graphics_request;
// core->app
// request a graphics mode:
//
// ...
//
MSG_CHANNEL graphics_reply;
// app->core
// same as above
MSG_CHANNEL heartbeat;
// core->app
// sent every second, even while app is suspended
// app's current working set size
// max working set size
MSG_CHANNEL app_status;
// app->core
// status message every second, of the form
// ...
// ...
// ...
// ...
MSG_CHANNEL trickle_up;
// app->core
//
MSG_CHANNEL trickle_down;
// core->app
//
};
// MSG_QUEUE provides a queuing mechanism for shared-mem messages
// (which don't have one otherwise)
//
struct MSG_QUEUE {
std::vector msgs;
char name[256];
double last_block; // last time we found message channel full
void init(char*);
void msg_queue_send(const char*, MSG_CHANNEL& channel);
void msg_queue_poll(MSG_CHANNEL& channel);
int msg_queue_purge(const char*);
bool timeout(double);
};
#define DEFAULT_CHECKPOINT_PERIOD 300
#define SHM_PREFIX "shm_"
#define QUIT_PREFIX "quit_"
struct GRAPHICS_MSG {
int mode;
char window_station[256];
char desktop[256];
char display[256];
GRAPHICS_MSG();
};
class APP_CLIENT_SHM {
public:
SHARED_MEM *shm;
int decode_graphics_msg(char*, GRAPHICS_MSG&);
void reset_msgs(); // resets all messages and clears their flags
APP_CLIENT_SHM();
};
#ifdef _WIN32
typedef char SHMEM_SEG_NAME[256];
#else
typedef int SHMEM_SEG_NAME;
#endif
// parsed version of main init file
// If you add anything here, update copy()
//
struct APP_INIT_DATA {
int major_version;
int minor_version;
int release;
int app_version;
char app_name[256];
char symstore[256];
char acct_mgr_url[256];
char* project_preferences;
int userid;
int teamid;
int hostid;
// project's DB ID for this host (NOT host CPID)
char user_name[256];
char team_name[256];
char project_dir[256];
char boinc_dir[256];
char wu_name[256];
char result_name[256];
char authenticator[256];
int slot;
int client_pid;
double user_total_credit;
double user_expavg_credit;
double host_total_credit;
double host_expavg_credit;
double resource_share_fraction;
HOST_INFO host_info;
PROXY_INFO proxy_info; // in case app wants to use network
GLOBAL_PREFS global_prefs;
double starting_elapsed_time; // elapsed time, counting previous episodes
bool using_sandbox; // client is using account-based sandboxing
// info about the WU
double rsc_fpops_est;
double rsc_fpops_bound;
double rsc_memory_bound;
double rsc_disk_bound;
double computation_deadline;
// the following are used for compound apps,
// where each stage of the computation is a fixed fraction of the total.
//
double fraction_done_start;
double fraction_done_end;
// info for GPU apps
//
char gpu_type[64];
int gpu_device_num;
int gpu_opencl_dev_index;
double gpu_usage; // APP_VERSION.gpu_usage.usage
// info for multicore apps: how many cores to use
//
double ncpus;
// client configuration info
//
bool vbox_window;
// Items below here are for BOINC runtime system,
// and should not be directly accessed by apps
//
double checkpoint_period; // recommended checkpoint period
SHMEM_SEG_NAME shmem_seg_name;
double wu_cpu_time; // cpu time from previous episodes
APP_INIT_DATA();
APP_INIT_DATA(const APP_INIT_DATA&); // copy constructor
APP_INIT_DATA &operator=(const APP_INIT_DATA&);
void copy(const APP_INIT_DATA&); // actually do the copy here
void clear();
~APP_INIT_DATA();
};
struct GRAPHICS_INFO {
int xsize;
int ysize;
double refresh_period;
};
typedef struct GRAPHICS_INFO GRAPHICS_INFO;
int write_init_data_file(FILE* f, APP_INIT_DATA&);
int parse_init_data_file(FILE* f, APP_INIT_DATA&);
int write_graphics_file(FILE* f, GRAPHICS_INFO* gi);
int parse_graphics_file(FILE* f, GRAPHICS_INFO* gi);
// filenames used in the slot directory
//
#define INIT_DATA_FILE "init_data.xml"
#define BOINC_FINISH_CALLED_FILE "boinc_finish_called"
#define TEMPORARY_EXIT_FILE "boinc_temporary_exit"
#define TRICKLE_UP_FILENAME "trickle_up.xml"
#define STDERR_FILE "stderr.txt"
#define STDOUT_FILE "stdout.txt"
#define LOCKFILE "boinc_lockfile"
#define UPLOAD_FILE_REQ_PREFIX "boinc_ufr_"
#define UPLOAD_FILE_STATUS_PREFIX "boinc_ufs_"
// other filenames
#define PROJECT_DIR "projects"
extern const char* xml_graphics_modes[NGRAPHICS_MSGS];
extern int boinc_link(const char* phys_name, const char* logical_name);
extern int boinc_resolve_filename_s(const char*, std::string&);
extern void url_to_project_dir(char* url, char* dir);
extern "C" {
#endif
extern int boinc_resolve_filename(const char*, char*, int len);
#ifdef __cplusplus
} // extern "C" {
#endif
#endif