created initial vmprg class

5 files changed, 163 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index c02dfe4d..3770cc55 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,6 +5,8 @@ rfc3195d_SOURCES = rfc3195d.c rsyslog.h
 rsyslogd_SOURCES = \
 	syslogd.c \
 	syslogd.h \
+	vmprg.c \
+	vmprg.h \
 	vmop.c \
 	vmop.h \
 	debug.c \
diff --git a/syslogd.c b/syslogd.c
index 4379fea8..72f1f793 100644
--- a/syslogd.c
+++ b/syslogd.c
@@ -171,6 +171,7 @@
 #include "ctok.h"
 #include "conf.h"
 #include "vmop.h"
+#include "vmprg.h"
 
 /* We define our own set of syslog defintions so that we
  * do not need to rely on (possibly different) implementations.
@@ -3418,6 +3419,7 @@ static rsRetVal InitGlobalClasses(void)
 	CHKiRet(wtpClassInit());
 	CHKiRet(queueClassInit());
 	CHKiRet(vmopClassInit());
+	CHKiRet(vmprgClassInit());
 	CHKiRet(varClassInit());
 	CHKiRet(ctok_tokenClassInit());
 	CHKiRet(ctokClassInit());
diff --git a/vmop.h b/vmop.h
index 031d03e4..2500fd78 100644
--- a/vmop.h
+++ b/vmop.h
@@ -59,6 +59,7 @@ typedef struct vmop_s {
 		var_t *pVar;
 		/* TODO: add function pointer */
 	} operand;
+	struct vmop_s *pNext; /* next operation or NULL, if end of program (logically this belongs to vmprg) */
 } vmop_t;
 
 
diff --git a/vmprg.c b/vmprg.c
new file mode 100644
index 00000000..44b403f8
--- /dev/null
+++ b/vmprg.c
@@ -0,0 +1,101 @@
+/* vmprg.c - abstracts a program (bytecode) for the rsyslog virtual machine
+ *
+ * Module begun 2008-02-20 by Rainer Gerhards
+ *
+ * Copyright 2007, 2008 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+
+#include "config.h"
+#include <stdlib.h>
+#include <assert.h>
+
+#include "rsyslog.h"
+#include "obj.h"
+#include "vmprg.h"
+
+/* static data */
+DEFobjStaticHelpers
+
+
+/* Standard-Constructor
+ */
+BEGINobjConstruct(vmprg) /* be sure to specify the object type also in END macro! */
+ENDobjConstruct(vmprg)
+
+
+/* ConstructionFinalizer
+ * rgerhards, 2008-01-09
+ */
+rsRetVal vmprgConstructFinalize(vmprg_t *pThis)
+{
+	DEFiRet;
+	ISOBJ_TYPE_assert(pThis, vmprg);
+	RETiRet;
+}
+
+
+/* destructor for the vmprg object */
+BEGINobjDestruct(vmprg) /* be sure to specify the object type also in END and CODESTART macros! */
+	vmop_t *pOp;
+	vmop_t *pTmp;
+CODESTARTobjDestruct(vmprg)
+	/* we need to destruct the program elements! */
+	for(pOp = pThis->vmopRoot ; pOp != NULL ; ) {
+		pTmp = pOp;
+		pOp = pOp->pNext;
+		vmopDestruct(&pTmp);
+	}
+ENDobjDestruct(vmprg)
+
+
+/* add an operation (instruction) to the end of the current program. This
+ * function is expected to be called while creating the program, but never
+ * again after this is done and it is being executed. Results are undefined if
+ * it is called after execution.
+ */
+rsRetVal
+addOperation(vmprg_t *pThis, vmop_t *pOp)
+{
+	DEFiRet;
+
+	ISOBJ_TYPE_assert(pThis, vmprg);
+	ISOBJ_TYPE_assert(pOp, vmop);
+
+	if(pThis->vmopRoot == NULL) {
+		pThis->vmopRoot = pOp;
+	} else {
+		pThis->vmopLast->pNext = pOp;
+	}
+	pThis->vmopLast = pOp;
+
+	RETiRet;
+}
+
+
+/* Initialize the vmprg class. Must be called as the very first method
+ * before anything else is called inside this class.
+ * rgerhards, 2008-02-19
+ */
+BEGINObjClassInit(vmprg, 1) /* class, version */
+	OBJSetMethodHandler(objMethod_CONSTRUCTION_FINALIZER, vmprgConstructFinalize);
+ENDObjClassInit(vmprg)
+
+/* vi:set ai:
+ */
diff --git a/vmprg.h b/vmprg.h
new file mode 100644
index 00000000..9b278360
--- /dev/null
+++ b/vmprg.h
@@ -0,0 +1,57 @@
+/* The vmprg object.
+ *
+ * The program is made up of vmop_t's, one after another. When we support
+ * branching (or user-defined functions) at some time, well do this via
+ * special branch opcodes. They will then contain the actual memory
+ * address of a logical program entry that we shall branch to. Other than
+ * that, all execution is serial - that is one opcode is executed after
+ * the other. This class implements a logical program store, modelled
+ * after real main memory. A linked list of opcodes is used to implement it.
+ * In the future, we may use linked lists of array's to enhance performance,
+ * but for the time being we have taken the simplistic approach (which also
+ * reduces risk of bugs during initial development). The necessary pointers
+ * for this are already implemented in vmop. Though this is not the 100%
+ * correct place, we have opted this time in favor of performance, which
+ * made them go there.
+ *
+ * Copyright 2008 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+#ifndef INCLUDED_VMPRG_H
+#define INCLUDED_VMPRG_H
+
+#include "vmop.h"
+
+
+/* the vmprg object */
+typedef struct vmprg_s {
+	BEGINobjInstance;	/* Data to implement generic object - MUST be the first data element! */
+	vmop_t *vmopRoot;	/* start of program */
+	vmop_t *vmopLast;	/* last vmop of program (for adding new ones) */
+} vmprg_t;
+
+
+/* prototypes */
+rsRetVal vmprgConstruct(vmprg_t **ppThis);
+rsRetVal vmprgConstructFinalize(vmprg_t __attribute__((unused)) *pThis);
+rsRetVal vmprgDestruct(vmprg_t **ppThis);
+rsRetVal addOperation(vmprg_t *pThis, vmop_t *pOp);
+PROTOTYPEObjClassInit(vmprg);
+
+#endif /* #ifndef INCLUDED_VMPRG_H */