Merge pull request #824 from mull-project/linker-timeout

Add an option to configure linker's timeout

docs/CompilationDatabaseAndJunk.rst

@@ -20,7 +20,7 @@ Get sources and build fmtlib:
       -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
     make core-test
 
-*Note: last tested against commit ``018688da2a58ba25cdf173bd899734f755adb11a``*
+*Note: last tested against commit 018688da2a58ba25cdf173bd899734f755adb11a*
 
 Run Mull against the ``core-test``:
 
@@ -32,7 +32,7 @@ Run Mull against the ``core-test``:
 Right now you should see a weird and long error message by the end of execution.
 Here is a snippet:
 
-.. code-blocK:: text
+.. code-block:: text
 
     /// skipped
     [info] Applying mutations (threads: 1)
@@ -62,7 +62,7 @@ it just uses ``clang`` which works in most of the cases. However, in this case
 we deal with C++ which needs a corresponding C++ linker. Instead we should be
 using ``clang++``, which will do the job just fine.
 
-*Note: on Linux you may have to specify ``clang-<version>`` or ``clang++-<version>``,
+*Note: on Linux you may have to specify clang-<version> or clang++-<version>,
 where <version> corresponds to the version of clang installed*
 
 Try this:

docs/SQLiteReport.rst

@@ -1,7 +1,8 @@
 Working with SQLite report
 ==========================
 
-**Warning: the data model has changed and most of the tutorial is no longer relevant/applicable**
+**Warning: the data model has changed and most of the tutorial is no longer relevant/applicable.
+This tutorial will be updated for the next release.**
 
 From the very beginning, we didn't want to impose our vision on treating the results of mutation testing. Some people do not care about the mutation score, while others do care, but want to calculate it slightly differently.
 

docs/generated/CLIOptions.rst

@@ -40,6 +40,8 @@
 
 --linker-flags string		Extra linker flags to produce final executable
 
+--linker-timeout number		Timeout for the linking job (milliseconds)
+
 --coverage-info string		Path to the coverage info file (LLVM's profdata)
 
 --include-path regex		File/directory paths to whitelist (supports regex)

include/mull/Config/Configuration.h

@@ -8,6 +8,7 @@
 namespace mull {
 
 extern int MullDefaultTimeoutMilliseconds;
+extern unsigned MullDefaultLinkerTimeoutMilliseconds;
 
 struct Configuration {
   bool debugEnabled;
@@ -17,6 +18,7 @@ struct Configuration {
   bool skipSanityCheckRun;
 
   int timeout;
+  unsigned linkerTimeout;
 
   IDEDiagnosticsKind diagnostics;
 

lib/Config/Configuration.cpp

@@ -13,10 +13,12 @@ ParallelizationConfig singleThreadParallelization() {
 }
 
 int MullDefaultTimeoutMilliseconds = 3000;
+unsigned MullDefaultLinkerTimeoutMilliseconds = 30000;
 
 Configuration::Configuration()
     : debugEnabled(false), dryRunEnabled(false), captureTestOutput(true), captureMutantOutput(true),
       skipSanityCheckRun(false), timeout(MullDefaultTimeoutMilliseconds),
-      diagnostics(IDEDiagnosticsKind::None), parallelization(singleThreadParallelization()) {}
+      linkerTimeout(MullDefaultLinkerTimeoutMilliseconds), diagnostics(IDEDiagnosticsKind::None),
+      parallelization(singleThreadParallelization()) {}
 
 } // namespace mull

lib/Toolchain/Linker.cpp

@@ -29,7 +29,8 @@ std::string Linker::linkObjectFiles(const std::vector<std::string> &objects) {
   std::copy(std::begin(objects), std::end(objects), std::back_inserter(arguments));
   arguments.emplace_back("-o");
   arguments.push_back(resultPath.str().str());
-  ExecutionResult result = runner.runProgram(configuration.linker, arguments, {}, 50000, true);
+  ExecutionResult result =
+      runner.runProgram(configuration.linker, arguments, {}, configuration.linkerTimeout, true);
   std::stringstream commandStream;
   commandStream << configuration.linker;
   for (std::string &argument : arguments) {
@@ -48,6 +49,6 @@ std::string Linker::linkObjectFiles(const std::vector<std::string> &objects) {
     diagnostics.error(message.str());
   }
   diagnostics.debug("Link command: "s + command);
-  diagnostics.debug("Compiled executable: "s + resultPath.c_str());
+  diagnostics.info("Compiled executable: "s + resultPath.c_str());
   return resultPath.str().str();
 }

tools/mull-cxx/CLIOptions.cpp

@@ -90,6 +90,14 @@ opt<std::string> tool::LinkerFlags(
     init(std::string()),
     cat(MullCXXCategory));
 
+opt<unsigned> tool::LinkerTimeout(
+    "linker-timeout",
+    desc("Timeout for the linking job (milliseconds)"),
+    Optional,
+    value_desc("number"),
+    init(MullDefaultLinkerTimeoutMilliseconds),
+    cat(MullCXXCategory));
+
 opt<std::string> tool::CoverageInfo(
     "coverage-info",
     desc("Path to the coverage info file (LLVM's profdata)"),
@@ -317,6 +325,7 @@ void tool::dumpCLIInterface(Diagnostics &diagnostics) {
 
       &Linker,
       &LinkerFlags,
+      &LinkerTimeout,
 
       &CoverageInfo,
 

tools/mull-cxx/CLIOptions.h

@@ -28,6 +28,7 @@ extern opt<std::string> CompilationFlags;
 
 extern opt<std::string> Linker;
 extern opt<std::string> LinkerFlags;
+extern opt<unsigned> LinkerTimeout;
 
 extern opt<std::string> CoverageInfo;
 

tools/mull-cxx/mull-cxx.cpp

@@ -90,6 +90,7 @@ int main(int argc, char **argv) {
 
   configuration.linker = tool::Linker.getValue();
   configuration.linkerFlags = splitFlags(tool::LinkerFlags.getValue());
+  configuration.linkerTimeout = tool::LinkerTimeout.getValue();
 
   configuration.debugEnabled = tool::DebugEnabled;
   configuration.timeout = tool::Timeout.getValue();