llvm-6502/lib/CodeGen
Duncan P. N. Exon Smith dad20b2ae2 IR: Split Metadata from Value
Split `Metadata` away from the `Value` class hierarchy, as part of
PR21532.  Assembly and bitcode changes are in the wings, but this is the
bulk of the change for the IR C++ API.

I have a follow-up patch prepared for `clang`.  If this breaks other
sub-projects, I apologize in advance :(.  Help me compile it on Darwin
I'll try to fix it.  FWIW, the errors should be easy to fix, so it may
be simpler to just fix it yourself.

This breaks the build for all metadata-related code that's out-of-tree.
Rest assured the transition is mechanical and the compiler should catch
almost all of the problems.

Here's a quick guide for updating your code:

  - `Metadata` is the root of a class hierarchy with three main classes:
    `MDNode`, `MDString`, and `ValueAsMetadata`.  It is distinct from
    the `Value` class hierarchy.  It is typeless -- i.e., instances do
    *not* have a `Type`.

  - `MDNode`'s operands are all `Metadata *` (instead of `Value *`).

  - `TrackingVH<MDNode>` and `WeakVH` referring to metadata can be
    replaced with `TrackingMDNodeRef` and `TrackingMDRef`, respectively.

    If you're referring solely to resolved `MDNode`s -- post graph
    construction -- just use `MDNode*`.

  - `MDNode` (and the rest of `Metadata`) have only limited support for
    `replaceAllUsesWith()`.

    As long as an `MDNode` is pointing at a forward declaration -- the
    result of `MDNode::getTemporary()` -- it maintains a side map of its
    uses and can RAUW itself.  Once the forward declarations are fully
    resolved RAUW support is dropped on the ground.  This means that
    uniquing collisions on changing operands cause nodes to become
    "distinct".  (This already happened fairly commonly, whenever an
    operand went to null.)

    If you're constructing complex (non self-reference) `MDNode` cycles,
    you need to call `MDNode::resolveCycles()` on each node (or on a
    top-level node that somehow references all of the nodes).  Also,
    don't do that.  Metadata cycles (and the RAUW machinery needed to
    construct them) are expensive.

  - An `MDNode` can only refer to a `Constant` through a bridge called
    `ConstantAsMetadata` (one of the subclasses of `ValueAsMetadata`).

    As a side effect, accessing an operand of an `MDNode` that is known
    to be, e.g., `ConstantInt`, takes three steps: first, cast from
    `Metadata` to `ConstantAsMetadata`; second, extract the `Constant`;
    third, cast down to `ConstantInt`.

    The eventual goal is to introduce `MDInt`/`MDFloat`/etc. and have
    metadata schema owners transition away from using `Constant`s when
    the type isn't important (and they don't care about referring to
    `GlobalValue`s).

    In the meantime, I've added transitional API to the `mdconst`
    namespace that matches semantics with the old code, in order to
    avoid adding the error-prone three-step equivalent to every call
    site.  If your old code was:

        MDNode *N = foo();
        bar(isa             <ConstantInt>(N->getOperand(0)));
        baz(cast            <ConstantInt>(N->getOperand(1)));
        bak(cast_or_null    <ConstantInt>(N->getOperand(2)));
        bat(dyn_cast        <ConstantInt>(N->getOperand(3)));
        bay(dyn_cast_or_null<ConstantInt>(N->getOperand(4)));

    you can trivially match its semantics with:

        MDNode *N = foo();
        bar(mdconst::hasa               <ConstantInt>(N->getOperand(0)));
        baz(mdconst::extract            <ConstantInt>(N->getOperand(1)));
        bak(mdconst::extract_or_null    <ConstantInt>(N->getOperand(2)));
        bat(mdconst::dyn_extract        <ConstantInt>(N->getOperand(3)));
        bay(mdconst::dyn_extract_or_null<ConstantInt>(N->getOperand(4)));

    and when you transition your metadata schema to `MDInt`:

        MDNode *N = foo();
        bar(isa             <MDInt>(N->getOperand(0)));
        baz(cast            <MDInt>(N->getOperand(1)));
        bak(cast_or_null    <MDInt>(N->getOperand(2)));
        bat(dyn_cast        <MDInt>(N->getOperand(3)));
        bay(dyn_cast_or_null<MDInt>(N->getOperand(4)));

  - A `CallInst` -- specifically, intrinsic instructions -- can refer to
    metadata through a bridge called `MetadataAsValue`.  This is a
    subclass of `Value` where `getType()->isMetadataTy()`.

    `MetadataAsValue` is the *only* class that can legally refer to a
    `LocalAsMetadata`, which is a bridged form of non-`Constant` values
    like `Argument` and `Instruction`.  It can also refer to any other
    `Metadata` subclass.

(I'll break all your testcases in a follow-up commit, when I propagate
this change to assembly.)

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@223802 91177308-0d34-0410-b5e6-96231b3b80d8
2014-12-09 18:38:53 +00:00
..
AsmPrinter IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
SelectionDAG IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
AggressiveAntiDepBreaker.cpp Handle early-clobber registers in the aggressive anti-dep breaker 2014-12-09 01:00:59 +00:00
AggressiveAntiDepBreaker.h mop up: "Don’t duplicate function or class name at the beginning of the comment." 2014-09-21 14:48:16 +00:00
AllocationOrder.cpp
AllocationOrder.h
Analysis.cpp Allow the use of functions as typeinfo in landingpad clauses 2014-11-14 00:35:50 +00:00
AntiDepBreaker.h mop up: "Don’t duplicate function or class name at the beginning of the comment." 2014-09-21 14:48:16 +00:00
AtomicExpandPass.cpp Lower idempotent RMWs to fence+load 2014-09-25 17:27:43 +00:00
BasicTargetTransformInfo.cpp Fix typo 2014-10-22 00:28:59 +00:00
BranchFolding.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
BranchFolding.h
CalcSpillWeights.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
CallingConvLower.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
CMakeLists.txt Add Forward Control-Flow Integrity. 2014-11-11 21:08:02 +00:00
CodeGen.cpp
CodeGenPrepare.cpp IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
CriticalAntiDepBreaker.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
CriticalAntiDepBreaker.h mop up: "Don’t duplicate function or class name at the beginning of the comment." 2014-09-21 14:48:16 +00:00
DeadMachineInstructionElim.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
DFAPacketizer.cpp Remove the TargetMachine from DFAPacketizer since it was only 2014-10-14 01:03:16 +00:00
DwarfEHPrepare.cpp In DwarfEHPrepare, after all passes are run, RewindFunction may be a dangling 2014-09-14 20:36:28 +00:00
EarlyIfConversion.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
EdgeBundles.cpp
ErlangGC.cpp
ExecutionDepsFix.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00
ExpandISelPseudos.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
ExpandPostRAPseudos.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
ForwardControlFlowIntegrity.cpp Fix build break: remove unused variable in FCFI. 2014-11-11 21:26:33 +00:00
GCMetadata.cpp Remove StringMap::GetOrCreateValue in favor of StringMap::insert 2014-11-19 05:49:42 +00:00
GCMetadataPrinter.cpp
GCStrategy.cpp
GlobalMerge.cpp
IfConversion.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
InlineSpiller.cpp [Statepoints 2/4] Statepoint infrastructure for garbage collection: MI & x86-64 Backend 2014-12-01 22:52:56 +00:00
InterferenceCache.cpp
InterferenceCache.h
IntrinsicLowering.cpp
JumpInstrTables.cpp Add Forward Control-Flow Integrity. 2014-11-11 21:08:02 +00:00
LatencyPriorityQueue.cpp
LexicalScopes.cpp DebugInfo: Ensure that all debug location scope chains from instructions within a function, lead to the function itself. 2014-10-14 18:22:52 +00:00
LiveDebugVariables.cpp Added reset of LexicalScope in LiveDebugVariables reset function. 2014-10-24 02:46:50 +00:00
LiveDebugVariables.h
LiveInterval.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
LiveIntervalAnalysis.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
LiveIntervalUnion.cpp
LivePhysRegs.cpp
LiveRangeCalc.cpp
LiveRangeCalc.h
LiveRangeEdit.cpp Add missing semicolon from r222118. 2014-11-17 05:58:26 +00:00
LiveRegMatrix.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
LiveStackAnalysis.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00
LiveVariables.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
LLVMBuild.txt
LLVMTargetMachine.cpp Add Forward Control-Flow Integrity. 2014-11-11 21:08:02 +00:00
LocalStackSlotAllocation.cpp [Statepoints 2/4] Statepoint infrastructure for garbage collection: MI & x86-64 Backend 2014-12-01 22:52:56 +00:00
MachineBasicBlock.cpp Allow target to specify prefix for labels 2014-12-04 00:06:57 +00:00
MachineBlockFrequencyInfo.cpp
MachineBlockPlacement.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
MachineBranchProbabilityInfo.cpp
MachineCombiner.cpp
MachineCopyPropagation.cpp
MachineCSE.cpp [MachineCSE] Clear kill-flag on registers imp-def'd by the CSE'd instruction. 2014-12-02 18:09:51 +00:00
MachineDominanceFrontier.cpp
MachineDominators.cpp
MachineFunction.cpp Remove unused member variable. 2014-10-14 18:53:16 +00:00
MachineFunctionAnalysis.cpp Remove unused member variable. 2014-10-14 18:53:16 +00:00
MachineFunctionPass.cpp
MachineFunctionPrinterPass.cpp
MachineInstr.cpp IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
MachineInstrBundle.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
MachineLICM.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
MachineLoopInfo.cpp
MachineModuleInfo.cpp Allow the use of functions as typeinfo in landingpad clauses 2014-11-14 00:35:50 +00:00
MachineModuleInfoImpls.cpp
MachinePassRegistry.cpp
MachinePostDominators.cpp
MachineRegionInfo.cpp
MachineRegisterInfo.cpp
MachineScheduler.cpp Access the subtarget off of the MachineFunction via the DAG 2014-10-14 06:56:25 +00:00
MachineSink.cpp Use DomTree in MachineSink to sink over diamonds. 2014-12-04 10:36:42 +00:00
MachineSSAUpdater.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
MachineTraceMetrics.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
MachineVerifier.cpp [MachineVerifier] Accept a MBB with a single landing pad successor. 2014-12-01 18:43:53 +00:00
Makefile
module.modulemap
OcamlGC.cpp
OptimizePHIs.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
Passes.cpp Add a print and verify pass after the RegisterCoalescer 2014-11-19 19:46:15 +00:00
PeepholeOptimizer.cpp Avoid caching the MachineFunction, we don't use it outside of 2014-10-15 21:06:25 +00:00
PHIElimination.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
PHIEliminationUtils.cpp
PHIEliminationUtils.h
PostRASchedulerList.cpp Whitespace. 2014-10-29 15:23:11 +00:00
ProcessImplicitDefs.cpp
PrologEpilogInserter.cpp [Statepoints 2/4] Statepoint infrastructure for garbage collection: MI & x86-64 Backend 2014-12-01 22:52:56 +00:00
PrologEpilogInserter.h
PseudoSourceValue.cpp
README.txt
RegAllocBase.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00
RegAllocBase.h
RegAllocBasic.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
RegAllocFast.cpp [RegAllocFast] Handle implicit definitions conservatively. 2014-12-03 23:38:08 +00:00
RegAllocGreedy.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00
RegAllocPBQP.cpp [PBQP] Callee saved regs should have a higher cost than scratch regs 2014-11-04 20:51:29 +00:00
RegisterClassInfo.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00
RegisterCoalescer.cpp Simplify implementation and testcase of r223401 based on feedback from dblaikie. 2014-12-04 22:58:41 +00:00
RegisterCoalescer.h mop up: "Don’t duplicate function or class name at the beginning of the comment." 2014-09-20 22:39:16 +00:00
RegisterPressure.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
RegisterScavenging.cpp Grab the subtarget and subtarget dependent variables off of 2014-10-14 07:22:00 +00:00
ScheduleDAG.cpp
ScheduleDAGInstrs.cpp MISched: Fix moving stores across barriers 2014-12-08 23:36:48 +00:00
ScheduleDAGPrinter.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
ScoreboardHazardRecognizer.cpp
ShadowStackGC.cpp Use nullptr instead of NULL for variadic sentinels 2014-11-13 22:55:19 +00:00
SjLjEHPrepare.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
SlotIndexes.cpp
Spiller.h [RegAlloc] Kill off the trivial spiller - nobody is using it any more. 2014-11-06 19:12:38 +00:00
SpillPlacement.cpp Fix the threshold added in r186434 (a re-apply of r185393) and updaated 2014-10-02 22:23:14 +00:00
SpillPlacement.h Fix the threshold added in r186434 (a re-apply of r185393) and updaated 2014-10-02 22:23:14 +00:00
SplitKit.cpp Grab the subtarget and subtarget dependent variables off of 2014-10-14 07:22:00 +00:00
SplitKit.h
StackColoring.cpp IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
StackMapLivenessAnalysis.cpp
StackMaps.cpp [Statepoints 2/4] Statepoint infrastructure for garbage collection: MI & x86-64 Backend 2014-12-01 22:52:56 +00:00
StackProtector.cpp [stack protector] Set edge weights for newly created basic blocks. 2014-12-01 04:27:03 +00:00
StackSlotColoring.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
TailDuplication.cpp
TargetFrameLoweringImpl.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
TargetInstrInfo.cpp Fix a lot of confusion around inserting nops on empty functions. 2014-09-15 18:32:58 +00:00
TargetLoweringBase.cpp [Statepoints 2/4] Statepoint infrastructure for garbage collection: MI & x86-64 Backend 2014-12-01 22:52:56 +00:00
TargetLoweringObjectFileImpl.cpp IR: Split Metadata from Value 2014-12-09 18:38:53 +00:00
TargetOptionsImpl.cpp Add Forward Control-Flow Integrity. 2014-11-11 21:08:02 +00:00
TargetRegisterInfo.cpp Introduce register dump helper 2014-11-19 19:46:11 +00:00
TargetSchedule.cpp Remove unnecessary TargetMachine.h includes. 2014-10-14 07:22:08 +00:00
TwoAddressInstructionPass.cpp Update SetVector to rely on the underlying set's insert to return a pair<iterator, bool> 2014-11-19 07:49:26 +00:00
UnreachableBlockElim.cpp
VirtRegMap.cpp Move register class name strings to a single array in MCRegisterInfo to reduce static table size and number of relocation entries. 2014-11-17 05:50:14 +00:00

//===---------------------------------------------------------------------===//

Common register allocation / spilling problem:

        mul lr, r4, lr
        str lr, [sp, #+52]
        ldr lr, [r1, #+32]
        sxth r3, r3
        ldr r4, [sp, #+52]
        mla r4, r3, lr, r4

can be:

        mul lr, r4, lr
        mov r4, lr
        str lr, [sp, #+52]
        ldr lr, [r1, #+32]
        sxth r3, r3
        mla r4, r3, lr, r4

and then "merge" mul and mov:

        mul r4, r4, lr
        str r4, [sp, #+52]
        ldr lr, [r1, #+32]
        sxth r3, r3
        mla r4, r3, lr, r4

It also increase the likelihood the store may become dead.

//===---------------------------------------------------------------------===//

bb27 ...
        ...
        %reg1037 = ADDri %reg1039, 1
        %reg1038 = ADDrs %reg1032, %reg1039, %NOREG, 10
    Successors according to CFG: 0x8b03bf0 (#5)

bb76 (0x8b03bf0, LLVM BB @0x8b032d0, ID#5):
    Predecessors according to CFG: 0x8b0c5f0 (#3) 0x8b0a7c0 (#4)
        %reg1039 = PHI %reg1070, mbb<bb76.outer,0x8b0c5f0>, %reg1037, mbb<bb27,0x8b0a7c0>

Note ADDri is not a two-address instruction. However, its result %reg1037 is an
operand of the PHI node in bb76 and its operand %reg1039 is the result of the
PHI node. We should treat it as a two-address code and make sure the ADDri is
scheduled after any node that reads %reg1039.

//===---------------------------------------------------------------------===//

Use local info (i.e. register scavenger) to assign it a free register to allow
reuse:
        ldr r3, [sp, #+4]
        add r3, r3, #3
        ldr r2, [sp, #+8]
        add r2, r2, #2
        ldr r1, [sp, #+4]  <==
        add r1, r1, #1
        ldr r0, [sp, #+4]
        add r0, r0, #2

//===---------------------------------------------------------------------===//

LLVM aggressively lift CSE out of loop. Sometimes this can be negative side-
effects:

R1 = X + 4
R2 = X + 7
R3 = X + 15

loop:
load [i + R1]
...
load [i + R2]
...
load [i + R3]

Suppose there is high register pressure, R1, R2, R3, can be spilled. We need
to implement proper re-materialization to handle this:

R1 = X + 4
R2 = X + 7
R3 = X + 15

loop:
R1 = X + 4  @ re-materialized
load [i + R1]
...
R2 = X + 7 @ re-materialized
load [i + R2]
...
R3 = X + 15 @ re-materialized
load [i + R3]

Furthermore, with re-association, we can enable sharing:

R1 = X + 4
R2 = X + 7
R3 = X + 15

loop:
T = i + X
load [T + 4]
...
load [T + 7]
...
load [T + 15]
//===---------------------------------------------------------------------===//

It's not always a good idea to choose rematerialization over spilling. If all
the load / store instructions would be folded then spilling is cheaper because
it won't require new live intervals / registers. See 2003-05-31-LongShifts for
an example.

//===---------------------------------------------------------------------===//

With a copying garbage collector, derived pointers must not be retained across
collector safe points; the collector could move the objects and invalidate the
derived pointer. This is bad enough in the first place, but safe points can
crop up unpredictably. Consider:

        %array = load { i32, [0 x %obj] }** %array_addr
        %nth_el = getelementptr { i32, [0 x %obj] }* %array, i32 0, i32 %n
        %old = load %obj** %nth_el
        %z = div i64 %x, %y
        store %obj* %new, %obj** %nth_el

If the i64 division is lowered to a libcall, then a safe point will (must)
appear for the call site. If a collection occurs, %array and %nth_el no longer
point into the correct object.

The fix for this is to copy address calculations so that dependent pointers
are never live across safe point boundaries. But the loads cannot be copied
like this if there was an intervening store, so may be hard to get right.

Only a concurrent mutator can trigger a collection at the libcall safe point.
So single-threaded programs do not have this requirement, even with a copying
collector. Still, LLVM optimizations would probably undo a front-end's careful
work.

//===---------------------------------------------------------------------===//

The ocaml frametable structure supports liveness information. It would be good
to support it.

//===---------------------------------------------------------------------===//

The FIXME in ComputeCommonTailLength in BranchFolding.cpp needs to be
revisited. The check is there to work around a misuse of directives in inline
assembly.

//===---------------------------------------------------------------------===//

It would be good to detect collector/target compatibility instead of silently
doing the wrong thing.

//===---------------------------------------------------------------------===//

It would be really nice to be able to write patterns in .td files for copies,
which would eliminate a bunch of explicit predicates on them (e.g. no side 
effects).  Once this is in place, it would be even better to have tblgen 
synthesize the various copy insertion/inspection methods in TargetInstrInfo.

//===---------------------------------------------------------------------===//

Stack coloring improvements:

1. Do proper LiveStackAnalysis on all stack objects including those which are
   not spill slots.
2. Reorder objects to fill in gaps between objects.
   e.g. 4, 1, <gap>, 4, 1, 1, 1, <gap>, 4 => 4, 1, 1, 1, 1, 4, 4

//===---------------------------------------------------------------------===//

The scheduler should be able to sort nearby instructions by their address. For
example, in an expanded memset sequence it's not uncommon to see code like this:

  movl $0, 4(%rdi)
  movl $0, 8(%rdi)
  movl $0, 12(%rdi)
  movl $0, 0(%rdi)

Each of the stores is independent, and the scheduler is currently making an
arbitrary decision about the order.

//===---------------------------------------------------------------------===//

Another opportunitiy in this code is that the $0 could be moved to a register:

  movl $0, 4(%rdi)
  movl $0, 8(%rdi)
  movl $0, 12(%rdi)
  movl $0, 0(%rdi)

This would save substantial code size, especially for longer sequences like
this. It would be easy to have a rule telling isel to avoid matching MOV32mi
if the immediate has more than some fixed number of uses. It's more involved
to teach the register allocator how to do late folding to recover from
excessive register pressure.