From 686540cebee2920341911860c0019e687174daa8 Mon Sep 17 00:00:00 2001
From: Rainer Gerhards <rgerhards@adiscon.com>
Date: Wed, 20 Jul 2011 14:27:20 +0200
Subject: milestone: on the way to a new action conf interface to plugins...

---
 runtime/module-template.h | 65 ++++++++++++++++++++++++++++++++++++++++++++---
 runtime/modules.c         | 14 ++++++----
 2 files changed, 70 insertions(+), 9 deletions(-)

(limited to 'runtime')

diff --git a/runtime/module-template.h b/runtime/module-template.h
index 37c1cde8..2fa8e2e2 100644
--- a/runtime/module-template.h
+++ b/runtime/module-template.h
@@ -304,6 +304,54 @@ finalize_it:\
 }
 
 
+/* newActInst()
+ * Extra comments:
+ * This creates a new instance of a the action that implements the call.
+ * This is part of the conf2 (rsyslog v6) config system. It is called by
+ * the core when an action object has been obtained. The output module
+ * must then verify parameters and create a new action instance (if
+ * parameters are acceptable) or return an error code.
+ * On exit, ppModData must point to instance data. Also, a string
+ * request object must be created and filled. A macro is defined
+ * for that.
+ * For the most usual case, we have defined a macro below.
+ * If more than one string is requested, the macro can be used together
+ * with own code that overwrites the entry count. In this case, the
+ * macro must come before the own code. It is recommended to be
+ * placed right after CODESTARTnewActInst.
+ */
+#define BEGINnewActInst \
+static rsRetVal newActInst(struct nvlst *lst, void **ppModData, omodStringRequest_t **ppOMSR)\
+{\
+	DEFiRet;\
+	uchar *p;\
+	instanceData *pData = NULL;
+
+#define CODESTARTnewActInst \
+
+#define CODE_STD_STRING_REQUESTnewActInst(NumStrReqEntries) \
+	CHKiRet(OMSRconstruct(ppOMSR, NumStrReqEntries));
+
+#define CODE_STD_FINALIZERnewActInst \
+finalize_it:\
+	if(iRet == RS_RET_OK || iRet == RS_RET_SUSPENDED) {\
+		*ppModData = pData;\
+	} else {\
+		/* cleanup, we failed */\
+		if(*ppOMSR != NULL) {\
+			OMSRdestruct(*ppOMSR);\
+			*ppOMSR = NULL;\
+		}\
+		if(pData != NULL) {\
+			freeInstance(pData);\
+		} \
+	}
+
+#define ENDnewActInst \
+	RETiRet;\
+}
+
+
 /* tryResume()
  * This entry point is called to check if a module can resume operations. This
  * happens when a module requested that it be suspended. In suspended state,
@@ -473,7 +521,7 @@ static rsRetVal queryEtryPt(uchar *name, rsRetVal (**pEtryPoint)())\
 
 
 /* the following block is to be added for modules that support the v2
- * config system.
+ * config system. The config name is also provided.
  */
 #define CODEqueryEtryPt_STD_CONF2_QUERIES \
 	  else if(!strcmp((char*) name, "beginCnfLoad")) {\
@@ -486,9 +534,8 @@ static rsRetVal queryEtryPt(uchar *name, rsRetVal (**pEtryPoint)())\
 		*pEtryPoint = activateCnf;\
 	} else if(!strcmp((char*) name, "freeCnf")) {\
 		*pEtryPoint = freeCnf;\
-	} else if(!strcmp((char*) name, "getModCnfName")) {\
-		*pEtryPoint = modGetCnfName;\
-	}
+	} \
+	CODEqueryEtryPt_STD_CONF2_CNFNAME_QUERIES 
 
 
 /* the following block is to be added for modules that require
@@ -499,6 +546,16 @@ static rsRetVal queryEtryPt(uchar *name, rsRetVal (**pEtryPoint)())\
 		*pEtryPoint = activateCnfPrePrivDrop;\
 	}
 
+/* the following block is to be added for modules that support
+ * their config name. This is required for the rsyslog v6 config
+ * system, especially for outout modules which do not require
+ * the new set of begin/end config settings.
+ */
+#define CODEqueryEtryPt_STD_CONF2_CNFNAME_QUERIES \
+	  else if(!strcmp((char*) name, "getModCnfName")) {\
+		*pEtryPoint = modGetCnfName;\
+	}
+
 /* the following definition is the standard block for queryEtryPt for LIBRARY
  * modules. This can be used if no specific handling (e.g. to cover version
  * differences) is needed.
diff --git a/runtime/modules.c b/runtime/modules.c
index 9ab03574..d09ba770 100644
--- a/runtime/modules.c
+++ b/runtime/modules.c
@@ -524,6 +524,15 @@ doModInit(rsRetVal (*modInit)(int, int*, rsRetVal(**)(), rsRetVal(*)(), modInfo_
 		ABORT_FINALIZE(localRet);
 
 	/* optional calls for new config system */
+	localRet = (*pNew->modQueryEtryPt)((uchar*)"getModCnfName", &getModCnfName);
+	if(localRet == RS_RET_OK) {
+		if(getModCnfName(&cnfName) == RS_RET_OK)
+			pNew->cnfName = (uchar*) strdup((char*)cnfName);
+			  /**< we do not care if strdup() fails, we can accept that */
+		else
+			pNew->cnfName = NULL;
+		dbgprintf("module config name is '%s'\n", cnfName);
+	}
 	localRet = (*pNew->modQueryEtryPt)((uchar*)"beginCnfLoad", &pNew->beginCnfLoad);
 	if(localRet == RS_RET_OK) {
 		dbgprintf("module %s supports rsyslog v6 config interface\n", name);
@@ -537,11 +546,6 @@ doModInit(rsRetVal (*modInit)(int, int*, rsRetVal(**)(), rsRetVal(*)(), modInfo_
 		} else {
 			CHKiRet(localRet);
 		}
-		CHKiRet((*pNew->modQueryEtryPt)((uchar*)"getModCnfName", &getModCnfName));
-		getModCnfName(&cnfName);
-		pNew->cnfName = (uchar*) strdup((char*)cnfName);
-			/**< we do not care if strdup() fails, we can accept that */
-		dbgprintf("module config name is '%s'\n", cnfName);
 	} else if(localRet == RS_RET_MODULE_ENTRY_POINT_NOT_FOUND) {
 		pNew->beginCnfLoad = NULL; /* flag as non-present */
 	} else {
-- 
cgit