[intel-pt] Refactor 2: create a new folder structure

[wallace]

Summary

Depends on D85068.

The existing folder structure was not great and was using relative includes
for headers in C++ files, which I'm not fond of. I've split the code into two
main groups: Core and API. This will help us have a clear separation between
the public and private code.

Besides, I've updated the CMakeFile accordingly.

[wallace]

After syncing up with Greg, we decided to redo this in a different way

lldb/tools/intel-features/cli-wrapper.cpp

 //
 //===----------------------------------------------------------------------===//
 
 #ifdef BUILD_INTEL_MPX
 #include "intel-mpx/cli-wrapper-mpxtable.h"
 #endif
 
 #ifdef BUILD_INTEL_PT
-#include "intel-pt/cli-wrapper-pt.h"
+#include "intel-pt/API/cli-wrapper-pt.h"
 #endif
 
 #include "lldb/API/SBDebugger.h"
 
 namespace lldb {
 bool PluginInitialize(lldb::SBDebugger debugger);
 }
 
 bool lldb::PluginInitialize(lldb::SBDebugger debugger) {
 
 #ifdef BUILD_INTEL_PT

lldb/tools/intel-features/intel-pt/CMakeLists.txt

-if (NOT LIBIPT_INCLUDE_PATH)
-  message (FATAL_ERROR "libipt include path not provided")
-endif()
-
-if (NOT EXISTS "${LIBIPT_INCLUDE_PATH}")
-  message (FATAL_ERROR "invalid libipt include path provided")
-endif()
-include_directories(${LIBIPT_INCLUDE_PATH})
-
-if (NOT LIBIPT_LIBRARY_PATH)
-  find_library(LIBIPT_LIBRARY ipt)
-else()
-  if (NOT EXISTS "${LIBIPT_LIBRARY_PATH}")
-    message (FATAL_ERROR "invalid libipt library path provided")
-  endif()
-  find_library(LIBIPT_LIBRARY ipt PATHS ${LIBIPT_LIBRARY_PATH})
-endif()
-
-if (NOT LIBIPT_LIBRARY)
-  message (FATAL_ERROR "libipt library not found")
-endif()
-
-add_lldb_library(lldbIntelPT
-  PTDecoder.cpp
-  Decoder.cpp
-  cli-wrapper-pt.cpp
-
-  LINK_LIBS
-    ${LIBIPT_LIBRARY}
-    liblldb
-  )
+set(INTEL_PT_INCLUDES
+  ${LLDB_SOURCE_DIR}/tools/intel-features/intel-pt/include
+
+add_subdirectory(source)

lldb/tools/intel-features/intel-pt/include/intel-pt/API/PTDecoder.h

 //===-- PTDecoder.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 PTDecoder_h_
-#define PTDecoder_h_
+#ifndef LLDB_INTEL_PT_API_PT_DECODER_H
+#define LLDB_INTEL_PT_API_PT_DECODER_H
 
 // C/C++ Includes
 #include <vector>
 
 #include "lldb/API/SBDebugger.h"
 #include "lldb/API/SBError.h"
 #include "lldb/API/SBProcess.h"
 #include "lldb/API/SBStructuredData.h"
 #include "lldb/API/SBTraceOptions.h"
 #include "lldb/lldb-enumerations.h"
 #include "lldb/lldb-types.h"
 
 namespace intelpt_private {
public:
   ///     configuration.
   static lldb::SBTraceOptions GetDefaultTraceOptions();
 
 private:
   std::shared_ptr<intelpt_private::Decoder> m_opaque_sp;
 };
 
 } // namespace intelpt
-#endif // PTDecoder_h_
+#endif // LLDB_INTEL_PT_API_PT_DECODER_H

lldb/tools/intel-features/intel-pt/include/intel-pt/API/cli-wrapper-pt.h

 //===-- cli-wrapper-pt.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
 //
 // CLI Wrapper of PTDecoder Tool to enable it to be used through LLDB's CLI.
 //===----------------------------------------------------------------------===//
 
 #include "lldb/API/SBDebugger.h"
 
 bool PTPluginInitialize(lldb::SBDebugger &debugger);

lldb/tools/intel-features/intel-pt/include/intel-pt/Core/Decoder.h

 //===-- Decoder.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 Decoder_h_
-#define Decoder_h_
+#ifndef LLDB_INTEL_PT_CORE_DECODER_H
+#define LLDB_INTEL_PT_CORE_DECODER_H
 
 // C/C++ Includes
 #include <map>
 #include <mutex>
 #include <string>
 #include <vector>
 
 #include "lldb/API/SBDebugger.h"
 #include "lldb/API/SBError.h"
 #include "lldb/API/SBProcess.h"
 #include "lldb/API/SBStream.h"
 #include "lldb/API/SBStructuredData.h"
 #include "lldb/API/SBTarget.h"
 #include "lldb/API/SBTrace.h"
 #include "lldb/API/SBTraceOptions.h"
 #include "lldb/lldb-enumerations.h"
MapProcessUID_MapThreadID_TraceInfo
       m_mapProcessUID_mapThreadID_TraceInfo; // to store trace information for
                                              // each process and its associated
                                              // threads
   lldb::user_id_t m_debugger_user_id; // SBDebugger instance which is associated
                                       // to this Decoder instance
 };
 
 } // namespace intelpt_private
-#endif // Decoder_h_
+#endif // LLDB_INTEL_PT_CORE_DECODER_H

lldb/tools/intel-features/intel-pt/interface/PTDecoder.i

 %include "stdint.i"
 
 %include "lldb/lldb-defines.h"
 %include "lldb/lldb-enumerations.h"
 %include "lldb/lldb-forward.h"
 %include "lldb/lldb-types.h"
 
 %include "lldb/API/SBDefines.h"
 
-%include "../PTDecoder.h"
+%include "intel-pt/API/PTDecoder.h"

lldb/tools/intel-features/intel-pt/source/API/CMakeLists.txt

+add_lldb_library(lldbIntelPT
+  PTDecoder.cpp
+  cli-wrapper-pt.cpp
+
+  LINK_LIBS
+    lldbIntelPTCore
+)
+
+target_include_directories(lldbIntelPT PUBLIC ${INTEL_PT_INCLUDES})

lldb/tools/intel-features/intel-pt/source/API/PTDecoder.cpp

 //===-- PTDecoder.cpp -------------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
-#include "PTDecoder.h"
-#include "Decoder.h"
+#include "intel-pt/API/PTDecoder.h"
+#include "intel-pt/Core/Decoder.h"
 
 using namespace intelpt;
 using namespace intelpt_private;
 
 // PTInstruction class member functions definitions
 PTInstruction::PTInstruction(
     const std::shared_ptr<intelpt_private::Instruction> &ptr)
     : m_opaque_sp(ptr) {}

lldb/tools/intel-features/intel-pt/source/API/cli-wrapper-pt.cpp

 //===----------------------------------------------------------------------===//
 
 #include <cerrno>
 #include <cinttypes>
 #include <cstring>
 #include <string>
 #include <vector>
 
-#include "PTDecoder.h"
-#include "cli-wrapper-pt.h"
+#include "intel-pt/API/PTDecoder.h"
+#include "intel-pt/API/cli-wrapper-pt.h"
 #include "lldb/API/SBCommandInterpreter.h"
 #include "lldb/API/SBCommandReturnObject.h"
 #include "lldb/API/SBDebugger.h"
 #include "lldb/API/SBProcess.h"
 #include "lldb/API/SBStream.h"
 #include "lldb/API/SBStructuredData.h"
 #include "lldb/API/SBTarget.h"
 #include "lldb/API/SBThread.h"

lldb/tools/intel-features/intel-pt/source/CMakeLists.txt

+add_subdirectory(Core)
+add_subdirectory(API)

lldb/tools/intel-features/intel-pt/source/Core/CMakeLists.txt

else()
   endif()
   find_library(LIBIPT_LIBRARY ipt PATHS ${LIBIPT_LIBRARY_PATH})
 endif()
 
 if (NOT LIBIPT_LIBRARY)
   message (FATAL_ERROR "libipt library not found")
 endif()
 
-add_lldb_library(lldbIntelPT
-  PTDecoder.cpp
+add_lldb_library(lldbIntelPTCore
   Decoder.cpp
-  cli-wrapper-pt.cpp
 
   LINK_LIBS
     ${LIBIPT_LIBRARY}
     liblldb
-  )
+
+target_include_directories(lldbIntelPTCore PRIVATE ${INTEL_PT_INCLUDES})

lldb/tools/intel-features/intel-pt/source/Core/Decoder.cpp

 //===-- Decoder.cpp ---------------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
-#include "Decoder.h"
+#include "intel-pt/Core/Decoder.h"
 
 // C/C++ Includes
 #include <cinttypes>
 #include <cstring>
 
 #include "lldb/API/SBModule.h"
 #include "lldb/API/SBProcess.h"
 #include "lldb/API/SBThread.h"

lldb/tools/intel-features/scripts/CMakeLists.txt

 file(GLOB_RECURSE SWIG_SOURCES *.swig)
 
 set(FLAGS
   -c++
   -shadow
   -python
   -D__STDC_LIMIT_MACROS
   -D__STDC_CONSTANT_MACROS
   )
 
 set(INCLUDES
   -I${LLDB_SOURCE_DIR}/include
-  -I${LLDB_SOURCE_DIR}/tools/intel-features/intel-pt
+  -I${LLDB_SOURCE_DIR}/tools/intel-features/intel-pt/include
   )
 
 set(OUTPUT_PYTHON_WRAPPER
   ${CMAKE_CURRENT_BINARY_DIR}/IntelFeaturesPythonWrap.cpp
   )
 
 set(OUTPUT_PYTHON_SCRIPT_DIR
   ${CMAKE_CURRENT_BINARY_DIR}

lldb/tools/intel-features/scripts/lldb-intel-features.swig

 #if SWIG_VERSION >= 0x030009 && SWIG_VERSION < 0x030011
 #error Swig versions 3.0.9 and 3.0.10 are incompatible with lldb.
 #endif
 
 %module(moduleimport=MODULEIMPORT) lldbIntelFeatures
 
 %{
 #include "lldb/lldb-public.h"
-#include "intel-pt/PTDecoder.h"
+#include "intel-pt/API/PTDecoder.h"
 using namespace intelpt;
 %}
 
 /* Undefine GCC keyword to make Swig happy when processing glibc's stdint.h */
 #define __extension__
 
 /* Combined python typemap for all features */
 %include "python-typemaps.txt"
 
 /* Feature specific python interface files*/
 %include "../intel-pt/interface/PTDecoder.i"