Home | History | Annotate | Download | only in modules
      1 # LLVM_TARGET_DEFINITIONS must contain the name of the .td file to process.
      2 # Extra parameters for `tblgen' may come after `ofn' parameter.
      3 # Adds the name of the generated file to TABLEGEN_OUTPUT.
      4 
      5 include(LLVMExternalProjectUtils)
      6 
      7 if(LLVM_MAIN_INCLUDE_DIR)
      8   set(LLVM_TABLEGEN_FLAGS -I ${LLVM_MAIN_INCLUDE_DIR})
      9 endif()
     10 
     11 function(tablegen project ofn)
     12   # Validate calling context.
     13   if(NOT ${project}_TABLEGEN_EXE)
     14     message(FATAL_ERROR "${project}_TABLEGEN_EXE not set")
     15   endif()
     16 
     17   # Use depfile instead of globbing arbitrary *.td(s)
     18   # DEPFILE is available for Ninja Generator with CMake>=3.7.
     19   if(CMAKE_GENERATOR STREQUAL "Ninja" AND NOT CMAKE_VERSION VERSION_LESS 3.7)
     20     # Make output path relative to build.ninja, assuming located on
     21     # ${CMAKE_BINARY_DIR}.
     22     # CMake emits build targets as relative paths but Ninja doesn't identify
     23     # absolute path (in *.d) as relative path (in build.ninja)
     24     # Note that tblgen is executed on ${CMAKE_BINARY_DIR} as working directory.
     25     file(RELATIVE_PATH ofn_rel
     26       ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/${ofn})
     27     set(additional_cmdline
     28       -o ${ofn_rel}.tmp
     29       -d ${ofn_rel}.d
     30       WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
     31       DEPFILE ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.d
     32       )
     33     set(local_tds)
     34     set(global_tds)
     35   else()
     36     file(GLOB local_tds "*.td")
     37     file(GLOB_RECURSE global_tds "${LLVM_MAIN_INCLUDE_DIR}/llvm/*.td")
     38     set(additional_cmdline
     39       -o ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.tmp
     40       )
     41   endif()
     42 
     43   if (IS_ABSOLUTE ${LLVM_TARGET_DEFINITIONS})
     44     set(LLVM_TARGET_DEFINITIONS_ABSOLUTE ${LLVM_TARGET_DEFINITIONS})
     45   else()
     46     set(LLVM_TARGET_DEFINITIONS_ABSOLUTE
     47       ${CMAKE_CURRENT_SOURCE_DIR}/${LLVM_TARGET_DEFINITIONS})
     48   endif()
     49   if (LLVM_ENABLE_DAGISEL_COV)
     50     list(FIND ARGN "-gen-dag-isel" idx)
     51     if( NOT idx EQUAL -1 )
     52       list(APPEND LLVM_TABLEGEN_FLAGS "-instrument-coverage")
     53     endif()
     54   endif()
     55   if (LLVM_ENABLE_GISEL_COV)
     56     list(FIND ARGN "-gen-global-isel" idx)
     57     if( NOT idx EQUAL -1 )
     58       list(APPEND LLVM_TABLEGEN_FLAGS "-instrument-gisel-coverage")
     59       list(APPEND LLVM_TABLEGEN_FLAGS "-gisel-coverage-file=${LLVM_GISEL_COV_PREFIX}all")
     60     endif()
     61   endif()
     62 
     63   # We need both _TABLEGEN_TARGET and _TABLEGEN_EXE in the  DEPENDS list
     64   # (both the target and the file) to have .inc files rebuilt on
     65   # a tablegen change, as cmake does not propagate file-level dependencies
     66   # of custom targets. See the following ticket for more information:
     67   # https://cmake.org/Bug/view.php?id=15858
     68   # The dependency on both, the target and the file, produces the same
     69   # dependency twice in the result file when
     70   # ("${${project}_TABLEGEN_TARGET}" STREQUAL "${${project}_TABLEGEN_EXE}")
     71   # but lets us having smaller and cleaner code here.
     72   add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.tmp
     73     # Generate tablegen output in a temporary file.
     74     COMMAND ${${project}_TABLEGEN_EXE} ${ARGN} -I ${CMAKE_CURRENT_SOURCE_DIR}
     75     ${LLVM_TABLEGEN_FLAGS}
     76     ${LLVM_TARGET_DEFINITIONS_ABSOLUTE}
     77     ${additional_cmdline}
     78     # The file in LLVM_TARGET_DEFINITIONS may be not in the current
     79     # directory and local_tds may not contain it, so we must
     80     # explicitly list it here:
     81     DEPENDS ${${project}_TABLEGEN_TARGET} ${${project}_TABLEGEN_EXE}
     82       ${local_tds} ${global_tds}
     83     ${LLVM_TARGET_DEFINITIONS_ABSOLUTE}
     84     COMMENT "Building ${ofn}..."
     85     )
     86   add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${ofn}
     87     # Only update the real output file if there are any differences.
     88     # This prevents recompilation of all the files depending on it if there
     89     # aren't any.
     90     COMMAND ${CMAKE_COMMAND} -E copy_if_different
     91         ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.tmp
     92         ${CMAKE_CURRENT_BINARY_DIR}/${ofn}
     93     DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.tmp
     94     COMMENT "Updating ${ofn}..."
     95     )
     96 
     97   # `make clean' must remove all those generated files:
     98   set_property(DIRECTORY APPEND
     99     PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${ofn}.tmp ${ofn})
    100 
    101   set(TABLEGEN_OUTPUT ${TABLEGEN_OUTPUT} ${CMAKE_CURRENT_BINARY_DIR}/${ofn} PARENT_SCOPE)
    102   set_source_files_properties(${CMAKE_CURRENT_BINARY_DIR}/${ofn} PROPERTIES
    103     GENERATED 1)
    104 endfunction()
    105 
    106 # Creates a target for publicly exporting tablegen dependencies.
    107 function(add_public_tablegen_target target)
    108   if(NOT TABLEGEN_OUTPUT)
    109     message(FATAL_ERROR "Requires tablegen() definitions as TABLEGEN_OUTPUT.")
    110   endif()
    111   add_custom_target(${target}
    112     DEPENDS ${TABLEGEN_OUTPUT})
    113   if(LLVM_COMMON_DEPENDS)
    114     add_dependencies(${target} ${LLVM_COMMON_DEPENDS})
    115   endif()
    116   set_target_properties(${target} PROPERTIES FOLDER "Tablegenning")
    117   set(LLVM_COMMON_DEPENDS ${LLVM_COMMON_DEPENDS} ${target} PARENT_SCOPE)
    118 endfunction()
    119 
    120 macro(add_tablegen target project)
    121   set(${target}_OLD_LLVM_LINK_COMPONENTS ${LLVM_LINK_COMPONENTS})
    122   set(LLVM_LINK_COMPONENTS ${LLVM_LINK_COMPONENTS} TableGen)
    123 
    124   # CMake-3.9 doesn't let compilation units depend on their dependent libraries.
    125   if(NOT (CMAKE_GENERATOR STREQUAL "Ninja" AND NOT CMAKE_VERSION VERSION_LESS 3.9) AND NOT XCODE)
    126     # FIXME: It leaks to user, callee of add_tablegen.
    127     set(LLVM_ENABLE_OBJLIB ON)
    128   endif()
    129 
    130   add_llvm_executable(${target} DISABLE_LLVM_LINK_LLVM_DYLIB ${ARGN})
    131   set(LLVM_LINK_COMPONENTS ${${target}_OLD_LLVM_LINK_COMPONENTS})
    132 
    133   set(${project}_TABLEGEN "${target}" CACHE
    134       STRING "Native TableGen executable. Saves building one when cross-compiling.")
    135 
    136   # Upgrade existing LLVM_TABLEGEN setting.
    137   if(${project} STREQUAL LLVM)
    138     if(${LLVM_TABLEGEN} STREQUAL tblgen)
    139       set(LLVM_TABLEGEN "${target}" CACHE
    140           STRING "Native TableGen executable. Saves building one when cross-compiling."
    141           FORCE)
    142     endif()
    143   endif()
    144 
    145   # Effective tblgen executable to be used:
    146   set(${project}_TABLEGEN_EXE ${${project}_TABLEGEN} PARENT_SCOPE)
    147   set(${project}_TABLEGEN_TARGET ${${project}_TABLEGEN} PARENT_SCOPE)
    148 
    149   if(LLVM_USE_HOST_TOOLS)
    150     if( ${${project}_TABLEGEN} STREQUAL "${target}" )
    151       if (NOT CMAKE_CONFIGURATION_TYPES)
    152         set(${project}_TABLEGEN_EXE "${LLVM_NATIVE_BUILD}/bin/${target}")
    153       else()
    154         set(${project}_TABLEGEN_EXE "${LLVM_NATIVE_BUILD}/Release/bin/${target}")
    155       endif()
    156       set(${project}_TABLEGEN_EXE ${${project}_TABLEGEN_EXE} PARENT_SCOPE)
    157 
    158       llvm_ExternalProject_BuildCmd(tblgen_build_cmd ${target}
    159                                     ${LLVM_NATIVE_BUILD}
    160                                     CONFIGURATION Release)
    161       add_custom_command(OUTPUT ${${project}_TABLEGEN_EXE}
    162         COMMAND ${tblgen_build_cmd}
    163         DEPENDS CONFIGURE_LLVM_NATIVE ${target}
    164         WORKING_DIRECTORY ${LLVM_NATIVE_BUILD}
    165         COMMENT "Building native TableGen..."
    166         USES_TERMINAL)
    167       add_custom_target(${project}-tablegen-host DEPENDS ${${project}_TABLEGEN_EXE})
    168       set(${project}_TABLEGEN_TARGET ${project}-tablegen-host PARENT_SCOPE)
    169     endif()
    170   endif()
    171 
    172   if (${project} STREQUAL LLVM AND NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
    173     if(${target} IN_LIST LLVM_DISTRIBUTION_COMPONENTS OR
    174         NOT LLVM_DISTRIBUTION_COMPONENTS)
    175       set(export_to_llvmexports EXPORT LLVMExports)
    176     endif()
    177 
    178     install(TARGETS ${target}
    179             ${export_to_llvmexports}
    180             RUNTIME DESTINATION ${LLVM_TOOLS_INSTALL_DIR})
    181   endif()
    182   set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${target})
    183 endmacro()
    184