boinc/sched/sched_util.C

// The contents of this file are subject to the BOINC Public License
// Version 1.0 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://boinc.berkeley.edu/license_1.0.txt
// 
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
// License for the specific language governing rights and limitations
// under the License. 
// 
// The Original Code is the Berkeley Open Infrastructure for Network Computing. 
// 
// The Initial Developer of the Original Code is the SETI@home project.
// Portions created by the SETI@home project are Copyright (C) 2002
// University of California at Berkeley. All Rights Reserved. 
// 
// Contributor(s):
//

using namespace std;

#include <strings.h>
#include <csignal>
#include <cstdarg>
#include <unistd.h>

#include "parse.h"
#include "util.h"
#include "main.h"
#include "sched_util.h"
#include "server_types.h"

int debug_level = 0;

inline const char* msg_level_dscription(int msg_level)
{
    switch (msg_level) {
    case MSG_CRITICAL: return "CRITICAL";
    case MSG_NORMAL:   return "NORMAL";
    case MSG_DEBUG:    return "DEBUG";
    default:           return "*** internal error; unknown msg_level ***";
    }
}

void write_log(int msg_level, const char* p, ...) {
    if (debug_level < msg_level) return;
    if (p == NULL) return;

    va_list     ap;
    va_start(ap, p);
    fprintf(stderr, "%s [%s]: ", timestamp(), msg_level_dscription(msg_level));
    vfprintf(stderr, p, ap);
    va_end(ap);
}

void write_log_line(int msg_level, const char* p, ...) {
    if (debug_level < msg_level) return;
    if (p == NULL) return;

    va_list     ap;
    va_start(ap, p);
    fprintf(stderr, "%s [%s]: ", timestamp(), msg_level_dscription(msg_level));
    vfprintf(stderr, p, ap);
    fprintf(stderr, "\n");
    va_end(ap);
}

// break a multi-line string into lines (so that we show prefix on each line)
void write_log_multiline(int msg_level, const char* p) {
    if (debug_level < msg_level) return;
    if (p == NULL) return;

    string line;
    while (*p) {
        if (*p == '\n') {
            write_log(msg_level, "   %s\n", line.c_str());
            line.erase();
        } else {
            line += *p;
        }
        ++p;
    }
    if (!line.empty()) {
        write_log(msg_level, "  %s\n", line.c_str());
    }
}

void write_pid_file(const char* filename)
{
    FILE* fpid = fopen(filename, "w");
    if (!fpid) {
        write_log(MSG_NORMAL, "Couldn't write pid\n");
        return;
    }
    fprintf(fpid, "%d\n", getpid());
    fclose(fpid);
}

void set_debug_level(int new_level) {
    debug_level = new_level;
}

// sig_int will be set to true if SIGINT is caught.
bool sig_int = false;
static void sigint_handler(int)
{
    fprintf(stderr, "SIGINT\n");
    sig_int = true;
}

void install_sigint_handler()
{
    signal(SIGINT, sigint_handler);
    // SIGINT is now default again so hitting ^C again will kill the program.
}

void check_stop_trigger() {
    if (sig_int) {
        write_log(MSG_CRITICAL, "Quitting due to SIGINT\n");
        exit(0);
    }
    FILE* f = fopen(STOP_TRIGGER_FILENAME, "r");
    if (f) {
        write_log(MSG_NORMAL, "Quitting due to stop trigger\n");
        exit(0);
    }
}


// update an exponential average of credit per second.
//
void update_average(double credit_assigned_time, double credit, double& avg, double& avg_time) {
    time_t now = time(0);

    // decrease existing average according to how long it's been
    // since it was computed
    //
    if (avg_time) {
        double deltat = now - avg_time;
        avg *= exp(-deltat*ALPHA);
    }
    if (credit_assigned_time) {
        double deltat = now - credit_assigned_time;
        // Add (credit)/(number of days to return result) to credit, which
        // is the average number of cobblestones per day
        avg += credit/(deltat/86400);
    }
    avg_time = now;
}