1 //===-- ObjectContainerBSDArchive.h -----------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLDB_SOURCE_PLUGINS_OBJECTCONTAINER_BSD_ARCHIVE_OBJECTCONTAINERBSDARCHIVE_H 10 #define LLDB_SOURCE_PLUGINS_OBJECTCONTAINER_BSD_ARCHIVE_OBJECTCONTAINERBSDARCHIVE_H 11 12 #include "lldb/Core/UniqueCStringMap.h" 13 #include "lldb/Symbol/ObjectContainer.h" 14 #include "lldb/Utility/ArchSpec.h" 15 #include "lldb/Utility/ConstString.h" 16 #include "lldb/Utility/FileSpec.h" 17 18 #include "llvm/Support/Chrono.h" 19 20 #include <map> 21 #include <memory> 22 #include <mutex> 23 24 class ObjectContainerBSDArchive : public lldb_private::ObjectContainer { 25 public: 26 ObjectContainerBSDArchive(const lldb::ModuleSP &module_sp, 27 lldb::DataBufferSP &data_sp, 28 lldb::offset_t data_offset, 29 const lldb_private::FileSpec *file, 30 lldb::offset_t offset, lldb::offset_t length); 31 32 ~ObjectContainerBSDArchive() override; 33 34 // Static Functions 35 static void Initialize(); 36 37 static void Terminate(); 38 39 static llvm::StringRef GetPluginNameStatic() { return "bsd-archive"; } 40 41 static llvm::StringRef GetPluginDescriptionStatic() { 42 return "BSD Archive object container reader."; 43 } 44 45 static lldb_private::ObjectContainer * 46 CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp, 47 lldb::offset_t data_offset, const lldb_private::FileSpec *file, 48 lldb::offset_t offset, lldb::offset_t length); 49 50 static size_t GetModuleSpecifications(const lldb_private::FileSpec &file, 51 lldb::DataBufferSP &data_sp, 52 lldb::offset_t data_offset, 53 lldb::offset_t file_offset, 54 lldb::offset_t length, 55 lldb_private::ModuleSpecList &specs); 56 57 static bool MagicBytesMatch(const lldb_private::DataExtractor &data); 58 59 // Member Functions 60 bool ParseHeader() override; 61 62 size_t GetNumObjects() const override { 63 if (m_archive_sp) 64 return m_archive_sp->GetNumObjects(); 65 return 0; 66 } 67 68 void Dump(lldb_private::Stream *s) const override; 69 70 lldb::ObjectFileSP GetObjectFile(const lldb_private::FileSpec *file) override; 71 72 // PluginInterface protocol 73 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 74 75 protected: 76 struct Object { 77 Object(); 78 79 void Clear(); 80 81 lldb::offset_t Extract(const lldb_private::DataExtractor &data, 82 lldb::offset_t offset); 83 /// Object name in the archive. 84 lldb_private::ConstString ar_name; 85 86 /// Object modification time in the archive. 87 uint32_t modification_time = 0; 88 89 /// Object user id in the archive. 90 uint16_t uid = 0; 91 92 /// Object group id in the archive. 93 uint16_t gid = 0; 94 95 /// Object octal file permissions in the archive. 96 uint16_t mode = 0; 97 98 /// Object size in bytes in the archive. 99 uint32_t size = 0; 100 101 /// File offset in bytes from the beginning of the file of the object data. 102 lldb::offset_t file_offset = 0; 103 104 /// Length of the object data. 105 lldb::offset_t file_size = 0; 106 }; 107 108 class Archive { 109 public: 110 typedef std::shared_ptr<Archive> shared_ptr; 111 typedef std::multimap<lldb_private::FileSpec, shared_ptr> Map; 112 113 Archive(const lldb_private::ArchSpec &arch, 114 const llvm::sys::TimePoint<> &mod_time, lldb::offset_t file_offset, 115 lldb_private::DataExtractor &data); 116 117 ~Archive(); 118 119 static Map &GetArchiveCache(); 120 121 static std::recursive_mutex &GetArchiveCacheMutex(); 122 123 static Archive::shared_ptr FindCachedArchive( 124 const lldb_private::FileSpec &file, const lldb_private::ArchSpec &arch, 125 const llvm::sys::TimePoint<> &mod_time, lldb::offset_t file_offset); 126 127 static Archive::shared_ptr ParseAndCacheArchiveForFile( 128 const lldb_private::FileSpec &file, const lldb_private::ArchSpec &arch, 129 const llvm::sys::TimePoint<> &mod_time, lldb::offset_t file_offset, 130 lldb_private::DataExtractor &data); 131 132 size_t GetNumObjects() const { return m_objects.size(); } 133 134 const Object *GetObjectAtIndex(size_t idx) { 135 if (idx < m_objects.size()) 136 return &m_objects[idx]; 137 return nullptr; 138 } 139 140 size_t ParseObjects(); 141 142 Object *FindObject(lldb_private::ConstString object_name, 143 const llvm::sys::TimePoint<> &object_mod_time); 144 145 lldb::offset_t GetFileOffset() const { return m_file_offset; } 146 147 const llvm::sys::TimePoint<> &GetModificationTime() { 148 return m_modification_time; 149 } 150 151 const lldb_private::ArchSpec &GetArchitecture() const { return m_arch; } 152 153 void SetArchitecture(const lldb_private::ArchSpec &arch) { m_arch = arch; } 154 155 bool HasNoExternalReferences() const; 156 157 lldb_private::DataExtractor &GetData() { return m_data; } 158 159 protected: 160 typedef lldb_private::UniqueCStringMap<uint32_t> ObjectNameToIndexMap; 161 // Member Variables 162 lldb_private::ArchSpec m_arch; 163 llvm::sys::TimePoint<> m_modification_time; 164 lldb::offset_t m_file_offset; 165 std::vector<Object> m_objects; 166 ObjectNameToIndexMap m_object_name_to_index_map; 167 lldb_private::DataExtractor m_data; ///< The data for this object container 168 ///so we don't lose data if the .a files 169 ///gets modified 170 }; 171 172 void SetArchive(Archive::shared_ptr &archive_sp); 173 174 Archive::shared_ptr m_archive_sp; 175 }; 176 177 #endif // LLDB_SOURCE_PLUGINS_OBJECTCONTAINER_BSD_ARCHIVE_OBJECTCONTAINERBSDARCHIVE_H 178