Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add crash log handling. #13253

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
47 changes: 36 additions & 11 deletions Extension/src/LanguageServer/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1048,13 +1048,16 @@ export function watchForCrashes(crashDirectory: string): void {
let previousCrashData: string;
let previousCrashCount: number = 0;

function logCrashTelemetry(data: string, type: string, offsetData?: string): void {
function logCrashTelemetry(data: string, type: string, offsetData?: string, crashLog?: string): void {
const crashObject: Record<string, string> = {};
const crashCountObject: Record<string, number> = {};
crashObject.CrashingThreadCallStack = data;
if (offsetData !== undefined) {
crashObject.CrashingThreadCallStackOffsets = offsetData;
}
if (crashLog !== undefined) {
crashObject.CrashLog = crashLog;
}
previousCrashCount = data === previousCrashData ? previousCrashCount + 1 : 0;
previousCrashData = data;
crashCountObject.CrashCount = previousCrashCount + 1;
Expand All @@ -1065,8 +1068,8 @@ function logMacCrashTelemetry(data: string): void {
logCrashTelemetry(data, "MacCrash");
}

function logCppCrashTelemetry(data: string, offsetData?: string): void {
logCrashTelemetry(data, "CppCrash", offsetData);
function logCppCrashTelemetry(data: string, offsetData?: string, crashLog?: string): void {
logCrashTelemetry(data, "CppCrash", offsetData, crashLog);
}

function handleMacCrashFileRead(err: NodeJS.ErrnoException | undefined | null, data: string): void {
Expand Down Expand Up @@ -1167,6 +1170,10 @@ function handleMacCrashFileRead(err: NodeJS.ErrnoException | undefined | null, d
logMacCrashTelemetry(data);
}

function containsUnexpectedTelemetryCharacter(str: string): boolean {
return str.includes("/") || str.includes("\\") || str.includes("@");
}

async function handleCrashFileRead(crashDirectory: string, crashFile: string, crashDate: Date, err: NodeJS.ErrnoException | undefined | null, data: string): Promise<void> {
if (err) {
if (err.code === "ENOENT") {
Expand All @@ -1186,15 +1193,33 @@ async function handleCrashFileRead(crashDirectory: string, crashFile: string, cr
const endOffsetStr: string = isMac ? " " : " <";
const dotStr: string = "\n…";
let signalType: string;
if (lines[0].startsWith("SIG")) {
signalType = lines[0];
let crashLog: string = "";
let crashStackStartLine: number = 0;
if (lines[0] === "LOG") {
let crashLogLine: number = 1;
for (; crashLogLine < lines.length; ++crashLogLine) {
const pendingCrashLogLine = lines[crashLogLine];
if (pendingCrashLogLine === "ENDLOG") {
break;
}
if (!containsUnexpectedTelemetryCharacter(pendingCrashLogLine)) {
crashLog += pendingCrashLogLine + "\n";
} else {
crashLog += "<unexpectedCharacter>\n";
}
}
crashLog = crashLog.trimEnd();
crashStackStartLine = ++crashLogLine;
}
if (lines[crashStackStartLine].startsWith("SIG")) {
signalType = lines[crashStackStartLine];
} else {
// The signal type may fail to be written.
signalType = "SIG-??\n"; // Intentionally different from SIG-? from cpptools.
}
let crashCallStack: string = "";
let validFrameFound: boolean = false;
for (let lineNum: number = 0; lineNum < lines.length - 3; ++lineNum) { // skip last lines
for (let lineNum: number = crashStackStartLine; lineNum < lines.length - 3; ++lineNum) { // skip last lines
const line: string = lines[lineNum];
const startPos: number = line.indexOf(startStr);
if (startPos === -1 || line[startPos + (isMac ? 1 : 4)] === "+") {
Expand Down Expand Up @@ -1251,7 +1276,7 @@ async function handleCrashFileRead(crashDirectory: string, crashFile: string, cr
const offsetPos2: number = offsetPos + offsetStr.length;
if (isMac) {
const pendingOffset: string = line.substring(offsetPos2);
if (!pendingOffset.includes("/") && !pendingOffset.includes("\\") && !pendingOffset.includes("@")) {
if (!containsUnexpectedTelemetryCharacter(pendingOffset)) {
crashCallStack += pendingOffset;
} else {
crashCallStack += "<offsetUnexpectedCharacter>";
Expand All @@ -1270,7 +1295,7 @@ async function handleCrashFileRead(crashDirectory: string, crashFile: string, cr
continue; // unexpected
}
const pendingOffset: string = line.substring(offsetPos2, endPos);
if (!pendingOffset.includes("/") && !pendingOffset.includes("\\") && !pendingOffset.includes("@")) {
if (!containsUnexpectedTelemetryCharacter(pendingOffset)) {
crashCallStack += pendingOffset;
} else {
crashCallStack += "<offsetUnexpectedCharacter>";
Expand All @@ -1282,7 +1307,7 @@ async function handleCrashFileRead(crashDirectory: string, crashFile: string, cr
prevCppCrashCallStackData = crashCallStack;

if (lines.length >= 6 && util.getLoggingLevel() >= 1) {
getCrashCallStacksChannel().appendLine(`\n${isCppToolsSrv ? "cpptools-srv" : "cpptools"}\n${crashDate.toLocaleString()}\n${signalType}${crashCallStack}`);
getCrashCallStacksChannel().appendLine(`\n${isCppToolsSrv ? "cpptools-srv" : "cpptools"}\n${crashDate.toLocaleString()}\n${signalType}${crashCallStack}\n\n${crashLog}`);
}
}

Expand All @@ -1292,11 +1317,11 @@ async function handleCrashFileRead(crashDirectory: string, crashFile: string, cr
data = data.substring(0, 8191) + "…";
}

if (addressData.includes("/") || addressData.includes("\\") || addressData.includes("@")) {
if (containsUnexpectedTelemetryCharacter(addressData)) {
addressData = "<addressDataUnexpectedCharacter>";
}

logCppCrashTelemetry(data, addressData);
logCppCrashTelemetry(data, addressData, crashLog);

await util.deleteFile(path.resolve(crashDirectory, crashFile)).catch(logAndReturn.undefined);
if (crashFile === "cpptools.txt") {
Expand Down