Files

90 lines
3.5 KiB
TypeScript

// Copyright (c) 2022, 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 type {ExecutionOptions} from '../../types/compilation/compilation.interfaces.js';
import type {UnprocessedExecResult} from '../../types/execution/execution.interfaces.js';
import {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces.js';
export interface ObjdumpResult {
code: number;
stdout?: string;
stderr?: string;
objdumpTime?: string;
asm?: string;
}
export abstract class BaseObjdumper {
constructor(
protected readonly intelAsmOptions: string[],
protected readonly widthOptions: string[],
) {}
getArgs(
outputFilename: string,
demangle?: boolean,
intelAsm?: boolean,
staticReloc?: boolean,
dynamicReloc?: boolean,
objdumperArguments?: string[],
filters?: ParseFiltersAndOutputOptions,
) {
const args = ['-d', outputFilename, '-l', ...this.widthOptions];
if (staticReloc) args.push('-r');
if (dynamicReloc) args.push('-R');
if (demangle) args.push('-C');
if (intelAsm) args.push(...this.intelAsmOptions);
if (objdumperArguments) args.push(...objdumperArguments);
return args;
}
async executeObjdump(
objdumperPath: string,
args: string[],
execOptions: ExecutionOptions,
exec: (filepath: string, args: string[], options: ExecutionOptions) => Promise<UnprocessedExecResult>,
): Promise<ObjdumpResult> {
const objResult = await exec(objdumperPath, args, execOptions);
if (objResult.code === 0) {
return {
code: 0,
objdumpTime: objResult.execTime.toString(),
asm: objResult.stdout,
};
}
return {
code: objResult.code,
stderr: objResult.stderr,
};
}
// There's no way in TS to do an abstract static members and interfaces don't allow "static" at all.
// There's apparently a hack with InstanceType but I couldn't get it working. I think this is the best solution.
static get key(): string {
throw new Error('Objdumper must provide a `static get key()` implementation');
}
}