Merge pull request #251 from sy-c/master

v2.18.4

Author: sy-c

doc/configurationParameters.md

@@ -69,7 +69,8 @@ The parameters related to 3rd-party libraries are described here for convenience
 | consumer-FairMQChannel-* | memoryPoolNumberOfPages | int | 100 | c.f. same parameter in bank-*. |
 | consumer-FairMQChannel-* | memoryPoolPageSize | bytes | 128k | c.f. same parameter in bank-*. |
 | consumer-FairMQChannel-* | sessionName | string | default | Name of the FMQ session. c.f. FairMQ::FairMQChannel.h |
-| consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of thread is created for the data processing. |
+| consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of threads is created for the data processing. |
+| consumer-FairMQChannel-* | threadsFifoSize | int | 0 | Incoming FIFO size for processing threads. By default, value is guessed. |
 | consumer-FairMQChannel-* | unmanagedMemorySize | bytes |  | Size of the memory region to be created. c.f. FairMQ::FairMQUnmanagedRegion.h. If not set, no special FMQ memory region is created. |
 | consumer-fileRecorder-* | bytesMax | bytes | 0 | Maximum number of bytes to write to each file. Data pages are never truncated, so if writing the full page would exceed this limit, no data from that page is written at all and file is closed. If zero (default), no maximum size set.|
 | consumer-fileRecorder-* | dataBlockHeaderEnabled | int | 0 | Enable (1) or disable (0) the writing to file of the internal readout header (Readout DataBlock.h) between the data pages, to easily navigate through the file without RDH decoding. If disabled, the raw data pages received from CRU are written without further formatting. |

doc/releaseNotes.md

@@ -551,3 +551,7 @@ This file describes the main feature changes for each readout.exe released versi
 
 ## v2.18.3 - 05/04/2023
 - Fixed bug introduced in v2.18.0 causing crash when overlapping HBF copy buffer empty.
+
+## v2.18.4 - 06/06/2023
+- Updated configuration parameters:
+  - added consumer-FairMQchannel.threadsFifoSize

src/ConsumerFMQchannel.cxx

@@ -423,13 +423,13 @@ class ConsumerFMQchannel : public Consumer
     cfg.getOptionalValue<int>(cfgEntryPoint + ".enablePackedCopy", enablePackedCopy);
     theLog.log(LogInfoDevel_(3008), "Packed copy enabled = %d", enablePackedCopy);
 
-    // configuration parameter: | consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of thread is created for the data processing. |
+    // configuration parameter: | consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of threads is created for the data processing. |
     cfg.getOptionalValue<int>(cfgEntryPoint + ".threads", nwThreads);
     if (nwThreads) {
-      theLog.log(LogInfoDevel_(3008), "Using %d threads for DD formatting", nwThreads);
-    }
-    if (nwThreads) {
-      wThreadFifoSize = 88 / nwThreads; // 1s of buffer
+      // configuration parameter: | consumer-FairMQChannel-* | threadsFifoSize | int | 0 | Incoming FIFO size for processing threads. By default, value is guessed. |
+      wThreadFifoSize = memoryPoolNumberOfPages / nwThreads; // by default, enough slots to store all pages from this pool
+      cfg.getOptionalValue<int>(cfgEntryPoint + ".threadsFifoSize", wThreadFifoSize);
+      theLog.log(LogInfoDevel_(3008), "Using %d threads for DD formatting, FIFO size = %d", nwThreads, wThreadFifoSize);
       wThreads.resize(nwThreads);
       wThreadShutdown = 0;
       int isError = 0;
@@ -707,7 +707,8 @@ class ConsumerFMQchannel : public Consumer
        if ((!isError)||(!dropEntireTFonError)) {
          // ensure end-of-timeframe flag is set for last message
          if (msglist->size()) {
-           msglist->back().stfHeader->lastTFMessage = 1;
+           // TODO: add a warning + option to force set bit
+           //msglist->back().stfHeader->lastTFMessage = 1;
          }
 	 if (wThreads[thIx].output->push(std::move(msglist))) {
            isError = 1;

src/ReadoutVersion.h

@@ -9,5 +9,5 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#define READOUT_VERSION "2.18.3"
+#define READOUT_VERSION "2.18.4"
 

src/readoutConfigEditor.tcl

@@ -45,7 +45,8 @@ set configurationParametersDescriptor {
 | consumer-FairMQChannel-* | memoryPoolNumberOfPages | int | 100 | c.f. same parameter in bank-*. |
 | consumer-FairMQChannel-* | memoryPoolPageSize | bytes | 128k | c.f. same parameter in bank-*. |
 | consumer-FairMQChannel-* | sessionName | string | default | Name of the FMQ session. c.f. FairMQ::FairMQChannel.h |
-| consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of thread is created for the data processing. |
+| consumer-FairMQChannel-* | threads | int | 0 | If set, a pool of threads is created for the data processing. |
+| consumer-FairMQChannel-* | threadsFifoSize | int | 0 | Incoming FIFO size for processing threads. By default, value is guessed. |
 | consumer-FairMQChannel-* | unmanagedMemorySize | bytes |  | Size of the memory region to be created. c.f. FairMQ::FairMQUnmanagedRegion.h. If not set, no special FMQ memory region is created. |
 | consumer-fileRecorder-* | bytesMax | bytes | 0 | Maximum number of bytes to write to each file. Data pages are never truncated, so if writing the full page would exceed this limit, no data from that page is written at all and file is closed. If zero (default), no maximum size set.|
 | consumer-fileRecorder-* | dataBlockHeaderEnabled | int | 0 | Enable (1) or disable (0) the writing to file of the internal readout header (Readout DataBlock.h) between the data pages, to easily navigate through the file without RDH decoding. If disabled, the raw data pages received from CRU are written without further formatting. |