@specs-feup/kadabra/src-api/kadabra/analysis/energy/detectors/ExcessiveMethodCallsDetector.ts

A Java source-to-source compiler written in Typescript

import Query from "@specs-feup/lara/api/weaver/Query.js";
import Collections from "@specs-feup/lara/api/lara/Collections.js";
import BaseDetector from "./BaseDetector.js";
import {
    FileJp,
    Loop,
    Var,
    Call,
    Joinpoint,
    Class,
    RefType,
    Method,
    LoopType,
    LocalVariable,
    ArrayAccess,
    Constructor,
    Declaration,
} from "../../../../Joinpoints.js";

export interface MethodInfo {
    method: Method;
    missingInfo: boolean;
    writes: Var[];
    reads: Var[];
}

export default class ExcessiveMethodCallsDetector extends BaseDetector {
    currentPackage: string | undefined;
    loopGlobalReads: Declaration[] = [];
    loopGlobalWrites: Declaration[] = [];
    loopLocalWrites: Declaration[] = [];
    methodsInfo: MethodInfo[] = [];
    variantCalls: string[] = [];
    missingCallDecl: boolean = false;
    results: Call[] = [];

    constructor(debugEnabled = false) {
        super("Excessive Method Calls Detector", debugEnabled);
    }

    static containsJP(arr: Joinpoint[], jp: Joinpoint) {
        return arr.some((i) => i.equals(jp));
    }

    static tryGetMethodInfo(arr: MethodInfo[], jp: Method) {
        for (const j of arr) {
            if (j.method.equals(jp)) return j;
        }
        return null;
    }

    static addIfNew(arr: Joinpoint[], jp: Joinpoint) {
        if (!ExcessiveMethodCallsDetector.containsJP(arr, jp)) arr.push(jp);
    }

    analyseClass(jpClass: Class) {
        super.analyseClass(jpClass);

        this.currentPackage = jpClass.packageName;
        const fileName = jpClass.getAncestor("file");

        for (const l of Query.searchFrom(jpClass, Loop)) {
            this.printDebugInfo(`\n${fileName} @ L${l.line}`);
            this.analyseLoop(l);
        }
    }

    analyseLoop(jpLoop: Loop) {
        this.resetDetector();

        // First pass to collect information on read/write variables and methods
        this.printDebugInfo("Collect Loop Info:");
        this.collectLoopInfo(jpLoop);

        if (this.debugEnabled) {
            let msg = "Global Reads: ";
            for (const lgr of this.loopGlobalReads) {
                msg += lgr.name + ", ";
            }

            msg += "\nGlobal Writes: ";
            for (const lgw of this.loopGlobalWrites) {
                msg += lgw.name + ", ";
            }

            msg += "\nLocal Writes: ";
            for (const llw of this.loopLocalWrites) {
                msg += llw.name + ", ";
            }

            console.log(msg);
        }

        // Second pass to analyse loop calls against collected loop info
        this.printDebugInfo("Analyse Loop Calls:");
        for (const call of this.getFirstDescendentsOfTypes(jpLoop, ["call"])) {
            this.analyseLoopCall(call);
        }
    }

    print() {
        console.log(`${this.name}:`);
        const data = this.results.map((r) => [
            r.line.toString(),
            r.name,
            (r.getAncestor("file") as FileJp).path,
        ]);
        Collections.printTable(["Line", "Call", "File"], data, [10, 30, 100]);
        console.log();
    }

    resetDetector() {
        this.loopGlobalReads = [];
        this.loopLocalWrites = [];
        this.loopGlobalWrites = [];
        this.methodsInfo = [];
        this.variantCalls = [];
        this.missingCallDecl = false;
    }

    printDebugInfo(msg: string) {
        if (!this.debugEnabled) return;

        console.log(msg);
    }

    save() {
        return this.results.map((r) => {
            let loc = r.name + "(" + r.arguments + "):" + r.line.toString();

            // Initialized inside method
            const jpMethod = r.getAncestor("method") as Method;
            if (jpMethod !== undefined) {
                loc = jpMethod.name + "/" + loc;
            } else {
                const jpConstruct = r.getAncestor("constructor") as Constructor;
                loc = jpConstruct.name + "/" + loc;
            }

            const jpClass = r.getAncestor("class") as Class;
            loc = jpClass.name + "/" + loc;
            const jpFile = jpClass.getAncestor("file") as FileJp;
            loc = jpFile.name + "/" + loc;

            return loc;
        });
    }

    ////////// First pass //////////

    collectLoopInfo(jp: Joinpoint) {
        const addIfNew = ExcessiveMethodCallsDetector.addIfNew;

        for (const child of jp.children) {
            this.collectLoopInfo(child);
        }

        if (jp instanceof Loop && jp.type !== LoopType.FOREACH) {
            if (jp.cond !== undefined) {
                for (const v of Query.searchFrom(jp.cond, Var, {
                    declaration: (d) => d !== undefined,
                })) {
                    addIfNew(this.loopLocalWrites, v.declaration);
                }
            }
        } else if (jp instanceof LocalVariable) {
            addIfNew(this.loopLocalWrites, jp);
        } else if (jp instanceof Var) {
            this.analyseVar(jp);
        } else if (jp instanceof Call) {
            this.analyseCall(jp);
        }
    }

    analyseVar(jpVar: Var) {
        const addIfNew = ExcessiveMethodCallsDetector.addIfNew;

        if (jpVar.declaration === undefined) return;
        const isField = jpVar.isField;
        const access = jpVar.reference;
        if (isField && access === RefType.WRITE) {
            addIfNew(this.loopGlobalWrites, jpVar.declaration);
        } else if (isField && access === RefType.READ) {
            addIfNew(this.loopGlobalReads, jpVar.declaration);
        } else if (isField && access === RefType.READWRITE) {
            addIfNew(this.loopGlobalWrites, jpVar.declaration);
            addIfNew(this.loopGlobalReads, jpVar.declaration);
        } else if (!isField && access === RefType.WRITE) {
            addIfNew(this.loopLocalWrites, jpVar.declaration);
        }
    }

    analyseCall(jpCall: Call) {
        const addIfNew = ExcessiveMethodCallsDetector.addIfNew;

        if (jpCall.decl === undefined) {
            this.missingCallDecl = true;
            this.printDebugInfo("Failed to get declaration of call: " + jpCall);
            return;
        }

        const { writes, reads } = this.analyseMethodRecursive(jpCall.decl);

        for (const w of writes) {
            addIfNew(this.loopGlobalWrites, w.declaration);
        }
        for (const r of reads) {
            addIfNew(this.loopGlobalReads, r.declaration);
        }
    }

    analyseMethodRecursive(jpMethod: Method) {
        const res: { writes: Var[]; reads: Var[] } = { writes: [], reads: [] };

        if (
            ExcessiveMethodCallsDetector.tryGetMethodInfo(
                this.methodsInfo,
                jpMethod
            ) !== null
        )
            return res;

        this.printDebugInfo(
            `Analysing method: ${jpMethod} ${
                jpMethod.line !== undefined ? "@ L" + jpMethod.line : ""
            }`
        );

        const {
            missing: m,
            write: w,
            read: r,
        } = this.getFieldUsageInsideJP(jpMethod);

        res.writes.push(...w);
        res.reads.push(...r);

        const calls = Query.searchFrom(jpMethod, Call).get();
        const callDeclSplit = Collections.partition(
            calls,
            (c) => c.decl !== undefined
        );

        const missingInfo = m.length > 0 || callDeclSplit[1].length > 0;

        this.methodsInfo.push({
            method: jpMethod,
            missingInfo: missingInfo,
            writes: w,
            reads: r,
        });

        for (const call of callDeclSplit[0]) {
            const { writes: wi, reads: ri } = this.analyseMethodRecursive(
                call.decl
            );
            res.writes.push(...wi);
            res.reads.push(...ri);
        }

        return res;
    }

    getFieldUsageInsideJP(jp: Joinpoint) {
        const vars = Query.searchFrom(jp, Var, { isField: true }).get();
        const declSplit = Collections.partition(
            vars,
            (v) => v.declaration !== undefined
        );

        const read = [];
        const write = [];
        for (const v of declSplit[0]) {
            const accessType = v.reference;
            if (accessType === RefType.WRITE) write.push(v);
            else if (accessType === RefType.READ) read.push(v);
            else if (accessType === RefType.READWRITE) {
                read.push(v);
                write.push(v);
            }
        }

        return {
            missing: declSplit[1],
            write: write,
            read: read,
        };
    }

    ////////// Second pass //////////

    analyseLoopCall(jp: Joinpoint) {
        let childCallsInvariant = true;

        for (const child of jp.children) {
            childCallsInvariant &&= this.analyseLoopCall(child);
        }

        if (jp instanceof Call) {
            if (childCallsInvariant && this.isCallInvariant(jp)) {
                this.results.push(jp);
                return true;
            }
            return false;
        }
        return true;
    }

    isCallInvariant(jpCall: Call) {
        if (this.variantCalls.includes(jpCall.toString())) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (repeatVariantCall)`
            );
            return false;
        }

        if (jpCall.decl === undefined) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (noCallDecl)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        if (
            jpCall.decl.body === undefined ||
            jpCall.decl.body.children.length === 0
        ) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (emptyDecl)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        // Overlap check of some arguments. unavoidable until ast can differentiate in "a.foo(bar)" -> argument vars (bar) and all other vars (a)
        const vars = this.getFirstDescendentsOfTypes(jpCall, ["var"]) as Var[];
        for (const v of vars) {
            if (v.declaration === undefined) {
                this.printDebugInfo(
                    `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (noVarDecl)`
                );
                this.variantCalls.push(jpCall.toString());
                return false;
            } else if (
                this.loopLocalWrites.some((w) => w.equals(v.declaration))
            ) {
                this.printDebugInfo(
                    `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (usesLoopVar)`
                );
                this.variantCalls.push(jpCall.toString());
                return false;
            }
        }

        if (jpCall.descendants.some((d) => d instanceof ArrayAccess)) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (containsArrayAccess)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        const mi = ExcessiveMethodCallsDetector.tryGetMethodInfo(
            this.methodsInfo,
            jpCall.decl
        );

        if (mi === null) {
            throw new Error("Failed to get MethodInfo");
        }

        if (mi.missingInfo) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (methodMissingInfo)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        const mir = mi.reads.map((r) => r.declaration);
        const miw = mi.writes.map((w) => w.declaration);
        const cmr2lw = this.compareFieldUsage(mir, this.loopGlobalWrites);
        const cmw2lr = this.compareFieldUsage(miw, this.loopGlobalReads);
        if (cmr2lw || cmw2lr) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (variantMethodFields)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        const { isVariant, cause } = this.callUsesVariantArgument(jpCall);
        if (isVariant) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (${cause})`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        if (this.callInvokesVariantMethod(jpCall.decl)) {
            this.printDebugInfo(
                `Call: ${jpCall} @ L${jpCall.line} -> VARIANT (variantMethodCalls)`
            );
            this.variantCalls.push(jpCall.toString());
            return false;
        }

        if (jpCall.name === "next") {
            console.log(jpCall.decl.body);
        }

        this.printDebugInfo(`Call: ${jpCall} @ L${jpCall.line} -> INVARIANT`);
        return true;
    }

    compareFieldUsage(arr1: Joinpoint[], arr2: Joinpoint[]) {
        return arr1.some((r) => arr2.some((w) => w.equals(r)));
    }

    callUsesVariantArgument(jpCall: Call) {
        // Gather arguments
        const args = jpCall.children.slice(1);

        const varArgs = args.filter((arg: Joinpoint) => arg instanceof Var);
        const callArgs = args.filter((arg: Joinpoint) => arg instanceof Call);

        // If any call argument is already tagged as variant, this call is also variant
        if (callArgs.some((c) => this.variantCalls.includes(c.toString())))
            return { isVariant: true, cause: "variantCallAsArgument" };

        // Check variables
        for (const v of varArgs) {
            const vDecl = v.declaration;

            // Unknown field used as argument
            const unknField = vDecl === undefined;
            if (unknField) return { isVariant: true, cause: "noVarDecl" };

            // Read field but unknown call exists in loop
            if (v.isField && this.missingCallDecl)
                return {
                    isVariant: true,
                    cause: "usesField + missingCallDecl",
                };

            // Reads variable changed by loop
            if (
                !unknField &&
                (ExcessiveMethodCallsDetector.containsJP(
                    this.loopGlobalWrites,
                    vDecl
                ) ||
                    ExcessiveMethodCallsDetector.containsJP(
                        this.loopLocalWrites,
                        vDecl
                    ))
            )
                return { isVariant: true, cause: "varChangedInLoop" };
        }

        // Check calls recursively

        return { isVariant: false, cause: "" };
    }

    callInvokesVariantMethod(jp: Joinpoint): boolean {
        for (const child of jp.children) {
            const isVariant = this.callInvokesVariantMethod(child);
            if (isVariant) return isVariant;
        }

        if (jp instanceof Call) {
            return !this.isCallInvariant(jp);
        }

        return false;
    }

    getFirstDescendentsOfTypes(jp: Joinpoint, types: string[]): Joinpoint[] {
        if (types.some((type) => jp.instanceOf(type))) {
            return [jp];
        } else {
            const matches = [];
            for (const child of jp.children) {
                matches.push(...this.getFirstDescendentsOfTypes(child, types));
            }
            return matches;
        }
    }
}