mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 10:33:59 -05:00
219 lines
11 KiB
TypeScript
219 lines
11 KiB
TypeScript
// Copyright (c) 2023, Compiler Explorer Authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import {beforeAll, describe, expect, it} from 'vitest';
|
|
|
|
import {LlvmPassDumpParser} from '../lib/parsers/llvm-pass-dump-parser.js';
|
|
import * as properties from '../lib/properties.js';
|
|
|
|
const languages = {
|
|
'c++': {id: 'c++'},
|
|
};
|
|
|
|
function deepCopy(obj) {
|
|
return JSON.parse(JSON.stringify(obj));
|
|
}
|
|
|
|
describe('llvm-pass-dump-parser filter', () => {
|
|
let llvmPassDumpParser;
|
|
|
|
beforeAll(() => {
|
|
const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
|
|
const compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');
|
|
llvmPassDumpParser = new LlvmPassDumpParser(compilerProps);
|
|
});
|
|
// biome-ignore format: keep as-is for readability
|
|
const rawFuncIR = [
|
|
{text: ' # Machine code for function f(S1&, S2 const&): NoPHIs, TracksLiveness, TiedOpsRewritten'},
|
|
{text: 'define dso_local void @f(S1&, S2 const&)(%struct.S1* noundef nonnull align 8 dereferenceable(16) %s1, %struct.S2* noundef nonnull align 8 dereferenceable(16) %s2) #0 !dbg !7 {',},
|
|
{text: 'entry:'},
|
|
{text: ' %s1.addr = alloca %struct.S1*, align 8'},
|
|
{text: ' store %struct.S1* %s1, %struct.S1** %s1.addr, align 8, !tbaa !32'},
|
|
{text: ' call void @llvm.dbg.declare(metadata %struct.S1** %s1.addr, metadata !30, metadata !DIExpression()), !dbg !36',},
|
|
{text: ' call void @llvm.dbg.value(metadata %struct.S1* %s1, metadata !30, metadata !DIExpression()), !dbg !32',},
|
|
{text: ' tail call void @llvm.dbg.declare(metadata i16* %p.addr, metadata !24, metadata !DIExpression()), !dbg !12',},
|
|
{text: ' tail call void @llvm.dbg.value(metadata i32 0, metadata !20, metadata !DIExpression()), !dbg !21'},
|
|
{text: ' #dbg_declare(i16* %x.addr, !44, !DIExpression(), !42)'},
|
|
{text: ' #dbg_value(i32 10, !40, !DIExpression(), !41)'},
|
|
{text: ' DBG_VALUE $rdi, $noreg, !"s1", !DIExpression(), debug-location !32; example.cpp:0 line no:7'},
|
|
{text: ' store %struct.S2* %s2, %struct.S2** %s2.addr, align 8, !tbaa !32'},
|
|
{text: ' %0 = load %struct.S2*, %struct.S2** %s2.addr, align 8, !dbg !38, !tbaa !32'},
|
|
{text: ' %a = getelementptr inbounds %struct.S2, %struct.S2* %0, i32 0, i32 0, !dbg !39'},
|
|
{text: ' %1 = load i64, i64* %t, align 8, !dbg !40, !tbaa !41'},
|
|
{text: ' %2 = load %struct.S1*, %struct.S1** %s1.addr, align 8, !dbg !46, !tbaa !32'},
|
|
{text: ' store i64 %1, i64* %t2, align 8, !dbg !49, !tbaa !50'},
|
|
{text: ' %t3 = getelementptr inbounds %struct.Wrapper2, %struct.Wrapper2* %b, i32 0, i32 0, !dbg !54'},
|
|
{text: ' ret void, !dbg !61'},
|
|
];
|
|
|
|
it('should not filter out dbg metadata', () => {
|
|
const options = {filterDebugInfo: false};
|
|
expect(llvmPassDumpParser.applyIrFilters(deepCopy(rawFuncIR), options)).toEqual(rawFuncIR);
|
|
});
|
|
|
|
it('should filter out dbg metadata too', () => {
|
|
const options = {filterDebugInfo: true};
|
|
// biome-ignore format: keep as-is for readability
|
|
expect(llvmPassDumpParser.applyIrFilters(deepCopy(rawFuncIR), options)).toEqual([
|
|
{text: ' # Machine code for function f(S1&, S2 const&): NoPHIs, TracksLiveness, TiedOpsRewritten'},
|
|
{text: 'define dso_local void @f(S1&, S2 const&)(%struct.S1* noundef nonnull align 8 dereferenceable(16) %s1, %struct.S2* noundef nonnull align 8 dereferenceable(16) %s2) {',},
|
|
{text: 'entry:'},
|
|
{text: ' %s1.addr = alloca %struct.S1*, align 8'},
|
|
{text: ' store %struct.S1* %s1, %struct.S1** %s1.addr, align 8, !tbaa !32'},
|
|
{text: ' store %struct.S2* %s2, %struct.S2** %s2.addr, align 8, !tbaa !32'},
|
|
{text: ' %0 = load %struct.S2*, %struct.S2** %s2.addr, align 8, !tbaa !32'},
|
|
{text: ' %a = getelementptr inbounds %struct.S2, %struct.S2* %0, i32 0, i32 0'},
|
|
{text: ' %1 = load i64, i64* %t, align 8, !tbaa !41'},
|
|
{text: ' %2 = load %struct.S1*, %struct.S1** %s1.addr, align 8, !tbaa !32'},
|
|
{text: ' store i64 %1, i64* %t2, align 8, !tbaa !50'},
|
|
{text: ' %t3 = getelementptr inbounds %struct.Wrapper2, %struct.Wrapper2* %b, i32 0, i32 0'},
|
|
{text: ' ret void'},
|
|
]);
|
|
});
|
|
|
|
it('should filter out instruction metadata and object attribute group, leave debug instructions in place', () => {
|
|
// 'hide IR metadata' aims to decrease more visual noise than `hide debug info`
|
|
const options = {filterDebugInfo: false, filterIRMetadata: true};
|
|
// biome-ignore format: keep as-is for readability
|
|
expect(llvmPassDumpParser.applyIrFilters(deepCopy(rawFuncIR), options)).toEqual([
|
|
{text: ' # Machine code for function f(S1&, S2 const&): NoPHIs, TracksLiveness, TiedOpsRewritten'},
|
|
{text: 'define dso_local void @f(S1&, S2 const&)(%struct.S1* noundef nonnull align 8 dereferenceable(16) %s1, %struct.S2* noundef nonnull align 8 dereferenceable(16) %s2) {',},
|
|
{text: 'entry:'},
|
|
{text: ' %s1.addr = alloca %struct.S1*, align 8'},
|
|
{text: ' store %struct.S1* %s1, %struct.S1** %s1.addr, align 8'},
|
|
{text: ' call void @llvm.dbg.declare(metadata %struct.S1** %s1.addr, metadata !30, metadata !DIExpression())',},
|
|
{text: ' call void @llvm.dbg.value(metadata %struct.S1* %s1, metadata !30, metadata !DIExpression())'},
|
|
{text: ' tail call void @llvm.dbg.declare(metadata i16* %p.addr, metadata !24, metadata !DIExpression())'},
|
|
{text: ' tail call void @llvm.dbg.value(metadata i32 0, metadata !20, metadata !DIExpression())'},
|
|
{text: ' #dbg_declare(i16* %x.addr, !44, !DIExpression(), !42)'},
|
|
{text: ' #dbg_value(i32 10, !40, !DIExpression(), !41)'},
|
|
{text: ' DBG_VALUE $rdi, $noreg, !"s1", !DIExpression(), debug-location !32; example.cpp:0 line no:7'},
|
|
{text: ' store %struct.S2* %s2, %struct.S2** %s2.addr, align 8'},
|
|
{text: ' %0 = load %struct.S2*, %struct.S2** %s2.addr, align 8'},
|
|
{text: ' %a = getelementptr inbounds %struct.S2, %struct.S2* %0, i32 0, i32 0'},
|
|
{text: ' %1 = load i64, i64* %t, align 8'},
|
|
{text: ' %2 = load %struct.S1*, %struct.S1** %s1.addr, align 8'},
|
|
{text: ' store i64 %1, i64* %t2, align 8'},
|
|
{text: ' %t3 = getelementptr inbounds %struct.Wrapper2, %struct.Wrapper2* %b, i32 0, i32 0'},
|
|
{text: ' ret void'},
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('llvm-pass-dump-parser Old style IR Dump header', () => {
|
|
let llvmPassDumpParser;
|
|
|
|
beforeAll(() => {
|
|
const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
|
|
const compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');
|
|
llvmPassDumpParser = new LlvmPassDumpParser(compilerProps);
|
|
});
|
|
|
|
const rawFuncIR = [
|
|
{text: '*** IR Dump After NoOpModulePass on [module] ***'},
|
|
{text: 'define void @foo() {'},
|
|
{text: ' ret void'},
|
|
{text: '}'},
|
|
{text: 'define void @bar() {'},
|
|
{text: 'entry:'},
|
|
{text: ' br label %my-loop'},
|
|
{text: 'my-loop: ; preds = %my-loop, %entry'},
|
|
{text: ' br label %my-loop'},
|
|
{text: '}'},
|
|
];
|
|
|
|
it('should recognize dump', () => {
|
|
const options = {filterDebugInfo: false};
|
|
|
|
const brokenDown = llvmPassDumpParser.breakdownOutputIntoPassDumps(deepCopy(rawFuncIR), options);
|
|
|
|
expect(brokenDown).toEqual([
|
|
{
|
|
affectedFunction: undefined,
|
|
header: 'IR Dump After NoOpModulePass on [module]',
|
|
lines: [
|
|
{text: 'define void @foo() {'},
|
|
{text: ' ret void'},
|
|
{text: '}'},
|
|
{text: 'define void @bar() {'},
|
|
{text: 'entry:'},
|
|
{text: ' br label %my-loop'},
|
|
{text: 'my-loop: ; preds = %my-loop, %entry'},
|
|
{text: ' br label %my-loop'},
|
|
{text: '}'},
|
|
],
|
|
machine: false,
|
|
},
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe('llvm-pass-dump-parser New style IR Dump header', () => {
|
|
let llvmPassDumpParser;
|
|
|
|
beforeAll(() => {
|
|
const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
|
|
const compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');
|
|
llvmPassDumpParser = new LlvmPassDumpParser(compilerProps);
|
|
});
|
|
|
|
const rawFuncIR = [
|
|
{text: '; *** IR Dump After NoOpModulePass on [module] ***'},
|
|
{text: 'define void @foo() {'},
|
|
{text: ' ret void'},
|
|
{text: '}'},
|
|
{text: 'define void @bar() {'},
|
|
{text: 'entry:'},
|
|
{text: ' br label %my-loop'},
|
|
{text: 'my-loop: ; preds = %my-loop, %entry'},
|
|
{text: ' br label %my-loop'},
|
|
{text: '}'},
|
|
];
|
|
|
|
it('should recognize dump', () => {
|
|
const options = {filterDebugInfo: false};
|
|
|
|
const brokenDown = llvmPassDumpParser.breakdownOutputIntoPassDumps(deepCopy(rawFuncIR), options);
|
|
|
|
expect(brokenDown).toEqual([
|
|
{
|
|
affectedFunction: undefined,
|
|
header: 'IR Dump After NoOpModulePass on [module]',
|
|
lines: [
|
|
{text: 'define void @foo() {'},
|
|
{text: ' ret void'},
|
|
{text: '}'},
|
|
{text: 'define void @bar() {'},
|
|
{text: 'entry:'},
|
|
{text: ' br label %my-loop'},
|
|
{text: 'my-loop: ; preds = %my-loop, %entry'},
|
|
{text: ' br label %my-loop'},
|
|
{text: '}'},
|
|
],
|
|
machine: false,
|
|
},
|
|
]);
|
|
});
|
|
});
|