This is an archive of the discontinued LLVM Phabricator instance.

[lld][WebAssembly] Allow element sections for nonzero table numbers
ClosedPublic

Authored by wingo on Nov 30 2020, 6:29 AM.

Details

Summary

This patch fixes LLD to allow element sections for tables whose number
is nonzero. We also add a test for linking multiple tables, showing
that nonzero table numbers for the indirect function table,
user-declared imported tables, and local user table definitions work.

Diff Detail

Event Timeline

wingo created this revision.Nov 30 2020, 6:29 AM
Herald added a project: Restricted Project. · View Herald TranscriptNov 30 2020, 6:29 AM
wingo requested review of this revision.Nov 30 2020, 6:29 AM
wingo updated this revision to Diff 314536.Jan 5 2021, 1:47 AM

Copy/paste GetOrCreateFunctionTableSymbol into WebAssemblyAsmParser

wingo updated this revision to Diff 314537.Jan 5 2021, 1:48 AM

Revert change to incorrect changeset

wingo updated this revision to Diff 317483.Jan 19 2021, 1:22 AM

Address clang-format nits

wingo added a comment.Jan 19 2021, 1:28 AM

OK let's do this! This one finally makes multi-table linking work as it should, and includes what i think is a reasonably thorough test.

wingo updated this revision to Diff 317554.Jan 19 2021, 7:00 AM

Fix typo introduced while addressing clang-format nits

wingo updated this revision to Diff 323966.Feb 16 2021, 5:35 AM

Rebase and adapt test for latest [+-]reference-types expectations

This one is ready for review. +tlively for a second eye on how the expected behavior should work (see lld/test/wasm/multi-table.s).

sbc100 added inline comments.Feb 16 2021, 7:54 AM
lld/wasm/SyntheticSections.cpp
450

This flag is never set so this is dead code isn't it?

I'm guessing that when we add actual multi table here we will still want to separate the linker-synthetic indirectFunctionTable from other tables that are composed of actual input segments, so I'm not sure it makes since to make this code too generic here.

llvm/include/llvm/ObjectYAML/WasmYAML.h
68

It would be nice to see all of the non-linker parts of this change tested by llvm/test/MC/WebAssembly/tables.s.

However, I IIRC, the reason that might be hard today is that we don't support declaring elements in the assembly syntax. Perhaps we should take should figure out how that will work so we can land the core part here without depending on the linker to test them?

llvm/lib/MC/WasmObjectWriter.cpp
923

Might as well use if (TableNumber) again here for consistency with above.

936

This is dead code no? Since that flag cannot be set?

In fact all these changes to writeElemSection look unused (and therefore untested), perhaps we can split this out and make it part of a future PR?

wingo added inline comments.Feb 17 2021, 1:42 AM
llvm/lib/MC/WasmObjectWriter.cpp
936

So the tableNumber changes above are definitely used and tested. Definitely possible to have non-zero table numbers for the indirect function table. I could remove this HAS_ELEM_KIND bit here but let me push back gently -- we would like to test that this output is spec-conforming and also that it "makes" sense" from a LLVM point of view (e.g. can round trip through tables.s). But the former is more important than the latter. By structuring this function to look more like the [binary spec]((https://webassembly.github.io/reference-types/core/binary/modules.html#binary-elemsec)) -- e.g. checking the HAS_TABLE_NUMBER flag instead of checking TableNumber -- I have greater confidence reading the code that it does what the spec says.

sbc100 added inline comments.Feb 18 2021, 7:27 AM
llvm/lib/MC/WasmObjectWriter.cpp
936

Sure, I don't really care if you check TableNumber of HAS_TABLE_NUMBER above.

But these six lines seems compltely pointless and in fact that are dead code right? This function doesn't write arbitrary tables it *only* writes the special __indirect_function_table (at least today). Can that ever have an ElemKind?

wingo added inline comments.Mar 2 2021, 6:38 AM
lld/wasm/SyntheticSections.cpp
425

This assertion fails for the bsymbolic test; see https://bugs.llvm.org/show_bug.cgi?id=49397.

wingo updated this revision to Diff 327437.Mar 2 2021, 6:39 AM

Address feedback; bsymbolic test still failing

sbc100 added inline comments.Mar 2 2021, 7:21 AM
lld/wasm/SyntheticSections.cpp
450

I still think this block should be completely removed. This method exists only for writing the indirectFunctionTable which by definition does not have this flag and does need this code block. If we ever change the type of indirectFunctionTable we can change this function.

When we add a method for writing a generic element section it most likely won't be a SyntheticSections like this one is but one that is made up of InputChunk.. that method will want to be more generic but I don't see why this one should be.

llvm/lib/MC/WasmObjectWriter.cpp
908

How about moving the assert below the early return and changing it to just assert(IndirectFunctionTable)

917

This cast looks redundant maybe?

1846

llvm policy it to avoid using auto on the left unless the type is completely obvious (e.g. already stated on the same line): https://llvm.org/docs/CodingStandards.html#use-auto-type-deduction-to-make-code-more-readable

1847

I wonder if

wingo added inline comments.Mar 2 2021, 7:48 AM
lld/wasm/SyntheticSections.cpp
450

Aaah yes I had removed it locally; I think I must have fat-fingered the "arc diff". Tx for sharp eye.

wingo marked 9 inline comments as done.Mar 3 2021, 2:49 AM
wingo added inline comments.
lld/wasm/SyntheticSections.cpp
450

As noted below, this isn't dead code at all. You have to write the elem kind if the table number is nonzero. LMK your thoughts here.

llvm/lib/MC/WasmObjectWriter.cpp
936

Paging this back in -- this code was not dead. See the definition for WASM_ELEM_SEGMENT_HAS_ELEM_KIND. I have restored it here. WDYT?

wingo updated this revision to Diff 327731.Mar 3 2021, 2:49 AM
wingo marked an inline comment as done.

Address feedback

sbc100 added inline comments.Mar 3 2021, 7:09 AM
llvm/include/llvm/ObjectYAML/WasmYAML.h
68

I'd still think it would be good to see at least one llvm-side test (not just the lld integration test) test for this code.

llvm/lib/MC/WasmObjectWriter.cpp
936

Paging this back in -- this code was not dead. See the definition for WASM_ELEM_SEGMENT_HAS_ELEM_KIND. I have restored it here. WDYT?

Oh I see.. WASM_ELEM_SEGMENT_HAS_ELEM_KIND is defined as ~SOME_OTHER_FLAG.. that seem odd at best. Perhaps better write to little helper function elemSegmentNeedsElemKind() rather than trying to make that part of the enum? Otherwise folks will think that WASM_ELEM_SEGMENT_HAS_ELEM_KIND is just another flag they can | together. Either that or maybe add MASK to its name and take it out of the enum with the others.

It looks like WASM_ELEM_SEGMENT_HAS_ELEM_KIND is basically PASSIVE | HAS_TABLE_NUMBER ... maybe its more clear to just write that out here?

wingo retitled this revision from [WebAssembly] Allow element sections for nonzero table numbers to [lld][WebAssembly] Allow element sections for nonzero table numbers.Mar 4 2021, 1:53 AM
wingo edited the summary of this revision. (Show Details)
wingo updated this revision to Diff 328083.Mar 4 2021, 2:09 AM

Add _MASK to HAS_ELEM_KIND name

sbc100 accepted this revision.Mar 4 2021, 7:55 AM
This revision is now accepted and ready to land.Mar 4 2021, 7:55 AM