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 = SCCalloc(1, sizeof(*op));
81  if (op == NULL)
82  return -1;
83 
84  op->alproto = alproto;
85  op->LogFunc = LogFunc;
87  op->output_ctx = output_ctx;
88  op->name = name;
89  op->logger_id = id;
90  op->ThreadInit = ThreadInit;
93 
94  if (alproto == ALPROTO_UNKNOWN) {
95  op->tc_log_progress = 0;
96  } else if (tc_log_progress < 0) {
97  op->tc_log_progress =
99  STREAM_TOCLIENT);
100  } else {
102  }
103 
104  if (alproto == ALPROTO_UNKNOWN) {
105  op->ts_log_progress = 0;
106  } else if (ts_log_progress < 0) {
107  op->ts_log_progress =
109  STREAM_TOSERVER);
110  } else {
112  }
113 
114  if (list[alproto] == NULL) {
115  op->id = 1;
116  list[alproto] = op;
117  } else {
118  OutputTxLogger *t = list[alproto];
119  while (t->next)
120  t = t->next;
121  if (t->id * 2ULL > UINT32_MAX) {
122  FatalError("Too many loggers registered.");
123  }
124  op->id = t->id * 2;
125  t->next = op;
126  }
127 
128  SCLogDebug("OutputRegisterTxLogger happy");
129  return 0;
130 }
131 
132 extern bool g_file_logger_enabled;
133 extern bool g_filedata_logger_enabled;
134 
135 /** \brief run the per tx file logging
136  * \todo clean up various end of tx/stream etc indicators
137  */
138 static inline void OutputTxLogFiles(ThreadVars *tv, OutputFileLoggerThreadData *file_td,
139  OutputFiledataLoggerThreadData *filedata_td, Packet *p, Flow *f, void *tx,
140  const uint64_t tx_id, AppLayerTxData *txd, const bool tx_complete, const bool ts_ready,
141  const bool tc_ready, const bool ts_eof, const bool tc_eof, const bool eof)
142 {
143  uint8_t packet_dir;
144  uint8_t opposing_dir;
145  bool packet_dir_ready;
146  const bool opposing_dir_ready = eof;
147  bool opposing_tx_ready;
148  if (p->flowflags & FLOW_PKT_TOSERVER) {
149  packet_dir = STREAM_TOSERVER;
150  opposing_dir = STREAM_TOCLIENT;
151  packet_dir_ready = eof | ts_ready | ts_eof;
152  opposing_tx_ready = tc_ready;
153  } else if (p->flowflags & FLOW_PKT_TOCLIENT) {
154  packet_dir = STREAM_TOCLIENT;
155  opposing_dir = STREAM_TOSERVER;
156  packet_dir_ready = eof | tc_ready | tc_eof;
157  opposing_tx_ready = ts_ready;
158  } else {
159  abort();
160  }
161 
162  SCLogDebug("eof %d ts_ready %d ts_eof %d", eof, ts_ready, ts_eof);
163  SCLogDebug("eof %d tc_ready %d tc_eof %d", eof, tc_ready, tc_eof);
164 
165  SCLogDebug("packet dir %s opposing %s packet_dir_ready %d opposing_dir_ready %d",
166  packet_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT",
167  opposing_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT", packet_dir_ready,
168  opposing_dir_ready);
169 
170  AppLayerGetFileState app_files =
171  AppLayerParserGetTxFiles(f, FlowGetAppState(f), tx, packet_dir);
172  FileContainer *ffc = app_files.fc;
173  AppLayerGetFileState app_files_opposing =
174  AppLayerParserGetTxFiles(f, FlowGetAppState(f), tx, opposing_dir);
175  FileContainer *ffc_opposing = app_files_opposing.fc;
176 
177  /* see if opposing side is finished: if no file support in this direction, of is not
178  * files and tx is done for opposing dir. */
179  bool opposing_finished =
180  ffc_opposing == NULL || (ffc_opposing->head == NULL && opposing_tx_ready);
181  SCLogDebug("opposing_finished %d ffc_opposing %p ffc_opposing->head %p opposing_tx_ready %d",
182  opposing_finished, ffc_opposing, ffc_opposing ? ffc_opposing->head : NULL,
183  opposing_tx_ready);
184 
185  if (ffc || ffc_opposing)
186  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
187  " ffc %p ffc_opposing %p tx_complete %d",
188  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
189 
190  if (ffc) {
191  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | eof;
192  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
193  SCLogDebug("tx: calling files: ffc %p head %p file_close %d file_trunc %d", ffc, ffc->head,
194  file_close, file_trunc);
195  if (filedata_td && txd->files_opened > txd->files_stored)
196  OutputFiledataLogFfc(tv, filedata_td, p, app_files, tx, tx_id, txd, packet_dir,
197  file_close, file_trunc, packet_dir);
198  if (file_td && txd->files_opened > txd->files_logged)
200  tv, file_td, p, ffc, tx, tx_id, txd, file_close, file_trunc, packet_dir);
201  }
202  /* if EOF and we support files, do a final write out */
203  if (opposing_dir_ready && ffc_opposing != NULL) {
204  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | tx_complete | eof;
205  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
206  opposing_finished = true;
207  SCLogDebug("tx: calling for opposing direction files: file_close:%s file_trunc:%s",
208  file_close ? "true" : "false", file_trunc ? "true" : "false");
209  if (filedata_td && txd->files_opened > txd->files_stored)
210  OutputFiledataLogFfc(tv, filedata_td, p, app_files_opposing, tx, tx_id, txd,
211  opposing_dir, file_close, file_trunc, opposing_dir);
212  if (file_td && txd->files_opened > txd->files_logged)
213  OutputFileLogFfc(tv, file_td, p, ffc_opposing, tx, tx_id, txd, file_close, file_trunc,
214  opposing_dir);
215  }
216 
217  const bool tx_done = packet_dir_ready && opposing_finished;
218  SCLogDebug("tx_done %d packet_dir_ready %d opposing_finished %d", tx_done, packet_dir_ready,
219  opposing_finished);
220 
221  /* if not a file tx or if tx is done, set logger flags so tx can move on */
222  const bool is_file_tx = (ffc != NULL || ffc_opposing != NULL);
223  if (!is_file_tx || tx_done) {
224  SCLogDebug("is_file_tx %d tx_done %d", is_file_tx, tx_done);
225  if (file_td) {
226  txd->logged.flags |= BIT_U32(LOGGER_FILE);
227  SCLogDebug("setting LOGGER_FILE => %08x", txd->logged.flags);
228  }
229  if (filedata_td) {
230  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
231  SCLogDebug("setting LOGGER_FILEDATA => %08x", txd->logged.flags);
232  }
233  } else {
234  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
235  " NOT SETTING FILE FLAGS ffc %p ffc_opposing %p tx_complete %d",
236  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
237  }
238 }
239 
240 static void OutputTxLogList0(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data, Packet *p,
241  Flow *f, void *tx, const uint64_t tx_id)
242 {
243  const OutputTxLogger *logger = list[ALPROTO_UNKNOWN];
244  const OutputLoggerThreadStore *store = op_thread_data->store[ALPROTO_UNKNOWN];
245 
246  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
247  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
248  DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
249 
250  while (logger && store) {
251  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
252 
253  SCLogDebug("logger %p", logger);
254 
255  /* always invoke "wild card" tx loggers */
256  SCLogDebug("Logging tx_id %"PRIu64" to logger %d", tx_id, logger->logger_id);
258  logger->LogFunc(tv, store->thread_data, p, f, f->alstate, tx, tx_id);
260 
261  logger = logger->next;
262  store = store->next;
263 
264  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
265  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
266  }
267 }
268 
269 struct Ctx {
270  uint32_t tx_logged_old;
271  uint32_t tx_logged;
272 };
273 
274 static void OutputTxLogCallLoggers(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data,
275  const OutputTxLogger *logger, const OutputLoggerThreadStore *store, Packet *p, Flow *f,
276  void *alstate, void *tx, const uint64_t tx_id, const AppProto alproto, const bool eof,
277  const int tx_progress_ts, const int tx_progress_tc, struct Ctx *ctx)
278 {
279  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
280  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
281  // DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
282 
283  while (logger && store) {
284  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
285  DEBUG_VALIDATE_BUG_ON(logger->alproto != alproto);
286 
287  SCLogDebug("logger %p, Alproto %d LogCondition %p, ts_log_progress %d "
288  "tc_log_progress %d",
289  logger, logger->alproto, logger->LogCondition, logger->ts_log_progress,
290  logger->tc_log_progress);
291  if ((ctx->tx_logged_old & BIT_U32(logger->logger_id)) == 0) {
292  SCLogDebug("alproto match %d, logging tx_id %" PRIu64, logger->alproto, tx_id);
293 
294  SCLogDebug("pcap_cnt %" PRIu64 ", tx_id %" PRIu64 " logger %d. EOF %s", p->pcap_cnt,
295  tx_id, logger->logger_id, eof ? "true" : "false");
296 
297  if (eof) {
298  SCLogDebug("EOF, so log now");
299  } else {
300  if (logger->LogCondition) {
301  if (!logger->LogCondition(tv, p, alstate, tx, tx_id)) {
302  SCLogDebug("conditions not met, not logging");
303  goto next_logger;
304  }
305  } else {
306  if (tx_progress_tc < logger->tc_log_progress) {
307  SCLogDebug("progress not far enough, not logging");
308  goto next_logger;
309  }
310 
311  if (tx_progress_ts < logger->ts_log_progress) {
312  SCLogDebug("progress not far enough, not logging");
313  goto next_logger;
314  }
315  }
316  }
317 
318  SCLogDebug("Logging tx_id %" PRIu64 " to logger %d", tx_id, logger->logger_id);
320  logger->LogFunc(tv, store->thread_data, p, f, alstate, tx, tx_id);
322 
323  ctx->tx_logged |= BIT_U32(logger->logger_id);
324  }
325 
326  next_logger:
327  logger = logger->next;
328  store = store->next;
329 
330  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
331  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
332  }
333 }
334 
335 static TmEcode OutputTxLog(ThreadVars *tv, Packet *p, void *thread_data)
336 {
337  DEBUG_VALIDATE_BUG_ON(thread_data == NULL);
338  if (p->flow == NULL)
339  return TM_ECODE_OK;
340  if (!PKT_IS_PSEUDOPKT(p) && p->app_update_direction == 0 &&
341  ((PKT_IS_TOSERVER(p) && (p->flow->flags & FLOW_TS_APP_UPDATED) == 0) ||
342  (PKT_IS_TOCLIENT(p) && (p->flow->flags & FLOW_TC_APP_UPDATED) == 0))) {
343  SCLogDebug("not pseudo, no app update: skip");
344  return TM_ECODE_OK;
345  }
346  if ((p->flags & PKT_STREAM_EST) == 0 && p->proto == IPPROTO_TCP) {
347  return TM_ECODE_OK;
348  }
349  SCLogDebug("pseudo, or app update: run output");
350 
351  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
352 
353  Flow * const f = p->flow;
354  const uint8_t ipproto = f->proto;
355  const AppProto alproto = f->alproto;
356  SCLogDebug("pcap_cnt %u tx logging %u/%s", (uint32_t)p->pcap_cnt, alproto,
357  AppProtoToString(alproto));
358 
359  const bool file_logging_active = (op_thread_data->file || op_thread_data->filedata);
360  if (!file_logging_active) {
361  if (list[alproto] == NULL && list[ALPROTO_UNKNOWN] == NULL) {
362  SCLogDebug("bail");
363  /* No child loggers registered. */
364  return TM_ECODE_OK;
365  }
366  if (AppLayerParserProtocolHasLogger(ipproto, alproto) == 0)
367  goto end;
368  }
369  void *alstate = f->alstate;
370  if (alstate == NULL) {
371  SCLogDebug("no alstate");
372  goto end;
373  }
374  const LoggerId logger_expectation = AppLayerParserProtocolGetLoggerBits(ipproto, alproto);
375  if (logger_expectation == 0) {
376  SCLogDebug("bail: logger_expectation %u. LOGGER_FILE %u LOGGER_FILEDATA %u",
377  logger_expectation, LOGGER_FILE, LOGGER_FILEDATA);
378  goto end;
379  }
380  SCLogDebug("pcap_cnt %" PRIu64, p->pcap_cnt);
381 
382  const bool last_pseudo = (p->flowflags & FLOW_PKT_LAST_PSEUDO) != 0;
383  const bool ts_eof = AppLayerParserStateIssetFlag(f->alparser,
385  const bool tc_eof = AppLayerParserStateIssetFlag(f->alparser,
387 
388  const bool eof = last_pseudo || (ts_eof && tc_eof);
389  SCLogDebug("eof %d last_pseudo %d ts_eof %d tc_eof %d", eof, last_pseudo, ts_eof, tc_eof);
390 
391  const uint8_t ts_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOSERVER);
392  const uint8_t tc_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOCLIENT);
393  SCLogDebug("ts_disrupt_flags %02x tc_disrupt_flags %02x", ts_disrupt_flags, tc_disrupt_flags);
394  const uint64_t total_txs = AppLayerParserGetTxCnt(f, alstate);
395  uint64_t tx_id = AppLayerParserGetTransactionLogId(f->alparser);
396  uint64_t max_id = tx_id;
397  int logged = 0;
398  int gap = 0;
399  const bool support_files = AppLayerParserSupportsFiles(ipproto, alproto);
400  const uint8_t pkt_dir = STREAM_FLAGS_FOR_PACKET(p);
401 
402  SCLogDebug("pcap_cnt %" PRIu64 ": tx_id %" PRIu64 " total_txs %" PRIu64, p->pcap_cnt, tx_id,
403  total_txs);
404 
405  AppLayerGetTxIteratorFunc IterFunc = AppLayerGetTxIterator(ipproto, alproto);
407  memset(&state, 0, sizeof(state));
408 
409  const int complete_ts =
410  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOSERVER);
411  const int complete_tc =
412  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOCLIENT);
413  while (1) {
414  AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, tx_id, total_txs, &state);
415  if (ires.tx_ptr == NULL)
416  break;
417  void * const tx = ires.tx_ptr;
418  tx_id = ires.tx_id;
419  SCLogDebug("STARTING tx_id %" PRIu64 ", tx %p", tx_id, tx);
420 
421  const int tx_progress_ts =
422  AppLayerParserGetStateProgress(ipproto, alproto, tx, ts_disrupt_flags);
423  const int tx_progress_tc =
424  AppLayerParserGetStateProgress(ipproto, alproto, tx, tc_disrupt_flags);
425  const bool tx_complete = (tx_progress_ts == complete_ts && tx_progress_tc == complete_tc);
426 
427  SCLogDebug("file_thread_data %p filedata_thread_data %p", op_thread_data->file,
428  op_thread_data->filedata);
429 
430  AppLayerTxData *txd = AppLayerParserGetTxData(ipproto, alproto, tx);
431  if (unlikely(txd == NULL)) {
432  SCLogDebug("NO TXD");
433  /* make sure this tx, which can't be properly logged is skipped */
434  logged = 1;
435  max_id = tx_id;
436  goto next_tx;
437  }
438 
439  if (file_logging_active) {
440  if (AppLayerParserIsFileTx(txd)) { // need to process each tx that might be a file tx,
441  // even if there are not files (yet)
442  const bool ts_ready = (tx_progress_ts == complete_ts);
443  const bool tc_ready = (tx_progress_tc == complete_tc);
444  SCLogDebug("ts_ready %d tc_ready %d", ts_ready, tc_ready);
445 
446  const bool eval_files = ts_ready | tc_ready | tx_complete | ts_eof | tc_eof | eof;
447 
448  SCLogDebug("eval_files: %u, ts_ready %u, tc_ready %u, tx_complete %u, ts_eof %u, "
449  "tc_eof %u, eof %u",
450  eval_files, ts_ready, tc_ready, tx_complete, ts_eof, tc_eof, eof);
451  SCLogDebug("txd->file_tx & pkt_dir: %02x & %02x -> %02x", txd->file_tx, pkt_dir,
452  (txd->file_tx & pkt_dir));
453 
454  /* call only for the correct direction, except when it looks anything like a end of
455  * transaction or end of stream. Since OutputTxLogFiles has complicated logic around
456  * that, we just leave it to that function to sort things out for now. */
457  if (eval_files || AppLayerParserIsFileTxInDir(txd, pkt_dir)) {
458  OutputTxLogFiles(tv, op_thread_data->file, op_thread_data->filedata, p, f, tx,
459  tx_id, txd, tx_complete, ts_ready, tc_ready, ts_eof, tc_eof, eof);
460  }
461  } else if (support_files) {
462  if (op_thread_data->file) {
463  txd->logged.flags |= BIT_U32(LOGGER_FILE);
464  SCLogDebug("not a file_tx: setting LOGGER_FILE => %08x", txd->logged.flags);
465  }
466  if (op_thread_data->filedata) {
467  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
468  SCLogDebug("not a file_tx: setting LOGGER_FILEDATA => %08x", txd->logged.flags);
469  }
470  }
471  }
472  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
473 
474  if (list[ALPROTO_UNKNOWN] != 0) {
475  OutputTxLogList0(tv, op_thread_data, p, f, tx, tx_id);
476  if (list[alproto] == NULL)
477  goto next_tx;
478  }
479 
480  SCLogDebug("tx %p/%" PRIu64 " txd %p: log_flags %x logger_expectation %x", tx, tx_id, txd,
481  txd->config.log_flags, logger_expectation);
482  if (txd->config.log_flags & BIT_U8(CONFIG_TYPE_TX)) {
483  SCLogDebug("SKIP tx %p/%"PRIu64, tx, tx_id);
484  // so that AppLayerParserTransactionsCleanup can clean this tx
485  txd->logged.flags |= logger_expectation;
486  goto next_tx;
487  }
488 
489  if (txd->logged.flags == logger_expectation) {
490  SCLogDebug("fully logged");
491  /* tx already fully logged */
492  goto next_tx;
493  }
494 
495  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
496  const OutputTxLogger *logger = list[alproto];
497  const OutputLoggerThreadStore *store = op_thread_data->store[alproto];
498  struct Ctx ctx = { .tx_logged = txd->logged.flags, .tx_logged_old = txd->logged.flags };
499  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
500 
501  OutputTxLogCallLoggers(tv, op_thread_data, logger, store, p, f, alstate, tx, tx_id, alproto,
502  eof, tx_progress_ts, tx_progress_tc, &ctx);
503 
504  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
505  if (ctx.tx_logged != ctx.tx_logged_old) {
506  SCLogDebug("logger: storing %08x (was %08x)", ctx.tx_logged, ctx.tx_logged_old);
507  DEBUG_VALIDATE_BUG_ON(txd == NULL);
508  txd->logged.flags |= ctx.tx_logged;
509  }
510 
511  /* If all loggers logged set a flag and update the last tx_id
512  * that was logged.
513  *
514  * If not all loggers were logged we flag that there was a gap
515  * so any subsequent transactions in this loop don't increase
516  * the maximum ID that was logged. */
517  if (!gap && ctx.tx_logged == logger_expectation) {
518  SCLogDebug("no gap %d, %08x == %08x", gap, ctx.tx_logged, logger_expectation);
519  logged = 1;
520  max_id = tx_id;
521  SCLogDebug("max_id %" PRIu64, max_id);
522  } else {
523  gap = 1;
524  }
525 next_tx:
526  if (!ires.has_next)
527  break;
528  tx_id++;
529  }
530 
531  /* Update the last ID that has been logged with all
532  * transactions before it. */
533  if (logged) {
534  SCLogDebug("updating log tx_id %"PRIu64, max_id);
536  }
537 
538 end:
539  return TM_ECODE_OK;
540 }
541 
542 /** \brief thread init for the tx logger
543  * This will run the thread init functions for the individual registered
544  * loggers */
545 static TmEcode OutputTxLogThreadInit(ThreadVars *tv, const void *_initdata, void **data)
546 {
547  OutputTxLoggerThreadData *td = SCCalloc(1, sizeof(*td));
548  if (td == NULL)
549  return TM_ECODE_FAILED;
550 
551  *data = (void *)td;
552  SCLogDebug("OutputTxLogThreadInit happy (*data %p)", *data);
553 
554  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
555  OutputTxLogger *logger = list[alproto];
556  while (logger) {
557  if (logger->ThreadInit) {
558  void *retptr = NULL;
559  if (logger->ThreadInit(tv, (void *)logger->output_ctx, &retptr) == TM_ECODE_OK) {
560  OutputLoggerThreadStore *ts = SCCalloc(1, sizeof(*ts));
561  /* todo */ BUG_ON(ts == NULL);
562 
563  /* store thread handle */
564  ts->thread_data = retptr;
565 
566  if (td->store[alproto] == NULL) {
567  td->store[alproto] = ts;
568  } else {
569  OutputLoggerThreadStore *tmp = td->store[alproto];
570  while (tmp->next != NULL)
571  tmp = tmp->next;
572  tmp->next = ts;
573  }
574 
575  SCLogDebug("%s is now set up", logger->name);
576  }
577  }
578 
579  logger = logger->next;
580  }
581  }
582 
583  if (g_file_logger_enabled) {
584  if (OutputFileLogThreadInit(tv, &td->file) != TM_ECODE_OK) {
585  FatalError("failed to set up file thread data");
586  }
587  }
590  FatalError("failed to set up filedata thread data");
591  }
592  }
593 
594  SCLogDebug("file_thread_data %p filedata_thread_data %p", td->file, td->filedata);
595 
596  return TM_ECODE_OK;
597 }
598 
599 static TmEcode OutputTxLogThreadDeinit(ThreadVars *tv, void *thread_data)
600 {
601  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
602 
603  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
604  OutputLoggerThreadStore *store = op_thread_data->store[alproto];
605  OutputTxLogger *logger = list[alproto];
606 
607  while (logger && store) {
608  if (logger->ThreadDeinit) {
609  logger->ThreadDeinit(tv, store->thread_data);
610  }
611 
612  OutputLoggerThreadStore *next_store = store->next;
613  SCFree(store);
614  store = next_store;
615  logger = logger->next;
616  }
617  }
618 
619  if (op_thread_data->file) {
620  OutputFileLogThreadDeinit(tv, op_thread_data->file);
621  }
622  if (op_thread_data->filedata) {
623  OutputFiledataLogThreadDeinit(tv, op_thread_data->filedata);
624  }
625 
626  SCFree(op_thread_data);
627  return TM_ECODE_OK;
628 }
629 
630 static void OutputTxLogExitPrintStats(ThreadVars *tv, void *thread_data)
631 {
632  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
633 
634  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
635  OutputLoggerThreadStore *store = op_thread_data->store[alproto];
636  OutputTxLogger *logger = list[alproto];
637 
638  while (logger && store) {
639  if (logger->ThreadExitPrintStats) {
640  logger->ThreadExitPrintStats(tv, store->thread_data);
641  }
642 
643  logger = logger->next;
644  store = store->next;
645  }
646  }
647 }
648 
649 static uint32_t OutputTxLoggerGetActiveCount(void)
650 {
651  uint32_t cnt = 0;
652  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
653  for (OutputTxLogger *p = list[alproto]; p != NULL; p = p->next) {
654  cnt++;
655  }
656  }
657 
658  if (g_file_logger_enabled) {
659  cnt++;
660  SCLogDebug("g_file_logger_enabled");
661  }
663  cnt++;
664  SCLogDebug("g_filedata_logger_enabled");
665  }
666 
667  return cnt;
668 }
669 
670 
672 {
673  OutputRegisterRootLogger(OutputTxLogThreadInit, OutputTxLogThreadDeinit,
674  OutputTxLogExitPrintStats, OutputTxLog, OutputTxLoggerGetActiveCount);
675 }
676 
678 {
679  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
680  OutputTxLogger *logger = list[alproto];
681  while (logger) {
682  OutputTxLogger *next_logger = logger->next;
683  SCFree(logger);
684  logger = next_logger;
685  }
686  list[alproto] = NULL;
687  }
688 }
PKT_IS_TOCLIENT
#define PKT_IS_TOCLIENT(p)
Definition: decode.h:244
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:204
OutputTxLogger_::alproto
AppProto alproto
Definition: output-tx.c:50
Packet_::proto
uint8_t proto
Definition: decode.h:504
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:1530
OutputTxLoggerRegister
void OutputTxLoggerRegister(void)
Definition: output-tx.c:671
AppLayerParserProtocolHasLogger
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1540
OutputFileLoggerThreadData_
Definition: output-file.h:33
AppLayerParserSetTransactionLogId
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
Definition: app-layer-parser.c:705
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:1330
FLOW_PKT_LAST_PSEUDO
#define FLOW_PKT_LAST_PSEUDO
Definition: flow.h:237
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:615
LOGGER_FILEDATA
@ LOGGER_FILEDATA
Definition: suricata-common.h:469
OutputTxShutdown
void OutputTxShutdown(void)
Definition: output-tx.c:677
Ctx
Definition: output-tx.c:269
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
Packet_::pcap_cnt
uint64_t pcap_cnt
Definition: decode.h:609
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:690
Flow_::proto
uint8_t proto
Definition: flow.h:378
Ctx::tx_logged
uint32_t tx_logged
Definition: output-tx.c:271
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:82
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:1086
Packet_::flags
uint32_t flags
Definition: decode.h:519
Flow_
Flow data structure.
Definition: flow.h:356
OutputFiledataLogThreadDeinit
TmEcode OutputFiledataLogThreadDeinit(ThreadVars *tv, OutputFiledataLoggerThreadData *op_thread_data)
Definition: output-filedata.c:250
LoggerId
LoggerId
Definition: suricata-common.h:460
AppLayerParserGetTransactionLogId
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
Definition: app-layer-parser.c:698
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
Definition: app-layer-protos.c:76
AppLayerParserSupportsFiles
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1168
logged
int logged
Definition: app-layer-htp.h:1
FLOW_TC_APP_UPDATED
#define FLOW_TC_APP_UPDATED
Definition: flow.h:118
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1115
g_filedata_logger_enabled
bool g_filedata_logger_enabled
Definition: output-filedata.c:37
OutputLoggerThreadStore_::next
struct OutputLoggerThreadStore_ * next
Definition: output.h:35
FLOW_PKT_TOSERVER
#define FLOW_PKT_TOSERVER
Definition: flow.h:228
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:513
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:77
OutputTxLogger_::ThreadDeinit
TmEcode(* ThreadDeinit)(ThreadVars *, void *)
Definition: output-tx.c:61
Ctx::tx_logged_old
uint32_t tx_logged_old
Definition: output-tx.c:270
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
OutputCtx_
Definition: tm-modules.h:85
OutputTxLoggerThreadData
struct OutputTxLoggerThreadData_ OutputTxLoggerThreadData
OutputLoggerThreadStore_::thread_data
void * thread_data
Definition: output.h:34
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:480
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
PKT_IS_TOSERVER
#define PKT_IS_TOSERVER(p)
Definition: decode.h:243
OutputFileLogThreadDeinit
TmEcode OutputFileLogThreadDeinit(ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data)
Definition: output-file.c:215
OutputTxLoggerThreadData_::filedata
OutputFiledataLoggerThreadData * filedata
Definition: output-tx.c:43
BIT_U32
#define BIT_U32(n)
Definition: suricata-common.h:400
PKT_PSEUDO_STREAM_END
#define PKT_PSEUDO_STREAM_END
Definition: decode.h:1279
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:40
app-layer-parser.h
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:300
util-profiling.h
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:482
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:128
OutputTxLogger_::ThreadExitPrintStats
void(* ThreadExitPrintStats)(ThreadVars *, void *)
Definition: output-tx.c:62
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:229
TxLoggerCondition
bool(* TxLoggerCondition)(ThreadVars *, const Packet *, void *state, void *tx, uint64_t tx_id)
Definition: output-tx.h:38
PACKET_PROFILING_LOGGER_END
#define PACKET_PROFILING_LOGGER_END(p, id)
Definition: util-profiling.h:241
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1370
cnt
uint32_t cnt
Definition: tmqh-packetpool.h:7
Packet_::flow
struct Flow_ * flow
Definition: decode.h:521
BIT_U8
#define BIT_U8(n)
Definition: suricata-common.h:398
suricata-common.h
OutputTxLogger
struct OutputTxLogger_ OutputTxLogger
Packet_::app_update_direction
uint8_t app_update_direction
Definition: decode.h:516
FLOW_TS_APP_UPDATED
#define FLOW_TS_APP_UPDATED
Definition: flow.h:117
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:100
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1178
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:168
util-validate.h
LOGGER_FILE
@ LOGGER_FILE
Definition: suricata-common.h:468
Packet_::next
struct Packet_ * next
Definition: decode.h:618
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:481
Flow_::flags
uint32_t flags
Definition: flow.h:426
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:837
OutputTxLogger_::name
const char * name
Definition: output-tx.c:55
AppLayerParserProtocolGetLoggerBits
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1548
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:871
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1138
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:1797
g_file_logger_enabled
bool g_file_logger_enabled
Definition: output-file.c:39
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:455
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
OutputTxLogger_::id
uint32_t id
Definition: output-tx.c:57
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *f, void *alstate)
Definition: app-layer-parser.c:1101
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:102
output.h
PKT_STREAM_EST
#define PKT_STREAM_EST
Definition: decode.h:1274
ThreadDeinitFunc
TmEcode(* ThreadDeinitFunc)(ThreadVars *, void *)
Definition: tm-modules.h:41
OutputTxLoggerThreadData_
Definition: output-tx.c:37
app-layer.h