contrib/llvm/tools/lldb/source/Plugins/ObjectContainer/BSD-Archive/ObjectContainerBSDArchive.cpp

   1 //===-- ObjectContainerBSDArchive.cpp ---------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "ObjectContainerBSDArchive.h"
  11
  12 #if defined(_WIN32) || defined(__ANDROID__)
  13 // Defines from ar, missing on Windows
  14 #define ARMAG "!<arch>\n"
  15 #define SARMAG 8
  16 #define ARFMAG "`\n"
  17
  18 typedef struct ar_hdr {
  19   char ar_name[16];
  20   char ar_date[12];
  21   char ar_uid[6], ar_gid[6];
  22   char ar_mode[8];
  23   char ar_size[10];
  24   char ar_fmag[2];
  25 } ar_hdr;
  26 #else
  27 #include <ar.h>
  28 #endif
  29
  30 #include "lldb/Core/Module.h"
  31 #include "lldb/Core/ModuleSpec.h"
  32 #include "lldb/Core/PluginManager.h"
  33 #include "lldb/Host/FileSystem.h"
  34 #include "lldb/Symbol/ObjectFile.h"
  35 #include "lldb/Utility/ArchSpec.h"
  36 #include "lldb/Utility/DataBufferLLVM.h"
  37 #include "lldb/Utility/Stream.h"
  38 #include "lldb/Utility/Timer.h"
  39
  40 #include "llvm/Support/MemoryBuffer.h"
  41
  42 using namespace lldb;
  43 using namespace lldb_private;
  44
  45 ObjectContainerBSDArchive::Object::Object()
  46     : ar_name(), ar_date(0), ar_uid(0), ar_gid(0), ar_mode(0), ar_size(0),
  47       ar_file_offset(0), ar_file_size(0) {}
  48
  49 void ObjectContainerBSDArchive::Object::Clear() {
  50   ar_name.Clear();
  51   ar_date = 0;
  52   ar_uid = 0;
  53   ar_gid = 0;
  54   ar_mode = 0;
  55   ar_size = 0;
  56   ar_file_offset = 0;
  57   ar_file_size = 0;
  58 }
  59
  60 lldb::offset_t
  61 ObjectContainerBSDArchive::Object::Extract(const DataExtractor &data,
  62                                            lldb::offset_t offset) {
  63   size_t ar_name_len = 0;
  64   std::string str;
  65   char *err;
  66
  67   // File header
  68   //
  69   // The common format is as follows.
  70   //
  71   //  Offset  Length    Name            Format
  72   //  0       16      File name       ASCII right padded with spaces (no spaces
  73   //  allowed in file name)
  74   //  16      12      File mod        Decimal as cstring right padded with
  75   //  spaces
  76   //  28      6       Owner ID        Decimal as cstring right padded with
  77   //  spaces
  78   //  34      6       Group ID        Decimal as cstring right padded with
  79   //  spaces
  80   //  40      8       File mode       Octal   as cstring right padded with
  81   //  spaces
  82   //  48      10      File byte size  Decimal as cstring right padded with
  83   //  spaces
  84   //  58      2       File magic      0x60 0x0A
  85
  86   // Make sure there is enough data for the file header and bail if not
  87   if (!data.ValidOffsetForDataOfSize(offset, 60))
  88     return LLDB_INVALID_OFFSET;
  89
  90   str.assign((const char *)data.GetData(&offset, 16), 16);
  91   if (str.find("#1/") == 0) {
  92     // If the name is longer than 16 bytes, or contains an embedded space then
  93     // it will use this format where the length of the name is here and the
  94     // name characters are after this header.
  95     ar_name_len = strtoul(str.c_str() + 3, &err, 10);
  96   } else {
  97     // Strip off any trailing spaces.
  98     const size_t last_pos = str.find_last_not_of(' ');
  99     if (last_pos != std::string::npos) {
 100       if (last_pos + 1 < 16)
 101         str.erase(last_pos + 1);
 102     }
 103     ar_name.SetCString(str.c_str());
 104   }
 105
 106   str.assign((const char *)data.GetData(&offset, 12), 12);
 107   ar_date = strtoul(str.c_str(), &err, 10);
 108
 109   str.assign((const char *)data.GetData(&offset, 6), 6);
 110   ar_uid = strtoul(str.c_str(), &err, 10);
 111
 112   str.assign((const char *)data.GetData(&offset, 6), 6);
 113   ar_gid = strtoul(str.c_str(), &err, 10);
 114
 115   str.assign((const char *)data.GetData(&offset, 8), 8);
 116   ar_mode = strtoul(str.c_str(), &err, 8);
 117
 118   str.assign((const char *)data.GetData(&offset, 10), 10);
 119   ar_size = strtoul(str.c_str(), &err, 10);
 120
 121   str.assign((const char *)data.GetData(&offset, 2), 2);
 122   if (str == ARFMAG) {
 123     if (ar_name_len > 0) {
 124       const void *ar_name_ptr = data.GetData(&offset, ar_name_len);
 125       // Make sure there was enough data for the string value and bail if not
 126       if (ar_name_ptr == NULL)
 127         return LLDB_INVALID_OFFSET;
 128       str.assign((const char *)ar_name_ptr, ar_name_len);
 129       ar_name.SetCString(str.c_str());
 130     }
 131     ar_file_offset = offset;
 132     ar_file_size = ar_size - ar_name_len;
 133     return offset;
 134   }
 135   return LLDB_INVALID_OFFSET;
 136 }
 137
 138 ObjectContainerBSDArchive::Archive::Archive(const lldb_private::ArchSpec &arch,
 139                                             const llvm::sys::TimePoint<> &time,
 140                                             lldb::offset_t file_offset,
 141                                             lldb_private::DataExtractor &data)
 142     : m_arch(arch), m_time(time), m_file_offset(file_offset), m_objects(),
 143       m_data(data) {}
 144
 145 ObjectContainerBSDArchive::Archive::~Archive() {}
 146
 147 size_t ObjectContainerBSDArchive::Archive::ParseObjects() {
 148   DataExtractor &data = m_data;
 149   std::string str;
 150   lldb::offset_t offset = 0;
 151   str.assign((const char *)data.GetData(&offset, SARMAG), SARMAG);
 152   if (str == ARMAG) {
 153     Object obj;
 154     do {
 155       offset = obj.Extract(data, offset);
 156       if (offset == LLDB_INVALID_OFFSET)
 157         break;
 158       size_t obj_idx = m_objects.size();
 159       m_objects.push_back(obj);
 160       // Insert all of the C strings out of order for now...
 161       m_object_name_to_index_map.Append(obj.ar_name, obj_idx);
 162       offset += obj.ar_file_size;
 163       obj.Clear();
 164     } while (data.ValidOffset(offset));
 165
 166     // Now sort all of the object name pointers
 167     m_object_name_to_index_map.Sort();
 168   }
 169   return m_objects.size();
 170 }
 171
 172 ObjectContainerBSDArchive::Object *
 173 ObjectContainerBSDArchive::Archive::FindObject(
 174     const ConstString &object_name,
 175     const llvm::sys::TimePoint<> &object_mod_time) {
 176   const ObjectNameToIndexMap::Entry *match =
 177       m_object_name_to_index_map.FindFirstValueForName(object_name);
 178   if (match) {
 179     if (object_mod_time != llvm::sys::TimePoint<>()) {
 180       const uint64_t object_date = llvm::sys::toTimeT(object_mod_time);
 181       if (m_objects[match->value].ar_date == object_date)
 182         return &m_objects[match->value];
 183       const ObjectNameToIndexMap::Entry *next_match =
 184           m_object_name_to_index_map.FindNextValueForName(match);
 185       while (next_match) {
 186         if (m_objects[next_match->value].ar_date == object_date)
 187           return &m_objects[next_match->value];
 188         next_match =
 189             m_object_name_to_index_map.FindNextValueForName(next_match);
 190       }
 191     } else {
 192       return &m_objects[match->value];
 193     }
 194   }
 195   return NULL;
 196 }
 197
 198 ObjectContainerBSDArchive::Archive::shared_ptr
 199 ObjectContainerBSDArchive::Archive::FindCachedArchive(
 200     const FileSpec &file, const ArchSpec &arch,
 201     const llvm::sys::TimePoint<> &time, lldb::offset_t file_offset) {
 202   std::lock_guard<std::recursive_mutex> guard(Archive::GetArchiveCacheMutex());
 203   shared_ptr archive_sp;
 204   Archive::Map &archive_map = Archive::GetArchiveCache();
 205   Archive::Map::iterator pos = archive_map.find(file);
 206   // Don't cache a value for "archive_map.end()" below since we might delete an
 207   // archive entry...
 208   while (pos != archive_map.end() && pos->first == file) {
 209     bool match = true;
 210     if (arch.IsValid() &&
 211         pos->second->GetArchitecture().IsCompatibleMatch(arch) == false)
 212       match = false;
 213     else if (file_offset != LLDB_INVALID_OFFSET &&
 214              pos->second->GetFileOffset() != file_offset)
 215       match = false;
 216     if (match) {
 217       if (pos->second->GetModificationTime() == time) {
 218         return pos->second;
 219       } else {
 220         // We have a file at the same path with the same architecture whose
 221         // modification time doesn't match. It doesn't make sense for us to
 222         // continue to use this BSD archive since we cache only the object info
 223         // which consists of file time info and also the file offset and file
 224         // size of any contained objects. Since this information is now out of
 225         // date, we won't get the correct information if we go and extract the
 226         // file data, so we should remove the old and outdated entry.
 227         archive_map.erase(pos);
 228         pos = archive_map.find(file);
 229         continue; // Continue to next iteration so we don't increment pos
 230                   // below...
 231       }
 232     }
 233     ++pos;
 234   }
 235   return archive_sp;
 236 }
 237
 238 ObjectContainerBSDArchive::Archive::shared_ptr
 239 ObjectContainerBSDArchive::Archive::ParseAndCacheArchiveForFile(
 240     const FileSpec &file, const ArchSpec &arch,
 241     const llvm::sys::TimePoint<> &time, lldb::offset_t file_offset,
 242     DataExtractor &data) {
 243   shared_ptr archive_sp(new Archive(arch, time, file_offset, data));
 244   if (archive_sp) {
 245     const size_t num_objects = archive_sp->ParseObjects();
 246     if (num_objects > 0) {
 247       std::lock_guard<std::recursive_mutex> guard(
 248           Archive::GetArchiveCacheMutex());
 249       Archive::GetArchiveCache().insert(std::make_pair(file, archive_sp));
 250     } else {
 251       archive_sp.reset();
 252     }
 253   }
 254   return archive_sp;
 255 }
 256
 257 ObjectContainerBSDArchive::Archive::Map &
 258 ObjectContainerBSDArchive::Archive::GetArchiveCache() {
 259   static Archive::Map g_archive_map;
 260   return g_archive_map;
 261 }
 262
 263 std::recursive_mutex &
 264 ObjectContainerBSDArchive::Archive::GetArchiveCacheMutex() {
 265   static std::recursive_mutex g_archive_map_mutex;
 266   return g_archive_map_mutex;
 267 }
 268
 269 void ObjectContainerBSDArchive::Initialize() {
 270   PluginManager::RegisterPlugin(GetPluginNameStatic(),
 271                                 GetPluginDescriptionStatic(), CreateInstance,
 272                                 GetModuleSpecifications);
 273 }
 274
 275 void ObjectContainerBSDArchive::Terminate() {
 276   PluginManager::UnregisterPlugin(CreateInstance);
 277 }
 278
 279 lldb_private::ConstString ObjectContainerBSDArchive::GetPluginNameStatic() {
 280   static ConstString g_name("bsd-archive");
 281   return g_name;
 282 }
 283
 284 const char *ObjectContainerBSDArchive::GetPluginDescriptionStatic() {
 285   return "BSD Archive object container reader.";
 286 }
 287
 288 ObjectContainer *ObjectContainerBSDArchive::CreateInstance(
 289     const lldb::ModuleSP &module_sp, DataBufferSP &data_sp,
 290     lldb::offset_t data_offset, const FileSpec *file,
 291     lldb::offset_t file_offset, lldb::offset_t length) {
 292   ConstString object_name(module_sp->GetObjectName());
 293   if (!object_name)
 294     return nullptr;
 295
 296   if (data_sp) {
 297     // We have data, which means this is the first 512 bytes of the file Check
 298     // to see if the magic bytes match and if they do, read the entire table of
 299     // contents for the archive and cache it
 300     DataExtractor data;
 301     data.SetData(data_sp, data_offset, length);
 302     if (file && data_sp && ObjectContainerBSDArchive::MagicBytesMatch(data)) {
 303       static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
 304       Timer scoped_timer(
 305           func_cat,
 306           "ObjectContainerBSDArchive::CreateInstance (module = %s, file = "
 307           "%p, file_offset = 0x%8.8" PRIx64 ", file_size = 0x%8.8" PRIx64 ")",
 308           module_sp->GetFileSpec().GetPath().c_str(),
 309           static_cast<const void *>(file), static_cast<uint64_t>(file_offset),
 310           static_cast<uint64_t>(length));
 311
 312       // Map the entire .a file to be sure that we don't lose any data if the
 313       // file gets updated by a new build while this .a file is being used for
 314       // debugging
 315       DataBufferSP archive_data_sp =
 316           DataBufferLLVM::CreateSliceFromPath(file->GetPath(), length, file_offset);
 317       if (!archive_data_sp)
 318         return nullptr;
 319
 320       lldb::offset_t archive_data_offset = 0;
 321
 322       Archive::shared_ptr archive_sp(Archive::FindCachedArchive(
 323           *file, module_sp->GetArchitecture(), module_sp->GetModificationTime(),
 324           file_offset));
 325       std::unique_ptr<ObjectContainerBSDArchive> container_ap(
 326           new ObjectContainerBSDArchive(module_sp, archive_data_sp,
 327                                         archive_data_offset, file, file_offset,
 328                                         length));
 329
 330       if (container_ap.get()) {
 331         if (archive_sp) {
 332           // We already have this archive in our cache, use it
 333           container_ap->SetArchive(archive_sp);
 334           return container_ap.release();
 335         } else if (container_ap->ParseHeader())
 336           return container_ap.release();
 337       }
 338     }
 339   } else {
 340     // No data, just check for a cached archive
 341     Archive::shared_ptr archive_sp(Archive::FindCachedArchive(
 342         *file, module_sp->GetArchitecture(), module_sp->GetModificationTime(),
 343         file_offset));
 344     if (archive_sp) {
 345       std::unique_ptr<ObjectContainerBSDArchive> container_ap(
 346           new ObjectContainerBSDArchive(module_sp, data_sp, data_offset, file,
 347                                         file_offset, length));
 348
 349       if (container_ap.get()) {
 350         // We already have this archive in our cache, use it
 351         container_ap->SetArchive(archive_sp);
 352         return container_ap.release();
 353       }
 354     }
 355   }
 356   return NULL;
 357 }
 358
 359 bool ObjectContainerBSDArchive::MagicBytesMatch(const DataExtractor &data) {
 360   uint32_t offset = 0;
 361   const char *armag = (const char *)data.PeekData(offset, sizeof(ar_hdr));
 362   if (armag && ::strncmp(armag, ARMAG, SARMAG) == 0) {
 363     armag += offsetof(struct ar_hdr, ar_fmag) + SARMAG;
 364     if (strncmp(armag, ARFMAG, 2) == 0)
 365       return true;
 366   }
 367   return false;
 368 }
 369
 370 ObjectContainerBSDArchive::ObjectContainerBSDArchive(
 371     const lldb::ModuleSP &module_sp, DataBufferSP &data_sp,
 372     lldb::offset_t data_offset, const lldb_private::FileSpec *file,
 373     lldb::offset_t file_offset, lldb::offset_t size)
 374     : ObjectContainer(module_sp, file, file_offset, size, data_sp, data_offset),
 375       m_archive_sp() {}
 376 void ObjectContainerBSDArchive::SetArchive(Archive::shared_ptr &archive_sp) {
 377   m_archive_sp = archive_sp;
 378 }
 379
 380 ObjectContainerBSDArchive::~ObjectContainerBSDArchive() {}
 381
 382 bool ObjectContainerBSDArchive::ParseHeader() {
 383   if (m_archive_sp.get() == NULL) {
 384     if (m_data.GetByteSize() > 0) {
 385       ModuleSP module_sp(GetModule());
 386       if (module_sp) {
 387         m_archive_sp = Archive::ParseAndCacheArchiveForFile(
 388             m_file, module_sp->GetArchitecture(),
 389             module_sp->GetModificationTime(), m_offset, m_data);
 390       }
 391       // Clear the m_data that contains the entire archive data and let our
 392       // m_archive_sp hold onto the data.
 393       m_data.Clear();
 394     }
 395   }
 396   return m_archive_sp.get() != NULL;
 397 }
 398
 399 void ObjectContainerBSDArchive::Dump(Stream *s) const {
 400   s->Printf("%p: ", static_cast<const void *>(this));
 401   s->Indent();
 402   const size_t num_archs = GetNumArchitectures();
 403   const size_t num_objects = GetNumObjects();
 404   s->Printf("ObjectContainerBSDArchive, num_archs = %" PRIu64
 405             ", num_objects = %" PRIu64 "",
 406             (uint64_t)num_archs, (uint64_t)num_objects);
 407   uint32_t i;
 408   ArchSpec arch;
 409   s->IndentMore();
 410   for (i = 0; i < num_archs; i++) {
 411     s->Indent();
 412     GetArchitectureAtIndex(i, arch);
 413     s->Printf("arch[%u] = %s\n", i, arch.GetArchitectureName());
 414   }
 415   for (i = 0; i < num_objects; i++) {
 416     s->Indent();
 417     s->Printf("object[%u] = %s\n", i, GetObjectNameAtIndex(i));
 418   }
 419   s->IndentLess();
 420   s->EOL();
 421 }
 422
 423 ObjectFileSP ObjectContainerBSDArchive::GetObjectFile(const FileSpec *file) {
 424   ModuleSP module_sp(GetModule());
 425   if (module_sp) {
 426     if (module_sp->GetObjectName() && m_archive_sp) {
 427       Object *object = m_archive_sp->FindObject(
 428           module_sp->GetObjectName(), module_sp->GetObjectModificationTime());
 429       if (object) {
 430         lldb::offset_t data_offset = object->ar_file_offset;
 431         return ObjectFile::FindPlugin(
 432             module_sp, file, m_offset + object->ar_file_offset,
 433             object->ar_file_size, m_archive_sp->GetData().GetSharedDataBuffer(),
 434             data_offset);
 435       }
 436     }
 437   }
 438   return ObjectFileSP();
 439 }
 440
 441 //------------------------------------------------------------------
 442 // PluginInterface protocol
 443 //------------------------------------------------------------------
 444 lldb_private::ConstString ObjectContainerBSDArchive::GetPluginName() {
 445   return GetPluginNameStatic();
 446 }
 447
 448 uint32_t ObjectContainerBSDArchive::GetPluginVersion() { return 1; }
 449
 450 size_t ObjectContainerBSDArchive::GetModuleSpecifications(
 451     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
 452     lldb::offset_t data_offset, lldb::offset_t file_offset,
 453     lldb::offset_t file_size, lldb_private::ModuleSpecList &specs) {
 454
 455   // We have data, which means this is the first 512 bytes of the file Check to
 456   // see if the magic bytes match and if they do, read the entire table of
 457   // contents for the archive and cache it
 458   DataExtractor data;
 459   data.SetData(data_sp, data_offset, data_sp->GetByteSize());
 460   if (!file || !data_sp || !ObjectContainerBSDArchive::MagicBytesMatch(data))
 461     return 0;
 462
 463   const size_t initial_count = specs.GetSize();
 464   llvm::sys::TimePoint<> file_mod_time = FileSystem::GetModificationTime(file);
 465   Archive::shared_ptr archive_sp(
 466       Archive::FindCachedArchive(file, ArchSpec(), file_mod_time, file_offset));
 467   bool set_archive_arch = false;
 468   if (!archive_sp) {
 469     set_archive_arch = true;
 470     data_sp =
 471         DataBufferLLVM::CreateSliceFromPath(file.GetPath(), file_size, file_offset);
 472     if (data_sp) {
 473       data.SetData(data_sp, 0, data_sp->GetByteSize());
 474       archive_sp = Archive::ParseAndCacheArchiveForFile(
 475           file, ArchSpec(), file_mod_time, file_offset, data);
 476     }
 477   }
 478
 479   if (archive_sp) {
 480     const size_t num_objects = archive_sp->GetNumObjects();
 481     for (size_t idx = 0; idx < num_objects; ++idx) {
 482       const Object *object = archive_sp->GetObjectAtIndex(idx);
 483       if (object) {
 484         const lldb::offset_t object_file_offset =
 485             file_offset + object->ar_file_offset;
 486         if (object->ar_file_offset < file_size &&
 487             file_size > object_file_offset) {
 488           if (ObjectFile::GetModuleSpecifications(
 489                   file, object_file_offset, file_size - object_file_offset,
 490                   specs)) {
 491             ModuleSpec &spec =
 492                 specs.GetModuleSpecRefAtIndex(specs.GetSize() - 1);
 493             llvm::sys::TimePoint<> object_mod_time(
 494                 std::chrono::seconds(object->ar_date));
 495             spec.GetObjectName() = object->ar_name;
 496             spec.SetObjectOffset(object_file_offset);
 497             spec.SetObjectSize(file_size - object_file_offset);
 498             spec.GetObjectModificationTime() = object_mod_time;
 499           }
 500         }
 501       }
 502     }
 503   }
 504   const size_t end_count = specs.GetSize();
 505   size_t num_specs_added = end_count - initial_count;
 506   if (set_archive_arch && num_specs_added > 0) {
 507     // The archive was created but we didn't have an architecture so we need to
 508     // set it
 509     for (size_t i = initial_count; i < end_count; ++i) {
 510       ModuleSpec module_spec;
 511       if (specs.GetModuleSpecAtIndex(i, module_spec)) {
 512         if (module_spec.GetArchitecture().IsValid()) {
 513           archive_sp->SetArchitecture(module_spec.GetArchitecture());
 514           break;
 515         }
 516       }
 517     }
 518   }
 519   return num_specs_added;
 520 }