/usr/include/llvm-3.9/llvm/Object/StackMapParser.h is in llvm-3.9-dev 1:3.9.1-19ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | //===-------- StackMapParser.h - StackMap Parsing Support -------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CODEGEN_STACKMAPPARSER_H
#define LLVM_CODEGEN_STACKMAPPARSER_H
#include "llvm/ADT/ArrayRef.h"
#include "llvm/Support/Endian.h"
#include <vector>
namespace llvm {
template <support::endianness Endianness>
class StackMapV1Parser {
public:
template <typename AccessorT>
class AccessorIterator {
public:
AccessorIterator(AccessorT A) : A(A) {}
AccessorIterator& operator++() { A = A.next(); return *this; }
AccessorIterator operator++(int) {
auto tmp = *this;
++*this;
return tmp;
}
bool operator==(const AccessorIterator &Other) {
return A.P == Other.A.P;
}
bool operator!=(const AccessorIterator &Other) { return !(*this == Other); }
AccessorT& operator*() { return A; }
AccessorT* operator->() { return &A; }
private:
AccessorT A;
};
/// Accessor for function records.
class FunctionAccessor {
friend class StackMapV1Parser;
public:
/// Get the function address.
uint64_t getFunctionAddress() const {
return read<uint64_t>(P);
}
/// Get the function's stack size.
uint32_t getStackSize() const {
return read<uint64_t>(P + sizeof(uint64_t));
}
private:
FunctionAccessor(const uint8_t *P) : P(P) {}
const static int FunctionAccessorSize = 2 * sizeof(uint64_t);
FunctionAccessor next() const {
return FunctionAccessor(P + FunctionAccessorSize);
}
const uint8_t *P;
};
/// Accessor for constants.
class ConstantAccessor {
friend class StackMapV1Parser;
public:
/// Return the value of this constant.
uint64_t getValue() const { return read<uint64_t>(P); }
private:
ConstantAccessor(const uint8_t *P) : P(P) {}
const static int ConstantAccessorSize = sizeof(uint64_t);
ConstantAccessor next() const {
return ConstantAccessor(P + ConstantAccessorSize);
}
const uint8_t *P;
};
// Forward-declare RecordAccessor so we can friend it below.
class RecordAccessor;
enum class LocationKind : uint8_t {
Register = 1, Direct = 2, Indirect = 3, Constant = 4, ConstantIndex = 5
};
/// Accessor for location records.
class LocationAccessor {
friend class StackMapV1Parser;
friend class RecordAccessor;
public:
/// Get the Kind for this location.
LocationKind getKind() const {
return LocationKind(P[KindOffset]);
}
/// Get the Dwarf register number for this location.
uint16_t getDwarfRegNum() const {
return read<uint16_t>(P + DwarfRegNumOffset);
}
/// Get the small-constant for this location. (Kind must be Constant).
uint32_t getSmallConstant() const {
assert(getKind() == LocationKind::Constant && "Not a small constant.");
return read<uint32_t>(P + SmallConstantOffset);
}
/// Get the constant-index for this location. (Kind must be ConstantIndex).
uint32_t getConstantIndex() const {
assert(getKind() == LocationKind::ConstantIndex &&
"Not a constant-index.");
return read<uint32_t>(P + SmallConstantOffset);
}
/// Get the offset for this location. (Kind must be Direct or Indirect).
int32_t getOffset() const {
assert((getKind() == LocationKind::Direct ||
getKind() == LocationKind::Indirect) &&
"Not direct or indirect.");
return read<int32_t>(P + SmallConstantOffset);
}
private:
LocationAccessor(const uint8_t *P) : P(P) {}
LocationAccessor next() const {
return LocationAccessor(P + LocationAccessorSize);
}
static const int KindOffset = 0;
static const int DwarfRegNumOffset = KindOffset + sizeof(uint16_t);
static const int SmallConstantOffset = DwarfRegNumOffset + sizeof(uint16_t);
static const int LocationAccessorSize = sizeof(uint64_t);
const uint8_t *P;
};
/// Accessor for stackmap live-out fields.
class LiveOutAccessor {
friend class StackMapV1Parser;
friend class RecordAccessor;
public:
/// Get the Dwarf register number for this live-out.
uint16_t getDwarfRegNum() const {
return read<uint16_t>(P + DwarfRegNumOffset);
}
/// Get the size in bytes of live [sub]register.
unsigned getSizeInBytes() const {
return read<uint8_t>(P + SizeOffset);
}
private:
LiveOutAccessor(const uint8_t *P) : P(P) {}
LiveOutAccessor next() const {
return LiveOutAccessor(P + LiveOutAccessorSize);
}
static const int DwarfRegNumOffset = 0;
static const int SizeOffset =
DwarfRegNumOffset + sizeof(uint16_t) + sizeof(uint8_t);
static const int LiveOutAccessorSize = sizeof(uint32_t);
const uint8_t *P;
};
/// Accessor for stackmap records.
class RecordAccessor {
friend class StackMapV1Parser;
public:
typedef AccessorIterator<LocationAccessor> location_iterator;
typedef AccessorIterator<LiveOutAccessor> liveout_iterator;
/// Get the patchpoint/stackmap ID for this record.
uint64_t getID() const {
return read<uint64_t>(P + PatchpointIDOffset);
}
/// Get the instruction offset (from the start of the containing function)
/// for this record.
uint32_t getInstructionOffset() const {
return read<uint32_t>(P + InstructionOffsetOffset);
}
/// Get the number of locations contained in this record.
uint16_t getNumLocations() const {
return read<uint16_t>(P + NumLocationsOffset);
}
/// Get the location with the given index.
LocationAccessor getLocation(unsigned LocationIndex) const {
unsigned LocationOffset =
LocationListOffset + LocationIndex * LocationSize;
return LocationAccessor(P + LocationOffset);
}
/// Begin iterator for locations.
location_iterator location_begin() const {
return location_iterator(getLocation(0));
}
/// End iterator for locations.
location_iterator location_end() const {
return location_iterator(getLocation(getNumLocations()));
}
/// Iterator range for locations.
iterator_range<location_iterator> locations() const {
return make_range(location_begin(), location_end());
}
/// Get the number of liveouts contained in this record.
uint16_t getNumLiveOuts() const {
return read<uint16_t>(P + getNumLiveOutsOffset());
}
/// Get the live-out with the given index.
LiveOutAccessor getLiveOut(unsigned LiveOutIndex) const {
unsigned LiveOutOffset =
getNumLiveOutsOffset() + sizeof(uint16_t) + LiveOutIndex * LiveOutSize;
return LiveOutAccessor(P + LiveOutOffset);
}
/// Begin iterator for live-outs.
liveout_iterator liveouts_begin() const {
return liveout_iterator(getLiveOut(0));
}
/// End iterator for live-outs.
liveout_iterator liveouts_end() const {
return liveout_iterator(getLiveOut(getNumLiveOuts()));
}
/// Iterator range for live-outs.
iterator_range<liveout_iterator> liveouts() const {
return make_range(liveouts_begin(), liveouts_end());
}
private:
RecordAccessor(const uint8_t *P) : P(P) {}
unsigned getNumLiveOutsOffset() const {
return LocationListOffset + LocationSize * getNumLocations() +
sizeof(uint16_t);
}
unsigned getSizeInBytes() const {
unsigned RecordSize =
getNumLiveOutsOffset() + sizeof(uint16_t) + getNumLiveOuts() * LiveOutSize;
return (RecordSize + 7) & ~0x7;
}
RecordAccessor next() const {
return RecordAccessor(P + getSizeInBytes());
}
static const unsigned PatchpointIDOffset = 0;
static const unsigned InstructionOffsetOffset =
PatchpointIDOffset + sizeof(uint64_t);
static const unsigned NumLocationsOffset =
InstructionOffsetOffset + sizeof(uint32_t) + sizeof(uint16_t);
static const unsigned LocationListOffset =
NumLocationsOffset + sizeof(uint16_t);
static const unsigned LocationSize = sizeof(uint64_t);
static const unsigned LiveOutSize = sizeof(uint32_t);
const uint8_t *P;
};
/// Construct a parser for a version-1 stackmap. StackMap data will be read
/// from the given array.
StackMapV1Parser(ArrayRef<uint8_t> StackMapSection)
: StackMapSection(StackMapSection) {
ConstantsListOffset = FunctionListOffset + getNumFunctions() * FunctionSize;
assert(StackMapSection[0] == 1 &&
"StackMapV1Parser can only parse version 1 stackmaps");
unsigned CurrentRecordOffset =
ConstantsListOffset + getNumConstants() * ConstantSize;
for (unsigned I = 0, E = getNumRecords(); I != E; ++I) {
StackMapRecordOffsets.push_back(CurrentRecordOffset);
CurrentRecordOffset +=
RecordAccessor(&StackMapSection[CurrentRecordOffset]).getSizeInBytes();
}
}
typedef AccessorIterator<FunctionAccessor> function_iterator;
typedef AccessorIterator<ConstantAccessor> constant_iterator;
typedef AccessorIterator<RecordAccessor> record_iterator;
/// Get the version number of this stackmap. (Always returns 1).
unsigned getVersion() const { return 1; }
/// Get the number of functions in the stack map.
uint32_t getNumFunctions() const {
return read<uint32_t>(&StackMapSection[NumFunctionsOffset]);
}
/// Get the number of large constants in the stack map.
uint32_t getNumConstants() const {
return read<uint32_t>(&StackMapSection[NumConstantsOffset]);
}
/// Get the number of stackmap records in the stackmap.
uint32_t getNumRecords() const {
return read<uint32_t>(&StackMapSection[NumRecordsOffset]);
}
/// Return an FunctionAccessor for the given function index.
FunctionAccessor getFunction(unsigned FunctionIndex) const {
return FunctionAccessor(StackMapSection.data() +
getFunctionOffset(FunctionIndex));
}
/// Begin iterator for functions.
function_iterator functions_begin() const {
return function_iterator(getFunction(0));
}
/// End iterator for functions.
function_iterator functions_end() const {
return function_iterator(
FunctionAccessor(StackMapSection.data() +
getFunctionOffset(getNumFunctions())));
}
/// Iterator range for functions.
iterator_range<function_iterator> functions() const {
return make_range(functions_begin(), functions_end());
}
/// Return the large constant at the given index.
ConstantAccessor getConstant(unsigned ConstantIndex) const {
return ConstantAccessor(StackMapSection.data() +
getConstantOffset(ConstantIndex));
}
/// Begin iterator for constants.
constant_iterator constants_begin() const {
return constant_iterator(getConstant(0));
}
/// End iterator for constants.
constant_iterator constants_end() const {
return constant_iterator(
ConstantAccessor(StackMapSection.data() +
getConstantOffset(getNumConstants())));
}
/// Iterator range for constants.
iterator_range<constant_iterator> constants() const {
return make_range(constants_begin(), constants_end());
}
/// Return a RecordAccessor for the given record index.
RecordAccessor getRecord(unsigned RecordIndex) const {
std::size_t RecordOffset = StackMapRecordOffsets[RecordIndex];
return RecordAccessor(StackMapSection.data() + RecordOffset);
}
/// Begin iterator for records.
record_iterator records_begin() const {
if (getNumRecords() == 0)
return record_iterator(RecordAccessor(nullptr));
return record_iterator(getRecord(0));
}
/// End iterator for records.
record_iterator records_end() const {
// Records need to be handled specially, since we cache the start addresses
// for them: We can't just compute the 1-past-the-end address, we have to
// look at the last record and use the 'next' method.
if (getNumRecords() == 0)
return record_iterator(RecordAccessor(nullptr));
return record_iterator(getRecord(getNumRecords() - 1).next());
}
/// Iterator range for records.
iterator_range<record_iterator> records() const {
return make_range(records_begin(), records_end());
}
private:
template <typename T>
static T read(const uint8_t *P) {
return support::endian::read<T, Endianness, 1>(P);
}
static const unsigned HeaderOffset = 0;
static const unsigned NumFunctionsOffset = HeaderOffset + sizeof(uint32_t);
static const unsigned NumConstantsOffset = NumFunctionsOffset + sizeof(uint32_t);
static const unsigned NumRecordsOffset = NumConstantsOffset + sizeof(uint32_t);
static const unsigned FunctionListOffset = NumRecordsOffset + sizeof(uint32_t);
static const unsigned FunctionSize = 2 * sizeof(uint64_t);
static const unsigned ConstantSize = sizeof(uint64_t);
std::size_t getFunctionOffset(unsigned FunctionIndex) const {
return FunctionListOffset + FunctionIndex * FunctionSize;
}
std::size_t getConstantOffset(unsigned ConstantIndex) const {
return ConstantsListOffset + ConstantIndex * ConstantSize;
}
ArrayRef<uint8_t> StackMapSection;
unsigned ConstantsListOffset;
std::vector<unsigned> StackMapRecordOffsets;
};
}
#endif
|