Shorten sanitizer plugin names

[labath]

Summary

The new UndefinedBehaviorSanitizer plugin was breaking file path length
limits, because it's (fairly long name) appears multiple times in the
path. Cmake ends up putting the object file at path
tools/lldb/source/Plugins/InstrumentationRuntime/UndefinedBehaviorSanitizer/CMakeFiles/lldbPluginInstrumentationRuntimeUndefinedBehaviorSanitizer.dir/UndefinedBehaviorSanitizerRuntime.cpp.obj
which is 191 characters long and very dangerously close to the 260
character path limit on windows systems (also, just the include line for
that file was breaking the 80 character line limit).

This renames the sanitizer plugins to use shorter names (asan, ubsan,
tsan). I think this will still be quite understandable to everyone as
those are the names everyone uses to refer to them anyway.

[kubamracek]

Oh wow, we really need to limit path lengths? What about files like ./packages/Python/lldbsuite/test/functionalities/thread/concurrent_events/breakpoints_delayed_breakpoint_one_watchpoint/TestConcurrentBreakpointsDelayedBreakpointOneWatchpoint.py?

[labath]

In D34553#789023, @kubamracek wrote:

Oh wow, we really need to limit path lengths?

It's a bit annoying, but windows has issues with paths like that. It's actually possible to avoid it nowadays, if you use the right APIs, but not all programs have been updated to do that. Ironically enough, the error here comes from the MSVC linker, which means clang either succeeded in creating the object file, or failed silently doing that (I can't say which one as this was happening on the buildbot).

What about files like ./packages/Python/lldbsuite/test/functionalities/thread/concurrent_events/breakpoints_delayed_breakpoint_one_watchpoint/TestConcurrentBreakpointsDelayedBreakpointOneWatchpoint.py?

That's another fine example of an incredibly long path, and it was causing some problems already (it broke dotest log file name length), but I've managed to work around those.

However, even without these limits, I feel that our file names/paths tend to be unnecessarily long.

[amccarth]

Thanks for doing this. This seems a reasonable alternative to fixing all the build tools upstream. And overly long paths are difficult to read.

[vsk]

Thanks, this lgtm. Our tools don't depend on these plugins having a particular file name.

[jingham]

I try to avoid making cryptic file names just to get them under some character count, since that also makes code hard to comprehend particularly for new users. But in this case everybody calls these features ASAN, UBSAN, etc. So this change shouldn't cause any confusion.

[krytarowski]

Looks good. It's easier to parse [at least for my eyes]: ubsan, asan, tsan etc than full-names.

source/API/SystemInitializerFull.cpp

 #include "Plugins/ABI/SysV-x86_64/ABISysV_x86_64.h"
 #include "Plugins/Disassembler/llvm/DisassemblerLLVMC.h"
 #include "Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOS.h"
 #include "Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOSXDYLD.h"
 #include "Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h"
 #include "Plugins/DynamicLoader/Static/DynamicLoaderStatic.h"
 #include "Plugins/DynamicLoader/Windows-DYLD/DynamicLoaderWindowsDYLD.h"
 #include "Plugins/Instruction/ARM64/EmulateInstructionARM64.h"
-#include "Plugins/InstrumentationRuntime/AddressSanitizer/AddressSanitizerRuntime.h"
-#include "Plugins/InstrumentationRuntime/ThreadSanitizer/ThreadSanitizerRuntime.h"
-#include "Plugins/InstrumentationRuntime/UndefinedBehaviorSanitizer/UndefinedBehaviorSanitizerRuntime.h"
+#include "Plugins/InstrumentationRuntime/ASan/ASanRuntime.h"
+#include "Plugins/InstrumentationRuntime/TSan/TSanRuntime.h"
+#include "Plugins/InstrumentationRuntime/UBSan/UBSanRuntime.h"
 #include "Plugins/InstrumentationRuntime/MainThreadChecker/MainThreadCheckerRuntime.h"
 #include "Plugins/JITLoader/GDB/JITLoaderGDB.h"
 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
 #include "Plugins/Language/Go/GoLanguage.h"
 #include "Plugins/Language/Java/JavaLanguage.h"
 #include "Plugins/Language/OCaml/OCamlLanguage.h"
 #include "Plugins/Language/ObjC/ObjCLanguage.h"
 #include "Plugins/Language/ObjCPlusPlus/ObjCPlusPlusLanguage.h"

source/Plugins/InstrumentationRuntime/ASan/ASanRuntime.h

 //===-- AddressSanitizerRuntime.h -------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef liblldb_AddressSanitizerRuntime_h_
 #define liblldb_AddressSanitizerRuntime_h_
 
 // C Includes
 // C++ Includes
 // Other libraries and framework includes
 // Project includes
 #include "lldb/Core/StructuredData.h"
 #include "lldb/Target/InstrumentationRuntime.h"
 #include "lldb/Target/Process.h"
 #include "lldb/lldb-private.h"
 
 namespace lldb_private {
 
 class AddressSanitizerRuntime : public lldb_private::InstrumentationRuntime {
 public:
   ~AddressSanitizerRuntime() override;
 
   static lldb::InstrumentationRuntimeSP
   CreateInstance(const lldb::ProcessSP &process_sp);
 
   static void Initialize();
 
   static void Terminate();
 
   static lldb_private::ConstString GetPluginNameStatic();
 
   static lldb::InstrumentationRuntimeType GetTypeStatic();
 
   lldb_private::ConstString GetPluginName() override {
     return GetPluginNameStatic();
   }
 
   virtual lldb::InstrumentationRuntimeType GetType() { return GetTypeStatic(); }
 
   uint32_t GetPluginVersion() override { return 1; }
 
 private:
   AddressSanitizerRuntime(const lldb::ProcessSP &process_sp)
       : lldb_private::InstrumentationRuntime(process_sp) {}
 
   const RegularExpression &GetPatternForRuntimeLibrary() override;
 
   bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;
 
   void Activate() override;
 
   void Deactivate();
 
   static bool NotifyBreakpointHit(void *baton,
                                   StoppointCallbackContext *context,
                                   lldb::user_id_t break_id,
                                   lldb::user_id_t break_loc_id);
 
   StructuredData::ObjectSP RetrieveReportData();
 
   std::string FormatDescription(StructuredData::ObjectSP report);
 };
 
 } // namespace lldb_private
 
 #endif // liblldb_AddressSanitizerRuntime_h_

source/Plugins/InstrumentationRuntime/ASan/ASanRuntime.cpp

-//===-- AddressSanitizerRuntime.cpp -----------------------------*- C++ -*-===//
+//===-- ASanRuntime.cpp -----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#include "AddressSanitizerRuntime.h"
+#include "ASanRuntime.h"
 
 #include "lldb/Breakpoint/StoppointCallbackContext.h"
 #include "lldb/Core/Debugger.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Core/PluginInterface.h"
 #include "lldb/Core/PluginManager.h"
 #include "lldb/Core/StreamFile.h"
 #include "lldb/Core/ValueObject.h"

source/Plugins/InstrumentationRuntime/ASan/CMakeLists.txt

-add_lldb_library(lldbPluginInstrumentationRuntimeAddressSanitizer PLUGIN
-  AddressSanitizerRuntime.cpp
+add_lldb_library(lldbPluginInstrumentationRuntimeASan PLUGIN
+  ASanRuntime.cpp
 
   LINK_LIBS
     lldbBreakpoint
     lldbCore
     lldbExpression
     lldbInterpreter
     lldbSymbol
     lldbTarget
   LINK_COMPONENTS
     Support
   )

source/Plugins/InstrumentationRuntime/CMakeLists.txt

-add_subdirectory(AddressSanitizer)
-add_subdirectory(ThreadSanitizer)
-add_subdirectory(UndefinedBehaviorSanitizer)
+add_subdirectory(ASan)
 add_subdirectory(MainThreadChecker)
+add_subdirectory(TSan)
+add_subdirectory(UBSan)

source/Plugins/InstrumentationRuntime/TSan/CMakeLists.txt

-add_lldb_library(lldbPluginInstrumentationRuntimeThreadSanitizer PLUGIN
-  ThreadSanitizerRuntime.cpp
+add_lldb_library(lldbPluginInstrumentationRuntimeTSan PLUGIN
+  TSanRuntime.cpp
 
   LINK_LIBS
     lldbBreakpoint
     lldbCore
     lldbExpression
     lldbInterpreter
     lldbSymbol
     lldbTarget
     lldbPluginProcessUtility
   )

source/Plugins/InstrumentationRuntime/TSan/TSanRuntime.h

 //===-- ThreadSanitizerRuntime.h --------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef liblldb_ThreadSanitizerRuntime_h_
 #define liblldb_ThreadSanitizerRuntime_h_
 
 // C Includes
 // C++ Includes
 // Other libraries and framework includes
 // Project includes
 #include "lldb/Core/StructuredData.h"
 #include "lldb/Target/ABI.h"
 #include "lldb/Target/InstrumentationRuntime.h"
 #include "lldb/lldb-private.h"
 
 namespace lldb_private {
 
 class ThreadSanitizerRuntime : public lldb_private::InstrumentationRuntime {
 public:
   ~ThreadSanitizerRuntime() override;
 
   static lldb::InstrumentationRuntimeSP
   CreateInstance(const lldb::ProcessSP &process_sp);
 
   static void Initialize();
 
   static void Terminate();
 
   static lldb_private::ConstString GetPluginNameStatic();
 
   static lldb::InstrumentationRuntimeType GetTypeStatic();
 
   lldb_private::ConstString GetPluginName() override {
     return GetPluginNameStatic();
   }
 
   virtual lldb::InstrumentationRuntimeType GetType() { return GetTypeStatic(); }
 
   uint32_t GetPluginVersion() override { return 1; }
 
   lldb::ThreadCollectionSP
   GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info) override;
 
 private:
   ThreadSanitizerRuntime(const lldb::ProcessSP &process_sp)
       : lldb_private::InstrumentationRuntime(process_sp) {}
 
   const RegularExpression &GetPatternForRuntimeLibrary() override;
 
   bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;
 
   void Activate() override;
 
   void Deactivate();
 
   static bool NotifyBreakpointHit(void *baton,
                                   StoppointCallbackContext *context,
                                   lldb::user_id_t break_id,
                                   lldb::user_id_t break_loc_id);
 
   StructuredData::ObjectSP RetrieveReportData(ExecutionContextRef exe_ctx_ref);
 
   std::string FormatDescription(StructuredData::ObjectSP report);
 
   std::string GenerateSummary(StructuredData::ObjectSP report);
 
   lldb::addr_t GetMainRacyAddress(StructuredData::ObjectSP report);
 
   std::string GetLocationDescription(StructuredData::ObjectSP report,
                                      lldb::addr_t &global_addr,
                                      std::string &global_name,
                                      std::string &filename, uint32_t &line);
 
   lldb::addr_t GetFirstNonInternalFramePc(StructuredData::ObjectSP trace,
                                           bool skip_one_frame = false);
 };
 
 } // namespace lldb_private
 
 #endif // liblldb_ThreadSanitizerRuntime_h_

source/Plugins/InstrumentationRuntime/TSan/TSanRuntime.cpp

-//===-- ThreadSanitizerRuntime.cpp ------------------------------*- C++ -*-===//
+//===-- TSanRuntime.cpp -----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#include "ThreadSanitizerRuntime.h"
+#include "TSanRuntime.h"
 
 #include "Plugins/Process/Utility/HistoryThread.h"
 #include "lldb/Breakpoint/StoppointCallbackContext.h"
 #include "lldb/Core/Debugger.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Core/PluginInterface.h"
 #include "lldb/Core/PluginManager.h"
 #include "lldb/Core/StreamFile.h"

source/Plugins/InstrumentationRuntime/UBSan/CMakeLists.txt

-add_lldb_library(lldbPluginInstrumentationRuntimeUndefinedBehaviorSanitizer PLUGIN
-  UndefinedBehaviorSanitizerRuntime.cpp
+add_lldb_library(lldbPluginInstrumentationRuntimeUBSan PLUGIN
+  UBSanRuntime.cpp
 
   LINK_LIBS
     lldbBreakpoint
     lldbCore
     lldbExpression
     lldbInterpreter
     lldbSymbol
     lldbTarget
   LINK_COMPONENTS
     Support
   )

source/Plugins/InstrumentationRuntime/UBSan/UBSanRuntime.h

 //===-- UndefinedBehaviorSanitizerRuntime.h ---------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef liblldb_UndefinedBehaviorSanitizerRuntime_h_
 #define liblldb_UndefinedBehaviorSanitizerRuntime_h_
 
 #include "lldb/Core/StructuredData.h"
 #include "lldb/Target/ABI.h"
 #include "lldb/Target/InstrumentationRuntime.h"
 #include "lldb/lldb-private.h"
 
 namespace lldb_private {
 
 class UndefinedBehaviorSanitizerRuntime
     : public lldb_private::InstrumentationRuntime {
 public:
   ~UndefinedBehaviorSanitizerRuntime() override;
 
   static lldb::InstrumentationRuntimeSP
   CreateInstance(const lldb::ProcessSP &process_sp);
 
   static void Initialize();
 
   static void Terminate();
 
   static lldb_private::ConstString GetPluginNameStatic();
 
   static lldb::InstrumentationRuntimeType GetTypeStatic();
 
   lldb_private::ConstString GetPluginName() override {
     return GetPluginNameStatic();
   }
 
   virtual lldb::InstrumentationRuntimeType GetType() { return GetTypeStatic(); }
 
   uint32_t GetPluginVersion() override { return 1; }
 
   lldb::ThreadCollectionSP
   GetBacktracesFromExtendedStopInfo(StructuredData::ObjectSP info) override;
 
 private:
   UndefinedBehaviorSanitizerRuntime(const lldb::ProcessSP &process_sp)
       : lldb_private::InstrumentationRuntime(process_sp) {}
 
   const RegularExpression &GetPatternForRuntimeLibrary() override;
 
   bool CheckIfRuntimeIsValid(const lldb::ModuleSP module_sp) override;
 
   void Activate() override;
 
   void Deactivate();
 
   static bool NotifyBreakpointHit(void *baton,
                                   StoppointCallbackContext *context,
                                   lldb::user_id_t break_id,
                                   lldb::user_id_t break_loc_id);
 
   StructuredData::ObjectSP RetrieveReportData(ExecutionContextRef exe_ctx_ref);
 };
 
 } // namespace lldb_private
 
 #endif // liblldb_UndefinedBehaviorSanitizerRuntime_h_

source/Plugins/InstrumentationRuntime/UBSan/UBSanRuntime.cpp

-//===-- UndefinedBehaviorSanitizerRuntime.cpp -------------------*- C++ -*-===//
+//===-- UBSanRuntime.cpp ----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
-#include "UndefinedBehaviorSanitizerRuntime.h"
+#include "UBSanRuntime.h"
 
 #include "Plugins/Process/Utility/HistoryThread.h"
 #include "lldb/Breakpoint/StoppointCallbackContext.h"
 #include "lldb/Core/Debugger.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Core/PluginInterface.h"
 #include "lldb/Core/PluginManager.h"
 #include "lldb/Core/StreamFile.h"