ProcessStructReader.h

Go to the documentation of this file.

//===---------------------ProcessStructReader.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
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_TARGET_PROCESSSTRUCTREADER_H
#define LLDB_TARGET_PROCESSSTRUCTREADER_H
 
#include "lldb/lldb-defines.h"
#include "lldb/lldb-types.h"
 
#include "lldb/Symbol/CompilerType.h"
#include "lldb/Target/Process.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "lldb/Utility/DataExtractor.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Status.h"
 
#include "llvm/ADT/StringMap.h"
 
#include <initializer_list>
#include <map>
#include <string>
 
namespace lldb_private {
class ProcessStructReader {
protected:
  struct FieldImpl {
    CompilerType type;
    size_t offset;
    size_t size;
  };
 
  llvm::StringMap<FieldImpl> m_fields;
  DataExtractor m_data;
  lldb::ByteOrder m_byte_order;
  size_t m_addr_byte_size;
 
public:
  ProcessStructReader(Process *process, lldb::addr_t base_addr,
                      CompilerType struct_type)
      : m_byte_order(lldb::eByteOrderInvalid), m_addr_byte_size(0) {
    if (!process)
      return;
    if (base_addr == 0 || base_addr == LLDB_INVALID_ADDRESS)
      return;
    m_byte_order = process->GetByteOrder();
    m_addr_byte_size = process->GetAddressByteSize();
 
    for (size_t idx = 0; idx < struct_type.GetNumFields(); idx++) {
      std::string name;
      uint64_t bit_offset;
      uint32_t bitfield_bit_size;
      bool is_bitfield;
      CompilerType field_type = struct_type.GetFieldAtIndex(
          idx, name, &bit_offset, &bitfield_bit_size, &is_bitfield);
      // no support for bitfields in here (yet)
      if (is_bitfield)
        return;
      auto size_or_err = field_type.GetByteSize(nullptr);
      if (!size_or_err) {
        LLDB_LOG_ERROR(GetLog(LLDBLog::Target), size_or_err.takeError(), "{0}");
        return;
      }
      size_t size = *size_or_err;
 
      // no support for things larger than a uint64_t (yet)
      if (size > 8)
        return;
      size_t byte_index = static_cast<size_t>(bit_offset / 8);
      m_fields.insert(
          {name, FieldImpl{field_type, byte_index, static_cast<size_t>(size)}});
    }
    auto total_size_or_err = struct_type.GetByteSize(nullptr);
    if (!total_size_or_err) {
      LLDB_LOG_ERROR(GetLog(LLDBLog::Target), total_size_or_err.takeError(),
                     "{0}");
      return;
    }
    size_t total_size = *total_size_or_err;
 
    lldb::WritableDataBufferSP buffer_sp(new DataBufferHeap(total_size, 0));
    Status error;
    process->ReadMemoryFromInferior(base_addr, buffer_sp->GetBytes(),
                                    total_size, error);
    if (error.Fail())
      return;
    m_data = DataExtractor(buffer_sp, m_byte_order, m_addr_byte_size);
  }
 
  template <typename RetType>
  RetType GetField(llvm::StringRef name, RetType fail_value = RetType()) {
    auto iter = m_fields.find(name), end = m_fields.end();
    if (iter == end)
      return fail_value;
    auto size = iter->second.size;
    if (sizeof(RetType) < size)
      return fail_value;
    lldb::offset_t offset = iter->second.offset;
    if (offset + size > m_data.GetByteSize())
      return fail_value;
    return (RetType)(m_data.GetMaxU64(&offset, size));
  }
};
}
 
#endif // LLDB_TARGET_PROCESSSTRUCTREADER_H