[COMGR][Cache] Move AMDGPUCompilerDiagnosticHandler into its own header

Additionally, break the dependency between
AMDGPUCompilerDiagnosticHandler and AMDGPUCompiler. Only LogS is
referenced.

This is needed to properly cache the log stream for spirv support.
The function that is cached must initialize the DiagnosticHandler with the
raw_ostream passed by the cache. This raw_ostream may be LogS or a
raw_string_ostream to capture the error stream.

co-authored by anjenner and jmmartinez

Change-Id: Id915184e01b9b1aaafdcb974154ff8cb2089cefb

Author: jmmartinez

amd/comgr/CMakeLists.txt

@@ -72,6 +72,7 @@ set(SOURCES
   src/comgr-compiler.cpp
   src/comgr.cpp
   src/comgr-device-libs.cpp
+  src/comgr-diagnostic-handler.cpp
   src/comgr-disassembly.cpp
   src/comgr-elfdump.cpp
   src/comgr-env.cpp

amd/comgr/src/comgr-compiler.cpp

@@ -38,6 +38,7 @@
 
 #include "comgr-compiler.h"
 #include "comgr-device-libs.h"
+#include "comgr-diagnostic-handler.h"
 #include "comgr-env.h"
 #include "lld/Common/CommonLinkerContext.h"
 #include "lld/Common/Driver.h"
@@ -51,6 +52,7 @@
 #include "clang/Driver/Tool.h"
 #include "clang/Frontend/CompilerInstance.h"
 #include "clang/Frontend/FrontendDiagnostic.h"
+#include "clang/Frontend/TextDiagnosticPrinter.h"
 #include "clang/FrontendTool/Utils.h"
 #include "llvm/Bitcode/BitcodeWriter.h"
 #include "llvm/IR/LLVMContext.h"
@@ -1353,7 +1355,7 @@ amd_comgr_status_t AMDGPUCompiler::linkBitcodeToBitcode() {
   SMDiagnostic SMDiag;
   LLVMContext Context;
   Context.setDiagnosticHandler(
-      std::make_unique<AMDGPUCompilerDiagnosticHandler>(this), true);
+      std::make_unique<AMDGPUCompilerDiagnosticHandler>(this->LogS), true);
 
   auto Composite = std::make_unique<llvm::Module>("llvm-link", Context);
   Linker L(*Composite);
@@ -1867,7 +1869,7 @@ amd_comgr_status_t AMDGPUCompiler::translateSpirvToBitcode() {
 
   LLVMContext Context;
   Context.setDiagnosticHandler(
-    std::make_unique<AMDGPUCompilerDiagnosticHandler>(this), true);
+      std::make_unique<AMDGPUCompilerDiagnosticHandler>(this->LogS), true);
 
   for (auto *Input : InSet->DataObjects) {
 

amd/comgr/src/comgr-compiler.h

@@ -41,9 +41,6 @@
 
 #include "comgr.h"
 #include "clang/Driver/Driver.h"
-#include "clang/Frontend/TextDiagnosticPrinter.h"
-#include "llvm/IR/DiagnosticInfo.h"
-#include "llvm/IR/DiagnosticPrinter.h"
 
 namespace COMGR {
 
@@ -52,39 +49,6 @@ namespace COMGR {
 /// @warning No more than one public method should be called on a constructed
 /// object before it is destructed.
 class AMDGPUCompiler {
-  struct AMDGPUCompilerDiagnosticHandler : public llvm::DiagnosticHandler {
-    AMDGPUCompiler *Compiler = nullptr;
-
-    AMDGPUCompilerDiagnosticHandler(AMDGPUCompiler *Compiler)
-        : Compiler(Compiler) {}
-
-    bool handleDiagnostics(const llvm::DiagnosticInfo &DI) override {
-      assert(Compiler && "Compiler cannot be nullptr");
-      unsigned Severity = DI.getSeverity();
-      switch (Severity) {
-      case llvm::DS_Error:
-        Compiler->LogS << "ERROR: ";
-        break;
-      case llvm::DS_Warning:
-        Compiler->LogS << "WARNING: ";
-        break;
-      case llvm::DS_Remark:
-        Compiler->LogS << "REMARK: ";
-        break;
-      case llvm::DS_Note:
-        Compiler->LogS << "NOTE: ";
-        break;
-      default:
-        Compiler->LogS << "(Unknown DiagnosticInfo Severity): ";
-        break;
-      }
-      llvm::DiagnosticPrinterRawOStream DP(Compiler->LogS);
-      DI.print(DP);
-      Compiler->LogS << "\n";
-      return true;
-    }
-  };
-
   DataAction *ActionInfo;
   DataSet *InSet;
   amd_comgr_data_set_t OutSetT;

amd/comgr/src/comgr-diagnostic-handler.cpp

@@ -0,0 +1,69 @@
+/*******************************************************************************
+ *
+ * University of Illinois/NCSA
+ * Open Source License
+ *
+ * Copyright (c) 2003-2017 University of Illinois at Urbana-Champaign.
+ * Modifications (c) 2018 Advanced Micro Devices, Inc.
+ * All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * with the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimers.
+ *
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimers in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *     * Neither the names of the LLVM Team, University of Illinois at
+ *       Urbana-Champaign, nor the names of its contributors may be used to
+ *       endorse or promote products derived from this Software without specific
+ *       prior written permission.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+ * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
+ * THE SOFTWARE.
+ *
+ ******************************************************************************/
+#include "comgr-diagnostic-handler.h"
+
+#include "llvm/IR/DiagnosticPrinter.h"
+
+namespace COMGR {
+using namespace llvm;
+bool AMDGPUCompilerDiagnosticHandler::handleDiagnostics(
+    const DiagnosticInfo &DI) {
+  unsigned Severity = DI.getSeverity();
+  switch (Severity) {
+  case DS_Error:
+    LogS << "ERROR: ";
+    break;
+  case DS_Warning:
+    LogS << "WARNING: ";
+    break;
+  case DS_Remark:
+    LogS << "REMARK: ";
+    break;
+  case DS_Note:
+    LogS << "NOTE: ";
+    break;
+  default:
+    LogS << "(Unknown DiagnosticInfo Severity): ";
+    break;
+  }
+  DiagnosticPrinterRawOStream DP(LogS);
+  DI.print(DP);
+  LogS << "\n";
+  return true;
+}
+} // namespace COMGR

amd/comgr/src/comgr-diagnostic-handler.h

@@ -0,0 +1,54 @@
+/*******************************************************************************
+ *
+ * University of Illinois/NCSA
+ * Open Source License
+ *
+ * Copyright (c) 2003-2017 University of Illinois at Urbana-Champaign.
+ * Modifications (c) 2018 Advanced Micro Devices, Inc.
+ * All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * with the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimers.
+ *
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimers in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *     * Neither the names of the LLVM Team, University of Illinois at
+ *       Urbana-Champaign, nor the names of its contributors may be used to
+ *       endorse or promote products derived from this Software without specific
+ *       prior written permission.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+ * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
+ * THE SOFTWARE.
+ *
+ ******************************************************************************/
+
+#ifndef COMGR_DIAGNOSTIC_HANDLER_H
+#define COMGR_DIAGNOSTIC_HANDLER_H
+
+#include <llvm/IR/DiagnosticInfo.h>
+
+namespace COMGR {
+struct AMDGPUCompilerDiagnosticHandler : public llvm::DiagnosticHandler {
+  llvm::raw_ostream &LogS;
+
+  AMDGPUCompilerDiagnosticHandler(llvm::raw_ostream &LogS) : LogS(LogS) {}
+
+  bool handleDiagnostics(const llvm::DiagnosticInfo &DI) override;
+};
+} // namespace COMGR
+
+#endif