Skip to content

Commit 808caa9

Browse files
[JITLink][AArch32] Run all error unittests throug main entrypoints (#72091)
Reading implicit addend from a relocation site doesn't require a complete `LinkGraph` edge. The operation is independent from `TargetSymbol`, but constructing an `Edge` instance required one. This patch fixes the inconsistency and simplifies some setup code from the error unittests. Furthermore this patch prepares for the `Arm`/`Thumb`/`Data` helper functions to be turned into implementation details. Exposing them in the API causes unfortunate inconsistencies that we don't want to error-check all the time, e.g. passing `Thumb_Call` to `readAddendArm()`.
1 parent 0f7f8db commit 808caa9

File tree

4 files changed

+32
-64
lines changed

4 files changed

+32
-64
lines changed

llvm/include/llvm/ExecutionEngine/JITLink/aarch32.h

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -226,28 +226,30 @@ struct FixupInfo<Thumb_MovwAbsNC> : public FixupInfo<Thumb_MovtAbs> {
226226
};
227227

228228
/// Helper function to read the initial addend for Data-class relocations.
229-
Expected<int64_t> readAddendData(LinkGraph &G, Block &B, const Edge &E);
229+
Expected<int64_t> readAddendData(LinkGraph &G, Block &B, Edge::OffsetT Offset,
230+
Edge::Kind Kind);
230231

231232
/// Helper function to read the initial addend for Arm-class relocations.
232-
Expected<int64_t> readAddendArm(LinkGraph &G, Block &B, const Edge &E);
233+
Expected<int64_t> readAddendArm(LinkGraph &G, Block &B, Edge::OffsetT Offset,
234+
Edge::Kind Kind);
233235

234236
/// Helper function to read the initial addend for Thumb-class relocations.
235-
Expected<int64_t> readAddendThumb(LinkGraph &G, Block &B, const Edge &E,
236-
const ArmConfig &ArmCfg);
237+
Expected<int64_t> readAddendThumb(LinkGraph &G, Block &B, Edge::OffsetT Offset,
238+
Edge::Kind Kind, const ArmConfig &ArmCfg);
237239

238240
/// Read the initial addend for a REL-type relocation. It's the value encoded
239241
/// in the immediate field of the fixup location by the compiler.
240-
inline Expected<int64_t> readAddend(LinkGraph &G, Block &B, const Edge &E,
242+
inline Expected<int64_t> readAddend(LinkGraph &G, Block &B,
243+
Edge::OffsetT Offset, Edge::Kind Kind,
241244
const ArmConfig &ArmCfg) {
242-
Edge::Kind Kind = E.getKind();
243245
if (Kind <= LastDataRelocation)
244-
return readAddendData(G, B, E);
246+
return readAddendData(G, B, Offset, Kind);
245247

246248
if (Kind <= LastArmRelocation)
247-
return readAddendArm(G, B, E);
249+
return readAddendArm(G, B, Offset, Kind);
248250

249251
if (Kind <= LastThumbRelocation)
250-
return readAddendThumb(G, B, E, ArmCfg);
252+
return readAddendThumb(G, B, Offset, Kind, ArmCfg);
251253

252254
llvm_unreachable("Relocation must be of class Data, Arm or Thumb");
253255
}

llvm/lib/ExecutionEngine/JITLink/ELF_aarch32.cpp

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,14 +173,13 @@ class ELFLinkGraphBuilder_aarch32
173173

174174
auto FixupAddress = orc::ExecutorAddr(FixupSect.sh_addr) + Rel.r_offset;
175175
Edge::OffsetT Offset = FixupAddress - BlockToFix.getAddress();
176-
Edge E(*Kind, Offset, *GraphSymbol, 0);
177176

178177
Expected<int64_t> Addend =
179-
aarch32::readAddend(*Base::G, BlockToFix, E, ArmCfg);
178+
aarch32::readAddend(*Base::G, BlockToFix, Offset, *Kind, ArmCfg);
180179
if (!Addend)
181180
return Addend.takeError();
182181

183-
E.setAddend(*Addend);
182+
Edge E(*Kind, Offset, *GraphSymbol, *Addend);
184183
LLVM_DEBUG({
185184
dbgs() << " ";
186185
printEdge(dbgs(), BlockToFix, E, getELFAArch32EdgeKindName(*Kind));

llvm/lib/ExecutionEngine/JITLink/aarch32.cpp

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -304,12 +304,11 @@ void writeImmediate(WritableArmRelocation &R, uint32_t Imm) {
304304
R.Wd = (R.Wd & ~Mask) | Imm;
305305
}
306306

307-
Expected<int64_t> readAddendData(LinkGraph &G, Block &B, const Edge &E) {
307+
Expected<int64_t> readAddendData(LinkGraph &G, Block &B, Edge::OffsetT Offset,
308+
Edge::Kind Kind) {
308309
llvm::endianness Endian = G.getEndianness();
309-
310-
Edge::Kind Kind = E.getKind();
311310
const char *BlockWorkingMem = B.getContent().data();
312-
const char *FixupPtr = BlockWorkingMem + E.getOffset();
311+
const char *FixupPtr = BlockWorkingMem + Offset;
313312

314313
switch (Kind) {
315314
case Data_Delta32:
@@ -319,13 +318,13 @@ Expected<int64_t> readAddendData(LinkGraph &G, Block &B, const Edge &E) {
319318
return make_error<JITLinkError>(
320319
"In graph " + G.getName() + ", section " + B.getSection().getName() +
321320
" can not read implicit addend for aarch32 edge kind " +
322-
G.getEdgeKindName(E.getKind()));
321+
G.getEdgeKindName(Kind));
323322
}
324323
}
325324

326-
Expected<int64_t> readAddendArm(LinkGraph &G, Block &B, const Edge &E) {
327-
ArmRelocation R(B.getContent().data() + E.getOffset());
328-
Edge::Kind Kind = E.getKind();
325+
Expected<int64_t> readAddendArm(LinkGraph &G, Block &B, Edge::OffsetT Offset,
326+
Edge::Kind Kind) {
327+
ArmRelocation R(B.getContent().data() + Offset);
329328

330329
switch (Kind) {
331330
case Arm_Call:
@@ -352,14 +351,13 @@ Expected<int64_t> readAddendArm(LinkGraph &G, Block &B, const Edge &E) {
352351
return make_error<JITLinkError>(
353352
"In graph " + G.getName() + ", section " + B.getSection().getName() +
354353
" can not read implicit addend for aarch32 edge kind " +
355-
G.getEdgeKindName(E.getKind()));
354+
G.getEdgeKindName(Kind));
356355
}
357356
}
358357

359-
Expected<int64_t> readAddendThumb(LinkGraph &G, Block &B, const Edge &E,
360-
const ArmConfig &ArmCfg) {
361-
ThumbRelocation R(B.getContent().data() + E.getOffset());
362-
Edge::Kind Kind = E.getKind();
358+
Expected<int64_t> readAddendThumb(LinkGraph &G, Block &B, Edge::OffsetT Offset,
359+
Edge::Kind Kind, const ArmConfig &ArmCfg) {
360+
ThumbRelocation R(B.getContent().data() + Offset);
363361

364362
switch (Kind) {
365363
case Thumb_Call:
@@ -394,7 +392,7 @@ Expected<int64_t> readAddendThumb(LinkGraph &G, Block &B, const Edge &E,
394392
return make_error<JITLinkError>(
395393
"In graph " + G.getName() + ", section " + B.getSection().getName() +
396394
" can not read implicit addend for aarch32 edge kind " +
397-
G.getEdgeKindName(E.getKind()));
395+
G.getEdgeKindName(Kind));
398396
}
399397
}
400398

llvm/unittests/ExecutionEngine/JITLink/AArch32ErrorTests.cpp

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -44,32 +44,16 @@ TEST(AArch32_ELF, readAddendArmErrors) {
4444
sizeof(ArmWord));
4545
auto &BArm = G->createContentBlock(Sec, ArmContent, B1DummyAddr, ArmAlignment,
4646
AlignmentOffset);
47-
Symbol &TargetSymbol =
48-
G->addAnonymousSymbol(BArm, SymbolOffset, SymbolSize, false, false);
49-
Edge InvalidEdge(Edge::GenericEdgeKind::Invalid, 0 /*Offset*/, TargetSymbol,
50-
0 /*Addend*/);
51-
52-
// Edge kind is tested, block itself is not significant here. So it is tested
53-
// once in Arm
54-
EXPECT_THAT_EXPECTED(readAddendData(*G, BArm, InvalidEdge),
55-
FailedWithMessage(testing::HasSubstr(
56-
"can not read implicit addend for aarch32 edge kind "
57-
"INVALID RELOCATION")));
58-
59-
EXPECT_THAT_EXPECTED(readAddendArm(*G, BArm, InvalidEdge),
60-
FailedWithMessage(testing::HasSubstr(
61-
"can not read implicit addend for aarch32 edge kind "
62-
"INVALID RELOCATION")));
47+
Edge::Kind Invalid = Edge::GenericEdgeKind::Invalid;
6348

64-
EXPECT_THAT_EXPECTED(readAddendThumb(*G, BArm, InvalidEdge, ArmCfg),
49+
EXPECT_THAT_EXPECTED(readAddend(*G, BArm, SymbolOffset, Invalid, ArmCfg),
6550
FailedWithMessage(testing::HasSubstr(
6651
"can not read implicit addend for aarch32 edge kind "
6752
"INVALID RELOCATION")));
6853

6954
for (Edge::Kind K = FirstArmRelocation; K < LastArmRelocation; K += 1) {
70-
Edge E(K, 0, TargetSymbol, 0);
7155
EXPECT_THAT_EXPECTED(
72-
readAddendArm(*G, BArm, E),
56+
readAddend(*G, BArm, SymbolOffset, K, ArmCfg),
7357
FailedWithMessage(testing::StartsWith("Invalid opcode")));
7458
}
7559
}
@@ -90,15 +74,10 @@ TEST(AArch32_ELF, readAddendThumbErrors) {
9074
sizeof(ThumbHalfWords));
9175
auto &BThumb = G->createContentBlock(Sec, ThumbContent, B2DummyAddr,
9276
ThumbAlignment, AlignmentOffset);
93-
Symbol &TargetSymbol =
94-
G->addAnonymousSymbol(BThumb, SymbolOffset, SymbolSize, false, false);
95-
Edge InvalidEdge(Edge::GenericEdgeKind::Invalid, 0 /*Offset*/, TargetSymbol,
96-
0 /*Addend*/);
9777

9878
for (Edge::Kind K = FirstThumbRelocation; K < LastThumbRelocation; K += 1) {
99-
Edge E(K, 0, TargetSymbol, 0);
10079
EXPECT_THAT_EXPECTED(
101-
readAddendThumb(*G, BThumb, E, ArmCfg),
80+
readAddend(*G, BThumb, SymbolOffset, K, ArmCfg),
10281
FailedWithMessage(testing::StartsWith("Invalid opcode")));
10382
}
10483
}
@@ -119,24 +98,14 @@ TEST(AArch32_ELF, applyFixupArmErrors) {
11998
Edge InvalidEdge(Edge::GenericEdgeKind::Invalid, 0 /*Offset*/, TargetSymbol,
12099
0 /*Addend*/);
121100

122-
// Edge kind is tested, block itself is not significant here. So it is tested
123-
// once in Arm
124-
EXPECT_THAT_ERROR(
125-
applyFixupData(*G, BArm, InvalidEdge),
126-
FailedWithMessage(testing::HasSubstr(
127-
"encountered unfixable aarch32 edge kind INVALID RELOCATION")));
128-
EXPECT_THAT_ERROR(
129-
applyFixupArm(*G, BArm, InvalidEdge),
130-
FailedWithMessage(testing::HasSubstr(
131-
"encountered unfixable aarch32 edge kind INVALID RELOCATION")));
132101
EXPECT_THAT_ERROR(
133-
applyFixupThumb(*G, BArm, InvalidEdge, ArmCfg),
102+
applyFixup(*G, BArm, InvalidEdge, ArmCfg),
134103
FailedWithMessage(testing::HasSubstr(
135104
"encountered unfixable aarch32 edge kind INVALID RELOCATION")));
136105

137106
for (Edge::Kind K = FirstArmRelocation; K < LastArmRelocation; K += 1) {
138107
Edge E(K, 0, TargetSymbol, 0);
139-
EXPECT_THAT_ERROR(applyFixupArm(*G, BArm, E),
108+
EXPECT_THAT_ERROR(applyFixup(*G, BArm, E, ArmCfg),
140109
FailedWithMessage(testing::AllOf(
141110
testing::StartsWith("Invalid opcode"),
142111
testing::EndsWith(G->getEdgeKindName(K)))));
@@ -177,7 +146,7 @@ TEST(AArch32_ELF, applyFixupThumbErrors) {
177146

178147
for (Edge::Kind K = FirstThumbRelocation; K < LastThumbRelocation; K += 1) {
179148
Edge E(K, 0, TargetSymbol, 0);
180-
EXPECT_THAT_ERROR(applyFixupThumb(*G, BThumb, E, ArmCfg),
149+
EXPECT_THAT_ERROR(applyFixup(*G, BThumb, E, ArmCfg),
181150
FailedWithMessage(testing::AllOf(
182151
testing::StartsWith("Invalid opcode"),
183152
testing::EndsWith(G->getEdgeKindName(K)))));

0 commit comments

Comments
 (0)