-
Notifications
You must be signed in to change notification settings - Fork 14.6k
[TableGen][DecoderEmitter] Add option to emit type-specialized code #146593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
What's the motivation? |
Please see the PR description that I just added. I also have data to support this, will add soon (tabulating it ATM) |
Failure is in the unit test (TableGen/VarLenDecoder.td), I need to update it. |
Why can't the disassembler emitter figure out the bitwidths from the tablegen input? It already makes separate tables for each instruction size. |
Oh is it because RISC-V uses 3 bit widths, but only 2 types for DecodeInstruction? |
Can we store the type in the Instruction class in the .td files like the bitwidth instead of introducing a complex command line argument? |
Right, this is POC at this which shows that the proposed optimization works. I am open to changing the interface here as well. The command line one was simple enough to not mess with tablegen instruction class etc, but that is an option, though it feels more intrusive. The command line is moderately complex and localized to the decoder emitter. |
Repeating the type per-instruction record might be redundant (and we would need more verification as well to verify for a given size, all insts of that size have the C++ type specified and its consistent). One option is to add a new InstructionTypeAndSize class that records this information, and DecoderEmitter can use that if its present else fall back to templated code. Something like
and a particular backend can define a single record of type InstructionDecoderTypeAndSizes<> which the DecoderEmitter will use. This is essentially encoding the command line option as a record.
or more simply
|
30d0838
to
2d7d1dc
Compare
RISCV uses a common base class for each of the 3 instruction sizes. Other targets may be similar.
|
Right, but nonetheless, we will have the type specified per instruction instance and we will still need to validate for example that for all instructions with a particular size, the type string is same. To me that seems unnecessary duplication of this information and then additional verification to make sure that it's consistent. Also, unlike the size in bytes, which is a core property of the instruction, its C++ type to represent its bits in memory seems not a core property. Many backends seems to choose the same type (for example uint64_t) for all their 16/32/48/64 bit insts. Adoption wise as well, sticking it in the per-inst record seems more invasive (for example, in our and several other downstream backends the core instruction records are auto-generated so the adoption curve for this increases further). |
Requesting not review per-se but opinion on the user interface for this optimization. Choices proposed are:
|
I'm probably going to change to uint64_t for RISC-V. The 48-bit instructions are only used by one vendor and are relatively recent additions. I think the duplication cost just wasn't considered when they were added. I agree adding to the Inst class might be too invasive. I still think it should be in .td files somehow. Needing to change a CMake file and replicating to GN and the other build systems when a new instruction width is added seems bad. |
Right, is the option #3 above palatable? We essentially encode it as a standalone record that the DecoderEmitter will look for. |
Maybe it should be stored in the |
…6. NFC Insn is passed to decodeInstruction which is a template function based on the type of Insn. By using uint64_t we ensure only one version of decodeInstruction is created. This reduces the file size of RISCVDisassembler.cpp.o by ~25% in my local build. This should get even more size benefit than llvm#146593.
|
2d7d1dc
to
04366ee
Compare
@topperc Please let me know if this new scheme looks ok. If yes, I'll migrate the rest of the targets (Right now I just changed AARCH64 and RISCV) to use this, and add some unit tests for a final review. |
I have not tested. My speculation is, no binary size change but just minor compile time improvement by avoiding template specialization. I'll check and report back. |
Looks like templating adds a little bit to the code size. Building the RISCVDisassembler.cpp.o in a release config with/without this change results in the following:
So, 16 bytes less. Not significant though. |
Could just be a difference in the name mangling of the function name? Or are you checking the .text size? |
yeah, your guess was right. I dumped the sizes with
That is, text sizes are the same but mangled names are different and that likely leads to larger object file sizes. |
Note though that what you did for RISCV may not be applicable/desirable for all targets. For example, AMDGPU has 128 bit instructions, so I am assuming if we just use a 128-bit type for all instructions, we may pay a penalty in terms of the bit extraction costs (32 vs 64-bit may not be as bad). |
@topperc My question is still unanswered. WDYT of this new interface to op-in into this optimization? |
Prior to this change decodeInstruction had a template parameter for the type of Insn. I was just suggesting to go back to that. |
I see. As an alternative, generate single, non-templated decodeInstruction for the widest integer type (e.g., uint64_t for RISC-V, uint32_t for ARM). This would prevent accidental instantiation of the template for different types. |
Let me try going back to a templated decodeInstruction / single copy of decodeInstruction. Note that it will have to dynamically dispatch to both decodeToMCInst and fieldFromInstruction, but that will likely help reduce the code size. A single non-templated one for the widest type is a possibility as well, but that may be a bitset<> type for some targets, like AMDGPU. In any case, we are potentially trading off some runtime decoding perf for smaller code size. The choice is whether it's in terms of always operating at the highest instruction bitwidth vs dynamic dispatch to the 2 functions above. And in either case, when we call
|
Why would we need to dynamically dispatch to fieldFromInstruction? Can't it use the same template type as decodeInstruction and just work? |
what I am thinking is: If we make the entire decodeInstruction templated, we still get code duplication when it's instantiated for each type (RISCV will just do 1 instantiation, but other targets may not). So, I am trying to implement with no templating (which also matches well with the option name). That entails an impl function that is bitwidth agnostic (this will address code size) and we will still have the per-bitwidth entry point that will just call the impl function with appropriate lambdas to encapsulate any insn specific code, which includes calls to fieldFromInstruction, decodeToMCInst, and the +ve/-ve mask checks for softfail. |
OTOH: operating at the highest bitwidth always may not be bad. Basically, we just call fieldFromInstruction on a larger bitwidth value, but that may not be as expensive as an indirect function call. And then just at the point of decodeToMCInst call, we call the version with the appropriate bitwidth and type. Given that there are no benchmarks here to measure which one is faster, we need to make a judgement call. Always doing the highest bitwidth (in decodeInstruction) might be less expensive than dynamic calls to fieldFromInstruction? So the 2 choices are essentially: decodeInstructionImpl operating at highest bitwidth, and then doing a dynamic dispatch to appropriate decodeToMCInst() with appropriate down casting, or what I suggested above, where both calls to fieldFromInstruction and decodeToMCInst are dynamic. Note that fieldFromInstruction is called both from @topperc and @s-barannikov WDYT? Am I overthinking this? |
I finally got around to prototyping this. I went with the idea that we will have a single non-templated
We still have the per-bit-width overloads of
I'll do some more testing and put this version up for review. |
96a955e
to
a08bd99
Compare
Planning to do some profiling with the new llvm-mc --runs option to see which of the above options has better decode times. I am assuming we want to err on the side of faster decoder over smaller code size (will use some tests from AMDGPU and RISCV) |
This change attempts to reduce the size of the disassembler code generated by DecoderEmitter.
Current state:
decodeInstruction
which is the entry point into the generated code anddecodeToMCInst
which is invoked when a decode op is reached in the while traversing through the decoder table. Both functions are templated onInsnType
which is the raw instruction bits that are supplied todecodeInstruction
.decodeInstruction
with different types, leading to several template instantiations of this function in the final code. As an example, AMDGPU instantiates this function with typeDecoderUInt128
type for decoding 96/128 bit instructions,uint64_t
for decoding 64-bit instructions, anduint32_t
for decoding 32-bit instructions.decodeToMCInst
generated, it has code that handles all instruction sizes. The decoders emitted for different instructions sizes rarely have any intersection with each other. That means, in the AMDGPU case, the instantiation with InsnType == DecoderUInt128 has decoder code for 32/64-bit instructions that is never exercised. Conversely, the instantiation with InsnType == uint64_t has decoder code for 128/96/32 bit instructions that is never exercised. This leads to unnecessary dead code in the generated disassembler binary.With this change, the DecoderEmitter will stop generating a single templated
decodeInstruction
and will instead generate several overloaded versions of this function and the associateddecodeToMCInst
function as well. Instead of using the templatedInsnType
, it will use an auto-inferred type which can be either a standard C++ integrer type, APInt, or a std::bitset. As a results, decoders for 32-bit instructions will appear only in the 32-bit variant ofdecodeToMCinst
and 64-bit decoders will appear only in 64-bit variant and that will fix the code duplication in the templated variant.Additionally, the
DecodeIndex
will now be computed per-instruction bitwidth as instead of being computed globally across all bitwidths in the earlier case. So, the values will generally be smaller than before and hence will consume less bytes in their ULEB128 encoding in the decoder tables, resulting in further reduction in the size of the decode tables.Since this non-templated decoder also needs some changes in the C++ code, added an option
GenerateTemplatedDecoder
toInstrInfo
that is defaulted to false, but targets can set to true to fall back to using templated code. The goal is to migrate all targets to use non-templated decoder and deprecate this option in future.Adopt this feature for the AMDGPU backend. In a release build, this results in a net 35% reduction in the .text size of libLLVMAMDGPUDisassembler.so and a 5% reduction in the .rodata size. Actual numbers measured locally for a Linux x86_64 build using clang-18.1.3 toolchain are:
For targets that do not use multiple instantiations of
decodeInstruction
, opting in into this feature may not result in code/data size improvement but potential compile time improvements by avoiding the use of templated code.