confhdl.c File Reference

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

Implementation of type- and target-specific handler functions for configuration parsing. More...

#include "confhdl.h"
#include <ctype.h>
#include <grp.h>
#include <pwd.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include "common.h"
#include "confconv.h"
#include "globopt.h"
#include "lexers.h"
#include "logio.h"

Include dependency graph for confhdl.c:

Macros
#define	crinitCfgHandlerTypeCheck(t)

Functions
static int	crinitCfgHandlerSetTaskOptFromStr (crinitTaskOpts_t *tgt, crinitTaskOpts_t opt, const char *val)
static void *	crinitCfgHandlerManageArrayMem (void *dynArr, size_t elementSize, size_t curSize, size_t reqSize)
static bool	crinitDirExists (const char *path)
static bool	crinitFileIsExecutable (const char *path)
static bool	crinitUsernameToUid (const char *name, uid_t *uid)
static bool	crinitUidToUsername (uid_t uid, char **name)
static bool	crinitGroupnameToGid (const char *name, gid_t *gid)
static bool	crinitGidToGroupname (gid_t gid, char **name)
int	crinitCfgCmdHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgStopCmdHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgDepHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgPrvHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgEnvHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgFilterHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgIoRedirHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgNameHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgRespHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgRespRetHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitTaskIncludeHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgUserHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgGroupHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgDebugHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgInclSuffixHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgInclDirHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgShdGpHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgTaskSuffixHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgTaskDirHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgTaskDirSlHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgTasksHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgSyslogHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgElosHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgElosServerHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgElosPortHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgElosEventPollIntervalHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgLauncherCmdHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgSigKeyDirHandler (void *tgt, const char *val, crinitConfigType_t type)
int	crinitCfgSignaturesHandler (void *tgt, const char *val, crinitConfigType_t type)

Detailed Description

Implementation of type- and target-specific handler functions for configuration parsing.

Macro Definition Documentation

crinitCfgHandlerTypeCheck

#define crinitCfgHandlerTypeCheck

(

t

)

Value:

    do {                                                                                                  \
        if ((t) != type) {                                                                                \
            crinitErrPrint("This function is not capable of dealing with the configuration type %s", #t); \
            return -1;                                                                                    \
        }                                                                                                 \
    } while (0)

Macro to assert that the given crinitConfigType_t in a crinitConfigHandler_t has a specific value.

Parameters

t	The target value of the parameter type. If unequal to the value given to the encompassing function, the function will print an error and return -1.

Function Documentation

crinitCfgCmdHandler()

int crinitCfgCmdHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for COMMAND config directives. See crinitConfigHandler_t.

crinitCfgDebugHandler()

int crinitCfgDebugHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for DEBUG config directives. See crinitConfigHandler_t.

crinitCfgDepHandler()

int crinitCfgDepHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for DEPENDS config directives. See crinitConfigHandler_t.

crinitCfgElosEventPollIntervalHandler()

int crinitCfgElosEventPollIntervalHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for ELOS_EVENT_POLL_INTERVAL config directive. See crinitConfigHandler_t.

crinitCfgElosHandler()

int crinitCfgElosHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for USE_ELOS config directives. See crinitConfigHandler_t.

crinitCfgElosPortHandler()

int crinitCfgElosPortHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for ELOS_PORT config directives. See crinitConfigHandler_t.

crinitCfgElosServerHandler()

int crinitCfgElosServerHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for ELOS_SERVER config directives. See crinitConfigHandler_t.

crinitCfgEnvHandler()

int crinitCfgEnvHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for ENV_SET config directives. See crinitConfigHandler_t.

crinitCfgFilterHandler()

int crinitCfgFilterHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for FILTER_DEFINE config directives. See crinitConfigHandler_t.

crinitCfgGroupHandler()

int crinitCfgGroupHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for GROUP config directives. See crinitConfigHandler_t

crinitCfgHandlerManageArrayMem()

static void * crinitCfgHandlerManageArrayMem ( void *  dynArr, size_t  elementSize, size_t  curSize, size_t  reqSize  )

inlinestatic

(Re-)allocate memory for generic arrays.

Given current size of an array and required size, the function will allocate/grow the array. Shrinking is unsupported and will lead to an error being returned. Initializes newly allocated memory to 0.

Parameters

dynArr	The array to reallocate or NULL if we want a new array.
elementSize	Size of a single element in the array.
curSize	Current number of elements in the array.
reqSize	Required number of elements in the array.

Returns

The new address of the array on success, NULL on failure.

crinitCfgHandlerSetTaskOptFromStr()

static int crinitCfgHandlerSetTaskOptFromStr ( crinitTaskOpts_t *  tgt, crinitTaskOpts_t  opt, const char *  val  )

inlinestatic

Helper function to set a bitmask value in crinitTask_t::opts.

Parameters

tgt	Direct pointer to the crinitTaskOpts_t inside an crinitTask_t which shall be modified.
opt	Bitmask of the task option to be set, one of CRINIT_TASK_OPT_*
val	The string value indicating if the bit should be set or unset. Uses crinitConfConvToBool().

Returns

0 on success, -1 on error

crinitCfgInclDirHandler()

int crinitCfgInclDirHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for INCLUDEDIR config directives. See crinitConfigHandler_t.

crinitCfgInclSuffixHandler()

int crinitCfgInclSuffixHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for INCLUDE_SUFFIX config directives. See crinitConfigHandler_t.

crinitCfgIoRedirHandler()

int crinitCfgIoRedirHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for IO_REDIRECT config directives. See crinitConfigHandler_t.

crinitCfgLauncherCmdHandler()

int crinitCfgLauncherCmdHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for LAUNCHER_CMD config directive. See crinitConfigHandler_t.

crinitCfgNameHandler()

int crinitCfgNameHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for NAME config directives. See crinitConfigHandler_t.

crinitCfgPrvHandler()

int crinitCfgPrvHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for PROVIDES config directives. See crinitConfigHandler_t.

crinitCfgRespHandler()

int crinitCfgRespHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for RESPAWN config directives. See crinitConfigHandler_t.

crinitCfgRespRetHandler()

int crinitCfgRespRetHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for RESPAWN_RETRIES config directives. See crinitConfigHandler_t.

crinitCfgShdGpHandler()

int crinitCfgShdGpHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for SHUTDOWN_GRACE_PERIOD_US config directives. See crinitConfigHandler_t.

crinitCfgSigKeyDirHandler()

int crinitCfgSigKeyDirHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for crinit.sigkeydir Kernel command line setting. See crinitConfigHandler_t.

crinitCfgSignaturesHandler()

int crinitCfgSignaturesHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for crinit.signatures Kernel command line setting. See crinitConfigHandler_t.

crinitCfgStopCmdHandler()

int crinitCfgStopCmdHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for STOP_COMMAND config directives. See crinitConfigHandler_t.

crinitCfgSyslogHandler()

int crinitCfgSyslogHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for USE_SYSLOG config directives. See crinitConfigHandler_t.

crinitCfgTaskDirHandler()

int crinitCfgTaskDirHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for TASKDIR config directives. See crinitConfigHandler_t.

crinitCfgTaskDirSlHandler()

int crinitCfgTaskDirSlHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for TASKDIR_FOLLOW_SYMLINKS config directives. See crinitConfigHandler_t.

crinitCfgTasksHandler()

int crinitCfgTasksHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for TASKS config directives. See crinitConfigHandler_t.

crinitCfgTaskSuffixHandler()

int crinitCfgTaskSuffixHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for TASK_SUFFIX config directives. See crinitConfigHandler_t.

crinitCfgUserHandler()

int crinitCfgUserHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for USER config directives. See crinitConfigHandler_t

crinitDirExists()

static bool crinitDirExists ( const char *  path )

static

Check if a path exists, is accessible, and a directory.

Uses stat() with S_ISDIR().

Parameters

path	The path to check.

Returns

true if path refers to an accessible directory, false otherwise.

crinitFileIsExecutable()

static bool crinitFileIsExecutable ( const char *  path )

static

Check if a path exists, is accessible, a file and is executable by owner.

Uses stat().

Parameters

path	The path to check.

Returns

true if path refers to an executable file, false otherwise.

crinitGidToGroupname()

static bool crinitGidToGroupname ( gid_t  gid, char **  name  )

static

Check if given GID exists and convert to groupname.

Parameters

gid	GID to query
name	Pointer to result. Caller must free the pointer allocated by the function.

Returns

true if GID could be resolved and converted, false otherwise.

crinitGroupnameToGid()

static bool crinitGroupnameToGid ( const char *  name, gid_t *  gid  )

static

Check if given groupname exists and convert into numeric ID.

Parameters

name	groupname
gid	Pointer to gid_t object

Returns

true if groupname could be resolved, false otherwise.

crinitTaskIncludeHandler()

int crinitTaskIncludeHandler	(	void *	tgt,
		const char *	val,
		crinitConfigType_t	type
	)

Handler for INCLUDE config directives. See crinitConfigHandler_t.

crinitUidToUsername()

static bool crinitUidToUsername ( uid_t  uid, char **  name  )

static

Check if given UID exists and convert to username.

Parameters

uid	UID to query
name	Pointer to result. Caller must free the pointer allocated by the function.

Returns

true if UID could be resolved and converted, false otherwise.

crinitUsernameToUid()

static bool crinitUsernameToUid ( const char *  name, uid_t *  uid  )

static

Check if given username exists and convert into numeric ID.

Parameters

name	Username
uid	Pointer to uid_t object

Returns

true if username could be resolved, false otherwise.