[llvm-dev] CloneFunction during LTO leads to seg fault?

[Scott A. Carr via llvm-dev]

Hello again,

I've narrowed down my issue to a small test case.  The core of the issue 
is that CloneFunction (with ModuleLevelChanges=true) on a function that 
has had other functions inlined into it generates orphan debug info 
metadata nodes.  Then when this module is emitted, DwarfDebug crashes.

The C program is here [1].  Note that the inliner should inline add into 
main.

If compile that C program with "-g -S -emit-llvm" and run the result 
through opt with -std-link-opts, I get [2].  The optimizer does in fact 
inline add into main.

Then I run my pass on [2] and I get [3].

All my pass does is:

     ValueToValueMapTy vMap;
     auto main = M.getFunction("main");
     auto mainDup = CloneFunction(main, vMap, true);
     M.getFunctionList().push_back(mainDup);

Note that [2] and [3] are virtually the same except:  1) there is a new 
function "main.1" which is a copy of "main" and 2) there are more debug 
info metadata nodes at the end of the module.  If you look at "!44" 
you'll see that it is not in the subprograms of any DICompileUnit.  I 
think this is the problem.

If I compile [3], I get a seg fault at [4].  I back traced to here [5].  
There's no check if SP is actually in SPMap.  My guess is that it is 
missing in the crash case.

Is this a bug?  Is there an assumption that a function won't be cloned 
after inlining?  Is there an assumption that the debug info metadata 
nodes are well formed when they get to DwarfDebug?

I'm outside of my sliver of LLVM knowledge here.  I mostly write 
transform passes.  Is there a work around aside from disabling inlining 
or making sure my pass runs before it?  If this is a bug, I'd be happy 
to try to help fix it, but I'd need some guidance.

Thanks,
Scott

[1] http://pastebin.com/z0sDd6Zp
[2] http://pastebin.com/xRKYwEYj
[3] http://pastebin.com/fbV3MUUb
[4] 
https://github.com/llvm-mirror/llvm/blob/master/lib/CodeGen/AsmPrinter/DwarfCompileUnit.cpp#L610
[5] 
https://github.com/llvm-mirror/llvm/blob/master/lib/CodeGen/AsmPrinter/DwarfDebug.cpp#L369

On 02/09/2016 02:03 PM, Scott A. Carr wrote:
> Hi Medhi,
>
> Thanks for you reply.  Here is the full output of -print-after-all [1] 
> and just the module itself after my pass[2].
>
> I've looked over the IR, but I can't see anything obviously wrong.
>
> I'm not sure what you meant by:
>
>> You may want to try to add it at the end of the pipeline
>
> My pass is the last one added inside populateLTOPassManager. Should I 
> add it to the PassManager somewhere else?
>
> Thanks,
> Scott
>
> [1] https://gist.github.com/scottcarr/ce0bb6df1cbb44ec46a5
> [2] http://pastebin.com/9xc2jpRj
>
> On 02/09/2016 01:36 PM, Mehdi Amini wrote:
>>> On Feb 9, 2016, at 10:24 AM, Scott A. Carr via llvm-dev 
>>> <llvm-dev at lists.llvm.org> wrote:
>>>
>>> Hello,
>>>
>>> I'm writing an LTO pass and I'd like to be able to duplicate a 
>>> function (with debugging info).  I'm trying to accomplish this with 
>>> CloneFunction but it's leading to a seg fault in ld.
>>>
>>> I've whittled down my problem so that it occurs in this small pass [1].
>>>
>>> If I run this pass with opt, I get the expected result (i.e. a valid 
>>> program that calls main twice).  If I run the pass during LTO, ld 
>>> seg faults.  Here is a pastebin of when ld seg faults in lldb [2].
>>>
>>> If I set the third parameter of CloneFunction (ModuleLevelChanges) 
>>> to false, then then compilation will complete -- but I lose 
>>> debugging information in the cloned function.  I really want to 
>>> preserve the debug info.
>>>
>>> Any idea what is wrong?  Is this a bug?  Usually when I screw up the 
>>> module the verifier catches the problem.  This is getting to I think 
>>> CodeGen then crashing.
>>
>> What could help is to pass -mllvm -print-after-all to ld and get the 
>> IR before and after your pass ran, and also just before CodeGen.
>>
>>> I've found that the module itself needs to be non-trivial to cause 
>>> the crash.  Here is the module I'm testing with [3].
>>>
>>> In case it is relevant: to get my pass to run during LTO I added 
>>> "PM.add(createHelloPass())" to 
>>> PassMangerBuilder::populateLTOPassManager.  I'm using binutils-gold 
>>> on Linux (Ubuntu 14.04 LTS).
>> You may want to try to add it at the end of the pipeline, in case 
>> something does not play well with optimizations (just trying to 
>> pinpoint where the issue is).
>>
>