Merge pull request #229 from sy-c/master

v2.14.1

Author: sy-c

CMakeLists.txt

@@ -31,6 +31,9 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -Wall -Wextra -Wno-deprecated-de
 # -Wno-unused-variable -Wno-unused-parameter -Wno-unused-private-field
 # -g -O0
 
+# ensure debug symbols always included
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
+
 # by default, build optimized release code
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE RelWithDebInfo)
@@ -71,6 +74,7 @@ find_package(Occ)
 find_package(BookkeepingApiCpp)
 find_package(ZMQ)
 find_package(MySQL)
+#find_package(gperftools)
 
 # extract include directories from targets
 get_target_property(InfoLogger_INCLUDE_DIRS AliceO2::InfoLogger INTERFACE_INCLUDE_DIRECTORIES)
@@ -138,8 +142,14 @@ else ()
   message(STATUS "MySQL not found, corresponding features will be disabled.")
 endif()
 
+# check Gperftools
+if(${gperftools_FOUND})
+  message(STATUS "gperftools enabled")
+endif()
+
+
 # add flags to enable optional features in Readout, based on available dependencies
-add_compile_definitions($<$<BOOL:${Numa_FOUND}>:WITH_NUMA> $<$<BOOL:${RDMA_FOUND}>:WITH_RDMA> $<$<BOOL:${Configuration_FOUND}>:WITH_CONFIG> $<$<BOOL:${FairMQ_FOUND}>:WITH_FAIRMQ> $<$<BOOL:${Occ_FOUND}>:WITH_OCC> $<$<BOOL:${BookkeepingApiCpp_FOUND}>:WITH_LOGBOOK> $<$<BOOL:${ZMQ_FOUND}>:WITH_ZMQ> $<$<BOOL:${MYSQL_FOUND}>:WITH_DB> $<$<BOOL:${ReadoutCard_FOUND}>:WITH_READOUTCARD> )
+add_compile_definitions($<$<BOOL:${Numa_FOUND}>:WITH_NUMA> $<$<BOOL:${RDMA_FOUND}>:WITH_RDMA> $<$<BOOL:${Configuration_FOUND}>:WITH_CONFIG> $<$<BOOL:${FairMQ_FOUND}>:WITH_FAIRMQ> $<$<BOOL:${Occ_FOUND}>:WITH_OCC> $<$<BOOL:${BookkeepingApiCpp_FOUND}>:WITH_LOGBOOK> $<$<BOOL:${ZMQ_FOUND}>:WITH_ZMQ> $<$<BOOL:${MYSQL_FOUND}>:WITH_DB> $<$<BOOL:${ReadoutCard_FOUND}>:WITH_READOUTCARD> $<$<BOOL:${gperftools_FOUND}>:WITH_GPERFTOOLS>)
 
 # define include directories
 set(READOUT_INCLUDE_DIRS
@@ -179,6 +189,9 @@ if(MYSQL_FOUND)
   list(APPEND READOUT_INCLUDE_DIRS ${MYSQL_INCLUDE_DIRS}) 
   list(APPEND READOUT_LINK_LIBRARIES ${MYSQL_LIBRARIES})
 endif()
+if(gperftools_FOUND)
+  list(APPEND READOUT_LINK_LIBRARIES ${gperftools_LIBRARIES})
+endif()
 
 # some systems don't need an explicit library to have dlopen()
 if (CMAKE_DL_LIBS)

cmake/Findgperftools.cmake

@@ -0,0 +1,31 @@
+# Try to find the gperftools package include dirs and libraries
+# Author: Sylvain Chapeland
+#
+# This script will set the following variables:
+#  gperftools_FOUND - System has gperftools
+#  gperftools_INCLUDE_DIRS - The gperftools include directories
+#  gperftools_LIBRARIES - The libraries needed to use gperftools
+#
+# This script can use the following variables:
+#  gperftools_ROOT - Installation root to tell this module where to look.
+
+
+find_path(
+  gperftools_INCLUDE_DIRS NAMES gperftools/profiler.h
+  PATHS ${gperftools_ROOT} ${gperftools_ROOT}/include)
+  
+find_library(
+  gperftools_LIBRARIES NAMES profiler tcmalloc
+  PATHS ${gperftools_ROOT} ${gperftools_ROOT}/lib)
+  
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(
+  gperftools DEFAULT_MSG gperftools_INCLUDE_DIRS gperftools_LIBRARIES)
+
+if(${gperftools_FOUND})
+    message(
+    STATUS
+    "Found gperftools (include: ${gperftools_INCLUDE_DIRS} library: ${gperftools_LIBRARIES})")    
+endif()
+
+mark_as_advanced(gperftools_INCLUDE_DIRS gperftools_LIBRARIES)

doc/releaseNotes.md

@@ -480,3 +480,7 @@ This file describes the main feature changes for each readout.exe released versi
 ## v2.13.0 - 11/08/2022
 - Updated configuration parameters:
   - added equipment-*.numaNode. If set, memory / thread will try to use given NUMA node. If "auto", will try to guess it for given equipment (eg ROC). "auto" is default.
+
+## v2.14.1 - 22/08/2022
+- Updated configuration parameters:
+  - added consumer-FairMQChannel-*.threads. If set, a pool of threads is used for FMQ message formatting. Needed at high rates when a single CPU core is not enough to prepare data for DataDistribution (including overlapping HBF copy).

src/Consumer.cxx

@@ -14,6 +14,10 @@
 
 Consumer::Consumer(ConfigFile& cfg, std::string cfgEntryPoint)
 {
+  // by default, name the equipment as the config node entry point
+  // configuration parameter: | consumer-* | name | string| | Name used to identify this consumer (in logs). By default, it takes the name of the configuration section, consumer-xxx |
+  cfg.getOptionalValue<std::string>(cfgEntryPoint + ".name", name, cfgEntryPoint);
+
   // configuration parameter: | consumer-* | filterLinksInclude | string |  | Defines a filter based on link ids. Only data belonging to the links in this list (coma separated values) are accepted. If empty, all link ids are fine. |
   std::string cfgFilterLinksInclude;
   cfg.getOptionalValue<std::string>(cfgEntryPoint + ".filterLinksInclude", cfgFilterLinksInclude);

src/Consumer.h

@@ -42,7 +42,8 @@ class Consumer
   // Function called just after stopping data taking, after the last call to pushData(). Not called before input FIFO empty.
   virtual int stop()
   {
-    theLog.log(LogInfoDevel_(3003), "Push statistics for %s: %llu err / %llu total (DataSets), %llu/%llu filtered (DataBlocks)", this->name.c_str(), totalPushError, totalPushError + totalPushSuccess, totalBlocksFiltered, totalBlocksUnfiltered + totalBlocksFiltered);
+    theLog.log(LogInfoDevel_(3003), "Push statistics for %s: %llu err / %llu total (DataSets), %llu/%llu filtered (DataBlocks)",
+      this->name.c_str(), totalPushError.load(), totalPushError.load() + totalPushSuccess.load(), totalBlocksFiltered.load(), totalBlocksUnfiltered.load() + totalBlocksFiltered.load());
     return 0;
   };
 
@@ -53,10 +54,10 @@ class Consumer
   bool stopOnError = false;            // if set, readout will stop when this consumer reports an error (isError flag or pushData() failing)
   int isError = 0;                     // flag which might be used to count number of errors occuring in the consumer
   bool isErrorReported = false;        // flag to keep track of error reports for this consumer
-  unsigned long long totalPushSuccess = 0;
-  unsigned long long totalPushError = 0;
-  unsigned long long totalBlocksFiltered = 0;
-  unsigned long long totalBlocksUnfiltered = 0;
+  std::atomic<unsigned long long> totalPushSuccess = 0;
+  std::atomic<unsigned long long> totalPushError = 0;
+  std::atomic<unsigned long long> totalBlocksFiltered = 0;
+  std::atomic<unsigned long long> totalBlocksUnfiltered = 0;
 
  protected:
   // check if a DataBlock passes defined filters. Return 1 if ok, zero if not.