Move SafeMachO from Utility to Host

[labath]

Summary

One of the conclusions of the discussion on D49740 was that SafeMachO is better
off in the Host module (as that's the only place which should include
mach/machine.h, which is what this header is working around). Also, Utility,
which is the only module which cannot include Host, should not be doing
anything with object file formats.

This patch implements that move, and also removes any unneded includes of that
file.

I've verified that MacOS still compiles after this.

[teemperor]

Please add the header also to the modulemap in Host (which has to be manually written, as the Host module contains a lot of OS-specific headers):
module SafeMachO { header "Host/SafeMachO.h" export * }

[labath]

Add the file to module map.

[teemperor]

LGTM, thanks!

include/lldb/Host/SafeMachO.h

 //===-- SafeMachO.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_SafeMachO_h_
 #define liblldb_SafeMachO_h_
 
 // This header file is required to work around collisions between the defines
 // in mach/machine.h, and enum members of the same name in llvm's MachO.h.  If
 // you want to use llvm/Support/MachO.h, use this file instead. The caveats
 // are: 1) You can only use the MachO.h enums, you can't use the defines.  That
 // won't make a difference since the values
 //    are the same.
 // 2) If you need any header file that relies on mach/machine.h, you must
 // include that first. 3) This isn't a total solution, it doesn't undef every
 // define that MachO.h has borrowed from various system headers,
 //    only the ones that come from mach/machine.h because that is the one we
 //    ended up pulling in from various places.
 //
 
 #undef CPU_ARCH_MASK
 #undef CPU_ARCH_ABI64
 
 #undef CPU_TYPE_ANY
 #undef CPU_TYPE_X86
 #undef CPU_TYPE_I386
 #undef CPU_TYPE_X86_64
 #undef CPU_TYPE_MC98000
 #undef CPU_TYPE_ARM
 #undef CPU_TYPE_ARM64
 #undef CPU_TYPE_SPARC
 #undef CPU_TYPE_POWERPC
 #undef CPU_TYPE_POWERPC64
 
 #undef CPU_SUB_TYPE_MASK
 #undef CPU_SUB_TYPE_LIB64
 
 #undef CPU_SUBTYPE_MULTIPLE
 
 #undef CPU_SUBTYPE_I386_ALL
 #undef CPU_SUBTYPE_386
 #undef CPU_SUBTYPE_486
 #undef CPU_SUBTYPE_486SX
 #undef CPU_SUBTYPE_586
 #undef CPU_SUBTYPE_PENT
 #undef CPU_SUBTYPE_PENTPRO
 #undef CPU_SUBTYPE_PENTII_M3
 #undef CPU_SUBTYPE_PENTII_M5
 #undef CPU_SUBTYPE_CELERON
 #undef CPU_SUBTYPE_CELERON_MOBILE
 #undef CPU_SUBTYPE_PENTIUM_3
 #undef CPU_SUBTYPE_PENTIUM_3_M
 #undef CPU_SUBTYPE_PENTIUM_3_XEON
 #undef CPU_SUBTYPE_PENTIUM_M
 #undef CPU_SUBTYPE_PENTIUM_4
 #undef CPU_SUBTYPE_PENTIUM_4_M
 #undef CPU_SUBTYPE_ITANIUM
 #undef CPU_SUBTYPE_ITANIUM_2
 #undef CPU_SUBTYPE_XEON
 #undef CPU_SUBTYPE_XEON_MP
 
 #undef CPU_SUBTYPE_X86_ALL
 #undef CPU_SUBTYPE_X86_64_ALL
 #undef CPU_SUBTYPE_X86_ARCH1
 #undef CPU_SUBTYPE_X86_64_H
 
 #undef CPU_SUBTYPE_INTEL
 #undef CPU_SUBTYPE_INTEL_FAMILY
 #undef CPU_SUBTYPE_INTEL_FAMILY_MAX
 #undef CPU_SUBTYPE_INTEL_MODEL
 #undef CPU_SUBTYPE_INTEL_MODEL_ALL
 
 #undef CPU_SUBTYPE_ARM
 #undef CPU_SUBTYPE_ARM_ALL
 #undef CPU_SUBTYPE_ARM_V4T
 #undef CPU_SUBTYPE_ARM_V6
 #undef CPU_SUBTYPE_ARM_V5
 #undef CPU_SUBTYPE_ARM_V5TEJ
 #undef CPU_SUBTYPE_ARM_XSCALE
 #undef CPU_SUBTYPE_ARM_V7
 
 #undef CPU_SUBTYPE_ARM_V7S
 #undef CPU_SUBTYPE_ARM_V7K
 #undef CPU_SUBTYPE_ARM_V6M
 #undef CPU_SUBTYPE_ARM_V7M
 #undef CPU_SUBTYPE_ARM_V7EM
 
 #undef CPU_SUBTYPE_ARM64_ALL
 
 #undef CPU_SUBTYPE_SPARC_ALL
 
 #undef CPU_SUBTYPE_POWERPC
 #undef CPU_SUBTYPE_POWERPC_ALL
 #undef CPU_SUBTYPE_POWERPC_601
 #undef CPU_SUBTYPE_POWERPC_602
 #undef CPU_SUBTYPE_POWERPC_603
 #undef CPU_SUBTYPE_POWERPC_603e
 #undef CPU_SUBTYPE_POWERPC_603ev
 #undef CPU_SUBTYPE_POWERPC_604
 #undef CPU_SUBTYPE_POWERPC_604e
 #undef CPU_SUBTYPE_POWERPC_620
 #undef CPU_SUBTYPE_POWERPC_750
 #undef CPU_SUBTYPE_POWERPC_7400
 #undef CPU_SUBTYPE_POWERPC_7450
 #undef CPU_SUBTYPE_POWERPC_970
 
 #undef CPU_SUBTYPE_MC980000_ALL
 #undef CPU_SUBTYPE_MC98601
 
 #include "llvm/BinaryFormat/MachO.h"
 
 #endif // liblldb_SafeMachO_h_

include/lldb/module.modulemap

module lldb_Host {
   module MonitoringProcessLauncher { header "Host/MonitoringProcessLauncher.h" export * }
   module OptionParser { header "Host/OptionParser.h" export * }
   module PipeBase { header "Host/PipeBase.h" export * }
   module Pipe { header "Host/Pipe.h" export * }
   module PosixApi { header "Host/PosixApi.h" export * }
   module ProcessLauncher { header "Host/ProcessLauncher.h" export * }
   module ProcessRunLock { header "Host/ProcessRunLock.h" export * }
   module PseudoTerminal { header "Host/PseudoTerminal.h" export * }
+  module SafeMachO { header "Host/SafeMachO.h" export * }
   module SocketAddress { header "Host/SocketAddress.h" export * }
   module Socket { header "Host/Socket.h" export * }
   module StringConvert { header "Host/StringConvert.h" export * }
   module Symbols { header "Host/Symbols.h" export * }
   module TaskPool { header "Host/TaskPool.h" export * }
   module Terminal { header "Host/Terminal.h" export * }
   module ThreadLauncher { header "Host/ThreadLauncher.h" export * }
   module Time { header "Host/Time.h" export * }

source/Host/common/Symbols.cpp

 #include "lldb/Core/ModuleSpec.h"
 #include "lldb/Host/FileSystem.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Target/Target.h"
 #include "lldb/Utility/ArchSpec.h"
 #include "lldb/Utility/DataBuffer.h"
 #include "lldb/Utility/DataExtractor.h"
 #include "lldb/Utility/Log.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/StreamString.h"
 #include "lldb/Utility/Timer.h"
 #include "lldb/Utility/UUID.h"
 
 #include "llvm/Support/FileSystem.h"
 
 // From MacOSX system header "mach/machine.h"
 typedef int cpu_type_t;
 typedef int cpu_subtype_t;
 
 using namespace lldb;
 using namespace lldb_private;
-using namespace llvm::MachO;
 
 #if defined(__APPLE__)
 
 // Forward declaration of method defined in source/Host/macosx/Symbols.cpp
 int LocateMacOSXFilesUsingDebugSymbols(const ModuleSpec &module_spec,
                                        ModuleSpec &return_module_spec);
 
 #else

source/Host/macosx/Symbols.cpp

 //===-- Symbols.cpp ---------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "lldb/Host/Symbols.h"
 
 // C Includes
-#include "lldb/Utility/SafeMachO.h"
 #include <dirent.h>
 #include <pwd.h>
 
 // C++ Includes
 // Other libraries and framework includes
 #include <CoreFoundation/CoreFoundation.h>
 
 // Project includes

 #include "lldb/Utility/Timer.h"
 #include "lldb/Utility/UUID.h"
 #include "mach/machine.h"
 
 #include "llvm/Support/FileSystem.h"
 
 using namespace lldb;
 using namespace lldb_private;
-using namespace llvm::MachO;
 
 #if !defined(__arm__) && !defined(__arm64__) &&                                \
     !defined(__aarch64__) // No DebugSymbols on the iOS devices
 extern "C" {
 
 CFURLRef DBGCopyFullDSYMURLForUUID(CFUUIDRef uuid, CFURLRef exec_url);
 CFDictionaryRef DBGCopyDSYMPropertyLists(CFURLRef dsym_url);
 }

source/Host/macosx/objcxx/HostInfoMacOSX.mm

 //===-- HostInfoMacOSX.mm ---------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "lldb/Host/HostInfo.h"
 #include "lldb/Host/macosx/HostInfoMacOSX.h"
 #include "lldb/Utility/Args.h"
 #include "lldb/Utility/Log.h"
-#include "lldb/Utility/SafeMachO.h"
 
 #include "llvm/ADT/SmallString.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/raw_ostream.h"
 
 // C++ Includes
 #include <string>

source/Plugins/DynamicLoader/Darwin-Kernel/DynamicLoaderDarwinKernel.h

 // C Includes
 // C++ Includes
 #include <mutex>
 #include <string>
 #include <vector>
 
 // Other libraries and framework includes
 
-#include "lldb/Utility/SafeMachO.h"
+#include "lldb/Host/SafeMachO.h"
 
 // Project includes
 #include "lldb/Target/DynamicLoader.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Utility/FileSpec.h"
 #include "lldb/Utility/UUID.h"
 
 class DynamicLoaderDarwinKernel : public lldb_private::DynamicLoader {

source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderDarwin.h

 // C Includes
 // C++ Includes
 #include <map>
 #include <mutex>
 #include <vector>
 
 // Other libraries and framework includes
 // Project includes
+#include "lldb/Host/SafeMachO.h"
 #include "lldb/Target/DynamicLoader.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Utility/FileSpec.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/StructuredData.h"
 #include "lldb/Utility/UUID.h"
 
 #include "llvm/ADT/Triple.h"
 
 namespace lldb_private {
 
 class DynamicLoaderDarwin : public lldb_private::DynamicLoader {

source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOS.h

 #include <mutex>
 #include <vector>
 
 // Other libraries and framework includes
 // Project includes
 #include "lldb/Target/DynamicLoader.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Utility/FileSpec.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/StructuredData.h"
 #include "lldb/Utility/UUID.h"
 
 #include "DynamicLoaderDarwin.h"
 
 class DynamicLoaderMacOS : public lldb_private::DynamicLoaderDarwin {
 public:
   DynamicLoaderMacOS(lldb_private::Process *process);

source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOSXDYLD.h

 
 // C Includes
 // C++ Includes
 #include <mutex>
 #include <vector>
 
 // Other libraries and framework includes
 // Project includes
+#include "lldb/Host/SafeMachO.h"
 #include "lldb/Target/DynamicLoader.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Utility/FileSpec.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/StructuredData.h"
 #include "lldb/Utility/UUID.h"
 
 #include "DynamicLoaderDarwin.h"
 
 class DynamicLoaderMacOSXDYLD : public lldb_private::DynamicLoaderDarwin {
 public:
   DynamicLoaderMacOSXDYLD(lldb_private::Process *process);

source/Plugins/ObjectContainer/Universal-Mach-O/ObjectContainerUniversalMachO.h

 //===-- ObjectContainerUniversalMachO.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_ObjectContainerUniversalMachO_h_
 #define liblldb_ObjectContainerUniversalMachO_h_
 
 // C Includes
 // C++ Includes
 // Other libraries and framework includes
 // Project includes
+#include "lldb/Host/SafeMachO.h"
 #include "lldb/Symbol/ObjectContainer.h"
 #include "lldb/Utility/FileSpec.h"
-#include "lldb/Utility/SafeMachO.h"
 
 class ObjectContainerUniversalMachO : public lldb_private::ObjectContainer {
 public:
   ObjectContainerUniversalMachO(const lldb::ModuleSP &module_sp,
                                 lldb::DataBufferSP &data_sp,
                                 lldb::offset_t data_offset,
                                 const lldb_private::FileSpec *file,
                                 lldb::offset_t offset, lldb::offset_t length);

source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.h

 
 // C Includes
 // C++ Includes
 // Other libraries and framework includes
 // Project includes
 #include "lldb/Core/Address.h"
 #include "lldb/Core/FileSpecList.h"
 #include "lldb/Core/RangeMap.h"
+#include "lldb/Host/SafeMachO.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Utility/FileSpec.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/UUID.h"
 
 //----------------------------------------------------------------------
 // This class needs to be hidden as eventually belongs in a plugin that
 // will export the ObjectFile protocol
 //----------------------------------------------------------------------
 class ObjectFileMachO : public lldb_private::ObjectFile {
 public:

source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.cpp

 #include "lldb/Utility/FileSpec.h"
 #include "lldb/Utility/Log.h"
 #include "lldb/Utility/RegisterValue.h"
 #include "lldb/Utility/Status.h"
 #include "lldb/Utility/StreamString.h"
 #include "lldb/Utility/Timer.h"
 #include "lldb/Utility/UUID.h"
 
-#include "lldb/Utility/SafeMachO.h"
+#include "lldb/Host/SafeMachO.h"
 
 #include "llvm/Support/MemoryBuffer.h"
 
 #include "ObjectFileMachO.h"
 
 #if defined(__APPLE__) &&                                                      \
     (defined(__arm__) || defined(__arm64__) || defined(__aarch64__))
 // GetLLDBSharedCacheUUID() needs to call dlsym()

source/Plugins/Process/MacOSX-Kernel/ThreadKDP.cpp

 //===-- ThreadKDP.cpp -------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "ThreadKDP.h"
 
-#include "lldb/Utility/SafeMachO.h"
+#include "lldb/Host/SafeMachO.h"
 
 #include "lldb/Breakpoint/Watchpoint.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Target/RegisterContext.h"
 #include "lldb/Target/StopInfo.h"
 #include "lldb/Target/Target.h"
 #include "lldb/Target/Unwind.h"
 #include "lldb/Utility/ArchSpec.h"

source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.cpp

 
 // Other libraries and framework includes
 #include "lldb/Core/ModuleSpec.h"
 #include "lldb/Host/Config.h"
 #include "lldb/Host/File.h"
 #include "lldb/Host/FileSystem.h"
 #include "lldb/Host/Host.h"
 #include "lldb/Host/HostInfo.h"
+#include "lldb/Host/SafeMachO.h"
 #include "lldb/Interpreter/OptionArgParser.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Target/FileAction.h"
 #include "lldb/Target/Platform.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Utility/Endian.h"
 #include "lldb/Utility/JSON.h"
 #include "lldb/Utility/Log.h"
-#include "lldb/Utility/SafeMachO.h"
 #include "lldb/Utility/StreamGDBRemote.h"
 #include "lldb/Utility/StreamString.h"
 #include "llvm/ADT/Triple.h"
 
 // Project includes
 #include "ProcessGDBRemoteLog.h"
 #include "lldb/Utility/StringExtractorGDBRemote.h"
 

source/Plugins/Process/mach-core/ProcessMachCore.cpp

 #include "lldb/Utility/State.h"
 
 // Project includes
 #include "ProcessMachCore.h"
 #include "Plugins/Process/Utility/StopInfoMachException.h"
 #include "ThreadMachCore.h"
 
 // Needed for the plug-in names for the dynamic loaders.
-#include "lldb/Utility/SafeMachO.h"
+#include "lldb/Host/SafeMachO.h"
 
 #include "Plugins/DynamicLoader/Darwin-Kernel/DynamicLoaderDarwinKernel.h"
 #include "Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOSXDYLD.h"
 #include "Plugins/ObjectFile/Mach-O/ObjectFileMachO.h"
 
 using namespace lldb;
 using namespace lldb_private;
 

source/Plugins/Process/mach-core/ThreadMachCore.cpp

 //===-- ThreadMachCore.cpp --------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "ThreadMachCore.h"
 
-#include "lldb/Utility/SafeMachO.h"
-
 #include "lldb/Breakpoint/Watchpoint.h"
 #include "lldb/Symbol/ObjectFile.h"
 #include "lldb/Target/Process.h"
 #include "lldb/Target/RegisterContext.h"
 #include "lldb/Target/StopInfo.h"
 #include "lldb/Target/Target.h"
 #include "lldb/Target/Unwind.h"
 #include "lldb/Utility/ArchSpec.h"