libfossscheduler.h

/* **************************************************************
Copyright (C) 2010 Hewlett-Packard Development Company, L.P.
Copyright (C) 2015 Siemens AG

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

************************************************************** */

#ifndef LIBFOSSSCHEDULER_H_INCLUDE
#define LIBFOSSSCHEDULER_H_INCLUDE

/* local includes */
#include <fossconfig.h>
#include <libfossdbmanager.h>

/* library includes */
#include <stdio.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <sys/file.h>
#include <unistd.h>

/* other libraries */
#include <libpq-fe.h>

#define ALARM_SECS 30


/* ************************************************************************** */
/* **** Data Types ********************************************************** */
/* ************************************************************************** */

enum job_status
{
  RUNNING, 
  KILLED,  
  PAUSED   
};

extern int agent_verbose;

extern fo_conf* sysconfig;
extern char* sysconfigdir;

/*
 * The following macro definitions are meant to act as their own statement in
 * the c language. To accomplish this, they needed to not only be able to be used
 * in the situation of an "if" statement with no body, but also require that
 * they are followed by a ";".
 *
 * To do this the "do {} while(0)" loop is used, the loop will not appear in
 * result flow control since it does not modify the flow of control, but it is
 * a single statement that requires a ";" at the end to be syntactically correct
 */

#define LOG_FATAL(...) { \
            fprintf(stdout, "FATAL %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "\n"); \
            fflush(stdout); }

#define LOG_PQ_FATAL(pg_r, ...) { \
            fprintf(stdout, "FATAL %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "FATAL postgresql error: %s\n", PQresultErrorMessage(pg_r)); \
            fflush(stdout); }

#define LOG_ERROR(...) { \
            fprintf(stdout, "ERROR %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "\n"); \
            fflush(stdout); }

#define LOG_PQ_ERROR(pg_r, ...) { \
            fprintf(stdout, "ERROR %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "ERROR postgresql error: %s\n", PQresultErrorMessage(pg_r)); \
            fflush(stdout); }

#define LOG_WARNING(...) { \
            fprintf(stdout, "WARNING %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "\n"); \
            fflush(stdout); }

#define LOG_DEBUG(...) { \
            fprintf(stdout, "DEBUG %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "\n"); \
            fflush(stdout); }

#define LOG_NOTICE(...) { \
            fprintf(stdout, "NOTICE %s.%d: ", __FILE__, __LINE__); \
            fprintf(stdout, __VA_ARGS__); \
            fprintf(stdout, "\n"); \
            fflush(stdout); }

#define TVERBOSE   agent_verbose              
#define TVERBOSE0 (agent_verbose & (1 << 0))  
#define TVERBOSE1 (agent_verbose & (1 << 1))  
#define TVERBOSE2 (agent_verbose & (1 << 2))  
#define TVERBOSE3 (agent_verbose & (1 << 3))  
#define TVERBOSE4 (agent_verbose & (1 << 4))  
#define TVERBOSE5 (agent_verbose & (1 << 5))  
#define TVERBOSE6 (agent_verbose & (1 << 6))  
#define TVERBOSE7 (agent_verbose & (1 << 7))  


#define LOG_VERBOSE(...)  if(TVERBOSE)  LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE0(...) if(TVERBOSE0) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE1(...) if(TVERBOSE1) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE2(...) if(TVERBOSE2) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE3(...) if(TVERBOSE3) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE4(...) if(TVERBOSE4) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE5(...) if(TVERBOSE5) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE6(...) if(TVERBOSE6) LOG_NOTICE(__VA_ARGS__);
#define LOG_VERBOSE7(...) if(TVERBOSE7) LOG_NOTICE(__VA_ARGS__);

#define SPECIAL_NOKILL (1 << 0)

/* ************************************************************************** */
/* **** Agent api *********************************************************** */
/* ************************************************************************** */

#define NOTIFY_EMAIL(...)         \
    fprintf(stdout, "EMAIL ");    \
    fprintf(stdout, __VA_ARGS__); \
    fprintf(stdout, "\n");        \
    fflush(stdout)

void fo_scheduler_heart(int i);
void fo_scheduler_connect(int* argc, char** argv, PGconn** db_conn);
void fo_scheduler_connect_dbMan(int* argc, char** argv, fo_dbManager** dbManager);
void fo_scheduler_disconnect(int retcode);
char* fo_scheduler_next();

/* ************************************************************************** */
/* **** Accessor Functions ************************************************** */
/* ************************************************************************** */

char* fo_scheduler_current();
int fo_scheduler_userID();
int fo_scheduler_groupID();
int fo_scheduler_jobId();
void fo_scheduler_set_special(int option, int value);
int fo_scheduler_get_special(int option);
char* fo_sysconfig(const char* sectionname, const char* variablename);

#endif /* LIBFOSSSCHEDULER_H_INCLUDE */