compiler-explorer/test/llvm-ir-parser-tests.ts

// 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 {LLVMIRDemangler} from '../lib/demangler/llvm.js';
import {LlvmIrParser} from '../lib/llvm-ir.js';
import * as properties from '../lib/properties.js';
import type {LLVMIrBackendOptions} from '../types/compilation/ir.interfaces.js';

const languages = {
    'c++': {id: 'c++'},
};

describe('llvm-ir parseMetaNode', () => {
    let llvmIrParser: LlvmIrParser;
    let compilerProps;

    beforeAll(() => {
        const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
        compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');

        llvmIrParser = new LlvmIrParser(compilerProps, undefined as unknown as LLVMIRDemangler);
    });

    it('should parse DILocation node', () => {
        expect(llvmIrParser.parseMetaNode('!60 = !DILocation(line: 9, column: 15, scope: !58)')).toEqual({
            metaType: 'Location',
            metaId: '!60',
            line: '9',
            column: '15',
            scope: '!58',
        });
    });

    it('should parse distinct DILexicalBlock', () => {
        expect(
            llvmIrParser.parseMetaNode('!50 = distinct !DILexicalBlock(scope: !44, file: !1, line: 8, column: 5)'),
        ).toEqual({
            metaType: 'LexicalBlock',
            metaId: '!50',
            scope: '!44',
            file: '!1',
            line: '8',
            column: '5',
        });
    });

    it('should parse all value types', () => {
        expect(
            llvmIrParser.parseMetaNode(
                '!44 = distinct !DISubprogram(name: "func<int, int>", ' +
                    'scope: !1, line: 7, isLocal: false, isDefinition: true, flags: ' +
                    'DIFlagPrototyped, ceEmpty: "", ceTest: "a:b\\"c,d")',
            ),
        ).toEqual({
            metaType: 'Subprogram',
            metaId: '!44',
            name: 'func<int, int>',
            line: '7',
            scope: '!1',
            isLocal: 'false',
            isDefinition: 'true',
            flags: 'DIFlagPrototyped',
            ceTest: 'a:b\\"c,d',
            ceEmpty: '',
        });
    });

    it('should parse distinct DILexicalBlock', () => {
        expect(
            llvmIrParser.parseMetaNode(
                '!1 = !DIFile(filename: "/tmp/example.cpp", directory: "/home/compiler-explorer")',
            ),
        ).toEqual({
            metaType: 'File',
            metaId: '!1',
            filename: '/tmp/example.cpp',
            directory: '/home/compiler-explorer',
        });
    });

    it('should parse meta nodes without operands', () => {
        expect(llvmIrParser.parseMetaNode('!123 = distinct !DIAssignID()')).toEqual({
            metaType: 'AssignID',
            metaId: '!123',
        });
    });
});

describe('llvm-ir getSourceLineNumber', () => {
    let llvmIrParser: LlvmIrParser;
    let compilerProps;

    beforeAll(() => {
        const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
        compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');

        llvmIrParser = new LlvmIrParser(compilerProps, undefined as unknown as LLVMIRDemangler);
    });

    const debugInfo = {
        '!10': {line: 10, metaId: ''},
        '!20': {line: 20, scope: '!10', metaId: ''},
        '!11': {scope: '!10', metaId: ''},
        '!12': {line: 0, scope: '!10', metaId: ''},
        '!14': {metaId: ''},
        '!15': {scope: '!14', metaId: ''},
        '!16': {scope: '!42', metaId: ''},
    };

    it('should return a line number', () => {
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!10')).toBe(10);
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!20')).toBe(20);
    });

    it('should return the line number of its parent scope', () => {
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!11')).toBe(10);
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!12')).toBe(10);
    });

    it('should return null on non-existend node', () => {
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!16')).toBe(null);
    });

    it('should return null if no higher scope has a line', () => {
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!14')).toBe(null);
        expect(llvmIrParser.getSourceLineNumber(debugInfo, '!15')).toBe(null);
    });
});

describe('llvm-ir getSourceColumn', () => {
    let llvmIrParser: LlvmIrParser;
    let compilerProps;

    beforeAll(() => {
        const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
        compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');

        llvmIrParser = new LlvmIrParser(compilerProps, undefined as unknown as LLVMIRDemangler);
    });

    const debugInfo = {
        '!10': {column: 10, metaId: ''},
        '!20': {column: 20, scope: '!10', metaId: ''},
        '!11': {scope: '!10', metaId: ''},
        '!12': {column: 0, scope: '!10', metaId: ''},
        '!14': {metaId: ''},
        '!15': {scope: '!14', metaId: ''},
        '!16': {scope: '!42', metaId: ''},
    };

    it('should return a column number', () => {
        expect(llvmIrParser.getSourceColumn(debugInfo, '!10')).toBe(10);
        expect(llvmIrParser.getSourceColumn(debugInfo, '!20')).toBe(20);
    });

    it('should return the column number of its parent scope', () => {
        expect(llvmIrParser.getSourceColumn(debugInfo, '!11')).toBe(10);
        expect(llvmIrParser.getSourceColumn(debugInfo, '!12')).toBe(10);
    });

    it('should return undefined on non-existend node', () => {
        expect(llvmIrParser.getSourceColumn(debugInfo, '!16')).toBe(undefined);
        expect(llvmIrParser.getSourceColumn(debugInfo, '!30')).toBe(undefined);
    });

    it('should return undefined if no higher scope has a column', () => {
        expect(llvmIrParser.getSourceColumn(debugInfo, '!14')).toBe(undefined);
        expect(llvmIrParser.getSourceColumn(debugInfo, '!15')).toBe(undefined);
    });
});

describe('llvm-ir getFileName', () => {
    let llvmIrParser: LlvmIrParser;
    let compilerProps;

    beforeAll(() => {
        const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
        compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');

        llvmIrParser = new LlvmIrParser(compilerProps, undefined as unknown as LLVMIRDemangler);
    });
    const debugInfo = {
        '!10': {filename: '/test.cpp', metaId: ''},
        '!20': {filename: '/example.cpp', metaId: ''},
        '!11': {file: '!10', metaId: ''},
        '!21': {file: '!20', metaId: ''},
        '!12': {scope: '!11', metaId: ''},
        '!13': {scope: '!12', metaId: ''},
    };

    it('should return a filename', () => {
        expect(llvmIrParser.getFileName(debugInfo, '!10')).toBe('/test.cpp');
        expect(llvmIrParser.getFileName(debugInfo, '!11')).toBe('/test.cpp');
    });

    it('should return the filename of its parent scope', () => {
        expect(llvmIrParser.getFileName(debugInfo, '!12')).toBe('/test.cpp');
        expect(llvmIrParser.getFileName(debugInfo, '!13')).toBe('/test.cpp');
    });

    it('should return null on non-existend node', () => {
        expect(llvmIrParser.getFileName(debugInfo, '!42')).toBe(null);
    });

    it('should not return source filename', () => {
        expect(llvmIrParser.getFileName(debugInfo, '!20')).toBe(null);
        expect(llvmIrParser.getFileName(debugInfo, '!21')).toBe(null);
    });
});

describe('llvm-ir processIr filters', () => {
    let llvmIrParser: LlvmIrParser;
    let compilerProps;

    const noFilters: LLVMIrBackendOptions = {
        filterDebugInfo: false,
        filterIRMetadata: false,
        filterAttributes: false,
        filterComments: false,
        filterDeclarations: false,
        filterLibraryFunctions: false,
        demangle: false,
    };

    beforeAll(() => {
        const fakeProps = new properties.CompilerProps(languages, properties.fakeProps({}));
        compilerProps = (fakeProps.get as any).bind(fakeProps, 'c++');
        llvmIrParser = new LlvmIrParser(compilerProps, undefined as unknown as LLVMIRDemangler);
    });

    const irWithDeclarations = [
        'define i32 @foo() {',
        '  ret i32 0',
        '}',
        '',
        'declare i32 @external_func(i32)',
        'declare void @llvm.memcpy.p0.p0.i64(ptr, ptr, i64, i1)',
    ].join('\n');

    describe('filterDeclarations', () => {
        it('should keep declare lines when filter is off', async () => {
            const result = await llvmIrParser.processIr(irWithDeclarations, {...noFilters});
            const texts = result.asm.map(l => l.text);
            expect(texts).toContain('declare i32 @external_func(i32)');
            expect(texts).toContain('declare void @llvm.memcpy.p0.p0.i64(ptr, ptr, i64, i1)');
        });

        it('should remove declare lines when filter is on', async () => {
            const result = await llvmIrParser.processIr(irWithDeclarations, {
                ...noFilters,
                filterDeclarations: true,
            });
            const texts = result.asm.map(l => l.text);
            expect(texts).not.toContain('declare i32 @external_func(i32)');
            expect(texts).not.toContain('declare void @llvm.memcpy.p0.p0.i64(ptr, ptr, i64, i1)');
        });

        it('should preserve non-declare lines when filter is on', async () => {
            const result = await llvmIrParser.processIr(irWithDeclarations, {
                ...noFilters,
                filterDeclarations: true,
            });
            const texts = result.asm.map(l => l.text);
            expect(texts).toContain('define i32 @foo() {');
            expect(texts).toContain('  ret i32 0');
        });
    });

    // Real-world Julia IR: the compiler emits @jfptr_<name>_<id> dispatch wrappers alongside
    // every function. These are foreign-pointer thunks used for dynamic dispatch and are not
    // user code. Example taken from the pattern described in #6320 (see godbolt.org/z/Prf3W87oP).
    const irWithLibraryFunctions = [
        'define nonnull {}* @julia_square_generic_2345({}** %0, i32 %1) {',
        'top:',
        '  ret {}* null',
        '}',
        '',
        'define nonnull {}* @jfptr_square_generic_2345({}** %0, i32 %1) {',
        'top:',
        '  %2 = call nonnull {}* @julia_square_generic_2345({}** %0, i32 %1)',
        '  ret {}* %2',
        '}',
        '',
        'define nonnull {}* @julia_square_intrinsic_2346({}** %0, i32 %1) {',
        'top:',
        '  ret {}* null',
        '}',
    ].join('\n');

    describe('filterLibraryFunctions', () => {
        it('should keep jfptr_ functions when filter is off', async () => {
            const result = await llvmIrParser.processIr(irWithLibraryFunctions, {...noFilters});
            const texts = result.asm.map(l => l.text);
            expect(texts).toContain('define nonnull {}* @jfptr_square_generic_2345({}** %0, i32 %1) {');
            expect(texts).toContain('  %2 = call nonnull {}* @julia_square_generic_2345({}** %0, i32 %1)');
        });

        it('should remove the entire jfptr_ function body when filter is on', async () => {
            const result = await llvmIrParser.processIr(irWithLibraryFunctions, {
                ...noFilters,
                filterLibraryFunctions: true,
            });
            const texts = result.asm.map(l => l.text);
            expect(texts).not.toContain('define nonnull {}* @jfptr_square_generic_2345({}** %0, i32 %1) {');
            expect(texts).not.toContain('  %2 = call nonnull {}* @julia_square_generic_2345({}** %0, i32 %1)');
        });

        it('should preserve user-defined functions when filter is on', async () => {
            const result = await llvmIrParser.processIr(irWithLibraryFunctions, {
                ...noFilters,
                filterLibraryFunctions: true,
            });
            const texts = result.asm.map(l => l.text);
            expect(texts).toContain('define nonnull {}* @julia_square_generic_2345({}** %0, i32 %1) {');
            expect(texts).toContain('define nonnull {}* @julia_square_intrinsic_2346({}** %0, i32 %1) {');
        });
    });
});