confmap.c File Reference

(2023-08-28, commit: c9b21e6)

Implementation file related to mapping configuration options and their string representations. More...

#include "confmap.h"
#include <stdlib.h>
#include "common.h"
#include "logio.h"

Include dependency graph for confmap.c:

Functions
static int	crinitCompareConfigMappings (const void *a, const void *b)
const crinitConfigMapping_t *	crinitFindConfigMapping (const crinitConfigMapping_t *map, size_t mapSize, const char *keyStr)

Variables
const crinitConfigMapping_t	crinitTaskCfgMap []
const size_t	crinitTaskCfgMapSize = crinitNumElements(crinitTaskCfgMap)
const crinitConfigMapping_t	crinitSeriesCfgMap []
const size_t	crinitSeriesCfgMapSize = crinitNumElements(crinitSeriesCfgMap)

Detailed Description

Implementation file related to mapping configuration options and their string representations.

Function Documentation

crinitCompareConfigMappings()

static int crinitCompareConfigMappings ( const void *  a, const void *  b  )

static

Comparison function between two crinitConfigMapping_t, for bsearch()

crinitFindConfigMapping()

const crinitConfigMapping_t* crinitFindConfigMapping	(	const crinitConfigMapping_t *	map,
		size_t	mapSize,
		const char *	keyStr
	)

Searches for an entry in an array of crinitConfigMapping_t by crinitConfigMapping_t::configKey.

Uses bsearch() with the assumption that the array is lexicographically ordered by crinitConfigMapping_t::configKey.

Parameters

map	The array of crinitConfigMapping_t to search in.
mapSize	The number of elements in the array to search.
keyStr	The name of the mapping to search for.

Variable Documentation

crinitSeriesCfgMap

const crinitConfigMapping_t crinitSeriesCfgMap[]

Initial value:

= {
    {CRINIT_CONFIG_DEBUG, CRINIT_CONFIG_KEYSTR_DEBUG, false, false, crinitCfgDebugHandler},
    {CRINIT_CONFIG_ELOS_PORT, CRINIT_CONFIG_KEYSTR_ELOS_PORT, false, false, crinitCfgElosPortHandler},
    {CRINIT_CONFIG_ELOS_SERVER, CRINIT_CONFIG_KEYSTR_ELOS_SERVER, false, false, crinitCfgElosServerHandler},
    {CRINIT_CONFIG_ENV_SET, CRINIT_CONFIG_KEYSTR_ENV_SET, true, false, crinitCfgEnvHandler},
    {CRINIT_CONFIG_FILTER_DEFINE, CRINIT_CONFIG_KEYSTR_FILTER_DEFINE, true, false, crinitCfgFilterHandler},
    {CRINIT_CONFIG_INCLUDEDIR, CRINIT_CONFIG_KEYSTR_INCLDIR, false, false, crinitCfgInclDirHandler},
    {CRINIT_CONFIG_INCLUDE_SUFFIX, CRINIT_CONFIG_KEYSTR_INCL_SUFFIX, false, false, crinitCfgInclSuffixHandler},
    {CRINIT_CONFIG_SHDGRACEP, CRINIT_CONFIG_KEYSTR_SHDGRACEP, false, false, crinitCfgShdGpHandler},
    {CRINIT_CONFIG_TASKDIR, CRINIT_CONFIG_KEYSTR_TASKDIR, false, false, crinitCfgTaskDirHandler},
    {CRINIT_CONFIG_TASKDIR_FOLLOW_SYMLINKS, CRINIT_CONFIG_KEYSTR_TASKDIR_SYMLINKS, false, false,
     crinitCfgTaskDirSlHandler},
    {CRINIT_CONFIG_TASKS, CRINIT_CONFIG_KEYSTR_TASKS, true, false, crinitCfgTasksHandler},
    {CRINIT_CONFIG_TASK_FILE_SUFFIX, CRINIT_CONFIG_KEYSTR_TASK_FILE_SUFFIX, false, false, crinitCfgTaskSuffixHandler},
    {CRINIT_CONFIG_USE_ELOS, CRINIT_CONFIG_KEYSTR_USE_ELOS, false, false, crinitCfgElosHandler},
    {CRINIT_CONFIG_USE_SYSLOG, CRINIT_CONFIG_KEYSTR_USE_SYSLOG, false, false, crinitCfgSyslogHandler},
}

Constant (at compile-time) array of mappings between series/global configuration names and their indices and properties.

Must be lexicographically ordered (by crinitConfigMapping_t::configKey), so that crinitFindConfigMapping() works. This is tested by a unit/regression test.

crinitSeriesCfgMapSize

const size_t crinitSeriesCfgMapSize = crinitNumElements(crinitSeriesCfgMap)

Size of crinitSeriesCfgMap, known at compile-time.

crinitTaskCfgMap

const crinitConfigMapping_t crinitTaskCfgMap[]

Initial value:

= {
    {CRINIT_CONFIG_COMMAND, CRINIT_CONFIG_KEYSTR_COMMAND, true, false, crinitCfgCmdHandler},
    {CRINIT_CONFIG_DEPENDS, CRINIT_CONFIG_KEYSTR_DEPENDS, true, true, crinitCfgDepHandler},
    {CRINIT_CONFIG_ENV_SET, CRINIT_CONFIG_KEYSTR_ENV_SET, true, true, crinitCfgEnvHandler},
    {CRINIT_CONFIG_FILTER_DEFINE, CRINIT_CONFIG_KEYSTR_FILTER_DEFINE, true, true, crinitCfgFilterHandler},
    {CRINIT_CONFIG_INCLUDE, CRINIT_CONFIG_KEYSTR_INCLUDE, true, false, crinitTaskIncludeHandler},
    {CRINIT_CONFIG_IOREDIR, CRINIT_CONFIG_KEYSTR_IOREDIR, true, true, crinitCfgIoRedirHandler},
    {CRINIT_CONFIG_NAME, CRINIT_CONFIG_KEYSTR_NAME, false, false, crinitCfgNameHandler},
    {CRINIT_CONFIG_PROVIDES, CRINIT_CONFIG_KEYSTR_PROVIDES, true, false, crinitCfgPrvHandler},
    {CRINIT_CONFIG_RESPAWN, CRINIT_CONFIG_KEYSTR_RESPAWN, false, false, crinitCfgRespHandler},
    {CRINIT_CONFIG_RESPAWN_RETRIES, CRINIT_CONFIG_KEYSTR_RESPAWN_RETRIES, false, false, crinitCfgRespRetHandler},
}

Constant (at compile-time) array of mappings between task-specific configuration names and their indices and properties.

Must be lexicographically ordered (by crinitConfigMapping_t::configKey), so that crinitFindConfigMapping() works. This is tested by a unit/regression test.

crinitTaskCfgMapSize

const size_t crinitTaskCfgMapSize = crinitNumElements(crinitTaskCfgMap)

Size of crinitTaskCfgMap, known at compile-time.