Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity
boinc/sched/sched_main.cpp

686 lines
20 KiB
C++
Raw Blame History

// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2023 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 <http://www.gnu.org/licenses/>.
// The BOINC scheduler.
// Normally runs as a CGI or fast CGI program.
// You can also run it:
// - manually for debugging, with a single request
// - for simulation or performance testing, with a stream of requests
// (using --batch)
// TODO: what does the following mean?
// Also, You can call debug_sched() for whatever situation is of
// interest to you. It won't do anything unless you create
// (touch) the file 'debug_sched' in the project root directory.
//
#include "config.h"
#include <cassert>
#include <ctime>
#include "boinc_stdio.h"
#include <cstdlib>
#include <vector>
#include <string>
#include <cstring>
#include <unistd.h>
#include <csignal>
#include <cerrno>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/time.h>
#include <sys/resource.h>
#include "boinc_db.h"
#include "error_numbers.h"
#include "filesys.h"
#include "parse.h"
#include "shmem.h"
#include "str_util.h"
#include "svn_version.h"
#include "synch.h"
#include "util.h"
#include "handle_request.h"
#include "sched_config.h"
#include "sched_files.h"
#include "sched_keyword.h"
#include "sched_msgs.h"
#include "sched_types.h"
#include "sched_util.h"
#include "sched_main.h"
// Useful for debugging, if your cgi script keeps crashing. This
// makes it dump a core file that you can load into a debugger to see
// where the problem is.
#define DUMP_CORE_ON_SEGV 0
#define DEBUG_LEVEL 999
#define MAX_FCGI_COUNT 20
GUI_URLS gui_urls;
PROJECT_FILES project_files;
key_t sema_key;
int g_pid;
static bool db_opened=false;
SCHED_SHMEM* ssp = 0;
bool batch = false;
bool mark_jobs_done = false;
bool all_apps_use_hr;
static void usage(char* p) {
boinc::fprintf(stderr,
"Usage: %s [OPTION]...\n\n"
"Options:\n"
" --batch stdin contains a sequence of request messages.\n"
" Do them all, and ignore rpc_seqno.\n"
" --mark_jobs_done When send a job, also mark it as done.\n"
" (for performance testing)\n"
" --debug_log Write messages to the file 'debug_log'\n"
" --simulator X Start with simulated time X\n"
" (only if compiled with GCL_SIMULATOR)\n"
" -h | --help Show this help text\n"
" -v | --version Show version information\n",
p
);
}
void debug_sched(const char *trigger) {
char tmpfilename[256];
FILE *fp;
if (!boinc_file_exists(config.project_path("%s", trigger))) {
return;
}
sprintf(tmpfilename,
"sched_reply_%06ld_%06d", g_request->hostid, g_request->rpc_seqno
);
// use _XXXXXX if you want random filenames rather than
// deterministic mkstemp(tmpfilename);
fp=boinc::fopen(tmpfilename, "w");
if (!fp) {
log_messages.printf(MSG_CRITICAL,
"Found %s, but can't open %s\n", trigger, tmpfilename
);
return;
}
log_messages.printf(MSG_DEBUG,
"Found %s, so writing %s\n", trigger, tmpfilename
);
g_reply->write(fp, *g_request);
boinc::fclose(fp);
sprintf(tmpfilename,
"sched_request_%06ld_%06d", g_request->hostid, g_request->rpc_seqno
);
fp=boinc::fopen(tmpfilename, "w");
if (!fp) {
log_messages.printf(MSG_CRITICAL,
"Found %s, but can't open %s\n", trigger, tmpfilename
);
return;
}
log_messages.printf(MSG_DEBUG,
"Found %s, so writing %s\n", trigger, tmpfilename
);
g_request->write(fp);
boinc::fclose(fp);
return;
}
// call this only if we're not going to call handle_request()
//
static void send_message(const char* msg, int delay) {
boinc::fprintf(stdout,
"Content-type: text/plain\n\n"
"<scheduler_reply>\n"
" <message priority=\"low\">%s</message>\n"
" <request_delay>%d</request_delay>\n"
" <project_is_down/>\n"
"%s</scheduler_reply>\n",
msg, delay,
config.ended?" <ended>1</ended>\n":""
);
}
int open_database() {
int retval;
if (db_opened) {
retval = boinc_db.ping();
if (retval) {
log_messages.printf(MSG_CRITICAL,
"lost connection to database - trying to reconnect\n"
);
} else {
return 0;
}
}
retval = boinc_db.open(
config.db_name, config.db_host, config.db_user, config.db_passwd
);
if (retval) {
log_messages.printf(MSG_CRITICAL, "can't open database: %s\n",
boinc_db.error_string()
);
return retval;
}
db_opened = true;
return 0;
}
// If the scheduler 'hangs' (e.g. because DB is slow),
// Apache will send it a SIGTERM.
// Record this in the log file and close the DB conn.
//
void sigterm_handler(int /*signo*/) {
if (db_opened) {
boinc_db.close();
}
log_messages.printf(MSG_CRITICAL,
"Caught SIGTERM (sent by Apache); exiting\n"
);
unlock_sched();
boinc::fflush((FILE*)NULL);
exit(1);
return;
}
static void log_request_headers(int& length) {
char *cl=getenv("CONTENT_LENGTH");
char *ri=getenv("REMOTE_ADDR");
char *rm=getenv("REQUEST_METHOD");
char *ct=getenv("CONTENT_TYPE");
char *ha=getenv("HTTP_ACCEPT");
char *hu=getenv("HTTP_USER_AGENT");
if (config.debug_request_details) {
log_messages.printf(MSG_NORMAL,
"(req details) REQUEST_METHOD=%s CONTENT_TYPE=%s HTTP_ACCEPT=%s HTTP_USER_AGENT=%s\n",
rm?rm:"" , ct?ct:"", ha?ha:"", hu?hu:""
);
}
if (!cl) {
log_messages.printf(MSG_CRITICAL,
"CONTENT_LENGTH environment variable not set\n"
);
} else {
length=atoi(cl);
if (config.debug_request_details) {
log_messages.printf(MSG_NORMAL,
"CONTENT_LENGTH=%d from %s\n", length, ri?ri:"[Unknown]"
);
}
}
}
#if DUMP_CORE_ON_SEGV
void set_core_dump_size_limit() {
struct rlimit limit;
if (getrlimit(RLIMIT_CORE, &limit)) {
log_messages.printf(MSG_CRITICAL,
"Unable to read resource limit for core dump size.\n"
);
} else {
char short_string[256], *short_message=short_string;
short_message += sprintf(short_message,"Default resource limit for core dump size curr=");
if (limit.rlim_cur == RLIM_INFINITY) {
short_message += sprintf(short_message,"Inf max=");
} else {
short_message += sprintf(short_message,"%d max=", (int)limit.rlim_cur);
}
if (limit.rlim_max == RLIM_INFINITY) {
short_message += sprintf(short_message,"Inf\n");
} else {
short_message += sprintf(short_message,"%d\n", (int)limit.rlim_max);
}
log_messages.printf(MSG_DEBUG, "%s", short_string);
// now set limit to the maximum allowed value
limit.rlim_cur=limit.rlim_max;
if (setrlimit(RLIMIT_CORE, &limit)) {
log_messages.printf(MSG_CRITICAL,
"Unable to set current resource limit for core dump size to max value.\n"
);
} else {
log_messages.printf(MSG_DEBUG,
"Set limit for core dump size to max value.\n"
);
}
}
}
#endif
void attach_to_feeder_shmem() {
char path[MAXPATHLEN];
strlcpy(path, config.project_dir, sizeof(path));
get_key(path, 'a', sema_key);
int i, retval;
void* p;
retval = attach_shmem(config.shmem_key, &p);
if (retval || p==0) {
log_messages.printf(MSG_CRITICAL,
"Can't attach shmem: %d (feeder not running?)\n",
retval
);
log_messages.printf(MSG_CRITICAL,
"uid %d euid %d gid %d eguid%d\n",
getuid(), geteuid(), getgid(), getegid()
);
send_message(
"Server error: feeder not running", config.maintenance_delay
);
exit(0);
} else {
ssp = (SCHED_SHMEM*)p;
retval = ssp->verify();
if (retval) {
log_messages.printf(MSG_CRITICAL,
"shmem has wrong struct sizes - recompile\n"
);
send_message("Server error: recompile needed", config.maintenance_delay);
exit(0);
}
for (i=0; i<10; i++) {
if (ssp->ready) break;
log_messages.printf(MSG_DEBUG,
"waiting for ready flag\n"
);
sleep(1);
}
if (!ssp->ready) {
log_messages.printf(MSG_CRITICAL,
"feeder doesn't seem to be running\n"
);
send_message(
"Server error: feeder not running", config.maintenance_delay
);
exit(0);
}
}
all_apps_use_hr = true;
for (i=0; i<ssp->napps; i++) {
if (!ssp->apps[i].homogeneous_redundancy) {
all_apps_use_hr = false;
break;
}
}
}
inline static const char* get_remote_addr() {
const char * r = getenv("REMOTE_ADDR");
return r ? r : "?.?.?.?";
}
#if 0 // performance test for XML parsing (use a large request)
int main(int, char**) {
SCHEDULER_REQUEST sreq;
FILE* f = fopen("req", "r");
MIOFILE mf;
XML_PARSER xp(&mf);
mf.init_file(f);
for (int i=0; i<10; i++) {
sreq.parse(xp);
fseek(f, 0, SEEK_SET);
}
}
#else
#if !defined(PLAN_CLASS_TEST)
int main(int argc, char** argv) {
FILE* fin, *fout;
int i, retval;
char req_path[MAXPATHLEN], reply_path[MAXPATHLEN];
char log_path[MAXPATHLEN], path[MAXPATHLEN];
unsigned int counter=0;
char* code_sign_key;
int length = -1;
log_messages.pid = getpid();
bool debug_log = false;
for (i=1; i<argc; i++) {
if (!strcmp(argv[i], "--batch")) {
batch = true;
continue;
} else if (!strcmp(argv[i], "--mark_jobs_done")) {
mark_jobs_done = true;
} else if (!strcmp(argv[i], "--debug_log")) {
debug_log = true;
#ifdef GCL_SIMULATOR
} else if (!strcmp(argv[i], "--simulator")) {
if(!argv[++i]) {
log_messages.printf(MSG_CRITICAL, "%s requires an argument\n\n", argv[--i]);
usage(argv[0]);
exit(1);
}
simtime = atof(argv[i]);
#endif
} else if(!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
usage(argv[0]);
exit(0);
} else if(!strcmp(argv[i], "-v") || !strcmp(argv[i], "--version")) {
printf("%s\n", SVN_VERSION);
exit(0);
} else if (strlen(argv[i])){
log_messages.printf(MSG_CRITICAL, "unknown command line argument: %s\n\n", argv[i]);
usage(argv[0]);
exit(1);
}
}
// install a signal handler that catches SIGTERMS sent by Apache if the CGI
// times out.
//
signal(SIGTERM, sigterm_handler);
if (debug_log) {
if (!boinc::freopen("debug_log", "w", stderr)) {
boinc::fprintf(stderr, "Can't redirect stderr\n");
exit(1);
}
} else {
char *stderr_buffer;
if (get_log_path(path, "scheduler.log") == ERR_MKDIR) {
boinc::fprintf(stderr, "Can't create log directory '%s' (errno: %d)\n", path, errno);
}
#ifndef _USING_FCGI_
char buf[256];
if (!freopen(path, "a", stderr)) {
fprintf(stderr, "Can't redirect stderr\n");
sprintf(buf, "Server can't open log file (%s)", path);
send_message(buf, config.maintenance_delay);
exit(1);
}
#else
FILE* f = boinc::fopen(path, "a");
if (f) {
log_messages.redirect(f);
} else {
char buf[256];
boinc::fprintf(stderr, "Can't redirect FCGI log messages\n");
sprintf(buf, "Server can't open log file for FCGI (%s)", path);
send_message(buf, config.maintenance_delay);
exit(1);
}
#endif
// install a larger buffer for stderr. This ensures that
// log information from different scheduler requests running
// in parallel aren't intermingled in the log file.
//
if (config.scheduler_log_buffer) {
stderr_buffer = (char*)malloc(config.scheduler_log_buffer);
if (!stderr_buffer) {
log_messages.printf(MSG_CRITICAL,
"Unable to allocate stderr buffer\n"
);
} else {
#ifdef _USING_FCGI_
retval = setvbuf(
f->stdio_stream, stderr_buffer, _IOFBF,
config.scheduler_log_buffer
);
#else
retval = setvbuf(
stderr, stderr_buffer, _IOFBF, config.scheduler_log_buffer
);
#endif
if (retval) {
log_messages.printf(MSG_CRITICAL,
"Unable to change stderr buffering\n"
);
}
}
}
}
srand(time(0)+getpid());
log_messages.set_debug_level(DEBUG_LEVEL);
#if DUMP_CORE_ON_SEGV
set_core_dump_size_limit();
#endif
retval = config.parse_file();
if (retval) {
log_messages.printf(MSG_CRITICAL,
"Can't parse config.xml: %s\n", boincerror(retval)
);
send_message("Server can't parse configuration file", config.maintenance_delay);
exit(0);
}
log_messages.set_debug_level(config.sched_debug_level);
if (config.sched_debug_level == 4) g_print_queries = true;
gui_urls.init();
project_files.init();
init_file_delete_regex();
sprintf(path, "%s/code_sign_public", config.key_dir);
retval = read_file_malloc(path, code_sign_key);
if (retval) {
log_messages.printf(MSG_CRITICAL,
"Can't read code sign key file (%s)\n", path
);
send_message("Server can't find key file", config.maintenance_delay);
exit(0);
}
strip_whitespace(code_sign_key);
g_pid = getpid();
#ifdef _USING_FCGI_
//while(FCGI_Accept() >= 0 && counter < MAX_FCGI_COUNT) {
while(FCGI_Accept() >= 0) {
counter++;
log_messages.set_indent_level(0);
#endif
if (config.debug_request_headers) {
log_request_headers(length);
}
if (!debug_log && check_stop_sched()) {
send_message(
"Project is temporarily shut down for maintenance",
config.maintenance_delay
);
goto done;
}
if (!ssp) {
attach_to_feeder_shmem();
}
if (!ssp) {
send_message("Server error: can't attach shared memory", config.maintenance_delay);
goto done;
}
if (config.keyword_sched) {
keyword_sched_init();
}
if (strlen(config.debug_req_reply_dir)) {
struct stat statbuf;
// the code below is convoluted because,
// instead of going from stdin to stdout directly,
// we go via a pair of disk files
// (this makes it easy to save the input,
// and to know the length of the output).
// NOTE: to use this, you must create group-writeable dirs
// boinc_req and boinc_reply in the project dir
//
sprintf(req_path, "%s/%d_%u_sched_request.xml", config.debug_req_reply_dir, g_pid, counter);
sprintf(reply_path, "%s/%d_%u_sched_reply.xml", config.debug_req_reply_dir, g_pid, counter);
// keep an own 'log' per PID in case general logging fails
// this allows to associate at least the scheduler request with the client
// IP address (as shown in httpd error log) in case of a crash
sprintf(log_path, "%s/%d_%u_sched.log", config.debug_req_reply_dir, g_pid, counter);
fout = boinc::fopen(log_path, "a");
if (!fout) {
log_messages.printf(MSG_CRITICAL,
"can't write client log file %s\n", log_path
);
exit(1);
}
boinc::fprintf(fout, "PID: %d Client IP: %s\n", g_pid, get_remote_addr());
boinc::fclose(fout);
log_messages.printf(MSG_DEBUG,
"keeping sched_request in %s, sched_reply in %s, custom log in %s\n",
req_path, reply_path, log_path
);
fout = boinc::fopen(req_path, "w");
if (!fout) {
log_messages.printf(MSG_CRITICAL,
"can't write request file\n"
);
exit(1);
}
copy_stream(stdin, fout);
boinc::fclose(fout);
stat(req_path, &statbuf);
if (length>=0 && (statbuf.st_size != length)) {
log_messages.printf(MSG_CRITICAL,
"Request length %d != CONTENT_LENGTH %d\n",
(int)statbuf.st_size, length
);
}
fin = boinc::fopen(req_path, "r");
if (!fin) {
log_messages.printf(MSG_CRITICAL,
"can't read request file\n"
);
exit(1);
}
fout = boinc::fopen(reply_path, "w");
if (!fout) {
log_messages.printf(MSG_CRITICAL,
"can't write reply file\n"
);
exit(1);
}
handle_request(fin, fout, code_sign_key);
boinc::fclose(fin);
boinc::fclose(fout);
fin = boinc::fopen(reply_path, "r");
if (!fin) {
log_messages.printf(MSG_CRITICAL,
"can't read reply file\n"
);
exit(1);
}
copy_stream(fin, stdout);
boinc::fclose(fin);
// if not contacted from a client, don't keep the log files
/* not sure what lead to the assumption of a client setting
CONTENT_LENGTH, but it's wrong at least on our current
project / Apache / Client configuration. Commented out.
if (getenv("CONTENT_LENGTH")) {
unlink(req_path);
unlink(reply_path);
}
*/
#ifndef _USING_FCGI_
} else if (batch) {
while (!feof(stdin)) {
handle_request(stdin, stdout, code_sign_key);
fflush(stdout);
}
#endif
} else {
handle_request(stdin, stdout, code_sign_key);
boinc::fflush(stderr);
}
done:
#ifdef _USING_FCGI_
if (config.debug_fcgi) {
log_messages.printf(MSG_NORMAL,
"FCGI: counter: %d\n", counter
);
}
log_messages.flush();
} // do()
if (counter == MAX_FCGI_COUNT) {
boinc::fprintf(stderr, "FCGI: counter passed MAX_FCGI_COUNT - exiting..\n");
} else {
boinc::fprintf(stderr, "FCGI: FCGI_Accept failed - exiting..\n");
}
// when exiting, write headers back to apache so it won't complain
// about "incomplete headers"
boinc::fprintf(stdout,"Content-type: text/plain\n\n");
#endif
if (db_opened) {
boinc_db.close();
}
}
#endif
#endif
// the following stuff is here because if you put it in sched_limit.cpp
// you get "ssp undefined" in programs other than cgi
void RSC_JOB_LIMIT::print_log(const char* rsc_name) {
log_messages.printf(MSG_NORMAL,
"[quota] %s: base %d scaled %d njobs %d\n",
rsc_name, base_limit, scaled_limit, njobs
);
}
void JOB_LIMIT::print_log() {
if (total.any_limit()) total.print_log("total");
if (proc_type_limits[0].any_limit()) proc_type_limits[0].print_log("CPU");
if (proc_type_limits[1].any_limit()) proc_type_limits[1].print_log("GPU");
}
void JOB_LIMITS::print_log() {
log_messages.printf(MSG_NORMAL, "[quota] Overall limits on jobs in progress:\n");
project_limits.print_log();
for (unsigned int i=0; i<app_limits.size(); i++) {
if (app_limits[i].any_limit()) {
APP* app = ssp->lookup_app_name(app_limits[i].app_name);
if (!app) continue;
log_messages.printf(MSG_NORMAL,
"[quota] Limits for %s:\n", app->name
);
app_limits[i].print_log();
}
}
}
Reference in New Issue View Git Blame Copy Permalink