step: imtcp moved to new config interface

as far as we know that new interface right now ;)

19 files changed, 273 insertions, 138 deletions

diff --git a/plugins/im3195/im3195.c b/plugins/im3195/im3195.c
index 89dffacd..1daad3dd 100644
--- a/plugins/im3195/im3195.c
+++ b/plugins/im3195/im3195.c
@@ -59,9 +59,9 @@ DEFobjCurrIf(errmsg)
 
 /* configuration settings */
 
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static int listenPort = 601;
 
diff --git a/plugins/imdiag/imdiag.c b/plugins/imdiag/imdiag.c
index 2595b903..57fa08e5 100644
--- a/plugins/imdiag/imdiag.c
+++ b/plugins/imdiag/imdiag.c
@@ -78,9 +78,9 @@ static prop_t *pRcvIPDummy = NULL;
 
 
 /* config settings */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static int iTCPSessMax = 20; /* max number of sessions */
 static int iStrmDrvrMode = 0; /* mode for stream driver, driver-dependent (0 mostly means plain tcp) */
diff --git a/plugins/imfile/imfile.c b/plugins/imfile/imfile.c
index f3aff1bb..321abbda 100644
--- a/plugins/imfile/imfile.c
+++ b/plugins/imfile/imfile.c
@@ -83,9 +83,9 @@ typedef struct fileInfo_s {
 static rsRetVal persistStrmState(fileInfo_t *pInfo);
 
 /* config variables */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static uchar *pszFileName = NULL;
 static uchar *pszFileTag = NULL;
diff --git a/plugins/imgssapi/imgssapi.c b/plugins/imgssapi/imgssapi.c
index 4d790cb0..5f69a0b6 100644
--- a/plugins/imgssapi/imgssapi.c
+++ b/plugins/imgssapi/imgssapi.c
@@ -104,9 +104,9 @@ typedef struct gss_sess_s {
 
 
 /* config variables */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static int iTCPSessMax = 200; /* max number of sessions */
 static char *gss_listen_service_name = NULL;
diff --git a/plugins/imklog/imklog.c b/plugins/imklog/imklog.c
index 05365588..425dec7f 100644
--- a/plugins/imklog/imklog.c
+++ b/plugins/imklog/imklog.c
@@ -68,9 +68,9 @@ DEFobjCurrIf(prop)
 
 /* configuration settings */
 
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 int dbgPrintSymbols = 0; /* this one is extern so the helpers can access it! */
 int symbols_twice = 0;
diff --git a/plugins/immark/immark.c b/plugins/immark/immark.c
index ae793e80..a3c0981b 100644
--- a/plugins/immark/immark.c
+++ b/plugins/immark/immark.c
@@ -57,9 +57,9 @@ DEFobjCurrIf(glbl)
 DEFobjCurrIf(errmsg)
 
 static int iMarkMessagePeriod = DEFAULT_MARK_PERIOD;
-typedef struct {
+struct modConfData_s {
 	int iMarkMessagePeriod;
-} modConfData_t;
+};
 
 BEGINisCompatibleWithFeature
 CODESTARTisCompatibleWithFeature
diff --git a/plugins/impstats/impstats.c b/plugins/impstats/impstats.c
index 139652c1..59d62d18 100644
--- a/plugins/impstats/impstats.c
+++ b/plugins/impstats/impstats.c
@@ -69,9 +69,9 @@ typedef struct configSettings_s {
 	int iSeverity;
 } configSettings_t;
 
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 
 static configSettings_t cs;
diff --git a/plugins/imptcp/imptcp.c b/plugins/imptcp/imptcp.c
index 31f6fbc6..82e64576 100644
--- a/plugins/imptcp/imptcp.c
+++ b/plugins/imptcp/imptcp.c
@@ -198,9 +198,9 @@ static int iMaxLine; /* maximum size of a single message */
 static rsRetVal resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal);
 static rsRetVal addLstn(ptcpsrv_t *pSrv, int sock);
 
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 
 
diff --git a/plugins/imrelp/imrelp.c b/plugins/imrelp/imrelp.c
index 39c90849..414c5995 100644
--- a/plugins/imrelp/imrelp.c
+++ b/plugins/imrelp/imrelp.c
@@ -60,9 +60,9 @@ static prop_t *pInputName = NULL;	/* there is only one global inputName for all
 
 
 /* config settings */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static int iTCPSessMax = 200; /* max number of sessions */
 
diff --git a/plugins/imsolaris/imsolaris.c b/plugins/imsolaris/imsolaris.c
index b9701076..05827a18 100644
--- a/plugins/imsolaris/imsolaris.c
+++ b/plugins/imsolaris/imsolaris.c
@@ -99,9 +99,9 @@ DEFobjCurrIf(prop)
 
 
 /* config settings */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 static prop_t *pInputName = NULL;	/* our inputName currently is always "imuxsock", and this will hold it */
 static char *LogName = NULL;	/* the log socket name TODO: make configurable! */
diff --git a/plugins/imtcp/imtcp.c b/plugins/imtcp/imtcp.c
index b034ebe9..67fa1557 100644
--- a/plugins/imtcp/imtcp.c
+++ b/plugins/imtcp/imtcp.c
@@ -76,28 +76,53 @@ DEFobjCurrIf(netstrm)
 DEFobjCurrIf(errmsg)
 DEFobjCurrIf(ruleset)
 
+static rsRetVal resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal);
+
 /* Module static data */
 static tcpsrv_t *pOurTcpsrv = NULL;  /* our TCP server(listener) TODO: change for multiple instances */
 static permittedPeers_t *pPermPeersRoot = NULL;
 
 
 /* config settings */
-
-typedef struct {
-	EMPTY_STRUCT;
-} modConfData_t;
-
-static int iTCPSessMax = 200; /* max number of sessions */
-static int iTCPLstnMax = 20; /* max number of sessions */
-static int iStrmDrvrMode = 0; /* mode for stream driver, driver-dependent (0 mostly means plain tcp) */
-static int bEmitMsgOnClose = 0; /* emit an informational message on close by remote peer */
-static int iAddtlFrameDelim = TCPSRV_NO_ADDTL_DELIMITER; /* addtl frame delimiter, e.g. for netscreen, default none */
-static int bDisableLFDelim = 0; /* disbale standard LF delimiter */
-static int bUseFlowControl = 1; /* use flow control, what means indicate ourselfs a "light delayable" */
-static uchar *pszStrmDrvrAuthMode = NULL; /* authentication mode to use */
-static uchar *pszInputName = NULL; /* value for inputname property, NULL is OK and handled by core engine */
-static ruleset_t *pBindRuleset = NULL; /* ruleset to bind listener to (use system default if unspecified) */
-
+static struct configSettings_s {
+	int iTCPSessMax;
+	int iTCPLstnMax;
+	int iStrmDrvrMode;
+	int bEmitMsgOnClose;
+	int iAddtlFrameDelim;
+	int bDisableLFDelim;
+	int bUseFlowControl;
+	uchar *pszStrmDrvrAuthMode;
+	uchar *pszInputName;
+	uchar *pszBindRuleset;
+} cs;
+
+struct instanceConf_s {
+	uchar *pszBindPort;		/* port to bind to */
+	uchar *pszBindRuleset;		/* name of ruleset to bind to */
+	ruleset_t *pBindRuleset;	/* ruleset to bind listener to (use system default if unspecified) */
+	uchar *pszInputName;		/* value for inputname property, NULL is OK and handled by core engine */
+	struct instanceConf_s *next;
+};
+
+
+struct modConfData_s {
+	rsconf_t *pConf;		/* our overall config object */
+	instanceConf_t *root, *tail;
+	int iTCPSessMax; /* max number of sessions */
+	int iTCPLstnMax; /* max number of sessions */
+	int iStrmDrvrMode; /* mode for stream driver, driver-dependent (0 mostly means plain tcp) */
+	int bEmitMsgOnClose; /* emit an informational message on close by remote peer */
+	int iAddtlFrameDelim; /* addtl frame delimiter, e.g. for netscreen, default none */
+	int bDisableLFDelim; /* disable standard LF delimiter */
+	int bUseFlowControl; /* use flow control, what means indicate ourselfs a "light delayable" */
+	uchar *pszStrmDrvrAuthMode; /* authentication mode to use */
+};
+
+static modConfData_t *loadModConf = NULL;/* modConf ptr to use for the current load process */
+static modConfData_t *runModConf = NULL;/* modConf ptr to use for the current load process */
+
+#include "im-helper.h" /* must be included AFTER the type definitions! */
 
 /* callbacks */
 /* this shall go into a specific ACL module! */
@@ -170,48 +195,70 @@ finalize_it:
 }
 
 
-/* accept a new ruleset to bind. Checks if it exists and complains, if not */
-static rsRetVal setRuleset(void __attribute__((unused)) *pVal, uchar *pszName)
+/* This function is called when a new listener instace shall be added to 
+ * the current config object via the legacy config system. It just shuffles
+ * all parameters to the listener in-memory instance.
+ * rgerhards, 2011-05-04
+ */
+static rsRetVal addInstance(void __attribute__((unused)) *pVal, uchar *pNewVal)
 {
-	ruleset_t *pRuleset;
-	rsRetVal localRet;
+	instanceConf_t *inst;
 	DEFiRet;
 
-	localRet = ruleset.GetRuleset(ourConf, &pRuleset, pszName);
-	if(localRet == RS_RET_NOT_FOUND) {
-		errmsg.LogError(0, RS_RET_RULESET_NOT_FOUND, "error: ruleset '%s' not found - ignored", pszName);
+	CHKmalloc(inst = MALLOC(sizeof(instanceConf_t)));
+
+	CHKmalloc(inst->pszBindPort = ustrdup((pNewVal == NULL || *pNewVal == '\0')
+				 	       ? (uchar*) "10514" : pNewVal));
+	if((cs.pszBindRuleset == NULL) || (cs.pszBindRuleset[0] == '\0')) {
+		inst->pszBindRuleset = NULL;
+	} else {
+		CHKmalloc(inst->pszBindRuleset = ustrdup(cs.pszBindRuleset));
+	}
+	if((cs.pszInputName == NULL) || (cs.pszInputName[0] == '\0')) {
+		inst->pszInputName = NULL;
+	} else {
+		CHKmalloc(inst->pszInputName = ustrdup(cs.pszInputName));
+	}
+	inst->next = NULL;
+
+	/* node created, let's add to config */
+	if(loadModConf->tail == NULL) {
+		loadModConf->tail = loadModConf->root = inst;
+	} else {
+		loadModConf->tail->next = inst;
+		loadModConf->tail = inst;
 	}
-	CHKiRet(localRet);
-	pBindRuleset = pRuleset;
-	DBGPRINTF("imtcp current bind ruleset %p: '%s'\n", pRuleset, pszName);
 
 finalize_it:
-	free(pszName); /* no longer needed */
+	free(pNewVal);
 	RETiRet;
 }
 
 
-static rsRetVal addTCPListener(void __attribute__((unused)) *pVal, uchar *pNewVal)
+static rsRetVal
+addListner(modConfData_t *modConf, instanceConf_t *inst)
 {
 	DEFiRet;
 
 	if(pOurTcpsrv == NULL) {
 		CHKiRet(tcpsrv.Construct(&pOurTcpsrv));
-		CHKiRet(tcpsrv.SetSessMax(pOurTcpsrv, iTCPSessMax));
-		CHKiRet(tcpsrv.SetLstnMax(pOurTcpsrv, iTCPLstnMax));
+		/* callbacks */
 		CHKiRet(tcpsrv.SetCBIsPermittedHost(pOurTcpsrv, isPermittedHost));
 		CHKiRet(tcpsrv.SetCBRcvData(pOurTcpsrv, doRcvData));
 		CHKiRet(tcpsrv.SetCBOpenLstnSocks(pOurTcpsrv, doOpenLstnSocks));
 		CHKiRet(tcpsrv.SetCBOnRegularClose(pOurTcpsrv, onRegularClose));
 		CHKiRet(tcpsrv.SetCBOnErrClose(pOurTcpsrv, onErrClose));
-		CHKiRet(tcpsrv.SetDrvrMode(pOurTcpsrv, iStrmDrvrMode));
-		CHKiRet(tcpsrv.SetUseFlowControl(pOurTcpsrv, bUseFlowControl));
-		CHKiRet(tcpsrv.SetAddtlFrameDelim(pOurTcpsrv, iAddtlFrameDelim));
-		CHKiRet(tcpsrv.SetbDisableLFDelim(pOurTcpsrv, bDisableLFDelim));
-		CHKiRet(tcpsrv.SetNotificationOnRemoteClose(pOurTcpsrv, bEmitMsgOnClose));
+		/* params */
+		CHKiRet(tcpsrv.SetSessMax(pOurTcpsrv, modConf->iTCPSessMax));
+		CHKiRet(tcpsrv.SetLstnMax(pOurTcpsrv, modConf->iTCPLstnMax));
+		CHKiRet(tcpsrv.SetDrvrMode(pOurTcpsrv, modConf->iStrmDrvrMode));
+		CHKiRet(tcpsrv.SetUseFlowControl(pOurTcpsrv, modConf->bUseFlowControl));
+		CHKiRet(tcpsrv.SetAddtlFrameDelim(pOurTcpsrv, modConf->iAddtlFrameDelim));
+		CHKiRet(tcpsrv.SetbDisableLFDelim(pOurTcpsrv, modConf->bDisableLFDelim));
+		CHKiRet(tcpsrv.SetNotificationOnRemoteClose(pOurTcpsrv, modConf->bEmitMsgOnClose));
 		/* now set optional params, but only if they were actually configured */
-		if(pszStrmDrvrAuthMode != NULL) {
-			CHKiRet(tcpsrv.SetDrvrAuthMode(pOurTcpsrv, pszStrmDrvrAuthMode));
+		if(modConf->pszStrmDrvrAuthMode != NULL) {
+			CHKiRet(tcpsrv.SetDrvrAuthMode(pOurTcpsrv, modConf->pszStrmDrvrAuthMode));
 		}
 		if(pPermPeersRoot != NULL) {
 			CHKiRet(tcpsrv.SetDrvrPermPeers(pOurTcpsrv, pPermPeersRoot));
@@ -219,16 +266,14 @@ static rsRetVal addTCPListener(void __attribute__((unused)) *pVal, uchar *pNewVa
 	}
 
 	/* initialized, now add socket and listener params */
-	CHKiRet(tcpsrv.SetRuleset(pOurTcpsrv, pBindRuleset));
-	CHKiRet(tcpsrv.SetInputName(pOurTcpsrv, pszInputName == NULL ?
-						UCHAR_CONSTANT("imtcp") : pszInputName));
-	tcpsrv.configureTCPListen(pOurTcpsrv, pNewVal);
+	CHKiRet(tcpsrv.SetRuleset(pOurTcpsrv, inst->pBindRuleset));
+	CHKiRet(tcpsrv.SetInputName(pOurTcpsrv, inst->pszInputName == NULL ?
+						UCHAR_CONSTANT("imtcp") : inst->pszInputName));
+	tcpsrv.configureTCPListen(pOurTcpsrv, inst->pszBindPort);
 
 finalize_it:
 	if(iRet != RS_RET_OK) {
-		errmsg.LogError(0, NO_ERRCODE, "error %d trying to add listener", iRet);
-		if(pOurTcpsrv != NULL)
-			tcpsrv.Destruct(&pOurTcpsrv);
+		errmsg.LogError(0, NO_ERRCODE, "imtcp: error %d trying to add listener", iRet);
 	}
 	RETiRet;
 }
@@ -236,21 +281,64 @@ finalize_it:
 
 BEGINbeginCnfLoad
 CODESTARTbeginCnfLoad
+	loadModConf = pModConf;
+	pModConf->pConf = pConf;
+	/* init legacy config variables */
+	cs.pszStrmDrvrAuthMode = NULL;
+	resetConfigVariables(NULL, NULL); /* dummy parameters just to fulfill interface def */
 ENDbeginCnfLoad
 
 
 BEGINendCnfLoad
 CODESTARTendCnfLoad
+	/* persist module-specific settings from legacy config system */
+	pModConf->iTCPSessMax = cs.iTCPSessMax;
+	pModConf->iTCPLstnMax = cs.iTCPLstnMax;
+	pModConf->iStrmDrvrMode = cs.iStrmDrvrMode;
+	pModConf->bEmitMsgOnClose = cs.bEmitMsgOnClose;
+	pModConf->iAddtlFrameDelim = cs.iAddtlFrameDelim;
+	pModConf->bDisableLFDelim = cs.bDisableLFDelim;
+	pModConf->bUseFlowControl = cs.bUseFlowControl;
+	if((cs.pszStrmDrvrAuthMode == NULL) || (cs.pszStrmDrvrAuthMode[0] == '\0')) {
+		loadModConf->pszStrmDrvrAuthMode = NULL;
+		free(cs.pszStrmDrvrAuthMode);
+	} else {
+		loadModConf->pszStrmDrvrAuthMode = cs.pszStrmDrvrAuthMode;
+	}
+	cs.pszStrmDrvrAuthMode = NULL;
+
+	loadModConf = NULL; /* done loading */
 ENDendCnfLoad
 
 
+/* function to generate error message if framework does not find requested ruleset */
+static inline void
+std_checkRuleset_genErrMsg(__attribute__((unused)) modConfData_t *modConf, instanceConf_t *inst)
+{
+	errmsg.LogError(0, NO_ERRCODE, "imtcp: ruleset '%s' for port %s not found - "
+			"using default ruleset instead", inst->pszBindRuleset,
+			inst->pszBindPort);
+}
+
 BEGINcheckCnf
+	instanceConf_t *inst;
 CODESTARTcheckCnf
+	for(inst = pModConf->root ; inst != NULL ; inst = inst->next) {
+		std_checkRuleset(pModConf, inst);
+	}
 ENDcheckCnf
 
 
 BEGINactivateCnf
+	instanceConf_t *inst;
 CODESTARTactivateCnf
+	runModConf = pModConf;
+	for(inst = runModConf->root ; inst != NULL ; inst = inst->next) {
+		addListner(pModConf, inst);
+	}
+	if(pOurTcpsrv == NULL)
+		ABORT_FINALIZE(RS_RET_NO_RUN);
+finalize_it:
 ENDactivateCnf
 
 
@@ -274,11 +362,7 @@ ENDrunInput
 /* initialize and return if will run or not */
 BEGINwillRun
 CODESTARTwillRun
-	/* first apply some config settings */
 	net.PrintAllowedSenders(2); /* TCP */
-	if(pOurTcpsrv == NULL)
-		ABORT_FINALIZE(RS_RET_NO_RUN);
-finalize_it:
 ENDwillRun
 
 
@@ -318,17 +402,17 @@ ENDmodExit
 static rsRetVal
 resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal)
 {
-	iTCPSessMax = 200;
-	iTCPLstnMax = 20;
-	iStrmDrvrMode = 0;
-	bUseFlowControl = 0;
-	bEmitMsgOnClose = 0;
-	iAddtlFrameDelim = TCPSRV_NO_ADDTL_DELIMITER;
-	bDisableLFDelim = 0;
-	free(pszInputName);
-	pszInputName = NULL;
-	free(pszStrmDrvrAuthMode);
-	pszStrmDrvrAuthMode = NULL;
+	cs.iTCPSessMax = 200;
+	cs.iTCPLstnMax = 20;
+	cs.iStrmDrvrMode = 0;
+	cs.bUseFlowControl = 0;
+	cs.bEmitMsgOnClose = 0;
+	cs.iAddtlFrameDelim = TCPSRV_NO_ADDTL_DELIMITER;
+	cs.bDisableLFDelim = 0;
+	free(cs.pszInputName);
+	cs.pszInputName = NULL;
+	free(cs.pszStrmDrvrAuthMode);
+	cs.pszStrmDrvrAuthMode = NULL;
 	return RS_RET_OK;
 }
 
@@ -356,31 +440,31 @@ CODEmodInit_QueryRegCFSLineHdlr
 
 	/* register config file handlers */
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverrun"), 0, eCmdHdlrGetWord,
-				   addTCPListener, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   addInstance, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpmaxsessions"), 0, eCmdHdlrInt,
-				   NULL, &iTCPSessMax, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   NULL, &cs.iTCPSessMax, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpmaxlisteners"), 0, eCmdHdlrInt,
-				   NULL, &iTCPLstnMax, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpservernotifyonconnectionclose"), 0,
-				   eCmdHdlrBinary, NULL, &bEmitMsgOnClose, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdrivermode"), 0,
-				   eCmdHdlrInt, NULL, &iStrmDrvrMode, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdriverauthmode"), 0,
-				   eCmdHdlrGetWord, NULL, &pszStrmDrvrAuthMode, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdriverpermittedpeer"), 0,
-				   eCmdHdlrGetWord, setPermittedPeer, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   NULL, &cs.iTCPLstnMax, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpservernotifyonconnectionclose"), 0, eCmdHdlrBinary,
+				   NULL, &cs.bEmitMsgOnClose, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdrivermode"), 0, eCmdHdlrInt,
+				   NULL, &cs.iStrmDrvrMode, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdriverauthmode"), 0, eCmdHdlrGetWord,
+				   NULL, &cs.pszStrmDrvrAuthMode, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverstreamdriverpermittedpeer"), 0, eCmdHdlrGetWord,
+				   setPermittedPeer, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserveraddtlframedelimiter"), 0, eCmdHdlrInt,
-				   NULL, &iAddtlFrameDelim, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   NULL, &cs.iAddtlFrameDelim, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverdisablelfdelimiter"), 0, eCmdHdlrBinary,
-				   NULL, &bDisableLFDelim, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverinputname"), 0,
-				   eCmdHdlrGetWord, NULL, &pszInputName, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverbindruleset"), 0,
-				   eCmdHdlrGetWord, setRuleset, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
-	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpflowcontrol"), 0,
-				   eCmdHdlrBinary, NULL, &bUseFlowControl, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   NULL, &cs.bDisableLFDelim, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverinputname"), 0, eCmdHdlrGetWord,
+				   NULL, &cs.pszInputName, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpserverbindruleset"), 0, eCmdHdlrGetWord,
+				   NULL, &cs.pszBindRuleset, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("inputtcpflowcontrol"), 0, eCmdHdlrBinary,
+				   NULL, &cs.bUseFlowControl, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 	CHKiRet(omsdRegCFSLineHdlr(UCHAR_CONSTANT("resetconfigvariables"), 1, eCmdHdlrCustomHandler,
-		resetConfigVariables, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
+				   resetConfigVariables, NULL, STD_LOADABLE_MODULE_ID, eConfObjGlobal));
 ENDmodInit
 
 
diff --git a/plugins/imtemplate/imtemplate.c b/plugins/imtemplate/imtemplate.c
index 1f60bef7..0cc9451e 100644
--- a/plugins/imtemplate/imtemplate.c
+++ b/plugins/imtemplate/imtemplate.c
@@ -95,10 +95,9 @@ DEF_IMOD_STATIC_DATA	/* must be present, starts static data */
 /* static int imtemplateWhateverVar = 0; */
 
 /* config settings */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
-
+};
 
 
 BEGINbeginCnfLoad
diff --git a/plugins/imttcp/imttcp.c b/plugins/imttcp/imttcp.c
index 47bd071e..e62360bd 100644
--- a/plugins/imttcp/imttcp.c
+++ b/plugins/imttcp/imttcp.c
@@ -135,9 +135,9 @@ DEFobjCurrIf(ruleset)
 
 
 /* config settings */
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 typedef struct configSettings_s {
 	int bEmitMsgOnClose;		/* emit an informational message on close by remote peer */
diff --git a/plugins/imudp/imudp.c b/plugins/imudp/imudp.c
index f2a5811d..e0cb3f34 100644
--- a/plugins/imudp/imudp.c
+++ b/plugins/imudp/imudp.c
@@ -93,27 +93,26 @@ static struct configSettings_s {
 	int iTimeRequery;		/* how often is time to be queried inside tight recv loop? 0=always */
 } cs;
 
-/* config settings */
-
-typedef struct instanceConf_s {
+struct instanceConf_s {
 	uchar *pszBindAddr;		/* IP to bind socket to */
 	uchar *pszBindPort;		/* Port to bind socket to */
 	uchar *pszBindRuleset;		/* name of ruleset to bind to */
 	ruleset_t *pBindRuleset;	/* ruleset to bind listener to (use system default if unspecified) */
 	struct instanceConf_s *next;
-} instanceConf_t;
+};
 
-typedef struct {
+struct modConfData_s {
 	rsconf_t *pConf;		/* our overall config object */
 	instanceConf_t *root, *tail;
 	uchar *pszSchedPolicy;		/* scheduling policy string */
 	int iSchedPolicy;		/* scheduling policy as SCHED_xxx */
 	int iSchedPrio;			/* scheduling priority */
 	int iTimeRequery;		/* how often is time to be queried inside tight recv loop? 0=always */
-} modConfData_t;
+};
 static modConfData_t *loadModConf = NULL;/* modConf ptr to use for the current load process */
 static modConfData_t *runModConf = NULL;/* modConf ptr to use for the current load process */
 
+#include "im-helper.h" /* must be included AFTER the type definitions! */
 
 
 
@@ -126,6 +125,7 @@ static rsRetVal addInstance(void __attribute__((unused)) *pVal, uchar *pNewVal)
 {
 	instanceConf_t *inst;
 	DEFiRet;
+
 	CHKmalloc(inst = MALLOC(sizeof(instanceConf_t)));
 	CHKmalloc(inst->pszBindPort = ustrdup((pNewVal == NULL || *pNewVal == '\0')
 				 	       ? (uchar*) "514" : pNewVal));
@@ -224,31 +224,13 @@ finalize_it:
 }
 
 
-/* Check provided ruleset name in conf and store a direct
- * pointer to it, if valid.
- */
-static inline rsRetVal
-checkRuleset(modConfData_t *modConf, instanceConf_t *inst)
+static inline void
+std_checkRuleset_genErrMsg(__attribute__((unused)) modConfData_t *modConf, instanceConf_t *inst)
 {
-	ruleset_t *pRuleset;
-	rsRetVal localRet;
-	DEFiRet;
-
-	if(inst->pszBindRuleset == NULL)
-		FINALIZE;
-
-	localRet = ruleset.GetRuleset(modConf->pConf, &pRuleset, inst->pszBindRuleset);
-	if(localRet == RS_RET_NOT_FOUND) {
-		errmsg.LogError(0, NO_ERRCODE, "imudp: ruleset '%s' for %s:%s not found - "
-				"using default ruleset instead", inst->pszBindRuleset,
-				inst->pszBindAddr == NULL ? "*" : inst->pszBindAddr,
-				inst->pszBindPort);
-	}
-	CHKiRet(localRet);
-	inst->pBindRuleset = pRuleset;
-
-finalize_it:
-	RETiRet;
+	errmsg.LogError(0, NO_ERRCODE, "imudp: ruleset '%s' for %s:%s not found - "
+			"using default ruleset instead", inst->pszBindRuleset,
+			inst->pszBindAddr == NULL ? "*" : (char*) inst->pszBindAddr,
+			inst->pszBindPort);
 }
 
 
@@ -670,7 +652,7 @@ BEGINcheckCnf
 CODESTARTcheckCnf
 	checkSchedParam(pModConf); /* this can not cause fatal errors */
 	for(inst = pModConf->root ; inst != NULL ; inst = inst->next) {
-		checkRuleset(pModConf, inst);
+		std_checkRuleset(pModConf, inst);
 	}
 ENDcheckCnf
 
diff --git a/plugins/imuxsock/imuxsock.c b/plugins/imuxsock/imuxsock.c
index 91f273c1..21550264 100644
--- a/plugins/imuxsock/imuxsock.c
+++ b/plugins/imuxsock/imuxsock.c
@@ -88,9 +88,9 @@ DEFobjCurrIf(datetime)
 DEFobjCurrIf(statsobj)
 
 
-typedef struct {
+struct modConfData_s {
 	EMPTY_STRUCT;
-} modConfData_t;
+};
 
 statsobj_t *modStats;
 STATSCOUNTER_DEF(ctrSubmit, mutCtrSubmit)
diff --git a/runtime/Makefile.am b/runtime/Makefile.am
index cfcfdc2c..a107e21a 100644
--- a/runtime/Makefile.am
+++ b/runtime/Makefile.am
@@ -13,6 +13,7 @@ librsyslog_la_SOURCES = \
 	batch.h \
 	syslogd-types.h \
 	module-template.h \
+	im-helper.h \
 	obj-types.h \
 	nsd.h \
 	glbl.h \
diff --git a/runtime/im-helper.h b/runtime/im-helper.h
new file mode 100644
index 00000000..6bbd6d70
--- /dev/null
+++ b/runtime/im-helper.h
@@ -0,0 +1,66 @@
+/* im-helper.h
+ * This file contains helper constructs that save time writing input modules. It
+ * assumes some common field names and plumbing. It is intended to be used together
+ * with module-template.h
+ *
+ * File begun on 2011-05-04 by RGerhards
+ *
+ * Copyright 2011 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of the rsyslog runtime library.
+ *
+ * The rsyslog runtime library is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The rsyslog runtime library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with the rsyslog runtime library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ * A copy of the LGPL can be found in the file "COPYING.LESSER" in this distribution.
+ */
+#ifndef	IM_HELPER_H_INCLUDED
+#define	IM_HELPER_H_INCLUDED 1
+
+
+/* The following function provides a complete implementation to check a
+ * ruleset and set the actual ruleset pointer. The macro assumes that
+ * standard field names are used. A functon std_checkRuleset_genErrMsg()
+ * must be defined to generate error messages in case the ruleset cannot
+ * be found.
+ */
+static inline void std_checkRuleset_genErrMsg(modConfData_t *modConf, instanceConf_t *inst);
+static inline rsRetVal
+std_checkRuleset(modConfData_t *modConf, instanceConf_t *inst)
+{
+	ruleset_t *pRuleset;
+	rsRetVal localRet;
+	DEFiRet;
+
+	inst->pBindRuleset = NULL;	/* assume default ruleset */
+
+	if(inst->pszBindRuleset == NULL)
+		FINALIZE;
+dbgprintf("ZZZZZ: inst->pszBindRuleset %s\n", inst->pszBindRuleset);
+
+	localRet = ruleset.GetRuleset(modConf->pConf, &pRuleset, inst->pszBindRuleset);
+	if(localRet == RS_RET_NOT_FOUND) {
+		std_checkRuleset_genErrMsg(modConf, inst);
+	}
+	CHKiRet(localRet);
+	inst->pBindRuleset = pRuleset;
+
+finalize_it:
+	RETiRet;
+}
+
+#endif /* #ifndef IM_HELPER_H_INCLUDED */
+
+/* vim:set ai:
+ */
diff --git a/runtime/module-template.h b/runtime/module-template.h
index 38cda4ba..965d48d0 100644
--- a/runtime/module-template.h
+++ b/runtime/module-template.h
@@ -584,7 +584,6 @@ finalize_it:\
 #define CODEmodInit_QueryRegCFSLineHdlr \
 	CHKiRet(pHostQueryEtryPt((uchar*)"regCfSysLineHdlr", &omsdRegCFSLineHdlr));
 
-#endif /* #ifndef MODULE_TEMPLATE_H_INCLUDED */
 
 /* modExit()
  * This is the counterpart to modInit(). It destroys a module and makes it ready for
@@ -853,5 +852,7 @@ static rsRetVal GetStrgenName(uchar **ppSz)\
 }
 
 
+#endif /* #ifndef MODULE_TEMPLATE_H_INCLUDED */
+
 /* vim:set ai:
  */
diff --git a/runtime/typedefs.h b/runtime/typedefs.h
index 1c8e93ce..11061e14 100644
--- a/runtime/typedefs.h
+++ b/runtime/typedefs.h
@@ -90,6 +90,8 @@ typedef struct rsconf_s rsconf_t;
 typedef struct cfgmodules_s cfgmodules_t;
 typedef struct cfgmodules_etry_s cfgmodules_etry_t;
 typedef struct outchannels_s outchannels_t;
+typedef struct modConfData_s modConfData_t;
+typedef struct instanceConf_s instanceConf_t;
 typedef rsRetVal (*prsf_t)(struct vmstk_s*, int);	/* pointer to a RainerScript function */
 typedef uint64 qDeqID;	/* queue Dequeue order ID. 32 bits is considered dangerously few */