[lldb] Clean up uses of UuidCompatibility.h

[bulbazord]

Summary

This commit does a few related things:

• Removes unused function uuid_is_null
• Removes unneeded includes of UuidCompatibility.h
• Renames UuidCompatibility to AppleUuidCompatibility and adds a comment to clarify intent of header.
• Moves AppleUuidCompatibility to the include directory

[mib]

lldb/include/lldb/Utility/AppleUuidCompatibility.h

15–16

May be this could be moved to lldb-types.h (if it's even used) so we can remove the whole file ?

[bulbazord]

lldb/include/lldb/Utility/AppleUuidCompatibility.h

15–16

I thought about this but I went with this as a safer option. I'm not sure what definition of uuid_t other platforms provide (hopefully the same but I haven't verified). We really only use this definition in two places: ObjectFileMachO and DynamicLoaderMacOSXDYLD. In those places, we just need a compatible definition of uuid_t. Putting it in lldb-types.h would mean we would get that definition everywhere (even if it was already provided by the underlying system, excluding Darwin).

[jasonmolenda]

This is fine to me but maybe instead of ifndef apple we could do a if __has_include(<uuid/uuid.h>) and include the system header if it's avail. I must be misreading the patch but it seems like you're changing the filename to AppleUuidCompatbility.h but the two places it's included still call it UuidCompatibility.h.

The uuid_is_null is probably my fault, I think I had something that I had a uuid_t that I didn't want to turn in to a "valid" UUID object when I assigned the bytes, and either I misunderstood the contract or I used the wrong one and once I fixed that, I didn't need the test any more.

[bulbazord]

In D156562#4543743, @jasonmolenda wrote:

This is fine to me but maybe instead of ifndef apple we could do a if __has_include(<uuid/uuid.h>) and include the system header if it's avail. I must be misreading the patch but it seems like you're changing the filename to AppleUuidCompatbility.h but the two places it's included still call it UuidCompatibility.h.

You're not reading it wrong, that was just my mistake. I built this on a Darwin machine so that codepath never ran... Good catch!

The uuid_is_null is probably my fault, I think I had something that I had a uuid_t that I didn't want to turn in to a "valid" UUID object when I assigned the bytes, and either I misunderstood the contract or I used the wrong one and once I fixed that, I didn't need the test any more.

Thanks for the context 👍

[bulbazord]

Fix incorrect includes that @jasonmolenda pointed out

[bulbazord]

In D156562#4543743, @jasonmolenda wrote:

This is fine to me but maybe instead of ifndef apple we could do a if __has_include(<uuid/uuid.h>) and include the system header if it's avail.

One reason I decided not to do this is because I don't want to accidentally pull in a different uuid.h on other platforms that may have an incompatible uuid_t definition. I'm not sure what other definition it may have that would make it incompatible, but it might be a headache to figure that out.

lldb/include/lldb/Utility/AppleUuidCompatibility.h

 //===-- UuidCompatibility.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
 //
 //===----------------------------------------------------------------------===//
 
-// Include this header if your system does not have a definition of uuid_t
+// Include this header for a definition of uuid_t compatible with Darwin's
+// definition.
 
 #ifndef utility_UUID_COMPATIBILITY_H
 #define utility_UUID_COMPATIBILITY_H
-
 // uuid_t is guaranteed to always be a 16-byte array
 typedef unsigned char uuid_t[16];
-
-// Return 1 if uuid is null, that is, all zeroes.
-inline __attribute__((always_inline)) int uuid_is_null(uuid_t uuid) {
-  for (int i = 0; i < 16; i++)
-    if (uuid[i])
-      return 0;
-  return 1;
-}
-
 #endif // utility_UUID_COMPATIBILITY_H

lldb/source/Expression/ObjectFileJIT.cpp

 #include "lldb/Utility/DataBuffer.h"
 #include "lldb/Utility/DataBufferHeap.h"
 #include "lldb/Utility/FileSpec.h"
 #include "lldb/Utility/FileSpecList.h"
 #include "lldb/Utility/Log.h"
 #include "lldb/Utility/Timer.h"
 #include "lldb/Utility/UUID.h"
 
-#ifndef __APPLE__
-#include "Utility/UuidCompatibility.h"
-#endif
-
 using namespace lldb;
 using namespace lldb_private;
 
 char ObjectFileJIT::ID;
 
 void ObjectFileJIT::Initialize() {
   PluginManager::RegisterPlugin(GetPluginNameStatic(),
                                 GetPluginDescriptionStatic(), CreateInstance,

lldb/source/Host/macosx/objcxx/HostInfoMacOSX.mm

 //===-- HostInfoMacOSX.mm ---------------------------------------*- 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 "lldb/Host/macosx/HostInfoMacOSX.h"
-#include "Utility/UuidCompatibility.h"
 #include "lldb/Host/FileSystem.h"
 #include "lldb/Host/Host.h"
 #include "lldb/Host/HostInfo.h"
 #include "lldb/Utility/Args.h"
 #include "lldb/Utility/LLDBLog.h"
 #include "lldb/Utility/Log.h"
 #include "lldb/Utility/Timer.h"
 
 #include "llvm/ADT/ScopeExit.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringMap.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/raw_ostream.h"
 
 // C++ Includes
 #include <optional>
 #include <string>
 
 // C inclues
 #include <cstdlib>
 #include <sys/sysctl.h>
 #include <sys/syslimits.h>
 #include <sys/types.h>
+#include <uuid/uuid.h>
 
 // Objective-C/C++ includes
 #include <CoreFoundation/CoreFoundation.h>
 #include <Foundation/Foundation.h>
 #include <mach-o/dyld.h>
 #if __has_include(<mach-o/dyld_introspection.h>)
 #include <mach-o/dyld_introspection.h>
 #define SDK_HAS_NEW_DYLD_INTROSPECTION_SPIS

lldb/source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderDarwin.cpp

 //#define ENABLE_DEBUG_PRINTF // COMMENT THIS LINE OUT PRIOR TO CHECKIN
 #ifdef ENABLE_DEBUG_PRINTF
 #include <cstdio>
 #define DEBUG_PRINTF(fmt, ...) printf(fmt, ##__VA_ARGS__)
 #else
 #define DEBUG_PRINTF(fmt, ...)
 #endif
 
-#ifndef __APPLE__
-#include "Utility/UuidCompatibility.h"
-#else
-#include <uuid/uuid.h>
-#endif
-
 #include <memory>
 
 using namespace lldb;
 using namespace lldb_private;
 
 // Constructor
 DynamicLoaderDarwin::DynamicLoaderDarwin(Process *process)
     : DynamicLoader(process), m_dyld_module_wp(), m_libpthread_module_wp(),

lldb/source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOSXDYLD.cpp

 #ifdef ENABLE_DEBUG_PRINTF
 #include <cstdio>
 #define DEBUG_PRINTF(fmt, ...) printf(fmt, ##__VA_ARGS__)
 #else
 #define DEBUG_PRINTF(fmt, ...)
 #endif
 
 #ifndef __APPLE__
-#include "Utility/UuidCompatibility.h"
+#include "lldb/Utility/AppleUuidCompatibility.h"
 #else
 #include <uuid/uuid.h>
 #endif
 
 using namespace lldb;
 using namespace lldb_private;
 
 LLDB_PLUGIN_DEFINE(DynamicLoaderMacOSXDYLD)

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

 // GetLLDBSharedCacheUUID() needs to call dlsym()
 #include <dlfcn.h>
 #include <mach/mach_init.h>
 #include <mach/vm_map.h>
 #include <lldb/Host/SafeMachO.h>
 #endif
 
 #ifndef __APPLE__
-#include "Utility/UuidCompatibility.h"
+#include "lldb/Utility/AppleUuidCompatibility.h"
 #else
 #include <uuid/uuid.h>
 #endif
 
 #include <bitset>
 #include <memory>
 #include <optional>