[CMAKE][llvm-libraries] Add Precompiled Headers option to improve build times

ameerj · ameerj · commit 7fb7a9142488 · 2024-05-26T23:13:46.000-04:00
diff --git a/llvm/CMakeLists.txt b/llvm/CMakeLists.txt
@@ -1410,3 +1410,6 @@ endif()
 if (LLVM_INCLUDE_UTILS AND LLVM_INCLUDE_TOOLS)
   add_subdirectory(utils/llvm-locstats)
 endif()
+
+include(LLVMPrecompiledHeaders)
+llvm_lib_precompiled_headers()
diff --git a/llvm/cmake/modules/HandleLLVMOptions.cmake b/llvm/cmake/modules/HandleLLVMOptions.cmake
@@ -538,6 +538,11 @@ endif()
 
 option(LLVM_ENABLE_WARNINGS "Enable compiler warnings." ON)
 
+option(LLVM_ENABLE_LIB_PRECOMPILED_HEADERS "Enable precompiled headers for LLVM Lib projects to improve build times." ON)
+
+set(LLVM_LIB_DIRETORIES_FOR_PRECOMPILED_HEADERS ""
+    CACHE STRING "Semicolon-separated list of lib subdirectories to use precompiled headers")
+
 if( MSVC )
 
   # Add definitions that make MSVC much less annoying.
@@ -593,7 +598,11 @@ if( MSVC )
   # PDBs without changing codegen.
   option(LLVM_ENABLE_PDB OFF)
   if (LLVM_ENABLE_PDB AND uppercase_CMAKE_BUILD_TYPE STREQUAL "RELEASE")
-    append("/Zi" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+    if (LLVM_ENABLE_LIB_PRECOMPILED_HEADERS)
+        append("/Z7" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+    else()
+        append("/Zi" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+    endif()
     # /DEBUG disables linker GC and ICF, but we want those in Release mode.
     append("/DEBUG /OPT:REF /OPT:ICF"
           CMAKE_EXE_LINKER_FLAGS CMAKE_MODULE_LINKER_FLAGS
diff --git a/llvm/cmake/modules/LLVMPrecompiledHeaders.cmake b/llvm/cmake/modules/LLVMPrecompiledHeaders.cmake
@@ -0,0 +1,65 @@
+macro(get_all_targets_recursive targets dir)
+    get_property(subdirectories DIRECTORY ${dir} PROPERTY SUBDIRECTORIES)
+    foreach(subdir ${subdirectories})
+        get_all_targets_recursive(${targets} ${subdir})
+    endforeach()
+
+    get_property(current_targets DIRECTORY ${dir} PROPERTY BUILDSYSTEM_TARGETS)
+    list(APPEND ${targets} ${current_targets})
+endmacro()
+
+function(get_all_targets dir outvar)
+    set(targets)
+    get_all_targets_recursive(targets ${dir})
+    set(${outvar} ${targets} PARENT_SCOPE)
+endfunction()
+
+function(add_llvm_lib_precompiled_headers target)
+    get_target_property(target_type ${target} TYPE)
+    if (target_type STREQUAL "STATIC_LIBRARY")
+        target_precompile_headers(${target} REUSE_FROM LLVMPchTarget)
+    endif()
+endfunction()
+
+function(add_llvm_subdir_pch subdir)
+    get_all_targets("${LLVM_MAIN_SRC_DIR}/lib/${subdir}" lib_targets)
+    foreach(target ${lib_targets})
+        add_llvm_lib_precompiled_headers(${target})
+    endforeach()
+endfunction()
+
+function(llvm_lib_precompiled_headers)
+    if (LLVM_ENABLE_LIB_PRECOMPILED_HEADERS)
+        # Create a dummy source file to compile the PCH target.
+        set(pch_dummy_cpp ${CMAKE_CURRENT_BINARY_DIR}/dummy.cpp)
+        if (NOT EXISTS ${pch_dummy_cpp})
+            FILE(TOUCH ${pch_dummy_cpp})
+        endif()
+
+        set(precompiled_header_path ${LLVM_MAIN_INCLUDE_DIR}/llvm/PrecompiledHeaders.h)
+        add_llvm_component_library(LLVMPchTarget ${pch_dummy_cpp} ${precompiled_header_path})
+        target_precompile_headers(LLVMPchTarget PUBLIC "$<$<COMPILE_LANGUAGE:CXX>:${LLVM_MAIN_INCLUDE_DIR}/llvm/PrecompiledHeaders.h>")
+
+        if (NOT ${LLVM_LIB_DIRETORIES_FOR_PRECOMPILED_HEADERS})
+            set(default_lib_dirs_for_pch
+                "Analysis"
+                "Codegen"
+                "DebugInfo"
+                "ExecutionEngine"
+                "IR"
+                "MC"
+                "MCA"
+                "ObjCopy"
+                "Object"
+                "Passes"
+                "Support"
+                "Target"
+                "Transforms"
+            )
+            set(LLVM_LIB_DIRETORIES_FOR_PRECOMPILED_HEADERS ${default_lib_dirs_for_pch})
+        endif()
+        foreach(subdir ${LLVM_LIB_DIRETORIES_FOR_PRECOMPILED_HEADERS})
+	        add_llvm_subdir_pch(${subdir})
+        endforeach()
+    endif()
+endfunction()
diff --git a/llvm/include/llvm/ADT/ConcurrentHashtable.h b/llvm/include/llvm/ADT/ConcurrentHashtable.h
@@ -16,7 +16,6 @@
 #include "llvm/Support/Allocator.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/Parallel.h"
-#include "llvm/Support/WithColor.h"
 #include "llvm/Support/xxhash.h"
 #include <atomic>
 #include <cstddef>
diff --git a/llvm/include/llvm/PrecompiledHeaders.h b/llvm/include/llvm/PrecompiledHeaders.h
@@ -0,0 +1,99 @@
+//===-- llvm/PrecompiledHeaders.h - Precompiled Headers ---------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// This file contains common headers used within the LLVM library.
+/// It is intended to be used as a precompiled header.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_PRECOMPILEDHEADERS_H
+#define LLVM_PRECOMPILEDHEADERS_H
+
+#include "llvm/IR/PassManager.h"
+#include "llvm/IR/Instructions.h"
+#include "llvm/IR/IntrinsicInst.h"
+#include "llvm/IR/DebugInfoMetadata.h"
+
+#include "llvm/ADT/STLForwardCompat.h"
+#include "llvm/ADT/STLFunctionalExtras.h"
+#include "llvm/ADT/ADL.h"
+#include "llvm/ADT/iterator_range.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/DenseMapInfo.h"
+#include "llvm/ADT/bit.h"
+#include "llvm/ADT/StringRef.h"
+#include "llvm/ADT/Hashing.h"
+#include "llvm/ADT/iterator.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/ADT/Twine.h"
+#include "llvm/ADT/EpochTracker.h"
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/StringMapEntry.h"
+#include "llvm/ADT/DenseSet.h"
+#include "llvm/ADT/StringMap.h"
+#include "llvm/ADT/PointerIntPair.h"
+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/ADT/APInt.h"
+#include "llvm/ADT/ilist_node_base.h"
+#include "llvm/ADT/ilist_node.h"
+#include "llvm/ADT/ilist_node_options.h"
+#include "llvm/ADT/BitmaskEnum.h"
+
+#include <algorithm>
+#include <utility>
+#include <optional>
+#include <vector>
+#include <string>
+#include <memory>
+#include <iterator>
+#include <map>
+#include <tuple>
+#include <limits>
+#include <set>
+#include <system_error>
+#include <functional>
+#include <numeric>
+#include <deque>
+#include <sstream>
+#include <queue>
+#include <type_traits>
+#include <mutex>
+#include <array>
+#include <list>
+#include <atomic>
+#include <unordered_map>
+#include <bitset>
+#include <new>
+#include <unordered_set>
+#include <iomanip>
+#include <thread>
+#include <variant>
+#include <future>
+#include <stack>
+#include <chrono>
+#include <initializer_list>
+#include <random>
+
+#include <cctype>
+#include <cerrno>
+#include <cfloat>
+#include <cinttypes>
+#include <climits>
+#include <clocale>
+#include <cmath>
+#include <cstddef>
+#include <cstdint>
+#include <cstdio>
+#include <cstdlib>
+#include <cstring>
+#include <ctime>
+#include <cwchar>
+
+#endif // LLVM_PRECOMPILEDHEADERS_H
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFAbbreviationDeclaration.cpp b/llvm/lib/DebugInfo/DWARF/DWARFAbbreviationDeclaration.cpp
@@ -68,7 +68,7 @@ DWARFAbbreviationDeclaration::extract(DataExtractor Data, uint64_t *OffsetPtr) {
 
   // Read all of the abbreviation attributes and forms.
   while (Data.isValidOffset(*OffsetPtr)) {
-    auto A = static_cast<Attribute>(Data.getULEB128(OffsetPtr, &Err));
+    auto A = static_cast<dwarf::Attribute>(Data.getULEB128(OffsetPtr, &Err));
     if (Err)
       return std::move(Err);
 
diff --git a/llvm/lib/Object/Minidump.cpp b/llvm/lib/Object/Minidump.cpp
@@ -92,7 +92,7 @@ Expected<ArrayRef<T>> MinidumpFile::getListStream(StreamType Type) const {
 
   return getDataSliceAs<T>(*Stream, ListOffset, ListSize);
 }
-template Expected<ArrayRef<Module>>
+template Expected<ArrayRef<minidump::Module>>
     MinidumpFile::getListStream(StreamType) const;
 template Expected<ArrayRef<Thread>>
     MinidumpFile::getListStream(StreamType) const;
diff --git a/llvm/lib/Support/CMakeLists.txt b/llvm/lib/Support/CMakeLists.txt
@@ -297,6 +297,21 @@ add_llvm_component_library(LLVMSupport
 
 set(llvm_system_libs ${system_libs})
 
+if (LLVM_ENABLE_LIB_PRECOMPILED_HEADERS)
+  # CMake cannot use a C++ PCH in source targets that are non-C++
+  # Ideally this would be handled by LLVMPrecompiledHeaders.cmake
+  set(non_cpp_sources 
+    regcomp.c
+    regerror.c
+    regexec.c
+    regfree.c
+    regstrlcpy.c
+  )
+  foreach(source ${non_cpp_sources})
+    set_source_files_properties(${source} PROPERTIES SKIP_PRECOMPILE_HEADERS ON)
+  endforeach()
+endif()
+
 # This block is only needed for llvm-config. When we deprecate llvm-config and
 # move to using CMake export, this block can be removed.
 if(LLVM_ENABLE_ZLIB)

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ Expected<ArrayRef<T>> MinidumpFile::getListStream(StreamType Type) const {`
`92`	`92`
`93`	`93`	`return getDataSliceAs<T>(*Stream, ListOffset, ListSize);`
`94`	`94`	`}`
`95`		`-template Expected<ArrayRef<Module>>`
	`95`	`+template Expected<ArrayRef<minidump::Module>>`
`96`	`96`	`MinidumpFile::getListStream(StreamType) const;`
`97`	`97`	`template Expected<ArrayRef<Thread>>`
`98`	`98`	`MinidumpFile::getListStream(StreamType) const;`