suricata
output-tx.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  * AppLayer TX Logger Output registration functions
24  */
25 
26 #include "suricata-common.h"
27 #include "output.h"
28 #include "output-tx.h"
29 #include "stream.h"
30 #include "app-layer.h"
31 #include "app-layer-parser.h"
32 #include "util-profiling.h"
33 #include "util-validate.h"
34 
35 /** per thread data for this module, contains a list of per thread
36  * data for the packet loggers. */
37 typedef struct OutputTxLoggerThreadData_ {
39 
40  /* thread local data from file api */
42  /* thread local data from filedata api */
45 
46 /* logger instance, a module + a output ctx,
47  * it's perfectly valid that have multiple instances of the same
48  * log module (e.g. http.log) with different output ctx'. */
49 typedef struct OutputTxLogger_ {
55  const char *name;
57  uint32_t id;
60  TmEcode (*ThreadInit)(ThreadVars *, const void *, void **);
62  void (*ThreadExitPrintStats)(ThreadVars *, void *);
64 
65 static OutputTxLogger *list[ALPROTO_MAX] = { NULL };
66 
73  void (*ThreadExitPrintStats)(ThreadVars *, void *))
74 {
76  SCLogDebug(
77  "%s logger not enabled: protocol %s is disabled", name, AppProtoToString(alproto));
78  return -1;
79  }
80  OutputTxLogger *op = SCMalloc(sizeof(*op));
81  if (op == NULL)
82  return -1;
83  memset(op, 0x00, sizeof(*op));
84 
85  op->alproto = alproto;
86  op->LogFunc = LogFunc;
88  op->output_ctx = output_ctx;
89  op->name = name;
90  op->logger_id = id;
91  op->ThreadInit = ThreadInit;
94 
95  if (alproto == ALPROTO_UNKNOWN) {
96  op->tc_log_progress = 0;
97  } else if (tc_log_progress < 0) {
98  op->tc_log_progress =
100  STREAM_TOCLIENT);
101  } else {
103  }
104 
105  if (alproto == ALPROTO_UNKNOWN) {
106  op->ts_log_progress = 0;
107  } else if (ts_log_progress < 0) {
108  op->ts_log_progress =
110  STREAM_TOSERVER);
111  } else {
113  }
114 
115  if (list[alproto] == NULL) {
116  op->id = 1;
117  list[alproto] = op;
118  } else {
119  OutputTxLogger *t = list[alproto];
120  while (t->next)
121  t = t->next;
122  if (t->id * 2ULL > UINT32_MAX) {
123  FatalError("Too many loggers registered.");
124  }
125  op->id = t->id * 2;
126  t->next = op;
127  }
128 
129  SCLogDebug("OutputRegisterTxLogger happy");
130  return 0;
131 }
132 
133 extern bool g_file_logger_enabled;
134 extern bool g_filedata_logger_enabled;
135 
136 /** \brief run the per tx file logging
137  * \todo clean up various end of tx/stream etc indicators
138  */
139 static inline void OutputTxLogFiles(ThreadVars *tv, OutputFileLoggerThreadData *file_td,
140  OutputFiledataLoggerThreadData *filedata_td, Packet *p, Flow *f, void *tx,
141  const uint64_t tx_id, AppLayerTxData *txd, const bool tx_complete, const bool ts_ready,
142  const bool tc_ready, const bool ts_eof, const bool tc_eof, const bool eof)
143 {
144  uint8_t packet_dir;
145  uint8_t opposing_dir;
146  bool packet_dir_ready;
147  const bool opposing_dir_ready = eof;
148  bool opposing_tx_ready;
149  if (p->flowflags & FLOW_PKT_TOSERVER) {
150  packet_dir = STREAM_TOSERVER;
151  opposing_dir = STREAM_TOCLIENT;
152  packet_dir_ready = eof | ts_ready | ts_eof;
153  opposing_tx_ready = tc_ready;
154  } else if (p->flowflags & FLOW_PKT_TOCLIENT) {
155  packet_dir = STREAM_TOCLIENT;
156  opposing_dir = STREAM_TOSERVER;
157  packet_dir_ready = eof | tc_ready | tc_eof;
158  opposing_tx_ready = ts_ready;
159  } else {
160  abort();
161  }
162 
163  SCLogDebug("eof %d ts_ready %d ts_eof %d", eof, ts_ready, ts_eof);
164  SCLogDebug("eof %d tc_ready %d tc_eof %d", eof, tc_ready, tc_eof);
165 
166  SCLogDebug("packet dir %s opposing %s packet_dir_ready %d opposing_dir_ready %d",
167  packet_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT",
168  opposing_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT", packet_dir_ready,
169  opposing_dir_ready);
170 
171  AppLayerGetFileState app_files =
172  AppLayerParserGetTxFiles(f, FlowGetAppState(f), tx, packet_dir);
173  FileContainer *ffc = app_files.fc;
174  AppLayerGetFileState app_files_opposing =
175  AppLayerParserGetTxFiles(f, FlowGetAppState(f), tx, opposing_dir);
176  FileContainer *ffc_opposing = app_files_opposing.fc;
177 
178  /* see if opposing side is finished: if no file support in this direction, of is not
179  * files and tx is done for opposing dir. */
180  bool opposing_finished =
181  ffc_opposing == NULL || (ffc_opposing->head == NULL && opposing_tx_ready);
182  SCLogDebug("opposing_finished %d ffc_opposing %p ffc_opposing->head %p opposing_tx_ready %d",
183  opposing_finished, ffc_opposing, ffc_opposing ? ffc_opposing->head : NULL,
184  opposing_tx_ready);
185 
186  if (ffc || ffc_opposing)
187  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
188  " ffc %p ffc_opposing %p tx_complete %d",
189  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
190 
191  if (ffc) {
192  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | eof;
193  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
194  SCLogDebug("tx: calling files: ffc %p head %p file_close %d file_trunc %d", ffc, ffc->head,
195  file_close, file_trunc);
196  if (filedata_td && txd->files_opened > txd->files_stored)
197  OutputFiledataLogFfc(tv, filedata_td, p, app_files, tx, tx_id, txd, packet_dir,
198  file_close, file_trunc, packet_dir);
199  if (file_td && txd->files_opened > txd->files_logged)
201  tv, file_td, p, ffc, tx, tx_id, txd, file_close, file_trunc, packet_dir);
202  }
203  /* if EOF and we support files, do a final write out */
204  if (opposing_dir_ready && ffc_opposing != NULL) {
205  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | tx_complete | eof;
206  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
207  opposing_finished = true;
208  SCLogDebug("tx: calling for opposing direction files: file_close:%s file_trunc:%s",
209  file_close ? "true" : "false", file_trunc ? "true" : "false");
210  if (filedata_td && txd->files_opened > txd->files_stored)
211  OutputFiledataLogFfc(tv, filedata_td, p, app_files_opposing, tx, tx_id, txd,
212  opposing_dir, file_close, file_trunc, opposing_dir);
213  if (file_td && txd->files_opened > txd->files_logged)
214  OutputFileLogFfc(tv, file_td, p, ffc_opposing, tx, tx_id, txd, file_close, file_trunc,
215  opposing_dir);
216  }
217 
218  const bool tx_done = packet_dir_ready && opposing_finished;
219  SCLogDebug("tx_done %d packet_dir_ready %d opposing_finished %d", tx_done, packet_dir_ready,
220  opposing_finished);
221 
222  /* if not a file tx or if tx is done, set logger flags so tx can move on */
223  const bool is_file_tx = (ffc != NULL || ffc_opposing != NULL);
224  if (!is_file_tx || tx_done) {
225  SCLogDebug("is_file_tx %d tx_done %d", is_file_tx, tx_done);
226  if (file_td) {
227  txd->logged.flags |= BIT_U32(LOGGER_FILE);
228  SCLogDebug("setting LOGGER_FILE => %08x", txd->logged.flags);
229  }
230  if (filedata_td) {
231  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
232  SCLogDebug("setting LOGGER_FILEDATA => %08x", txd->logged.flags);
233  }
234  } else {
235  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
236  " NOT SETTING FILE FLAGS ffc %p ffc_opposing %p tx_complete %d",
237  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
238  }
239 }
240 
241 static void OutputTxLogList0(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data, Packet *p,
242  Flow *f, void *tx, const uint64_t tx_id)
243 {
244  const OutputTxLogger *logger = list[ALPROTO_UNKNOWN];
245  const OutputLoggerThreadStore *store = op_thread_data->store[ALPROTO_UNKNOWN];
246 
247  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
248  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
249  DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
250 
251  while (logger && store) {
252  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
253 
254  SCLogDebug("logger %p", logger);
255 
256  /* always invoke "wild card" tx loggers */
257  SCLogDebug("Logging tx_id %"PRIu64" to logger %d", tx_id, logger->logger_id);
259  logger->LogFunc(tv, store->thread_data, p, f, f->alstate, tx, tx_id);
261 
262  logger = logger->next;
263  store = store->next;
264 
265  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
266  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
267  }
268 }
269 
270 struct Ctx {
271  uint32_t tx_logged_old;
272  uint32_t tx_logged;
273 };
274 
275 static void OutputTxLogCallLoggers(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data,
276  const OutputTxLogger *logger, const OutputLoggerThreadStore *store, Packet *p, Flow *f,
277  void *alstate, void *tx, const uint64_t tx_id, const AppProto alproto, const bool eof,
278  const int tx_progress_ts, const int tx_progress_tc, struct Ctx *ctx)
279 {
280  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
281  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
282  // DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
283 
284  while (logger && store) {
285  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
286  DEBUG_VALIDATE_BUG_ON(logger->alproto != alproto);
287 
288  SCLogDebug("logger %p, Alproto %d LogCondition %p, ts_log_progress %d "
289  "tc_log_progress %d",
290  logger, logger->alproto, logger->LogCondition, logger->ts_log_progress,
291  logger->tc_log_progress);
292  if ((ctx->tx_logged_old & BIT_U32(logger->logger_id)) == 0) {
293  SCLogDebug("alproto match %d, logging tx_id %" PRIu64, logger->alproto, tx_id);
294 
295  SCLogDebug("pcap_cnt %" PRIu64 ", tx_id %" PRIu64 " logger %d. EOF %s", p->pcap_cnt,
296  tx_id, logger->logger_id, eof ? "true" : "false");
297 
298  if (eof) {
299  SCLogDebug("EOF, so log now");
300  } else {
301  if (logger->LogCondition) {
302  int r = logger->LogCondition(tv, p, alstate, tx, tx_id);
303  if (r == FALSE) {
304  SCLogDebug("conditions not met, not logging");
305  goto next_logger;
306  }
307  } else {
308  if (tx_progress_tc < logger->tc_log_progress) {
309  SCLogDebug("progress not far enough, not logging");
310  goto next_logger;
311  }
312 
313  if (tx_progress_ts < logger->ts_log_progress) {
314  SCLogDebug("progress not far enough, not logging");
315  goto next_logger;
316  }
317  }
318  }
319 
320  SCLogDebug("Logging tx_id %" PRIu64 " to logger %d", tx_id, logger->logger_id);
322  logger->LogFunc(tv, store->thread_data, p, f, alstate, tx, tx_id);
324 
325  ctx->tx_logged |= BIT_U32(logger->logger_id);
326  }
327 
328  next_logger:
329  logger = logger->next;
330  store = store->next;
331 
332  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
333  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
334  }
335 }
336 
337 static TmEcode OutputTxLog(ThreadVars *tv, Packet *p, void *thread_data)
338 {
339  DEBUG_VALIDATE_BUG_ON(thread_data == NULL);
340  if (p->flow == NULL)
341  return TM_ECODE_OK;
343  SCLogDebug("not pseudo, no app update: skip");
344  return TM_ECODE_OK;
345  }
346  SCLogDebug("pseudo, or app update: run output");
347 
348  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
349 
350  Flow * const f = p->flow;
351  const uint8_t ipproto = f->proto;
352  const AppProto alproto = f->alproto;
353  SCLogDebug("pcap_cnt %u tx logging %u/%s", (uint32_t)p->pcap_cnt, alproto,
354  AppProtoToString(alproto));
355 
356  const bool file_logging_active = (op_thread_data->file || op_thread_data->filedata);
357  if (!file_logging_active) {
358  if (list[alproto] == NULL && list[ALPROTO_UNKNOWN] == NULL) {
359  SCLogDebug("bail");
360  /* No child loggers registered. */
361  return TM_ECODE_OK;
362  }
363  if (AppLayerParserProtocolHasLogger(ipproto, alproto) == 0)
364  goto end;
365  }
366  void *alstate = f->alstate;
367  if (alstate == NULL) {
368  SCLogDebug("no alstate");
369  goto end;
370  }
371  const LoggerId logger_expectation = AppLayerParserProtocolGetLoggerBits(ipproto, alproto);
372  if (logger_expectation == 0) {
373  SCLogDebug("bail: logger_expectation %u. LOGGER_FILE %u LOGGER_FILEDATA %u",
374  logger_expectation, LOGGER_FILE, LOGGER_FILEDATA);
375  goto end;
376  }
377  SCLogDebug("pcap_cnt %" PRIu64, p->pcap_cnt);
378 
379  const bool last_pseudo = (p->flowflags & FLOW_PKT_LAST_PSEUDO) != 0;
380  const bool ts_eof = AppLayerParserStateIssetFlag(f->alparser,
382  const bool tc_eof = AppLayerParserStateIssetFlag(f->alparser,
384 
385  const bool eof = last_pseudo || (ts_eof && tc_eof);
386  SCLogDebug("eof %d last_pseudo %d ts_eof %d tc_eof %d", eof, last_pseudo, ts_eof, tc_eof);
387 
388  const uint8_t ts_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOSERVER);
389  const uint8_t tc_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOCLIENT);
390  SCLogDebug("ts_disrupt_flags %02x tc_disrupt_flags %02x", ts_disrupt_flags, tc_disrupt_flags);
391  const uint64_t total_txs = AppLayerParserGetTxCnt(f, alstate);
392  uint64_t tx_id = AppLayerParserGetTransactionLogId(f->alparser);
393  uint64_t max_id = tx_id;
394  int logged = 0;
395  int gap = 0;
396  const bool support_files = AppLayerParserSupportsFiles(ipproto, alproto);
397  const uint8_t pkt_dir = STREAM_FLAGS_FOR_PACKET(p);
398 
399  SCLogDebug("pcap_cnt %" PRIu64 ": tx_id %" PRIu64 " total_txs %" PRIu64, p->pcap_cnt, tx_id,
400  total_txs);
401 
402  AppLayerGetTxIteratorFunc IterFunc = AppLayerGetTxIterator(ipproto, alproto);
404  memset(&state, 0, sizeof(state));
405 
406  const int complete_ts =
407  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOSERVER);
408  const int complete_tc =
409  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOCLIENT);
410  while (1) {
411  AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, tx_id, total_txs, &state);
412  if (ires.tx_ptr == NULL)
413  break;
414  void * const tx = ires.tx_ptr;
415  tx_id = ires.tx_id;
416  SCLogDebug("STARTING tx_id %" PRIu64 ", tx %p", tx_id, tx);
417 
418  const int tx_progress_ts =
419  AppLayerParserGetStateProgress(ipproto, alproto, tx, ts_disrupt_flags);
420  const int tx_progress_tc =
421  AppLayerParserGetStateProgress(ipproto, alproto, tx, tc_disrupt_flags);
422  const bool tx_complete = (tx_progress_ts == complete_ts && tx_progress_tc == complete_tc);
423 
424  SCLogDebug("file_thread_data %p filedata_thread_data %p", op_thread_data->file,
425  op_thread_data->filedata);
426 
427  AppLayerTxData *txd = AppLayerParserGetTxData(ipproto, alproto, tx);
428  if (unlikely(txd == NULL)) {
429  SCLogDebug("NO TXD");
430  /* make sure this tx, which can't be properly logged is skipped */
431  logged = 1;
432  max_id = tx_id;
433  goto next_tx;
434  }
435 
436  if (file_logging_active) {
437  if (AppLayerParserIsFileTx(txd)) { // need to process each tx that might be a file tx,
438  // even if there are not files (yet)
439  const bool ts_ready = (tx_progress_ts == complete_ts);
440  const bool tc_ready = (tx_progress_tc == complete_tc);
441  SCLogDebug("ts_ready %d tc_ready %d", ts_ready, tc_ready);
442 
443  const bool eval_files = ts_ready | tc_ready | tx_complete | ts_eof | tc_eof | eof;
444 
445  SCLogDebug("eval_files: %u, ts_ready %u, tc_ready %u, tx_complete %u, ts_eof %u, "
446  "tc_eof %u, eof %u",
447  eval_files, ts_ready, tc_ready, tx_complete, ts_eof, tc_eof, eof);
448  SCLogDebug("txd->file_tx & pkt_dir: %02x & %02x -> %02x", txd->file_tx, pkt_dir,
449  (txd->file_tx & pkt_dir));
450 
451  /* call only for the correct direction, except when it looks anything like a end of
452  * transaction or end of stream. Since OutputTxLogFiles has complicated logic around
453  * that, we just leave it to that function to sort things out for now. */
454  if (eval_files || AppLayerParserIsFileTxInDir(txd, pkt_dir)) {
455  OutputTxLogFiles(tv, op_thread_data->file, op_thread_data->filedata, p, f, tx,
456  tx_id, txd, tx_complete, ts_ready, tc_ready, ts_eof, tc_eof, eof);
457  }
458  } else if (support_files) {
459  if (op_thread_data->file) {
460  txd->logged.flags |= BIT_U32(LOGGER_FILE);
461  SCLogDebug("not a file_tx: setting LOGGER_FILE => %08x", txd->logged.flags);
462  }
463  if (op_thread_data->filedata) {
464  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
465  SCLogDebug("not a file_tx: setting LOGGER_FILEDATA => %08x", txd->logged.flags);
466  }
467  }
468  }
469  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
470 
471  if (list[ALPROTO_UNKNOWN] != 0) {
472  OutputTxLogList0(tv, op_thread_data, p, f, tx, tx_id);
473  if (list[alproto] == NULL)
474  goto next_tx;
475  }
476 
477  SCLogDebug("tx %p/%" PRIu64 " txd %p: log_flags %x logger_expectation %x", tx, tx_id, txd,
478  txd->config.log_flags, logger_expectation);
479  if (txd->config.log_flags & BIT_U8(CONFIG_TYPE_TX)) {
480  SCLogDebug("SKIP tx %p/%"PRIu64, tx, tx_id);
481  // so that AppLayerParserTransactionsCleanup can clean this tx
482  txd->logged.flags |= logger_expectation;
483  goto next_tx;
484  }
485 
486  if (txd->logged.flags == logger_expectation) {
487  SCLogDebug("fully logged");
488  /* tx already fully logged */
489  goto next_tx;
490  }
491 
492  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
493  const OutputTxLogger *logger = list[alproto];
494  const OutputLoggerThreadStore *store = op_thread_data->store[alproto];
495  struct Ctx ctx = { .tx_logged = txd->logged.flags, .tx_logged_old = txd->logged.flags };
496  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
497 
498  OutputTxLogCallLoggers(tv, op_thread_data, logger, store, p, f, alstate, tx, tx_id, alproto,
499  eof, tx_progress_ts, tx_progress_tc, &ctx);
500 
501  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
502  if (ctx.tx_logged != ctx.tx_logged_old) {
503  SCLogDebug("logger: storing %08x (was %08x)", ctx.tx_logged, ctx.tx_logged_old);
504  DEBUG_VALIDATE_BUG_ON(txd == NULL);
505  txd->logged.flags |= ctx.tx_logged;
506  }
507 
508  /* If all loggers logged set a flag and update the last tx_id
509  * that was logged.
510  *
511  * If not all loggers were logged we flag that there was a gap
512  * so any subsequent transactions in this loop don't increase
513  * the maximum ID that was logged. */
514  if (!gap && ctx.tx_logged == logger_expectation) {
515  SCLogDebug("no gap %d, %08x == %08x", gap, ctx.tx_logged, logger_expectation);
516  logged = 1;
517  max_id = tx_id;
518  SCLogDebug("max_id %" PRIu64, max_id);
519  } else {
520  gap = 1;
521  }
522 next_tx:
523  if (!ires.has_next)
524  break;
525  tx_id++;
526  }
527 
528  /* Update the last ID that has been logged with all
529  * transactions before it. */
530  if (logged) {
531  SCLogDebug("updating log tx_id %"PRIu64, max_id);
533  }
534 
535 end:
536  return TM_ECODE_OK;
537 }
538 
539 /** \brief thread init for the tx logger
540  * This will run the thread init functions for the individual registered
541  * loggers */
542 static TmEcode OutputTxLogThreadInit(ThreadVars *tv, const void *_initdata, void **data)
543 {
544  OutputTxLoggerThreadData *td = SCMalloc(sizeof(*td));
545  if (td == NULL)
546  return TM_ECODE_FAILED;
547  memset(td, 0x00, sizeof(*td));
548 
549  *data = (void *)td;
550  SCLogDebug("OutputTxLogThreadInit happy (*data %p)", *data);
551 
552  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
553  OutputTxLogger *logger = list[alproto];
554  while (logger) {
555  if (logger->ThreadInit) {
556  void *retptr = NULL;
557  if (logger->ThreadInit(tv, (void *)logger->output_ctx, &retptr) == TM_ECODE_OK) {
558  OutputLoggerThreadStore *ts = SCMalloc(sizeof(*ts));
559  /* todo */ BUG_ON(ts == NULL);
560  memset(ts, 0x00, sizeof(*ts));
561 
562  /* store thread handle */
563  ts->thread_data = retptr;
564 
565  if (td->store[alproto] == NULL) {
566  td->store[alproto] = ts;
567  } else {
568  OutputLoggerThreadStore *tmp = td->store[alproto];
569  while (tmp->next != NULL)
570  tmp = tmp->next;
571  tmp->next = ts;
572  }
573 
574  SCLogDebug("%s is now set up", logger->name);
575  }
576  }
577 
578  logger = logger->next;
579  }
580  }
581 
582  if (g_file_logger_enabled) {
583  if (OutputFileLogThreadInit(tv, &td->file) != TM_ECODE_OK) {
584  FatalError("failed to set up file thread data");
585  }
586  }
589  FatalError("failed to set up filedata thread data");
590  }
591  }
592 
593  SCLogDebug("file_thread_data %p filedata_thread_data %p", td->file, td->filedata);
594 
595  return TM_ECODE_OK;
596 }
597 
598 static TmEcode OutputTxLogThreadDeinit(ThreadVars *tv, void *thread_data)
599 {
600  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
601 
602  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
603  OutputLoggerThreadStore *store = op_thread_data->store[alproto];
604  OutputTxLogger *logger = list[alproto];
605 
606  while (logger && store) {
607  if (logger->ThreadDeinit) {
608  logger->ThreadDeinit(tv, store->thread_data);
609  }
610 
611  OutputLoggerThreadStore *next_store = store->next;
612  SCFree(store);
613  store = next_store;
614  logger = logger->next;
615  }
616  }
617 
618  if (op_thread_data->file) {
619  OutputFileLogThreadDeinit(tv, op_thread_data->file);
620  }
621  if (op_thread_data->filedata) {
622  OutputFiledataLogThreadDeinit(tv, op_thread_data->filedata);
623  }
624 
625  SCFree(op_thread_data);
626  return TM_ECODE_OK;
627 }
628 
629 static void OutputTxLogExitPrintStats(ThreadVars *tv, void *thread_data)
630 {
631  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
632 
633  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
634  OutputLoggerThreadStore *store = op_thread_data->store[alproto];
635  OutputTxLogger *logger = list[alproto];
636 
637  while (logger && store) {
638  if (logger->ThreadExitPrintStats) {
639  logger->ThreadExitPrintStats(tv, store->thread_data);
640  }
641 
642  logger = logger->next;
643  store = store->next;
644  }
645  }
646 }
647 
648 static uint32_t OutputTxLoggerGetActiveCount(void)
649 {
650  uint32_t cnt = 0;
651  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
652  for (OutputTxLogger *p = list[alproto]; p != NULL; p = p->next) {
653  cnt++;
654  }
655  }
656 
657  if (g_file_logger_enabled) {
658  cnt++;
659  SCLogDebug("g_file_logger_enabled");
660  }
662  cnt++;
663  SCLogDebug("g_filedata_logger_enabled");
664  }
665 
666  return cnt;
667 }
668 
669 
671 {
672  OutputRegisterRootLogger(OutputTxLogThreadInit, OutputTxLogThreadDeinit,
673  OutputTxLogExitPrintStats, OutputTxLog, OutputTxLoggerGetActiveCount);
674 }
675 
677 {
678  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
679  OutputTxLogger *logger = list[alproto];
680  while (logger) {
681  OutputTxLogger *next_logger = logger->next;
682  SCFree(logger);
683  logger = next_logger;
684  }
685  list[alproto] = NULL;
686  }
687 }
OutputFiledataLogThreadInit
TmEcode OutputFiledataLogThreadInit(ThreadVars *tv, OutputFiledataLoggerThreadData **data)
thread init for the filedata logger This will run the thread init functions for the individual regist...
Definition: output-filedata.c:205
OutputTxLogger_::alproto
AppProto alproto
Definition: output-tx.c:50
OutputTxLoggerThreadData_::store
OutputLoggerThreadStore * store[ALPROTO_MAX]
Definition: output-tx.c:38
FileContainer_
Definition: util-file.h:113
output-tx.h
ts
uint64_t ts
Definition: source-erf-file.c:55
OutputLoggerThreadStore_
Definition: output.h:33
AppLayerParserIsEnabled
int AppLayerParserIsEnabled(AppProto alproto)
simple way to globally test if a alproto is registered and fully enabled in the configuration.
Definition: app-layer-parser.c:1549
OutputTxLoggerRegister
void OutputTxLoggerRegister(void)
Definition: output-tx.c:670
AppLayerParserProtocolHasLogger
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1559
OutputFileLoggerThreadData_
Definition: output-file.h:33
AppLayerParserSetTransactionLogId
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
Definition: app-layer-parser.c:719
CONFIG_TYPE_TX
@ CONFIG_TYPE_TX
Definition: util-config.h:36
PKT_IS_PSEUDOPKT
#define PKT_IS_PSEUDOPKT(p)
return 1 if the packet is a pseudo packet
Definition: decode.h:1053
FLOW_PKT_LAST_PSEUDO
#define FLOW_PKT_LAST_PSEUDO
Definition: flow.h:230
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
OutputTxLogger_::tc_log_progress
int tc_log_progress
Definition: output-tx.c:58
StreamTcpReassembleDepthReached
int StreamTcpReassembleDepthReached(Packet *p)
check if stream in pkt direction has depth reached
Definition: stream-tcp-reassemble.c:622
LOGGER_FILEDATA
@ LOGGER_FILEDATA
Definition: suricata-common.h:464
OutputTxShutdown
void OutputTxShutdown(void)
Definition: output-tx.c:676
Ctx
Definition: output-tx.c:270
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
Packet_::pcap_cnt
uint64_t pcap_cnt
Definition: decode.h:598
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:704
Flow_::proto
uint8_t proto
Definition: flow.h:369
Ctx::tx_logged
uint32_t tx_logged
Definition: output-tx.c:272
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:80
AppLayerParserGetStateProgress
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *alstate, uint8_t flags)
get the progress value for a tx/protocol
Definition: app-layer-parser.c:1105
Packet_::flags
uint32_t flags
Definition: decode.h:467
Flow_
Flow data structure.
Definition: flow.h:347
OutputFiledataLogThreadDeinit
TmEcode OutputFiledataLogThreadDeinit(ThreadVars *tv, OutputFiledataLoggerThreadData *op_thread_data)
Definition: output-filedata.c:253
LoggerId
LoggerId
Definition: suricata-common.h:455
AppLayerParserGetTransactionLogId
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
Definition: app-layer-parser.c:712
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
Definition: app-layer-protos.c:74
logged
int logged
Definition: app-layer-htp.h:1
FLOW_TC_APP_UPDATED
#define FLOW_TC_APP_UPDATED
Definition: flow.h:116
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1134
g_filedata_logger_enabled
bool g_filedata_logger_enabled
Definition: output-filedata.c:37
OutputLoggerThreadStore_::next
struct OutputLoggerThreadStore_ * next
Definition: output.h:35
AppLayerParserSupportsFiles
int AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1187
FLOW_PKT_TOSERVER
#define FLOW_PKT_TOSERVER
Definition: flow.h:221
TxLogger
int(* TxLogger)(ThreadVars *, void *thread_data, const Packet *, Flow *f, void *state, void *tx, uint64_t tx_id)
Definition: output-tx.h:33
OutputTxLogger_::ThreadInit
TmEcode(* ThreadInit)(ThreadVars *, const void *, void **)
Definition: output-tx.c:60
OutputTxLogger_::logger_id
LoggerId logger_id
Definition: output-tx.c:56
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:461
APP_LAYER_PARSER_EOF_TS
#define APP_LAYER_PARSER_EOF_TS
Definition: app-layer-parser.h:39
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:85
ALPROTO_MAX
@ ALPROTO_MAX
Definition: app-layer-protos.h:75
OutputTxLogger_::ThreadDeinit
TmEcode(* ThreadDeinit)(ThreadVars *, void *)
Definition: output-tx.c:61
Ctx::tx_logged_old
uint32_t tx_logged_old
Definition: output-tx.c:271
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
OutputCtx_
Definition: tm-modules.h:84
OutputTxLoggerThreadData
struct OutputTxLoggerThreadData_ OutputTxLoggerThreadData
OutputLoggerThreadStore_::thread_data
void * thread_data
Definition: output.h:34
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:471
OutputRegisterTxLogger
int OutputRegisterTxLogger(LoggerId id, const char *name, AppProto alproto, TxLogger LogFunc, OutputCtx *output_ctx, int tc_log_progress, int ts_log_progress, TxLoggerCondition LogCondition, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, void(*ThreadExitPrintStats)(ThreadVars *, void *))
Definition: output-tx.c:67
OutputFileLogThreadDeinit
TmEcode OutputFileLogThreadDeinit(ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data)
Definition: output-file.c:217
OutputTxLoggerThreadData_::filedata
OutputFiledataLoggerThreadData * filedata
Definition: output-tx.c:43
BIT_U32
#define BIT_U32(n)
Definition: suricata-common.h:395
PKT_PSEUDO_STREAM_END
#define PKT_PSEUDO_STREAM_END
Definition: decode.h:1002
OutputTxLogger_::next
struct OutputTxLogger_ * next
Definition: output-tx.c:54
STREAM_FLAGS_FOR_PACKET
#define STREAM_FLAGS_FOR_PACKET(p)
Definition: stream.h:30
FileContainer_::head
File * head
Definition: util-file.h:114
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
ThreadInitFunc
TmEcode(* ThreadInitFunc)(ThreadVars *, const void *, void **)
Definition: tm-modules.h:39
app-layer-parser.h
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:295
util-profiling.h
FALSE
#define FALSE
Definition: suricata-common.h:34
stream.h
OutputTxLogger_::ts_log_progress
int ts_log_progress
Definition: output-tx.c:59
AppLayerGetTxIterState
Definition: app-layer-parser.h:144
Packet_
Definition: decode.h:430
APP_LAYER_PARSER_EOF_TC
#define APP_LAYER_PARSER_EOF_TC
Definition: app-layer-parser.h:40
TmEcode
TmEcode
Definition: tm-threads-common.h:83
OutputTxLogger_::output_ctx
OutputCtx * output_ctx
Definition: output-tx.c:53
OutputTxLogger_::LogCondition
TxLoggerCondition LogCondition
Definition: output-tx.c:52
OutputFiledataLoggerThreadData_
Definition: output-filedata.h:34
OutputFiledataLogFfc
void OutputFiledataLogFfc(ThreadVars *tv, OutputFiledataLoggerThreadData *td, Packet *p, AppLayerGetFileState files, void *txv, const uint64_t tx_id, AppLayerTxData *txd, const uint8_t call_flags, const bool file_close, const bool file_trunc, const uint8_t dir)
Definition: output-filedata.c:129
OutputTxLogger_::ThreadExitPrintStats
void(* ThreadExitPrintStats)(ThreadVars *, void *)
Definition: output-tx.c:62
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:222
PACKET_PROFILING_LOGGER_END
#define PACKET_PROFILING_LOGGER_END(p, id)
Definition: util-profiling.h:241
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1347
Packet_::flow
struct Flow_ * flow
Definition: decode.h:469
BIT_U8
#define BIT_U8(n)
Definition: suricata-common.h:393
suricata-common.h
OutputTxLogger
struct OutputTxLogger_ OutputTxLogger
FLOW_TS_APP_UPDATED
#define FLOW_TS_APP_UPDATED
Definition: flow.h:115
OutputFileLogFfc
void OutputFileLogFfc(ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data, Packet *p, FileContainer *ffc, void *txv, const uint64_t tx_id, AppLayerTxData *txd, const bool file_close, const bool file_trunc, uint8_t dir)
Definition: output-file.c:101
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1199
FatalError
#define FatalError(...)
Definition: util-debug.h:502
OutputTxLoggerThreadData_::file
OutputFileLoggerThreadData * file
Definition: output-tx.c:41
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
OutputFileLogThreadInit
TmEcode OutputFileLogThreadInit(ThreadVars *tv, OutputFileLoggerThreadData **data)
thread init for the file logger This will run the thread init functions for the individual registered...
Definition: output-file.c:169
util-validate.h
LOGGER_FILE
@ LOGGER_FILE
Definition: suricata-common.h:463
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
Packet_::next
struct Packet_ * next
Definition: decode.h:607
TxLoggerCondition
int(* TxLoggerCondition)(ThreadVars *, const Packet *, void *state, void *tx, uint64_t tx_id)
Definition: output-tx.h:38
OutputTxLogger_::LogFunc
TxLogger LogFunc
Definition: output-tx.c:51
SCFree
#define SCFree(p)
Definition: util-mem.h:61
Flow_::alstate
void * alstate
Definition: flow.h:472
Flow_::flags
uint32_t flags
Definition: flow.h:417
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
OutputTxLogger_
Definition: output-tx.c:49
APP_LAYER_PARSER_TRUNC_TC
#define APP_LAYER_PARSER_TRUNC_TC
Definition: app-layer-parser.h:42
PACKET_PROFILING_LOGGER_START
#define PACKET_PROFILING_LOGGER_START(p, id)
Definition: util-profiling.h:234
OutputRegisterRootLogger
void OutputRegisterRootLogger(ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats, OutputLogFunc LogFunc, OutputGetActiveCountFunc ActiveCntFunc)
Definition: output.c:962
OutputTxLogger_::name
const char * name
Definition: output-tx.c:55
AppLayerParserProtocolGetLoggerBits
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1567
AppLayerGetTxIteratorFunc
AppLayerGetTxIterTuple(* AppLayerGetTxIteratorFunc)(const uint8_t ipproto, const AppProto alproto, void *alstate, uint64_t min_tx_id, uint64_t max_tx_id, AppLayerGetTxIterState *state)
tx iterator prototype
Definition: app-layer-parser.h:153
AppLayerParserGetTxFiles
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *state, void *tx, const uint8_t direction)
Definition: app-layer-parser.c:890
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1159
APP_LAYER_PARSER_TRUNC_TS
#define APP_LAYER_PARSER_TRUNC_TS
Definition: app-layer-parser.h:41
AppLayerParserStateIssetFlag
uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1806
g_file_logger_enabled
bool g_file_logger_enabled
Definition: output-file.c:39
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:446
OutputTxLogger_::id
uint32_t id
Definition: output-tx.c:57
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *f, void *alstate)
Definition: app-layer-parser.c:1120
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:104
output.h
ThreadDeinitFunc
TmEcode(* ThreadDeinitFunc)(ThreadVars *, void *)
Definition: tm-modules.h:40
OutputTxLoggerThreadData_
Definition: output-tx.c:37
app-layer.h