15068915155

Committed 16 May 2025 12:53PM UTC coverage: 88.889% (+0.002%) from 88.887%

Build # 15068915155

Build Type

Pull #170

github

Committed by

web-flow

Commit Message

Merge 23b365aba into 0492531d2

Pull Request Pull Request #170: Refactor source location interface

Run Details

16 of 17 new or added lines in 1 file covered. (94.12%)

12 existing lines in 1 file now uncovered.

4232 of 4761 relevant lines covered (88.89%)

278064.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.71

/lib/runtime/TypeResolution.cpp

// TypeART library
//
// Copyright (c) 2017-2025 TypeART Authors
// Distributed under the BSD 3-Clause license.
// (See accompanying file LICENSE.txt or copy at
// https://opensource.org/licenses/BSD-3-Clause)
//
// Project home: https://github.com/tudasc/TypeART
//
// SPDX-License-Identifier: BSD-3-Clause
//

#include "TypeResolution.h"

#include "AllocationTracking.h"
#include "Runtime.h"
#include "RuntimeData.h"
#include "RuntimeInterface.h"
#include "TypeInterface.h"
#include "support/Logger.h"
#include "support/System.h"

#include "llvm/Support/raw_ostream.h"

#include <cassert>
#include <cstddef>
#include <cstdint>
#include <utility>
#include <vector>

namespace typeart {

namespace detail {

template <typename P, typename T>
inline const void* add_byte_offset(const P* addr, T offset) {
  assert(addr != nullptr);
  return static_cast<const P*>(static_cast<const char*>(addr) + offset);
}

template <typename T>
inline std::ptrdiff_t substract_pointer(const T* addr_a, const T* addr_b) {
  assert(addr_a != nullptr);
  assert(addr_b != nullptr);
  return static_cast<const char*>(addr_a) - static_cast<const char*>(addr_b);
}

inline size_t get_member_index_at(const typeart_struct_layout& structInfo, size_t offset) {
  const size_t num_members = structInfo.num_members;

  if (num_members == 0) {
    return 0;
  }

  const auto* struct_offsets = structInfo.offsets;

  if (offset > struct_offsets[num_members - 1]) {
    return num_members - 1;
  }

  size_t member_index{0};
  while (member_index < (num_members - 1) && offset >= struct_offsets[member_index + 1]) {
    ++member_index;
  }
  return member_index;
}

}  // namespace detail

TypeResolution::TypeResolution(const TypeDB& type_db, Recorder& recorder)
    : type_database{type_db}, runtime_recorder{recorder} {
}

TypeResolution::TypeArtStatus TypeResolution::getSubTypeInfo(const void* baseAddr, size_t offset,
                                                             const typeart_struct_layout& containerInfo, int* subType,
                                                             const void** subTypeBaseAddr, size_t* subTypeOffset,
                                                             size_t* subTypeCount) const {
  if (containerInfo.type_id < 0) {
    return TYPEART_ERROR;
  }

  if (offset >= containerInfo.extent) {
    return TYPEART_BAD_OFFSET;
  }

  // Get index of the struct member at the address
  const size_t memberIndex = detail::get_member_index_at(containerInfo, offset);
  const int memberType     = containerInfo.member_types[memberIndex];
  const size_t baseOffset  = containerInfo.offsets[memberIndex];

  const size_t internalOffset = offset - baseOffset;
  const size_t typeSize       = type_database.getTypeSize(memberType);
  if (typeSize == 0) {
    return TYPEART_INVALID_ID;
  }
  const size_t offsetInTypeSize = internalOffset / typeSize;
  const size_t newOffset        = internalOffset % typeSize;

  // If newOffset != 0, the subtype cannot be atomic, i.e. must be a struct
  if (newOffset != 0) {
    if (type_database.isReservedType(memberType)) {
      return TYPEART_BAD_ALIGNMENT;
    }
  }

  // Ensure that the array index is in bounds
  if (offsetInTypeSize >= containerInfo.count[memberIndex]) {
    // Address points to padding
    return TYPEART_BAD_ALIGNMENT;
  }

  *subType         = memberType;
  *subTypeBaseAddr = detail::add_byte_offset(baseAddr, baseOffset);
  *subTypeOffset   = newOffset;
  *subTypeCount    = containerInfo.count[memberIndex] - offsetInTypeSize;

  return TYPEART_OK;
}

TypeResolution::TypeArtStatus TypeResolution::getTypeInfoInternal(const void* baseAddr, size_t offset,
                                                                  const StructTypeInfo& containerInfo, int* type,
                                                                  size_t* count) const {
  assert(offset < containerInfo.extent && "Something went wrong with the base address computation");

  int subType{-1};
  const void* subTypeBaseAddr;
  size_t subTypeOffset{0};
  size_t subTypeCount{0};

  const StructTypeInfo* structInfo = &containerInfo;

  const auto to_struct_layout_info = [](const auto& struct_type_info) {
    typeart_struct_layout struct_layout;
    struct_layout.type_id      = struct_type_info.type_id;
    struct_layout.name         = struct_type_info.name.c_str();
    struct_layout.num_members  = struct_type_info.num_members;
    struct_layout.extent       = struct_type_info.extent;
    struct_layout.offsets      = &struct_type_info.offsets[0];
    struct_layout.member_types = &struct_type_info.member_types[0];
    struct_layout.count        = &struct_type_info.array_sizes[0];
    return struct_layout;
  };

  // Resolve type recursively, until the address matches exactly
  bool resolve{true};
  while (resolve) {
    const auto status_subtype_info = getSubTypeInfo(baseAddr, offset, to_struct_layout_info(*structInfo), &subType,
                                                    &subTypeBaseAddr, &subTypeOffset, &subTypeCount);

    if (status_subtype_info != TYPEART_OK) {
      return status_subtype_info;
    }

    baseAddr = subTypeBaseAddr;
    offset   = subTypeOffset;

    // Continue as long as there is a byte offset
    resolve = offset != 0;

    // Get layout of the nested struct
    if (resolve) {
      const auto status_struct_info = getStructInfo(subType, &structInfo);
      if (status_struct_info != TYPEART_OK) {
        return status_struct_info;
      }
    }
  }
  *type  = subType;
  *count = subTypeCount;
  return TYPEART_OK;
}

TypeResolution::TypeArtStatus TypeResolution::getTypeInfo(const void* addr, const void* basePtr,
                                                          const PointerInfo& ptrInfo, int* type, size_t* count) const {
  const int containing_type = ptrInfo.typeId;
  size_t containing_type_count{0};
  size_t internal_byte_offset{0};

  // First, retrieve the containing type
  TypeArtStatus status = getContainingTypeInfo(addr, basePtr, ptrInfo, &containing_type_count, &internal_byte_offset);
  if (status != TYPEART_OK) {
    if (status == TYPEART_UNKNOWN_ADDRESS) {
      runtime_recorder.incAddrMissing(addr);
    }
    return status;
  }

  // Check for exact address match
  if (internal_byte_offset == 0) {
    *type  = containing_type;
    *count = containing_type_count;
    return TYPEART_OK;
  }

  if (type_database.isBuiltinType(containing_type)) {
    // Address points to the middle of a builtin type
    return TYPEART_BAD_ALIGNMENT;
  }

  // Resolve struct recursively
  const auto* structInfo = type_database.getStructInfo(containing_type);
  if (structInfo != nullptr) {
    const void* containingTypeAddr = detail::add_byte_offset(addr, -std::ptrdiff_t(internal_byte_offset));
    return getTypeInfoInternal(containingTypeAddr, internal_byte_offset, *structInfo, type, count);
  }

  return TYPEART_INVALID_ID;
}

TypeResolution::TypeArtStatus TypeResolution::getContainingTypeInfo(const void* addr, const void* basePtr,
                                                                    const PointerInfo& ptrInfo, size_t* count,
                                                                    size_t* offset) const {
  const auto& basePtrInfo = ptrInfo;
  size_t typeSize         = type_database.getTypeSize(basePtrInfo.typeId);
  if (basePtrInfo.typeId == TYPEART_VOID || basePtrInfo.typeId == TYPEART_POINTER) {
    // typeSize = 1;
  }

  // Check for exact match -> no further checks and offsets calculations needed
  if (basePtr == addr) {
    *count  = ptrInfo.count;
    *offset = 0;
    return TYPEART_OK;
  }

  if (typeSize == 0) {
    return TYPEART_ERROR;
  }

  // The address points inside a known array
  const void* blockEnd = detail::add_byte_offset(basePtr, basePtrInfo.count * typeSize);

  // Ensure that the given address is in bounds and points to the start of an element
  if (addr >= blockEnd) {
    const std::ptrdiff_t byte_offset_to_base = detail::substract_pointer(addr, basePtr);

    const auto elements  = byte_offset_to_base / typeSize;
    const auto oob_index = elements - basePtrInfo.count + 1;
    LOG_WARNING("Out of bounds for the lookup: (" << debug::toString(addr, basePtrInfo)
                                                  << ") #Elements too far: " << oob_index);
    return TYPEART_UNKNOWN_ADDRESS;
  }

  assert(addr >= basePtr && "Error in base address computation");

  const std::ptrdiff_t addrDif = detail::substract_pointer(addr, basePtr);

  // Offset of the pointer w.r.t. the start of the containing type
  const size_t internalOffset = addrDif % typeSize;

  // Array index
  const size_t typeOffset = addrDif / typeSize;
  const size_t typeCount  = basePtrInfo.count - typeOffset;

  // Retrieve and return type information
  *count  = typeCount;
  *offset = internalOffset;
  return TYPEART_OK;
}

TypeResolution::TypeArtStatus TypeResolution::getStructInfo(int type_id, const StructTypeInfo** structInfo) const {
  // Requested ID must correspond to a struct
  if (!type_database.isStructType(type_id)) {
    return TYPEART_WRONG_KIND;
  }

  const auto* result = type_database.getStructInfo(type_id);

  if (result != nullptr) {
    *structInfo = result;
    return TYPEART_OK;
  }
  return TYPEART_INVALID_ID;
}

const TypeDB& TypeResolution::db() const {
  return type_database;
}

namespace detail {
// inline typeart_status query_type(const void* addr, int* type, size_t* count) {
//   auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);
//   typeart::RuntimeSystem::get().recorder.incUsedInRequest(addr);
//   if (alloc) {
//     return typeart::RuntimeSystem::get().typeResolution.getTypeInfo(addr, alloc->first, alloc->second, type, count);
//   }
//   return TYPEART_UNKNOWN_ADDRESS;
// }

inline typeart_status query_type(const void* addr, typeart_type_info& info) {
  auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);
  typeart::RuntimeSystem::get().recorder.incUsedInRequest(addr);
  if (alloc) {
    typeart_base_type_info base;
    base.address        = alloc->first;
    base.type_id        = alloc->second.typeId;
    base.count          = alloc->second.count;
    info.base_type_info = base;
    info.address        = addr;

    typeart::RuntimeSystem::get().recorder.incTypeQuery(base.type_id);

    const auto result = typeart::RuntimeSystem::get().typeResolution.getTypeInfo(addr, alloc->first, alloc->second,
                                                                                 &info.type_id, &info.count);
    return result;
  }
  return TYPEART_UNKNOWN_ADDRESS;
}

inline typeart_status query_struct_layout(int type_id, typeart_struct_layout* struct_layout) {
  const typeart::StructTypeInfo* struct_info;
  typeart_status status = typeart::RuntimeSystem::get().typeResolution.getStructInfo(type_id, &struct_info);
  if (status == TYPEART_OK) {
    struct_layout->type_id      = struct_info->type_id;
    struct_layout->name         = struct_info->name.c_str();
    struct_layout->num_members  = struct_info->num_members;
    struct_layout->extent       = struct_info->extent;
    struct_layout->offsets      = (struct_info->offsets).data();
    struct_layout->member_types = (struct_info->member_types).data();
    struct_layout->count        = (struct_info->array_sizes).data();
  } else {
    struct_layout->type_id      = std::numeric_limits<decltype(typeart_struct_layout::type_id)>::min();
    struct_layout->name         = "";
    struct_layout->num_members  = 0;
    struct_layout->extent       = 0;
    struct_layout->offsets      = nullptr;
    struct_layout->member_types = nullptr;
    struct_layout->count        = nullptr;
  }
  return status;
}

char* string2char(std::string_view src) {
  // const void* ret_addr       = __builtin_return_address(0);
  const size_t source_length = src.size() + 1;  // +1 for '\0'
  char* string_copy          = (char*)malloc(sizeof(char) * source_length);

  if (string_copy == nullptr) {
    return nullptr;
  }

  // typeart::RuntimeSystem::get().allocTracker.onAlloc(string_copy, TYPEART_CHAR_8, source_length, ret_addr);

  memcpy(string_copy, src.data(), source_length);

  return string_copy;
}

}  // namespace detail
}  // namespace typeart

/**
 * Runtime interface implementation
 *
 */

typeart_status typeart_get_type(const void* addr, typeart_type_info* base_type) {
  typeart::RTGuard guard;
  return typeart::detail::query_type(addr, *base_type);
}

typeart_status typeart_get_containing_type(typeart_type_info type, typeart_base_type_info* containing_type,
                                           size_t* byte_offset) {
  typeart::RTGuard guard;
  containing_type->type_id = type.base_type_info.type_id;
  containing_type->count   = type.base_type_info.count;
  containing_type->address = type.base_type_info.address;
  const typeart::PointerInfo info{type.base_type_info.type_id, type.base_type_info.count};
  const auto result = typeart::RuntimeSystem::get().typeResolution.getContainingTypeInfo(
      type.address, containing_type->address, info, &containing_type->count, byte_offset);

  return result;
}

typeart_status typeart_get_subtype(const typeart_struct_layout* container_layout, const void* base_addr, size_t offset,
                                   typeart_base_type_info* subtype_info, size_t* subtype_byte_offset) {
  typeart::RTGuard guard;
  auto status = typeart::RuntimeSystem::get().typeResolution.getSubTypeInfo(
      base_addr, offset, *container_layout, &subtype_info->type_id, &subtype_info->address, subtype_byte_offset,
      &subtype_info->count);
  return status;
}

typeart_status typeart_resolve_type_id(int type_id, typeart_struct_layout* struct_layout) {
  typeart::RTGuard guard;
  return typeart::detail::query_struct_layout(type_id, struct_layout);
}

typeart_status typeart_get_return_address(const void* addr, const void** return_addr) {
  typeart::RTGuard guard;
  auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);

  if (alloc) {
    *return_addr = alloc.value().second.debug;
    return TYPEART_OK;
  }
  *return_addr = nullptr;
  return TYPEART_UNKNOWN_ADDRESS;
}

// typeart_status_t typeart_get_source_location(const void* addr, char** file, char** function, char** line) {
//   using namespace typeart::detail;
//   typeart::RTGuard guard;

//   auto source_loc = typeart::SourceLocation::create(addr);

//   if (source_loc) {
//     *file     = string2char(source_loc->file);
//     *function = string2char(source_loc->function);
//     *line     = string2char(source_loc->line);

//     if (*file == nullptr || *function == nullptr || *line == nullptr) {
//       return TYPEART_ERROR;
//     }

//     return TYPEART_OK;
//   }

//   return TYPEART_UNKNOWN_ADDRESS;
// }

typeart_status_t typeart_get_source_location(const void* addr, typeart_source_location* source_location) {
  using namespace typeart::detail;
  typeart::RTGuard guard;

  auto source_loc = typeart::SourceLocation::create(addr);

  if (source_loc) {
    source_location->file     = string2char(source_loc->file);
    source_location->function = string2char(source_loc->function);
    source_location->line     = string2char(source_loc->line);

    if (source_location->file == nullptr || source_location->function == nullptr || source_location->line == nullptr) {
      return TYPEART_ERROR;
    }

    return TYPEART_OK;
  }

  return TYPEART_UNKNOWN_ADDRESS;
}

typeart_status_t typeart_free_source_location(typeart_source_location* source_location) {
  using namespace typeart::detail;
  typeart::RTGuard guard;

  if (source_location == nullptr) {
    return TYPEART_ERROR;
  }

  free(source_location->file);
  free(source_location->function);
  free(source_location->line);

  source_location->file     = nullptr;
  source_location->function = nullptr;
  source_location->line     = nullptr;

  return TYPEART_OK;
}

const char* typeart_get_type_name(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().getTypeName(type_id).c_str();
}

bool typeart_is_vector_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isVectorType(type_id);
}

bool typeart_is_valid_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isValid(type_id);
}

bool typeart_is_reserved_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isReservedType(type_id);
}

bool typeart_is_builtin_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isBuiltinType(type_id);
}

bool typeart_is_struct_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isStructType(type_id);
}

bool typeart_is_userdefined_type(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isUserDefinedType(type_id);
}

bool typeart_is_union(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().isUnion(type_id);
}

size_t typeart_get_type_size(int type_id) {
  typeart::RTGuard guard;
  return typeart::RuntimeSystem::get().typeResolution.db().getTypeSize(type_id);
}

1	// TypeART library
2	//
3	// Copyright (c) 2017-2025 TypeART Authors
4	// Distributed under the BSD 3-Clause license.
5	// (See accompanying file LICENSE.txt or copy at
6	// https://opensource.org/licenses/BSD-3-Clause)
7	//
8	// Project home: https://github.com/tudasc/TypeART
9	//
10	// SPDX-License-Identifier: BSD-3-Clause
11	//
12
13	#include "TypeResolution.h"
14
15	#include "AllocationTracking.h"
16	#include "Runtime.h"
17	#include "RuntimeData.h"
18	#include "RuntimeInterface.h"
19	#include "TypeInterface.h"
20	#include "support/Logger.h"
21	#include "support/System.h"
22
23	#include "llvm/Support/raw_ostream.h"
24
25	#include <cassert>
26	#include <cstddef>
27	#include <cstdint>
28	#include <utility>
29	#include <vector>
30
31	namespace typeart {
32
33	namespace detail {
34
35	template <typename P, typename T>
36	inline const void* add_byte_offset(const P* addr, T offset) {	2,163✔
37	assert(addr != nullptr);	2,163✔
38	return static_cast<const P>(static_cast<const char>(addr) + offset);	2,163✔
39	}
40
41	template <typename T>
42	inline std::ptrdiff_t substract_pointer(const T* addr_a, const T* addr_b) {	1,575✔
43	assert(addr_a != nullptr);	1,575✔
44	assert(addr_b != nullptr);	1,575✔
45	return static_cast<const char>(addr_a) - static_cast<const char>(addr_b);	1,575✔
46	}
47
48	inline size_t get_member_index_at(const typeart_struct_layout& structInfo, size_t offset) {	348✔
49	const size_t num_members = structInfo.num_members;	348✔
50
51	if (num_members == 0) {	348✔
UNCOV 52	return 0;	×
53	}
54
55	const auto* struct_offsets = structInfo.offsets;	348✔
56
57	if (offset > struct_offsets[num_members - 1]) {	348✔
58	return num_members - 1;	15✔
59	}
60
61	size_t member_index{0};	333✔
62	while (member_index < (num_members - 1) && offset >= struct_offsets[member_index + 1]) {	720✔
63	++member_index;	387✔
64	}
65	return member_index;	333✔
66	}	348✔
67
68	} // namespace detail
69
70	TypeResolution::TypeResolution(const TypeDB& type_db, Recorder& recorder)	778✔
71	: type_database{type_db}, runtime_recorder{recorder} {	778✔
72	}	778✔
73
74	TypeResolution::TypeArtStatus TypeResolution::getSubTypeInfo(const void* baseAddr, size_t offset,	784✔
75	const typeart_struct_layout& containerInfo, int* subType,
76	const void** subTypeBaseAddr, size_t* subTypeOffset,
77	size_t* subTypeCount) const {
78	if (containerInfo.type_id < 0) {	372✔
79	return TYPEART_ERROR;	12✔
80	}
81
82	if (offset >= containerInfo.extent) {	360✔
83	return TYPEART_BAD_OFFSET;	12✔
84	}
85
86	// Get index of the struct member at the address
87	const size_t memberIndex = detail::get_member_index_at(containerInfo, offset);	348✔
88	const int memberType = containerInfo.member_types[memberIndex];	348✔
89	const size_t baseOffset = containerInfo.offsets[memberIndex];	348✔
90
91	const size_t internalOffset = offset - baseOffset;	348✔
92	const size_t typeSize = type_database.getTypeSize(memberType);	348✔
93	if (typeSize == 0) {	348✔
UNCOV 94	return TYPEART_INVALID_ID;	×
95	}
96	const size_t offsetInTypeSize = internalOffset / typeSize;	348✔
97	const size_t newOffset = internalOffset % typeSize;	348✔
98
99	// If newOffset != 0, the subtype cannot be atomic, i.e. must be a struct
100	if (newOffset != 0) {	348✔
101	if (type_database.isReservedType(memberType)) {	24✔
102	return TYPEART_BAD_ALIGNMENT;	24✔
103	}
UNCOV 104	}	×
105
106	// Ensure that the array index is in bounds
107	if (offsetInTypeSize >= containerInfo.count[memberIndex]) {	324✔
108	// Address points to padding
109	return TYPEART_BAD_ALIGNMENT;	60✔
110	}
111
112	*subType = memberType;	264✔
113	*subTypeBaseAddr = detail::add_byte_offset(baseAddr, baseOffset);	264✔
114	*subTypeOffset = newOffset;	264✔
115	*subTypeCount = containerInfo.count[memberIndex] - offsetInTypeSize;	264✔
116
117	return TYPEART_OK;	264✔
118	}	372✔
119
120	TypeResolution::TypeArtStatus TypeResolution::getTypeInfoInternal(const void* baseAddr, size_t offset,	324✔
121	const StructTypeInfo& containerInfo, int* type,
122	size_t* count) const {
123	assert(offset < containerInfo.extent && "Something went wrong with the base address computation");	648✔
124
125	int subType{-1};	324✔
126	const void* subTypeBaseAddr;	324✔
127	size_t subTypeOffset{0};	324✔
128	size_t subTypeCount{0};	324✔
129
130	const StructTypeInfo* structInfo = &containerInfo;	324✔
131
132	const auto to_struct_layout_info = [](const auto& struct_type_info) {	648✔
133	typeart_struct_layout struct_layout;	324✔
134	struct_layout.type_id = struct_type_info.type_id;	324✔
135	struct_layout.name = struct_type_info.name.c_str();	324✔
136	struct_layout.num_members = struct_type_info.num_members;	324✔
137	struct_layout.extent = struct_type_info.extent;	324✔
138	struct_layout.offsets = &struct_type_info.offsets[0];	324✔
139	struct_layout.member_types = &struct_type_info.member_types[0];	324✔
140	struct_layout.count = &struct_type_info.array_sizes[0];	324✔
141	return struct_layout;	324✔
142	};	324✔
143
144	// Resolve type recursively, until the address matches exactly
145	bool resolve{true};	324✔
146	while (resolve) {	576✔
147	const auto status_subtype_info = getSubTypeInfo(baseAddr, offset, to_struct_layout_info(*structInfo), &subType,	324✔
148	&subTypeBaseAddr, &subTypeOffset, &subTypeCount);
149
150	if (status_subtype_info != TYPEART_OK) {	324✔
151	return status_subtype_info;	72✔
152	}
153
154	baseAddr = subTypeBaseAddr;	252✔
155	offset = subTypeOffset;	252✔
156
157	// Continue as long as there is a byte offset
158	resolve = offset != 0;	252✔
159
160	// Get layout of the nested struct
161	if (resolve) {	252✔
UNCOV 162	const auto status_struct_info = getStructInfo(subType, &structInfo);	×
163	if (status_struct_info != TYPEART_OK) {	×
164	return status_struct_info;	×
165	}
UNCOV 166	}	×
167	}	324✔
168	*type = subType;	252✔
169	*count = subTypeCount;	252✔
170	return TYPEART_OK;	252✔
171	}	324✔
172
173	TypeResolution::TypeArtStatus TypeResolution::getTypeInfo(const void* addr, const void* basePtr,	7,589✔
174	const PointerInfo& ptrInfo, int* type, size_t* count) const {
175	const int containing_type = ptrInfo.typeId;	7,589✔
176	size_t containing_type_count{0};	7,589✔
177	size_t internal_byte_offset{0};	7,589✔
178
179	// First, retrieve the containing type
180	TypeArtStatus status = getContainingTypeInfo(addr, basePtr, ptrInfo, &containing_type_count, &internal_byte_offset);	7,589✔
181	if (status != TYPEART_OK) {	7,589✔
182	if (status == TYPEART_UNKNOWN_ADDRESS) {	573✔
183	runtime_recorder.incAddrMissing(addr);	573✔
184	}	573✔
185	return status;	573✔
186	}
187
188	// Check for exact address match
189	if (internal_byte_offset == 0) {	7,016✔
190	*type = containing_type;	6,452✔
191	*count = containing_type_count;	6,452✔
192	return TYPEART_OK;	6,452✔
193	}
194
195	if (type_database.isBuiltinType(containing_type)) {	564✔
196	// Address points to the middle of a builtin type
197	return TYPEART_BAD_ALIGNMENT;	240✔
198	}
199
200	// Resolve struct recursively
201	const auto* structInfo = type_database.getStructInfo(containing_type);	324✔
202	if (structInfo != nullptr) {	324✔
203	const void* containingTypeAddr = detail::add_byte_offset(addr, -std::ptrdiff_t(internal_byte_offset));	324✔
204	return getTypeInfoInternal(containingTypeAddr, internal_byte_offset, *structInfo, type, count);	324✔
205	}	324✔
206
UNCOV 207	return TYPEART_INVALID_ID;	×
208	}	7,589✔
209
210	TypeResolution::TypeArtStatus TypeResolution::getContainingTypeInfo(const void* addr, const void* basePtr,	7,643✔
211	const PointerInfo& ptrInfo, size_t* count,
212	size_t* offset) const {
213	const auto& basePtrInfo = ptrInfo;	7,643✔
214	size_t typeSize = type_database.getTypeSize(basePtrInfo.typeId);	7,643✔
215	if (basePtrInfo.typeId == TYPEART_VOID \|\| basePtrInfo.typeId == TYPEART_POINTER) {	7,643✔
216	// typeSize = 1;
217	}	108✔
218
219	// Check for exact match -> no further checks and offsets calculations needed
220	if (basePtr == addr) {	7,643✔
221	*count = ptrInfo.count;	6,068✔
222	*offset = 0;	6,068✔
223	return TYPEART_OK;	6,068✔
224	}
225
226	if (typeSize == 0) {	1,575✔
UNCOV 227	return TYPEART_ERROR;	×
228	}
229
230	// The address points inside a known array
231	const void* blockEnd = detail::add_byte_offset(basePtr, basePtrInfo.count * typeSize);	1,575✔
232
233	// Ensure that the given address is in bounds and points to the start of an element
234	if (addr >= blockEnd) {	1,575✔
235	const std::ptrdiff_t byte_offset_to_base = detail::substract_pointer(addr, basePtr);	573✔
236
237	const auto elements = byte_offset_to_base / typeSize;	573✔
238	const auto oob_index = elements - basePtrInfo.count + 1;	573✔
239	LOG_WARNING("Out of bounds for the lookup: (" << debug::toString(addr, basePtrInfo)	573✔
240	<< ") #Elements too far: " << oob_index);
241	return TYPEART_UNKNOWN_ADDRESS;	573✔
242	}	573✔
243
244	assert(addr >= basePtr && "Error in base address computation");	2,004✔
245
246	const std::ptrdiff_t addrDif = detail::substract_pointer(addr, basePtr);	1,002✔
247
248	// Offset of the pointer w.r.t. the start of the containing type
249	const size_t internalOffset = addrDif % typeSize;	1,002✔
250
251	// Array index
252	const size_t typeOffset = addrDif / typeSize;	1,002✔
253	const size_t typeCount = basePtrInfo.count - typeOffset;	1,002✔
254
255	// Retrieve and return type information
256	*count = typeCount;	1,002✔
257	*offset = internalOffset;	1,002✔
258	return TYPEART_OK;	1,002✔
259	}	7,643✔
260
261	TypeResolution::TypeArtStatus TypeResolution::getStructInfo(int type_id, const StructTypeInfo** structInfo) const {	276✔
262	// Requested ID must correspond to a struct
263	if (!type_database.isStructType(type_id)) {	276✔
UNCOV 264	return TYPEART_WRONG_KIND;	×
265	}
266
267	const auto* result = type_database.getStructInfo(type_id);	276✔
268
269	if (result != nullptr) {	276✔
270	*structInfo = result;	252✔
271	return TYPEART_OK;	252✔
272	}
273	return TYPEART_INVALID_ID;	24✔
274	}	276✔
275
276	const TypeDB& TypeResolution::db() const {	890,266✔
277	return type_database;	890,266✔
278	}
279
280	namespace detail {
281	// inline typeart_status query_type(const void* addr, int* type, size_t* count) {
282	// auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);
283	// typeart::RuntimeSystem::get().recorder.incUsedInRequest(addr);
284	// if (alloc) {
285	// return typeart::RuntimeSystem::get().typeResolution.getTypeInfo(addr, alloc->first, alloc->second, type, count);
286	// }
287	// return TYPEART_UNKNOWN_ADDRESS;
288	// }
289
290	inline typeart_status query_type(const void* addr, typeart_type_info& info) {	7,740✔
291	auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);	7,740✔
292	typeart::RuntimeSystem::get().recorder.incUsedInRequest(addr);	7,740✔
293	if (alloc) {	7,740✔
294	typeart_base_type_info base;	7,589✔
295	base.address = alloc->first;	7,589✔
296	base.type_id = alloc->second.typeId;	7,589✔
297	base.count = alloc->second.count;	7,589✔
298	info.base_type_info = base;	7,589✔
299	info.address = addr;	7,589✔
300
301	typeart::RuntimeSystem::get().recorder.incTypeQuery(base.type_id);	7,589✔
302
303	const auto result = typeart::RuntimeSystem::get().typeResolution.getTypeInfo(addr, alloc->first, alloc->second,	7,589✔
304	&info.type_id, &info.count);	7,589✔
305	return result;	7,589✔
306	}	7,589✔
307	return TYPEART_UNKNOWN_ADDRESS;	151✔
308	}	7,740✔
309
310	inline typeart_status query_struct_layout(int type_id, typeart_struct_layout* struct_layout) {	276✔
311	const typeart::StructTypeInfo* struct_info;	276✔
312	typeart_status status = typeart::RuntimeSystem::get().typeResolution.getStructInfo(type_id, &struct_info);	276✔
313	if (status == TYPEART_OK) {	276✔
314	struct_layout->type_id = struct_info->type_id;	252✔
315	struct_layout->name = struct_info->name.c_str();	252✔
316	struct_layout->num_members = struct_info->num_members;	252✔
317	struct_layout->extent = struct_info->extent;	252✔
318	struct_layout->offsets = (struct_info->offsets).data();	252✔
319	struct_layout->member_types = (struct_info->member_types).data();	252✔
320	struct_layout->count = (struct_info->array_sizes).data();	252✔
321	} else {	252✔
322	struct_layout->type_id = std::numeric_limits<decltype(typeart_struct_layout::type_id)>::min();	24✔
323	struct_layout->name = "";	24✔
324	struct_layout->num_members = 0;	24✔
325	struct_layout->extent = 0;	24✔
326	struct_layout->offsets = nullptr;	24✔
327	struct_layout->member_types = nullptr;	24✔
328	struct_layout->count = nullptr;	24✔
329	}
330	return status;	276✔
331	}	276✔
332
333	char* string2char(std::string_view src) {	36✔
334	// const void* ret_addr = __builtin_return_address(0);
335	const size_t source_length = src.size() + 1; // +1 for '\0'	36✔
336	char* string_copy = (char)malloc(sizeof(char) source_length);	36✔
337
338	if (string_copy == nullptr) {	36✔
UNCOV 339	return nullptr;	×
340	}
341
342	// typeart::RuntimeSystem::get().allocTracker.onAlloc(string_copy, TYPEART_CHAR_8, source_length, ret_addr);
343
344	memcpy(string_copy, src.data(), source_length);	36✔
345
346	return string_copy;	36✔
347	}	36✔
348
349	} // namespace detail
350	} // namespace typeart
351
352	/**
353	* Runtime interface implementation
354	*
355	*/
356
357	typeart_status typeart_get_type(const void* addr, typeart_type_info* base_type) {	7,740✔
358	typeart::RTGuard guard;	7,740✔
359	return typeart::detail::query_type(addr, *base_type);	7,740✔
360	}	7,740✔
361
362	typeart_status typeart_get_containing_type(typeart_type_info type, typeart_base_type_info* containing_type,	54✔
363	size_t* byte_offset) {
364	typeart::RTGuard guard;	54✔
365	containing_type->type_id = type.base_type_info.type_id;	54✔
366	containing_type->count = type.base_type_info.count;	54✔
367	containing_type->address = type.base_type_info.address;	54✔
368	const typeart::PointerInfo info{type.base_type_info.type_id, type.base_type_info.count};	54✔
369	const auto result = typeart::RuntimeSystem::get().typeResolution.getContainingTypeInfo(	60✔
370	type.address, containing_type->address, info, &containing_type->count, byte_offset);	30✔
371
372	return result;	30✔
373	}	30✔
374
375	typeart_status typeart_get_subtype(const typeart_struct_layout* container_layout, const void* base_addr, size_t offset,	48✔
376	typeart_base_type_info* subtype_info, size_t* subtype_byte_offset) {
377	typeart::RTGuard guard;	48✔
378	auto status = typeart::RuntimeSystem::get().typeResolution.getSubTypeInfo(	96✔
379	base_addr, offset, *container_layout, &subtype_info->type_id, &subtype_info->address, subtype_byte_offset,	48✔
380	&subtype_info->count);	48✔
381	return status;	48✔
382	}	48✔
383
384	typeart_status typeart_resolve_type_id(int type_id, typeart_struct_layout* struct_layout) {	276✔
385	typeart::RTGuard guard;	276✔
386	return typeart::detail::query_struct_layout(type_id, struct_layout);	276✔
387	}	276✔
388
389	typeart_status typeart_get_return_address(const void* addr, const void** return_addr) {	24✔
390	typeart::RTGuard guard;	24✔
391	auto alloc = typeart::RuntimeSystem::get().allocTracker.findBaseAlloc(addr);	24✔
392
393	if (alloc) {	24✔
394	*return_addr = alloc.value().second.debug;	12✔
395	return TYPEART_OK;	12✔
396	}
397	*return_addr = nullptr;	12✔
398	return TYPEART_UNKNOWN_ADDRESS;	12✔
399	}	24✔
400
401	// typeart_status_t typeart_get_source_location(const void* addr, char file, char function, char** line) {
402	// using namespace typeart::detail;
403	// typeart::RTGuard guard;
404
405	// auto source_loc = typeart::SourceLocation::create(addr);
406
407	// if (source_loc) {
408	// *file = string2char(source_loc->file);
409	// *function = string2char(source_loc->function);
410	// *line = string2char(source_loc->line);
411
412	// if (file == nullptr \|\| function == nullptr \|\| *line == nullptr) {
413	// return TYPEART_ERROR;
414	// }
415
416	// return TYPEART_OK;
417	// }
418
419	// return TYPEART_UNKNOWN_ADDRESS;
420	// }
421
422	typeart_status_t typeart_get_source_location(const void* addr, typeart_source_location* source_location) {	12✔
423	using namespace typeart::detail;
424	typeart::RTGuard guard;	12✔
425
426	auto source_loc = typeart::SourceLocation::create(addr);	12✔
427
428	if (source_loc) {	12✔
429	source_location->file = string2char(source_loc->file);	12✔
430	source_location->function = string2char(source_loc->function);	12✔
431	source_location->line = string2char(source_loc->line);	12✔
432
433	if (source_location->file == nullptr \|\| source_location->function == nullptr \|\| source_location->line == nullptr) {	12✔
434	return TYPEART_ERROR;	×
435	}
436
437	return TYPEART_OK;	12✔
438	}
439
UNCOV 440	return TYPEART_UNKNOWN_ADDRESS;	×
441	}	12✔
442
443	typeart_status_t typeart_free_source_location(typeart_source_location* source_location) {	12✔
444	using namespace typeart::detail;
445	typeart::RTGuard guard;	12✔
446
447	if (source_location == nullptr) {	12✔
NEW 448	return TYPEART_ERROR;	×
449	}
450
451	free(source_location->file);	12✔
452	free(source_location->function);	12✔
453	free(source_location->line);	12✔
454
455	source_location->file = nullptr;	12✔
456	source_location->function = nullptr;	12✔
457	source_location->line = nullptr;	12✔
458
459	return TYPEART_OK;	12✔
460	}	12✔
461
462	const char* typeart_get_type_name(int type_id) {	6,094✔
463	typeart::RTGuard guard;	6,094✔
464	return typeart::RuntimeSystem::get().typeResolution.db().getTypeName(type_id).c_str();	6,094✔
465	}	6,094✔
466
467	bool typeart_is_vector_type(int type_id) {	24✔
468	typeart::RTGuard guard;	24✔
469	return typeart::RuntimeSystem::get().typeResolution.db().isVectorType(type_id);	24✔
470	}	24✔
471
472	bool typeart_is_valid_type(int type_id) {	24✔
473	typeart::RTGuard guard;	24✔
474	return typeart::RuntimeSystem::get().typeResolution.db().isValid(type_id);	24✔
475	}	24✔
476
477	bool typeart_is_reserved_type(int type_id) {	24✔
478	typeart::RTGuard guard;	24✔
479	return typeart::RuntimeSystem::get().typeResolution.db().isReservedType(type_id);	24✔
480	}	24✔
481
482	bool typeart_is_builtin_type(int type_id) {	24✔
483	typeart::RTGuard guard;	24✔
484	return typeart::RuntimeSystem::get().typeResolution.db().isBuiltinType(type_id);	24✔
485	}	24✔
486
487	bool typeart_is_struct_type(int type_id) {	24✔
488	typeart::RTGuard guard;	24✔
489	return typeart::RuntimeSystem::get().typeResolution.db().isStructType(type_id);	24✔
490	}	24✔
491
492	bool typeart_is_userdefined_type(int type_id) {	24✔
493	typeart::RTGuard guard;	24✔
494	return typeart::RuntimeSystem::get().typeResolution.db().isUserDefinedType(type_id);	24✔
495	}	24✔
496
UNCOV 497	bool typeart_is_union(int type_id) {	×
UNCOV 498	typeart::RTGuard guard;	×
499	return typeart::RuntimeSystem::get().typeResolution.db().isUnion(type_id);	×
500	}	×
501
502	size_t typeart_get_type_size(int type_id) {	24✔
503	typeart::RTGuard guard;	24✔
504	return typeart::RuntimeSystem::get().typeResolution.db().getTypeSize(type_id);	24✔
505	}	24✔

tudasc / TypeART / 15068915155

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous