job.h

/*
 SPDX-FileCopyrightText: © 2010-2013 Hewlett-Packard Development Company, L.P.
 SPDX-FileCopyrightText: © 2015 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
#ifndef JOB_H_INCLUDE
#define JOB_H_INCLUDE
 
/* local includes */
#include <logging.h>
 
/* std library includes */
#include <stdio.h>
#include <time.h>
#include <event.h>
#include <libpq-fe.h>
 
/* glib includes */
#include <glib.h>
 
/* ************************************************************************** */
/* **** Data Types ********************************************************** */
/* ************************************************************************** */
 
#define JOB_STATUS_TYPES(apply)                        \
  apply(NOT_AVAILABLE)                                 \
 \
  apply(CHECKEDOUT)                                    \
       \
  apply(STARTED)                                       \
   \
  apply(COMPLETE)                                      \
                               \
  apply(RESTART)                                       \
   \
  apply(FAILED)                                        \
                 \
  apply(PAUSED)
 
#define SELECT_ENUM(passed) JB_##passed,
typedef enum { JOB_STATUS_TYPES(SELECT_ENUM) } job_status;
#undef SELECT_ENUM
 
extern const char* job_status_strings[];
 
typedef struct
{
    /* associated agent information */
    char*  agent_type;      
    char*  required_host;   
    GList* running_agents;  
    GList* finished_agents; 
    GList* failed_agents;   
    log_t*  log;            
 
    /* information for data manipulation */
    job_status status;    
    gchar*     data;      
    gchar     *jq_cmd_args; 
    PGresult*  db_result; 
    GMutex*    lock;      
    uint32_t   idx;       
 
    /* information about job status */
    gchar*   message;   
    int32_t  priority;  
    int32_t  verbose;   
    int32_t  parent_id; 
    int32_t  id;        
    int32_t  user_id;   
    int32_t  group_id;  
    time_t   checkedout_at; 
} job_t;
 
/* ************************************************************************** */
/* **** Constructor Destructor ********************************************** */
/* ************************************************************************** */
 
job_t* job_init(GTree* job_list, GSequence* job_queue, char* type, char* host,
    int id, int parent_id, int user_id, int group_id, int priority, char *jq_cmd_args);
void   job_destroy(job_t* job);
 
/* ************************************************************************** */
/* **** Functions and events ************************************************ */
/* ************************************************************************** */
 
void job_verbose_event (scheduler_t* scheduler, job_t* j);
void job_status_event  (scheduler_t* scheduler, arg_int* params);
void job_pause_event   (scheduler_t* scheduler, arg_int* params);
void job_restart_event (scheduler_t* scheduler, arg_int* params);
void job_priority_event(scheduler_t* scheduler, arg_int* params);
void job_fail_event    (scheduler_t* scheduler, job_t* job);
 
void job_add_agent(job_t* job, void* a);
void job_remove_agent(job_t* job, GTree* job_list, void* a);
void job_finish_agent(job_t* job, void* a);
void job_fail_agent(job_t* job, void* a);
void job_set_data(scheduler_t* scheduler, job_t* job, char* data, int sql);
void job_update(scheduler_t* scheduler, job_t* job);
 
int       job_is_open(scheduler_t* scheduler, job_t* job);
gchar*    job_next(job_t* job);
log_t*    job_log(job_t* job);
 
/* ************************************************************************** */
/* **** Job list Functions ************************************************** */
/* ************************************************************************** */
 
job_t*   next_job(GSequence* job_queue);
job_t*   peek_job(GSequence* job_queue);
uint32_t active_jobs(GTree* job_list);
gint job_compare(gconstpointer a, gconstpointer b, gpointer user_data);
 
#endif /* JOB_H_INCLUDE */