begun to better modularize syslogd.c - this is an ongoing project; moved

    type definitions to a separate file

1 files changed, 265 insertions, 0 deletions

diff --git a/syslogd-types.h b/syslogd-types.h
new file mode 100644
index 00000000..3a33e693
--- /dev/null
+++ b/syslogd-types.h
@@ -0,0 +1,265 @@
+/* syslogd-type.h
+ * This file contains type defintions used by syslogd and its modules.
+ * It is a required input for any module.
+ *
+ * File begun on 2007-07-13 by RGerhards (extracted from syslogd.c)
+ *
+ * Copyright 2007 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This program 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 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+#include "config.h"  /* make sure we have autoconf macros */
+#include "stringbuf.h"
+
+#ifdef UT_NAMESIZE
+# define UNAMESZ	UT_NAMESIZE	/* length of a login name */
+#else
+# define UNAMESZ	8	/* length of a login name */
+#endif
+#define MAXUNAMES	20	/* maximum number of user names */
+#define MAXFNAME	200	/* max file pathname length */
+
+
+typedef enum _TCPFRAMINGMODE {
+		TCP_FRAMING_OCTET_STUFFING = 0, /* traditional LF-delimited */
+		TCP_FRAMING_OCTET_COUNTING = 1  /* -transport-tls like octet count */
+	} TCPFRAMINGMODE;
+
+/* The following structure is a dynafile name cache entry.
+ */
+struct s_dynaFileCacheEntry {
+	uchar *pName;	/* name currently open, if dynamic name */
+	short	fd;		/* name associated with file name in cache */
+	time_t	lastUsed;	/* for LRU - last access */
+};
+typedef struct s_dynaFileCacheEntry dynaFileCacheEntry;
+
+/* values for host comparisons specified with host selector blocks
+ * (+host, -host). rgerhards 2005-10-18.
+ */
+enum _EHostnameCmpMode {
+	HN_NO_COMP = 0, /* do not compare hostname */
+	HN_COMP_MATCH = 1, /* hostname must match */
+	HN_COMP_NOMATCH = 2 /* hostname must NOT match */
+};
+typedef enum _EHostnameCmpMode EHostnameCmpMode;
+
+/* rgerhards 2004-11-11: the following structure represents
+ * a time as it is used in syslog.
+ */
+struct syslogTime {
+	int timeType;	/* 0 - unitinialized , 1 - RFC 3164, 2 - syslog-protocol */
+	int year;
+	int month;
+	int day;
+	int hour; /* 24 hour clock */
+	int minute;
+	int second;
+	int secfrac;	/* fractional seconds (must be 32 bit!) */
+	int secfracPrecision;
+	char OffsetMode;	/* UTC offset + or - */
+	char OffsetHour;	/* UTC offset in hours */
+	int OffsetMinute;	/* UTC offset in minutes */
+	/* full UTC offset minutes = OffsetHours*60 + OffsetMinute. Then use
+	 * OffsetMode to know the direction.
+	 */
+};
+
+/* rgerhards 2004-11-08: The following structure represents a
+ * syslog message. 
+ *
+ * Important Note:
+ * The message object is used for multiple purposes (once it
+ * has been created). Once created, it actully is a read-only
+ * object (though we do not specifically express this). In order
+ * to avoid multiple copies of the same object, we use a
+ * reference counter. This counter is set to 1 by the constructer
+ * and increased by 1 with a call to MsgAddRef(). The destructor
+ * checks the reference count. If it is more than 1, only the counter
+ * will be decremented. If it is 1, however, the object is actually
+ * destroyed. To make this work, it is vital that MsgAddRef() is
+ * called each time a "copy" is stored somewhere.
+ */
+struct msg {
+	int	iRefCount;	/* reference counter (0 = unused) */
+	short	iSyslogVers;	/* version of syslog protocol
+				 * 0 - RFC 3164
+				 * 1 - RFC draft-protocol-08 */
+	short	bParseHOSTNAME;	/* should the hostname be parsed from the message? */
+	   /* background: the hostname is not present on "regular" messages
+	    * received via UNIX domain sockets from the same machine. However,
+	    * it is available when we have a forwarder (e.g. rfc3195d) using local
+	    * sockets. All in all, the parser would need parse templates, that would
+	    * resolve all these issues... rgerhards, 2005-10-06
+	    */
+	short	iSeverity;	/* the severity 0..7 */
+	uchar *pszSeverity;	/* severity as string... */
+	int iLenSeverity;	/* ... and its length. */
+ 	uchar *pszSeverityStr;   /* severity name... */
+ 	int iLenSeverityStr;    /* ... and its length. */
+	int	iFacility;	/* Facility code (up to 2^32-1) */
+	uchar *pszFacility;	/* Facility as string... */
+	int iLenFacility;	/* ... and its length. */
+ 	uchar *pszFacilityStr;   /* facility name... */
+ 	int iLenFacilityStr;    /* ... and its length. */
+	uchar *pszPRI;		/* the PRI as a string */
+	int iLenPRI;		/* and its length */
+	uchar	*pszRawMsg;	/* message as it was received on the
+				 * wire. This is important in case we
+				 * need to preserve cryptographic verifiers.
+				 */
+	int	iLenRawMsg;	/* length of raw message */
+	uchar	*pszMSG;	/* the MSG part itself */
+	int	iLenMSG;	/* Length of the MSG part */
+	uchar	*pszUxTradMsg;	/* the traditional UNIX message */
+	int	iLenUxTradMsg;/* Length of the traditional UNIX message */
+	uchar	*pszTAG;	/* pointer to tag value */
+	int	iLenTAG;	/* Length of the TAG part */
+	uchar	*pszHOSTNAME;	/* HOSTNAME from syslog message */
+	int	iLenHOSTNAME;	/* Length of HOSTNAME */
+	uchar	*pszRcvFrom;	/* System message was received from */
+	int	iLenRcvFrom;	/* Length of pszRcvFrom */
+	int	iProtocolVersion;/* protocol version of message received 0 - legacy, 1 syslog-protocol) */
+	rsCStrObj *pCSProgName;	/* the (BSD) program name */
+	rsCStrObj *pCSStrucData;/* STRUCTURED-DATA */
+	rsCStrObj *pCSAPPNAME;	/* APP-NAME */
+	rsCStrObj *pCSPROCID;	/* PROCID */
+	rsCStrObj *pCSMSGID;	/* MSGID */
+	struct syslogTime tRcvdAt;/* time the message entered this program */
+	char *pszRcvdAt3164;	/* time as RFC3164 formatted string (always 15 charcters) */
+	char *pszRcvdAt3339;	/* time as RFC3164 formatted string (32 charcters at most) */
+	char *pszRcvdAt_MySQL;	/* rcvdAt as MySQL formatted string (always 14 charcters) */
+	struct syslogTime tTIMESTAMP;/* (parsed) value of the timestamp */
+	char *pszTIMESTAMP3164;	/* TIMESTAMP as RFC3164 formatted string (always 15 charcters) */
+	char *pszTIMESTAMP3339;	/* TIMESTAMP as RFC3339 formatted string (32 charcters at most) */
+	char *pszTIMESTAMP_MySQL;/* TIMESTAMP as MySQL formatted string (always 14 charcters) */
+	int msgFlags;		/* flags associated with this message */
+};
+
+
+/* This structure represents the files that will have log
+ * copies printed.
+ * RGerhards 2004-11-08: Each instance of the filed structure 
+ * describes what I call an "output channel". This is important
+ * to mention as we now allow database connections to be
+ * present in the filed structure. If helps immensely, if we
+ * think of it as the abstraction of an output channel.
+ * rgerhards, 2005-10-26: The structure below provides ample
+ * opportunity for non-thread-safety. Each of the variable
+ * accesses must be carefully evaluated, many of them probably
+ * be guarded by mutexes. But beware of deadlocks...
+ */
+struct filed {
+	struct	filed *f_next;		/* next in linked list */
+	short	f_type;			/* entry type, see below */
+	short	f_file;			/* file descriptor */
+	off_t	f_sizeLimit;		/* file size limit, 0 = no limit */
+	char	*f_sizeLimitCmd;	/* command to carry out when size limit is reached */
+	time_t	f_time;			/* time this was last written */
+	/* filter properties */
+	enum {
+		FILTER_PRI = 0,		/* traditional PRI based filer */
+		FILTER_PROP = 1		/* extended filter, property based */
+	} f_filter_type;
+	EHostnameCmpMode eHostnameCmpMode;
+	rsCStrObj *pCSHostnameComp;/* hostname to check */
+	rsCStrObj *pCSProgNameComp;	/* tag to check or NULL, if not to be checked */
+	union {
+		u_char	f_pmask[LOG_NFACILITIES+1];	/* priority mask */
+		struct {
+			rsCStrObj *pCSPropName;
+			enum {
+				FIOP_NOP = 0,		/* do not use - No Operation */
+				FIOP_CONTAINS  = 1,	/* contains string? */
+				FIOP_ISEQUAL  = 2,	/* is (exactly) equal? */
+				FIOP_STARTSWITH = 3	/* starts with a string? */
+			} operation;
+			rsCStrObj *pCSCompValue;	/* value to "compare" against */
+			char isNegated;			/* actually a boolean ;) */
+		} prop;
+	} f_filterData;
+	union {
+		char	f_uname[MAXUNAMES][UNAMESZ+1];
+#ifdef	WITH_DB
+		struct {
+			MYSQL	*f_hmysql;		/* handle to MySQL */
+			char	f_dbsrv[MAXHOSTNAMELEN+1];	/* IP or hostname of DB server*/ 
+			char	f_dbname[_DB_MAXDBLEN+1];	/* DB name */
+			char	f_dbuid[_DB_MAXUNAMELEN+1];	/* DB user */
+			char	f_dbpwd[_DB_MAXPWDLEN+1];	/* DB user's password */
+			time_t	f_timeResumeOnError;		/* 0 if no error is present,	
+								   otherwise is it set to the
+								   time a retrail should be attampt */
+			int	f_iLastDBErrNo;			/* Last db error number. 0 = no error */
+		} f_mysql;
+#endif
+		struct {
+			char	f_hname[MAXHOSTNAMELEN+1];
+			struct addrinfo *f_addr;
+			int compressionLevel; /* 0 - no compression, else level for zlib */
+			char *port;
+			int protocol;
+			TCPFRAMINGMODE tcp_framing;
+#			define	FORW_UDP 0
+#			define	FORW_TCP 1
+			/* following fields for TCP-based delivery */
+			enum TCPSendStatus {
+				TCP_SEND_NOTCONNECTED = 0,
+				TCP_SEND_CONNECTING = 1,
+				TCP_SEND_READY = 2
+			} status;
+			char *savedMsg;
+			int savedMsgLen; /* length of savedMsg in octets */
+#			ifdef USE_PTHREADS
+			pthread_mutex_t mtxTCPSend;
+#			endif
+		} f_forw;		/* forwarding address */
+		struct {
+			char	f_fname[MAXFNAME];/* file or template name (dispaly only) */
+			struct template *pTpl;	/* pointer to template object */
+			char	bDynamicName;	/* 0 - static name, 1 - dynamic name (with properties) */
+			int	fCreateMode;	/* file creation mode for open() */
+			int	iCurrElt;	/* currently active cache element (-1 = none) */
+			int	iCurrCacheSize;	/* currently cache size (1-based) */
+			int	iDynaFileCacheSize; /* size of file handle cache */
+			/* The cache is implemented as an array. An empty element is indicated
+			 * by a NULL pointer. Memory is allocated as needed. The following
+			 * pointer points to the overall structure.
+			 */
+			dynaFileCacheEntry **dynCache;
+		} f_file;
+	} f_un;
+	char	f_lasttime[16];			/* time of last occurrence */
+	char	f_prevhost[MAXHOSTNAMELEN+1];	/* host from which recd. */
+	int	f_prevpri;			/* pri of f_prevline */
+	int	f_prevlen;			/* length of f_prevline */
+	int	f_prevcount;			/* repetition cnt of prevline */
+	int	f_repeatcount;			/* number of "repeated" msgs */
+	int	f_flags;			/* store some additional flags */
+	struct template *f_pTpl;		/* pointer to template to use */
+	struct iovec *f_iov;			/* dyn allocated depinding on template */
+	unsigned short *f_bMustBeFreed;		/* indicator, if iov_base must be freed to destruct */
+	int	f_iIovUsed;			/* nbr of elements used in IOV */
+	char	*f_psziov;			/* iov as string */
+	int	f_iLenpsziov;			/* length of iov as string */
+	struct msg* f_pMsg;			/* pointer to the message (this wil
+					         * replace the other vars with msg
+						 * content later). This is preserved after
+						 * the message has been processed - it is
+						 * also used to detect duplicates. */
+};
+typedef struct filed selector_t;	/* new type name */