@specs-feup/clava
Version:
A C/C++ source-to-source compiler written in Typescript
254 lines • 10.2 kB
JavaScript
import IdGenerator from "@specs-feup/lara/api/lara/util/IdGenerator.js";
import PrintOnce from "@specs-feup/lara/api/lara/util/PrintOnce.js";
import Query from "@specs-feup/lara/api/weaver/Query.js";
import { Call, FileJp, FunctionJp, Scope } from "../../Joinpoints.js";
import Clava from "../Clava.js";
import ClavaJoinPoints from "../ClavaJoinPoints.js";
import MemoiUtils from "./MemoiUtils.js";
/**
* Library to instrument applications with the memoiprof profiling library.
*
* @param targetSig - The signature of the target funtion
* @param id - Unique ID representing this function
* @param reportDir - Path to the directory where the report will be saved (does not need trailing /)
*/
export default class MemoiProf {
target;
id;
reportDir;
/**
* Options for memoiprof.
*/
memoiprofOptions = new MemoiprofOptions();
constructor(target, id, reportDir) {
this.target = target;
this.id = id.replace(" ", "_");
this.reportDir = reportDir;
// Deal with dependecy to memoiprof
PrintOnce.message("Woven code has dependency to project memoiprof, which can be found at https://github.com/cc187/memoiprof");
Clava.getProgram().addProjectFromGit("https://github.com/cc187/memoiprof.git", ["mp"]);
}
setSampling(samplingKind, samplingRate) {
this.memoiprofOptions.setSampling(samplingKind, samplingRate);
}
setPeriodicReporting(periodicReportKind, periodicReportRate) {
this.memoiprofOptions.setPeriodicReporting(periodicReportKind, periodicReportRate);
}
setCulling(cullingKind, cullingRatio) {
this.memoiprofOptions.setCulling(cullingKind, cullingRatio);
}
setApprox(approxKind, approxBits) {
this.memoiprofOptions.setApprox(approxKind, approxBits);
}
/**
* Profiles all calls of the target function. This includes making a single
* wrapper for all calls and adding the memoization profiling code inside this
* wrapper.
* */
profAll() {
const cSig = MemoiUtils.cSig(this.target.sig);
const wrapperName = "mw_" + cSig;
const monitorName = "mp_" + cSig;
const monitorType = ClavaJoinPoints.typeLiteral("MemoiProf*");
// make the wrapper
for (const $call of Query.search(Call, {
signature: (s) => this.target.sig === MemoiUtils.normalizeSig(s),
})) {
$call.wrap(wrapperName);
}
// instrument the wrapper
this.memoiInstrumentWrapper(wrapperName, monitorName, monitorType);
// setup
this.memoiSetup(monitorName, monitorType, this.id, ["global"]);
}
/**
* Profiles each call to the target function separately. This includes
* making a wrapper for each call and adding the memoization profiling code
* inside the wrapper.
* */
profEach() {
const cSig = MemoiUtils.cSig(this.target.sig);
const wrapperNameBase = "mw_" + cSig;
const monitorNameBase = "mp_" + cSig;
const monitorType = ClavaJoinPoints.typeLiteral("MemoiProf*");
for (const $call of Query.search(Call, {
signature: (s) => this.target.sig === MemoiUtils.normalizeSig(s),
})) {
// make the wrapper
const wrapperName = IdGenerator.next(wrapperNameBase);
$call.wrap(wrapperName);
// instrument the wrapper
const monitorName = IdGenerator.next(monitorNameBase);
this.memoiInstrumentWrapper(wrapperName, monitorName, monitorType);
const callSiteInfo = $call.location;
// setup
const id = IdGenerator.next(this.id + "_");
this.memoiSetup(monitorName, monitorType, id, [callSiteInfo]);
}
}
memoiInstrumentWrapper(wrapperName, monitorName, monitorType) {
const numInputs = this.target.numInputs;
const numOutputs = this.target.numOutputs;
const query = Query.search(FileJp)
.search(FunctionJp, { name: wrapperName })
.search(Call)
.chain();
for (const row of query) {
let code = "mp_inc(" + monitorName;
const $params = row["function"].params;
for (let i = 0; i < numInputs; i++) {
code += ", &" + $params[i].name;
}
if (numOutputs == 1) {
code += ", &result";
}
else {
for (let o = numInputs; o < $params.length; o++) {
code += ", " + $params[o].name;
}
}
code += ");";
const $call = row["call"];
$call.insert("after", code);
$call.insert("after", "#pragma omp critical"); // needed for correct semantics under OpenMP
const $file = row["file"];
$file.addGlobal(monitorName, monitorType, "NULL");
$file.addInclude("MemoiProfiler.h", false);
$file.addInclude("stdlib.h", true);
}
}
memoiSetup(monitorName, monitorType, id, callSiteInfo) {
const inputsCode = this.target.inputTypes
.map(function (e) {
return "mp_" + e;
})
.join(",")
.toUpperCase();
const outputsCode = this.target.outputTypes
.map(function (e) {
return "mp_" + e;
})
.join(",")
.toUpperCase();
const query = Query.search(FileJp)
.search(FunctionJp, { name: "main" })
.children(Scope)
.chain()[0];
if (query !== undefined) {
throw new Error("MemoiProf: Could not find main function needed for setup");
}
const memoiReportPath = "path_" + monitorName;
const $body = query["scope"];
// memoiprof options
if (this.memoiprofOptions.samplingKind !== SamplingKind.OFF) {
const samplingKind = "MP_SAMPLING_" + this.memoiprofOptions.samplingKind.toUpperCase();
$body.insertBegin(`mp_set_sampling(${monitorName}, ${samplingKind}, ${this.memoiprofOptions.samplingRate});`);
}
if (this.memoiprofOptions.periodicReportKind) {
$body.insertBegin(`mp_set_periodic_reporting(${monitorName}, MP_PERIODIC_ON, ${this.memoiprofOptions.periodicReportRate});`);
}
if (this.memoiprofOptions.cullingKind) {
$body.insertBegin(`mp_set_culling(${monitorName}, MP_CULLING_ON, ${this.memoiprofOptions.cullingRatio});`);
}
if (this.memoiprofOptions.approxKind) {
$body.insertBegin(`mp_set_approx(${monitorName}, MP_APPROX_ON, ${this.memoiprofOptions.approxBits});`);
}
this.memoiAddCallSiteInfo($body, callSiteInfo, monitorName);
$body.insertBegin(`free(${memoiReportPath});`); // can free here, since mp_init duped it
$body.insertBegin(`${monitorName} = mp_init("${this.target.sig}", "${id}", ${memoiReportPath}, ${this.target.inputTypes.length}, ${this.target.outputTypes.length}, ${inputsCode}, ${outputsCode});`);
$body.insertBegin(`char* ${memoiReportPath} = mp_make_report_path("${this.reportDir}", "${monitorName}");`);
/* add functions to print and clean up at every return on main */
const $function = query["function"];
$function.insertReturn(`mp_to_json(${monitorName});`);
$function.insertReturn(`${monitorName} = mp_destroy(${monitorName});`);
const $file = query["file"];
$file.addGlobal(monitorName, monitorType, "NULL");
$file.addInclude("MemoiProfiler.h", false);
$file.addInclude("stdlib.h", true);
}
memoiAddCallSiteInfo($mainBody, callSiteInfo = ["global"], monitorName) {
const length = callSiteInfo.length;
$mainBody.insertBegin("mp_set_call_sites(" +
monitorName +
", " +
length +
", " +
callSiteInfo.map((i) => `"${i}"`).join(", ") +
");");
}
}
export var SamplingKind;
(function (SamplingKind) {
SamplingKind["RANDOM"] = "random";
SamplingKind["FIXED"] = "fixed";
SamplingKind["OFF"] = "off";
})(SamplingKind || (SamplingKind = {}));
/**
* Class used to store memoiprof options.
* */
export class MemoiprofOptions {
_samplingKind = SamplingKind.OFF;
_samplingRate = 0;
_periodicReportKind = false;
_periodicReportRate = 0;
_cullingKind = false;
_cullingRatio = 0.0;
_approxKind = false;
_approxBits = 0;
get samplingKind() {
return this._samplingKind;
}
get samplingRate() {
return this._samplingRate;
}
get periodicReportKind() {
return this._periodicReportKind;
}
get periodicReportRate() {
return this._periodicReportRate;
}
get cullingKind() {
return this._cullingKind;
}
get cullingRatio() {
return this._cullingRatio;
}
get approxKind() {
return this._approxKind;
}
get approxBits() {
return this._approxBits;
}
/**
* Supported samplingKind values are: 'random', 'fixed', 'off'.
* For 1/x sampling, samplingRate should be x.
* */
setSampling(samplingKind, samplingRate) {
this._samplingKind = samplingKind;
this._samplingRate = samplingRate;
}
/**
* Supported periodicReportKind values are: true, false.
* periodicReportRate is the number of calls between writes of periodic reports.
* */
setPeriodicReporting(periodicReportKind, periodicReportRate) {
this._periodicReportKind = periodicReportKind;
this._periodicReportRate = periodicReportRate;
}
/**
* Supported cullingKind values are: true, false.
* cullingRatio is the threshold (% of calls) for printing to the JSON.
* */
setCulling(cullingKind, cullingRatio) {
this._cullingKind = cullingKind;
this._cullingRatio = cullingRatio;
}
/**
* Supported approxKind values are: true, false.
* */
setApprox(approxKind, approxBits) {
this._approxKind = approxKind;
this._approxBits = approxBits;
}
}
//# sourceMappingURL=MemoiProf.js.map