summaryrefslogtreecommitdiffstats
path: root/src/log-pcap.c
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
commita0aa2307322cd47bbf416810ac0292925e03be87 (patch)
tree37076262a026c4b48c8a0e84f44ff9187556ca35 /src/log-pcap.c
parentInitial commit. (diff)
downloadsuricata-a0aa2307322cd47bbf416810ac0292925e03be87.tar.xz
suricata-a0aa2307322cd47bbf416810ac0292925e03be87.zip
Adding upstream version 1:7.0.3.upstream/1%7.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/log-pcap.c')
-rw-r--r--src/log-pcap.c2044
1 files changed, 2044 insertions, 0 deletions
diff --git a/src/log-pcap.c b/src/log-pcap.c
new file mode 100644
index 0000000..a20fc84
--- /dev/null
+++ b/src/log-pcap.c
@@ -0,0 +1,2044 @@
+/* Copyright (C) 2007-2021 Open Information Security Foundation
+ *
+ * You can copy, redistribute or modify this Program under the terms of
+ * the GNU General Public License version 2 as published by the Free
+ * Software Foundation.
+ *
+ * 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
+ * version 2 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+/**
+ * \file
+ *
+ * \author William Metcalf <William.Metcalf@gmail.com>
+ * \author Victor Julien <victor@inliniac.net>
+ *
+ * Pcap packet logging module.
+ */
+
+#include "suricata-common.h"
+#ifdef HAVE_LIBLZ4
+#include <lz4frame.h>
+#include "util-fmemopen.h"
+#endif /* HAVE_LIBLZ4 */
+
+#if defined(HAVE_DIRENT_H) && defined(HAVE_FNMATCH_H)
+#define INIT_RING_BUFFER
+#include <dirent.h>
+#include <fnmatch.h>
+#endif
+
+#include "log-pcap.h"
+
+#include "threads.h"
+#include "threadvars.h"
+#include "decode.h"
+#include "stream.h"
+#include "stream-tcp-reassemble.h"
+
+#include "output.h"
+
+#include "util-buffer.h"
+#include "util-byte.h"
+#include "util-conf.h"
+#include "util-cpu.h"
+#include "util-datalink.h"
+#include "util-misc.h"
+#include "util-path.h"
+#include "util-profiling.h"
+#include "util-time.h"
+
+#define DEFAULT_LOG_FILENAME "pcaplog"
+#define MODULE_NAME "PcapLog"
+#define MIN_LIMIT 4 * 1024 * 1024
+#define DEFAULT_LIMIT 100 * 1024 * 1024
+#define DEFAULT_FILE_LIMIT 0
+
+#define LOGMODE_NORMAL 0
+#define LOGMODE_SGUIL 1
+#define LOGMODE_MULTI 2
+
+typedef enum LogModeConditionalType_ {
+ LOGMODE_COND_ALL,
+ LOGMODE_COND_ALERTS,
+ LOGMODE_COND_TAG
+} LogModeConditionalType;
+
+#define RING_BUFFER_MODE_DISABLED 0
+#define RING_BUFFER_MODE_ENABLED 1
+
+#define TS_FORMAT_SEC 0
+#define TS_FORMAT_USEC 1
+
+#define USE_STREAM_DEPTH_DISABLED 0
+#define USE_STREAM_DEPTH_ENABLED 1
+
+#define HONOR_PASS_RULES_DISABLED 0
+#define HONOR_PASS_RULES_ENABLED 1
+
+#define PCAP_SNAPLEN 262144
+#define PCAP_BUFFER_TIMEOUT 1000000 // microseconds
+
+SC_ATOMIC_DECLARE(uint32_t, thread_cnt);
+
+typedef struct PcapFileName_ {
+ char *filename;
+ char *dirname;
+
+ /* Like a struct timeval, but with fixed size. This is only used when
+ * seeding the ring buffer on start. */
+ struct {
+ uint64_t secs;
+ uint32_t usecs;
+ };
+
+ TAILQ_ENTRY(PcapFileName_) next; /**< Pointer to next Pcap File for tailq. */
+} PcapFileName;
+
+thread_local char *pcap_file_thread = NULL;
+
+typedef struct PcapLogProfileData_ {
+ uint64_t total;
+ uint64_t cnt;
+} PcapLogProfileData;
+
+#define MAX_TOKS 9
+#define MAX_FILENAMELEN 513
+
+enum PcapLogCompressionFormat {
+ PCAP_LOG_COMPRESSION_FORMAT_NONE,
+ PCAP_LOG_COMPRESSION_FORMAT_LZ4,
+};
+
+typedef struct PcapLogCompressionData_ {
+ enum PcapLogCompressionFormat format;
+ uint8_t *buffer;
+ uint64_t buffer_size;
+#ifdef HAVE_LIBLZ4
+ LZ4F_compressionContext_t lz4f_context;
+ LZ4F_preferences_t lz4f_prefs;
+#endif /* HAVE_LIBLZ4 */
+ FILE *file;
+ uint8_t *pcap_buf;
+ uint64_t pcap_buf_size;
+ FILE *pcap_buf_wrapper;
+ uint64_t bytes_in_block;
+} PcapLogCompressionData;
+
+/**
+ * PcapLog thread vars
+ *
+ * Used for storing file options.
+ */
+typedef struct PcapLogData_ {
+ int use_stream_depth; /**< use stream depth i.e. ignore packets that reach limit */
+ int honor_pass_rules; /**< don't log if pass rules have matched */
+ int is_private; /**< TRUE if ctx is thread local */
+ SCMutex plog_lock;
+ uint64_t pkt_cnt; /**< total number of packets */
+ struct pcap_pkthdr *h; /**< pcap header struct */
+ char *filename; /**< current filename */
+ int mode; /**< normal or sguil */
+ int prev_day; /**< last day, for finding out when */
+ uint64_t size_current; /**< file current size */
+ uint64_t size_limit; /**< file size limit */
+ pcap_t *pcap_dead_handle; /**< pcap_dumper_t needs a handle */
+ pcap_dumper_t *pcap_dumper; /**< actually writes the packets */
+ uint64_t profile_data_size; /**< track in bytes how many bytes we wrote */
+ uint32_t file_cnt; /**< count of pcap files we currently have */
+ uint32_t max_files; /**< maximum files to use in ring buffer mode */
+ LogModeConditionalType
+ conditional; /**< log all packets or just packets and flows with alerts */
+
+ PcapLogProfileData profile_lock;
+ PcapLogProfileData profile_write;
+ PcapLogProfileData profile_unlock;
+ PcapLogProfileData profile_handles; // open handles
+ PcapLogProfileData profile_close;
+ PcapLogProfileData profile_open;
+ PcapLogProfileData profile_rotate;
+
+ TAILQ_HEAD(, PcapFileName_) pcap_file_list;
+
+ uint32_t thread_number; /**< thread number, first thread is 1, second 2, etc */
+ int use_ringbuffer; /**< ring buffer mode enabled or disabled */
+ int timestamp_format; /**< timestamp format sec or usec */
+ char *prefix; /**< filename prefix */
+ const char *suffix; /**< filename suffix */
+ char dir[PATH_MAX]; /**< pcap log directory */
+ int reported;
+ int threads; /**< number of threads (only set in the global) */
+ char *filename_parts[MAX_TOKS];
+ int filename_part_cnt;
+ struct timeval last_pcap_dump;
+ int fopen_err; /**< set to the last fopen error */
+ bool pcap_open_err; /**< true if the last pcap open errored */
+
+ PcapLogCompressionData compression;
+} PcapLogData;
+
+typedef struct PcapLogThreadData_ {
+ PcapLogData *pcap_log;
+ MemBuffer *buf;
+} PcapLogThreadData;
+
+/* Pattern for extracting timestamp from pcap log files. */
+static const char timestamp_pattern[] = ".*?(\\d+)(\\.(\\d+))?";
+static pcre2_code *pcre_timestamp_code = NULL;
+static pcre2_match_data *pcre_timestamp_match = NULL;
+
+/* global pcap data for when we're using multi mode. At exit we'll
+ * merge counters into this one and then report counters. */
+static PcapLogData *g_pcap_data = NULL;
+
+static int PcapLogOpenFileCtx(PcapLogData *);
+static int PcapLog(ThreadVars *, void *, const Packet *);
+static TmEcode PcapLogDataInit(ThreadVars *, const void *, void **);
+static TmEcode PcapLogDataDeinit(ThreadVars *, void *);
+static void PcapLogFileDeInitCtx(OutputCtx *);
+static OutputInitResult PcapLogInitCtx(ConfNode *);
+static void PcapLogProfilingDump(PcapLogData *);
+static int PcapLogCondition(ThreadVars *, void *, const Packet *);
+
+void PcapLogRegister(void)
+{
+ OutputRegisterPacketModule(LOGGER_PCAP, MODULE_NAME, "pcap-log",
+ PcapLogInitCtx, PcapLog, PcapLogCondition, PcapLogDataInit,
+ PcapLogDataDeinit, NULL);
+ PcapLogProfileSetup();
+ SC_ATOMIC_INIT(thread_cnt);
+ SC_ATOMIC_SET(thread_cnt, 1); /* first id is 1 */
+ return;
+}
+
+#define PCAPLOG_PROFILE_START \
+ uint64_t pcaplog_profile_ticks = UtilCpuGetTicks()
+
+#define PCAPLOG_PROFILE_END(prof) \
+ (prof).total += (UtilCpuGetTicks() - pcaplog_profile_ticks); \
+ (prof).cnt++
+
+static int PcapLogCondition(ThreadVars *tv, void *thread_data, const Packet *p)
+{
+ PcapLogThreadData *ptd = (PcapLogThreadData *)thread_data;
+
+ /* Log alerted flow or tagged flow */
+ switch (ptd->pcap_log->conditional) {
+ case LOGMODE_COND_ALL:
+ break;
+ case LOGMODE_COND_ALERTS:
+ if (p->alerts.cnt || (p->flow && FlowHasAlerts(p->flow))) {
+ return TRUE;
+ } else {
+ return FALSE;
+ }
+ break;
+ case LOGMODE_COND_TAG:
+ if (p->flags & (PKT_HAS_TAG | PKT_FIRST_TAG)) {
+ return TRUE;
+ } else {
+ return FALSE;
+ }
+ break;
+ }
+
+ if (p->flags & PKT_PSEUDO_STREAM_END) {
+ return FALSE;
+ }
+
+ if (IS_TUNNEL_PKT(p) && !IS_TUNNEL_ROOT_PKT(p)) {
+ return FALSE;
+ }
+ return TRUE;
+}
+
+/**
+ * \brief Function to close pcaplog file
+ *
+ * \param t Thread Variable containing input/output queue, cpu affinity etc.
+ * \param pl PcapLog thread variable.
+ */
+static int PcapLogCloseFile(ThreadVars *t, PcapLogData *pl)
+{
+ if (pl != NULL) {
+ PCAPLOG_PROFILE_START;
+
+ if (pl->pcap_dumper != NULL) {
+ pcap_dump_close(pl->pcap_dumper);
+#ifdef HAVE_LIBLZ4
+ PcapLogCompressionData *comp = &pl->compression;
+ if (comp->format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ /* pcap_dump_close() has closed its output ``file'',
+ * so we need to call fmemopen again. */
+
+ comp->pcap_buf_wrapper = SCFmemopen(comp->pcap_buf,
+ comp->pcap_buf_size, "w");
+ if (comp->pcap_buf_wrapper == NULL) {
+ SCLogError("SCFmemopen failed: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ }
+#endif /* HAVE_LIBLZ4 */
+ }
+ pl->size_current = 0;
+ pl->pcap_dumper = NULL;
+
+ if (pl->pcap_dead_handle != NULL)
+ pcap_close(pl->pcap_dead_handle);
+ pl->pcap_dead_handle = NULL;
+
+#ifdef HAVE_LIBLZ4
+ PcapLogCompressionData *comp = &pl->compression;
+ if (comp->format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ /* pcap_dump_close did not write any data because we call
+ * pcap_dump_flush() after every write when writing
+ * compressed output. */
+ uint64_t bytes_written = LZ4F_compressEnd(comp->lz4f_context,
+ comp->buffer, comp->buffer_size, NULL);
+ if (LZ4F_isError(bytes_written)) {
+ SCLogError("LZ4F_compressEnd: %s", LZ4F_getErrorName(bytes_written));
+ return TM_ECODE_FAILED;
+ }
+ if (fwrite(comp->buffer, 1, bytes_written, comp->file) < bytes_written) {
+ SCLogError("fwrite failed: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ fclose(comp->file);
+ comp->bytes_in_block = 0;
+ }
+#endif /* HAVE_LIBLZ4 */
+
+ PCAPLOG_PROFILE_END(pl->profile_close);
+ }
+
+ return 0;
+}
+
+static void PcapFileNameFree(PcapFileName *pf)
+{
+ if (pf != NULL) {
+ if (pf->filename != NULL) {
+ SCFree(pf->filename);
+ }
+ if (pf->dirname != NULL) {
+ SCFree(pf->dirname);
+ }
+ SCFree(pf);
+ }
+
+ return;
+}
+
+/**
+ * \brief Function to rotate pcaplog file
+ *
+ * \param t Thread Variable containing input/output queue, cpu affinity etc.
+ * \param pl PcapLog thread variable.
+ *
+ * \retval 0 on success
+ * \retval -1 on failure
+ */
+static int PcapLogRotateFile(ThreadVars *t, PcapLogData *pl)
+{
+ PcapFileName *pf;
+ PcapFileName *pfnext;
+
+ PCAPLOG_PROFILE_START;
+
+ if (PcapLogCloseFile(t,pl) < 0) {
+ SCLogDebug("PcapLogCloseFile failed");
+ return -1;
+ }
+
+ if (pl->use_ringbuffer == RING_BUFFER_MODE_ENABLED && pl->file_cnt >= pl->max_files) {
+ pf = TAILQ_FIRST(&pl->pcap_file_list);
+ SCLogDebug("Removing pcap file %s", pf->filename);
+
+ if (remove(pf->filename) != 0) {
+ // VJ remove can fail because file is already gone
+ // SCLogWarning("failed to remove log file %s: %s",
+ // pf->filename, strerror( errno ));
+ }
+
+ /* Remove directory if Sguil mode and no files left in sguil dir */
+ if (pl->mode == LOGMODE_SGUIL) {
+ pfnext = TAILQ_NEXT(pf,next);
+
+ if (strcmp(pf->dirname, pfnext->dirname) == 0) {
+ SCLogDebug("Current entry dir %s and next entry %s "
+ "are equal: not removing dir",
+ pf->dirname, pfnext->dirname);
+ } else {
+ SCLogDebug("current entry %s and %s are "
+ "not equal: removing dir",
+ pf->dirname, pfnext->dirname);
+
+ if (remove(pf->dirname) != 0) {
+ SCLogWarning("failed to remove sguil log %s: %s", pf->dirname, strerror(errno));
+ }
+ }
+ }
+
+ TAILQ_REMOVE(&pl->pcap_file_list, pf, next);
+ PcapFileNameFree(pf);
+ pl->file_cnt--;
+ }
+
+ if (PcapLogOpenFileCtx(pl) < 0) {
+ SCLogError("opening new pcap log file failed");
+ return -1;
+ }
+ pl->file_cnt++;
+ SCLogDebug("file_cnt %u", pl->file_cnt);
+
+ PCAPLOG_PROFILE_END(pl->profile_rotate);
+ return 0;
+}
+
+static int PcapLogOpenHandles(PcapLogData *pl, const Packet *p)
+{
+ PCAPLOG_PROFILE_START;
+
+ int datalink = p->datalink;
+ if (IS_TUNNEL_PKT(p) && !IS_TUNNEL_ROOT_PKT(p)) {
+ Packet *real_p = p->root;
+ datalink = real_p->datalink;
+ }
+ if (pl->pcap_dead_handle == NULL) {
+ SCLogDebug("Setting pcap-log link type to %u", datalink);
+ if ((pl->pcap_dead_handle = pcap_open_dead(datalink, PCAP_SNAPLEN)) == NULL) {
+ SCLogDebug("Error opening dead pcap handle");
+ return TM_ECODE_FAILED;
+ }
+ }
+
+ if (pl->pcap_dumper == NULL) {
+ if (pl->compression.format == PCAP_LOG_COMPRESSION_FORMAT_NONE) {
+ if ((pl->pcap_dumper = pcap_dump_open(pl->pcap_dead_handle,
+ pl->filename)) == NULL) {
+ if (!pl->pcap_open_err) {
+ SCLogError("Error opening dump file %s", pcap_geterr(pl->pcap_dead_handle));
+ pl->pcap_open_err = true;
+ }
+ return TM_ECODE_FAILED;
+ } else {
+ pl->pcap_open_err = false;
+ }
+ }
+#ifdef HAVE_LIBLZ4
+ else if (pl->compression.format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ PcapLogCompressionData *comp = &pl->compression;
+
+ comp->file = fopen(pl->filename, "w");
+ if (comp->file == NULL) {
+ if (errno != pl->fopen_err) {
+ SCLogError("Error opening file for compressed output: %s", strerror(errno));
+ pl->fopen_err = errno;
+ }
+ return TM_ECODE_FAILED;
+ } else {
+ pl->fopen_err = 0;
+ }
+
+ if ((pl->pcap_dumper = pcap_dump_fopen(pl->pcap_dead_handle, comp->pcap_buf_wrapper)) ==
+ NULL) {
+ if (!pl->pcap_open_err) {
+ SCLogError("Error opening dump file %s", pcap_geterr(pl->pcap_dead_handle));
+ pl->pcap_open_err = true;
+ }
+ fclose(comp->file);
+ comp->file = NULL;
+ return TM_ECODE_FAILED;
+ } else {
+ pl->pcap_open_err = false;
+ }
+
+ uint64_t bytes_written = LZ4F_compressBegin(comp->lz4f_context,
+ comp->buffer, comp->buffer_size, NULL);
+ if (LZ4F_isError(bytes_written)) {
+ SCLogError("LZ4F_compressBegin: %s", LZ4F_getErrorName(bytes_written));
+ return TM_ECODE_FAILED;
+ }
+ if (fwrite(comp->buffer, 1, bytes_written, comp->file) < bytes_written) {
+ SCLogError("fwrite failed: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ }
+#endif /* HAVE_LIBLZ4 */
+ }
+
+ PCAPLOG_PROFILE_END(pl->profile_handles);
+ return TM_ECODE_OK;
+}
+
+/** \internal
+ * \brief lock wrapper for main PcapLog() function
+ * NOTE: only meant for use in main PcapLog() function.
+ */
+static void PcapLogLock(PcapLogData *pl)
+{
+ if (!(pl->is_private)) {
+ PCAPLOG_PROFILE_START;
+ SCMutexLock(&pl->plog_lock);
+ PCAPLOG_PROFILE_END(pl->profile_lock);
+ }
+}
+
+/** \internal
+ * \brief unlock wrapper for main PcapLog() function
+ * NOTE: only meant for use in main PcapLog() function.
+ */
+static void PcapLogUnlock(PcapLogData *pl)
+{
+ if (!(pl->is_private)) {
+ PCAPLOG_PROFILE_START;
+ SCMutexUnlock(&pl->plog_lock);
+ PCAPLOG_PROFILE_END(pl->profile_unlock);
+ }
+}
+
+static inline int PcapWrite(
+ PcapLogData *pl, PcapLogCompressionData *comp, uint8_t *data, size_t len)
+{
+ struct timeval current_dump;
+ gettimeofday(&current_dump, NULL);
+ pcap_dump((u_char *)pl->pcap_dumper, pl->h, data);
+ if (pl->compression.format == PCAP_LOG_COMPRESSION_FORMAT_NONE) {
+ pl->size_current += len;
+ }
+#ifdef HAVE_LIBLZ4
+ else if (pl->compression.format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ pcap_dump_flush(pl->pcap_dumper);
+ long in_size = ftell(comp->pcap_buf_wrapper);
+ if (in_size < 0) {
+ SCLogError("ftell failed with: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ uint64_t out_size = LZ4F_compressUpdate(comp->lz4f_context, comp->buffer, comp->buffer_size,
+ comp->pcap_buf, (uint64_t)in_size, NULL);
+ if (LZ4F_isError(len)) {
+ SCLogError("LZ4F_compressUpdate: %s", LZ4F_getErrorName(len));
+ return TM_ECODE_FAILED;
+ }
+ if (fseek(pl->compression.pcap_buf_wrapper, 0, SEEK_SET) != 0) {
+ SCLogError("fseek failed: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ if (fwrite(comp->buffer, 1, out_size, comp->file) < out_size) {
+ SCLogError("fwrite failed: %s", strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+ if (out_size > 0) {
+ pl->size_current += out_size;
+ comp->bytes_in_block = len;
+ } else {
+ comp->bytes_in_block += len;
+ }
+ }
+#endif /* HAVE_LIBLZ4 */
+ if (TimeDifferenceMicros(pl->last_pcap_dump, current_dump) >= PCAP_BUFFER_TIMEOUT) {
+ pcap_dump_flush(pl->pcap_dumper);
+ }
+ pl->last_pcap_dump = current_dump;
+ return TM_ECODE_OK;
+}
+
+struct PcapLogCallbackContext {
+ PcapLogData *pl;
+ PcapLogCompressionData *connp;
+ MemBuffer *buf;
+};
+
+static int PcapLogSegmentCallback(
+ const Packet *p, TcpSegment *seg, void *data, const uint8_t *buf, uint32_t buflen)
+{
+ struct PcapLogCallbackContext *pctx = (struct PcapLogCallbackContext *)data;
+
+ if (seg->pcap_hdr_storage->pktlen) {
+ pctx->pl->h->ts.tv_sec = seg->pcap_hdr_storage->ts.tv_sec;
+ pctx->pl->h->ts.tv_usec = seg->pcap_hdr_storage->ts.tv_usec;
+ pctx->pl->h->len = seg->pcap_hdr_storage->pktlen + buflen;
+ pctx->pl->h->caplen = seg->pcap_hdr_storage->pktlen + buflen;
+ MemBufferReset(pctx->buf);
+ MemBufferWriteRaw(pctx->buf, seg->pcap_hdr_storage->pkt_hdr, seg->pcap_hdr_storage->pktlen);
+ MemBufferWriteRaw(pctx->buf, buf, buflen);
+
+ PcapWrite(pctx->pl, pctx->connp, (uint8_t *)pctx->buf->buffer, pctx->pl->h->len);
+ }
+ return 1;
+}
+
+static void PcapLogDumpSegments(
+ PcapLogThreadData *td, PcapLogCompressionData *connp, const Packet *p)
+{
+ uint8_t flag;
+ flag = STREAM_DUMP_HEADERS;
+
+ /* Loop on segment from this side */
+ struct PcapLogCallbackContext data = { td->pcap_log, connp, td->buf };
+ StreamSegmentForSession(p, flag, PcapLogSegmentCallback, (void *)&data);
+}
+
+/**
+ * \brief Pcap logging main function
+ *
+ * \param t threadvar
+ * \param p packet
+ * \param thread_data thread module specific data
+ *
+ * \retval TM_ECODE_OK on succes
+ * \retval TM_ECODE_FAILED on serious error
+ */
+static int PcapLog (ThreadVars *t, void *thread_data, const Packet *p)
+{
+ size_t len;
+ int rotate = 0;
+ int ret = 0;
+ Packet *rp = NULL;
+
+ PcapLogThreadData *td = (PcapLogThreadData *)thread_data;
+ PcapLogData *pl = td->pcap_log;
+
+ if (((p->flags & PKT_STREAM_NOPCAPLOG) && (pl->use_stream_depth == USE_STREAM_DEPTH_ENABLED)) ||
+ (pl->honor_pass_rules && (p->flags & PKT_NOPACKET_INSPECTION))) {
+ return TM_ECODE_OK;
+ }
+
+ PcapLogLock(pl);
+
+ pl->pkt_cnt++;
+ pl->h->ts.tv_sec = SCTIME_SECS(p->ts);
+ pl->h->ts.tv_usec = SCTIME_USECS(p->ts);
+ if (IS_TUNNEL_PKT(p) && !IS_TUNNEL_ROOT_PKT(p)) {
+ rp = p->root;
+ pl->h->caplen = GET_PKT_LEN(rp);
+ pl->h->len = GET_PKT_LEN(rp);
+ len = sizeof(*pl->h) + GET_PKT_LEN(rp);
+ } else {
+ pl->h->caplen = GET_PKT_LEN(p);
+ pl->h->len = GET_PKT_LEN(p);
+ len = sizeof(*pl->h) + GET_PKT_LEN(p);
+ }
+
+ if (pl->filename == NULL) {
+ ret = PcapLogOpenFileCtx(pl);
+ if (ret < 0) {
+ PcapLogUnlock(pl);
+ return TM_ECODE_FAILED;
+ }
+ SCLogDebug("Opening PCAP log file %s", pl->filename);
+ }
+
+ if (pl->mode == LOGMODE_SGUIL) {
+ struct tm local_tm;
+ struct tm *tms = SCLocalTime(SCTIME_SECS(p->ts), &local_tm);
+ if (tms->tm_mday != pl->prev_day) {
+ rotate = 1;
+ pl->prev_day = tms->tm_mday;
+ }
+ }
+
+ PcapLogCompressionData *comp = &pl->compression;
+ if (comp->format == PCAP_LOG_COMPRESSION_FORMAT_NONE) {
+ if ((pl->size_current + len) > pl->size_limit || rotate) {
+ if (PcapLogRotateFile(t,pl) < 0) {
+ PcapLogUnlock(pl);
+ SCLogDebug("rotation of pcap failed");
+ return TM_ECODE_FAILED;
+ }
+ }
+ }
+#ifdef HAVE_LIBLZ4
+ else if (comp->format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ /* When writing compressed pcap logs, we have no way of knowing
+ * for sure whether adding this packet would cause the current
+ * file to exceed the size limit. Thus, we record the number of
+ * bytes that have been fed into lz4 since the last write, and
+ * act as if they would be written uncompressed. */
+
+ if ((pl->size_current + comp->bytes_in_block + len) > pl->size_limit ||
+ rotate) {
+ if (PcapLogRotateFile(t,pl) < 0) {
+ PcapLogUnlock(pl);
+ SCLogDebug("rotation of pcap failed");
+ return TM_ECODE_FAILED;
+ }
+ }
+ }
+#endif /* HAVE_LIBLZ4 */
+
+ /* XXX pcap handles, nfq, pfring, can only have one link type ipfw? we do
+ * this here as we don't know the link type until we get our first packet */
+ if (pl->pcap_dead_handle == NULL || pl->pcap_dumper == NULL) {
+ if (PcapLogOpenHandles(pl, p) != TM_ECODE_OK) {
+ PcapLogUnlock(pl);
+ return TM_ECODE_FAILED;
+ }
+ }
+
+ PCAPLOG_PROFILE_START;
+
+ /* if we are using alerted logging and if packet is first one with alert in flow
+ * then we need to dump in the pcap the stream acked by the packet */
+ if ((p->flags & PKT_FIRST_ALERTS) && (td->pcap_log->conditional != LOGMODE_COND_ALL)) {
+ if (PKT_IS_TCP(p)) {
+ /* dump fake packets for all segments we have on acked by packet */
+#ifdef HAVE_LIBLZ4
+ PcapLogDumpSegments(td, comp, p);
+#else
+ PcapLogDumpSegments(td, NULL, p);
+#endif
+ if (p->flags & PKT_PSEUDO_STREAM_END) {
+ PcapLogUnlock(pl);
+ return TM_ECODE_OK;
+ }
+
+ /* PcapLogDumpSegment has written over the PcapLogData variables so need to update */
+ pl->h->ts.tv_sec = SCTIME_SECS(p->ts);
+ pl->h->ts.tv_usec = SCTIME_USECS(p->ts);
+ if (IS_TUNNEL_PKT(p) && !IS_TUNNEL_ROOT_PKT(p)) {
+ rp = p->root;
+ pl->h->caplen = GET_PKT_LEN(rp);
+ pl->h->len = GET_PKT_LEN(rp);
+ len = sizeof(*pl->h) + GET_PKT_LEN(rp);
+ } else {
+ pl->h->caplen = GET_PKT_LEN(p);
+ pl->h->len = GET_PKT_LEN(p);
+ len = sizeof(*pl->h) + GET_PKT_LEN(p);
+ }
+ }
+ }
+
+ if (IS_TUNNEL_PKT(p) && !IS_TUNNEL_ROOT_PKT(p)) {
+ rp = p->root;
+#ifdef HAVE_LIBLZ4
+ ret = PcapWrite(pl, comp, GET_PKT_DATA(rp), len);
+#else
+ ret = PcapWrite(pl, NULL, GET_PKT_DATA(rp), len);
+#endif
+ } else {
+#ifdef HAVE_LIBLZ4
+ ret = PcapWrite(pl, comp, GET_PKT_DATA(p), len);
+#else
+ ret = PcapWrite(pl, NULL, GET_PKT_DATA(p), len);
+#endif
+ }
+ if (ret != TM_ECODE_OK) {
+ PCAPLOG_PROFILE_END(pl->profile_write);
+ PcapLogUnlock(pl);
+ return ret;
+ }
+
+ PCAPLOG_PROFILE_END(pl->profile_write);
+ pl->profile_data_size += len;
+
+ SCLogDebug("pl->size_current %"PRIu64", pl->size_limit %"PRIu64,
+ pl->size_current, pl->size_limit);
+
+ PcapLogUnlock(pl);
+ return TM_ECODE_OK;
+}
+
+static PcapLogData *PcapLogDataCopy(const PcapLogData *pl)
+{
+ BUG_ON(pl->mode != LOGMODE_MULTI);
+ PcapLogData *copy = SCCalloc(1, sizeof(*copy));
+ if (unlikely(copy == NULL)) {
+ return NULL;
+ }
+
+ copy->h = SCCalloc(1, sizeof(*copy->h));
+ if (unlikely(copy->h == NULL)) {
+ SCFree(copy);
+ return NULL;
+ }
+
+ copy->prefix = SCStrdup(pl->prefix);
+ if (unlikely(copy->prefix == NULL)) {
+ SCFree(copy->h);
+ SCFree(copy);
+ return NULL;
+ }
+
+ copy->suffix = pl->suffix;
+
+ /* settings TODO move to global cfg struct */
+ copy->is_private = TRUE;
+ copy->mode = pl->mode;
+ copy->max_files = pl->max_files;
+ copy->use_ringbuffer = pl->use_ringbuffer;
+ copy->timestamp_format = pl->timestamp_format;
+ copy->use_stream_depth = pl->use_stream_depth;
+ copy->size_limit = pl->size_limit;
+ copy->conditional = pl->conditional;
+
+ const PcapLogCompressionData *comp = &pl->compression;
+ PcapLogCompressionData *copy_comp = &copy->compression;
+ copy_comp->format = comp->format;
+#ifdef HAVE_LIBLZ4
+ if (comp->format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ /* We need to allocate a new compression context and buffers for
+ * the copy. First copy the things that can simply be copied. */
+
+ copy_comp->buffer_size = comp->buffer_size;
+ copy_comp->pcap_buf_size = comp->pcap_buf_size;
+ copy_comp->lz4f_prefs = comp->lz4f_prefs;
+
+ /* Allocate the buffers. */
+
+ copy_comp->buffer = SCMalloc(copy_comp->buffer_size);
+ if (copy_comp->buffer == NULL) {
+ SCLogError("SCMalloc failed: %s", strerror(errno));
+ SCFree(copy->h);
+ SCFree(copy);
+ return NULL;
+ }
+ copy_comp->pcap_buf = SCMalloc(copy_comp->pcap_buf_size);
+ if (copy_comp->pcap_buf == NULL) {
+ SCLogError("SCMalloc failed: %s", strerror(errno));
+ SCFree(copy_comp->buffer);
+ SCFree(copy->h);
+ SCFree(copy);
+ return NULL;
+ }
+ copy_comp->pcap_buf_wrapper = SCFmemopen(copy_comp->pcap_buf,
+ copy_comp->pcap_buf_size, "w");
+ if (copy_comp->pcap_buf_wrapper == NULL) {
+ SCLogError("SCFmemopen failed: %s", strerror(errno));
+ SCFree(copy_comp->buffer);
+ SCFree(copy_comp->pcap_buf);
+ SCFree(copy->h);
+ SCFree(copy);
+ return NULL;
+ }
+
+ /* Initialize a new compression context. */
+
+ LZ4F_errorCode_t errcode =
+ LZ4F_createCompressionContext(&copy_comp->lz4f_context, 1);
+ if (LZ4F_isError(errcode)) {
+ SCLogError("LZ4F_createCompressionContext failed: %s", LZ4F_getErrorName(errcode));
+ fclose(copy_comp->pcap_buf_wrapper);
+ SCFree(copy_comp->buffer);
+ SCFree(copy_comp->pcap_buf);
+ SCFree(copy->h);
+ SCFree(copy);
+ return NULL;
+ }
+
+ /* Initialize the rest. */
+
+ copy_comp->file = NULL;
+ copy_comp->bytes_in_block = 0;
+ }
+#endif /* HAVE_LIBLZ4 */
+
+ TAILQ_INIT(&copy->pcap_file_list);
+ SCMutexInit(&copy->plog_lock, NULL);
+
+ strlcpy(copy->dir, pl->dir, sizeof(copy->dir));
+
+ int i;
+ for (i = 0; i < pl->filename_part_cnt && i < MAX_TOKS; i++)
+ copy->filename_parts[i] = pl->filename_parts[i];
+ copy->filename_part_cnt = pl->filename_part_cnt;
+
+ /* set thread number, first thread is 1 */
+ copy->thread_number = SC_ATOMIC_ADD(thread_cnt, 1);
+
+ SCLogDebug("copied, returning %p", copy);
+ return copy;
+}
+
+#ifdef INIT_RING_BUFFER
+static int PcapLogGetTimeOfFile(const char *filename, uint64_t *secs,
+ uint32_t *usecs)
+{
+ char buf[PATH_MAX];
+ size_t copylen;
+
+ int n = pcre2_match(pcre_timestamp_code, (PCRE2_SPTR8)filename, strlen(filename), 0, 0,
+ pcre_timestamp_match, NULL);
+ if (n != 2 && n != 4) {
+ /* No match. */
+ return 0;
+ }
+
+ if (n >= 2) {
+ /* Extract seconds. */
+ copylen = sizeof(buf);
+ if (pcre2_substring_copy_bynumber(pcre_timestamp_match, 1, (PCRE2_UCHAR8 *)buf, &copylen) <
+ 0) {
+ return 0;
+ }
+ if (StringParseUint64(secs, 10, 0, buf) < 0) {
+ return 0;
+ }
+ }
+ if (n == 4) {
+ /* Extract microseconds. */
+ copylen = sizeof(buf);
+ if (pcre2_substring_copy_bynumber(pcre_timestamp_match, 3, (PCRE2_UCHAR8 *)buf, &copylen) <
+ 0) {
+ return 0;
+ }
+ if (StringParseUint32(usecs, 10, 0, buf) < 0) {
+ return 0;
+ }
+ }
+
+ return 1;
+}
+
+static TmEcode PcapLogInitRingBuffer(PcapLogData *pl)
+{
+ char pattern[PATH_MAX];
+
+ SCLogInfo("Initializing PCAP ring buffer for %s/%s.",
+ pl->dir, pl->prefix);
+
+ strlcpy(pattern, pl->dir, PATH_MAX);
+ if (pattern[strlen(pattern) - 1] != '/') {
+ strlcat(pattern, "/", PATH_MAX);
+ }
+ if (pl->mode == LOGMODE_MULTI) {
+ for (int i = 0; i < pl->filename_part_cnt; i++) {
+ char *part = pl->filename_parts[i];
+ if (part == NULL || strlen(part) == 0) {
+ continue;
+ }
+ if (part[0] != '%' || strlen(part) < 2) {
+ strlcat(pattern, part, PATH_MAX);
+ continue;
+ }
+ switch (part[1]) {
+ case 'i':
+ SCLogError("Thread ID not allowed in ring buffer mode.");
+ return TM_ECODE_FAILED;
+ case 'n': {
+ char tmp[PATH_MAX];
+ snprintf(tmp, PATH_MAX, "%"PRIu32, pl->thread_number);
+ strlcat(pattern, tmp, PATH_MAX);
+ break;
+ }
+ case 't':
+ strlcat(pattern, "*", PATH_MAX);
+ break;
+ default:
+ SCLogError("Unsupported format character: %%%s", part);
+ return TM_ECODE_FAILED;
+ }
+ }
+ } else {
+ strlcat(pattern, pl->prefix, PATH_MAX);
+ strlcat(pattern, ".*", PATH_MAX);
+ }
+ strlcat(pattern, pl->suffix, PATH_MAX);
+
+ char *basename = strrchr(pattern, '/');
+ *basename++ = '\0';
+
+ /* Pattern is now just the directory name. */
+ DIR *dir = opendir(pattern);
+ if (dir == NULL) {
+ SCLogWarning("Failed to open directory %s: %s", pattern, strerror(errno));
+ return TM_ECODE_FAILED;
+ }
+
+ for (;;) {
+ struct dirent *entry = readdir(dir);
+ if (entry == NULL) {
+ break;
+ }
+ if (fnmatch(basename, entry->d_name, 0) != 0) {
+ continue;
+ }
+
+ uint64_t secs = 0;
+ uint32_t usecs = 0;
+
+ if (!PcapLogGetTimeOfFile(entry->d_name, &secs, &usecs)) {
+ /* Failed to get time stamp out of file name. Not necessarily a
+ * failure as the file might just not be a pcap log file. */
+ continue;
+ }
+
+ PcapFileName *pf = SCCalloc(sizeof(*pf), 1);
+ if (unlikely(pf == NULL)) {
+ goto fail;
+ }
+ char path[PATH_MAX];
+ if (snprintf(path, PATH_MAX, "%s/%s", pattern, entry->d_name) == PATH_MAX)
+ goto fail;
+
+ if ((pf->filename = SCStrdup(path)) == NULL) {
+ goto fail;
+ }
+ if ((pf->dirname = SCStrdup(pattern)) == NULL) {
+ goto fail;
+ }
+ pf->secs = secs;
+ pf->usecs = usecs;
+
+ if (TAILQ_EMPTY(&pl->pcap_file_list)) {
+ TAILQ_INSERT_TAIL(&pl->pcap_file_list, pf, next);
+ } else {
+ /* Ordered insert. */
+ PcapFileName *it = NULL;
+ TAILQ_FOREACH(it, &pl->pcap_file_list, next) {
+ if (pf->secs < it->secs) {
+ break;
+ } else if (pf->secs == it->secs && pf->usecs < it->usecs) {
+ break;
+ }
+ }
+ if (it == NULL) {
+ TAILQ_INSERT_TAIL(&pl->pcap_file_list, pf, next);
+ } else {
+ TAILQ_INSERT_BEFORE(it, pf, next);
+ }
+ }
+ pl->file_cnt++;
+ continue;
+
+ fail:
+ if (pf != NULL) {
+ if (pf->filename != NULL) {
+ SCFree(pf->filename);
+ }
+ if (pf->dirname != NULL) {
+ SCFree(pf->dirname);
+ }
+ SCFree(pf);
+ }
+ break;
+ }
+
+ if (pl->file_cnt > pl->max_files) {
+ PcapFileName *pf = TAILQ_FIRST(&pl->pcap_file_list);
+ while (pf != NULL && pl->file_cnt > pl->max_files) {
+ TAILQ_REMOVE(&pl->pcap_file_list, pf, next);
+
+ SCLogDebug("Removing PCAP file %s", pf->filename);
+ if (remove(pf->filename) != 0) {
+ SCLogWarning("Failed to remove PCAP file %s: %s", pf->filename, strerror(errno));
+ }
+ PcapFileNameFree(pf);
+ pl->file_cnt--;
+
+ pf = TAILQ_FIRST(&pl->pcap_file_list);
+ }
+ }
+
+ closedir(dir);
+
+ /* For some reason file count is initialized at one, instead of 0. */
+ SCLogNotice("Ring buffer initialized with %d files.", pl->file_cnt - 1);
+
+ return TM_ECODE_OK;
+}
+#endif /* INIT_RING_BUFFER */
+
+static TmEcode PcapLogDataInit(ThreadVars *t, const void *initdata, void **data)
+{
+ if (initdata == NULL) {
+ SCLogDebug("Error getting context for LogPcap. \"initdata\" argument NULL");
+ return TM_ECODE_FAILED;
+ }
+
+ PcapLogData *pl = ((OutputCtx *)initdata)->data;
+
+ PcapLogThreadData *td = SCCalloc(1, sizeof(*td));
+ if (unlikely(td == NULL))
+ return TM_ECODE_FAILED;
+
+ if (pl->mode == LOGMODE_MULTI)
+ td->pcap_log = PcapLogDataCopy(pl);
+ else
+ td->pcap_log = pl;
+ BUG_ON(td->pcap_log == NULL);
+
+ if (DatalinkHasMultipleValues()) {
+ if (pl->mode != LOGMODE_MULTI) {
+ FatalError("Pcap logging with multiple link type is not supported.");
+ } else {
+ /* In multi mode, only pcap conditional is not supported as a flow timeout
+ * will trigger packet logging with potentially invalid datalink. In regular
+ * pcap logging, the logging should be done in the same thread if we
+ * have a proper load balancing. So no mix of datalink should occur. But we need a
+ * proper load balancing so this needs at least a warning.
+ */
+ switch (pl->conditional) {
+ case LOGMODE_COND_ALERTS:
+ case LOGMODE_COND_TAG:
+ FatalError("Can't have multiple link types in pcap conditional mode.");
+ break;
+ default:
+ SCLogWarning("Using multiple link types can result in invalid pcap output");
+ }
+ }
+ }
+
+ PcapLogLock(td->pcap_log);
+
+ /** Use the Output Context (file pointer and mutex) */
+ td->pcap_log->pkt_cnt = 0;
+ td->pcap_log->pcap_dead_handle = NULL;
+ td->pcap_log->pcap_dumper = NULL;
+ if (td->pcap_log->file_cnt < 1) {
+ td->pcap_log->file_cnt = 1;
+ }
+
+ SCTime_t ts = TimeGet();
+ struct tm local_tm;
+ struct tm *tms = SCLocalTime(SCTIME_SECS(ts), &local_tm);
+ td->pcap_log->prev_day = tms->tm_mday;
+
+ PcapLogUnlock(td->pcap_log);
+
+ /* count threads in the global structure */
+ SCMutexLock(&pl->plog_lock);
+ pl->threads++;
+ SCMutexUnlock(&pl->plog_lock);
+
+ *data = (void *)td;
+
+ if (IsTcpSessionDumpingEnabled()) {
+ td->buf = MemBufferCreateNew(PCAP_OUTPUT_BUFFER_SIZE);
+ } else {
+ td->buf = NULL;
+ }
+
+ if (pl->max_files && (pl->mode == LOGMODE_MULTI || pl->threads == 1)) {
+#ifdef INIT_RING_BUFFER
+ if (PcapLogInitRingBuffer(td->pcap_log) == TM_ECODE_FAILED) {
+ return TM_ECODE_FAILED;
+ }
+#else
+ SCLogInfo("Unable to initialize ring buffer on this platform.");
+#endif /* INIT_RING_BUFFER */
+ }
+
+ /* Don't early initialize output files if in a PCAP file (offline)
+ * mode. */
+ if (!IsRunModeOffline(RunmodeGetCurrent())) {
+ if (pl->mode == LOGMODE_MULTI) {
+ PcapLogOpenFileCtx(td->pcap_log);
+ } else {
+ if (pl->filename == NULL) {
+ PcapLogOpenFileCtx(pl);
+ }
+ }
+ }
+
+ return TM_ECODE_OK;
+}
+
+static void StatsMerge(PcapLogData *dst, PcapLogData *src)
+{
+ dst->profile_open.total += src->profile_open.total;
+ dst->profile_open.cnt += src->profile_open.cnt;
+
+ dst->profile_close.total += src->profile_close.total;
+ dst->profile_close.cnt += src->profile_close.cnt;
+
+ dst->profile_write.total += src->profile_write.total;
+ dst->profile_write.cnt += src->profile_write.cnt;
+
+ dst->profile_rotate.total += src->profile_rotate.total;
+ dst->profile_rotate.cnt += src->profile_rotate.cnt;
+
+ dst->profile_handles.total += src->profile_handles.total;
+ dst->profile_handles.cnt += src->profile_handles.cnt;
+
+ dst->profile_lock.total += src->profile_lock.total;
+ dst->profile_lock.cnt += src->profile_lock.cnt;
+
+ dst->profile_unlock.total += src->profile_unlock.total;
+ dst->profile_unlock.cnt += src->profile_unlock.cnt;
+
+ dst->profile_data_size += src->profile_data_size;
+}
+
+static void PcapLogDataFree(PcapLogData *pl)
+{
+
+ PcapFileName *pf;
+ while ((pf = TAILQ_FIRST(&pl->pcap_file_list)) != NULL) {
+ TAILQ_REMOVE(&pl->pcap_file_list, pf, next);
+ PcapFileNameFree(pf);
+ }
+ if (pl == g_pcap_data) {
+ for (int i = 0; i < MAX_TOKS; i++) {
+ if (pl->filename_parts[i] != NULL) {
+ SCFree(pl->filename_parts[i]);
+ }
+ }
+ }
+ SCFree(pl->h);
+ SCFree(pl->filename);
+ SCFree(pl->prefix);
+
+ if (pl->pcap_dead_handle) {
+ pcap_close(pl->pcap_dead_handle);
+ }
+
+#ifdef HAVE_LIBLZ4
+ if (pl->compression.format == PCAP_LOG_COMPRESSION_FORMAT_LZ4) {
+ SCFree(pl->compression.buffer);
+ fclose(pl->compression.pcap_buf_wrapper);
+ SCFree(pl->compression.pcap_buf);
+ LZ4F_errorCode_t errcode =
+ LZ4F_freeCompressionContext(pl->compression.lz4f_context);
+ if (LZ4F_isError(errcode)) {
+ SCLogWarning("Error freeing lz4 context.");
+ }
+ }
+#endif /* HAVE_LIBLZ4 */
+ SCFree(pl);
+}
+
+/**
+ * \brief Thread deinit function.
+ *
+ * \param t Thread Variable containing input/output queue, cpu affinity etc.
+ * \param data PcapLog thread data.
+ * \retval TM_ECODE_OK on success
+ * \retval TM_ECODE_FAILED on failure
+ */
+static TmEcode PcapLogDataDeinit(ThreadVars *t, void *thread_data)
+{
+ PcapLogThreadData *td = (PcapLogThreadData *)thread_data;
+ PcapLogData *pl = td->pcap_log;
+
+ if (pl->pcap_dumper != NULL) {
+ if (PcapLogCloseFile(t,pl) < 0) {
+ SCLogDebug("PcapLogCloseFile failed");
+ }
+ }
+
+ if (pl->mode == LOGMODE_MULTI) {
+ SCMutexLock(&g_pcap_data->plog_lock);
+ StatsMerge(g_pcap_data, pl);
+ g_pcap_data->reported++;
+ if (g_pcap_data->threads == g_pcap_data->reported)
+ PcapLogProfilingDump(g_pcap_data);
+ SCMutexUnlock(&g_pcap_data->plog_lock);
+ } else {
+ if (pl->reported == 0) {
+ PcapLogProfilingDump(pl);
+ pl->reported = 1;
+ }
+ }
+
+ if (pl != g_pcap_data) {
+ PcapLogDataFree(pl);
+ }
+
+ if (td->buf)
+ MemBufferFree(td->buf);
+
+ SCFree(td);
+ return TM_ECODE_OK;
+}
+
+
+static int ParseFilename(PcapLogData *pl, const char *filename)
+{
+ char *toks[MAX_TOKS] = { NULL };
+ int tok = 0;
+ char str[MAX_FILENAMELEN] = "";
+ int s = 0;
+ int i, x;
+ char *p = NULL;
+ size_t filename_len = 0;
+
+ if (filename) {
+ filename_len = strlen(filename);
+ if (filename_len > (MAX_FILENAMELEN-1)) {
+ SCLogError("invalid filename option. Max filename-length: %d", MAX_FILENAMELEN - 1);
+ goto error;
+ }
+
+ for (i = 0; i < (int)strlen(filename); i++) {
+ if (tok >= MAX_TOKS) {
+ SCLogError("invalid filename option. Max 2 %%-sign options");
+ goto error;
+ }
+
+ str[s++] = filename[i];
+
+ if (filename[i] == '%') {
+ str[s-1] = '\0';
+ SCLogDebug("filename with %%-sign: %s", str);
+
+ p = SCStrdup(str);
+ if (p == NULL)
+ goto error;
+ toks[tok++] = p;
+
+ s = 0;
+
+ if (i+1 < (int)strlen(filename)) {
+ if (tok >= MAX_TOKS) {
+ SCLogError("invalid filename option. Max 2 %%-sign options");
+ goto error;
+ }
+
+ if (filename[i+1] != 'n' && filename[i+1] != 't' && filename[i+1] != 'i') {
+ SCLogError(
+ "invalid filename option. Valid %%-sign options: %%n, %%i and %%t");
+ goto error;
+ }
+ str[0] = '%';
+ str[1] = filename[i+1];
+ str[2] = '\0';
+ p = SCStrdup(str);
+ if (p == NULL)
+ goto error;
+ toks[tok++] = p;
+ i++;
+ }
+ }
+ }
+
+ if ((tok == 0) && (pl->mode == LOGMODE_MULTI)) {
+ SCLogError("Invalid filename for multimode. Need at least one %%-sign option");
+ goto error;
+ }
+
+ if (s) {
+ if (tok >= MAX_TOKS) {
+ SCLogError("invalid filename option. Max 3 %%-sign options");
+ goto error;
+
+ }
+ str[s++] = '\0';
+ p = SCStrdup(str);
+ if (p == NULL)
+ goto error;
+ toks[tok++] = p;
+ }
+
+ /* finally, store tokens in the pl */
+ for (i = 0; i < tok; i++) {
+ if (toks[i] == NULL)
+ goto error;
+
+ SCLogDebug("toks[%d] %s", i, toks[i]);
+ pl->filename_parts[i] = toks[i];
+ }
+ pl->filename_part_cnt = tok;
+ }
+ return 0;
+error:
+ for (x = 0; x < MAX_TOKS; x++) {
+ if (toks[x] != NULL)
+ SCFree(toks[x]);
+ }
+ return -1;
+}
+
+/** \brief Fill in pcap logging struct from the provided ConfNode.
+ * \param conf The configuration node for this output.
+ * \retval output_ctx
+ * */
+static OutputInitResult PcapLogInitCtx(ConfNode *conf)
+{
+ OutputInitResult result = { NULL, false };
+ int en;
+ PCRE2_SIZE eo = 0;
+
+ PcapLogData *pl = SCMalloc(sizeof(PcapLogData));
+ if (unlikely(pl == NULL)) {
+ FatalError("Failed to allocate Memory for PcapLogData");
+ }
+ memset(pl, 0, sizeof(PcapLogData));
+
+ pl->h = SCMalloc(sizeof(*pl->h));
+ if (pl->h == NULL) {
+ FatalError("Failed to allocate Memory for pcap header struct");
+ }
+
+ /* Set the defaults */
+ pl->mode = LOGMODE_NORMAL;
+ pl->max_files = DEFAULT_FILE_LIMIT;
+ pl->use_ringbuffer = RING_BUFFER_MODE_DISABLED;
+ pl->timestamp_format = TS_FORMAT_SEC;
+ pl->use_stream_depth = USE_STREAM_DEPTH_DISABLED;
+ pl->honor_pass_rules = HONOR_PASS_RULES_DISABLED;
+ pl->conditional = LOGMODE_COND_ALL;
+
+ TAILQ_INIT(&pl->pcap_file_list);
+
+ SCMutexInit(&pl->plog_lock, NULL);
+
+ /* Initialize PCREs. */
+ pcre_timestamp_code =
+ pcre2_compile((PCRE2_SPTR8)timestamp_pattern, PCRE2_ZERO_TERMINATED, 0, &en, &eo, NULL);
+ if (pcre_timestamp_code == NULL) {
+ PCRE2_UCHAR errbuffer[256];
+ pcre2_get_error_message(en, errbuffer, sizeof(errbuffer));
+ FatalError(
+ "Failed to compile \"%s\" at offset %d: %s", timestamp_pattern, (int)eo, errbuffer);
+ }
+ pcre_timestamp_match = pcre2_match_data_create_from_pattern(pcre_timestamp_code, NULL);
+
+ /* conf params */
+
+ const char *filename = NULL;
+
+ if (conf != NULL) { /* To facilitate unit tests. */
+ filename = ConfNodeLookupChildValue(conf, "filename");
+ }
+
+ if (filename == NULL)
+ filename = DEFAULT_LOG_FILENAME;
+
+ if ((pl->prefix = SCStrdup(filename)) == NULL) {
+ exit(EXIT_FAILURE);
+ }
+
+ pl->suffix = "";
+
+ pl->size_limit = DEFAULT_LIMIT;
+ if (conf != NULL) {
+ const char *s_limit = NULL;
+ s_limit = ConfNodeLookupChildValue(conf, "limit");
+ if (s_limit != NULL) {
+ if (ParseSizeStringU64(s_limit, &pl->size_limit) < 0) {
+ SCLogError("Failed to initialize pcap output, invalid limit: %s", s_limit);
+ exit(EXIT_FAILURE);
+ }
+ if (pl->size_limit < 4096) {
+ SCLogInfo("pcap-log \"limit\" value of %"PRIu64" assumed to be pre-1.2 "
+ "style: setting limit to %"PRIu64"mb", pl->size_limit, pl->size_limit);
+ uint64_t size = pl->size_limit * 1024 * 1024;
+ pl->size_limit = size;
+ } else if (pl->size_limit < MIN_LIMIT) {
+ FatalError("Fail to initialize pcap-log output, limit less than "
+ "allowed minimum of %d bytes.",
+ MIN_LIMIT);
+ }
+ }
+ }
+
+ if (conf != NULL) {
+ const char *s_mode = NULL;
+ s_mode = ConfNodeLookupChildValue(conf, "mode");
+ if (s_mode != NULL) {
+ if (strcasecmp(s_mode, "sguil") == 0) {
+ pl->mode = LOGMODE_SGUIL;
+ SCLogWarning("sguil mode is deprecated and will be removed from Suricata 8; see "
+ "issue 6688");
+ } else if (strcasecmp(s_mode, "multi") == 0) {
+ pl->mode = LOGMODE_MULTI;
+ } else if (strcasecmp(s_mode, "normal") != 0) {
+ SCLogError("log-pcap: invalid mode \"%s\". Valid options: \"normal\", "
+ "\"sguil\", or \"multi\" mode ",
+ s_mode);
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ const char *s_dir = NULL;
+ s_dir = ConfNodeLookupChildValue(conf, "dir");
+ if (s_dir == NULL) {
+ s_dir = ConfNodeLookupChildValue(conf, "sguil-base-dir");
+ }
+ if (s_dir == NULL) {
+ if (pl->mode == LOGMODE_SGUIL) {
+ FatalError("log-pcap \"sguil\" mode requires \"sguil-base-dir\" "
+ "option to be set.");
+ } else {
+ const char *log_dir = NULL;
+ log_dir = ConfigGetLogDirectory();
+
+ strlcpy(pl->dir,
+ log_dir, sizeof(pl->dir));
+ SCLogInfo("Using log dir %s", pl->dir);
+ }
+ } else {
+ if (PathIsAbsolute(s_dir)) {
+ strlcpy(pl->dir,
+ s_dir, sizeof(pl->dir));
+ } else {
+ const char *log_dir = NULL;
+ log_dir = ConfigGetLogDirectory();
+
+ snprintf(pl->dir, sizeof(pl->dir), "%s/%s",
+ log_dir, s_dir);
+ }
+
+ struct stat stat_buf;
+ if (stat(pl->dir, &stat_buf) != 0) {
+ SCLogError("The sguil-base-dir directory \"%s\" "
+ "supplied doesn't exist. Shutting down the engine",
+ pl->dir);
+ exit(EXIT_FAILURE);
+ }
+ SCLogInfo("Using log dir %s", pl->dir);
+ }
+
+ const char *compression_str = ConfNodeLookupChildValue(conf,
+ "compression");
+
+ PcapLogCompressionData *comp = &pl->compression;
+ if (compression_str == NULL || strcmp(compression_str, "none") == 0) {
+ comp->format = PCAP_LOG_COMPRESSION_FORMAT_NONE;
+ comp->buffer = NULL;
+ comp->buffer_size = 0;
+ comp->file = NULL;
+ comp->pcap_buf = NULL;
+ comp->pcap_buf_size = 0;
+ comp->pcap_buf_wrapper = NULL;
+ } else if (strcmp(compression_str, "lz4") == 0) {
+#ifdef HAVE_LIBLZ4
+ if (pl->mode == LOGMODE_SGUIL) {
+ SCLogError("Compressed pcap "
+ "logs are not possible in sguil mode");
+ SCFree(pl->h);
+ SCFree(pl);
+ return result;
+ }
+ pl->compression.format = PCAP_LOG_COMPRESSION_FORMAT_LZ4;
+
+ /* Use SCFmemopen so we can make pcap_dump write to a buffer. */
+
+ comp->pcap_buf_size = sizeof(struct pcap_file_header) +
+ sizeof(struct pcap_pkthdr) + PCAP_SNAPLEN;
+ comp->pcap_buf = SCMalloc(comp->pcap_buf_size);
+ if (comp->pcap_buf == NULL) {
+ SCLogError("SCMalloc failed: %s", strerror(errno));
+ exit(EXIT_FAILURE);
+ }
+ comp->pcap_buf_wrapper = SCFmemopen(comp->pcap_buf,
+ comp->pcap_buf_size, "w");
+ if (comp->pcap_buf_wrapper == NULL) {
+ SCLogError("SCFmemopen failed: %s", strerror(errno));
+ exit(EXIT_FAILURE);
+ }
+
+ /* Set lz4 preferences. */
+
+ memset(&comp->lz4f_prefs, '\0', sizeof(comp->lz4f_prefs));
+ comp->lz4f_prefs.frameInfo.blockSizeID = LZ4F_max4MB;
+ comp->lz4f_prefs.frameInfo.blockMode = LZ4F_blockLinked;
+ if (ConfNodeChildValueIsTrue(conf, "lz4-checksum")) {
+ comp->lz4f_prefs.frameInfo.contentChecksumFlag = 1;
+ }
+ else {
+ comp->lz4f_prefs.frameInfo.contentChecksumFlag = 0;
+ }
+ intmax_t lvl = 0;
+ if (ConfGetChildValueInt(conf, "lz4-level", &lvl)) {
+ if (lvl > 16) {
+ lvl = 16;
+ } else if (lvl < 0) {
+ lvl = 0;
+ }
+ } else {
+ lvl = 0;
+ }
+ comp->lz4f_prefs.compressionLevel = lvl;
+
+ /* Allocate resources for lz4. */
+
+ LZ4F_errorCode_t errcode =
+ LZ4F_createCompressionContext(&pl->compression.lz4f_context, 1);
+
+ if (LZ4F_isError(errcode)) {
+ SCLogError("LZ4F_createCompressionContext failed: %s", LZ4F_getErrorName(errcode));
+ exit(EXIT_FAILURE);
+ }
+
+ /* Calculate the size of the lz4 output buffer. */
+
+ comp->buffer_size = LZ4F_compressBound(comp->pcap_buf_size,
+ &comp->lz4f_prefs);
+
+ comp->buffer = SCMalloc(comp->buffer_size);
+ if (unlikely(comp->buffer == NULL)) {
+ FatalError("Failed to allocate memory for "
+ "lz4 output buffer.");
+ }
+
+ comp->bytes_in_block = 0;
+
+ /* Add the lz4 file extension to the log files. */
+
+ pl->suffix = ".lz4";
+#else
+ SCLogError("lz4 compression was selected "
+ "in pcap-log, but suricata was not compiled with lz4 "
+ "support.");
+ PcapLogDataFree(pl);
+ return result;
+#endif /* HAVE_LIBLZ4 */
+ }
+ else {
+ SCLogError("Unsupported pcap-log "
+ "compression format: %s",
+ compression_str);
+ PcapLogDataFree(pl);
+ return result;
+ }
+
+ SCLogInfo("Selected pcap-log compression method: %s",
+ compression_str ? compression_str : "none");
+
+ const char *s_conditional = ConfNodeLookupChildValue(conf, "conditional");
+ if (s_conditional != NULL) {
+ if (strcasecmp(s_conditional, "alerts") == 0) {
+ pl->conditional = LOGMODE_COND_ALERTS;
+ EnableTcpSessionDumping();
+ } else if (strcasecmp(s_conditional, "tag") == 0) {
+ pl->conditional = LOGMODE_COND_TAG;
+ EnableTcpSessionDumping();
+ } else if (strcasecmp(s_conditional, "all") != 0) {
+ FatalError("log-pcap: invalid conditional \"%s\". Valid options: \"all\", "
+ "\"alerts\", or \"tag\" mode ",
+ s_conditional);
+ }
+ }
+
+ SCLogInfo(
+ "Selected pcap-log conditional logging: %s", s_conditional ? s_conditional : "all");
+ }
+
+ if (ParseFilename(pl, filename) != 0)
+ exit(EXIT_FAILURE);
+
+ SCLogInfo("using %s logging", pl->mode == LOGMODE_SGUIL ?
+ "Sguil compatible" : (pl->mode == LOGMODE_MULTI ? "multi" : "normal"));
+
+ uint32_t max_file_limit = DEFAULT_FILE_LIMIT;
+ if (conf != NULL) {
+ const char *max_number_of_files_s = NULL;
+ max_number_of_files_s = ConfNodeLookupChildValue(conf, "max-files");
+ if (max_number_of_files_s != NULL) {
+ if (StringParseUint32(&max_file_limit, 10, 0,
+ max_number_of_files_s) == -1) {
+ SCLogError("Failed to initialize "
+ "pcap-log output, invalid number of files limit: %s",
+ max_number_of_files_s);
+ exit(EXIT_FAILURE);
+ } else if (max_file_limit < 1) {
+ FatalError("Failed to initialize pcap-log output, limit less than "
+ "allowed minimum.");
+ } else {
+ pl->max_files = max_file_limit;
+ pl->use_ringbuffer = RING_BUFFER_MODE_ENABLED;
+ }
+ }
+ }
+
+ const char *ts_format = NULL;
+ if (conf != NULL) { /* To facilitate unit tests. */
+ ts_format = ConfNodeLookupChildValue(conf, "ts-format");
+ }
+ if (ts_format != NULL) {
+ if (strcasecmp(ts_format, "usec") == 0) {
+ pl->timestamp_format = TS_FORMAT_USEC;
+ } else if (strcasecmp(ts_format, "sec") != 0) {
+ SCLogError("log-pcap ts_format specified %s is invalid must be"
+ " \"sec\" or \"usec\"",
+ ts_format);
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ const char *use_stream_depth = NULL;
+ if (conf != NULL) { /* To facilitate unit tests. */
+ use_stream_depth = ConfNodeLookupChildValue(conf, "use-stream-depth");
+ }
+ if (use_stream_depth != NULL) {
+ if (ConfValIsFalse(use_stream_depth)) {
+ pl->use_stream_depth = USE_STREAM_DEPTH_DISABLED;
+ } else if (ConfValIsTrue(use_stream_depth)) {
+ pl->use_stream_depth = USE_STREAM_DEPTH_ENABLED;
+ } else {
+ FatalError("log-pcap use_stream_depth specified is invalid must be");
+ }
+ }
+
+ const char *honor_pass_rules = NULL;
+ if (conf != NULL) { /* To facilitate unit tests. */
+ honor_pass_rules = ConfNodeLookupChildValue(conf, "honor-pass-rules");
+ }
+ if (honor_pass_rules != NULL) {
+ if (ConfValIsFalse(honor_pass_rules)) {
+ pl->honor_pass_rules = HONOR_PASS_RULES_DISABLED;
+ } else if (ConfValIsTrue(honor_pass_rules)) {
+ pl->honor_pass_rules = HONOR_PASS_RULES_ENABLED;
+ } else {
+ FatalError("log-pcap honor-pass-rules specified is invalid");
+ }
+ }
+
+ /* create the output ctx and send it back */
+
+ OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
+ if (unlikely(output_ctx == NULL)) {
+ FatalError("Failed to allocate memory for OutputCtx.");
+ }
+ output_ctx->data = pl;
+ output_ctx->DeInit = PcapLogFileDeInitCtx;
+ g_pcap_data = pl;
+
+ result.ctx = output_ctx;
+ result.ok = true;
+ return result;
+}
+
+static void PcapLogFileDeInitCtx(OutputCtx *output_ctx)
+{
+ if (output_ctx == NULL)
+ return;
+
+ PcapLogData *pl = output_ctx->data;
+
+ PcapFileName *pf = NULL;
+ TAILQ_FOREACH(pf, &pl->pcap_file_list, next) {
+ SCLogDebug("PCAP files left at exit: %s\n", pf->filename);
+ }
+ PcapLogDataFree(pl);
+ SCFree(output_ctx);
+
+ pcre2_code_free(pcre_timestamp_code);
+ pcre2_match_data_free(pcre_timestamp_match);
+
+ return;
+}
+
+/**
+ * \brief Read the config set the file pointer, open the file
+ *
+ * \param PcapLogData.
+ *
+ * \retval -1 if failure
+ * \retval 0 if succesful
+ */
+static int PcapLogOpenFileCtx(PcapLogData *pl)
+{
+ char *filename = NULL;
+
+ PCAPLOG_PROFILE_START;
+
+ if (pl->filename != NULL)
+ filename = pl->filename;
+ else {
+ filename = SCMalloc(PATH_MAX);
+ if (unlikely(filename == NULL)) {
+ return -1;
+ }
+ pl->filename = filename;
+ }
+
+ /** get the time so we can have a filename with seconds since epoch */
+ SCTime_t ts = TimeGet();
+
+ /* Place to store the name of our PCAP file */
+ PcapFileName *pf = SCMalloc(sizeof(PcapFileName));
+ if (unlikely(pf == NULL)) {
+ return -1;
+ }
+ memset(pf, 0, sizeof(PcapFileName));
+
+ if (pl->mode == LOGMODE_SGUIL) {
+ struct tm local_tm;
+ struct tm *tms = SCLocalTime(SCTIME_SECS(ts), &local_tm);
+
+ char dirname[32], dirfull[PATH_MAX] = "";
+
+ snprintf(dirname, sizeof(dirname), "%04d-%02d-%02d",
+ tms->tm_year + 1900, tms->tm_mon + 1, tms->tm_mday);
+
+ /* create the filename to use */
+ int ret = snprintf(dirfull, sizeof(dirfull), "%s/%s", pl->dir, dirname);
+ if (ret < 0 || (size_t)ret >= sizeof(dirfull)) {
+ SCLogError("failed to construct path");
+ goto error;
+ }
+
+ /* if mkdir fails file open will fail, so deal with errors there */
+ (void)SCMkDir(dirfull, 0700);
+
+ if ((pf->dirname = SCStrdup(dirfull)) == NULL) {
+ SCLogError("Error allocating memory for "
+ "directory name");
+ goto error;
+ }
+
+ int written;
+ if (pl->timestamp_format == TS_FORMAT_SEC) {
+ written = snprintf(filename, PATH_MAX, "%s/%s.%" PRIu32 "%s", dirfull, pl->prefix,
+ (uint32_t)SCTIME_SECS(ts), pl->suffix);
+ } else {
+ written = snprintf(filename, PATH_MAX, "%s/%s.%" PRIu32 ".%" PRIu32 "%s", dirfull,
+ pl->prefix, (uint32_t)SCTIME_SECS(ts), (uint32_t)SCTIME_USECS(ts), pl->suffix);
+ }
+ if (written == PATH_MAX) {
+ SCLogError("log-pcap path overflow");
+ goto error;
+ }
+ } else if (pl->mode == LOGMODE_NORMAL) {
+ int ret;
+ /* create the filename to use */
+ if (pl->timestamp_format == TS_FORMAT_SEC) {
+ ret = snprintf(filename, PATH_MAX, "%s/%s.%" PRIu32 "%s", pl->dir, pl->prefix,
+ (uint32_t)SCTIME_SECS(ts), pl->suffix);
+ } else {
+ ret = snprintf(filename, PATH_MAX, "%s/%s.%" PRIu32 ".%" PRIu32 "%s", pl->dir,
+ pl->prefix, (uint32_t)SCTIME_SECS(ts), (uint32_t)SCTIME_USECS(ts), pl->suffix);
+ }
+ if (ret < 0 || (size_t)ret >= PATH_MAX) {
+ SCLogError("failed to construct path");
+ goto error;
+ }
+ } else if (pl->mode == LOGMODE_MULTI) {
+ if (pl->filename_part_cnt > 0) {
+ /* assemble filename from stored tokens */
+
+ strlcpy(filename, pl->dir, PATH_MAX);
+ strlcat(filename, "/", PATH_MAX);
+
+ int i;
+ for (i = 0; i < pl->filename_part_cnt; i++) {
+ if (pl->filename_parts[i] == NULL ||strlen(pl->filename_parts[i]) == 0)
+ continue;
+
+ /* handle variables */
+ if (pl->filename_parts[i][0] == '%') {
+ char str[64] = "";
+ if (strlen(pl->filename_parts[i]) < 2)
+ continue;
+
+ switch(pl->filename_parts[i][1]) {
+ case 'n':
+ snprintf(str, sizeof(str), "%u", pl->thread_number);
+ break;
+ case 'i':
+ {
+ long thread_id = SCGetThreadIdLong();
+ snprintf(str, sizeof(str), "%"PRIu64, (uint64_t)thread_id);
+ break;
+ }
+ case 't':
+ /* create the filename to use */
+ if (pl->timestamp_format == TS_FORMAT_SEC) {
+ snprintf(str, sizeof(str), "%" PRIu32, (uint32_t)SCTIME_SECS(ts));
+ } else {
+ snprintf(str, sizeof(str), "%" PRIu32 ".%" PRIu32,
+ (uint32_t)SCTIME_SECS(ts), (uint32_t)SCTIME_USECS(ts));
+ }
+ }
+ strlcat(filename, str, PATH_MAX);
+
+ /* copy the rest over */
+ } else {
+ strlcat(filename, pl->filename_parts[i], PATH_MAX);
+ }
+ }
+ strlcat(filename, pl->suffix, PATH_MAX);
+ } else {
+ int ret;
+ /* create the filename to use */
+ if (pl->timestamp_format == TS_FORMAT_SEC) {
+ ret = snprintf(filename, PATH_MAX, "%s/%s.%u.%" PRIu32 "%s", pl->dir, pl->prefix,
+ pl->thread_number, (uint32_t)SCTIME_SECS(ts), pl->suffix);
+ } else {
+ ret = snprintf(filename, PATH_MAX, "%s/%s.%u.%" PRIu32 ".%" PRIu32 "%s", pl->dir,
+ pl->prefix, pl->thread_number, (uint32_t)SCTIME_SECS(ts),
+ (uint32_t)SCTIME_USECS(ts), pl->suffix);
+ }
+ if (ret < 0 || (size_t)ret >= PATH_MAX) {
+ SCLogError("failed to construct path");
+ goto error;
+ }
+ }
+ SCLogDebug("multi-mode: filename %s", filename);
+ }
+
+ if ((pf->filename = SCStrdup(pl->filename)) == NULL) {
+ SCLogError("Error allocating memory. For filename");
+ goto error;
+ }
+ SCLogDebug("Opening pcap file log %s", pf->filename);
+ TAILQ_INSERT_TAIL(&pl->pcap_file_list, pf, next);
+
+ if (pl->mode == LOGMODE_MULTI || pl->mode == LOGMODE_NORMAL) {
+ pcap_file_thread = pl->filename;
+ }
+ PCAPLOG_PROFILE_END(pl->profile_open);
+ return 0;
+
+error:
+ PcapFileNameFree(pf);
+ return -1;
+}
+
+char *PcapLogGetFilename(void)
+{
+ /* return pcap filename per thread */
+ if (pcap_file_thread != NULL) {
+ return pcap_file_thread;
+ }
+ return NULL;
+}
+
+static int profiling_pcaplog_enabled = 0;
+static int profiling_pcaplog_output_to_file = 0;
+static char *profiling_pcaplog_file_name = NULL;
+static const char *profiling_pcaplog_file_mode = "a";
+
+static void FormatNumber(uint64_t num, char *str, size_t size)
+{
+ if (num < 1000UL)
+ snprintf(str, size, "%"PRIu64, num);
+ else if (num < 1000000UL)
+ snprintf(str, size, "%3.1fk", (float)num/1000UL);
+ else if (num < 1000000000UL)
+ snprintf(str, size, "%3.1fm", (float)num/1000000UL);
+ else
+ snprintf(str, size, "%3.1fb", (float)num/1000000000UL);
+}
+
+static void ProfileReportPair(FILE *fp, const char *name, PcapLogProfileData *p)
+{
+ char ticks_str[32] = "n/a";
+ char cnt_str[32] = "n/a";
+ char avg_str[32] = "n/a";
+
+ FormatNumber((uint64_t)p->cnt, cnt_str, sizeof(cnt_str));
+ FormatNumber((uint64_t)p->total, ticks_str, sizeof(ticks_str));
+ if (p->cnt && p->total)
+ FormatNumber((uint64_t)(p->total/p->cnt), avg_str, sizeof(avg_str));
+
+ fprintf(fp, "%-28s %-10s %-10s %-10s\n", name, cnt_str, avg_str, ticks_str);
+}
+
+static void ProfileReport(FILE *fp, PcapLogData *pl)
+{
+ ProfileReportPair(fp, "open", &pl->profile_open);
+ ProfileReportPair(fp, "close", &pl->profile_close);
+ ProfileReportPair(fp, "write", &pl->profile_write);
+ ProfileReportPair(fp, "rotate (incl open/close)", &pl->profile_rotate);
+ ProfileReportPair(fp, "handles", &pl->profile_handles);
+ ProfileReportPair(fp, "lock", &pl->profile_lock);
+ ProfileReportPair(fp, "unlock", &pl->profile_unlock);
+}
+
+static void FormatBytes(uint64_t num, char *str, size_t size)
+{
+ if (num < 1000UL)
+ snprintf(str, size, "%"PRIu64, num);
+ else if (num < 1048576UL)
+ snprintf(str, size, "%3.1fKiB", (float)num/1000UL);
+ else if (num < 1073741824UL)
+ snprintf(str, size, "%3.1fMiB", (float)num/1000000UL);
+ else
+ snprintf(str, size, "%3.1fGiB", (float)num/1000000000UL);
+}
+
+static void PcapLogProfilingDump(PcapLogData *pl)
+{
+ FILE *fp = NULL;
+
+ if (profiling_pcaplog_enabled == 0)
+ return;
+
+ if (profiling_pcaplog_output_to_file == 1) {
+ fp = fopen(profiling_pcaplog_file_name, profiling_pcaplog_file_mode);
+ if (fp == NULL) {
+ SCLogError("failed to open %s: %s", profiling_pcaplog_file_name, strerror(errno));
+ return;
+ }
+ } else {
+ fp = stdout;
+ }
+
+ /* counters */
+ fprintf(fp, "\n\nOperation Cnt Avg ticks Total ticks\n");
+ fprintf(fp, "---------------------------- ---------- ---------- -----------\n");
+
+ ProfileReport(fp, pl);
+ uint64_t total = pl->profile_write.total + pl->profile_rotate.total +
+ pl->profile_handles.total + pl->profile_open.total +
+ pl->profile_close.total + pl->profile_lock.total +
+ pl->profile_unlock.total;
+
+ /* overall stats */
+ fprintf(fp, "\nOverall: %"PRIu64" bytes written, average %d bytes per write.\n",
+ pl->profile_data_size, pl->profile_write.cnt ?
+ (int)(pl->profile_data_size / pl->profile_write.cnt) : 0);
+ fprintf(fp, " PCAP data structure overhead: %"PRIuMAX" per write.\n",
+ (uintmax_t)sizeof(struct pcap_pkthdr));
+
+ /* print total bytes written */
+ char bytes_str[32];
+ FormatBytes(pl->profile_data_size, bytes_str, sizeof(bytes_str));
+ fprintf(fp, " Size written: %s\n", bytes_str);
+
+ /* ticks per MiB and GiB */
+ uint64_t ticks_per_mib = 0, ticks_per_gib = 0;
+ uint64_t mib = pl->profile_data_size/(1024*1024);
+ if (mib)
+ ticks_per_mib = total/mib;
+ char ticks_per_mib_str[32] = "n/a";
+ if (ticks_per_mib > 0)
+ FormatNumber(ticks_per_mib, ticks_per_mib_str, sizeof(ticks_per_mib_str));
+ fprintf(fp, " Ticks per MiB: %s\n", ticks_per_mib_str);
+
+ uint64_t gib = pl->profile_data_size/(1024*1024*1024);
+ if (gib)
+ ticks_per_gib = total/gib;
+ char ticks_per_gib_str[32] = "n/a";
+ if (ticks_per_gib > 0)
+ FormatNumber(ticks_per_gib, ticks_per_gib_str, sizeof(ticks_per_gib_str));
+ fprintf(fp, " Ticks per GiB: %s\n", ticks_per_gib_str);
+
+ if (fp != stdout)
+ fclose(fp);
+}
+
+void PcapLogProfileSetup(void)
+{
+ ConfNode *conf = ConfGetNode("profiling.pcap-log");
+ if (conf != NULL && ConfNodeChildValueIsTrue(conf, "enabled")) {
+ profiling_pcaplog_enabled = 1;
+ SCLogInfo("pcap-log profiling enabled");
+
+ const char *filename = ConfNodeLookupChildValue(conf, "filename");
+ if (filename != NULL) {
+ const char *log_dir;
+ log_dir = ConfigGetLogDirectory();
+
+ profiling_pcaplog_file_name = SCMalloc(PATH_MAX);
+ if (unlikely(profiling_pcaplog_file_name == NULL)) {
+ FatalError("can't duplicate file name");
+ }
+
+ snprintf(profiling_pcaplog_file_name, PATH_MAX, "%s/%s", log_dir, filename);
+
+ const char *v = ConfNodeLookupChildValue(conf, "append");
+ if (v == NULL || ConfValIsTrue(v)) {
+ profiling_pcaplog_file_mode = "a";
+ } else {
+ profiling_pcaplog_file_mode = "w";
+ }
+
+ profiling_pcaplog_output_to_file = 1;
+ SCLogInfo("pcap-log profiling output goes to %s (mode %s)",
+ profiling_pcaplog_file_name, profiling_pcaplog_file_mode);
+ }
+ }
+}