llvm dev - Dec 2015 - How do I get ABI information to a subclass of MCELFObjectTargetWriter::GetLocType?

I am implementing a defined, but currently unimplemented by LLVM, ABI. This ABI
differs from an existing ABI in its ELF object format by implementing a subset
of an existing ABI, but encoded differently and by setting the e_ident EI_CLASS
field. I am trying to use MCTargetOptions::getABIName to set a boolean in the
modified subclass of MCELFObjectTargetWriter to indicate which relocation
encoding to use. As far as I can determine by source examination and judicious
use of a debugger there isn't a simple path from the command line and the
setting of ABIname in MCTargetOptions to where an instance of a subclass of
MCELFObjectTargetWriter is created.
I looked at the approach taken by both Mips and X86 for implementing ILP32 and
neither seems applicable. For x86 x32, there is the combination of IsELF64 ==
false and OSABI == EM_X86_64, but that doesn't seem applicable, as the ELF
e_machine field is the same for the existing and the new ABI. For Mips N32, code
and state in MCELFObjectTargetWriter seems to take care of mapping the
relocation values and the ELF e_flags bit EF_MIPS_ABI_ON32 is set.
I'm trying to implement the AArch64 ILP32 ELF ABI.Ideally, I'd like to
be able to create a modified version of AArch64ELFObjectWriter so that its
GerRelocType method can choose which relocation encoding to use based upon what
was specified on the command line. Should I make up a new OSABI enum value? Do
some kind of manipulation of the Triple environment field to set it based upon
the value of "-mabi="?
ARM64 ELF  Reference with ILP32 information:http://infocenter.arm.com/
help/topic/com.arm.doc. ihi0056c/IHI0056C_beta_ aaelf64.pdf
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20151215/70016671/attachment.html>

Hi Anson,

I've been working on similar problems in MIPS. We have several problems with
the same root cause but the most relevant is that our N32 ABI implementation
behaves too much like N64. We get lots of important N32 details wrong with one
of the biggest being that we get the wrong EI_CLASS because we derive it from
the triple and not the ABI (which is currently unavailable to the relevant
object).

I have three patches that make a start on a general solution for this kind of
problem (http://reviews.llvm.org/D13858, http://reviews.llvm.org/D13860, and
http://reviews.llvm.org/D13863). The overall intent is that we create an
MCTargetMachine that describes the desired target (taking into account the
default ABI for the triple and any options that change it) and use it as a
factory for the MC layer objects. This way we can pass relevant detail down to
the MC objects without having to have all targets agree on what information
should be provided to each object. This mechanism can then be extended to other
target-specific detail as needed.

This mechanism also provides the groundwork to solve the Triple ambiguity
problem (see http://lists.llvm.org/pipermail/llvm-dev/2015-July/087700.html)
that most targets have to some degree but ARM and MIPS particularly suffer from.
This problem isn't limited to the MC layer, it also causes problems with
CodeGen and compatibility with GCC (differences in default option values, etc.).

My work in this area has been in review in since July and there have been no
commits yet so I've recently been considering adding MCTargetOptions to some
of the createMC*() functions as stop-gap measure to get some of the bugs fixed
sooner. I'll still need to fix the triple ambiguity problem properly to
avoid releasing multiple single-target clang toolchains (which I'm very keen
to avoid doing but I don't have much choice as things stand) but it at least
lets me improve matters.

By the way, you'll find that some paths through clang use the default
constructor of MCTargetOptions and therefore neglect to set
MCTargetOptions::ABIName. I was planning to fix this once I had the backend side
of things working.
> Should I make up a new OSABI enum value? Do some kind of manipulation of
the Triple environment field to set it based upon the value of
"-mabi="?
Both of those approaches would work and are similar to Debian's concept of
Multiarch Tuples.

My original TargetTuple solution was somewhat similar in principle but
unfortunately was not accepted. In the TargetTuple solution, I was trying to
introduce a boundary between the world of GNU Triples and the world of LLVM
Target Descriptions. At the moment llvm::Triple is responsible for interpreting
GNU Triples and being a target description within LLVM. So in the TargetTuple
solution, llvm::Triple parsed the triple and was then used to initialize a more
detailed, unambiguous, and authoritative target description in
llvm::TargetTuple. Command line arguments then modified the TargetTuple after
which it was passed to the backend instead of llvm::Triple.

It will be interesting to see what answers you get here. Personally, I was
avoiding inventing values in the llvm::Triple enums because MIPS needs to convey
information that is only implied by the triple (and therefore needed new member
variables) and/or differs between linux distributions, and also because I
thought that separating the GNU Triple parser and the resulting target
description was a good thing to do. However, if there's some agreement that
this is the right thing to do then I can rethink my plan and find some way to
encode what I need in one of these fields.

From: llvm-dev [mailto:llvm-dev-bounces at lists.llvm.org] On Behalf Of Anson
MacDonald via llvm-dev
Sent: 15 December 2015 22:58
To: llvm-dev at lists.llvm.org
Subject: [llvm-dev] How do I get ABI information to a subclass of
MCELFObjectTargetWriter::GetLocType?

I am implementing a defined, but currently unimplemented by LLVM, ABI. This ABI
differs from an existing ABI in its ELF object format by implementing a subset
of an existing ABI, but encoded differently and by setting the e_ident EI_CLASS
field. I am trying to use MCTargetOptions::getABIName to set a boolean in the
modified subclass of MCELFObjectTargetWriter to indicate which relocation
encoding to use. As far as I can determine by source examination and judicious
use of a debugger there isn't a simple path from the command line and the
setting of ABIname in MCTargetOptions to where an instance of a subclass of
MCELFObjectTargetWriter is created.

I looked at the approach taken by both Mips and X86 for implementing ILP32 and
neither seems applicable. For x86 x32, there is the combination of IsELF64 ==
false and OSABI == EM_X86_64, but that doesn't seem applicable, as the ELF
e_machine field is the same for the existing and the new ABI. For Mips N32, code
and state in MCELFObjectTargetWriter seems to take care of mapping the
relocation values and the ELF e_flags bit EF_MIPS_ABI_ON32 is set.

I'm trying to implement the AArch64 ILP32 ELF ABI.Ideally, I'd like to
be able to create a modified version of AArch64ELFObjectWriter so that its
GerRelocType method can choose which relocation encoding to use based upon what
was specified on the command line. Should I make up a new OSABI enum value? Do
some kind of manipulation of the Triple environment field to set it based upon
the value of "-mabi="?

ARM64 ELF  Reference with ILP32 information:
http://infocenter.arm.com/ help/topic/com.arm.doc. ihi0056c/IHI0056C_beta_
aaelf64.pdf<http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056c/IHI0056C_beta_aaelf64.pdf>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20151217/23d4b2f3/attachment.html>

Daniel: Thanks for your detailed response. I had seen the discussion from
earlier this year, but when I read it, I didn't expect it would be so
difficult to get just one bit of information where I wanted it. :-) Thanks for
the heads up about clang not necessarily setting ABIname. I have at least enough
of that working already that I can generate the appropriate assembly source.


After doing a little more investigation, I decided to take an approach that
seems simpler than yours, as I'm only trying to solve my own problem. It
relies on having things lower in the MC layer be able to query MCTargetOptions.
This is my plan:

Make a path from the callers of Target::createAsmBackend to get MCTargetOptions
to the MCELFObjectTargetWriter subclass or some method in the creation chain:

<client, e.g. llvm-mc> 
  -> Target::createAsmBackend(..., MCTargetOptions)
    -> (*MCAsmBackendCtorFn)(..., MCTargetOptions)
      -> <MCAsmBackend subclass constructor wanting options>(...,
MCTargetOptions)
         adds MCTargetOptions to the MCAsmBackend subclass state or the bits
needed
<MCAsmBackend subclass wanting options>::createObjectWriter(...)
  -> create<foo>ObjectWriter(..., added information)
    -> <foo>ObjectWriter::<foo>ObjectWriter(..., added
information)
       sets added state based on constructor args, in my case the ABI, IsILP32
<foo>ObjectWriter::GetRelocType(...)
  use state to guide which relocations are generated

I don't know if the object lifetime of MCTargetOptions allows a reference to
be kept around, so the information extraction in the MCAsmBackend subclass
constructor may be required.

Anson
On Thursday, December 17, 2015 6:30 AM, Daniel Sanders <Daniel.Sanders at
imgtec.com> wrote:



Hi Anson,
 
I've been working on similar problems in MIPS. We have several problems with
the same root cause but the most relevant is that our N32 ABI implementation
behaves too much like N64. We get lots of important N32 details wrong with one
of the biggest being that we get the wrong EI_CLASS because we derive it from
the triple and not the ABI (which is currently unavailable to the relevant
object).
 
I have three patches that make a start on a general solution for this kind of
problem (http://reviews.llvm.org/D13858, http://reviews.llvm.org/D13860, and
http://reviews.llvm.org/D13863). The overall intent is that we create an
MCTargetMachine that describes the desired target (taking into account the
default ABI for the triple and any options that change it) and use it as a
factory for the MC layer objects. This way we can pass relevant detail down to
the MC objects without having to have all targets agree on what information
should be provided to each object. This mechanism can then be extended to other
target-specific detail as needed.
 
This mechanism also provides the groundwork to solve the Triple ambiguity
problem (see http://lists.llvm.org/pipermail/llvm-dev/2015-July/087700.html)
that most targets have to some degree but ARM and MIPS particularly suffer from.
This problem isn't limited to the MC layer, it also causes problems with
CodeGen and compatibility with GCC (differences in default option values, etc.).
 
My work in this area has been in review in since July and there have been no
commits yet so I've recently been considering adding MCTargetOptions to some
of the createMC*() functions as stop-gap measure to get some of the bugs fixed
sooner. I'll still need to fix the triple ambiguity problem properly to
avoid releasing multiple single-target clang toolchains (which I'm very keen
to avoid doing but I don't have much choice as things stand) but it at least
lets me improve matters.
 
By the way, you'll find that some paths through clang use the default
constructor of MCTargetOptions and therefore neglect to set
MCTargetOptions::ABIName. I was planning to fix this once I had the backend side
of things working.
 
> Should I make up a new OSABI enum value? Do some kind of manipulation of
the Triple environment field to set it based upon the value of
"-mabi="?
 
Both of those approaches would work and are similar to Debian's concept of
Multiarch Tuples.
 
My original TargetTuple solution was somewhat similar in principle but
unfortunately was not accepted. In the TargetTuple solution, I was trying to
introduce a boundary between the world of GNU Triples and the world of LLVM
Target Descriptions. At the moment llvm::Triple is responsible for interpreting
GNU Triples and being a target description within LLVM. So in the TargetTuple
solution, llvm::Triple parsed the triple and was then used to initialize a more
detailed, unambiguous, and authoritative target description in
llvm::TargetTuple. Command line arguments then modified the TargetTuple after
which it was passed to the backend instead of llvm::Triple.
 
It will be interesting to see what answers you get here. Personally, I was
avoiding inventing values in the llvm::Triple enums because MIPS needs to convey
information that is only implied by the triple (and therefore needed new member
variables) and/or differs between linux distributions, and also because I
thought that separating the GNU Triple parser and the resulting target
description was a good thing to do. However, if there's some agreement that
this is the right thing to do then I can rethink my plan and find some way to
encode what I need in one of these fields.
 
From:llvm-dev [mailto:llvm-dev-bounces at lists.llvm.org] On Behalf Of Anson
MacDonald via llvm-dev
Sent: 15 December 2015 22:58
To: llvm-dev at lists.llvm.org
Subject: [llvm-dev] How do I get ABI information to a subclass of
MCELFObjectTargetWriter::GetLocType?
 
I am implementing a defined, but currently unimplemented by LLVM, ABI. This ABI
differs from an existing ABI in its ELF object format by implementing a subset
of an existing ABI, but encoded differently and by setting the e_ident EI_CLASS
field. I am trying to use MCTargetOptions::getABIName to set a boolean in the
modified subclass of MCELFObjectTargetWriter to indicate which relocation
encoding to use. As far as I can determine by source examination and judicious
use of a debugger there isn't a simple path from the command line and the
setting of ABIname in MCTargetOptions to where an instance of a subclass of
MCELFObjectTargetWriter is created.
 
I looked at the approach taken by both Mips and X86 for implementing ILP32 and
neither seems applicable. For x86 x32, there is the combination of IsELF64 ==
false and OSABI == EM_X86_64, but that doesn't seem applicable, as the ELF
e_machine field is the same for the existing and the new ABI. For Mips N32, code
and state in MCELFObjectTargetWriter seems to take care of mapping the
relocation values and the ELF e_flags bit EF_MIPS_ABI_ON32 is set.
 
I'm trying to implement the AArch64 ILP32 ELF ABI.Ideally, I'd like to
be able to create a modified version of AArch64ELFObjectWriter so that its
GerRelocType method can choose which relocation encoding to use based upon what
was specified on the command line. Should I make up a new OSABI enum value? Do
some kind of manipulation of the Triple environment field to set it based upon
the value of "-mabi="?
 
ARM64 ELF  Reference with ILP32 information:
http://infocenter.arm.com/ help/topic/com.arm.doc. ihi0056c/IHI0056C_beta_
aaelf64.pdf