summaryrefslogtreecommitdiff
path: root/syslogd/syslogd.h
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@tele2.at>2018-08-19 13:37:42 +0200
committerDavid Oberhollenzer <david.oberhollenzer@tele2.at>2018-08-20 12:31:51 +0200
commit73404a09d4f26522902a11b02f27896fa1a23d37 (patch)
treefd902bedd6222a4c11196bee4c3b6ea1e9bcded8 /syslogd/syslogd.h
parent325f919847cb23044d203501140d9030903cfe12 (diff)
usyslogd: minor header restructuring/file structure cleanup
Signed-off-by: David Oberhollenzer <david.oberhollenzer@tele2.at>
Diffstat (limited to 'syslogd/syslogd.h')
-rw-r--r--syslogd/syslogd.h89
1 files changed, 89 insertions, 0 deletions
diff --git a/syslogd/syslogd.h b/syslogd/syslogd.h
new file mode 100644
index 0000000..47fc31c
--- /dev/null
+++ b/syslogd/syslogd.h
@@ -0,0 +1,89 @@
+/* SPDX-License-Identifier: GPL-3.0-or-later */
+/*
+ * Copyright (C) 2018 - David Oberhollenzer
+ *
+ * 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 3 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, see <https://www.gnu.org/licenses/>.
+ */
+#ifndef SYSLOGD_H
+#define SYSLOGD_H
+
+
+#include <sys/types.h>
+#include <time.h>
+
+#include "config.h"
+
+
+#define SYSLOG_SOCKET PREFIXPATH "/dev/log"
+#define SYSLOG_PATH PREFIXPATH "/var/log"
+#define DEFAULT_USER "syslogd"
+#define DEFAULT_GROUP "syslogd"
+
+
+/*
+ encapsulates the split up data from a message received
+ through the local syslog socket.
+ */
+typedef struct {
+ int facility;
+ int level;
+ time_t timestamp;
+ pid_t pid;
+ const char *ident;
+ const char *message;
+} syslog_msg_t;
+
+
+enum {
+ /*
+ Rotate log data in a way that we still generate a continuous stream
+ of log data. E.g. in the case of log files, move the current log file
+ to one suffixed with a timestamp. We don't lose any log data.
+ */
+ LOG_ROTATE_CONTINUOUS = 0x00,
+
+ /*
+ Rotate log data by overwriting old data with more recent data.
+ E.g. in the case of log files, move the current log file to one
+ with a constant prefix, overwriting any existing data.
+ */
+ LOG_ROTATE_OVERWRITE = 0x01,
+
+ /*
+ Automatically do a log rotatation if a log stream reaches a preset
+ size limit.
+ */
+ LOG_ROTATE_SIZE_LIMIT = 0x10,
+};
+
+typedef struct log_backend_t {
+ int (*init)(struct log_backend_t *log, int flags, size_t sizelimit);
+
+ void (*cleanup)(struct log_backend_t *log);
+
+ int (*write)(struct log_backend_t *log, const syslog_msg_t *msg);
+
+ void (*rotate)(struct log_backend_t *log);
+} log_backend_t;
+
+
+extern log_backend_t *logmgr;
+
+/*
+ Parse a message string received from the syslog socket and produce
+ a split up representation for the message.
+ */
+int syslog_msg_parse(syslog_msg_t *msg, char *str);
+
+#endif /* LOGFILE_H */