[lldb] [ABI/X86] Split plugin class and base i386 class

[mgorny]

Summary

Split the ABIX86 class into two classes: ABIX86 class used to define
the plugin, and ABIX86_i386 class that is the base for 32-bit ABIs.
This makes ABIX86 more suitable to become a common class for all ABIs,
and removes the confusing concept that ABIX86 initializes 64-bit ABIs
but is only the base for 32-bit ABIs.

[mgorny]

lldb/source/Plugins/ABI/X86/ABIX86_i386.h

14

For the record, I'm not married to this name ;-). I was originally thinking of ABIX86_32 but it felt weird when all the ABIs carry _i386 suffix.

[labath]

lldb/source/Plugins/ABI/X86/ABIX86.h

15

Now it's weird that this class is in no relation to the ABI class, nor to the individual ABIXXX_YYY subclasses. Maybe lets insert it into the hierarchy (as a common superclass of ABIX86_i386 and ABIX86_64). Even if it's initially empty, I can imagine one could eventually put some common x86 code there.

[mgorny]

lldb/source/Plugins/ABI/X86/ABIX86.h

15

Sure, will do.

lldb/source/Plugins/ABI/X86/ABIMacOSX_i386.h

 //===-- ABIMacOSX_i386.h ----------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H
 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H
 
-#include "Plugins/ABI/X86/ABIX86.h"
+#include "Plugins/ABI/X86/ABIX86_i386.h"
 #include "lldb/Core/Value.h"
 #include "lldb/lldb-private.h"
 
-class ABIMacOSX_i386 : public ABIX86 {
+class ABIMacOSX_i386 : public ABIX86_i386 {
 public:
   ~ABIMacOSX_i386() override = default;
 
   size_t GetRedZoneSize() const override;
 
   bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,
                           lldb::addr_t func_addr, lldb::addr_t return_addr,
                           llvm::ArrayRef<lldb::addr_t> args) const override;
protected:
   bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info);
 
   std::string GetMCName(std::string name) override {
     MapRegisterName(name, "stmm", "st");
     return name;
   }
 
 private:
-  using ABIX86::ABIX86; // Call CreateInstance instead.
+  using ABIX86_i386::ABIX86_i386; // Call CreateInstance instead.
 };
 
 #endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABIMACOSX_I386_H

lldb/source/Plugins/ABI/X86/ABISysV_i386.h

 //===------------------- ABISysV_i386.h -------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABISYSV_I386_H
 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABISYSV_I386_H
 
-#include "Plugins/ABI/X86/ABIX86.h"
+#include "Plugins/ABI/X86/ABIX86_i386.h"
 #include "lldb/lldb-private.h"
 
-class ABISysV_i386 : public ABIX86 {
+class ABISysV_i386 : public ABIX86_i386 {
 public:
   ~ABISysV_i386() override = default;
 
   size_t GetRedZoneSize() const override {
     return 0; // There is no red zone for i386 Architecture
   }
 
   bool PrepareTrivialCall(lldb_private::Thread &thread, lldb::addr_t sp,

 protected:
   lldb::ValueObjectSP
   GetReturnValueObjectSimple(lldb_private::Thread &thread,
                              lldb_private::CompilerType &ast_type) const;
 
   bool RegisterIsCalleeSaved(const lldb_private::RegisterInfo *reg_info);
 
 private:
-  using ABIX86::ABIX86; // Call CreateInstance instead.
+  using ABIX86_i386::ABIX86_i386; // Call CreateInstance instead.
 };
 
 #endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABISYSV_I386_H

lldb/source/Plugins/ABI/X86/ABIX86.h

-//===-- X86.h ---------------------------------------------------*- C++ -*-===//
+//===-- ABIX86.h ------------------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_H
 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_H
 
 #include "lldb/Target/ABI.h"
+#include "lldb/lldb-private.h"
 
 class ABIX86 : public lldb_private::MCBasedABI {
 public:
   static void Initialize();
   static void Terminate();
 
-  uint32_t GetGenericNum(llvm::StringRef name) override;
-
 private:
   using lldb_private::MCBasedABI::MCBasedABI;
 };
+
 #endif

lldb/source/Plugins/ABI/X86/ABIX86.cpp

-//===-- X86.h -------------------------------------------------------------===//
+//===-- ABIX86.cpp --------------------------------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "ABIX86.h"

 }
 
 void ABIX86::Terminate() {
   ABIMacOSX_i386::Terminate();
   ABISysV_i386::Terminate();
   ABISysV_x86_64::Terminate();
   ABIWindows_x86_64::Terminate();
 }
-
-uint32_t ABIX86::GetGenericNum(llvm::StringRef name) {
-  return llvm::StringSwitch<uint32_t>(name)
-      .Case("eip", LLDB_REGNUM_GENERIC_PC)
-      .Case("esp", LLDB_REGNUM_GENERIC_SP)
-      .Case("ebp", LLDB_REGNUM_GENERIC_FP)
-      .Case("eflags", LLDB_REGNUM_GENERIC_FLAGS)
-      .Case("edi", LLDB_REGNUM_GENERIC_ARG1)
-      .Case("esi", LLDB_REGNUM_GENERIC_ARG2)
-      .Case("edx", LLDB_REGNUM_GENERIC_ARG3)
-      .Case("ecx", LLDB_REGNUM_GENERIC_ARG4)
-      .Default(LLDB_INVALID_REGNUM);
-}

lldb/source/Plugins/ABI/X86/ABIX86_64.h

 //===-- ABIX86_64.h ---------------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_64_H
 #define LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_64_H
 
-#include "lldb/Target/ABI.h"
-#include "lldb/lldb-private.h"
+#include "Plugins/ABI/X86/ABIX86.h"
+
+class ABIX86_64 : public ABIX86 {
+public:
+  uint32_t GetGenericNum(llvm::StringRef name) override;
 
-class ABIX86_64 : public lldb_private::MCBasedABI {
 protected:
   std::string GetMCName(std::string name) override {
     MapRegisterName(name, "stmm", "st");
     return name;
   }
 
 private:
-  using lldb_private::MCBasedABI::MCBasedABI;
+  using ABIX86::ABIX86;
 };
 
 #endif // LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_64_H

lldb/source/Plugins/ABI/X86/ABIX86_i386.h

-//===-- X86.h ---------------------------------------------------*- C++ -*-===//
+//===-- ABIX86_i386.h -------------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_H
-#define LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_H
+#ifndef LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_I386_H
+#define LLDB_SOURCE_PLUGINS_ABI_X86_ABIX86_I386_H
 
-#include "lldb/Target/ABI.h"
+#include "Plugins/ABI/X86/ABIX86.h"
 
-class ABIX86 : public lldb_private::MCBasedABI {
+class ABIX86_i386 : public ABIX86 {
 public:
-  static void Initialize();
-  static void Terminate();
-
   uint32_t GetGenericNum(llvm::StringRef name) override;
 
 private:
-  using lldb_private::MCBasedABI::MCBasedABI;
+  using ABIX86::ABIX86;
 };
+
 #endif

lldb/source/Plugins/ABI/X86/ABIX86_i386.cpp

-//===-- X86.h -------------------------------------------------------------===//
+//===-- ABIX86_i386.cpp ---------------------------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 
-#include "ABIX86.h"
-#include "ABIMacOSX_i386.h"
-#include "ABISysV_i386.h"
-#include "ABISysV_x86_64.h"
-#include "ABIWindows_x86_64.h"
-#include "lldb/Core/PluginManager.h"
+#include "ABIX86_i386.h"
 
-LLDB_PLUGIN_DEFINE(ABIX86)
-
-void ABIX86::Initialize() {
-  ABIMacOSX_i386::Initialize();
-  ABISysV_i386::Initialize();
-  ABISysV_x86_64::Initialize();
-  ABIWindows_x86_64::Initialize();
-}
-
-void ABIX86::Terminate() {
-  ABIMacOSX_i386::Terminate();
-  ABISysV_i386::Terminate();
-  ABISysV_x86_64::Terminate();
-  ABIWindows_x86_64::Terminate();
-}
-
-uint32_t ABIX86::GetGenericNum(llvm::StringRef name) {
+uint32_t ABIX86_i386::GetGenericNum(llvm::StringRef name) {
   return llvm::StringSwitch<uint32_t>(name)
       .Case("eip", LLDB_REGNUM_GENERIC_PC)
       .Case("esp", LLDB_REGNUM_GENERIC_SP)
       .Case("ebp", LLDB_REGNUM_GENERIC_FP)
       .Case("eflags", LLDB_REGNUM_GENERIC_FLAGS)
       .Case("edi", LLDB_REGNUM_GENERIC_ARG1)
       .Case("esi", LLDB_REGNUM_GENERIC_ARG2)
       .Case("edx", LLDB_REGNUM_GENERIC_ARG3)
       .Case("ecx", LLDB_REGNUM_GENERIC_ARG4)
       .Default(LLDB_INVALID_REGNUM);
 }

lldb/source/Plugins/ABI/X86/CMakeLists.txt

 add_lldb_library(lldbPluginABIX86 PLUGIN
   ABIX86.cpp
+  ABIX86_i386.cpp
   ABIMacOSX_i386.cpp
   ABISysV_i386.cpp
   ABISysV_x86_64.cpp
   ABIWindows_x86_64.cpp
 
   LINK_LIBS
     lldbCore
     lldbSymbol
     lldbTarget
   LINK_COMPONENTS
     Support
   )