Add registerLimit config option to specify the registers to list in Registers view

chenzhiy2001 · chenzhiy2001 · commit 97efe10d1f0c · 2024-09-19T21:13:38.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,8 @@ Versioning].
   enabled by default ([@JacquesLucke])
 - Suppress error for hover as the user may just play with the mouse ([@oltolm]).
 - solve the problem of failed parsing of containers ([@henryriley0])
+- Fixes #421 - Added `registerLimit` option to specify the registers to
+  display - PR #444 ([@chenzhiy2001])
 
 ## [0.27.0] - 2024-02-07
 
@@ -243,6 +245,7 @@ Versioning].
 [@abussy-aldebaran]: https://github.com/abussy-aldebaran
 [@anshulrouthu]: https://github.com/anshulrouthu
 [@brownts]: https://github.com/brownts
+[@chenzhiy2001]: https://github.com/chenzhiy2001
 [@coldencullen]: https://github.com/ColdenCullen
 [@eamousing]: https://github.com/eamousing
 [@evangrayk]: https://github.com/evangrayk
diff --git a/README.md b/README.md
@@ -81,6 +81,20 @@ that location prior to continuing execution.  Note that stopping at the entry po
 attach configuration assumes that the entry point has not yet been entered at the time of
 attach, otherwise this will have no affect.
 
+There is a Registers view in the VARIABLES view. As we fetch all registers at once, there can
+be cases where a register that cannot be fetched causes the entire register request to fail,
+corrupting the entire Registers output. If this happens, you might need to set the
+`registerLimit` option to specify which registers you want the debugger to fetch
+automatically.
+
+For example, to display only registers `rax` and `rip` in an x64 debug session, send the
+command `-data-list-register-names` in the debug console of an active x64 debug session.
+You will then receive a response containing an array starting with `["rax","rbx" ...]`.
+In this array, the index of `rax` is 0 and `rip` is 16, so set the option as
+`"registerLimit": "0 16"`. If you find the response text hard to navigate, you can paste
+it into a browser's developer tools console and press enter to get an expandable response
+object with array elements' indices explicitly displayed.
+
 ### Attaching to existing processes
 
 Attaching to existing processes currently only works by specifying the PID in the
diff --git a/package.json b/package.json
@@ -299,6 +299,11 @@
 										"description": "Content will be executed on the SSH host before the debugger call."
 									}
 								}
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					},
@@ -468,6 +473,11 @@
 										"description": "Content will be executed on the SSH host before the debugger call."
 									}
 								}
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					}
@@ -766,6 +776,11 @@
 										"description": "Content will be executed on the SSH host before the debugger call."
 									}
 								}
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					},
@@ -846,6 +861,11 @@
 								],
 								"description": "Whether debugger should stop at application entry point",
 								"default": false
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					}
@@ -992,6 +1012,11 @@
 								"type": "array",
 								"description": "mago commands to run when starting to debug",
 								"default": []
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					},
@@ -1057,6 +1082,11 @@
 								"type": "boolean",
 								"description": "Whether debugger should stop after connecting to target",
 								"default": false
+							},
+							"registerLimit": {
+								"type": "string",
+								"description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",
+								"default": ""
 							}
 						}
 					}
diff --git a/src/backend/mi2/mi2.ts b/src/backend/mi2/mi2.ts
@@ -883,7 +883,7 @@ export class MI2 extends EventEmitter implements IBackend {
 	async getRegisterValues(): Promise<RegisterValue[]> {
 		if (trace)
 			this.log("stderr", "getRegisterValues");
-		const result = await this.sendCommand("data-list-register-values N");
+		const result = await this.sendCommand("data-list-register-values --skip-unavailable N " + this.registerLimit);
 		const nodes = result.result('register-values');
 		if (!Array.isArray(nodes)) {
 			throw new Error('Failed to retrieve register values.');
@@ -1024,6 +1024,7 @@ export class MI2 extends EventEmitter implements IBackend {
 	debugOutput: boolean;
 	features: string[];
 	public procEnv: any;
+	public registerLimit: string;
 	protected isSSH: boolean;
 	protected sshReady: boolean;
 	protected currentToken: number = 1;
diff --git a/src/gdb.ts b/src/gdb.ts
@@ -20,6 +20,7 @@ export interface LaunchRequestArguments extends DebugProtocol.LaunchRequestArgum
 	frameFilters: boolean;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 export interface AttachRequestArguments extends DebugProtocol.AttachRequestArguments {
@@ -39,6 +40,7 @@ export interface AttachRequestArguments extends DebugProtocol.AttachRequestArgum
 	frameFilters: boolean;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 class GDBDebugSession extends MI2DebugSession {
@@ -75,6 +77,7 @@ class GDBDebugSession extends MI2DebugSession {
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
 		this.stopAtEntry = args.stopAtEntry;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		if (args.ssh !== undefined) {
 			if (args.ssh.forwardX11 === undefined)
 				args.ssh.forwardX11 = true;
@@ -120,6 +123,7 @@ class GDBDebugSession extends MI2DebugSession {
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
 		this.stopAtEntry = args.stopAtEntry;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		if (args.ssh !== undefined) {
 			if (args.ssh.forwardX11 === undefined)
 				args.ssh.forwardX11 = true;
diff --git a/src/lldb.ts b/src/lldb.ts
@@ -18,6 +18,7 @@ export interface LaunchRequestArguments extends DebugProtocol.LaunchRequestArgum
 	valuesFormatting: ValuesFormattingMode;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 export interface AttachRequestArguments extends DebugProtocol.AttachRequestArguments {
@@ -34,6 +35,7 @@ export interface AttachRequestArguments extends DebugProtocol.AttachRequestArgum
 	valuesFormatting: ValuesFormattingMode;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 class LLDBDebugSession extends MI2DebugSession {
@@ -66,6 +68,7 @@ class LLDBDebugSession extends MI2DebugSession {
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
 		this.stopAtEntry = args.stopAtEntry;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		if (args.ssh !== undefined) {
 			if (args.ssh.forwardX11 === undefined)
 				args.ssh.forwardX11 = true;
@@ -110,6 +113,7 @@ class LLDBDebugSession extends MI2DebugSession {
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
 		this.stopAtEntry = args.stopAtEntry;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		this.miDebugger.attach(args.cwd, args.executable, args.target, args.autorun || []).then(() => {
 			this.sendResponse(response);
 		}, err => {
diff --git a/src/mago.ts b/src/mago.ts
@@ -15,6 +15,7 @@ export interface LaunchRequestArguments extends DebugProtocol.LaunchRequestArgum
 	valuesFormatting: ValuesFormattingMode;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 export interface AttachRequestArguments extends DebugProtocol.AttachRequestArguments {
@@ -29,6 +30,7 @@ export interface AttachRequestArguments extends DebugProtocol.AttachRequestArgum
 	valuesFormatting: ValuesFormattingMode;
 	printCalls: boolean;
 	showDevDebugOutput: boolean;
+	registerLimit: string;
 }
 
 class MagoDebugSession extends MI2DebugSession {
@@ -66,6 +68,7 @@ class MagoDebugSession extends MI2DebugSession {
 		this.setValuesFormattingMode(args.valuesFormatting);
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		this.miDebugger.load(args.cwd, args.target, args.arguments, undefined, args.autorun || []).then(() => {
 			this.sendResponse(response);
 		}, err => {
@@ -88,6 +91,7 @@ class MagoDebugSession extends MI2DebugSession {
 		this.setValuesFormattingMode(args.valuesFormatting);
 		this.miDebugger.printCalls = !!args.printCalls;
 		this.miDebugger.debugOutput = !!args.showDevDebugOutput;
+		this.miDebugger.registerLimit = args.registerLimit ?? "";
 		this.miDebugger.attach(args.cwd, args.executable, args.target, args.autorun || []).then(() => {
 			this.sendResponse(response);
 		}, err => {

Original file line number	Diff line number	Diff line change
`@@ -299,6 +299,11 @@`
`299`	`299`	`"description": "Content will be executed on the SSH host before the debugger call."`
`300`	`300`	`}`
`301`	`301`	`}`
	`302`	`+ },`
	`303`	`+ "registerLimit": {`
	`304`	`+ "type": "string",`
	`305`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`306`	`+ "default": ""`
`302`	`307`	`}`
`303`	`308`	`}`
`304`	`309`	`},`
`@@ -468,6 +473,11 @@`
`468`	`473`	`"description": "Content will be executed on the SSH host before the debugger call."`
`469`	`474`	`}`
`470`	`475`	`}`
	`476`	`+ },`
	`477`	`+ "registerLimit": {`
	`478`	`+ "type": "string",`
	`479`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`480`	`+ "default": ""`
`471`	`481`	`}`
`472`	`482`	`}`
`473`	`483`	`}`
`@@ -766,6 +776,11 @@`
`766`	`776`	`"description": "Content will be executed on the SSH host before the debugger call."`
`767`	`777`	`}`
`768`	`778`	`}`
	`779`	`+ },`
	`780`	`+ "registerLimit": {`
	`781`	`+ "type": "string",`
	`782`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`783`	`+ "default": ""`
`769`	`784`	`}`
`770`	`785`	`}`
`771`	`786`	`},`
`@@ -846,6 +861,11 @@`
`846`	`861`	`],`
`847`	`862`	`"description": "Whether debugger should stop at application entry point",`
`848`	`863`	`"default": false`
	`864`	`+ },`
	`865`	`+ "registerLimit": {`
	`866`	`+ "type": "string",`
	`867`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`868`	`+ "default": ""`
`849`	`869`	`}`
`850`	`870`	`}`
`851`	`871`	`}`
`@@ -992,6 +1012,11 @@`
`992`	`1012`	`"type": "array",`
`993`	`1013`	`"description": "mago commands to run when starting to debug",`
`994`	`1014`	`"default": []`
	`1015`	`+ },`
	`1016`	`+ "registerLimit": {`
	`1017`	`+ "type": "string",`
	`1018`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`1019`	`+ "default": ""`
`995`	`1020`	`}`
`996`	`1021`	`}`
`997`	`1022`	`},`
`@@ -1057,6 +1082,11 @@`
`1057`	`1082`	`"type": "boolean",`
`1058`	`1083`	`"description": "Whether debugger should stop after connecting to target",`
`1059`	`1084`	`"default": false`
	`1085`	`+ },`
	`1086`	`+ "registerLimit": {`
	`1087`	`+ "type": "string",`
	`1088`	`+ "description": "List of numbers specifying the registers to display. An empty string indicates that the contents of all the registers must be returned.",`
	`1089`	`+ "default": ""`
`1060`	`1090`	`}`
`1061`	`1091`	`}`
`1062`	`1092`	`}`