commit 054b6a80439532b6c74be6b8c27f494a9f8330e2
author JosiahWI <41302989+JosiahWI@users.noreply.github.com> Tue Jun 11 15:16:08 2024 -0500
committer GitHub <noreply@github.com> Tue Jun 11 15:16:08 2024 -0500
tree f532541be07a5f8ae09d4e649bb01486fb590bb3
parent 348aedf77c2c19a3a2269c13aceced4d4f53e512

Fix race condition causing interleaved logs  (#11432)

* Remove unused argument from mime_hdr_print

This removes the unused heap argument and updates calls across the whole
codebase accordingly.

* Constify some arguments for MIME printing

This constifies some arguments to mime_field_print and mime_hdr_print and
updates usage throughout the codebase accordingly.

* Remove unused argument from http_hdr_print

This removes the heap argument from the method and updates the usage
throughout the codebase.

* Constify argument to http_hdr_status_get

* Constify argument to http_hdr_print

This marks the hdr argument to http_hdr_print as const.

* Constify the HTTPHdr::print method

* Fix race condition causing interleaved logs

The output of the `DUMP_HEADER` macro was being written in multiple calls to
fprintf() that raced with other logging, resulting in interleaved output that
intermittently failed the ja3_fingerprint AuTest on CI. Whether other AuTest
failures were related to the same issue is unknown at this point.

This fixes the race condition by batching the calls to a single fprintf() call.
This also refactors the macro to two inline functions. In a benchmark using an
expanded version of the headers in the HttpTransact tests, a 60% speedup was
measured over the macro if all the header data fit in the buffer. In the worst
case that the buffer could only hold a byte at a time, the speedup was 80%.
The benchmark was compiled with -O3 and stderr was piped to /dev/null.

These were the headers used for the benchmark:
```
  header input1[] = {
    {"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "111111111111111111111111"},
    {"BBB",                               "222"                     },
    {"CCC",                               "333"                     },
    {"DDD",                               "333"                     },
    {"EEE",                               "333"                     },
    {"FFF",                               "333"                     },
    {"GGG",                               "333"                     },
    {"HHH",                               "333"                     },
    {"III",                               "333"                     },
    {"JJJ",                               "333"                     },
    {"KKK",                               "333"                     },
  };
```

This fixes #11431.

* Implement changes requested by Brian Neradt

This makes the following changes:

 * The length parameter to string::append is used instead of adding a
   null terminator.
 * Some erroneous logic left over from testing is fixed.

* Fix formatting

* Add log output to dump_header for invalid hdrs

* Remove bufp parameter from TSMimeHdrPrint

This is an API change. The parameter is no longer used, so this commit removes
it and updates the developer documentation and core plugins accordingly.

* Fix the example plugins

Since the API changed, the example plugins now need updating as well.