compiler-explorer/lib/compilers/ldc.ts

// Copyright (c) 2016, 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 path from 'node:path';

import fs from 'fs-extra';
import semverParser from 'semver';

import type {CompilationResult} from '../../types/compilation/compilation.interfaces.js';
import type {PreliminaryCompilerInfo} from '../../types/compiler.interfaces.js';
import {ExecutableExecutionOptions} from '../../types/execution/execution.interfaces.js';
import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces.js';
import type {ResultLine} from '../../types/resultline/resultline.interfaces.js';
import {BaseCompiler} from '../base-compiler.js';
import {CompilationEnvironment} from '../compilation-env.js';
import {logger} from '../logger.js';
import * as utils from '../utils.js';

import {LDCParser} from './argument-parsers.js';

export class LDCCompiler extends BaseCompiler {
    static get key() {
        return 'ldc';
    }

    asanSymbolizerPath: string;

    constructor(info: PreliminaryCompilerInfo, env: CompilationEnvironment) {
        super(info, env);
        this.compiler.supportsIntel = true;
        this.compiler.supportsIrView = true;
        this.compiler.irArg = ['-output-ll'];

        this.asanSymbolizerPath = this.compilerProps<string>('llvmSymbolizer');
    }

    override runExecutable(executable: string, executeParameters: ExecutableExecutionOptions, homeDir: string) {
        if (this.asanSymbolizerPath) {
            executeParameters.env = {
                ASAN_SYMBOLIZER_PATH: this.asanSymbolizerPath,
                ...executeParameters.env,
            };
        }
        return super.runExecutable(executable, executeParameters, homeDir);
    }

    override getSharedLibraryPathsAsArguments() {
        return [];
    }

    override getOutputFilename(dirPath: string, outputFilebase: string, key?: any): string {
        if (key?.filters?.binary) {
            return path.join(dirPath, 'output');
        }
        if (key?.filters?.binaryObject) {
            return path.join(dirPath, 'output.o');
        }
        return path.join(dirPath, 'output.s');
    }

    override optionsForFilter(filters: ParseFiltersAndOutputOptions, outputFilename: string) {
        const options = ['-gline-tables-only', '-of', this.filename(outputFilename)];
        if (filters.intel && !filters.binary) options.push('-x86-asm-syntax=intel');
        if (!filters.binary && !filters.binaryObject) options.push('-output-s');
        else if (filters.binaryObject) options.push('-c');
        return options;
    }

    override getArgumentParserClass() {
        return LDCParser;
    }

    override filterUserOptions(userOptions: string[]) {
        return userOptions.filter(option => option !== '-run');
    }

    override isCfgCompiler() {
        return true;
    }

    override couldSupportASTDump(version: string) {
        const versionRegex = /\((\d\.\d+)\.\d+/;
        const versionMatch = versionRegex.exec(version);
        return versionMatch ? semverParser.compare(versionMatch[1] + '.0', '1.4.0', true) >= 0 : false;
    }

    override async generateAST(inputFilename: string, options: string[]): Promise<ResultLine[]> {
        // These options make LDC produce an AST dump in a separate file `<inputFilename>.cg`.
        const newOptions = options.concat('-vcg-ast');
        const execOptions = this.getDefaultExecOptions();

        return this.loadASTOutput(
            await this.runCompiler(this.compiler.exe, newOptions, this.filename(inputFilename), execOptions),
        );
    }

    async loadASTOutput(result: CompilationResult): Promise<ResultLine[]> {
        if (result.code !== 0) {
            return [{text: `Error generating AST: ${result.code}`}];
        }
        // Load the AST output from the `.cg` file.
        // Demangling is not needed.
        const astFilename = result.inputFilename!.concat('.cg');
        try {
            const rawAST: string = await fs.readFile(astFilename, 'utf8');
            return utils.parseOutput(rawAST, result.inputFilename);
            // In theory we'd want to run this through this.llvmAst.processAst, but ldc's so-called-AST
            // output is very different and processAst is moot:
            // https://github.com/dlang/dmd/pull/6556#issuecomment-282353400
        } catch (e) {
            // TODO(jeremy-rifkin) why does e have .code here
            if (e instanceof Error && (e as any).code === 'ENOENT') {
                logger.warn(`LDC AST file ${astFilename} requested but it does not exist`);
                return [{text: ''}];
            }
            throw e;
        }
    }

    // Override the IR file name method for LDC because the output file is different from clang.
    override getIrOutputFilename(inputFilename: string): string {
        const outputFilename = this.getOutputFilename(path.dirname(inputFilename), this.outputFilebase);
        return utils.changeExtension(outputFilename, '.ll');
    }
}