Split StateMachine and Tools into separate targets

This change is needed to share the functionality between
the core library and the SDK library. We want to support building/installing
just the SDK without having a dependency on the core library which adds
additional dependencies.

CMakeLists.txt

@@ -139,12 +139,7 @@ endif()
 
 
 # Targets ######################################################################
-if(BUILD_FAIRMQ)
+if(BUILD_FAIRMQ OR BUILD_SDK)
-  configure_file(${PROJECT_NAME_LOWER}/Version.h.in
-    ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-    @ONLY
-  )
-
   add_subdirectory(fairmq)
 endif()
 
@@ -165,10 +160,6 @@ if(BUILD_DOCS)
   doxygen_add_docs(doxygen README.md fairmq)
   add_custom_target(docs ALL DEPENDS doxygen)
 endif()
-
-if(BUILD_SDK)
-  add_subdirectory(fairmq/sdk)
-endif()
 ################################################################################
 
 
@@ -205,10 +196,6 @@ endif()
 
 # Installation #################################################################
 if(BUILD_FAIRMQ)
-  install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
-    DESTINATION ${PROJECT_INSTALL_INCDIR}
-  )
-
   install(FILES cmake/FindZeroMQ.cmake
     DESTINATION ${PROJECT_INSTALL_CMAKEMODDIR}
   )

FairMQTest.cmake

@@ -29,6 +29,7 @@ Set(configure_options "${configure_options};-DCMAKE_PREFIX_PATH=$ENV{SIMPATH}")
 Set(configure_options "${configure_options};-DBUILD_NANOMSG_TRANSPORT=ON")
 # Set(configure_options "${configure_options};-DBUILD_OFI_TRANSPORT=ON")
 Set(configure_options "${configure_options};-DBUILD_DDS_PLUGIN=ON")
+Set(configure_options "${configure_options};-DBUILD_SDK=ON")
 Set(configure_options "${configure_options};-DFAST_BUILD=ON")
 Set(configure_options "${configure_options};-DCOTIRE_MAXIMUM_NUMBER_OF_UNITY_INCLUDES=-j$ENV{number_of_processors}")
 

fairmq/CMakeLists.txt

@@ -16,11 +16,132 @@ if(BUILD_PMIX_PLUGIN)
   add_subdirectory(plugins/PMIx)
 endif()
 
+if(BUILD_FAIRMQ OR BUILD_SDK)
+  ###########
+  # Version #
+  ###########
+  configure_file(Version.h.in
+    ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
+    @ONLY
+  )
+  install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}/Version.h
+    DESTINATION ${PROJECT_INSTALL_INCDIR}
+  )
   
-##########################
+
-# libFairMQ header files #
+  #########
-##########################
+  # Tools #
-set(FAIRMQ_PUBLIC_HEADER_FILES
+  #########
+  set(target Tools)
+
+  set(TOOLS_PUBLIC_HEADER_FILES
+    tools/CppSTL.h
+    tools/Network.h
+    tools/Process.h
+    tools/RateLimit.h
+    tools/Strings.h
+    tools/Unique.h
+    tools/Version.h
+    Tools.h
+  )
+
+  set(TOOLS_SOURCE_FILES
+    tools/Network.cxx
+    tools/Process.cxx
+    tools/Unique.cxx
+  )
+
+  add_library(${target}
+    ${TOOLS_SOURCE_FILES}
+    ${TOOLS_PUBLIC_HEADER_FILES}
+  )
+  target_compile_definitions(${target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
+  target_include_directories(${target}
+    PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:include>
+  )
+  target_link_libraries(${target}
+    PRIVATE
+    FairLogger::FairLogger
+  )
+  set_target_properties(${target} PROPERTIES
+    VERSION ${PROJECT_GIT_VERSION}
+    SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    OUTPUT_NAME FairMQ${target}
+  )
+  install(
+    TARGETS ${target} 
+    EXPORT ${PROJECT_EXPORT_SET}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  )
+  foreach(HEADER ${TOOLS_PUBLIC_HEADER_FILES})
+    get_filename_component(_path ${HEADER} DIRECTORY)
+    file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
+    install(FILES ${HEADER}
+      DESTINATION ${_destination}
+    )
+  endforeach()
+
+  #################
+  # State Machine #
+  #################
+  set(target StateMachine)
+
+  set(FSM_PUBLIC_HEADER_FILES
+    StateMachine.h
+  )
+
+  set(FSM_SOURCE_FILES
+    StateMachine.cxx
+  )
+
+  add_library(${target}
+    ${FSM_SOURCE_FILES}
+    ${FSM_PUBLIC_HEADER_FILES}
+  )
+  target_compile_definitions(${target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
+  target_include_directories(${target}
+    PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:include>
+  )
+  target_link_libraries(${target}
+    PUBLIC
+    FairLogger::FairLogger
+    
+    PRIVATE
+    Boost::boost
+    Tools
+  )
+  set_target_properties(${target} PROPERTIES
+    VERSION ${PROJECT_GIT_VERSION}
+    SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    OUTPUT_NAME FairMQ${target}
+  )
+  install(
+    TARGETS ${target} 
+    EXPORT ${PROJECT_EXPORT_SET}
+    RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${PROJECT_INSTALL_LIBDIR}
+  )
+  foreach(HEADER ${FSM_PUBLIC_HEADER_FILES})
+    get_filename_component(_path ${HEADER} DIRECTORY)
+    file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
+    install(FILES ${HEADER}
+      DESTINATION ${_destination}
+    )
+  endforeach()
+endif()
+
+if(BUILD_FAIRMQ)
+  ##########################
+  # libFairMQ header files #
+  ##########################
+  set(FAIRMQ_PUBLIC_HEADER_FILES
     DeviceRunner.h
     EventManager.h
     FairMQChannel.h
@@ -31,11 +152,9 @@ set(FAIRMQ_PUBLIC_HEADER_FILES
     FairMQPoller.h
     FairMQUnmanagedRegion.h
     FairMQSocket.h
-  StateMachine.h
     FairMQTransportFactory.h
     MemoryResources.h
     MemoryResourceTools.h
-  Tools.h
     Transports.h
     options/FairMQProgOptions.h
     options/FairProgOptions.h
@@ -43,16 +162,9 @@ set(FAIRMQ_PUBLIC_HEADER_FILES
     PluginManager.h
     PluginServices.h
     runFairMQDevice.h
-  tools/CppSTL.h
+  )
-  tools/Network.h
-  tools/Process.h
-  tools/RateLimit.h
-  tools/Strings.h
-  tools/Unique.h
-  tools/Version.h
-)
 
-set(FAIRMQ_PRIVATE_HEADER_FILES
+  set(FAIRMQ_PRIVATE_HEADER_FILES
     devices/FairMQBenchmarkSampler.h
     devices/FairMQMerger.h
     devices/FairMQMultiplier.h
@@ -77,9 +189,9 @@ set(FAIRMQ_PRIVATE_HEADER_FILES
     zeromq/FairMQUnmanagedRegionZMQ.h
     zeromq/FairMQSocketZMQ.h
     zeromq/FairMQTransportFactoryZMQ.h
-)
+  )
 
-if(BUILD_NANOMSG_TRANSPORT)
+  if(BUILD_NANOMSG_TRANSPORT)
     set(FAIRMQ_PRIVATE_HEADER_FILES ${FAIRMQ_PRIVATE_HEADER_FILES}
       nanomsg/FairMQMessageNN.h
       nanomsg/FairMQPollerNN.h
@@ -87,9 +199,9 @@ if(BUILD_NANOMSG_TRANSPORT)
       nanomsg/FairMQSocketNN.h
       nanomsg/FairMQTransportFactoryNN.h
     )
-endif()
+  endif()
 
-if(BUILD_OFI_TRANSPORT)
+  if(BUILD_OFI_TRANSPORT)
     set(FAIRMQ_PRIVATE_HEADER_FILES ${FAIRMQ_PRIVATE_HEADER_FILES}
       ofi/Context.h
       ofi/Message.h
@@ -97,12 +209,12 @@ if(BUILD_OFI_TRANSPORT)
       ofi/Socket.h
       ofi/TransportFactory.h
     )
-endif()
+  endif()
 
-##########################
+  ##########################
-# libFairMQ source files #
+  # libFairMQ source files #
-##########################
+  ##########################
-set(FAIRMQ_SOURCE_FILES
+  set(FAIRMQ_SOURCE_FILES
     DeviceRunner.cxx
     FairMQChannel.cxx
     FairMQDevice.cxx
@@ -110,7 +222,6 @@ set(FAIRMQ_SOURCE_FILES
     FairMQMessage.cxx
     FairMQPoller.cxx
     FairMQSocket.cxx
-  StateMachine.cxx
     FairMQTransportFactory.cxx
     devices/FairMQBenchmarkSampler.cxx
     devices/FairMQMerger.cxx
@@ -131,18 +242,15 @@ set(FAIRMQ_SOURCE_FILES
     shmem/FairMQTransportFactorySHM.cxx
     shmem/Manager.cxx
     shmem/Region.cxx
-  tools/Network.cxx
-  tools/Process.cxx
-  tools/Unique.cxx
     zeromq/FairMQMessageZMQ.cxx
     zeromq/FairMQPollerZMQ.cxx
     zeromq/FairMQUnmanagedRegionZMQ.cxx
     zeromq/FairMQSocketZMQ.cxx
     zeromq/FairMQTransportFactoryZMQ.cxx
     MemoryResources.cxx
-)
+  )
 
-if(BUILD_NANOMSG_TRANSPORT)
+  if(BUILD_NANOMSG_TRANSPORT)
     set(FAIRMQ_SOURCE_FILES ${FAIRMQ_SOURCE_FILES}
       nanomsg/FairMQMessageNN.cxx
       nanomsg/FairMQPollerNN.cxx
@@ -150,9 +258,9 @@ if(BUILD_NANOMSG_TRANSPORT)
       nanomsg/FairMQSocketNN.cxx
       nanomsg/FairMQTransportFactoryNN.cxx
     )
-endif()
+  endif()
 
-if(BUILD_OFI_TRANSPORT)
+  if(BUILD_OFI_TRANSPORT)
     set(FAIRMQ_SOURCE_FILES ${FAIRMQ_SOURCE_FILES}
       ofi/Context.cxx
       ofi/Message.cxx
@@ -160,78 +268,78 @@ if(BUILD_OFI_TRANSPORT)
       ofi/Socket.cxx
       ofi/TransportFactory.cxx
     )
-endif()
+  endif()
 
 
-###################
+  ###################
-# configure files #
+  # configure files #
-###################
+  ###################
-set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
+  set(FAIRMQ_BIN_DIR ${CMAKE_BINARY_DIR}/fairmq)
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/run/startMQBenchmark.sh.in ${CMAKE_CURRENT_BINARY_DIR}/startMQBenchmark.sh)
+  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/run/startMQBenchmark.sh.in ${CMAKE_CURRENT_BINARY_DIR}/startMQBenchmark.sh)
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/options/startConfigExample.sh.in ${CMAKE_CURRENT_BINARY_DIR}/startConfigExample.sh)
+  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/options/startConfigExample.sh.in ${CMAKE_CURRENT_BINARY_DIR}/startConfigExample.sh)
 
 
-#################################
+  #################################
-# define libFairMQ build target #
+  # define libFairMQ build target #
-#################################
+  #################################
-if(FAST_BUILD)
+  if(FAST_BUILD)
     set(_target FairMQ_)
-else()
+  else()
     set(_target FairMQ)
-endif()
+  endif()
-add_library(${_target}
+  add_library(${_target}
     ${FAIRMQ_SOURCE_FILES}
     ${FAIRMQ_PUBLIC_HEADER_FILES} # for IDE integration
     ${FAIRMQ_PRIVATE_HEADER_FILES} # for IDE integration
-)
+  )
-set_target_properties(${_target} PROPERTIES LABELS coverage)
+  set_target_properties(${_target} PROPERTIES LABELS coverage)
-if(FAST_BUILD)
+  if(FAST_BUILD)
     set_target_properties(${_target} PROPERTIES OUTPUT_NAME FairMQ)
-endif()
+  endif()
 
 
-############################
+  ############################
-# preprocessor definitions #
+  # preprocessor definitions #
-############################
+  ############################
-target_compile_definitions(${_target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
+  target_compile_definitions(${_target} PUBLIC BOOST_ERROR_CODE_HEADER_ONLY)
-if(BUILD_NANOMSG_TRANSPORT)
+  if(BUILD_NANOMSG_TRANSPORT)
     target_compile_definitions(${_target} PRIVATE BUILD_NANOMSG_TRANSPORT)
-endif()
+  endif()
-if(BUILD_OFI_TRANSPORT)
+  if(BUILD_OFI_TRANSPORT)
     target_compile_definitions(${_target} PRIVATE BUILD_OFI_TRANSPORT)
-endif()
+  endif()
 
 
-#######################
+  #######################
-# include directories #
+  # include directories #
-#######################
+  #######################
-target_include_directories(${_target}
+  target_include_directories(${_target}
     PUBLIC # consumers inherit public include directories
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
     $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
     $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}>
     $<INSTALL_INTERFACE:include/fairmq>
     $<INSTALL_INTERFACE:include>
-)
+  )
 
-##################
+  ##################
-# link libraries #
+  # link libraries #
-##################
+  ##################
-if(BUILD_NANOMSG_TRANSPORT)
+  if(BUILD_NANOMSG_TRANSPORT)
     set(NANOMSG_DEPS nanomsg msgpackc-cxx)
-endif()
+  endif()
-if(BUILD_OFI_TRANSPORT)
+  if(BUILD_OFI_TRANSPORT)
     set(OFI_DEPS
       asiofi::asiofi
       Boost::container
     )
-endif()
+  endif()
-set(optional_deps ${NANOMSG_DEPS} ${OFI_DEPS})
+  set(optional_deps ${NANOMSG_DEPS} ${OFI_DEPS})
-if(optional_deps)
+  if(optional_deps)
     list(REMOVE_DUPLICATES optional_deps)
-endif()
+  endif()
 
-target_link_libraries(${_target}
+  target_link_libraries(${_target}
     INTERFACE # only consumers link against interface dependencies
     Boost::container
 
@@ -244,22 +352,24 @@ target_link_libraries(${_target}
     Boost::filesystem
     Boost::regex
     FairLogger::FairLogger
+    Tools
+    StateMachine
 
     PRIVATE # only libFairMQ links against private dependencies
     libzmq
     ${NANOMSG_DEPS}
     ${OFI_DEPS}
-)
+  )
-set_target_properties(${_target} PROPERTIES
+  set_target_properties(${_target} PROPERTIES
     VERSION ${PROJECT_GIT_VERSION}
     SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
-)
+  )
 
 
-##############
+  ##############
-# fast build #
+  # fast build #
-##############
+  ##############
-if(FAST_BUILD)
+  if(FAST_BUILD)
     set_target_properties(${_target} PROPERTIES
       COTIRE_UNITY_TARGET_NAME "FairMQ"
       # COTIRE_ENABLE_PRECOMPILED_HEADER FALSE
@@ -268,53 +378,53 @@ if(FAST_BUILD)
     cotire(${_target})
     set_target_properties(FairMQ PROPERTIES EXCLUDE_FROM_ALL FALSE)
     set_target_properties(FairMQ PROPERTIES LABELS coverage)
-endif()
+  endif()
 
 
-###############
+  ###############
-# executables #
+  # executables #
-###############
+  ###############
-add_executable(fairmq-bsampler run/runBenchmarkSampler.cxx)
+  add_executable(fairmq-bsampler run/runBenchmarkSampler.cxx)
-target_link_libraries(fairmq-bsampler FairMQ)
+  target_link_libraries(fairmq-bsampler FairMQ)
 
-add_executable(fairmq-merger run/runMerger.cxx)
+  add_executable(fairmq-merger run/runMerger.cxx)
-target_link_libraries(fairmq-merger FairMQ)
+  target_link_libraries(fairmq-merger FairMQ)
 
-add_executable(fairmq-multiplier run/runMultiplier.cxx)
+  add_executable(fairmq-multiplier run/runMultiplier.cxx)
-target_link_libraries(fairmq-multiplier FairMQ)
+  target_link_libraries(fairmq-multiplier FairMQ)
 
-add_executable(fairmq-proxy run/runProxy.cxx)
+  add_executable(fairmq-proxy run/runProxy.cxx)
-target_link_libraries(fairmq-proxy FairMQ)
+  target_link_libraries(fairmq-proxy FairMQ)
 
-add_executable(fairmq-sink run/runSink.cxx)
+  add_executable(fairmq-sink run/runSink.cxx)
-target_link_libraries(fairmq-sink FairMQ)
+  target_link_libraries(fairmq-sink FairMQ)
 
-add_executable(fairmq-splitter run/runSplitter.cxx)
+  add_executable(fairmq-splitter run/runSplitter.cxx)
-target_link_libraries(fairmq-splitter FairMQ)
+  target_link_libraries(fairmq-splitter FairMQ)
 
-add_executable(runConfigExample options/runConfigEx.cxx)
+  add_executable(runConfigExample options/runConfigEx.cxx)
-target_link_libraries(runConfigExample FairMQ)
+  target_link_libraries(runConfigExample FairMQ)
 
-add_executable(fairmq-shmmonitor shmem/Monitor.cxx shmem/Monitor.h shmem/runMonitor.cxx)
+  add_executable(fairmq-shmmonitor shmem/Monitor.cxx shmem/Monitor.h shmem/runMonitor.cxx)
-target_link_libraries(fairmq-shmmonitor PUBLIC
+  target_link_libraries(fairmq-shmmonitor PUBLIC
     Threads::Threads
     $<$<PLATFORM_ID:Linux>:rt>
     Boost::boost
     Boost::date_time
     Boost::program_options
-)
+  )
-target_include_directories(fairmq-shmmonitor PUBLIC
+  target_include_directories(fairmq-shmmonitor PUBLIC
     $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}>
-)
+  )
 
-add_executable(fairmq-uuid-gen run/runUuidGenerator.cxx)
+  add_executable(fairmq-uuid-gen run/runUuidGenerator.cxx)
-target_link_libraries(fairmq-uuid-gen FairMQ)
+  target_link_libraries(fairmq-uuid-gen FairMQ)
 
 
-###########
+  ###########
-# install #
+  # install #
-###########
+  ###########
-install(
+  install(
     TARGETS
     FairMQ
     fairmq-bsampler
@@ -330,13 +440,18 @@ install(
     RUNTIME DESTINATION ${PROJECT_INSTALL_BINDIR}
     LIBRARY DESTINATION ${PROJECT_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${PROJECT_INSTALL_LIBDIR}
-)
+  )
 
-# preserve relative path and prepend fairmq
+  # preserve relative path and prepend fairmq
-foreach(HEADER ${FAIRMQ_PUBLIC_HEADER_FILES})
+  foreach(HEADER ${FAIRMQ_PUBLIC_HEADER_FILES})
     get_filename_component(_path ${HEADER} DIRECTORY)
     file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
     install(FILES ${HEADER}
       DESTINATION ${_destination}
     )
-endforeach()
+  endforeach()
+endif()
+
+if(BUILD_SDK)
+  add_subdirectory(sdk)
+endif()

fairmq/StateMachine.h

@@ -9,7 +9,7 @@
 #ifndef FAIRMQSTATEMACHINE_H_
 #define FAIRMQSTATEMACHINE_H_
 
-#include "FairMQLogger.h"
+#include <fairlogger/Logger.h>
 
 #include <string>
 #include <memory>

fairmq/sdk/CMakeLists.txt

@@ -9,7 +9,7 @@
 ################
 # libFairMQSDK #
 ################
-set(target FairMQ_SDK)
+set(target SDK)
 
 set(SDK_PUBLIC_HEADER_FILES
   Session.h
@@ -39,14 +39,17 @@ target_include_directories(${target}
 target_link_libraries(${target}
   PUBLIC
   FairLogger::FairLogger
+  StateMachine
 
   PRIVATE
+  Tools
   DDS::dds_intercom_lib
   DDS::dds_protocol_lib
 )
 set_target_properties(${target} PROPERTIES
   VERSION ${PROJECT_GIT_VERSION}
   SOVERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+  OUTPUT_NAME FairMQ_${target}
 )
 
 ###############
@@ -55,13 +58,13 @@ set_target_properties(${target} PROPERTIES
 add_executable(fairmq runFairMQ.cxx)
 target_link_libraries(fairmq
   PRIVATE
-  FairMQ_SDK
+  SDK
   Boost::program_options
 )
 
 install(
   TARGETS
-  FairMQ_SDK
+  SDK
   fairmq
 
   EXPORT ${PROJECT_EXPORT_SET}
@@ -71,9 +74,9 @@ install(
 )
 
 # preserve relative path and prepend fairmq
-foreach(HEADER ${SDK_PUBLIC_HEADER_FILES})
+foreach(HEADER IN LISTS SDK_PUBLIC_HEADER_FILES)
   get_filename_component(_path ${HEADER} DIRECTORY)
-  file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/${_path} _destination)
+  file(TO_CMAKE_PATH ${PROJECT_INSTALL_INCDIR}/sdk/${_path} _destination)
   install(FILES ${HEADER}
     DESTINATION ${_destination}
   )

fairmq/sdk/runFairMQ.cxx

@@ -7,9 +7,12 @@
  ********************************************************************************/
 
 #include <fairmq/sdk/Topology.h>
+#include <fairmq/StateMachine.h>
+#include <iostream>
 
-int main(int argc, char *argv[])
+int main(int /*argc*/, char ** /*argv*/)
 {
+  std::cout << fair::mq::State::Idle << std::endl;
    
   return 0;
 }

fairmq/tools/Network.cxx

@@ -12,7 +12,7 @@
 #define _GNU_SOURCE // To get defns of NI_MAXSERV and NI_MAXHOST
 #endif
 
-#include "FairMQLogger.h"
+#include <fairlogger/Logger.h>
 
 #include <sys/socket.h>
 #include <sys/types.h>