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