tools/cmake/MaintainerMode.cmake

   1 # Change the following when we need a recent enough version of flexml to get the maintainer mode working
   2 set(FLEXML_MIN_MAJOR 1)
   3 set(FLEXML_MIN_MINOR 9)
   4 set(FLEXML_MIN_PATCH 6)
   5 # Change the following when we need a recent enough version of flex to get the maintainer mode working.
   6 # Maintainer mode does NOT work with version 2.5.35!
   7 set(FLEX_MIN_MAJOR 2)
   8 set(FLEX_MIN_MINOR 5)
   9 set(FLEX_MIN_PATCH 39)
  10
  11 # Let's generate header files required by SMPI when the call location tracing
  12 # has been activated.
  13 if(enable_maintainer_mode)
  14   if (enable_ns3)
  15     message(STATUS "Maintainer mode activated with ns-3, not enabling GLIBCXX_DEBUG (diable ns-3 to get it).")
  16   else()
  17     message(STATUS "Maintainer mode activated, enabling GLIBCXX_DEBUG.")
  18     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_DEBUG")
  19   endif()
  20
  21   add_custom_command(OUTPUT ${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces.h
  22                             ${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces_fortran.h
  23     DEPENDS
  24     ${CMAKE_HOME_DIRECTORY}/tools/smpi/generate_smpi_defines.pl
  25     ${CMAKE_HOME_DIRECTORY}/include/smpi/smpi.h
  26
  27     COMMENT "Generating header files for call-location tracing with SMPI"
  28     # Make sure there is no space after the redirection operator (>). I received
  29     # error messages in that case on my Debian system.
  30     COMMAND "${CMAKE_HOME_DIRECTORY}/tools/smpi/generate_smpi_defines.pl" "${CMAKE_HOME_DIRECTORY}/include/smpi/smpi.h >${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces.h"
  31     COMMAND "${CMAKE_HOME_DIRECTORY}/tools/smpi/generate_smpi_defines.pl" "-f" "${CMAKE_HOME_DIRECTORY}/include/smpi/smpi.h >${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces_fortran.h"
  32   )
  33
  34   add_custom_target(smpi_generated_headers_call_location_tracing
  35     DEPENDS
  36     ${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces.h
  37     ${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces_fortran.h
  38   )
  39
  40   SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES
  41     "${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces.h;${CMAKE_HOME_DIRECTORY}/include/smpi/smpi_extended_traces_fortran.h"
  42   )
  43 endif()
  44
  45 if(enable_maintainer_mode)
  46   find_program(FLEX_EXE NAMES flex)
  47   find_program(FLEXML_EXE NAMES flexml)
  48   find_program(SED_EXE NAMES sed)
  49   find_program(LEX_EXE NAMES lex)
  50
  51   mark_as_advanced(LEX_EXE)
  52
  53   message(STATUS "Found flex: ${FLEX_EXE}")
  54   IF(FLEX_EXE)
  55     set(HAVE_FLEX 1)
  56     execute_process(COMMAND ${FLEX_EXE} --version OUTPUT_VARIABLE FLEX_VERSION)
  57     string(REGEX MATCH "[0-9]+[.]+[0-9]+[.]+[0-9]+" FLEX_VERSION "${FLEX_VERSION}")
  58     string(REGEX MATCH "^[0-9]+" FLEX_MAJOR_VERSION "${FLEX_VERSION}")
  59     string(REGEX MATCH "[0-9]+[.]+[0-9]+$" FLEX_VERSION "${FLEX_VERSION}")
  60     string(REGEX MATCH "^[0-9]+" FLEX_MINOR_VERSION "${FLEX_VERSION}")
  61     string(REGEX MATCH "[0-9]+$" FLEX_PATCH_VERSION "${FLEX_VERSION}")
  62   ENDIF()
  63
  64   message(STATUS "Found flexml: ${FLEXML_EXE}")
  65   IF(FLEXML_EXE)
  66     set(HAVE_FLEXML 1)
  67     execute_process(COMMAND ${FLEXML_EXE} --version OUTPUT_VARIABLE FLEXML_VERSION)
  68     if (FLEXML_VERSION MATCHES "version Id:")
  69       message(FATAL_ERROR "You have an ancient flexml version (${FLEXML_VERSION}). You need at least v${FLEXML_MIN_MAJOR}.${FLEXML_MIN_MINOR}.${FLEXML_MIN_PATCH} to compile in maintainer mode. Upgrade your flexml, or disable the Maintainer mode option in cmake.")
  70     endif()
  71
  72     string(REGEX MATCH "[0-9]+[.]+[0-9]+[.]+[0-9]+" FLEXML_VERSION "${FLEXML_VERSION}")
  73     string(REGEX MATCH "^[0-9]*" FLEXML_MAJOR_VERSION "${FLEXML_VERSION}")
  74     string(REGEX MATCH "[0-9]+[.]+[0-9]+$" FLEXML_VERSION "${FLEXML_VERSION}")
  75     string(REGEX MATCH "^[0-9]+" FLEXML_MINOR_VERSION "${FLEXML_VERSION}")
  76     string(REGEX MATCH "[0-9]+$" FLEXML_PATCH_VERSION "${FLEXML_VERSION}")
  77   ENDIF()
  78
  79   message(STATUS "Found sed: ${SED_EXE}")
  80
  81   if(HAVE_FLEXML AND HAVE_FLEX AND SED_EXE)
  82
  83     message(STATUS "Flex version: ${FLEX_MAJOR_VERSION}.${FLEX_MINOR_VERSION}.${FLEX_PATCH_VERSION} (need at least version ${FLEX_MIN_MAJOR}.${FLEX_MIN_MINOR}.${FLEX_MIN_PATCH})")
  84     message(STATUS "Flexml version: ${FLEXML_MAJOR_VERSION}.${FLEXML_MINOR_VERSION}.${FLEXML_PATCH_VERSION} (need at least version ${FLEXML_MIN_MAJOR}.${FLEXML_MIN_MINOR}.${FLEXML_MIN_PATCH})")
  85
  86     IF(     (${FLEXML_MAJOR_VERSION} LESS ${FLEXML_MIN_MAJOR})
  87         OR ((${FLEXML_MAJOR_VERSION} EQUAL ${FLEXML_MIN_MAJOR}) AND (${FLEXML_MINOR_VERSION} LESS ${FLEXML_MIN_MINOR}) )
  88         OR (    (${FLEXML_MAJOR_VERSION} EQUAL ${FLEXML_MIN_MAJOR})
  89             AND (${FLEXML_MINOR_VERSION} EQUAL ${FLEXML_MIN_MINOR})
  90             AND (${FLEXML_PATCH_VERSION} LESS ${FLEXML_MIN_PATCH}) ))
  91
  92       message(FATAL_ERROR "Your flexml version is too old to compile in maintainer mode (need at least v${FLEXML_MIN_MAJOR}.${FLEXML_MIN_MINOR}.${FLEXML_MIN_PATCH}). Upgrade your flexml, or disable the Maintainer mode option in cmake.")
  93
  94     ENDIF()
  95
  96     IF(     (${FLEX_MAJOR_VERSION} LESS ${FLEX_MIN_MAJOR})
  97         OR ((${FLEX_MAJOR_VERSION} EQUAL ${FLEX_MIN_MAJOR}) AND (${FLEX_MINOR_VERSION} LESS ${FLEX_MIN_MINOR}) )
  98         OR (    (${FLEX_MAJOR_VERSION} EQUAL ${FLEX_MIN_MAJOR})
  99             AND (${FLEX_MINOR_VERSION} EQUAL ${FLEX_MIN_MINOR})
 100             AND (${FLEX_PATCH_VERSION} LESS ${FLEX_MIN_PATCH}) ))
 101
 102         message(FATAL_ERROR "Your flex version is too old to compile in maintainer mode (need at least v${FLEX_MIN_MAJOR}.${FLEX_MIN_MINOR}.${FLEX_MIN_PATCH}). Upgrade your flex, or disable the Maintainer mode option in cmake (run 'ccmake').")
 103
 104     ENDIF()
 105
 106     set(string1  "'s/extern /XBT_PUBLIC_DATA /'")
 107     set(string2  "'s/XBT_PUBLIC_DATA \\([^(]*\\)(/XBT_PUBLIC \\1(/'")
 108     set(string3  "'s/XBT_PUBLIC void STag_simgrid_parse_include/XBT_ATTRIB_NORETURN &/'") # remove with v5 of the dtd
 109     set(string4  "'s/XBT_PUBLIC void STag_simgrid_parse_\\(mount\\|storage\\)/XBT_ATTRIB_NORETURN &/'") # remove with v5 of the dtd
 110     set(string5  "'s/SET(DOCTYPE)/SET(ROOT_dax__adag)/'")
 111     set(string14 "'\\!^ \\* Generated [0-9/]\\{10\\} [0-9:]\\{8\\}\\.$$!d'")
 112
 113     ADD_CUSTOM_COMMAND(
 114       OUTPUT    ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.h
 115                 ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.h
 116                 ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.c
 117                 ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.c
 118
 119       DEPENDS   ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid.dtd
 120                 ${CMAKE_HOME_DIRECTORY}/src/dag/dax.dtd
 121
 122       #${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.l: ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid.dtd
 123       COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/src/kernel/xml
 124       COMMAND ${FLEXML_EXE} --root-tags platform -b 1000000 -P simgrid_parse --sysid=https://simgrid.org/simgrid.dtd -S src/kernel/xml/simgrid_dtd.l -L src/kernel/xml/simgrid.dtd
 125       COMMAND ${PERL_EXE} ${CMAKE_HOME_DIRECTORY}/tools/cmake/scripts/fixup_simgrid_dtd_l.pl < src/kernel/xml/simgrid_dtd.l > src/kernel/xml/simgrid_dtd.l.tmp
 126       COMMAND mv src/kernel/xml/simgrid_dtd.l.tmp src/kernel/xml/simgrid_dtd.l
 127       COMMAND ${CMAKE_COMMAND} -E echo "       Generated src/kernel/xml/simgrid_dtd.l"
 128
 129       #${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.l: ${CMAKE_HOME_DIRECTORY}/src/dag/dax.dtd
 130       COMMAND ${FLEXML_EXE} -b 1000000 --root-tags adag -P dax_ --sysid=dax.dtd -S src/dag/dax_dtd.l -L src/dag/dax.dtd
 131       COMMAND ${SED_EXE} -i ${string5} src/dag/dax_dtd.l
 132       COMMAND ${SED_EXE} -i ${string14} src/dag/dax_dtd.l
 133       COMMAND ${CMAKE_COMMAND} -E echo "       Generated src/dag/dax_dtd.l"
 134
 135       #${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.h: ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid.dtd
 136       COMMAND ${FLEXML_EXE} --root-tags platform -P simgrid_parse --sysid=https://simgrid.org/simgrid.dtd -H src/kernel/xml/simgrid_dtd.h -L src/kernel/xml/simgrid.dtd
 137       COMMAND ${SED_EXE} -i ${string1} src/kernel/xml/simgrid_dtd.h
 138       COMMAND ${SED_EXE} -i ${string2} src/kernel/xml/simgrid_dtd.h
 139       COMMAND ${SED_EXE} -i ${string3} src/kernel/xml/simgrid_dtd.h
 140       COMMAND ${SED_EXE} -i ${string4} src/kernel/xml/simgrid_dtd.h
 141       COMMAND ${SED_EXE} -i ${string14} src/kernel/xml/simgrid_dtd.h
 142       COMMAND ${CMAKE_COMMAND} -E echo "       Generated src/kernel/xml/simgrid_dtd.h"
 143
 144       #${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.h: ${CMAKE_HOME_DIRECTORY}/src/dag/dax.dtd
 145       COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.h
 146       COMMAND ${FLEXML_EXE} --root-tags adag -P dax_ --sysid=dax.dtd -H src/dag/dax_dtd.h -L src/dag/dax.dtd
 147       COMMAND ${SED_EXE} -i ${string1} src/dag/dax_dtd.h
 148       COMMAND ${SED_EXE} -i ${string2} src/dag/dax_dtd.h
 149       COMMAND ${SED_EXE} -i ${string14} src/dag/dax_dtd.h
 150       COMMAND ${CMAKE_COMMAND} -E echo "       Generated src/dag/dax_dtd.h"
 151
 152       #kernel/xml/simgrid_dtd.c: kernel/xml/simgrid_dtd.l
 153       COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.c
 154       COMMAND ${FLEX_EXE} -o src/kernel/xml/simgrid_dtd.c -Psimgrid_parse_ --noline src/kernel/xml/simgrid_dtd.l
 155       COMMAND ${CMAKE_COMMAND} -E echo "       Generated kernel/xml/simgrid_dtd.c"
 156
 157       #dag/dax_dtd.c: dag/dax_dtd.l
 158       COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.c
 159       COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/src/dag
 160       COMMAND ${FLEX_EXE} -o src/dag/dax_dtd.c -Pdax_ --noline src/dag/dax_dtd.l
 161       COMMAND ${CMAKE_COMMAND} -E echo "       Generated src/dag/dax_dtd.c"
 162
 163       WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
 164       COMMENT "Generating files in maintainer mode..."
 165       )
 166
 167   else()
 168     if(NOT HAVE_FLEXML)
 169       message(STATUS "Error : Install flexml to use the maintainer mode.")
 170     endif()
 171     if(NOT HAVE_FLEX)
 172       message(STATUS "Error : Install flex to use the maintainer mode.")
 173     endif()
 174     if(NOT SED_EXE)
 175       message(STATUS "Error : Install sed before use maintainer mode.")
 176     endif()
 177
 178     message(FATAL_ERROR STATUS "Error : Need to install all (flexml, flex, sed) tools for maintainer mode !!!")
 179   endif()
 180
 181 endif()
 182
 183 add_custom_target(maintainer_files
 184   DEPENDS ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.h
 185           ${CMAKE_HOME_DIRECTORY}/src/kernel/xml/simgrid_dtd.c
 186           ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.h
 187           ${CMAKE_HOME_DIRECTORY}/src/dag/dax_dtd.c
 188   )