Add support to print version.

[shankarke]

Summary

Add support to print version.

[shankarke]

Update change to fix few minor nits.

[ruiu]

Please write more descriptive commit message for this patch.
Something like "Add -version option to the universal driver to
print out LLD version and SVN revision number.".

CMakeLists.txt

99

I don't think we need this. It's always https://llvm.org/svn/llvm-project/lld/trunk.

include/lld/Config/Version.h

2

lib/Config/Version.h

46

We could print out revision number along with the version number like "version 3.5 (r205863)". I don't see the reason to print out repository name. Remove it?

lib/Config/Version.cpp

2

lib/Config/Version.cpp.

25

It's always defined, no?

33

Ditto

40

Remove?

60

Ditto

lib/Driver/UniversalDriver.cpp

194

Remove space before :.

[shankarke]

CMakeLists.txt

99

Its a standard thing followed by other projects like lldb/clang.

include/lld/Config/Version.h

2

Sure.

46

Same thing the style is followed by clang/lldb as well. so kept it consistent.

lldb --version 2>/dev/null
lldb version 3.6.0 ( https://llvm.org/svn/llvm-project/lldb/trunk revision 218537)

lib/Config/Version.cpp

25

The repository path and the version is empty on windows. Its a TODO.

lib/Driver/UniversalDriver.cpp

194

ok.

[shankarke]

include/lld/Config/Version.h

2

The file is an include file and is included by UniversalDriver, I dont think we should keep it in lib.

[shankarke]

address review comments.

[ruiu]

Please update the commit message to be more descriptive.

CMakeLists.txt

99

But clang doesn't have -repository-version option, no?

include/lld/Config/Version.h

2

What I mean is to update this line to match the path. I should've write "include/lld/Config/Version.h". Sorry.

46

OK, then let's use the same format as LLDB, instead of adding two options, -version and -repository-version, and remove remove -repository-version.

[shankarke]

CMakeLists.txt

99

It looks that option has disappeared from clang, I had seen that a long long time back.

include/lld/Config/Version.h

2

Updated to mention this properly in the new patch.

46

Ok.

lib/Config/Version.cpp

2

ok.

[shankarke]

I have changed the commit message but for some reason, its not appearing as part of the new diff. You will see it when I commit.

This is how it looks just FYI.

Add support to print version.

Summary: This adds support in the UniversalDriver to print the linker version and the
repository version.

Test Plan: A driver test is added

Differential Revision: http://reviews.llvm.org/D5641

[shankarke]

address review comments.

[ruiu]

LGTM with this nit.

lib/Config/Makefile

1

Remove "lld/" from this line.

[shankarke]

Address review comments and commit.

[shankarke]

For some reason, arc committed the patch with my old description. I don't have any clue why it did that and didn't use my latest change in the commit description.

CMakeLists.txt

if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
   set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 
   set(LLD_BUILT_STANDALONE 1)
 endif()
 
 set(LLD_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(LLD_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
+# Compute the LLD version from the LLVM version.
+string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" LLD_VERSION
+  ${PACKAGE_VERSION})
+message(STATUS "LLD version: ${LLD_VERSION}")
+
+string(REGEX REPLACE "([0-9]+)\\.[0-9]+(\\.[0-9]+)?" "\\1" LLD_VERSION_MAJOR
+  ${LLD_VERSION})
+string(REGEX REPLACE "[0-9]+\\.([0-9]+)(\\.[0-9]+)?" "\\1" LLD_VERSION_MINOR
+  ${LLD_VERSION})
+
+# Determine LLD revision and repository.
+# TODO: Figure out a way to get the revision and the repository on windows.
+if ( NOT CMAKE_SYSTEM_NAME MATCHES "Windows" )
+  execute_process(COMMAND ${CMAKE_SOURCE_DIR}/utils/GetSourceVersion ${LLD_SOURCE_DIR}
+                  OUTPUT_VARIABLE LLD_REVISION)
+
+  execute_process(COMMAND ${CMAKE_SOURCE_DIR}/utils/GetRepositoryPath ${LLD_SOURCE_DIR}
+                  OUTPUT_VARIABLE LLD_REPOSITORY)
+  if ( LLD_REPOSITORY )
+    # Replace newline characters with spaces
+    string(REGEX REPLACE "(\r?\n)+" " " LLD_REPOSITORY ${LLD_REPOSITORY})
+    # Remove leading spaces
+    STRING(REGEX REPLACE "^[ \t\r\n]+" "" LLD_REPOSITORY "${LLD_REPOSITORY}" )
+    # Remove trailing spaces
+    string(REGEX REPLACE "(\ )+$" "" LLD_REPOSITORY ${LLD_REPOSITORY})
+  endif()
+
+  if ( LLD_REVISION )
+    # Replace newline characters with spaces
+    string(REGEX REPLACE "(\r?\n)+" " " LLD_REVISION ${LLD_REVISION})
+    # Remove leading spaces
+    STRING(REGEX REPLACE "^[ \t\r\n]+" "" LLD_REVISION "${LLD_REVISION}" )
+    # Remove trailing spaces
+    string(REGEX REPLACE "(\ )+$" "" LLD_REVISION ${LLD_REVISION})
+  endif()
+endif ()
+
+# Configure the Version.inc file.
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/include/lld/Config/Version.inc.in
+  ${CMAKE_CURRENT_BINARY_DIR}/include/lld/Config/Version.inc)
+
+
 if (CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
   message(FATAL_ERROR "In-source builds are not allowed. CMake would overwrite "
 "the makefiles distributed with LLVM. Please create a directory and run cmake "
 "from there, passing the path to this source directory as the last argument. "
 "This process created the file `CMakeCache.txt' and the directory "
 "`CMakeFiles'. Please delete them.")
 endif()
 

include/lld/Config/Makefile

+LLD_LEVEL := ../../..
+
+BUILT_SOURCES = Version.inc
+
+TABLEGEN_INC_FILES_COMMON = 1
+
+include $(LLD_LEVEL)/Makefile
+
+# Compute the lld version from the LLVM version, unless specified explicitly.
+ifndef LLD_VERSION
+LLD_VERSION := $(subst svn,,$(LLVMVersion))
+LLD_VERSION := $(subst rc,,$(LLD_VERSION))
+endif
+
+LLD_VERSION_COMPONENTS := $(subst ., ,$(LLD_VERSION))
+LLD_VERSION_MAJOR := $(word 1,$(LLD_VERSION_COMPONENTS))
+LLD_VERSION_MINOR := $(word 2,$(LLD_VERSION_COMPONENTS))
+
+LLD_REVISION := $(strip \
+        $(shell $(LLVM_SRC_ROOT)/utils/GetSourceVersion $(LLVM_SRC_ROOT)/tools/lld))
+
+LLD_REPOSITORY := $(strip \
+        $(shell $(LLVM_SRC_ROOT)/utils/GetRepositoryPath $(LLVM_SRC_ROOT)/tools/lld))
+
+$(ObjDir)/Version.inc.tmp : Version.inc.in Makefile $(LLVM_OBJ_ROOT)/Makefile.config $(ObjDir)/.dir
+  $(Echo) "Updating LLD version info."
+  $(Verb)sed -e "s#@LLD_VERSION@#$(LLD_VERSION)#g" \
+             -e "s#@LLD_VERSION_MAJOR@#$(LLD_VERSION_MAJOR)#g" \
+             -e "s#@LLD_VERSION_MINOR@#$(LLD_VERSION_MINOR)#g" \
+             -e "s#@LLD_REVISION@#$(LLD_REVISION)#g" \
+             -e "s#@LLD_REPOSITORY@#$(LLD_REPOSITORY)#g" \
+             $< > $@

include/lld/Config/Version.h

+//===- lld/Config/Version.h - LLD Version Number ----------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// \brief Defines version macros and version-related utility functions
+/// for lld.
+///
+//===----------------------------------------------------------------------===//
+
+#ifndef LLD_VERSION_H
+#define LLD_VERSION_H
+
+#include "lld/Config/Version.inc"
+#include "llvm/ADT/StringRef.h"
+#include <string>
+
+/// \brief Helper macro for LLD_VERSION_STRING.
+#define LLD_MAKE_VERSION_STRING2(X) #X
+
+/// \brief Helper macro for LLD_VERSION_STRING.
+#define LLD_MAKE_VERSION_STRING(X, Y) LLD_MAKE_VERSION_STRING2(X.Y)
+
+/// \brief A string that describes the lld version number, e.g., "1.0".
+#define LLD_VERSION_STRING                                                     \
+  LLD_MAKE_VERSION_STRING(LLD_VERSION_MAJOR, LLD_VERSION_MINOR)
+
+namespace lld {
+/// \brief Retrieves the repository path (e.g., Subversion path) that
+/// identifies the particular lld branch, tag, or trunk from which this
+/// lld was built.
+llvm::StringRef getLLDRepositoryPath();
+
+/// \brief Retrieves the repository revision number (or identifer) from which
+/// this lld was built.
+llvm::StringRef getLLDRevision();
+
+/// \brief Retrieves the full repository version that is an amalgamation of
+/// the information in getLLDRepositoryPath() and getLLDRevision().
+std::string getLLDRepositoryVersion();
+
+/// \brief Retrieves a string representing the complete lld version.
+llvm::StringRef getLLDVersion();
+}
+
+#endif // LLD_VERSION_H

include/lld/Config/Version.inc.in

+#define LLD_VERSION @LLD_VERSION@
+#define LLD_VERSION_MAJOR @LLD_VERSION_MAJOR@
+#define LLD_VERSION_MINOR @LLD_VERSION_MINOR@
+#define LLD_REVISION_STRING "@LLD_REVISION@"
+#define LLD_REPOSITORY_STRING "@LLD_REPOSITORY@"

include/lld/Makefile

 LLD_LEVEL := ../..
-DIRS :=
+DIRS := Config
 
 include $(LLD_LEVEL)/Makefile
 
 install-local::
   $(Echo) Installing lld include files
   $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_includedir)
   $(Verb) if test -d "$(PROJ_SRC_DIR)" ; then \
     cd $(PROJ_SRC_DIR)/.. && \

lib/CMakeLists.txt

+add_subdirectory(Config)
 add_subdirectory(Core)
 add_subdirectory(Driver)
 add_subdirectory(Passes)
 add_subdirectory(ReaderWriter)

lib/Config/CMakeLists.txt

+add_lld_library(lldConfig
+  Version.cpp
+  )

lib/Config/Makefile

-##===- lib/Makefile ----------------------------------------*- Makefile -*-===##
+##===- lld/lib/Config/Makefile -----------------------------*- Makefile -*-===##
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 ##===----------------------------------------------------------------------===##
-LLD_LEVEL := ..
 
-# ARCMigrate and Rewrite are always needed because of libclang.
-PARALLEL_DIRS = Core Driver Passes ReaderWriter
-
-include $(LLD_LEVEL)/../../Makefile.config
+LLD_LEVEL := ../..
+LIBRARYNAME := lldConfig
 
 include $(LLD_LEVEL)/Makefile

lib/Config/Version.cpp

+//===- lib/Config/Version.cpp - LLD Version Number ---------------*- C++-=====//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines several version-related utility functions for LLD.
+//
+//===----------------------------------------------------------------------===//
+
+#include "lld/Config/Version.h"
+#include "llvm/Support/raw_ostream.h"
+#include <cstdlib>
+#include <cstring>
+
+using namespace llvm;
+
+namespace lld {
+
+StringRef getLLDRepositoryPath() {
+#ifdef LLD_REPOSITORY_STRING
+  return LLD_REPOSITORY_STRING;
+#else
+  return "";
+#endif
+}
+
+StringRef getLLDRevision() {
+#ifdef LLD_REVISION_STRING
+  return LLD_REVISION_STRING;
+#else
+  return "";
+#endif
+}
+
+std::string getLLDRepositoryVersion() {
+  std::string buf;
+  llvm::raw_string_ostream OS(buf);
+  std::string Path = getLLDRepositoryPath();
+  std::string Revision = getLLDRevision();
+  if (!Path.empty() || !Revision.empty()) {
+    OS << '(';
+    if (!Path.empty())
+      OS << Path;
+    if (!Revision.empty()) {
+      if (!Path.empty())
+        OS << ' ';
+      OS << Revision;
+    }
+    OS << ')';
+  }
+  return OS.str();
+}
+
+StringRef getLLDVersion() {
+#ifdef LLD_VERSION_STRING
+  return LLD_VERSION_STRING;
+#else
+  return "";
+#endif
+}
+
+} // end namespace lld

lib/Driver/CMakeLists.txt

add_lld_library(lldDriver
   WinLinkDriver.cpp
   WinLinkInputGraph.cpp
   WinLinkModuleDef.cpp
   )
 
 add_dependencies(lldDriver DriverOptionsTableGen)
 
 target_link_libraries(lldDriver
+  lldConfig
   lldPasses
   lldMachO
   lldPECOFF
   lldELF
   lldCore
   lldNative
   lldReaderWriter
   lldYAML
   LLVMObject
   LLVMOption
   LLVMSupport
   )

lib/Driver/UniversalDriver.cpp

 /// \file
 ///
 /// Driver for "universal" lld tool which can mimic any linker command line
 /// parsing once it figures out which command line flavor to use.
 ///
 //===----------------------------------------------------------------------===//
 
 #include "lld/Driver/Driver.h"
+#include "lld/Config/Version.h"
 
 #include "lld/Core/LLVM.h"
 
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/Option/Arg.h"
 #include "llvm/Option/Option.h"
bool UniversalDriver::link(int argc, const char *argv[],
   }
 
   // Handle --help
   if (parsedArgs->getLastArg(OPT_help)) {
     table.PrintHelp(llvm::outs(), programName.data(), "LLVM Linker", false);
     return true;
   }
 
+  // Handle -version
+  if (parsedArgs->getLastArg(OPT_version)) {
+    diagnostics << "LLVM Linker Version: " << getLLDVersion()
+                << getLLDRepositoryVersion() << "\n";
+    return true;
+  }
+
   Flavor flavor = getFlavor(argc, argv, parsedArgs);
   std::vector<const char *> args(argv, argv + argc);
 
   // Switch to appropriate driver.
   switch (flavor) {
   case Flavor::gnu_ld:
     return GnuLdDriver::linkELF(args.size(), args.data(), diagnostics);
   case Flavor::darwin_ld:

lib/Driver/UniversalDriverOptions.td

 include "llvm/Option/OptParser.td"
 
 // Select an optional flavor
 def flavor: Separate<["-"], "flavor">,
      HelpText<"Flavor for linking, options are gnu/darwin/link">;
 
 // Select the core flavor
 def core : Flag<["-"], "core">,
      HelpText<"CORE linking">;
 
 def target: Separate<["-"], "target">,
      HelpText<"Select the target">;
 
+def version: Flag<["-"], "version">,
+     HelpText<"Display the version">;
+
 // Help message
 def help : Flag<["-"], "help">,
      HelpText<"Display this help message">;

lib/Makefile

 ##===- lib/Makefile ----------------------------------------*- Makefile -*-===##
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 ##===----------------------------------------------------------------------===##
 LLD_LEVEL := ..
 
 # ARCMigrate and Rewrite are always needed because of libclang.
-PARALLEL_DIRS = Core Driver Passes ReaderWriter
+PARALLEL_DIRS = Config Core Driver Passes ReaderWriter
 
 include $(LLD_LEVEL)/../../Makefile.config
 
 include $(LLD_LEVEL)/Makefile

tools/lld/Makefile

 # No plugins, optimize startup time.
 TOOL_NO_EXPORTS = 1
 
 #include /Makefile.config
 LEVEL := $(LLD_LEVEL)/../..
 include $(LEVEL)/Makefile.config
 
 LINK_COMPONENTS := $(TARGETS_TO_BUILD)
-USEDLIBS = lldDriver.a \
+USEDLIBS = lldDriver.a lldConfig.a \
            lldELF.a lldMachO.a lldPasses.a lldPECOFF.a lldYAML.a \
            lldReaderWriter.a lldCore.a lldNative.a \
            lldHexagonELFTarget.a lldPPCELFTarget.a lldMipsELFTarget.a \
            lldX86ELFTarget.a lldX86_64ELFTarget.a lldAArch64ELFTarget.a \
            LLVMOption.a
 
 include $(LLD_LEVEL)/Makefile

unittests/DriverTests/Makefile

 ##===---- unittests/DriverTests/Makefile ----------------*- Makefile -*-===##
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 ##===-------------------------------------------------------------------===##
 
 LLD_LEVEL = ../..
 TESTNAME = DriverTests
-USEDLIBS = lldDriver.a \
+USEDLIBS = lldDriver.a lldConfig.a \
            lldELF.a lldMachO.a lldPasses.a lldPECOFF.a \
            lldCore.a lldNative.a lldReaderWriter.a \
            lldHexagonELFTarget.a lldPPCELFTarget.a lldMipsELFTarget.a \
            lldX86ELFTarget.a lldX86_64ELFTarget.a lldYAML.a \
            LLVMObject.a LLVMMCParser.a LLVMMC.a LLVMBitReader.a \
            LLVMCore.a LLVMOption.a LLVMSupport.a lldAArch64ELFTarget.a
 include $(LLD_LEVEL)/unittests/Makefile