task.h

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
#ifndef __TASK_H__
#define __TASK_H__
 
#include <stdint.h>
#include <sys/types.h>
#include <time.h>
 
#include "confparse.h"
#include "crinit-sdefs.h"
#include "envset.h"
#include "ioredir.h"
 
#ifdef ENABLE_CGROUP
#include "cgroup.h"
#endif
 
typedef unsigned long crinitTaskOpts_t;
#define CRINIT_TASK_OPT_RESPAWN (1 << 0)
#define CRINIT_TASK_OPT_RESPAWN_DEFAULT false
#define CRINIT_TASK_OPT_TRIGGER_REARM (1 << 1)
#define CRINIT_TASK_OPT_TRIGGER_REARM_DEFAULT false
 
#define CRINIT_TASK_EVENT_RUNNING "spawn"
#define CRINIT_TASK_EVENT_DONE "wait"
#define CRINIT_TASK_EVENT_FAILED "fail"
#define CRINIT_TASK_EVENT_NOTIFY_SUFFIX "-notified"
 
typedef enum crinitTaskType {
    CRINIT_TASK_TYPE_STANDARD,  
    CRINIT_TASK_TYPE_INCLUDE    
} crinitTaskType_t;
 
typedef enum crinitTaskTimestampType {
    CRINIT_TASK_TS_CREATION,  
    CRINIT_TASK_TS_START,     
    CRINIT_TASK_TS_END        
} crinitTaskTimestampType_t;
 
typedef struct crinitTaskCmd {
    int argc;     
    char **argv;  
} crinitTaskCmd_t;
 
typedef struct crinitTaskDep {
    char *name;   
    char *event;  
} crinitTaskDep_t;
 
typedef struct crinitTaskPrv {
    char *name;                  
    crinitTaskState_t stateReq;  
} crinitTaskPrv_t;
 
typedef struct crinitTask {
    char *name;                  
    crinitTaskCmd_t *cmds;       
    size_t cmdsSize;             
    crinitTaskCmd_t *stopCmds;   
    size_t stopCmdsSize;         
    crinitEnvSet_t taskEnv;      
    crinitEnvSet_t elosFilters;  
    crinitTaskDep_t *deps;       
    size_t depsSize;             
    crinitTaskDep_t *trig;       
    size_t trigSize;             
    bool triggered;              
    crinitTaskPrv_t *prv;        
    size_t prvSize;              
    crinitTaskOpts_t opts;       
    crinitTaskState_t state;     
    pid_t pid;                   
    crinitIoRedir_t *redirs;     
    size_t redirsSize;           
    int maxRetries;              
    int failCount;               
    bool inhibitRespawn;         
    struct timespec createTime;  
    struct timespec startTime;   
    struct timespec endTime;     
    uid_t user;                  
    gid_t group;                 
    gid_t *supGroups;            
    size_t supGroupsSize;        
    char *username;              
    char *groupname;             
#ifdef ENABLE_CAPABILITIES
    uint64_t capabilitiesSet;    
    uint64_t capabilitiesClear;  
#endif
#ifdef ENABLE_CGROUP
    crinitCgroup_t *cgroup;  
#endif
} crinitTask_t;
 
#define crinitTaskForEachDep(task, dep) for ((dep) = (task)->deps; (dep) != (task)->deps + (task)->depsSize; (dep)++)
 
#define crinitTaskForEachTrig(task, trg) for ((trg) = (task)->trig; (trg) != (task)->trig + (task)->trigSize; (trg)++)
 
int crinitTaskCreateFromConfKvList(crinitTask_t **out, const crinitConfKvList_t *in);
 
void crinitFreeTask(crinitTask_t *t);
 
void crinitDestroyTask(crinitTask_t *t);
 
int crinitTaskDup(crinitTask_t **out, const crinitTask_t *orig);
 
int crinitTaskCopy(crinitTask_t *out, const crinitTask_t *orig);
 
int crinitTaskMergeInclude(crinitTask_t *tgt, const char *src, char *importList);
 
#endif /* __TASK_H__ */