elosdep.c File Reference

(/usr/bin/git 2025-03-27, commit: d13a1c2)

Implementation of elos connection. More...

#include "elosdep.h"
#include <netinet/in.h>
#include <pthread.h>
#include <stdlib.h>
#include "common.h"
#include "elos-common.h"
#include "globopt.h"
#include "list.h"
#include "logio.h"
#include "task.h"
#include "taskdb.h"

Include dependency graph for elosdep.c:

Data Structures
struct	crinitElosdepFilterTask_t
struct	crinitElosdepFilter_t
struct	crinitElosEventThread_t

Macros
#define	CRINIT_ELOS_IDENT   "crinit"
	Identification string for crinit logging to syslog.
#define	CRINIT_ELOS_DEPENDENCY   "@elos"
	Elos filter dependency prefix.

Typedefs
typedef struct crinitElosdepFilterTask_t	crinitElosdepFilterTask_t
typedef struct crinitElosdepFilter_t	crinitElosdepFilter_t

Functions
static void	crinitElosdepFilterDestroy (crinitElosdepFilter_t *filter)
static int	crinitElosdepFilterRegister (crinitElosdepFilterTask_t *filterTask, crinitElosdepFilter_t *filter)
static int	crinitElosdepFilterUnregister (crinitElosdepFilterTask_t *filterTask, crinitElosdepFilter_t *filter)
static int	crinitElosdepFilterListClear (crinitElosdepFilterTask_t *filterTask)
static int	crinitElosdepFilterTaskDestroy (crinitElosdepFilterTask_t *filterTask)
static int	crinitElosdepFilterTaskListClear (void)
static int	crinitElosdepFilterFromEnvSet (const crinitTask_t *task, const char *name, crinitElosdepFilter_t **filter)
static int	crinitElosdepFilterSubscribe (crinitElosdepFilter_t *filter)
static int	crinitElosdepFilterListSubscribe (void)
static int	crinitElosdepFilterUnsubscribe (crinitElosdepFilter_t *filter)
static int	crinitElosdepFilterListUnsubscribe (void)
int	crinitElosdepTaskAdded (crinitTask_t *task)
static void *	crinitElosdepEventListener (void *arg)
static int	crinitElosdepInitThreadContext (crinitTaskDB_t *taskDb, struct crinitElosEventThread_t *tinfo)
int	crinitElosdepActivate (crinitTaskDB_t *taskDb, bool e)

Variables
static bool	crinitElosActivated = false
	Indicates if the elos connection and handler thread has been set up.
static pthread_mutex_t	crinitElosActivatedLock = PTHREAD_MUTEX_INITIALIZER
	Mutex to guard crinitElosActivated.
static struct crinitElosEventThread_t	crinitTinfo
static crinitList_t	crinitFilterTasks = CRINIT_LIST_INIT(crinitFilterTasks)
static pthread_mutex_t	crinitElosdepFilterTaskLock = PTHREAD_MUTEX_INITIALIZER
static pthread_mutex_t	crinitElosdepSessionLock = PTHREAD_MUTEX_INITIALIZER

Detailed Description

Implementation of elos connection.

Macro Definition Documentation

CRINIT_ELOS_DEPENDENCY

#define CRINIT_ELOS_DEPENDENCY   "@elos"

Elos filter dependency prefix.

CRINIT_ELOS_IDENT

#define CRINIT_ELOS_IDENT   "crinit"

Identification string for crinit logging to syslog.

Typedef Documentation

crinitElosdepFilter_t

typedef struct crinitElosdepFilter_t crinitElosdepFilter_t

Definition of a single filter related to a task.

crinitElosdepFilterTask_t

typedef struct crinitElosdepFilterTask_t crinitElosdepFilterTask_t

Task that has unfulfilled filter dependencies.

Function Documentation

crinitElosdepActivate()

int crinitElosdepActivate	(	struct crinitTaskDB_t *	taskDb,
		bool	e
	)

Specify if Elos should be used.

By default, Crinit will not connect to elos. If this is set to true, however, Crinit will connect to the elos daemon.

Parameters

taskDb	Task database to be informed if event occurs.
e	true if elos should be used, false otherwise.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepEventListener()

static void * crinitElosdepEventListener ( void *  arg )

static

crinitElosdepFilterDestroy()

static void crinitElosdepFilterDestroy ( crinitElosdepFilter_t *  filter )

static

Frees the heap allocated members of the filter.

Parameters

filter

Filter to be destroyed.

crinitElosdepFilterFromEnvSet()

static int crinitElosdepFilterFromEnvSet ( const crinitTask_t *  task, const char *  name, crinitElosdepFilter_t **  filter  )

static

Create and register a new elos event filter handle from a given environment set.

Parameters

task	Task to create elos filter for.
name	Name of the filter to register.
filter	Pointer to the created filter.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterListClear()

static int crinitElosdepFilterListClear ( crinitElosdepFilterTask_t *  filterTask )

static

Free the complete list of subscribed filters.

Parameters

filterTask

The task owning this filter list.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterListSubscribe()

static int crinitElosdepFilterListSubscribe ( void  )

static

Subscribes all filters currently registered with elosdep.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterListUnsubscribe()

static int crinitElosdepFilterListUnsubscribe ( void  )

static

Extracts all filter defines for each task and creates a local elos filter handle, which will be used to subscribe for this filter.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterRegister()

static int crinitElosdepFilterRegister ( crinitElosdepFilterTask_t *  filterTask, crinitElosdepFilter_t *  filter  )

static

Inserts an elos filter into the list of filter subscriptions.

Parameters

filterTask	Task to register the filter for.
filter	Filter to be registered.

Returns

Returns 0 if the filter has been inserted, -1 otherwise.

crinitElosdepFilterSubscribe()

static int crinitElosdepFilterSubscribe ( crinitElosdepFilter_t *  filter )

inlinestatic

Subscribes the filter with elos.

Parameters

filter

The filter to subscribe.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterTaskDestroy()

static int crinitElosdepFilterTaskDestroy ( crinitElosdepFilterTask_t *  filterTask )

static

Frees the heap allocated members of the filter task.

Parameters

filterTask

Filter task to be destroyed.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterTaskListClear()

static int crinitElosdepFilterTaskListClear ( void  )

static

Free the complete list of filter tasks.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterUnregister()

static int crinitElosdepFilterUnregister ( crinitElosdepFilterTask_t *  filterTask, crinitElosdepFilter_t *  filter  )

static

Removes the given filter from the filter list.

Parameters

filterTask	Task to remove the filter from.
filter	Filter to be destroyed.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepFilterUnsubscribe()

static int crinitElosdepFilterUnsubscribe ( crinitElosdepFilter_t *  filter )

inlinestatic

Unsubscribes the filter from elos.

Parameters

filter

The filter to unsubscribe.

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepInitThreadContext()

static int crinitElosdepInitThreadContext ( crinitTaskDB_t *  taskDb, struct crinitElosEventThread_t *  tinfo  )

static

Initializes the vtable managed within the elosdep thread context.

Parameters

taskDb	Pointer to the crinit task database
tinfo	Elosdep thread context

Returns

Returns 0 on success, -1 otherwise.

crinitElosdepTaskAdded()

int crinitElosdepTaskAdded

(

struct crinitTask_t *

task

)

Hook which will be invoked if a new task has been added and will register the elos filters for this task.

Parameters

task	Task that has been added to elos.

Returns

Returns 0 on success, -1 otherwise.

Variable Documentation

crinitElosActivated

bool crinitElosActivated = false

static

Indicates if the elos connection and handler thread has been set up.

crinitElosActivatedLock

pthread_mutex_t crinitElosActivatedLock = PTHREAD_MUTEX_INITIALIZER

static

Mutex to guard crinitElosActivated.

crinitElosdepFilterTaskLock

pthread_mutex_t crinitElosdepFilterTaskLock = PTHREAD_MUTEX_INITIALIZER

static

Mutex synchronizing elos filter task registration

crinitElosdepSessionLock

pthread_mutex_t crinitElosdepSessionLock = PTHREAD_MUTEX_INITIALIZER

static

Mutex synchronizing elos connection

crinitFilterTasks

crinitList_t crinitFilterTasks = CRINIT_LIST_INIT(crinitFilterTasks)

static

List of tasks with elos filter dependencies

crinitTinfo

struct crinitElosEventThread_t crinitTinfo

static