scheduler.h

Go to the documentation of this file.

/*
 SPDX-FileCopyrightText: © 2010, 2011, 2012 Hewlett-Packard Development Company, L.P.
 
 SPDX-License-Identifier: GPL-2.0-only
*/
#ifndef SCHEDULER_H_INCLUDE
#define SCHEDULER_H_INCLUDE
 
/* local includes */
#include <logging.h>
 
/* std library includes */
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdint.h>
 
/* other library includes */
#include <gio/gio.h>
#include <glib.h>
#include <libpq-fe.h>
#include <signal.h>
 
/* fo library includes */
#include <fossconfig.h>
 
#define CHECKOUT_SIZE 100
 
#define AGENT_BINARY "%s/%s/%s/agent/%s"  
#define AGENT_CONF "mods-enabled"         
 
#define SafePQclear(pgres)  if (pgres) {PQclear(pgres); pgres = NULL;}
 
/* ************************************************************************** */
/* *** Scheduler structure ************************************************** */
/* ************************************************************************** */
 
typedef struct
{
    /* information about the scheduler process */
    gchar*   process_name;  
    gboolean s_pid;         
    gboolean s_daemon;      
    gboolean s_startup;     
    gboolean s_pause;       
 
    /* loaded configuration information */
    fo_conf* sysconfig;     
    gchar*   sysconfigdir;  
    gchar*   logdir;        
    gboolean logcmdline;    
    log_t*   main_log;      
 
    /* used exclusively in agent.c */
    GTree*  meta_agents;    
    GTree*  agents;         
 
    /* used exclusively in host.c */
    GTree* host_list;       
    GList* host_queue;      
 
    /* used exclusively in interface.c */
    gboolean      i_created;    
    gboolean      i_terminate;  
    uint16_t      i_port;       
    GThread*      server;       
    GThreadPool*  workers;      
    GCancellable* cancel;       
 
    /* used exclusively in job.c */
    GTree*     job_list;    
    GSequence* job_queue;   
 
    /* used exclusively in database.c */
    PGconn*  db_conn;         
    gchar*   host_url;        
    gchar*   email_subject;   
    gchar*   email_header;    
    gchar*   email_footer;    
    gchar*   email_command;   
    gboolean default_header;  
    gboolean default_footer;  
 
    /* regular expressions */
    GRegex* parse_agent_msg;     
    GRegex* parse_db_email;      
    GRegex* parse_interface_cmd; 
} scheduler_t;
 
scheduler_t* scheduler_init(gchar* sysconfigdir, log_t* log);
void scheduler_destroy(scheduler_t* scheduler);
 
void scheduler_sig_handle(int signo);
void scheduler_signal(scheduler_t* scheduler);
void scheduler_update(scheduler_t* scheduler);
 
void g_tree_clear(GTree* tree);
 
extern int      verbose;
extern int      closing;
extern GThread* main_thread;
 
/* ************************************************************************** */
/* *** CONFIGURATION                                                      *** */
/* ***   There are a set of variables that can be defined in the          *** */
/* ***   Configuration file. These are defined used X-Macros so that      *** */
/* ***   adding a new variable can be accomplished by simply changing     *** */
/* ***   just the CONF_VARIABLE_TYPES Macro.                              *** */
/* ************************************************************************** */
 
#define NOOP(val) val
 
#define CONF_VARIABLES_TYPES(apply)                               \
  apply(uint32_t, fork_backoff_time,     atoi, %d, 5)             \
  apply(uint32_t, agent_death_timer,     atoi, %d, 180)           \
  apply(uint32_t, agent_update_interval, atoi, %d, 120)           \
  apply(uint32_t, agent_update_number,   atoi, %d, 5)             \
  apply(gint,     interface_nthreads,    atoi, %d, 10)
 
#define SELECT_DECLS(type, name, l_op, w_op, val) extern type CONF_##name;
CONF_VARIABLES_TYPES(SELECT_DECLS)
#undef SELECT_DECLS
 
#define MK_STRING_LIT(passed) #passed
 
/* ************************************************************************** */
/* **** Utility Functions *************************************************** */
/* ************************************************************************** */
 
/* glib related functions */
gint string_is_num(gchar* str);
gint string_compare(gconstpointer a, gconstpointer b, gpointer user_data);
gint int_compare(gconstpointer a, gconstpointer b, gpointer user_data);
 
/* ************************************************************************** */
/* **** Scheduler Functions ************************************************* */
/* ************************************************************************** */
 
/* scheduler events */
void scheduler_config_event(scheduler_t* scheduler, void*);
void scheduler_close_event(scheduler_t* scheduler, void*);
void scheduler_test_agents(scheduler_t* scheduler, void*);
 
void scheduler_clear_config(scheduler_t* scheduler);
void scheduler_agent_config(scheduler_t* scheduler);
void scheduler_foss_config(scheduler_t* scheduler);
int  scheduler_daemonize(scheduler_t* scheduler);
 
void set_usr_grp(gchar* process_name, fo_conf* config);
int  kill_scheduler(int force);
 
#endif /* SCHEDULER_H_INCLUDE */