This is an archive of the discontinued LLVM Phabricator instance.

Differential D31969

[CMake] Support generating Config.h
ClosedPublic

Authored by beanz on Apr 11 2017, 6:18 PM.

Details

Reviewers
zturner
labath
Commits
rGb90bee044b89: [CMake] Support generating Config.h
rLLDB300372: [CMake] Support generating Config.h
rL300372: [CMake] Support generating Config.h
Summary

This patch removes the hand maintained config files in favor of auto-generating the config file. We will still need to maintain the defines for the Xcode builds on Mac, but all CMake builds use the generated header instead.

This will enable finer grained platform support tests and enable supporting LLDB on more platforms with less manual maintenance.

I have only tested this patch on Darwin, and any help testing it out on other platforms would be greatly appreciated. I've probably messed something up somewhere.

Diff Detail

Repository
rL LLVM

Event Timeline

beanz created this revision.Apr 11 2017, 6:18 PM
Herald added subscribers: mgorny, srhines, emaste. · View Herald TranscriptApr 11 2017, 6:18 PM
krytarowski added a subscriber: krytarowski.Apr 11 2017, 6:23 PM
krytarowski added inline comments.
cmake/modules/LLDBConfig.cmake
433 ↗(On Diff #94923)

Can we just use #ifdef F_GETPATH in the source code? No need to define another symbol wrapping F_GETPATH.

krytarowski added a comment.Apr 11 2017, 6:31 PM

While there there are candidates like pipe2(2) in source/Host/posix/PipePosix.cpp.

beanz updated this revision to Diff 94924.Apr 11 2017, 6:35 PM
  • Fixing installation to make sure CMake always installs the generated Config.h
  • Removing LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED becasue we really don't need it
beanz updated this revision to Diff 94925.Apr 11 2017, 6:36 PM

Actually uploading the updates this time...

beanz updated this revision to Diff 94928.Apr 11 2017, 6:47 PM

Updating the hard coded Config.h

zturner edited edge metadata.Apr 11 2017, 7:01 PM

How much would it complicate things to move the hand maintained files out of tree? If the Xcode build isn't really a thing we're officially supporting, perhaps we can take that aggressive approach in-tree as well?

cmake/modules/LLDBConfig.cmake
287–293 ↗(On Diff #94928)

Is this necessary?

include/lldb/Host/Config.h.cmake
10–11 ↗(On Diff #94928)

Since we're in here anyway, can you use a fully qualified include guard here? Like #ifndef LLDB_HOST_CONFIG_H?

labath accepted this revision.Apr 12 2017, 3:38 AM

Thank you very much. I am soo happy that these files are going away.

In D31969#724508, @zturner wrote:

How much would it complicate things to move the hand maintained files out of tree? If the Xcode build isn't really a thing we're officially supporting, perhaps we can take that aggressive approach in-tree as well?

AFAIK, the xcode project already passes some additional -D flags to the compiler when building lldb. It shouldn't be too hard (for someone who knows how to edit xcode projects :) ) to add these two flags there and delete the hand-written Config.h. I don't feel too strongly about that though.

This revision is now accepted and ready to land.Apr 12 2017, 3:38 AM
beanz added a comment.Apr 12 2017, 1:20 PM

My intention in this patch is not in any way to adversely impact the Xcode project, which is the supported and documented way to build LLDB on OS X (http://lldb.llvm.org/build.html#BuildingLldbOnMacOSX).

The goal of this patch is to support configuration time capabilities inspection to aid in porting LLDB to other platforms via the CMake build system. By leaving the Host/Config.h header in LLDB's source tree we continue supporting the Xcode project, and we don't require changing the LLDB sources which include lldb/Host/Config.h. This seems like the best solution to me.

cmake/modules/LLDBConfig.cmake
287–293 ↗(On Diff #94928)

CMake's documentation does not specify the order in which directories may be processed, and since the source and build directories will have an overlapping Config.h file we need to make sure the right one gets picked every time regardless of any changes to how CMake might handle the underlying implementation of the install command.

beanz updated this revision to Diff 95024.Apr 12 2017, 1:24 PM

Fixing up the include guard as per feedback from zturner, and fixing up an install logic error that I spoted.

Closed by commit rL300372: [CMake] Support generating Config.h (authored by cbieneman). · Explain WhyApr 14 2017, 3:16 PM
This revision was automatically updated to reflect the committed changes.
sgraenitz mentioned this in D65862: Remove xcode-specific Config.h.Aug 7 2019, 5:13 AM

Revision Contents

PathSize
lldb/
trunk/
cmake/
modules/
28 lines
include/
lldb/
Host/
42 lines
19 lines
android/
28 lines
freebsd/
28 lines
linux/
28 lines
macosx/
28 lines
mingw/
30 lines
msvc/
30 lines
netbsd/
28 lines
openbsd/
28 lines
source/
Host/
common/
2 lines

Diff 95354

lldb/trunk/cmake/modules/LLDBConfig.cmake

Show First 20 Lines • Show All 264 Lines • ▼ Show 20 Lines
endif() endif()
# Compute the LLDB version from the LLVM version. # Compute the LLDB version from the LLVM version.
string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" LLDB_VERSION string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" LLDB_VERSION
${PACKAGE_VERSION}) ${PACKAGE_VERSION})
message(STATUS "LLDB version: ${LLDB_VERSION}") message(STATUS "LLDB version: ${LLDB_VERSION}")
include_directories(BEFORE include_directories(BEFORE
${CMAKE_CURRENT_BINARY_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/include ${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_BINARY_DIR}/include
) )
if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY) if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
install(DIRECTORY include/ install(DIRECTORY include/
COMPONENT lldb_headers COMPONENT lldb_headers
DESTINATION include DESTINATION include
FILES_MATCHING FILES_MATCHING
PATTERN "*.h" PATTERN "*.h"
PATTERN ".svn" EXCLUDE PATTERN ".svn" EXCLUDE
PATTERN ".cmake" EXCLUDE
PATTERN "Config.h" EXCLUDE
)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/
COMPONENT lldb_headers
DESTINATION include
FILES_MATCHING
PATTERN "*.h"
PATTERN ".svn" EXCLUDE
PATTERN ".cmake" EXCLUDE
) )
endif() endif()
if (NOT LIBXML2_FOUND AND NOT (CMAKE_SYSTEM_NAME MATCHES "Windows")) if (NOT LIBXML2_FOUND AND NOT (CMAKE_SYSTEM_NAME MATCHES "Windows"))
# Skip Libxml2 on Windows. In CMake 3.4 and higher, the algorithm for # Skip Libxml2 on Windows. In CMake 3.4 and higher, the algorithm for
# finding libxml2 got "smarter", and it can now locate the version which is # finding libxml2 got "smarter", and it can now locate the version which is
# in gnuwin32, even though that version does not contain the headers that # in gnuwin32, even though that version does not contain the headers that
# LLDB uses. # LLDB uses.
▲ Show 20 Lines • Show All 124 Lines • ▼ Show 20 Lines
endif() endif()
if ((CMAKE_SYSTEM_NAME MATCHES "Android") AND LLVM_BUILD_STATIC AND if ((CMAKE_SYSTEM_NAME MATCHES "Android") AND LLVM_BUILD_STATIC AND
((ANDROID_ABI MATCHES "armeabi") OR (ANDROID_ABI MATCHES "mips"))) ((ANDROID_ABI MATCHES "armeabi") OR (ANDROID_ABI MATCHES "mips")))
add_definitions(-DANDROID_USE_ACCEPT_WORKAROUND) add_definitions(-DANDROID_USE_ACCEPT_WORKAROUND)
endif() endif()
find_package(Backtrace) find_package(Backtrace)
check_include_file(termios.h HAVE_TERMIOS_H)
# These checks exist in LLVM's configuration, so I want to match the LLVM names
# so that the check isn't duplicated, but we translate them into the LLDB names
# so that I don't have to change all the uses at the moment.
set(LLDB_CONFIG_TERMIOS_SUPPORTED ${HAVE_TERMIOS_H})
if(NOT UNIX)
set(LLDB_DISABLE_POSIX 1)
endif()
# This should be done at the end
configure_file(
${LLDB_INCLUDE_ROOT}/lldb/Host/Config.h.cmake
${CMAKE_CURRENT_BINARY_DIR}/include/lldb/Host/Config.h)

lldb/trunk/include/lldb/Host/Config.h

//===-- Config.h ------------------------------------------------*- C++ -*-===// //===-- Config.h ------------------------------------------------*- C++ -*-===//
// //
// The LLVM Compiler Infrastructure // The LLVM Compiler Infrastructure
// //
// This file is distributed under the University of Illinois Open Source // This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details. // License. See LICENSE.TXT for details.
// //
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
#ifndef liblldb_Config_h_ #ifndef LLDB_HOST_CONFIG_H
#define liblldb_Config_h_ #define LLDB_HOST_CONFIG_H
#if defined(__APPLE__) #if defined(__APPLE__)
#include "lldb/Host/macosx/Config.h" // This block of code only exists to keep the Xcode project working in the
// absence of a configuration step.
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#elif defined(__ANDROID__) #define HAVE_SYS_EVENT_H 1
#include "lldb/Host/android/Config.h"
#elif defined(__linux__) || defined(__GNU__)
#include "lldb/Host/linux/Config.h"
#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
#include "lldb/Host/freebsd/Config.h"
#elif defined(__NetBSD__)
#include "lldb/Host/netbsd/Config.h"
#elif defined(__OpenBSD__)
#include "lldb/Host/openbsd/Config.h"
#elif defined(__MINGW__) || defined(__MINGW32__)
#include "lldb/Host/mingw/Config.h"
#elif defined(_MSC_VER)
#include "lldb/Host/msvc/Config.h"
#else #else
#error undefined platform #error This file is only used by the Xcode build.
#endif #endif
#endif // #ifndef liblldb_Config_h_ #endif // #ifndef LLDB_HOST_CONFIG_H

lldb/trunk/include/lldb/Host/Config.h.cmake

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_HOST_CONFIG_H
#define LLDB_HOST_CONFIG_H
#cmakedefine01 LLDB_CONFIG_TERMIOS_SUPPORTED
#cmakedefine LLDB_DISABLE_POSIX
#cmakedefine01 HAVE_SYS_EVENT_H
#endif // #ifndef LLDB_HOST_CONFIG_H

lldb/trunk/include/lldb/Host/android/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
//#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/freebsd/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/linux/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/macosx/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/mingw/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_DISABLE_POSIX
//#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
//#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/msvc/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_host_msvc_Config_h_
#define liblldb_host_msvc_Config_h_
#define LLDB_DISABLE_POSIX
//#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
//#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/netbsd/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/include/lldb/Host/openbsd/Config.h

//===-- Config.h -----------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//----------------------------------------------------------------------
// LLDB currently doesn't have a dynamic configuration mechanism, so we
// are going to hardcode things for now. Eventually these files will
// be auto generated by some configuration script that can detect
// platform functionality availability.
//----------------------------------------------------------------------
#ifndef liblldb_Platform_Config_h_
#define liblldb_Platform_Config_h_
#define LLDB_CONFIG_TERMIOS_SUPPORTED 1
#define LLDB_CONFIG_TILDE_RESOLVES_TO_USER 1
//#define LLDB_CONFIG_DLOPEN_RTLD_FIRST_SUPPORTED 1
//#define LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED 1
#endif // #ifndef liblldb_Platform_Config_h_

lldb/trunk/source/Host/common/File.cpp

Show First 20 Lines • Show All 301 Lines • ▼ Show 20 Linesvoid File::Clear() {
m_options = 0; m_options = 0;
m_own_stream = false; m_own_stream = false;
m_is_interactive = m_supports_colors = m_is_real_terminal = m_is_interactive = m_supports_colors = m_is_real_terminal =
eLazyBoolCalculate; eLazyBoolCalculate;
} }
Error File::GetFileSpec(FileSpec &file_spec) const { Error File::GetFileSpec(FileSpec &file_spec) const {
Error error; Error error;
#ifdef LLDB_CONFIG_FCNTL_GETPATH_SUPPORTED #ifdef F_GETPATH
if (IsValid()) { if (IsValid()) {
char path[PATH_MAX]; char path[PATH_MAX];
if (::fcntl(GetDescriptor(), F_GETPATH, path) == -1) if (::fcntl(GetDescriptor(), F_GETPATH, path) == -1)
error.SetErrorToErrno(); error.SetErrorToErrno();
else else
file_spec.SetFile(path, false); file_spec.SetFile(path, false);
} else { } else {
error.SetErrorString("invalid file handle"); error.SetErrorString("invalid file handle");
▲ Show 20 Lines • Show All 543 Lines • Show Last 20 Lines
lldb/trunk/include/lldb/Host/linux/Config.h