From 888c8c911d6cde96596fdb64936ceb2958cd4acf Mon Sep 17 00:00:00 2001 From: Dan <46821332+nsadeveloper789@users.noreply.github.com> Date: Wed, 18 Jan 2023 12:22:26 -0500 Subject: [PATCH] GP-2676: Breakpoints can now be placed in emulator with Sleigh injections or custom conditions. --- .../Debugger/data/debugger.theme.properties | 10 +- .../DebuggerBreakpointMarkerPlugin.html | 4 +- .../DebuggerBreakpointsPlugin.html | 265 ++++-- .../images/DebuggerBreakpointsPlugin.png | Bin 27939 -> 27493 bytes .../DebuggerControlPlugin.html | 113 +-- .../DebuggerEmulationServicePlugin.html | 23 +- .../DebuggerModulesPlugin.html | 7 + .../DebuggerThreadsPlugin.html | 98 +-- .../images/DebuggerThreadsPlugin.png | Bin 20532 -> 18655 bytes .../DebuggerTimePlugin.html | 35 +- .../DebuggerTraceViewDiffPlugin.html | 12 +- .../event/TraceActivatedPluginEvent.java | 10 +- .../TraceInactiveCoordinatesPluginEvent.java | 34 + .../core/debug/gui/DebuggerResources.java | 46 +- .../AbstractDebuggerSleighInputDialog.java | 140 ++++ .../gui/breakpoint/BreakpointLocationRow.java | 10 +- .../DebuggerBreakpointMarkerPlugin.java | 88 +- .../DebuggerBreakpointsProvider.java | 368 +++++++-- .../DebuggerSleighExpressionInputDialog.java | 47 ++ .../DebuggerSleighSemanticInputDialog.java | 47 ++ .../gui/breakpoint/LogicalBreakpointRow.java | 6 + .../gui/console/DebuggerConsoleProvider.java | 2 +- .../gui/control/DebuggerControlPlugin.java | 27 +- .../debug/gui/copying/DebuggerCopyPlan.java | 3 +- .../gui/listing/DebuggerListingProvider.java | 1 - .../memory/DebuggerLegacyRegionsPanel.java | 2 +- .../gui/memory/DebuggerRegionsProvider.java | 10 +- .../modules/DebuggerLegacyModulesPanel.java | 2 +- .../modules/DebuggerLegacySectionsPanel.java | 2 +- .../gui/modules/DebuggerModulesProvider.java | 10 +- .../DebuggerStaticMappingProvider.java | 3 +- .../gui/objects/DebuggerObjectsProvider.java | 3 +- .../gui/stack/DebuggerStackProvider.java | 8 +- .../thread/DebuggerLegacyThreadsPanel.java | 3 +- .../gui/thread/DebuggerThreadsProvider.java | 66 +- .../debug/gui/time/DebuggerTimeProvider.java | 56 +- .../breakpoint/BreakpointActionItem.java | 30 + .../breakpoint/BreakpointActionSet.java | 90 +- ...ebuggerLogicalBreakpointServicePlugin.java | 325 +++++--- .../DeleteEmuBreakpointActionItem.java | 39 + ... => DeleteTargetBreakpointActionItem.java} | 27 +- .../DisableEmuBreakpointActionItem.java | 34 + ...=> DisableTargetBreakpointActionItem.java} | 27 +- .../EnableEmuBreakpointActionItem.java | 33 + ... => EnableTargetBreakpointActionItem.java} | 27 +- .../breakpoint/LogicalBreakpointInternal.java | 414 +--------- .../breakpoint/LoneLogicalBreakpoint.java | 24 +- .../breakpoint/MappedLogicalBreakpoint.java | 117 ++- .../breakpoint/PlaceBreakpointActionItem.java | 73 -- .../PlaceEmuBreakpointActionItem.java | 114 +++ .../PlaceTargetBreakpointActionItem.java | 41 + .../service/breakpoint/ProgramBreakpoint.java | 496 +++++++++++ .../breakpoint/TraceBreakpointSet.java | 463 +++++++++++ .../DebuggerStateEditingServicePlugin.java | 232 ++---- .../DebuggerEmulationServicePlugin.java | 41 +- .../emulation/ProgramEmulationUtils.java | 69 +- .../model/DebuggerModelServicePlugin.java | 4 +- .../DebuggerTraceManagerServicePlugin.java | 173 ++-- ...dRowWrappedEnumeratedColumnTableModel.java | 6 +- .../DebuggerLogicalBreakpointService.java | 42 +- .../services/DebuggerStateEditingService.java | 47 +- .../services/DebuggerTraceManagerService.java | 93 ++- .../app/services/LogicalBreakpoint.java | 40 + .../ghidra/app/services/StateEditingMode.java | 431 ++++++++++ .../ghidra/debug/flatapi/FlatDebuggerAPI.java | 5 +- .../ghidra/pcode/exec/DebuggerPcodeUtils.java | 7 +- .../DebuggerBreakpointsPluginScreenShots.java | 23 +- .../stack/DebuggerStackPluginScreenShots.java | 3 +- .../VariableValueHoverPluginScreenShots.java | 3 +- .../disassemble/DebuggerDisassemblyTest.java | 15 +- .../AbstractGhidraHeadedDebuggerGUITest.java | 18 + .../DebuggerBreakpointMarkerPluginTest.java | 74 +- ...DebuggerBreakpointsProviderObjectTest.java | 87 +- .../DebuggerBreakpointsProviderTest.java | 110 +++ .../control/DebuggerControlPluginTest.java | 43 +- .../DebuggerMemoryBytesProviderTest.java | 17 +- .../DebuggerRegistersProviderTest.java | 8 +- .../DebuggerThreadsProviderLegacyTest.java | 51 -- .../thread/DebuggerThreadsProviderTest.java | 53 +- .../watch/DebuggerWatchesProviderTest.java | 7 +- ...gerLogicalBreakpointServiceObjectTest.java | 87 +- .../DebuggerLogicalBreakpointServiceTest.java | 126 ++- .../DebuggerStateEditingServiceTest.java | 49 +- .../DebuggerEmulationServiceTest.java | 127 +++ .../DebuggerTraceManagerServiceTest.java | 26 +- .../core/debug/stack/StackUnwinderTest.java | 13 +- .../debug/flatapi/FlatDebuggerAPITest.java | 9 +- .../pcode/exec/trace/TraceSleighUtils.java | 4 +- .../breakpoint/DBTraceBreakpoint.java | 70 +- .../breakpoint/DBTraceBreakpointSpace.java | 2 +- .../DBTraceObjectBreakpointLocation.java | 60 +- .../DBTraceObjectBreakpointSpec.java | 23 +- .../main/java/ghidra/trace/model/Trace.java | 10 + .../model/breakpoint/TraceBreakpoint.java | 51 +- .../model/breakpoint/TraceBreakpointKind.java | 2 + .../TraceObjectBreakpointLocation.java | 7 + .../trace/model/time/schedule/Scheduler.java | 12 +- .../model/time/schedule/TraceSchedule.java | 21 +- .../trace/AbstractTracePcodeEmulatorTest.java | 4 +- .../trace/BytesTracePcodeEmulatorTest.java | 2 +- .../RowWrappedEnumeratedColumnTableModel.java | 10 +- .../pcode/emu/AbstractPcodeMachine.java | 59 +- .../ghidra/pcode/emu/DefaultPcodeThread.java | 68 +- .../java/ghidra/pcode/emu/PcodeMachine.java | 45 +- .../pcode/emu/PcodeStateInitializer.java | 8 +- .../java/ghidra/pcode/emu/PcodeThread.java | 1 + .../pcode/emu/SleighInstructionDecoder.java | 4 +- ...InjectionErrorPcodeExecutionException.java | 26 + .../java/ghidra/pcode/exec/PcodeExecutor.java | 14 +- .../ghidra/pcode/exec/PcodeExpression.java | 2 +- .../java/ghidra/pcode/exec/PcodeFrame.java | 4 +- .../ghidra/pcode/exec/PcodeUseropLibrary.java | 2 +- .../exec/SleighPcodeUseropDefinition.java | 4 +- .../pcode/exec/SleighProgramCompiler.java | 4 +- .../java/ghidra/pcode/exec/SleighUtils.java | 776 ++++++++++++++++++ .../ghidra/pcode/exec/SleighUtilsTest.java | 300 +++++++ 116 files changed, 5676 insertions(+), 1993 deletions(-) create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceInactiveCoordinatesPluginEvent.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/AbstractDebuggerSleighInputDialog.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighExpressionInputDialog.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighSemanticInputDialog.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteEmuBreakpointActionItem.java rename Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/{DeleteBreakpointActionItem.java => DeleteTargetBreakpointActionItem.java} (57%) create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableEmuBreakpointActionItem.java rename Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/{DisableBreakpointActionItem.java => DisableTargetBreakpointActionItem.java} (57%) create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableEmuBreakpointActionItem.java rename Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/{EnableBreakpointActionItem.java => EnableTargetBreakpointActionItem.java} (57%) delete mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceBreakpointActionItem.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceEmuBreakpointActionItem.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceTargetBreakpointActionItem.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/ProgramBreakpoint.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/TraceBreakpointSet.java create mode 100644 Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/StateEditingMode.java create mode 100644 Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/InjectionErrorPcodeExecutionException.java create mode 100644 Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighUtils.java create mode 100644 Ghidra/Debug/ProposedUtils/src/test/java/ghidra/pcode/exec/SleighUtilsTest.java diff --git a/Ghidra/Debug/Debugger/data/debugger.theme.properties b/Ghidra/Debug/Debugger/data/debugger.theme.properties index 6cde8822ee..8079d12938 100644 --- a/Ghidra/Debug/Debugger/data/debugger.theme.properties +++ b/Ghidra/Debug/Debugger/data/debugger.theme.properties @@ -65,6 +65,7 @@ color.debugger.plugin.resources.breakpoint.marker.disabled.ineffective = color.d icon.debugger.object.populated = object-populated.png icon.debugger.object.unpopulated = object-unpopulated.png +font.debugger.sleigh = font.monospaced font.debugger.object.tree.renderer = Tahoma-plain-11 icon.debugger.display.graph = breakpoint-enable.png // TODO this icon was missing 'breakpoints.png' @@ -168,10 +169,11 @@ icon.debugger.diff = table_relationship.png icon.debugger.diff.previous = up.png icon.debugger.diff.next = down.png -icon.debugger.edit.mode.read.only = write-disabled.png -icon.debugger.edit.mode.write.target = write-target.png -icon.debugger.edit.mode.write.trace = write-trace.png -icon.debugger.edit.mode.write.emulator = write-emulator.png +icon.debugger.edit.mode.ro.target = record.png +icon.debugger.edit.mode.rw.target = write-target.png +icon.debugger.edit.mode.ro.trace = video-x-generic16.png +icon.debugger.edit.mode.rw.trace = write-trace.png +icon.debugger.edit.mode.rw.emulator = write-emulator.png icon.debugger.marker.register = register-marker.png icon.debugger.marker.event = icon.debugger.marker.register diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html index 4b73f04ca7..93887c6913 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointMarkerPlugin/DebuggerBreakpointMarkerPlugin.html @@ -62,8 +62,8 @@ breakpoints on arbitrary expressions, use the Set Breakpoint action of the Objects window. NOTE: These actions may also appear in - other address-based contexts, e.g., the decompiler listing; however, those contexts often lack - any indication of breakpoint presence or state.

+ other address-based contexts, but not all of those contexts include visual breakpoint + indicators.

Toggle Breakpoint (K)

diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/DebuggerBreakpointsPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/DebuggerBreakpointsPlugin.html index 3d09ebaa36..40912e874d 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/DebuggerBreakpointsPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/DebuggerBreakpointsPlugin.html @@ -22,126 +22,145 @@ -

The breakpoints window tabulates and manipulates breakpoints among all live and traced - targets. Only address-based breakpoints are tabulated. For other traps, e.g., "break on +

The breakpoints window tabulates and manipulates breakpoints among all traces, including + live targets. Only address-based breakpoints are tabulated. For other traps, e.g., "break on exception," see the Objects Window. Breakpoints can also be manipulated from address-based views, especially the disassembly listings. See Breakpoints in - the Listings. Display of breakpoints in other views, e.g., the decompiler, is not yet - implemented.

+ the Listings.

-

Individual breakpoint locations from among the targets are consolidated into logical +

Individual breakpoint locations from among the traces are consolidated into logical breakpoints, based on their addresses in the static listing. The static locations are typically stored as bookmarks in their respective Ghidra programs, comprising the current breakpoint set. See the Static Mappings window for the finer details of address mapping. A breakpoint which cannot be mapped to a static address becomes its own logical breakpoint at its dynamic address. The top table of the - provider displays logical breakpoints; the bottom table displays breakpoint locations. - NOTE: The breakpoints window cannot display or manipulate breakpoints from a target - until that target is recorded into a trace. Furthermore, dead traces are not included. Nor are - breakpoints from the past included, even when viewing past machine state.

+ provider displays logical breakpoints; the bottom table displays individual trace breakpoint + locations. NOTE: The breakpoints window cannot display or manipulate breakpoints from a + live target until that target is recorded into a trace. Only those breakpoints visible at the + current snapshot of each trace are included. For live targets, this is typically the latest + snapshot, i.e., the present.

Depending on what is supported by the connected debugger, breakpoints can trap a target when an address or range is executed, read, or written; using software or hardware mechanisms. In - case of "read" or "write," debuggers may differ in terminology, e.g., GDB might call them - "watchpoints," but Ghidra still calls these "breakpoints." Some debuggers allow the user to - specify a breakpoint location other than by address, but ultimately each specification is - realized by 0 or more addressable locations. To accommodate this, the Objects window will typically display a list of specifications, each listing its locations as children. However, - the grouping of breakpoint locations into logical breakpoints by this manager is done - without respect to the specifications. Often the specification is at a higher stratum - than Ghidra natively understands, e.g., the source filename and line number, and so such - specifications are not relevant. Note, however, that the model might not permit locations to be - manipulated independently of their specification, which may limit how the manager can operate - on each breakpoint location.

+ the grouping of breakpoint locations into logical breakpoints by Ghidra's breakpoint manager is + done without respect to the debugger's specifications. A specification may be at a + higher stratum than Ghidra natively understands, e.g., the source filename and line number, and + so such specifications are not relevant. Also note that the debugger might not permit locations + to be manipulated independently of their specifications. This may limit how Ghidra can operate, + since in that case, it must configure the specification, which may affect more locations than + intended.

+ +

When the control + mode is set to "trace" or "emulator," it is possible to rewind the trace to past snapshots + and examine old breakpoints. You may also emulate from those snapshots, even if the target is + no longer alive. By default, those historical breakpoints are disabled in the integrated + emulator, but they can be toggled in the usual ways. In addition, the locations can be + manipulated independently, since the emulator has its own breakpoint set. Emulated breakpoints + can be configured with conditions expressed in Sleigh using the Set + Condition action, or configured to replace the instruction's semantics altogether using the + Set Injection action.

Because of the logical grouping of breakpoints, it is possible for a breakpoint to be in a mixed or inconsistent state. This happens quite commonly, e.g., when a breakpoint is placed in - a Ghidra program before that program is mapped in any traced target. Once mapped in, the - location of that breakpoint in the trace is computed and noted as missing. A logical breakpoint - without any location in a trace (i.e., on an actual target) is called ineffective and - is drawn in grey, e.g.: . An enabled - logical breakpoint having a disabled location is called inconsistent and its icon will - include an exclamation mark: . A - disabled logical breakpoint having an enabled location is similarly inconsistent. Toggling an - ineffective or inconsistent logical breakpoint enables and/or places all its locations, aiming - for a consistent enabled state. Toggling it again disables all locations.

+ a Ghidra program before that program is mapped to any trace. Once mapped, the location of that + breakpoint in the trace is computed and noted as missing. A logical breakpoint without any + location in a trace is called ineffective and is drawn in grey, e.g.: . An enabled logical breakpoint having a disabled location + is called inconsistent and its icon will include an exclamation mark: . A disabled logical breakpoint having an enabled + location is similarly inconsistent. Toggling an ineffective or inconsistent logical breakpoint + enables and/or places all its mapped locations, aiming for a consistent enabled state. Toggling + it again disables all locations.

Tables and Columns

The top table, which lists logical breakpoints, has the following columns:

The bottom table, which lists breakpoint locations, has the following columns:

Breakpoint Actions

@@ -194,6 +213,124 @@

This action is always available. Use with caution! It deletes every breakpoint.

+

Set Condition (Emulator)

+ +

This action is available when all selected locations are emulated execution breakpoints. + (Conditional access breakpoints are not yet implemented.) It sets the condition using a Sleigh + expression that when true will trap the emulator. When false, the emulator continues past the + breakpoint without interruption. Sleigh operates similarly to C: zero is considered false, + while everything else is considered true. The dialog provides syntax checking, but does not + verify the semantics. If the breakpoint condition is not semantically correct, then the + breakpoint behaves as if unconditional; it will interrupt the emulator then indicate the + semantic error. To trap unconditionally (the default) use 1:1. Otherwise, use a + boolean Sleigh expression, such as RAX >= 0x1000. Sleigh conditions are rather + expressive. For example, on an x86 target, you might place a breakpoint at the entry of a + function and set the condition to (*:8 RSP) & 0xfff00000 == 0x00400000. This + will break on calls to the function from any address matching 0x004?????.

+ +

Set Injection (Emulator)

+ +

This action is available when all selected locations are emulated execution breakpoints. + (Injections on access breakpoints are not yet implemented.) It replaces the instruction's usual + Sleigh semantics with those entered into the dialog. The Sleigh syntax is the same as used in + the processor language's Sleigh specification (.slaspec and .sinc + files). The dialog provides syntax checking, but does not verify the semantics. If the + injection is not semantically correct, then the breakpoint behaves as if unconditional; it will + interrupt the emulator then indicate the semantic error. NOTE: The semantics at the + breakpoint address are completely replaced, ignoring the original instruction + entirely. This includes its control flow behavior, even fall through. The replacement semantics + must provide control flow behavior, or else the emulator's program counter will not + advance, and the same injection will be executed repeatedly. Here are three ways to provide + control flow:

+ + + +

Here are a few examples:

+ + +

Filter Actions

For organizing breakpoints the manager provides the following actions:

diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/images/DebuggerBreakpointsPlugin.png b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerBreakpointsPlugin/images/DebuggerBreakpointsPlugin.png index 41ffdea30a8115f4b8e32b8c6134bf6e5c5db8a5..46fcfafe1e0e62509d43b009bf5d00b121c7827e 100644 GIT binary patch literal 27493 zcmeFYXIxX;*Dk7{pdw(|R4ED~YADjBi%M@w?;yQMs0oC+0Y#A}Ei?h8_YR?jphycK zQUXFK3It3b^qNra0{1@u_dWNV-~D<&ydU@l*2-FwIp!G8c;*<-jCiJ{OnZs-(wQ@7 zXjN67>YO=4VF3JGx98s%~XxTN|d`{rHxa;mUh1wbctl{%%9(@JJtKKNhLW$X$!Swhm`jS-kpXd-_%F zJ>R7MBEvEVM0%VgBqUX*(?8gHUbyw@%Hs>F5?M)QHzl{8K0f*TT9lT#UniBp_R?5E zqK?|VJg4tsl_m&}8+j*x(SCHWN-9`Jh+Ze1)oFBYXh{y z{V${OC><9VW6+>dX5^ks>7>D>w)?KQ*Y}C@9mPehdS%EKw)G@I>ARL?(+U?9QaWyYX>6HG(W*>9r`Evmo=I~_3rm$z1{jSXKoby4P(#Lw zu_tOHtG9Swgk^4gt7yemCMSkQ`}O!o`>EqQi&|%LV>iOya*7j64u0SGp)Cg<)kfb% zC1|G=kj4>*xEjX8yqA$@b;|9Eai(;M8)a1J#jBuNj@;58RCI8)t0+erR5F^_ntZ?V z@Ji7o>C17>?BVF-%DHDn)9chl(|GFrrp*U-(Qn0?FB^^$E-9-J!Q8oY%W^t|BWEN> zPOjXtq#ElM8$YdIG(7z3jcr!$XusIF&a3HLEF~`|d`bg`-9Cuw#w0JyguUo_jk3iKVDq;aG(86{sjJw(~zWf@{8d- z5SyHN6K&S5DW$&mD_8xaJ`^oqRPK+rxauDpUXwSFGCpJ|sZ5I2+-~;p%9Cf4H>8Tn z;-$RPmk@H5S~Ep3jQ3meDlh*ty41@FwvJyp^V?nvzjQ8cFW`^A>Q3TfkqoTz9Es`> z_UpXHBI^|q74Z-{s)Kv@&_6XQ_Th_fo~aKdFshpd-Sd_i!ohhOuW1a>wdYH0O@{8L za(F1|RQDOB@QM7&#t4IEmpj~}`;6lWlRPeV(?fcTf~LGQ@QQ?7+)@&aVQI1=NW42c z>4vS4S>1E^Q?s{D2*pOfLq_A8ppv=2HSYD3ge%dZ z!j;xm9c}MI82SU~IK;oj!87`_W(4DAcr-&WH2PTe{*|1(!%CK+l{YNTO^@d1OOtaV z;zAfGK~x6G%2stkc5jxa{h#e{%4C1t>g<1*US9qFIIA*PbZ{T^ZgmKVZFE>Br+4dI+BIERyt0ns*j8KGJ#7u<=PrH+Qt# z7B3A+Z8@-0R+eQgzg)^}Bvgr>4#DInW>h=vz9^EtKkiXlCgNO&#xmc_856-{R&oSe z1!lzhZZ#hJB#_9Xrmxwz=kOS?y~(uLl8){2kM*G(WqSN%W6ibUoUW)OOq>id;8|E^ zDYDhl-oy>A&^q&l2b60%0FFE3oV`3*XCA{Q`4_{cin1IU51C>Uvk%=OOc@eJ%0QOE zhjk;7U+;yXIPbJ8Ma3+AfJL$qji~ko6t>xol3xBWZ5o)kYpBmAASur>dw;{PZ@Lgo z_Yan2)R#zO(qYgAxCz3A$F%+> zoRWH15$>dWTUK&t_3Bfe5?B&PkFuovXZ>D-GW`eJ7(+`%*O9_1QKuo%a&DyyVcGn~?sbZ{Qm7fr3l zy77$av%Y<^=lQML()%Z_bh)(J!Rj@L_TfE~E)&7$RJ`W$hN2q8h3>=rQkJy#7yAPs z$%zeT#IpjJu*=-%hQ;t&fr@D`exO7Wj;U>Fz`ZHa^?PPFUgMx`TyGtnV{v6JqZC4% zS%tICC6dIehK8G_Cnq$Qp!HkiLwBA_3d5tsbi0KQMQDbS;}#F=mS-Z3?#F`HcJJ%M5~F$l znYEKu9l4U66#j75s991+*-d%u$4W^ZPZx?asxf}u`)D!GFzakg{cIif4e_8IMk|p!)dy@=u+t#)2Y*bYH{jg0As#s zo7~Tk@=3DqPg9>+rRpvgOTP^xE);^|$9lI?H*KA6Kk955+pF@O>EMtV4=eG-gIOs- zV$TBSi&HWxr&GjsvtyKyP|U|JtEs^fyRfcD4k)4p%u-HlVWBC#TsK&VvCFNwA=~zgl*Bn>iwbCO zfSDTqVlcS*^Vo(xybXPHSbFAyk-~dZlkeLLqv1*RWr!PY`)?|??Z*ao+uOXOK7Ap| zozuFI{SIlaM;NWhqW~Rr$PC5Bdftuo^D_l=HLyzheYljpjK7fGsr});c@s4Gc}`c! zNA(Jqv8CqU3V+EBxIH@`9m0^g=U@5Dwo8jyu;B~;<9VC+X3^jrHifh2cJ>`mjv)CX z?^}0{)6XW%w^b!<^a>W)U480(L&R{0Lr#Eq;6s83O+5GK$LWq42yWh`)Lsd6#PH($ z$oQtPOUE6Ul>fu3Ud3u;|E(9!wS%uPrBy!@HN6OM?GQpuca8_gk)_y zbtD63YuO^+I{CLEUB7=^^&M~8t^7b<=QXZ@#I_9Ih4iJy=odW3-m3OkJS)j*OpV=P zhx;MBlr|@APcdJAho*GxD;!%jdON1Bd56uNZITjUy5QfluL0}Xx6t0+{iMQ6u zTqHN%ih>3o?K|MdDzc(X8UUk{8W|qSJ9#u^GHyv3n-Z{3=tH;uzFUTsv}iV^%S?2! zESdF}#%^yOu8nX~725DIfXTluF@zT7ftZSch!cwSJ_)&;%xU=4K20)A$^{%hQlzUq zb*I$0CSM~>xczFtxL6>Qzq=itw=lG`t+;(Hbz|((O7eRYM=QGc8g9Ok=01HgH&&TI zPzYhLG8!IG)LO|z8Ye1!GdaZw^ zh5RwmZ4-IvwtL?4o77(0trq>5fznY}1DiBNso00*Y68Od5DMeIcKeaWE}Mj4+Km4J zMUp|K5)-aES~_=ZZ$GBK3_lK%P>t*M;5L#oWtGE+f&D}Uld9VX$GpENwEm8M*8oD$TxWH%{FWpE*;Wu<@V zGbX}IzQ}v>dZ%>x*2gmhs}C5mCb?stDdximBBXv*n#*l$l_eus%rkVxXZ}@=tNJ;* zhFLqe8r-ffCaIX7oA-sk@w4h*ZZ<7zdUGpbUD=xr@pc1U40rwIDz#CJ#^Nq=!M7W} zB;7?+!^yFkiK9>Q6)6%0Vq_#(fb?u_m2^k}`Y_oNQ@8%LYINyq%2gui;@``Q;p&3| zPv5^PICh7i{iZ1LujO!G;cxaXxcuc)1Tj#Kn9( zL*c^88)O!3((2@(AxA;&&wh?q{`f$>7;c4tt>s3mpxmcR5`8&nt z%|We}*_}rGCQaz!+zwD~;2W*`h0d6!Xx2!a*f;c2^X-5r25`wQToy^Iz~#JQMSWJz z!cx?RgfIInJQZL3E#^>pgeWFEbkhl1pi*dPOWY$$1PzgRX0j6tSu6Br69VN6 zRLUp4Ez!j{THCpqYS(l|HAYw!ITyTe=1b0G(p?#={)be_g)mIlMkhZebQvUUcQR9n zIXr6i%?phflgiD!A)w#9{`BwHron!X>>^}PVG~HLQTWbk0kynE*qG+O4ts4|@1sB_ z>4pe6o7L1VuRj%KL~GXN!Z-?cmxH)SO#2Lm6~B^UxUjASIlPvWK2V=lbY!9H^lB^h z0K3O)4rG+Cu?q9dEkw9mgfR2st1}l6WA4)QbCsn5=eR8)>_t>bOl8C7w6+L@ji${c zV`!~F&cfGuezRsVsZQs?CRZVwLXw8YI~JSQAe+EDeD1Yn+Rb?{0+NrMF9yU8#aW#- z{Gw+C`S1_lHMKe)U7`5>Yn6Dn&7R+(Z+@P6i_R^M=+27%zlcq#gCPu}NJa(iUGm{I zOnKhSY5}Utxw}$9Xtjzkk&{sCh~fM0UusY`T}YKjd9unT0KZh2 zZkaArrDTzXhH9isjt$04eQH-ifBgI;XS8G&YqcGd(e!oRSS$9N830i0t?J=O7`yc& ziBQmG?_r5Vo@~o=`a4*AV+DlOU6J0CtqNtyGK-PIf%>%%Y?@srAN~qED!E?2B#?O& zDd8K~XS930GJPEYhC2i@Pq8`kJb8cLGGzM(CP|!#Rd2k6%Y~J|Ge7GuiM!_ECHi$- zNztU>5Cf~%H$iC*USA7;9uM8Q97t_&#qiUb5~Sro#AogvVNmO>Q&bT_+Ad--skrYS z&I%B6c-y7f`xM~8pLy>|Rg5;);;X7y`9-_tm02eRnZp7U_^g8dj|$Vu^g;ldpkYDs zZ>w~fQ(_8^0IWXfXbIF{peR<;Z+$N?H8*3?-YYMZe`!|i673B!ozDywCEs%lvm7(0 zU^HtZpKAD1;H$G^k3y1osPg7;S-u$*U%gvG2*wJ3_6EQnd?`{Q|olkuw8Mt7k%!-tm zuSW&o>b0ZBU6J;P)hCBH7V7D1_$3B|ezp%|m*rSaktelWNVmocBm44eT1uNHAKlzj# zLRo?&)A97RQieYqawHw(k0W$y9ffcUiNu%y`GxMd_D>dfkl{$8X0Ic9fX<>ED>s<$ zgS_JxXkuTt?YyBAnDrFQO&EB92uyKpjM$;1HfV;fYNt&3)4S&yXL~K8x8J)oWhw>N zsKiNNpkJ|;35FFu^XcBEsL_iG+S;)e*y#=V<3>erBMuegEuq=#01RVa;F^`HvFcZ+ z@wKUTsm|j1eq)4i_in0?P0S>eOx!qp|01U4V?IJo6J>#wD|}IpyE8%0X5>24DEItGCZKtrDe_zY`973uOt7`=l%O&e^Y(DI;)o{sifyi2ME~IJ7!$j+S>YE zNBp%GXEQ%)>ZTjREIAri;bJ1E8w7pO{F2;fZ?q(Kb!n)4%ujQE@s1j5#^J|XA%gOc z-$K{fa6{GxW`^UM6|S5k53rusiPUtZ^~4|P53t_LD=IZl7c*t-!VebVrnb81m=tdp zzs^3`#zt=iT5QaWJNR%(e`7XMuy=#O#Tso;W?+7_9vj?UH)g>r>$j66STgnu=hm>U z#3Jndw00Tp+N?hgJTl`6>{r#R5YzCwC0(}Oq;Y<|hC(*EfQJB2Ft?j8^oa3PsMWgQ z=jXRIu~Yf9$0v_uD2Ca&zpqu4BD3{IXBAmdKi4mDtjsEQbjN;QV?PBv+LC7$+)f)W z;-J;#;GkdATR-qJ9I$$o0MV~(%s0zLYUPu~k~k5!gI#?ue~8zP2N{APW}{fuS3#}x zG58-{yxJM~?wWige8#(!`GI5Mr2lH5Coahl?TVNZaK-v~^3l**{x>6mXA&NuT!+U` zmMR+6q29t>w>09D+upp=WJ*PMq%i9GgR8{A?ftG=@J%-+K^EPeDV;nXSU(kn>u@vc zxD;))xjS`?avV3QTk5$E%Ss&gO0exHh7hbsgI!q<;h>sG9LEEzM?WNmRMT-T76|Sfk!{U&SrtfR@_7SK<%{=4%q}D<%SXLh|4WoeWK5RqgYE4vr zfCkguwd~vcCM$c(r7w*DXVn2*!Vz$Z=S#ywF33)@*{}!wwuSF6o>URHPo>5P!LW-aH#$}fUxPxm!@>0(6Hy}<|OwYIMhfC=kJBW0)h^-IQjx5s9#40l#DxQvKG zF9#mc2k$+p91bWEhvF(;VioznwiM~3`34F zpYP$#diQOyKV4hOo4}fZ!Y`y_DzsdJX6NxjK=^fu($$g{?IG=xI}tw?;6Q+hu#N)0 zFZJ4DNo;yCEylm_4K{OBCiJ=)au9HV{ME3M{wG1qztSACc1(hXt7gM*fD`?;Z}haB zk7Un!a=l=zp5FNs9Ypl4Ftv&YVev>W!y*%NbmD$roSbvtxt`6Z7LbcrDMxdU4u*2q zl!dCAPXY&1t3d@&lY_eCflITuD;)>9-UO1iA`VPS?sF?e>!SL${4DOwzWP~5%<4HV ztp#slzx|zHc;t{3`Ry2pBR#`=WiSnF@<3uNKC!HsEh`;E>w@LA_Q!5d?4%AZS6a*k zmg5^14F>r6fu+(;aBEEpHVY2au(HK9YBuMk#xU4)Y9&$#w%i^&Ai6oT8LrA5vJ(f_ zfX5YR{{iDmydR%NsAy}~)M^D?K?#2^^5_}M3>wyyP>+PW+5%O_KgQa;}RYnA05uUTffBs(ua=JjEu!4Exc1YsdBRjDO;-@3y{Qam0 z&zJNClP$tZ4b_J|2FfyJHGv4D9$ejZ8m`YV^Xi|OC*R^`gMqW$w1FvS1|OYg5wp)O zwP-eO+I@S@V9b2cF*dwn#&y-QRTTGe@M(iyIYC@f5UrNBF_6Wo5(njh_=sBMM@ z2ZemscTva4N#D6>oo1~tfSl4+>~F`dMw0fEC@%M`-Zgu4C3$G1(uZ1Pa( zBZHJ!+^{pSv8kcppI4NnhSn-6@;%;zp3j;$k_ayIGsmr}1c{f|YWOwx{p8)%Mfx3- zYDo2ONPgn|4zI@TkOZzN?@2Gy84Gf}lib_VQKkQ?U5t0!JbTTRs51QMZr8b!%=+~0Sei@RV337hz)NDyft-Yy z|3Vzd^cgBCGqfDPRC1EvOztFC001P^TsF466Id7wpwYi+o?S9X`~}?&*`7EhLHb6b zpk*WRx((E{Vw^~Rb{yVF{1-@z4RYj8TT>7rfL_gy2%ZwOkq&QagX;zT$xXEBiX8`o z!>H~eFI0ExW|1|klb`tsZ5vv)ZK5n8MWd1!!aTdvK1q(uOvL>x-YK;0!8leQY?Yx$=Y-rWKjBN-6s7u-wjQ+S%bjXU9y_Y4})SvNau2XQag{)5bt= z%u4jjr;gURyG#Iwei7OZeU7w=t~M??brUW%R5ZL*zEmmeJ)1pJKK7I&VC|OO6xB@kuLSuUo6D`_={G_% zy(JuIV**hlMcD8i@-SvH_?U9z$DFnbM$n~abgD~ldc>F}PY)kEB2TSsQAeoDfm!rE zzRo@7(MhP&hT-c_`;g&!$_-ea^Tux**vOG#%e=p^2SFxj_e*3&_hfF;U^O}R=x(DY z4o=w>^e(?&)#MfcM8!Gg%{#b} zSptW3uXzY%l?lemn!6buUzY7BZq`)m+Vj2lQ43sKs*;G+D>vcxT$Ux=U9_uVB+k$G zh=e?4N3y4^v^nqn?h&r^aJCZr`22RIUtT@;d(WDc-zj*rv8O9mc4u*(ZHFA1py&tL}2%`0%&hV8#)4!Uis9ryjjVo@o| zZ4SjW3Gi}VoQK2tUX*VK)qd^E4#%Jt5*QyeT%F*?2olKY)J)=Uj!{9!JlVh**0Fb4 zBt)mxCvq!mpVPs3IDw`@Ftw?hdH!W1K$+8v@#XS`?8&cxLuL325lq_NQD7vg1f)$b zyHy#WU(-s$y}-?l=|qmQ^H{bPU@GDSivxK4=`tcl>mq9dmA|Q%HARmIeo*EJG}Gkn zKY}4qWQ!@e7Gga%I_uZM=Q*a4ij)>@xjZ@QUN_wS{=wNW<-&wD0tz#`edoRg}%l#cdj0 z?KgYN{;NoN`)OBW$AIC9*iTNJLc}o96btfSK>=IK(khxhtFjM-k0Ww|{B|xbJ2ca0 zLUY^2;vUgsnF7ym5~a7_pD*&e+cBtYA>|!vPZtt_t zl(t;S$I-}4aPca9MS@>C(uTj>0*|*Cb@`#O!};)<%0IEqC}45VwIrX)z?Cc5t95+n z>eI%EkY!(nuxSgKK_Ru4&CHiSs1p*b)Xn2Kt8Am$!+;Ush4# zqXo}RytXnntXtKMP)U;V_Kk@V%KVL_byC<@V^^NedN_Vri3g1ggc ze4e%xUOw?xhGn&9j?Cd!%^+;Kw%5=t;@e#OT0-16=L$DBdc)Rb;;-aVq-N zu)}Y;!#*z|)O#XnKVV5%`0H7GrvK_@hMS2&h28KNCXW%}QMP`ip(PS8z0xq8g0Sjg zg@}D&U9>&6u-N9)TzX-=VZW`;gzDS&yOI^1AT`tif88m8JpAGE$FuSSFDZaR$9(5> zhHA7wTHZABlhL+d=u4`2Cb^(2RBj9BKYpF2lnP1TEkvapmzwe52YI)h(~?Jn%3K7) zs^nDKXKq4PTge;)C3&Pp-@Gn$FI~Z8cA!{i+3H~1kv0=^BdF9OC-dc0mBjnP90cVs zyHVcD8IYK~25qTxz?F-oY7n1u&%yaPgP*PKi`kn%aV+%n+3V6mU+H47K6@@FR)HWV zp1=Y%;CK=5?SVD47dZeKBio+{7~ybpt}cOPi^Q{>^rm-xhL(-7zb06)!ViptEZ#2D z3()~QpB?5-o}L>jbOMQ`ux|ngKX(HvUtfTSY@hf>t@f=)oupWwFJ4#+r>izE-Sw~A zaFmJiF~RA1rzE(@Ttk)Gclgaq;Df|l*Uja7-+&AnNOmY4VnI3n9Rmp!_?zbIL59yX z?(Wi#G1zH*ut+3fr1A_~*0xMSQVAvzV6T)BQhw480DLN^d zL(L^hzsF}LmW6(>$c0nPg5ooi!2aC&#IF2-Xnrda**Q}i!(ti2emS3mPWkQ0QIAD%AZD&* zld;@${!_5El@!&Wb;fASHG;@{=4#5Ggg?wc-7yxB2ka60s3q7x3G^Ar#3cxve>Q;fIjM z8Eu+0!sAl<#I9KJbFVLKctj4NkL&fRAv~9#Sh?FV08P203Iy)deN>}5z9!vwIV|WH zKpVo#q<7B$11g|No3EJry=;v$-sg0n>!IH{;d#XKpBl7d{0r!16HVD45qERfx2`~6 zM)kDmQ!I}#8@)VY?1QPd@`;G^TN^=gPnc{jyGvit4*g~OGMMmRE%#k@or4uI z(C}A&D`!DflP$eRDyLJvjCtVU*OE7$O*`U~U(d2rzif#)i%P80Twj`$swCLMA?f3% z{?+xzzwmY1FK&9EEZttuIY}Nos3+jb@mQ!xgpa{5akgo}H=NrC2dE3)3BgPG|h;fZ7h%3td@Un6BY7X@~THvgC=L?bcUz zsz1Nny6R^I`8f{*bTh`DVrhKAMGwp(5T#=*btbs0Cu%p_JL0a>Tu2gKyq38?`I_DH zuIOi!C7;xNii68bQTCs&!F;DEPDFAl_MiL*R&5Wy7I|*WJ2krh$}YGYR$Vx!B22HZk|lhgFCV95@N5VTn}$y?(vGP z?;|#JC(Ok_>brfOou(+zt*a3QPd@d;`KgT8;w6C2JBoR;E%ZFiJiz_o0GrX?n1?-9 ziemm%lG#Dc8Ngh_&&Y3bn=@!HPG+qwtQZM27JI8~y7Z?f8#i-pdwk}DkNqFvFr~&o zUm(~!-S)EC7)#_#AetsHc(WaNJ5YBkd-v^lYgn6r@&fiEx65E@FG}ez=4v-l*+Z30#&8?9O{&?sr2NI`#0M6I5HCisq;esPQJp z1Rau8KRteJH&#A%)u-o%+h2)iDXCaD;rym|Vr6$4qB!L(VmRdm$h)h_#rh>IOU4>0 z4-_l{*7H(=bhDqTrb>F{UrLE#m%hVqQmaR8zqW(zup^8VdCqrVO`6G7)xD>iuTd*t z#o70;pcgSw*A1RTx!0t_!h3X9L~ip*j}{F;_QEvU|F?>wLdN zq~h?T+>9G*V{NWOx~TJnP7IsuRh83)A$$%`U=K-9z3jN#TQeZX3#f_ohaXB#L$O59 zpKWKwvf|^p24r_z(mK`Hg>B!?_mgw)+vFJs6HR^^8g#{E%;O8Pv<^96SqAbr3}i+x zn3kF%EH)N{#TS^E^Rr-gP^Ffr=^ruJ>i#TwON-z`T8J3#HIqf+U{2T9M8w{D7iZq{ z9HouDIhfwZznyZ&djSoW4twHC^J>sNlP%5h1`iui`4Zh+mFKC_K49;lo#pXC%1?$I zp=mGL!<9FeeKC{;+F1rz=k-~hOlc7MMMks7#=L6dVy3^%P|F0DmIfKq5y^y!5CT~G z$dQm$+ux3vPN)Y&!`sXNC*JA!97bJ&522)1T#%1|QwHryNI+Mo%j!8v6u-x73ML^y zrK7}9Pz(?~td7?x_b(CWYCJC2f8PwtjZ;_mt5-#a_uC$aa08nviN_a9*W6sT+Int- z*-7V7N>sFJQ}@lGE3 zi#CKX20LitS81T&}4mBy(v=5wSkc5U6UJ1|oFp_uy}t@(Z$iRsuF00-HXo(@)AA zCe!u~HZR?u(WC#U9e4<#6(f$iouS};neH>gpXYEdUo$;livXRiQ=Akc8fHjAbP$$4 z%Rg>W({m&?L6(#@HOQ}>P+XtaCJLY{lPvq|d!Z9_=P&*BY!iC0>}K&7Xb0XDe;Ezu z=Y0uBA^x3ZkHJi>yG!KPu3F1q&d`>Un*75rwU%*KzC_(KCxjSEwC>8=8=ukm`S2wX zt1S~}$gaE2q*rQmkJQd)L@wtE@*UrOff$HQUbxffo$GKoXSv~e%5hKOW!gB8TI){O zjq(FO%#z$rfNIV}=ULFBUN7 zr(p9>6wKNo5ZV?3gMiu7aQb87JLeWigzHST9f)BWYuxCWB=!6Ud zH^QGAuTXi=vUBfmYGrp2!lX_x$LZ0`K+BGVpu0euD{OM`On;h~?k34s0O=Zq{8Gha zQ#QHrFD$$kEba~Om!^o20>8RubUtwEi&&CU_b1&IlrCpXT|pu=34R(a|Oc9fBun$A|0n38r4<7o>(RpUa04irA?;(Z#AySa z?EH^GWDdgC!72nC!NVq)CQ^n% z@bb^D6!y1HWd6&D`l+Gn`$el=PNfu1Z$I~{h~R$RjOi-%ATwjxskN6b!3|~E$xUAs zZXoC?qpSGWXb##!Mm%KhF5UsN5S+%H$hWTz2fg-?X<(1!MPC`2jS!(hK-m6qcK0`* z{T}ZEWK?lgrr}rp)WP4J(tBnHbqiIircV_4CMUXvqkJD;Y`_7#*#uh|lDJAQbZ>9? zQnip>!Sb}v*W|n8LEfyT{=1K9O3wg-3AM4Xd*r0z+H?A+G%jMc#xp4o(kwtw8wqLW zl~rU(R0Q%1ZRwfm!kFaX1+a`FGW@JHt4(p}^bz;zNd{5*sFaW8kCOPd;{=~GLMAWB zR&t%(=utb^8a_W>2`k_;X|;%lmv8@N_YAmiWum zy!bDb{M`2Lgj?Re&1`f^9bcWJ1f5XG_wWDbCI4fS|M8Q@{}Vg^KY)U#Kil4&ijq3V zd;mSu$!7ZyP@SDz61{Cs3A%lHQ|H)^%0MOev{Pok&5RbS91?WZI>Q_1`Zy@lgQVN9?ncrk3#YSjua8rk5ec=L`VZc|x8#{N%c5dZbq?2lZ_= z1T&%fLMat3E1&=F@+V+SCvm3509iVfM6l3^-BlyaG*L+s?jiuY@qwQuEn_JsmqlJg z>#a1Ky+fGtxz!tQrMs?6#E<%Y3ix4HH9|x@jvsS{jJ#n?u|Gxc_b=bfv=y5nIy~3* zj3xa@Eo>nLL7Qu;zFMQJviBgJ%Zb(I;>}cs|Lyw(qPVK(#;d9dY{OgQHI6y2F2Q9KY9omdzkGAv@ zLL>gVLr|h!vjBR-oQW$~u=^T=+2LI;oo~H~5C^Uh%s}94K?UnE+c?mECQI<%U2*kh3p;y6QCEN8+ zN9x#rd2vsAp|TH4%Hf+lN@#KxgG{lopcWFNH05q}X=f!HruW4yNDNF)Fv3gmoW>hQX;6L6pkSUgYIPu@zC z7QghCNl1xas=JCDbBpCDk!*~98d^-yrSC0hr$aAm%Bv04kNk8d<<|&9+KnZlBwkpZ zla7WoV~UoqRi3t~!EqB@CX=^9BUMhBQNZ{fpq){fKK?nEA~hgq_{hHB{P(!l6_(Q! zoJ^hHR=im2s^hnJwn*maV}Ph5s&D2X;pLCx$i5j*1-ZRjVuw>Im6#W3A+gH975Ipd zp)#->AkD{grQSqXzEkh<(XIiDypx}I(8>Xi=Unu0RFR15LQ9Gin0W5rX<1z=oxagz z=&T{d*Fn7;2fLw#Zc=$xC&yK85^WAKP@|gwS;k1-?C>WVAkKNLm2IMb*rl!X0hPfE#}KDKG_(i$pb~xN-_^ZbD*UK)-nhnI_Y`mc z#d#V6;}fAjf>q5hu+U$WAmDc5km&FKb~(}I5BGh1@axa}UR^o2_rtPeI&?>*yy=^qwvYb~J0w==EayynlI!l#T1~d81rLRvra8YG5`WB) z_Ze9H(|N>ah9m_=M4sO61dd|<7u~Lo;JAb1m2peQXD6S7mK4+myjq#6DZ>umAi2*8 zJmkx?Tx1&B`zN0y_5UW(RYTfleNwOu{-j_Bd_E1n$Y#X;&{y;Y9jnw(oKjKpvWV#0 zWkJ!xlh5CR|4ohiJ8wPRenxFDyCX4Ow_bYVFoj#0?u}pS7ArJMh(G7vv8NdFkZ17l ztMKyC;~LcedV_iME^prolKSBgpGReX($cLlZ`tVl87{?XJuC{S!p67wA-QLAvCt~5 zv=fymK?HuhKfv$V%YO{XZFT~LuSYm%KXRlU7wPSk@1Y|7@-o2=kF#r$vl(A)4)Fxa zooLSEJ>|yDZ_T-0$ty9!#+p0i+Q_484=X2Hy)3^hkCer7_g}j~Dk{i2ku^vSZC8sP zG79MEW!&Ce91yhY4HB@_E5Ad-RN$7DNKHxWc_Zc4awkBW znq2Z?JNfC>)#m&oitGFPqDy#;!yT=(JIAZXhk)whH@C~EYkZHc0~*-s{<@otnU{MH zJzXCxbXhaSRSN2pYi#{QJ5%_{kykH&^*uXfjV3W!n*|xzKF$!A=29MqI@-PuTklA= z+kYn}WLIKPB5=IdB|ksmQjx$ROGYPSTnaZNCVg`*vq*87K!HQ5#mm4WZh)GrB=3i* zTkpj7y%-$2obkSy-bwwS&Sk7z*mLBea^p=CUQJn9Kyk-nls(_9b6Aq*ES(%spr^q> zdS0|UZHPTyNI&L|W(~ex69C9eC0wR;%2B_ldQwFS)I_$^&xVDgk-O8ph8D2ANub(1 zR3FG|2}_--B&h@IVy+t;0?t~kFVpNwPvn=*d)$FO$x(V;>EY37Kmqdbl|2WN)Ca0) z6^Kq3^~yB`PqvuL?XB6=9Ri8X1tU6CdT?_w_okiZA&qMtc-R7rI;7hl&N{jc)QJoh z4M79tM;V2PQ;#ge?%wWm!+JvjQ&P^ktzTPJAxdqt zjqOnHObkTmIjLIID6ro?K3J455gt7V+&vaFsW%|{Z9JXkwcDAzZCvG?A>|RUwa$BD zy;(9H^Mjktz}O@DZ^d1u3nAIb5>CWiz&*DKA~(ccb*VGXtEwjjld&^;X-Ss&$ouiT zJpt8Lzl4*rcn7Wv0pj#7?+^+>wV`a>pr|gYaiwW#q%3s%1_C{Tufc6gT-rzXE{9_* zuVJ+Lkfg{w>|(R4%kX->b6v&!de>%m={Sw;U_8Udx8_yFf6aH9f{E?MmUr(Z29%0y z_<`T$FG9K2dFa9aSPr@NMP1lo`mu2hxMsr8Oa4GbqxHzVQ2x{f-@dwz1C$>?7*>5+ zXQD0)KH9V_uK6)MWme~hGy_WgLauy~2iadmwJb;noJVVK9E~TXzV!5`A><5?qn4dN zJyx{+_2o64|LzKZ85hcXYs12XS6x>2GLoe6e^c>_{-fe`I#Kaz> zZf`R3#S}UGV})_UkA}fj-sAv;Ygq}Wn|sprKqWzH%|C8)`5VhapWk@+aV!2#m(aN` z1{Vu?YW(JoSA1r{0JUWBCjl_Vbn`;Fd){QGo93`pHp;fRt=K7YkJ^eHUanKulz4A5 zl{;`Gre!?fEfHeHJ0- z52W+?W5adzVVN9oi@=4{g8{WAaTNPs9-#xr%U*-9%i~32}He(~&jthe&13%wk4sv;7 zyw#EPR;*5=Ez@Hy3&@QvnC|h=62S?)KazFg_aHX2Ydl=Cvi(C+l?qSC9SpwuYCJ(uak)t#w>o%DWFs9LN=AP&GD+QejI z+8k8d)7@0x!;W&mTLC??#6u;`6w&_Y^duth*3c5h!6FDJCf2E@jrht?qMG3Fba9aL zyIUy?X$kB1$Kf~gkMhPa!&lzoff+e9S=ZgOD=7JK_kU?!5snyxXoaeRxu+wI>ai+6 zlemC0jhn|n@j^kFIO#^yg zc5?SX>hL?g==tp!l2P*dNN;|ZZ(zPszm!g{qmZ)Spu|i(YaO8&zma7aAF!VZZ`@=8 zRUwIh&fJGAkRP;puqoJGD0JO!d!l~`seIeFX+`P;=ALddA0vu zIG{=T;0`-4cT2_Z|BDRx?ZNuUIVvh>#Ino|U>1o>jBo(1_OG2Sw~)_?8gp1_Spwtb z-QNNyaG1TLoX$PqQELGiS_VcRkY^-R55qOBNq^t7T$TSm;wA+pl*@4@6V_MKS4qLE zAiO%KF}yQ#9bcG^k8OG<5iMW%#Hz z?_}h_dR)Ydcq6X{C}?o^qsPceV=ac6a&81mKXX~)5^EiepVL3mU}Mt1(qOX2 z!u!M5_J${{X!tK9pgSY@q8|UF{r^a8{-XlEyB!}GP8E0fnkotSyn4vvZdG^uJ>u2= z)X%FiqW>qx^dG_R|A8?%ixEy(ZlVqo(B)UwI(&ReQq47h{mRyspeJEc&~qW6I7KPV zBIbnLiAu9LTS54)$q=RdESzK2;AYWxdM)o?Hk2E2d^ZC0|Dj47%vL8Q57A~;6D!C; zpP;a9k5*&xtox~UH%`JEFQ9Kwp?xw;8itmq@=MbFbNVRq2#W?j`*JAAqVeQJm=jdw zq^*DaZ(F}O2Qh~Oq_gT_O8q>B<&$V7O_M@VBwHT*jh0#B#CBSD7`DfVZ&W7ayl zhP>j>i9XTxmS`r{j9^nA*p>g~PiAjCKBAtl>dJawY&jZV)*M^ZQdGmJRy4#}6nsCX z#TnzGya~w9!Yf)20i}&8OroIA=;mr7>E{?RUHQIY+12q@<(&O|oAjciT&K-k-=5td zqA4ub8b_!GxJ$D4V3CBr%UzZ!4b7L@PDhhD6Q9F6rtjagxzqOy z|L}s?%OM>#)Nz%EvEyE+DQbO46SmfG-C;M zO>*?p49QQnx02-C^3M#f2h)pxSibNnE(AmDHRFxu-n_B!f!+5X2aab)YtN>~AInjEww-xMS-_Ao{#7A@w`7Ddp_>>2ST;1c<5nV3!wDH#A$oE=u(p8LCAUXmbEY`ciQlu5^Hzu z@0>K`_NZcgfC?Y(IQ~AR85_tu|H5R}iBkxUF}A!2WLk9kIc-aJQD!14aPgFGD~+Zt zvyB?dHUQx?`faZ_9$f)5XPP~V7mVtee9jNUNI>JxrZvz4$#aZNVh~~h0rhkQL@gF6 ze#_rV`iJEAYH@%HFOJyuB^4vo5(5*g|5%e0)G@SDVPPU6Kl7Mo7sV;(_XV$!$TEcN zx`d*@@%)89(SOykM@(!v9xOgBKNrucgI**2Cr_>k;DCq|)0O0FX3o%sbt=agbzcn% zoYNbDa9|x;VIQ9Av+_#y`#$3%;z>0pmAB@qh2=_U$)21+_BrS&u>N1Y!T)tV+(^;N zf=LNF$Sv?(W+<4iUA4A2e=zH_gyOoA3(Q-WV8L-R8xyP<*4_U{_10iG#dZ2o;=f#L zXQL{`5bBe~%$24&ygH(?MVnZ!NAJJv{u*3;qw<#f7t+AWMbgs3H#t#qhG0^Q$4``V~u+3A~^Ips!eM z^Y3gXzyCU)frU?(ykTs367_^6{emLEwR zbG7Zsa|Wai4>r!kt{_!T=T{mW9{Cp4Du8R$*(l5D8~jQv2bg^w*C*Aa#~g3-<33b{ zJ6YI2pX#bflgiZpan@_I=x2YylKvi*upKkX^IMOMK4CCMzB_xl@>R$8ns}NOON*hH z19aOJ9N;^v>0d+l6~Tqqm}a*ca9g70mpAGAcY*9MzAv!BW6=nxNVgqL6)r{dPWJG4 z&ag(_uXTMlwj}QHcoNx3@y{kHJot6|ToS&><<-zm`}vlu@47Jd^Bf2J#nIv|>3PUt zYPEPM!gzb+k6~96P`X!5oQjHlM_c69zb9%riGVD^t>wiz9R*CNVi9*ZtU1zAW%g?$ zQpg9dtAWXpA$p|FZ?`6*M`M-?D#x2GGsx9h9s_y(JP4OnrcVjOqsxI&H!+!kZl|zl zsXRc$K?-g8dz3M#nxl1R3xP9WzK(Mk%gJZh{{z3z5Krbv4N*)?ud(gT+%7 z3ZTwJFYw-YK7>&5KAgR=^Ue$aO0Hh5!ll7Q3TuYN*WPjIAT=_C$Y$~_Gl~)5ebk6K z7_0om*0s7;X9Lm!2QdG9adVF2m<9dE| zezD)odb-2*kSqFOw(U#!!PeDi1(Tvf_C@M9+f#PnS=XTRA0Fz$ zq6XfWFHAjD{VXMS=It2D8C9=j9DSYMTWD-=l?%0$2-BQEy)WwCKxPH|((q_oHdU+t zFAa^$lL_nhys$8p6(L*k2`B#Oi>x(bGb92s^LnBi-~zVuG#te%iwx^>hdJ?B!a`S` zmrLG-hqC62Q8vW^!agGj5-UrPIJ%>jW3%E-!SNjcR>>VIOklmX+TRT@7)l^;md9=# z(8ua+Hn4%AJU}EY34NYxn#7)Xl$U~dP>KI|xnlt1Wv1cu_TB7QoiXhgWIE&S3GcSE zzLW3$dVsJ+C67DZ*#rFe0n$f@x*&aDleB;BI^30}gWpYbwaz}Gp%>8Sv~ia#ptr5f z&N5qbqqm5o!}E=zDwGWGT%;QW4mx#bYwW6$8JW{dj%6EyjOM$g0Qy>9AQAC-pv00s zKlRC>DVj4=FMV(GHW%?9;?FF{3&~r#p6e18*yU%3djKli-#jL95D$}v2q+E%P-PCmwqK>UX4+ZqoA*O&0W zFO9GxXGbo37Q$D#XEeXg43?#7X1xjkC}#ujjU+*y<#tkQ!um{eX1VFvv$;A{M_|TW zrcWK`6JlYbLtuY(AeddRw~#Bap$*?~?_y~c+*BI5!I3_BeaFY7zU(|>!KcBNc)6%@ zMXbnlz4>mp0ZD4x{!>nQ*mKSJ)V6Zlm#4xpn%~Z*X@MlfxsPg-ahZ9t%?lH4q|bw8 z)|L#4aJSI&3{MDD7BkszcsVAjWsCQeVDTTbv3Oi7Fou7(dLgIOcVXVCyt ziQfKb*8tQJmWZ-3iQ`=%3KvGXM1^U-A11oyHvnGGb+}&hDRBPBPAnDv5TL=Hv-M?k z@RVaFm;gPBKUBT3LH{B5N{(h3=$N1a8_jX&%M6*CT1f|Pr{6Zds;;JHuDp6%?MtSI z#~~=KiV@3f)3TR_NeH1=UG>U;f(Klm?+xBIF;Hjv(S?GA79+z zy)Sw$`bTH<_Ty8jxtmySohhmbs{^_T0*atLyUtg#JJ`6EJ2+F4@0~_Zxdq&)Xa%^s zQ8L?oZIkfOJ#gWha-9G_3G=c~)8zJv&mKvK1{%b|g$TkHDV-`UrwzVuZp+KWlC-Wj zq$tLF@4#Sa3O+r#RYTs<##*juhmGW~ug%&^@5P2bx%~)RG+iczIb$rNaLfsN^yPAjXJLhB_4=_-|?i*s*l;(+5-@bAD@+mz|WGvE(ZY5(^(&q zQU{9h+@3eOe6)P}^>=edp>O5H;%yC6kT>1AAAa{8d$X+3Qnhr$AqiKlJAI#Cg4WH0 zAmc;V{~7vzAAoulWYfzc^-UKQhiilQQ9OLvG-ENbc+O9|M|%5)rzD{B4>JRKD^A*sO14jfShvvOn*`#2GE&Q!UeV zUn$=+lv6o#BxApU3&w2&Otj?at1@qGpaNk1g?|ts3Dgo-?!{R05=L*9Rr-77P;R;D zX3OdNZUEf<<|bQ$nloY7)9_G4f6Z6+wcl;A$LZ|n-JLyT;=MlU4^_v|M)vt9%qhd; zjS)!2E-+vk_XT;;X1p&u3pF)d-HVf725KR$pfM#n#pOCLgzq0rf?Xu^^lxRwaIft~ zP{_Q(eIIl7PMSH(7^#Tzh}w?Peb=!$mOkZrSoV*G?5v(|^qvHjmb-Lk`_4(ra6g&W zJzVxS-?zv6rrMJ34cr0Ka$gs9z>D2@d=w_$gsM6H07Tt+?o?YCbeEm%;@jvm0 zruI1?V}0}YK*Pt#GTA>5iFO8gZ~AYwoL{j=&hU5w5D4t}U7Vv-dj@E`vpy ze^bGL6cMBwZvD?uM2vTo*Hk|p(dm_ux}s1~pZ9`dX)U^;S4xr78;VTQtQ;z#Q)K%~ z140L}p!}~BtucUF72_(~cw!xyNj~aEQ+s3LAC~=eTfFg@gkPc2%L2Z-<2a2wfpVHa zQ^N&=fVC|SZ;5B}>$tB9OcTx-Moe#nluS>|$eiDCo!c$nyY&>y;GA8d2}X!30@8oi zK4Wm1*;1W$3$f9UYyrC%X=Q#lQ3aas6h}`Wvn$32Dp;>R-;dI4_-K7mWOt2qtEWf3 z8>S^j9)0>OpiiUqW$l$RCjCfV*^>#!1n} z(AC;>dv|RNoTLGU81!IQKzq=(6#OmUFRM2pCy_Baz{Ukic2CJ+ zM?e7Oohorj$>?x#?cSNUd3!iBkmFzAjXn{qv`>6qWe}h^oG|a{Y3nFYA|+ZF`gLcQ z4`fVruv%vccXI;yh_!V{5M=zR4!wBpsad7<^kHhQY1|}VDGL(kA0n$_ek}T zSE%ijYiVxrUlCViFxjq?xOMmhoR_tK^HKG|BV0R@LUa@|E90fpL|7?q7J2NsL;3*@ zlc^motBP6WmiLJ|_0&uEBXn%+%|z$NmOi3sfI_;ng5pxsevUBNz0^ZISiOriHtrZ> zmMpMu;vwqmwJ+GCisuHrn*NF+uY$*}Aq$pa9arIeI8s!c=h#<;PAO&L zNHIZeOL6nJu}B-ggj1n?gB!CPC;e--(xdj3T;Jt2yOCqs_u=sk1(Xb0SRDB|9~dH< zo~$jvPOAVMONL@1!qfys)>4n^wyzXnY(^5yz;oky>nAhQo0|owygiKN{Vn_Tvyr6l z#hS*YV_AGYy7+9~G8i3>RdoRDWW8b6>-x3FHj{oIFEBLW%|5+tTmrlc1 z^`#Kx!&@BFZ;{ZBVu6wfu^=v*#N+&W#!-hYP(EG`#-Z=%2kDHRqMClt$=j_XpHCgU z0P%#cNE_@yZpb<_Z5e9T_u(mEeDyByC92RNp<2=4``22?;&-uGm&FgywZZbX#l!1y zZA&l8C?!Xq-0^vfhn70o9cH&+sLU~t1YY2x((Eo!I;*nhZ0gmTdGI33Nc9U~!o9sgSnpeNmYAu^L2O+Ud zVZrtA&=)2EE{I||a4*g=Y6!dvsM!3z@Qc~@f6;?qbU@cz({?aoea||FhHIP6xd`^F z*-`uAxr)6XhC}(+lbg)aw(_I)AxrI>=W$|zhe_XuY{0&fR^g|};Q(QpGn7&n>>5Q% z&dfiJJ>tTk4v!Mp9FW2RhnFKvLV1fnS^NG%ZA0ImRtZWb9Z^zsJ?%R{D@UpeEXLE@ zudFN;HW3Y7#dq48$J*`Q8d(k7K$Jf}b1@rVrVN4Bhx?44EMl5U8W8?p61Gh|tgi{% zA0ob^C^2X;_DM7zV+SBWYk^A-_C>;h!5PDl5u6DuhD9M98F~`1_O>DOZFJ*;QPmFv zt5sS1!sGLl1bP(U!+eiq10VeYvY#HEFWa%T$*qMx;z;yr;fE1#Bye*hyVz?+g{$KI zLGX+GV>r>HH%{WwYpqrWtI^!V&~3S@lP626V&10=9X2J?x%w|R+h7i7BSWd9IUQ@u z3WUsW481)h?Oh6m9Z|pQuBuuJb#YFh)`3$xO@1!nMkg{4^eoa8(GABU+J}0&cZVgv6Bg_co?!*y)im1~a$A>D4+_Uh7RPGGuyyXOq==(t ztu9&Qke1hWVKF~}@Ko!W7NV%IbO5LOm$Inv^l?%93VDx07WtSfDBzul4tX+SK+vdN z;92xw?Iz zE|jeZdjw9~s<>I+A~JoHF>50lO-B53kLEPW0MZLNH^ zLO(gkT%DSjJCre;k!APj>cS)*X3jk_ccGiTHM;eT&d%bM-6d2yGb1;Qf88fxkMzTE zinG$PITKBBxwcZR7$_NmBlgB_&syBXpQ**iza{uN+NL|1mj^|0F)3YIPhQVXJba&- zl0I=$$E6dtMop7jhl&V#gTZ*Cs!J1@!4-%;w+Zg0oRqF4D`!YtO(d>4C4E)mSA1XO z9(u)#234d1jb{xlIDZHnbLTZKB_*Zn!}A*oT04M?Y2QiMvLUf!x7LP4oB#dwzhm(K z%MXl>x%>rOgJ(j2Ibxt$Y7XF;mk=k9y69fL2wY?RuLzolQzd_7XB#_x@^My~+zGhs z6X8kLm7k5fwhz9&pz-rQ7cP~^mbpCw8gKnG!)WO35tlqrbR+OK{b_c5TThOKa*)$* z)Mc`bU8_g48*q1vSXvmoQM&nh;LvLe^J*Lu@sfzh*l&LE;!Qwt{yp!%ABz96!dVMb z*|4|q=O<2fZzHPO2iU_-7cNgf98}lw;yIvGFgbyFCeQIFnXe;1^yeZvbE{O|!Amv4 zS}q&fQi$McBj1G!f$T+3W}|2PV9k?49l!C+OEEx+W=o^>Og@u$S!;hTs-mIFZR3W6 zc1;A<{T|gz#<;jaso?m*H&HEt1Hwt(x3S4u@7~Fi0raBC{`a1N_F+~rRWnu$YW=ao zXj0o9XL+nwy-!rvpAWY_U$U~S{w;CfHN_`t^}h6=Op^eiX3sBsSj?(|a%|Jm?$jCd zil>WC`i}mvsvgVB4PjZQomwhQLt^Y1c96H={m$V{(?0SK$_vIIRp8dAS1UJoN8ZA^ zDZ6U8ysV$QY^_CLJ=xY0$V|q+xoJ|1R`2x!?kK$A>R#jL8g6wvASP_=JuF7}70Vb7 zEztzamAmC2^;3N|ZD@8F({|~!bIb0S#H$tZP`ym9EsUAX93N!Hgjg@S&e_VLIT{vK z{>R1(f54#uxW#IP!NsPf(yZ(6UrG9999$jbgm{qwHo-%k72}5uncKo*eT`@-X11LP zG{?Zt2knQd)+uSN#cQik80&{BaWjdXidF!)?NuJraFG+kZH44u7r@el!x@c`2=^r( zKGLepsn9sW!-${fK`c-gAf$(Rd8qi}St~u)$TCh-+@K|1aF!BXL0jqpRd!=hhJt1; z({s-BL~lb3IPNz0AhQHG>&Bn{-V?=E60gZ2L=2PDGtowm0Ex|pz(y{*4N;|Yl2>k2Xf%Q&*4AtI8_!d2(eaQgZjQ`^|5q! z(Qxk3dUO?Ktje)kk0v5`8OHUcyD-!%1v}H9pdRFePzIivMqd5y<6Ja+3n)=bQi3l} zG2eZX)mo@yduK9AdGx^{}9fz`eRPXLja?t?Kg9M_i~gfg|Nmspxr-k1%L4>@6?} zYvWn484}NsjFbE|-VBR}m&rpqf+wEat#W~!M22XPfu=sU6H$@G%g=yk6;HfWL1$M` zo!{RI4U2o{P>G9QDidTFpPkzh;!+6`jgb*ei2h2C=!s>S!KU@8E+65itfSW0)rFb(A4};;8YrspHb6ZiELcj3F%r7sy4oao1N0Y3`^`USbxn9xJw`ha*p3Pk0wt zc=6xMaA>)aSsu_t9BC8{4#{hXBOz9fxn+^IbT%mm{_sxBlccJ6xYA4b42RY@s}N6 zShim2q8eeU{fz_$Q;$`DRURv^wZXeR5bGxHF<_Kx_s5j!kK>4}0Nfy}%9EL;^F6=N z#GF=`Xxt&&K7{?ke`#ChJ@*9rRYCS6N{2TvD+>{fKxNJCXbi_sa0QUlZ zea#Sn{u3Wdegd}AeE@=YOQMk{f0kZ-=ujyE|K!IO%2w49xZihPG3sryBuH7>>R!2F z!!0kOkD6rbC`6*&2+BZ<9sA;d1A}$Rt0z;8^^Gl7^Shn3bd7+2pS9t#x!pzddGEXb E2RyT9`v3p{ literal 27939 zcmeFZhgVZyw*{&qpa`NO(m_N)dhbms(mRAu1d%2!^xjl@M>^63K}skFgit~+p`)}& zmlCS9gwV@7=~Qv8d+)X8nrm(%G}RSIh^UFKT)9G`q$sC- z<;pb>@Q>&Q0r1ZJ+SSA>SM1l7KZTRTGrxC>XJ)(cNY97++O^?^7Uk_m&-n7UZ$F(kV+TK)4`%L3HneS>NDXaI zSSa%;F}u$8t5y~V=RJ)Cew4q?Rv0K~uf4l3uLb-hN#lOcNDqUnZAL=x$lPEIzTPqn zc9^XR`}5+kJXFAVzxXPhL+u+DS>{PmeD0 zTAs1qS@@u^;Jx?bIcC*7XbIN*6wD)++ZrhoLZ~u-Cr(=GarPtGe8uoQ`HO{!Tueuz zEV`%pDabzUKD(4^WNLWf^{1l7$|;eBy5YkG3W{rdyGh=*!4j659{EX}!rHybafN&I$67Jpj{q9&pct&>%?(3z&Zhe-CFXR&EVJ$_1Zq$Cf`Oy7h08h*^XsD zs+LN7RDH1!B&JiKKGR$zthXLoq#tM~LGnfEjI>ZGh_sMh%ARuJ^V;wZx0J1btdy;U zEVVza#$udxFH%iLAf`~MDt-9d1c%M|DYs#N!ZN27yWuzDAGS5$?CCV1c;mdliByN&=&ZKfv&IHKJ;t`QwqhkF5xb(1oWo~bkoT6TIF+cTrj>y`~fx;Sg zU~X>{F4wfipwWDFcaNb~m-m%sc&m!#uV0pt&t+43e&q)8Tl{pP5z=i6a!2P&NE-dnDAk6gVfY&V#p`i`bY9<}eu1>A=T-wVPpd9o z4cPzBL+cI(a@T{$T0$O3-m|2N?QjBXls2|rIo*go$%Y2l@N1@4dKlMl8jbJXBTI~ zXKD+X?lICB^8Z{BS3h^DMG&c|KQ3HU={LV=QA+RU^l7w2P-hYzr!!hE$#3CBFbw|j z&(--I?C=vIo5E$vd5eNu>y`K7a+cQGX{E!8l&IHX+Ns;`{A+ziHQP7G*0^#PP0P+9 z)0OOOIW+o4-sWoG88)D31iolfdew61WX|(kj|$hKnBPU`uj%G}428$b=csLOohXld zQImBT{aNHCeO>fH#UUT)2uqsKB#Tn1y1B75@4=6jcJE@xz;B&}tAV-wLrY1iKDG*g z{&n5t0nrF;#;@^PDP5eO75E-(VbH0jY+s|lQt?}d)xep6-b{IJrEU^xC`LtWe4gAv z_DV6yPJKzZM!KXO2-WpwWNW6=*YQS`PCYVjrsHn(Jpe@m6YfSQ{G#C2`#E3`Yly4T zNVr=k_1aXkWA`())HA~U-kwBc`zyNna0M~R3UV?Qjl`>XgerZYvV5gP=3F5}OfIIenyp8256CYbtkg`tjjnT>CdWl!=(z>YKjc?WVZN*mo%No9|i7 zaXalnNyW-olhaP`8swvNIIbwO!OMU*a7v3jR3!gh9UJ&fH@Ri$Lu&Rv7nFShoJ)u& zoqtSPN~gF{pnxYyc?c7nbjs4jXY1*L73US5J#Q>>5KV^bSD5hG|Ky?Kw~D^jC+WMd z>g1h6IzxJ^hVItIGGez?LCX@SZL+7k_NDiVvyV@+*BMMG2M(F3XWg^2yG`mc3vm>a zzZd zrmw(k3jVEBIR|9R8d$qPx!`+yW0x-g{CKO)NIl!nOSG%=CE)QauA%3 z+o(vjSR0nb^z+Y|RCf_!Z2vuCc6Rd+GsZ%CV!HfJrw>hZbi}s|_FqxzzF{nOk-GmQ zQL9vLO_PqAzM8WE^Lo|x_fJ^LL#{X8;sZbLoj39b`0oGKY%rYl^yb|wq+tt^@;{a< zIEWgFtEO5+w2H*gifWq)>HE~qVF_fbS2{#PCX6k83mWfppCxT$t$v{oc|3{Q{Z>D` z_x>p8`O$5ALQiUAT8oPPv{S6@Zk(Iqw$O@g`*PMjxJALld6^)da}*%X<0Yjv28q2_~V9GaP|>&g~+uW zLqTa_R~k(ZMH1aksc14}%n+h$wv9>7p=S^8iu`ja3xm>H>?!X^KO_xs+v}RSLYBsh zV(wM7$#2-cDY&w{Y%C0IPK&B?M>Z908YELl>eZ(Y^ZJyZCIPn|J}a9gC7E^GwVgWN z?-F6_Q>aE%2T37=9Uj)3pZNY@oLOFJ+iA9NJNS8M9ba2CHsx%;G2^_-<_Qb50pC=eFw)WJkI%#_o_$^NRmDMLU${i&;n>gecNRe@)Yqs2mg zaj)B&_dqRORPwt@qN=traO1_fs&~<5e^JKwL1VMPziwo66=fgYv0`!q~8*id4dos7wiO z6ZNe6hl@zZ4=#+07Gvi4{`*I9m5y^m>uELiqV!^6BT2AfOG@Yi&XvCMmxW94xqwtW z!hoB}mN)-|0X-sqkQW(oVv76X5&`C6#cVCjFEt*hkVK^C3zhYS>L>2i=j)E=n%Q_^ zu`e8kN)VKok(i{x@42%6sTA#j9>_N8!+@t9Rv4On!QdTTBBMW>qc(y&&1Ap%z5{$^kjv3qGld`7gX zwZ+Yi{*XSl+cO_>JPa3XOX>aXzq)PK8-vQk?wOS?4@|KaD8~>VfZew$RZ}>{9|LeJ zd7(3`Z?st4^5;&BnR&JUNpbwU^m3nUPAdM>kson`za@u z@1cw2{{FroG@Yc6ThfQ&=hV$;N#ET{TmCGI^8sfz?v^_rW|nXTeW>p651-M{iY9Gh z23|I|7-2bw_M6<&;~><8eR-*B@*LL6$tZE#61D3ki@zy;1YL4?AiCY#=gq(4;&+&T zE&85nlKx-I+l(xeDHvAU((%F?<)a>~tI7C_6PU!}9}4QVjDf4|C{{#-Dl(v^T*lh- zY1U(~#kiWTUXK2%662$W8|Hd7zgNR^TV{L%QdV*pDCmheUi#$IO8Jd@JpC#cG4Has zT6e>ItPZO^rla?{YcxFf*($Ciu}$`!BZAl9Hk}xm5a{PnhNJpzQvC5EUU?j3f{Hzj z+x+RBcAwP<7e3I_5#hPg+v#cBqW2Ze<;|0|W5yO%8H~AW&wec^j1-f=@f>PLNXzRG zFagjq#)lWQJV#rIp{C3+YRP1KYnfKEHPaj`2ESp{IDSIoZ4yvgR_@9Xojm5g|GE^B zEeyEJdr;*127M##QJ!n+4RhSYifQm<)X`*tOeOgTstie+miR>Xcdfr8WLg26fj8r%&xwN=Wlja7^~OpP$Aktmk2sAV zbY#Sk_uupRxF-tI?9paw>mmxhY1PdG0&^L8So{Phvr8+70E73BC10{AT^CMcRY{@M zwG1;m$={Uu8%Xb4m8NhQB|nvYN4e~5*IxFFW=lZMg3FO3?AidjlV%0Ncd;yzjJgQ~ z$d$3n04a_*1#h54L9*|T-D_xwMp?d{h&r0Ya>JIvoJMtnAD-|aO%HUxl=P*(95d!9 z^ah#4$_wk63?xHg_1jHXZ6DPKjI2>Em&hE1*fw^0&N5e+$Br?@5ff1r_TBAL&OtO; z4-KuKfISjXq_iSTWk%dd+64;Ax$z&^^w?&X(qhJ3hhp^BeD=UpmZc`XXWR5p+cD-R zMabSBaO<7*uHH06Y<5Y_=7Zki5sEjZmzQ=LtSz;M%o1}P>p$$W5LzTO6$8W@5p`Rk zR0^^Yccy|xZ%lnL;xIZcgDrsWB4ZI`!ossxn4^yeK%LDUjJbo9V|}sm_a*lc?-8|R zps{HGwl~(rF9HYpbbIzVL&CEDqmgAWXS7i{bNM3wt&Ex%&F*$xo8Z#uB)v3pz@zU` zf8#2N`VpD%av9p3zM&RB8-x-KfV57V->)5gNF$Igm9g=s^W58k}&iY+^x65{II7qwsoI?<)Oa;~Xi*{KDz*iC46{KXM zcQ2^VGmAD?YXcz9@f;3gHR=7u#ensHG5x+7v%oLqVJqyOSb>?GwTP!@X^A43#k7f;hHX4C6V8i3q2ND{615^4^FXEXL28)k$;~}N5 zdb7Q)N+;Eu1MD8n63GqSpC!r^anAVIZb`{b`2@jwqaBag53c7g!x#=*M>$q!ic?4% z+fYJd=_vZPW(vo49?jmi|KTF_kBb!m9Ww4<-+ecum!_?ASP7tN^s87A^6QUmWQzk3 zStDXKxhZB>%7&`U#l9PX)l#v*y)?Rrewj|T7@Or~1mqI`3NS0_O>M3}FCa+1I$+`Zk43DyW zyMrxls5<9Ssfx9NE6x%H$=!$RNYF{^U2uQr0r42ji;$5qo3vgG6a32Ikv`pdwkG)| z>!YjQr!x+mElUgEvM%H8x%~Rc^PBwtWQ$|TuS>7^u<#fMGYa$t4vO2wUP9VE^;fHf zWBDXn4kF8wzeU{I^hrZo$3Q0RuRiqyPPdXl2mkaOZ0fKwu)TY=KdY_74S@^OVEe^A zKHysNs%YIGZ0Zv@!p+uvRq8xKRPRcT)|;vFEI$3iQkmwfL2b@f4=%#tw?D)2-_u6v z`%$sSi+i4;e$E93h92LSJ=u5GhK@(auTeeq#_oR*-&&Ogg2LY``HH#a+n!zk+Eh&7 zafqwE+9zUWUsU5kSdo7H?S8F_?7!xul2Y6)y48>qCEZ%O!?||@8Sop`xu#)T&1zb^ zkjKlg>wKU(*MpQP$2b;^>{&)x{A1(lE;iPS0+N4>ldNwpU(U76X-H3=lBuYUOie?| z{JSeahi*jN{a1#1`G0UcrI}qRKx^HR2@lMRPTp$zdoTRv@0+i$$B99NZ;vCK0k1%LC{E*>x#a;sUN00+5nYOQ4ihc!i{1iA#%3n;YwRO$xv1O1LZ@`&NLbMlLp2EBG zHF;-v0paI`nOEW;4j-djGmYb-9!G=6Z_RbBAMP$j5ZzWMWn!fnjkpWd=nU2^)|L-B zieQ1|u8!#Gp1il4@;o0b@)G{3{#Z)CU9{`0B&=>%gH}J@B_aPw3a$+f6LVQo%zGa+ z(td@_>iqPGvmM8ifOwWg`SmoPQ+NgOvU0hfj2wc$9!0;*lHC#7hK3ex80N{{WHl|z zmN*zh4tuY66}fqcRFnBo-t0>Dh%MWaC~}hIR5JObzIVDC{DkC0J+Tyy*74gL*emj)8>Nu! z*N})HiAyfyU{TM!F;b|(U^D7yr7I?$IeAku`ud`>I1+SHP2}3%=d6~-^W0@+kaI5Z z!e6)k;dNFPCBxtA@^^rV0MgvYmlHw!>GfcysE*$L<`i5Zn5GZAJdlV%_o*!Rr$3Pm zCDyL7H!x`QahID6C81FsFEx0glEN`uVJdAiTJ%9Vu#XeooyKe4X5+azSuniZ{Xv$` zviET^yMBsVhET|&((pU6U3A-G%Kd9#=;kDe$^a+o+5l>K-2onfG z5UzW?qKNN33?|V$XCSYeOqA^gu zh#vPl=xZ)lqu}$sNJbgqcJHSSKi$!_q>}RUN&|qUQXO0>1!cIO^1vJU?%MZ3-$kW*w3|$VA}AjkM5@B1qTeklx6= zH{#e=-P6Y03~>g~x6ftL?wYR0yl_!?$5PPq)16IfNLF5tZihM!?Hiet$UIk08YcM? zOV*QdannZNb-}mHZ!hWDbd(}NVaoA;)`zuC}~+pQ~ZAD7%StgIIIm9 zXc5zjXqE_Uk|&!W%d&V<8fUj54usJRKK+Xe3-{%tx=`dyQld2!CWA04xa(U#%ig39 z__rQ(ALBL(Od5T(KRtWrgqRYonXH%+DsvJm2f%nYuq(=ApU3fYi*Ht`XNj##aF`&# z4>%1UhY*oRc9SN~eO4fysCE9#XF<*mie|f|te z3PE9)0=3zyS1C-IrFwDYa3J0h2qa|?XK23BA%YSX+E)W zR{j}IC+fPKRIF1NiYio1zXz*W`f1`NinN*@yozakL%G3IyIRdVJ~Id#3z(^~2^n$D zwWgL-201TV7W(JGNi2oOfe1nSfdNm@WqVNp`E%$0>Nm+ZEUQ(vvupR zc7Z{~jt}}v&!#dOnTz3`4yvH64~l9cm!HK^AkOf8S*-x*dHnVCDTH=1(ZtVWg4 z6PVLU8uc_b?zqGb)Mnv9{g!#)uD?^}So@<#oU0w@Oi1Y3AFext`aotPx07bTsJO+3 z?WROvk3n-~R2|mlngd7o6^H+Eq?@yi;{Q0(5%4U+yQ(DK%a$i>Q7PATWw3;uVaC}j zfd`q9Iy1hzSM4<47Vd=^dMozBa(?&5r0OJx&G30ny_MA+fJ3mu`^$rMB zr5N+JIqZ-$!(E7~ru^q<$ZBCufY>9GxzG`@-gmqKs6m31|pQJXethLW<1a1r6e9#3on|i5I3lzhrns7Q(x|wRA)=Zn)4;~{ zp3%k98pqr1ne0h)BYJOn_4~sE*NY1+j`!AjTS)08z>ub+<)Y0G`AC(w8ei)#o-B#m$XxeFG8G{kt*xu%I9CsbyD)r#yqL+3#ZVe*T3qVxAQ>q}9 zI{Z|Bvwux#_^nuOAo3}a?m&4_D)DpM-4y;gf7`n4g?8=J&UMUoG)g7K$W>*GIcrQ% zXt=&JBbDTsTav3HU{ndxlciCvlxpHKcNRaoCh>^Y^aPu0dx0{}PmYT z=U|u;88n*$`rzN2;GM9)N#L2gpl&$*&EE_*F^7N)5Xmy93vS55J3HMlgRD?8i<@^v z$D)36UG9i<6t7%Z<*!XG>67UO&k9{Ai1QTms!%=a(ZUZEcOW7Z>h3viy1I(s!=!?Rsn~1xi41tmoq92ThcBTD| zmwF%n#Y67vx_|J{CGeBEFm--xiPiWQy-g3?x7O9ip{DP|CM_|XMqc60QJ_2n2?{5OA>p$Pj{9iz%N-EcX zhV)=tN>-7whAcwEMH1PAt5s|Zw`|;TDE;dC7r({;&=m7K=MS*$cz>M+y5_o&uQ#P` z_BCLAI>%+dEeEsF>Gd_5N0R#w5_Wmi+Et=ty}4A&xV7`cN!7fM6nU{SnE7%kLy`-V_3vx@|sj##;n1<7l}{H9G(ESuSYlg*9A@^JS#jUU z^|6naptLG`L)~U0_USJwVPd~l0=uI-vYJkX!Ixmx=MEDDOlcGdS3jGwVKRH^T z=BH~fMJ!-)E-d2h;TEa3j!jJB2RWL~iG@R{!y3t{#8iAGwZbLMG_kHg@HO<>y7122 zk_OzHT7~_DH@F0$tp^$Ws5S%Dc)lb{r{CZ!N9KNaPgH^^7Ka%ro@+C! zTIT-XyVWRd+hEm?9_=&UouEK}jx&0Z@A$JeL;^c~VT`4YrWcmqYPfh_C-hQGZ~3b1 z3x(fC+;O7DbLCB>lKr+9J;_QsE6P2?mU@ldA2%O(HyV;mz_z_~#e%NWu%CX4e#78c z8VbKf1uZm^qhe(@RGa(-MX}{l@Th$h$cAVp?6_v>x*adDdq2HksDd&&fNN8O$9J+#J6?aRRu*vc(4Zes>d z+}mud2T!y%Z&~%;@I7fH1s0>m=Nh}NV!sSe+JubCX^yCra-9u;rlypFBYuT3po;b= zvz{MOa2s(CHG`kfI;PICP1}K$b9WXsy2E+NEKg?5D;*9rFv~{U^40TJ_v}lT`{NQF zKOzBpsGS*~JSDTlXa2V6@Z8_m<5yn5xh3fs)~%gHSUJYi4q8aSM6V$>U|5q3pkXLW zguZD77h!BR$%o0bxw?UwWN`ovYd-Aoo`$^7Z*1;&GdKz<_ z6zHem?cd^4y6qA zdBd})Fcv;rzGio!q3>rRSvMb+tArKO{;GL*XcuDX&Xy5SUaqSN+r4g9`WgPzyi2v* z`Pa-xcRf$8lmX;MiiU;*@5~&(v+miz1Wd6xNW<7 z&%s>7(yt$`E(%TJWA)k6j0Z!D^4YqL+UzKYxJbM>azA67gn3;XKer-|dK)?~UK&Sz z(6~PK9lPqq%COE&%#kHZ{jBM#jwJYSA=H`%~CZlyf_$QR5Rt?ACN<9VDvTahBevseh_HvDn*J zF|P2wD?QwQbvk<`Hk`$T-(=s>?JAxC^V)FX0WGkI3MB^ilODwW}es(KsTB_83YCUi7$V z?QZ)n1UWvCtxgY~mM&uFQGr`D>!sHz>zTxOeSNXL9F=SW>Qk%==##=xY;d1$KUu@* zZ5KJLQ#!nj6(w25J|qr2TWZ{&w4?LY#GQ$ROobTa7OHH08femEobSw{Z4QfYu-=FJo3*KE~jhW+^F`q1-n9=$%KW_Hv-Y`)RrAtR9Xa8<{ zJqnR#ZrT65>RMyPgIui;r*PV!-U9UzMwsxLVr;R!h&ECEYLbmk0rq_fCO&qFKwk;XNI1SoEqq1iWB6L`9Y{Jm`bl|bKFphd_njuA@Gk5m&Ycb}o1>1@%_gxBWHwUZ@r^<=zwq{**qq=M^w(DO6QaOLtO8oo!NFaSyXL1Kz2+j z+U%Tnv9QGbbaj2Is;$_sC~kGrq~5m5Ff0O@bPd6|nnLl*@1Z39&MP9bQ(ifn4q=Dg zi1nN80@Qmo3*6(*8mm*4e^$m-SK%Kzmc}%~KosH`kC|l)0^}C*RIL1m&sO2k_x=y> zn@>|tA~-8(-9-lf0bVy=TRBx`VZ_a@PiM4GZy6*w0We1O!PXD!PljDnE?%`l zn6-nfv1&KGxzaWs+9vt1Fcm*(faW44Rd|}ZyZ`WfVRJ+l84xp>P3}WAVA(0>g)lZ# zzi_S^pTCLmp@%NYIo9pcvHR)V%5mmh&^$0J|Lz*%b=pbutt%teN3^W1^!vyYg*|hj zuf9+CuCl_SyJyW zg1iN|m$WCOu9k1z(^wF@VMDA}I7T$@%G^-eT5XqSwds!T0GzV?AEtL<*P--}?lJGF z-4F1k;_<$Gry}qOg(2gl2V|(e_D!qa!1ZYTU+f#4ED%lSzp}_4JzhbOx&D^^g|Wd! z|NE;8J9YS%>dCyKrJ^*TQp)Ccsw1o;)T&5{J4JWZ9p_>#{z|D(bcKNw>^!OfV-GW{&KYJeVfa z%84XrXVxiH*9%?ih#(vOW}`FqQwFGdCr6O6^a8DPPs11jo&w|+@k$6-_`-Xa`V@X`p`eiQjs#$gb9DUIv*# zymo%J9k|h|EPZiWl@DZpkNRzll055X!cw_SLDKK*T+rGFIz!o#?aq*c4^#e%PmBSe zxHZ+}e^P>;ZS?KqACe$bC-iO?iT7Aa6p*49v1ZS*?Bq4eV3C-3ZC=eKwR@R9)UdA0g?4IQ*{#-)#w4>B!M=QRHw zFp#{7H#!-x*^aDcy_=1w)33LAauN52OZ1@O--e_w5I()_aosFAetDsF2@O2IJx&jI zcf@>x0iJz{I;{KzXkwfdNGz;dZfwxmfDY0`*^UBQ2CJ_3??Vr1Qn0_1=(*-3OJu)$+9p<%0DCEyIFUxyt8 z(4v9KmKuxX`Qc&-ippm`gktIJU@n!y)K9BSBb`q^+iM}h$q>8$VChVq%%>9Y+PQub`W7%{tUTce~vU`4H-)ocv7H^fbE$+FG6)L%TLG@zUuFEa{j zf5?6CCF6Sv&1Op(e70oL@-)Q6XRTnTUD9HDg}_UZe{LIe0>4%DzMc<_o9yTS&u8e> zJG-Qmr0#-P@JU!8#&0vI+uaWB zp8TfJ(DjPE27W=gbUE}g!)j$o#?OTK?dd%6q5YQfq;x*j#AXu`Nfz$LAhRAdbq%<> zbDA7vPxE;i(>uE>qG;c}9}1Q`zgp)-8eF5rev}&U9Z^NCsAx25k zz-W&fEmFn=cU&2?Z>9oJp;chBY0$lIX>&G)h1t5 zsj4C8yOm;ZT+?{rJsfVVMmUb2Hzlo2{dPmBm3?qy`t9?ODHvM@<8QAS`blcEw7tg(VuD3UgmFV3Hdwwjr=H@7Nvzdjm4Ow(!v`CAox_oG5 z7#>rn|E8H2)ywu@wms&gE~FpF+`U^xfg2E6zf?SFkfiC}Xq|pVCu>y=rnUY(EU)x-`B+9%2hJ0!D$LIOnXXZr{tT|j* zQ7)sJ(vO!iO#{J9-R1y)!Bj$-na=8$u-Eb;jpa#BjR`W41GBK(bffOAr?gPf|5#xj z|53kMhn&l4XMI*_c>x6pP;){HhOYBQzQz6cte}uzH5mYSuD13N(5^{)5xc%gg+34g zgX02x&YrCvj-5;2iF6G9^=XHIJ~)GDV>MLJ!u|U)kE(sAg{3Ry?4!1U=sK!ZvzD0X zo=y*$?R%jN@4Vj(If#QSWl_69q*6tp+&dn>05TQ`)O$Q8X)SSeqF4Hs8E^ib;`z+> zmX=p|s@gBojA*H?5MnWAmZO9M;V(#2bfjJ`yGDmnwqNxkyMwx+F&0M3aJ#VTnrx^K zSh*Gw!3xZ{s|Sy26dd`=W7i{{5$d|VB9(uStMG*M^Zl+V1RmjS;y4p<&$^+{UHa&+ zrl*4AKh!Bl)QAln7##T*@L9UqX1V%_)_W5I{HM#c`lHFOyM`#O)u;0v=;HJ0{e?sN zL9YRst)CVh!v)9pfRtlmyi4K25#9OcKiI1N<9%22KgUV#Cu;*m_&+d*v89UBb7U;akc76yLAq`97g$zibfycGV=JEAq1T{`lelHT^#e{GSE>&jSBv zf&brH!1%AK>IMv1_1Eh&&gTBTiMX56MfC1Z9^WAz`|n%28Ce5r_D0{RKgSN`UZZpW z6(e5#Z@1dPuyu^3{$=>czvIRb4+eV|-8U=sIap(72bDes9-+ub*nCt^s>o3)p&Q8q zVp50&js)B$y9_evL34gHgpVJ9=-K2cp+I&WN}ByQy=OmN-jHgEd_E$i9MlR$qbpKW z3d;M=ztEhAwlx{EIpR#X%0f#&;4(ZF(1f91RsTji-O5CLb3N#`i|9VqThx6kFY~(f z#c~Ig)AJfyDJD*q?bMHrp5Tw{vfwYUKj$#nCVHSSpW=;sqORu&9234uDVq%(efy>< z1-{%W)7f)NVRRIhUCXX6yOrHZWh({f4u4F*&>L6F8+{R0rNB`ca`Jr*K!kT0YFTAX zV#aP|rFL^SpEE;mpK?J-jc=bdaqj;E@-*H~)O)6+LA$Q-$pl0^OYQMQB z28a#e^r}t7Z&4q0lAGC$P6n~r=X$+0CX_G|S@3O((mfvbH-8zIG$ z?rhplqP@gv1A>1ucr?>b=E3&4TFO>qzE7Ezhiy#)kwwZse-i6`j5ma-o-^XD2MbO>w5c;;$v(8z={X{lvbs2Dp_EMNI1R0-RjCD@@K^I*jL(K)V%6>-%v~Fss?|0b> zdaq7JJ9jZ5e3P=xC69*Pf8vvK;<9#;)7^AI&s>g|Fi^JlzPESP@zh;!f)S(fZ zQ68N`bz)R}APvuO7;KmqS;t8OkUIKb2GeLvOz*>GDy^FZ9}Q(5MKNK(4oFe~&?N>- z=3BBVEs2rjP_xdAPYq*8=rkJYUXCxGymze;G*=fuHV@TGZpV^V+#}lN-ApQ-yl5zGDWsIitaCC@hM)7kHVXZk z`M9gsHg>E2Lq$YQjVWfr!CuGsGhl@09Pz`NaZ@;R=X zrjfLJVY9hsJ-*nG>h;8IU!{OWDVOoFY^1PS9*_`3kC6yZKh*g$5UV)#&6}O|)ax#J zlh39Vl{h3J>8ZgaA0VLk&tycwt`!)bKXvq&V<#8iPG-~L>UM41SBV(f@53$*^+nB@ zY9e?<@1IjNpYJ!^x2b*jn&waUiO9zIE&3_%hQhC9z~6jcHY`xdG1+R^KK~wYVzBH< zgvE;?zua#H#NL9SCm*?!@L0GNXF>wIf0aGLgNN@;aSXHU!Sz=ihwexUMff#pEoFJ9 zqNhXpFyKwmyHh;DmViprHni&xkEk7rpoX&0Ts-uRy~AOip}5st?ZEpQ@-}E zJrLf-cC$svkLT{~wL*mH+KFso<|ujLbvy{EMX3nzghmtv{f@ z{B3t+{9f6WQj-|{<#aD!{CPJ#@bW48#MlR1$+Kq)FWf79@x5Ur{tdx*5_G?V@5+=@ zzKSLw&3TykWiXkQ|H0uk?|6!-?{JkHj7s=GrdO5!~6dAk+vC5Gbe*{ROH(PQK#e7Y|-5ikgmQGR{>x=JwdyF>IvnCEDW#BrP^{p`W-K=&2 zxKyRNCjZaF#tvU+S%`sWw!Fjp`%I_YD1dHm^ua|Ep+*vt@Yhv`7&O4cU$+H%e2k-1Y}uVD>bjI}ogJa5XU&ZNW*IbK%k9w6BJ&!J_=NB>5#e48+m#Anee&$RMKupW# z01%Upb-t)-*ST0u0A#sHwz24^LBG14+9x47Wz6KWc8uh+4)lfrOpmsr>caB7Z#nk3 zQ&ptWI1X?oOPv~z-L2RKmk-xMEd~=_0^zZ&t)4@K4Lt{86SnAMUE{Y%L1qWYiw#Ut z4C+*Ec-0Bconb2MMnd{$1JO8;zeMMUW>!E+Jf`wW6A)Rk9*iR~hJCZculq}i_QX6K zqTki2@rD8C?34gX?Mt~}+w^2cmbm97N&gryM@gd%ASxD#-Rv6+d70&XyjED?f3mMN zPXN4|xIPAjZjj=IS_V_?1_UIY=DR~pOXyB8Dm|&(Ir$nnCiDS^X1EjEj&xqkoo&Fr z;vT;h|FLg$Gk4=&f`HvP2OI4t8jqh}%__~>3C3FV$_({Nbc^qO*sn&JBm#u4A~Kdv zFGPmg{H*C@>sBF9D=(G+_*=ffb3cPRmja1{X;;j+k)wQa)G7AUpj)OVM`R5@X=wid z4zrt9O+@(^=v=|Nx-13qCot$xexF$No;DqfFK)Y zXHMMj5Gh*fwl;i^f`a0C)K&G^a66{rxi`dw*NBZrH0S)N1i-jNT5Ig zLQ&Z~%asXP0_de1$de;AOyYQ1fSJ+%huk>a>kJ(3=|{uv=E=-_x$Rp*y5>5gD4;AY z=)P2iU?bS;P9j{e%`5@+D~<{yIG63&N4xTyg#(E!ajF?YoCwHo{W-#;mFHPDf*Wt{ zCw~lN^2Siys#xi{$k(;~!Ho#;-=Eg5n#uG|;y}^Vu)WR^M)$K+6Ly85 zXksUxrdKZCsIcx&c-cF){t%~78qvM-K;eA(TszrfqS8`}m|8$FQs0h4uqm67;^nXsa%@C7pvYJGE_zN(xJV*<-oD1^cC2D zTJvPgs+tV3o!Rp>(| zRkk>EnGxrKC}Z}VevvySNWS&Az}VqAz5=gvD7#b=3EY_-iUvDSG^c_Kb_ZEZ2lqJ{ zq!DRMaflx_NrfU9;Z>N7#s|7IS3OM33qT$Hdy*2b@g+|iPq6vrYT!wyYBV^m`PXpi zp+K4IMF`ER`xQWnG>)rZ{!$X?L}Ohs3}i zKJeCw3F{2O3Q*rO&53r0dtobE2kN%sm(BGRLN?sa=hF~p6N)`f?E_5%Nn242m(URBEPqPeL^cO6ex(vh0uJ8eYKSU zi#>kJWB#&2UwuOzm^7oaVeGmY&ubrv-PnKRzD`<~a$llSK-{`LUX~$oaf-b=-xVw+ zPzuagfiQAo%E?ecH1Yvw33Jhc67FQXS>Jqkd2gxr3Q9Q;yU{7;P@oy2pVxLv-%IaY zAD(5%WqQU`*YHYdjmIWvp#fUeEDYfQ<_hEt z1(j)I&7wtWxb-PK+zDRvc(LChJp~Q{fgJIvcfGu?q9!QIyAXvyDJ^sn=Y#$)6Y2pJ zXG;)1)C(j)Xxo`@Px+O12q=8XWk{=f16RK@;+TU(Y1^*=>i6WpvklXds0WUAX^S`q zkunAeFHLmwVyyV+W1vv#r%6CcPx~R;nCjEu>Kt3IGqQ2Gc4(={DHz@FnPa%saQO9p zAgumWd=Zy`9-r2(R=drCcw@zKECS2!p5x5oFs%=`r0G3WShCykL;;w?vVYG-@Xa<0tve&AR;I@@q^hBC*)Ab7yci}%$EQK4{_?+x5|$i=RSeaqAD+lM3xF?4 z6Q%NwelVbo&f&A_47e26<_CC2KMAL4z`Rw4uCQD-shf<50K5vhs@}(gyn&?K!!5?J zl|R&aPYh6xB)$;E>Hg8oqJO{_J0kc46#<3N6W8Spa-6h%UfZ5qFeU8;+OzoRIbKf^ zYgL}dOz6DW;(hBcy6G7aqbQ_*Z&G3(o*in1(ENc>V6oK^3}Zp+L7G z_%PMfSGHzL>|Qn9D?O>#YVTvneX@B9m4!7R-#&h8)vwS?t?=o?BSoi<(Ri|coi0NP zYpvbjUES-{$7r4_SPXobnHR&#qq57L34p)4@IidLo+XcWH({t`msPj6h?wCl%YMpL zH~ovDyHrvonysYvk$hCosnq0QNkK1Ecupt5>8x;^jN2P-lWz$6d*w0s%q|A>p04_dd^goV6 zJp7TB#oM#% z6O$};0){EHF#UJ)zEmz7Fnb2jVB#3^5f_3bB5qDVPho<7_`wO&m=2F9i&5nVtHmF; zb6qVF1s05FmqEfdeAb#DaGJudiDD)K3`#!&NPIxr{EDQI$lh7i$1R`jJ<=v;WnrR9 z9$lw0$Zl}sG&+CvWlca?#&dw+8V982!!XzP$DB>wMJifp+utMc&6FR=u>jHnI<#x> zK}u#-mtOFu?X=Ng(f1?gwx@#HU^-{%jWRwR3XD-y4F0ZuIrmRhCvGruP_MTR z;bqHv;mpRRuYFc;8>ui4LSXSnJcGCpFLmct5TWS zIF4xXiawx% z?OD3!uhsa7Q$FCarWWQ4)=t(8p?}onq0%OuFUa^v(Jn%lM>yn*jA`pgTu{5mz)~m& zC{$hf1r$#B-!V3BZR(X);~_FXQH#tJe^TbFOkAS=8pGWSssYfNJ+tBwig2&DcHx+y znov0NYwrq`3ZGCtU_yq5Yh;f5YyE1azHH1tOL`)eum9-81PIcwlEUcgA;NlH6?C-l zaRZQKMrJJanw1IfX9Xng@I09$3Hi@mJ{Y0(9`+dJRR@A8^#rbzlZOX(g-+I|Kz^Jo zaOKQGk@T0rf>5WQJT`3|KuPf9E=<+PRdcjP;2l1&i2cc_L7DZWBoejd!sT5Wzv!O%^zO0J09idan20dl1 z{HOh0o4y%%;OmE->k9oW)H#)h^{a2Ld{sFnL5rR&KmOJY*fX2*WDhr&;3}2nQb^-8O@fslk{0bLpY4{mM03TtW z;c!k3zx_J#ccz$oEsh3`Cjzgyu-dlrw!!jbGe=D7r7WG-l-7WzYV&6XK>%rpzNaJ|ssEmJRBf9rN$t?2a-RR_fYxf*I~?CP_sB za*DKK!EQ?8tkQSjMA%_rrXjk+-l!7=Y@0&p=F)?-@3lEu<-5>s{TDiPzFfGe|BCo8!H!i`>E6q#y8C4=-&JBa9jA=G>oFKYC3s%B6q z4F9^)#ijVHr6H1BFTGQl_42=+I zDW0aPp)7^RO;tHa-sFHrn9G2y+N~S)tEs#K`_-fQbx=3*jlo6=CoErQY_IfK4Jkim zN?Ml|Pma>H0jy{>N{MrDi1hXZXYHnh9NVBj^-#&S0i0AGb=g?SYyE5Is0h zW;Y!M9?pFLv6d{8I^rr1#l6elFcW*1DDSIV9hZ?^~%w$;YP4VFUHOcaT@K(kFmz&g^ z;>3|MWK52Qu9#fr+okK9!m~yv%Hn73YLK7YKvgQ2@Yga=cI7rc$SwtIrKshUhVyM( zubAgG^WBvW%F`zc4*3Ih1;SeQ>eEjDg9<|u4p2syPfXOvItK8rmy4e;p2YpfmOI1o z3Z&}TTU5`}+*#?`B-b|Sx*^|tAJvq`Ln}c|I9(Lfr%)|`lvm6POalT+X=y*gz2|1M zbWwo@*mzTZ-sNy+Cn8}|Z4%=-D9yrI)zj#rqM&nLgT<+DI^i75?Dd3zoYPf3WjBnp zWEEPiCtxDZBF%P%++(eKrMmmJ?SMp$^>1h*qD^`%j>MMR{s@ADOTQcga+SuEK9H9f z!e`73v5Cz_1Z>G8ERK@@_S|GTaDeS9IpEjbQQW6D)_KH|e+HLVll=ks2)E2;r~M_p zBN;b>rn=)aTRUV*uRi(>)QytJWbFG)YyEswKxM^#pI-xq83WVB#c&NXU!~g&4ImH8 zobh?CcnP_BXRU?YkqBA4Xtr`Ejjjt{zKvZlE2}eI`zD3Iv=wk1r-7l1=Z$nsoJ(@3tE=g$E z_~wfGAfogT!{|ip`Q9A1KJ4+U7{T@K(+4k&^?P>|5bdp(4Hd;cy3&8XIBf7j zBBU`@dh=F{CBY%zbT;gy#rdF-nFsYQUqFDk3pDd-N`Q;U9ydPdXo zf3^2lVx&C@NLFQW>+#i(mRmfRA6mwjHiejH+RD}I>$S2YLIQsiyB0RRg@!3CDBRIF(;XVov*KMyoy(x*&kpUB!pSGwlNK5Tf8*j> z@=Erv5TH-qi&v|zwF!&g9G*)f&CnYx+$YgTZo;gnspZASGJ==#CJyO*vX}RX)M)s@ z2Ya=fTlovKjo`4CYk0HOZjty(U#M$2FR~qHQ?u2wpYbCa3ai+1a)MyD8noH@kJRH6 z784+t9GxfXINaZ~7YBXHWTaTgLq3eQ=2LkKx5gn@f!Yg5^ z%3d%hJHGZI*W}pEr4tmt+2OG@jMn5I*xB!b?lU-(G4v~8v$z$RYMb@(x^zsj-Nv|* zlu-bU!52vrG-=fg7k<%^P}!|H6f(k%h#sB6jCfLhGUCXnhXMaQ9zbotqRT0bueqtXSw zbzkde9bZ#_hLjPHSy2|LDUL~GHw3v}4XZ%bL_pfRx{PQyANetm(}s0=mlDj2#54HM zX|Z}T+X>B)XVb%xUt%7uJ@kXuu5n{ahBPErZeid;HnMik`*JPJ)O2AH%-yzCxK4-( zW+Xh>KBzZu3~lPMZ9f*icpg!EcK>2E9%cVvLR5mZ!}=6B-MX`t@FgsV@{PIiqO#k7 z5EN>bB;_c3Pix1JMrG=&tdP?MM_W`ERuyMr1KAS9q5E;}MTRrqsc^&K(43cE<|KV- zOm=BcK@L_t(+4@dNRGKx_FLQ8&6)=nd%J664QZVWbi z&OfV!a%I{5HgUud%F38tDRWBl^C3AAaZk7q$W@@mTG zY}x6o$J|NR_D~7L_A>T-QN2p0^v3nL@1VqXpxm1}H>*Z8y6dt};NrgNltp1kl+YM# z?=~a4-oIJp_Y#>gsqwp{D{_t$ZA2Z5Ejoj)O<(F2PjFcfq-E2_{qyYH$64#dJAy{S zWbaa=GK{AAJZW>Y6njAt~AdgxjLxZ>5wI5Oc2&}U)?|EEKMiZx=WEIB@ zys$kqO~F%R1}vg8GsCLnz&M~kp{pkJ0$7rJ@pXQy2jaK?)o;y4!e2P>>|d$Z-A#Ch zP}7?KvD_%kvKeFjaJ6-W(s;#%U>nJ6VdZrjl4gz)R5@I&s56F#RFGFD<^Qja?xD|l z`v#}2D{if;j-DD;E?$vL%F_`S6R;;Gb zLQqis)R^DMcv;2T8=nYo_zo>=CqE*@YU6eAdf?{9RK#43yEVZXzky&qeG5-0!jFC_ zw@1k$JL=OSA#Rk8<5=3$vyZ41OyhzIvNrDDz0Tg|rMH!=HG9@em*ke0b9zm;ayMxV zhNhl`2;G!sp*fEobN8!Q`B|sL`-Q9B5-C^inLF9`H{`gvUh62raSKIU%T}?Dg3BTzmwpbv90yXXW~(1qFP#>Q>O% zko)@()1Nbw+bg8+GmVo#4JTr{+-L~o&Xl$P*i3buBW~>tGQu1a5!l-+$-<cjnbmqyn`__7Tk~H3=Uo$NDgh$Xd z3aA6gEoD(O7$Ffj=3BP`&4sbcPMFfWgP&C*+{!AL);s&xX)AGoGDag_@v)u!i#1)@ zJ&&dt-Y73h6$(GX=O4BOCB48hjwDa9!zqI?-!pd*Quk{|lb_>Q_{X(E!M)86zpX4R z%E9}j5SMP5;Wi@3(>GHVmajDjpM9c{oO4#Z30QYYNs?quxP@c!sz-2eun+3sbRStP zqFz6YGtP+M%*``e!2wRT zX|8szq*mJuskyCrUul}J%&2OB)-X+W4wx3?TOWG&wy1Uk@j5kuNjIQ2efMlbKuD`i|I;*1F-%SVNPYUL(Ry zf2Xny_pqmq7`Y`1dE=YepH4k_dht$xYvS&G4}UJH3y__Uq8^Tt)xAjVvt0;53PFgsgrS2JHa)OIlE< zNs|DQT)R5~wP@yGucw9>g>t}`uVmHK%?zgBvu7ZJiIe*3Tb!M-&pU(YUAnIqEdy0e zd!J)fTVuMJxRH2pi&E!h_33OFvq$(tpX~myK=`cV(ZcgQTl%I^p;l#Ti(Yh8MK+^% zcSd;Ax9$z_FrN}u-vqKBaf6W>^0+zJyP~p6J?dv^)RVA9toN{3cfVX^OtFhVmL`S^ zJ+4Lehrx!|B-5sQBUrb1g|x@P zskr9&$$-#azI({A#M+}@kEar3i7@NaJHbcE*!vqEWRVOpS?IXR%+RBq#8@-^!jG2A zbsu+?i~BHKfoJk?wx~U3AbmsgM;L>AV7HI^4oN@A?^e%;KFp4S(1+h1I*8uCkR_j5 z%9F();%q45M?cy#R?$h~tftKH^gsLV9^~cXx> zD|+CDKi&*};-dc5g5gOB_=tWL#Jm{%Jv02@5Bzr={yQK3zh4(O-8gpODzYL57z(b* z9GhKST$f&bamiBz7e^g)nhia``@g?gxbd#JgBt-}{N2hXDx32$<^9wfzl_E{XQAgV zd$_oM{9dg4>6yz~Q-awpu7{^SuRlx|{q@S_>Bx5qA?s(jxW05!#zRTF1Cq+Q2hKeo z09r@U=4MeYuB_Crb&RTg^HR=2h1X6N$-8Ra-JCf960LoqIT0&fz?U@acES37Q>Sco zN-+j36zi5hvW+`Ke4g4Xxh1J@&V|~h)Jc}t&~v_?{H0I2gm03DVh*Q^3RYRRCC^yV zBfqc5n%G(8Nl6b&vaXjVoYjRsNrGspn*5^N|EM$?aap4lil9)>M zbZ>ccE42!DORVI5ygXy(rWJ&4t{u6`B;UdYKPb0n^itBH#h|iASv_Gi)`bH*etZFL zY<)OQ#?h-R346_7q3r#Y&7KWgw^HkByCJrfgM)4TpFR2U z#X8XB#1O;*cu{d8x{EaPIZCWxz7b`r#tTuCJ>2{&ERTnH#|*gd_Au<>A?A{pdFbj~ zQ+Vg_1&!Ceo5H~{0kVtVbyEvc2ShE(QuS-I=s(?7n5%;&<Nv{JJGHo9L#`n-Ab z+)PDL9_g6^)^~L;mfdwTwJQ7iLBk!heBMFBjX)~dG4Y~Z&kTIs^nT_|n~3fKzG#=V zanvR63Uqw(H4~<4fV$~*6#vkJ;Es>OKGU!C^X@AKeC~hk^?5zvz;jO3**=BiR>h_K zuybK8_v1^;_=x>~mc(aXv@$y3*YDZy!AmD88BOz?C+1Se2fB zZ8IF~OzbmZey{R^fcWY1NBHRX5WHE07@{)w_f3am!~fF{&pW2?wr2-iu{&No z8B4rhHyn7)JK(cczQwQ>o8{?X+?*{fN*Laky6{hd9~_F*2`M8O?%DThp3NX+xVHme9o(%W&iJ?@A^{0Cx@J1pC> z%OC}t550Zixs`htw+g;TX3NqE=ioD@aXb806s(Jz3wx-_ zddQ#vFP_htwu|vDdE$kOMTpA@qO%{>GuW##=~Ydr*_VJ*U0|wn}F4kR-2Ib zGscjj5*&3Ha+JZm`6`)y4fe-&sOGZogU?x_=X#`1VZB33URw`#v}0bHaOQM(wN2RD z|5#zgV+n3+Eek#?PlSBFR;!k&kIL0{`#Mb0*QPx4nBQ(;p|YrwmD)&F?pdq^bLoGX z7`{<8gAQO~=1daNp01I_-*1RO>Z-i$V)eBSRF|MlJBsFVt4d8}sy#wGG`D|V`fEvc z$$%wU*+?cXZkZ)2hP+HpfVVTRqmbh3Z6$%erD;gJ48O1-^x^Qp@c;8ID~tcQ|Bd2+ zU4K7aor>>!R!uXMy^jNbZ}uX`-5b~W54-%ASNFvK;&WigKmQ+d3+zz< diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html index 0aa7a7ed5d..652154a25c 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html @@ -16,50 +16,60 @@

This plugin presents actions for controlling targets and modifying machine state. It provides a drop-down action in the main toolbar for choosing what to control for the current target: The live target, the integrated emulator, or the recorded trace. Only those control - actions suitable for the selection are displayed. Machine-state edits throughout the UI are - directed accordingly.

+ actions suitable for the selection are displayed. Machine-state edits and breakpoint commands + throughout the UI are directed accordingly.

Actions

The plugin provides several actions, but only certain ones are displayed, depending on the current mode.

-

Edit Mode

+

Control Mode

This action changes the mode for the active trace and, if applicable, its associated live target. It is always displayed, but only available when a trace is active. The possible modes are:

    -
  • Control Target w/Edits Disabled - This - presents actions for controlling the live target but rejects all machine-state edits.
    • +
  • Control Target w/Edits Disabled: The default, + this presents actions for controlling the live target but rejects all machine-state edits. + Breakpoint commands are directed to the live target. When active, the UI automatically + follows the latest snapshot recorded. If the target is terminated, the mode is automatically + switched to Control Trace.
    • -
  • Control Target - The default, this presents - actions for controlling the live target and directs edits to the live target. To accept - edits, the UI must be "live and at the present." If the trace has no associated target, i.e., - it is dead; or if the current view is in the past or includes any steps of emulation, i.e., - it is not at the present; then edits are rejected.
    • +
  • Control Target: This presents actions + for controlling the live target and directs edits to the live target. Breakpoint commands are + directed to the live target. To accept edits, the UI must be "live and at the present." If + the trace has no associated target, i.e., it is dead; or if the current view is in the past + or includes any steps of emulation, i.e., it is not at the present; then edits are rejected. + When active, the UI automatically follows the latest snapshot recorded. If the target is + terminated, the mode is automatically switched to Control Emulator.
    • -
  • Control Trace - This presents actions for +
  • Control Trace w/Edits Disabled: + This presents actions for navigating trace snapshots but rejects all machine-state edits. + Breakpoint commands are directed to the emulator.
    • + +
  • Control Trace: This presents actions for navigating trace snapshots. It directs all edits to the trace database. Edits are generally - always accepted, and they are applied directly to the trace.
    • + always accepted, and they are applied directly to the trace. Breakpoint commands are directed + to the emulator. -
  • Control Emulator - This presents actions for - controlling the integrated emulator. This can be used for interpolating and extrapolating - execution from the current snapshot, without affecting the live target. It directs edits to - the integrated emulator by generating patch steps and appending them to the emulation - schedule. See the Go To Time - action. Essentially, the change is applied in the trace's scratch space, leaving the original +
  • Control Emulator: This presents + actions for controlling the integrated emulator. Breakpoint commands are directed to the + emulator. This can be used for interpolating and extrapolating execution from the current + snapshot, without affecting the live target. It directs edits to the integrated emulator by + generating patch steps and appending them to the emulation schedule. See the Go To Time action. + Essentially, the change is applied in the trace's scratch space, leaving the original recording in tact. Due to implementation details, a thread must be selected, even if edits only affect memory. Additionally, the disassembly context register cannot be modified.

Target Control Actions

-

These actions are visible when the "Control Target" or "Control Target w/Edits Disabled" - mode is selected. They are available only when the current trace has an associated live target. - Commands are directed to the focused object or a suitable substitute.

+

These actions are visible when a Control Target mode is selected. They are available + only when the current trace has an associated live target. Commands are directed to the focused + object or a suitable substitute.

Resume

@@ -111,28 +121,28 @@

Trace Navigation Actions

-

These actions are visible when the "Control Trace" mode is selected. They are available when - there is an active trace.

+

These actions are visible when a Control Trace mode is selected. They are available + when there is an active trace.

Snapshot Backward

-

This navigates the trace backward one snapshot. All windows displaying machine state will - show that recorded in the current snapshot. This is available only when there exists a snapshot +

This activates the previous snapshot. All windows displaying machine state will show that + recorded in the activated snapshot. This is available only when there exists a snapshot previous to the current.

Snapshot Forward

-

This nativates the trace forward one snapshot. All windows displaying machine state will - show that recorded in the current snapshot. This is available only when there exists a snapshot - after the current.

+

This activates the next snapshot. All windows displaying machine state will show that + recorded in the activated snapshot. This is available only when there exists a snapshot after + the current.

-

Emulation Actions

+

Emulation Actions

-

These actions are visible when the "Control Emulator" mode is selected. They are available - when there is an active trace. Commands are directed to the integrated emulator for the current - trace.

+

These actions are visible when the Control Emulator mode is selected. They are + available when there is an active trace. Commands are directed to the integrated emulator for + the current trace.

Resume

@@ -141,15 +151,15 @@ Only one emulator can be run from the GUI at a time. If the current snapshot represents the live target, the emulator may read additional machine state from the live target. For non-contrived programs, the emulator will likely be interrupted, since some instructions and - all system calls are not yet supported. It could also start executing from unmapped memory or - enter a infinite loop. If it seems to carry on too long, interrupt it and examine.

+ system calls are not yet supported. It could also start executing from unmapped memory or enter + an infinite loop. If it seems to carry on too long, interrupt it and examine.

Interrupt

Interrupt the currently-running emulator. This is available when any integrated emulator is running. In most cases, this is the emulator for the current trace, but it may not be. Canceling the dialog for an emulation task will also interrupt the emulator. Upon interruption, - the emulation schedule is recorded and the snapshot displayed in the GUI.

+ the emulation schedule is noted and the snapshot displayed in the GUI.

Step Back

@@ -164,8 +174,8 @@

Steps the emulator to the next instruction, by flow. This is available when there is an active thread. At worst, this operates by repeating the current emulation schedule with one more step of the current thread. In most cases, this can use the cached emulator for the - current snapshot and advanced it a single step. Note that "Step Over" is not currently - supported by the emulator.

+ current snapshot and advance it a single step. Note that "Step Over" is not currently supported + by the emulator.

Skip Over

@@ -179,20 +189,21 @@

Recommendations

-

Write Target is the default mode, because in most cases, this is the desired behavior. When - the target dies, Write Target essentially means Read Only. For the most part, modifying the - recording itself is discouraged. There are few reasons, perhaps including 1) Hand-generating an - experimental trace; 2) Generating a trace from a script, e.g., importing an event log, - recording an emulated target; 3) Patching in state missed by the original recording. Be wary - when switching from emulation to trace mode, since you could accidentally edit scratch space in - the trace. It is allowed but can produce non-intuitive and erroneous results, since the - emulator caches its snapshots in scratch space.

+

The default mode is Control Target w/Edits Disabled, because in most cases, this is + the desired behavior. When the target dies, the mode becomes Control Trace w/Edits + Disabled. For the most part, modifying the recorded trace itself is discouraged. There are + few reasons to edit a trace, perhaps including 1) Hand-generating an experimental trace; 2) + Generating a trace from a script, e.g., importing an event log, recording an emulated target; + 3) Patching in state missed by the original recording. Be wary of Control Trace mode, + especially after emulating, since you could accidentally edit scratch space in the trace. It is + allowed but can produce non-intuitive and erroneous results, since the emulator caches its + snapshots in scratch space.

-

To prevent accidental edits to a live target, use the Control Target w/Edits Disabled mode. - This is only effective against edits from the UI, and only when all plugins and scripts use the - state editing service. This cannot prevent a component from accessing Ghidra's Target API to - modify a target. Nor can it prevent edits via the connected debugger's command-line - interpreter. The following components all use the service: To modify state in a live target, use the Control Target mode. NOTE: Some UI + components will also require you to toggle a write protector. This also affects scripts that + use the state editing service. However, disabling edits cannot prevent a script from directly + accessing Ghidra's Target API to modify a target. Nor can it prevent edits via the connected + debugger's command-line interpreter. The following components all use the service: Dynamic Listing, Memory (Dynamic Bytes), - Debugger: Model Service + Debugger: Emulation Service @@ -26,20 +26,21 @@

This action is available whenever a program is active. It will create a new trace suitable for "pure emulation" of the current program starting at the current address. More precisely, it - will open a new blank trace, initializes it with the current program's memory map, allocates a - stack, and creates a thread whose program counter is initialized to the current address and - whose registers are initialized to the register context at the current address. Optionally, any - other initialization can be done by manually modifying the trace in the UI, or using a script. - The trace and/or p-code stepping actions can then be used to emulate.

+ will open a new blank trace, initialize it with the current program's memory map, allocate a + stack, and create a thread whose program counter is initialized to the current address and + whose registers are initialized to the register context at that address. Optionally, any other + initialization can be done by manually modifying the trace in the UI, or using a script. The emulator + controls can then be used.

Add Emulated Thread

This action is available whenever a "pure emulation" trace is active. It spawns a new thread - in the current trace suitable for emulating starting at the current address. More precisely, it - allocates another stack and creates a new thread whose program counter is initialized to the - current address and whose registers are initialized to the register context at the current - address. Optionally, other registers can be initialized via the UI or a script. The new thread - is activated so that stepping actions will affect it by default.

+ in the current trace suitable for emulation starting at the current address. More precisely, it + will allocate another stack and create a new thread whose program counter is initialized to the + current address and whose registers are initialized to the register context at that address. + Optionally, other registers can be initialized via the UI or a script. The new thread is + activated so that control actions will affect it by default.

Configure Emulator

diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerModulesPlugin/DebuggerModulesPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerModulesPlugin/DebuggerModulesPlugin.html index 68ad1d0a5f..e02e142170 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerModulesPlugin/DebuggerModulesPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerModulesPlugin/DebuggerModulesPlugin.html @@ -103,6 +103,13 @@ is a suitable mapping when the current program is loaded in the trace without relocation. It is also a fallback worth trying in the absence of a module list.

+

Map Manually

+ +

This action is always available. It simply displays the Static Mappings + window. From there, it is possible to construct the map from trace memory to static images + entirely by hand.

+

Map Modules

This action is available from the modules' or sections' pop-up menu. It searches the tool's diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/DebuggerThreadsPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/DebuggerThreadsPlugin.html index 1f6d17c630..f3d5a1cb86 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/DebuggerThreadsPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/DebuggerThreadsPlugin.html @@ -82,103 +82,11 @@

  • Comment - a user-modifiable comment about the thread.
  • Plot - a graphical representation of the thread's lifespan. Unlike other column headers, - clicking and dragging in this one will navigate through time. To rearrange this column, hold - SHIFT while dragging.
    • + clicking and dragging in this one will navigate trace snapshots. To rearrange this column, + hold SHIFT while dragging. -

    Navigating Time

    - -

    The user can navigate through time within the current trace by using the caret in the plot - column header. There are also actions for "stepping the trace" forward and backward. See the Time window for a way to - display and navigate to specific events in the trace's timeline. Note that stepping away from - the present will prevent most windows from interacting with the live target. While some - components and scripts may interact with the target and record things "into the present," such - updates may not appear on screen until the user steps back to the present. Stepping the trace - does not affect the target, except that viewing the present requires querying the live target, - which can perturb its state.

    - -

    Step Trace - Snap Backward

    - -

    This action is available when there exists a snapshot previous to the current. It steps the - trace backward to the previous snapshot, causing most windows to display the recorded data from - the new point in time.

    - -

    Step Trace - Snap Forward

    - -

    This action is available when there exists a snapshot ahead of the current. It steps the - trace forward to the next snapshot, causing most windows to display the recorded data from the - new point in time.

    - -

    Emulate Trace - Tick Backward

    - -

    This action is available when the current point in time includes emulated steps. It steps - the trace backward to the previous tick.

    - -

    Emulate Trace - Tick Forward

    - -

    This action is available when a thread is selected. It steps the current thread forward to - the next tick, using emulation. Note that emulation does not affect the target. Furthermore, - emulation may halt early if it encounters certain instructions or causes an exception.

    - -

    Emulate - Trace Skip Tick Forward

    - -

    This action is available when a thread is selected. It steps the current thread forward by - skipping the next instruction, using emulation. Note that emulation does not affect the target. - Furthermore, emulation may halt early if it encounters certain instructions or causes an - exception. This action may be used skip subroutines; however, the stack may require - additional patching, e.g., to clean up stack parameters, depending on the calling convention. - This action does not perform those patches automatically. It only advances the program - counter. You may use Go To Time to append the require stack patch, - e.g., t0-{RSP=RSP+8}.

    - -

    Seek Trace to - Present

    - -

    This toggle is always available and is enabled by default. When first enabled, if the - current trace is live, it immediately steps the trace to the present. Furthermore, as long as - it is enabled and the current trace is live, whenever the recorder steps forward, the tool - steps with it. In most cases, this option should remain on, otherwise stepping the target will - not cause any windows to update. Toggling it off then on is a quick way to return to the - present after browsing the past.

    - -

    Go To Time

    - -

    This action is available when a trace is active. It prompts for a Time Schedule - expression. This is the same form as the expression in the title bar of the threads window. In - many cases, it is simply the snapshot number, e.g., 3, which will go to the - snapshot with key 3. It may optionally include an emulation schedule, for example, - 3:10 will use snapshot 3 for an emulator's initial state and step 10 machine - instructions on snapshot 3's event thread. If the snapshot does not give an event thread, then - the thread must be specified in the expression, e.g., 3:t1-10. That expression - will start at snapshot 3, get the thread with key 1, and step it 10 machine instructions. The - stepping commands can be repeated any number of times, separated by semicolons, to step threads - in a specified sequence, e.g., 3:t1-10;t2-5 will do the same as before, then get - thread 2 and step it 5 times.

    - -

    The emulator's state can also be modified by the schedule. Instead of specifying a number of - steps, write a Sleigh statement, e.g., 3:t1-{r0=0x1234};10. This will start - at snapshot 3, patch thread 1's r0 to 0x1234, then step 10 instructions. Like stepping - commands, the thread may be omitted for Sleigh commands. Each command without a thread - specified implicitly uses the one from the previous command, or in the case of the first - command, the event thread. Only one Sleigh statement is permitted per command.

    - -

    A second command sequence may be appended, following a dot, to command the emulator at the - level of p-code operations as well. This is particularly useful when debugging a processor - specification. See also the P-code Stepper - window. For example, 3:2.10 will start at snapshot 3 and step the event thread 2 - machine instructions, followed by 10 p-code operations. The same thread-by-thread sequencing - and state patching commands are allowed in the p-code command sequence. The entire - instruction sequence precedes the entire p-code sequence, i.e., only a single dot is allowed. - Once the expression enters p-code mode, it cannot re-enter instruction mode.

    - -

    Other Actions

    +

    Actions

    Synchronize Trace and Target Focus

    diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/images/DebuggerThreadsPlugin.png b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerThreadsPlugin/images/DebuggerThreadsPlugin.png index cd304800d4b00e792f853840ba695d4d654fcf75..6adc910b1acde3a8768c9fa781685afcb65a83f2 100644 GIT binary patch literal 18655 zcmeIZXIK+!_cw})q5@(^K#HKC0wPVMiwzYdB2q#LBArmAgc2ZZK?Mt-BE2dlv=AT= zYRE>E7J3U1AS#5C0Fe?(0^tnkexCn(uJi8qI-ky$Gar~R*Ua4az1DB7-&*Tl^Xh?t zF7H9XgB%*oFVo)bhr5V$0qMipUo7zdq7-uD#g14{Elb$Pu8l1 zE8|i6YfVMXUd3QC5q5*9iZn1zr#=9gCMa?OV*!W4OP7A@kBV*AfB$2`xO6Bj#@>U={aCg`hk%q34z#zIL&bz|_z3<<2Y;9F4%svBR)^Q#FoANtWt zXZ%`DTuns?RO?zOV zIp#&LmZvonEmz?)tm2L`0T1{NS6h#mreIqZ`>$+{4|on=Aym8Jn@g?Y7;GAJ4!>Mh z*FaR~`BhdgWx&H0T^JlkBs8kx&G#qx_mHx=}hCM^QgS zo@19I>5QjpeT$nQ%!XLKji>fT8z~xoD4NvgjFw4e2p(CrMW#CrZ7jV9uV}e(hs(0w zE|wWvBQwXbzJodGz4D%&Gn^$Nr zSnsES&sAq^Z?>mY=Ynr*ioGYYgW)?|OYuaKIy$`?H%_E=SiYka?v=(^CQw|FZ%n?W zjz67$f-D&C@V*-IYA&ggI}Tp+bZEHpO^{`6P%2W-#IDNc8&k&Ap-Lu4psdF#^zoT@ zVs{QJ?Ge-2KKtk$KD+-Y=jc(+1ECHaXZKg1+s_eg&Y>5JU&`Q`I*oMBlz&%O3 zwr}6LVf$Y91EHKciX1yn2G3q~vY90~7`RH|VtLZltvj58UIuA7U<-tE3_`_px_JKL z)Y(4E{&&dj*GF3$#i6GtlILQfWqB zUoBYke$r~9^lHDr*?6s<8}smhzaGtQl%C*ptKmtVJSb~((E*G|xI{a0>)+;lMK~~nF`HxM4i9AWqzV%5@_{UPh z^B~d1Y%<%YQU+3?T$Xz8-_$s%w10(Ji;hKy_Fb6_vPt^n(Per=BK(^2!^4H$pV1me zN$;U!ezhYTuA-)E-teJJ%|hrt?O9dz<-P~#cbU^ini-_k=8|zKyBVh2qLZs*H+Tzy zeqRbD>#Y9>?_Gj+&0Mv6?MlX29}-cOyn&R9dJ%ncAwcBy+@L`M{@$U}T9V;W2&rTI zg>gM4!XY*60kd3z%g%Mic-X3z^RT1OmulQ#X?o#stzMnF=ff+rgA$R|!E@$xI|h6n zd(QTZ!_?TG#Rub;p3S-bD`Zmk>7Z!8?&_MZVfw2x*28>W>X6Q#c>pNT7$>if>2#EO zuBEA9wwNt8I_pl{h1%PBOn^>ew!F{+fDxx{MSfEHwc zNmx*Dq%;n8cJ0tL)yTFPl98i z!>Z^04b$Ed`|~lAmp=HBgXKg9mrLRj=RU}1>vCEkQ);W0Aa?*$%>>`{!60(--I>tctMa?Z=ji>j$0y|V_*7cd#MhcFUg>hW zDO=)t=JkfWzZVx=0^^t!1l(oP|3R9H`}1$Sj4DD>jvO-gF#?aI*C>5yGgg>40Ox3)Y7lo5iH%a3}Hw(34`;ZIiR zdeoRySfP=LbX|8#wdY$*x_d(oq0OF#f^r(q5y0qRO#xDUpTrB3!z1a{VorkD!T>6_ zee!?M`G+dDotjTFN$0Xk8wM{iU1p9M>zRDBZo(mB;rMix+crvxuAX{bc-59?9l$ZJn=7?TleV3^~1YzA?`&b<^qE>8ky%Tb2ezo>*)< z>{LK8N6)pXk+Q-vhC?>4(~@*>&)$lh>lH%P4ml^4vAmvrjF_uTo|7;Chcy2~h`-Hq zhwmz8PH}oS0PkQ2yg0On|EsU0WaCyHSr5h1>oioP;L^H5+}}oG08afEDrOTKN5joO zp-2CIRixG?`fq*>@C!Mpe{&SFI){5r{*Bq<#3G!f|5b~gI*0#6#^@rkwN|g2`utn| z_Ybg82RNMnLfGuS#{4_*s2IzCU;W}7^2`&hK*Jg2{!k9*=bJAMaLnwY-~B7)hY)8w zwEM8UhjLg(fV+zLBx=$C3672kC|FP9{A=RQ#r(( zL`BEe9}VHMj0L@N7s87QHjeBTf;q7?x2nK0=SY!OH zqD;HoO~x>-$gdwp>(+CZ@rv1)b<~a_Z%kG^EDE}nsNiN$TgP(5Q6`f;Vz*fMEeut9 zZ0ntVx-z+317nRDlkpS8@{H;ra$3E;=BukVm{&V!3z(lE|utYUa? z@rup3jo^Uwpnt+kM*Qr`)0L_I)d^<|rLL4hA>!GQjFfVE(P-e_4qAn~YWK)Y839(9 z7DS!tqPHL~Y9G5=6p@fJ8F-ZAgM<i-1_Q^J)M9LEHJ*?E z@lw1e|2|jZRr{Q_MEoO2E?CdKvc##DodiW=46Ku{c-QHtYMF`@E=L@%K~)xnV92>J zmq7(Vl>pOAbrTN-G~G+HwGgyaKJiY`mDBed;v9umYV{k2!~2t&<$OYX+MCQbY9cv^ z&2u%H8_W_}cyIf|^_hH=gcMDWS3WZXy%>Bk!YjY3*Eyc{{_k9J3@_Q~CzaU8Q@T=S z>u=MH+vvdP;hIh_TQ{EPR>F!)qByQbJ;ghaXss_JOzLcO|?Bj)GSY;Nz|&- zXa%GV?UxPRu+(eGAaAfZ6OaR**xbCN8+^zx{(mn91Y&cr!@N!h9-Zj+f~Ee1w3C2K4v$ zlz6YMm1)&6sZgt>^>z=zmD8D*^9xgzHJff8 zoIn8tHu1E*WdgaOv$ z+K?8%V?IWBz5Ev`T+QmacJ|7wM;5#YfvF(Akf%LD}WABZ1dMTt>cmt3vE` zl4!+tqgV1qSKa`Ngp~OfK(+Ae_i<@qy}1Ovm4Fx9`i~sea@BDC2VsdXQPyVKy0)Z; z6?tHHmz5a(!+ojG)nL}EsEX8zr-^;=Z1?YnZjn|}3+3$pBTA=;Zefu?IQ4CSS4Y)U z_2g1A+4vqj2uG}S7f*mp8Yv0JkL7BAk#Iv7_oewm>I2oK|&Yg(|@iP zWT5P)Hdktgms0ncrBX?G>l$s&az>lB56seY97J2#gO5A5)${pZ)zdN`t@+!hT;9(v zZ`Smh?)ubw0{;5V`ZtHbO@_%aw*tT8%6?D7e0>{Q?=$X1irB~#`hUumzgr2Ds)`z$ zK9YK6kEB^NE^gfTWLDK7!K2I5?=`Ke4J=fBmeq+th$VGK;30$m1tS>?PpL%fzJ<#S zTBnlh<`-tS(FYbNL5i<-Xvmnq57Z|%Sg|EWJO6jj37Q5ibt!LZlWJP0-nVBTZ>;v_ zOs7InpTB9UHQol610k#}M2E<{iATKx(Z&@!HF}lNOwgL$6R;O^)`q#1^Wiy$5$R%^%vp!g(VKQ9Xve)WsmBty90o@yZ5EBg4uW?G;6 z>!clk8f-1b<`O?+x_VyWK;w_N70vY2eQG%R| z__0qCjm!b{ej|66+Fu`F!|%bwOh-{##C5#fz8dNmCU3qswc>5A`UOC-yznTjVLU%0 z;FcTR6ivZ8R1FO{e_V*@`J>xB;>zW8kB; zou<_+HuwO>1BvLg{qe!LC*<$Lv^yQgKw83boo__LHkivj1<`g0*I!BGE3MuS02n1s zoyguMpN}g#+e`X06j;Wv*?(}{RErl4b1%H^;U-mG2D%xF}e*!wiaUbMnV0>3#& zpLp}^hUHu;L7worZ)l&aM60u&&Qda5Qx|C%hrAsCX(`)g7MJuk|K|*Tn1=o)Q<0Y> zV#q4#@13Y+>S5FE{;~ELP31nHk>}0_bTs7%$q|3Ybzw?!?P$slv z4Km;Ae*DLY;IQHAL7B_8$!-6&d1|EfGM&?W+NyIo)NhG^ax#3Ms*aM(s|3Gg-i|-B z*v`K3aD5YG158 z5BcV`6k0#fhESEmAtd6CXq0L6O3X*bo5j#?()Jr)XBMYzL1$CGWFqrsqF#FI_UQdX z^vVdSU$^(!EQM?8dT)M-n^Lj%C1ei#CU^Y$Mr%W3gNGJ=v3L%EKs0Jh>AHuAJhVd` z>S#ju&qaPnocqFT$pd23xS94R+v~fzme$tM{zP9&Kgnj)s(WZm&s)m^{a9qB;rfFR zLuSOH?TxOD97t!q^G8aaVVbGJw%-UFmQob4*}NsZ?L71wu)2K+*UbOoDmg7WlG|gO9_-hOveZE)(^gc@|%hda(A5Q z*}*^R!0s#ba(yFjgtq`(XbD-M0o}ZgGRZSNMEfeA^$iNRF2i8+h@bic8Hhoz64X}Jle+71Bo&HD^fm`y)3 z5um#6X<1Wz&g4=hZcTW*oS+tdNL1q1>oGekkbTFLN{HEIK9)^=0jRfF>kGnl|Nn8( zZh!(1t{9eW^iGe#8VlIR5E*x!-`UK(rlmse#^+ju>PxRrbu`k5$pTjwD_ViTw!u^~zDZ zV`g?={l;Zs;sN=JZ8P=aZ3iULP$wm=ZFTOKN5xPQ9qC`J#d2L=vSwfGG!CgB-la0d zol2HUfCkE?`gtm`l$58GSpW>f;x`6k&TFq!62rvyzY7-U)M4D9@eycw>G0q%$SJfz zy4L7L_29FYH8|mOvpHcil?D+yI$awIZJ=Ja;KN406QfiYO@&+}B8ePho};@v^Z7Mp zVKQj@*56eBsAlTXI`C6x@IJV(ZK6hFm%co+@TQ(+DYoE4!C^cR{2&| z0nG7%v1qu}F{dPV?V>CaQ*1biewX7;R92{%_+;vTGP@%{R!ENFcy~HY=Yij~Bl272 zVHtIX+h;$ucCVY;`7g&%6N2wsSjN1+_!DNX$Ag_uFwvea~2%`IfaDlSUP~eOpOJ3-sg>@6U*rHxGpduFUJoTt+DSWEJpu zgBn%J73u=yY@_zxhhQQSjxiL^dL14qXIXsRZA)i|S^jTFS`j9TO%ASVuid$567;uM z`*36tbEH%kjVLPp@?F3&<;O(=A2)5yfjBaD>8-~YA;DHhQ3^dY!fw0%H59os6ASG8 z@*{2iqH3y3rx%8& z5mu`jp2(?UAevDKFPE-0s#?DGdJAa656{Al1k!^Qy!y;cYi5%!*?w25AYO0^nvyef z-Fyeo+J*_6p5i?LWV7$bf|*S;4Cc~MBC=ROY0?D};xO^Tbv4wj3p&6)Z4$Chux?E~ zr`NJPgE>ZR57^Mpkrh9A`nP~81HzHaU7pYqQkGi{$dck<@pbXUMe{SiR!AQ4)PC!C z@lf1FMMt@(<%GOBHDABjp{P@;CJ07>wH~r#)P82MU%{n~^McW&mTAq1QpFfwRX@mp zSI|08m{>%X*)G&oGpK~BsWfS8J|T)rvT(0GPs-$q+TKXIY{l`I{7#dYswI94G&wDO zHTLr@k0_#}qgAOQ$VSnrZE0LlLe8#+-!%+^>2OmI`Jq5#tyI&BRtxzQ6R{CyPy0IG zHS0WW$eBx{a(&J19;bMOY}FJ(YA$>lL1-YpJi1`T6j}c!hd2Z5Nfv#)Xly+g8MuBO?T8z!*wPPS~Fq?r6iK!q5Xxp$il$?Ta110V_BFZ{zZl-u@ ztiUg%YT|?5j{6VUr0sSdsNQit9e zk2%IY#`uZ{`$HFu@Mi9)QXLRvgY1VEm5aRkJ%S!CFlAi#MFtEyz9d82i-?|)OyPKa zQn6cBu(C(D`6VD6268+MCBLAkqz*l&hMtSs+mt~pthygBV__fc>)+3XLj44v0*+nQD}=^!c=;kcTJb zteofCX2N5!B}h5k?4mzuAFt5e?qv7vO(QdPA3>S4yv0H&?y_e8Tz`Qny0TMys}}aC z_!i;Hz!hbZBQe^%41gcipm$lo+lqo^!fTg09xB)lZ1{r*X_s1|BbEkc>2f$r3-{{v zlZjg1Y2|gdULR-7N@?>5TBBhpSDmX*l+6MHW|PS50X2sEw|s_z!^qjH)jF?dn}Kc^ zerR0~eB+6&W3+X9ybBms9SlJk$&Ib_rr{_nKhKGyEFiA&84EZzQ;5=nOp7~k3|U2e zgofSyM#F3yo=v)d4q90`kzQ#x{L)QguE4IP#%{4MvD9Z>kcL?Ssv>&1D(T!OPw(Kl zK>Mk20i?l?q#LlAv?=kV-c>9c&P?PlLVsHIhS-R zvd2K9u|ok`D%dI!kQ=jCSjrJxidIJxD~BWtJMkL~^ZGA+4>c}lx;X(VNYEiDypkxt`0kdunE?d<4D{5XvW9>rOvHPMnQ#v_Tuz- zPd-eY<~dkR`R02-(ArAWicH>QuX=T;PBjPH6TqMPilR#|Rs9Ewx4WSCmGQl8&QpFV zU`GR~rQqBpYToKf*-IVG*7?E;QQLaOY2^aafJw9@zZ@c*G5#JihB!@OKv$w8_F8Z9 zw3LhG4j{6N9-++JjkWxnpI&&lEJ^D-!3vvcQ|w%xm2fr3fAxVdnzY#^Fu?>i-8Fiq zU|&5L<4`p_hO4Qyq@57B>YvMalcj21T1V{DendsHdL7z4w+-2CjwyS<-UeM`XFYDn z>`Q()edKhYxo99GMs!~!ny5xS)EqFid2w4t;X#_$=Vb!oH-5(BKW--qJ*dFWzu7o! zB5}<*Q4@u{hjr~ANTQ2wtszgCWELiy;vuw;#{f~!%vN!uB(AB9JhiQDgIfI$GbKX5 zteYz~sW_?ScBC94-JYylL5~e-0GvKc<3GY3&J;MRx}VzdA)dL*Mti_o2!^~5 zGV+YuqR55B=CqqPkF4tzT7PE{?>pj_JO|6>i|?msNPH6Ej5X)nR0 zeO3#ALAlpBj5^GWl!tFjs^DM62SjEQ6&R-T?=u^lkm1p%p^`6!@;_G7=AXkc(HS#<1F|6Ad>aw$Bx_!JZy(Qw`Mr;oik~!d(DnqAceub+ zX0`8}c^=ahmZ<1gB4b(mMLFaV$-4l@35bDbY$ub-wySZox(MOhbAJ~lk9tO#!( zb<||thE&uJUeXya=*$d^?zH{np4XOyd5~7HQfuiq%DVvne=k#mQNN3c4VQDz6kD+j zit6si91I0mXYmpLbPA*jo@t3#k3B%CmRMcIZ#9^gEOlyI3)Xd?{WLZ!;RL_s8tem9 zYah`=bND;_B7#-bNw!S5_0VEZu3_dKD&N7$4a0u^3h-o^?bQ4LuhQ~zJhvRPqReGf z3*uPE?kgr*4MI1{nY<|NPw(2G;2T{HeA<%QTkCQYogwTuN(h=&CycP|q1a+Qz5UCV zeBesA{IXI3=>?K}Qw!%Zk##d<_udQ#;x-6@E%)l->Kf$y-vvxFLW-Nx>6vn`YAr*e ztQ=OaYt46S*_)=+nZ7yeIB+P54ZmvB^VT0nT+8~&01xsAdMi&WO3ao!)M7xBx}!c<@~?S*}ikaB=&8j!FVr;$&_Ey&(cm^AB}P<~_PZ&m#S1w(Tx zPVdb-Q+&TBs;F+`cZkzJ+#aEd^>l4wjhUT#`y^A6UO5?^Usu_#(5A`Vu-0K!tj}Iq z4QU3pA*^8QZZ@aLp^|?h;TI&z-4sa|;RCMZmVVuLclXval6}Qao&o}w*^3P$n2cyN z!ihS1f(&N`n_8)vbv0FpwE{723{mFE55M+m*##PNbE5^s)>ZSNP9~}7Z}Pl4%~|0} z4l{c^J2>aPy{5MwF7`o7kjB&8Nwp3~6dQPx{mfS_F7L@Wv3qMOB+HvPOHtZ+%n#ws zQS$d1IQ>}>FmnNNU+dZ=?yc%crGR#EhbRlb+1S9=k>ta>x1>()u3=15T!f5wo?D&Q zer@)6W3k}<|HE@}H7ln-Dy+suhX36OXTZwu-rjk}8b$uoLbg;t%ozLlhVA|8BWmqk z!6kK|F(r_1^RM46WiNp3QXn^ZvTGS&QhxC#*mL{0Qy3IQ=J<9Zry$m7j!ELsq27ik6|wI~?)V1d z`PHF(N@~q&+*Cf%r+-MxV(!)q(^-_rzc+nIyZLPuVd51sznKzmeZdqGP!7bK5(=(; zS^hZkS^_!JA^2ijiT;*DMjs3=b-`q7&98v1 zP1V~%r1Vpz&&{8AR`ndNeXfS@G?68jOeFy1@_uk-^k+V?RLEV%rF?-VVU&t_8fzIi z%G*-{1%b;ENY{}%>qh;AGtn9=k7^^y395w6;jEawHp23H-pE71(7=YB6S!z&&mtq@ zz=CtI<)@!FihL8c>dY%X1&!o~DS7lmsD03c2UDv|e(iAlcI3sJ=j4$?V2TB{VT1crI1-=GWOfK#HoTNolWAtnytF zp&h@95uQX>XQFmJ{x&=pR~_ayAC$awl>if>b))X9ANooI8YEC;rrTrDL~1z^LJv6J zpZ8l%gD?hF%18Psmch3&iSh(!O58d<#`~a|LmQcH8NN8pZ#}A+_D;ge(()f-{ zD#){j)x9GkhTe-sM8xr1KK(R1>?f{;ik7SWB@U?Hn#FtSBA`IKAalPW7T@WU=_@Q( zSR65Uj@NkzYZO#{D>=$!zbBT_GplISxB4ti0SXF?d_`Wn>1<0xk*ho5h4o`8?9Px& zzU{UJHYInulQrWrqfI>qPo$4wSrL{&E!jm{wUhl40p9$mC=l)a*C*dz>lP8~QW)^p zD2#}A(Yna3oBFo_lQQ?ZS^PLxMP{bo?`crADOqRHuCOg_XFhV4SO^fLn@G7Ht z3+E2(G82V@``~lZxxl!%%_B!J62RWLY}M_{n^qXlit+{z#5-u>fU^)_1{g~af8Vt{ zozhlJCl|KehXJp}3RhRPrjBR%d8Vp*1YF+)Oc4n4{oq&?Wm;$sBiFohY)_%Y%bL~n zkG!OnbA2q$Ll>9wxz&I2o1lZ+EovpTP;RQ?2{ps%yZ+HgYISgj)s5bfD|0o?dgavW zR_h`wxs#8o&7(K9EZV(rOVgvPBU0J)I+ev#T}5MFA2@F|+nJYl1P-S(mlz#uyz5cs zy|pK{uve7P9M4AgidMMtdmK|La~8Sv3XlS} z_dSTdUdPf|0`LNCE}2GIOXT{2VUQaUs-{h+j>y;K0KJ3U@-*C}&esj&Er-YB6m>~ObBon zW@M^(b_*>(f=?U}PFX!s+V=U`#TGMyu>(0(z(Xn+J*n6K(KnwCZzOq+s z?h%MK*OjMx9Y-F|P(Z8kmNA6t>_?A0>TjCNOVa@$4)lz~S-4}|pFTpflMkp|`H}*y z(>-z|M*f`6<<~=rTtHEY`(;ok67t&<0ZuUAp(?!vt9$e2*U)q1r99$D-i@33jh29q z0uBS1RD;Zon_rjZy$;Jf+?4oTiIU+w%DG*gl5g65tv(bmAmC6v$#L)`r_N5Hs)XY~ zadWJglP!qo)NSf;$wDqXS~y;l#YcGO{Dx9wN?OAL?p|d!_{|I@Zj{_QX+^GX1@s!r z7a0Aa#M`u*>e|$9ae=-nD6sYRiag2jwLP^w=7?f^YucW0)M^v3O`q*hfGF~fNW8>x zT*gawzZ#OiXhUogQ`omiAsnwF^rkecqo<3+#t){BfUk&Hd)o z&uedpl>)tj7nnf<8%%$a3TtA)uUcv}zUorM`UPOsi)Z&!4fk!{QceswEFZ#vlb^5y zX>UXc&l;MtTsIHJvG_#GTW8^b#nxCxuOR||MT~%JjB5=(3A3v_B`Z9NZI z{5v_-3g$wSYq9`3a9sxt@748~-|jG%#5HxiB1*^bquvKvLp|=JM{12Au8A<0yflaE zC%ql6j28(8006`(I=@<0;mufJA)ju)vd+-imN|8`?%PI%O+5POZszO>p=_Ng^v_;I zI;vywSq%Rj(z9dZy>m~Zx%89Ly9T&1o%)8L1O4(O9R1yCHD>DDB%H>Xh?xu3e9H45 zx)4ocdlsCtgTg>Rd)t{&cPmYd(Cx0nj`~>Ub$zK_8IRxhh?!;H5*-p??GBu5NGnpq zZ;OO?TO{hiEo#mq!A?QuqUvbM^0p7xKE=IO9qAG9DKT5iS7dIHwnw|PD7|08XUWtf zDn8inXI6?Dqro|3tzOOEXsd#DVk$2K&S?UwxnzYzWou!hyCg~cPt*=@?0xfbZ@o%2 zPl>z6gY{r~z>ZH)22j0TAR^3U_g!E~s71v&r(zA;)@xgVeoMC(cVJ&aji0&68{!Zq zXrVHs%G?MoV2_9edf~LDV^x{J<$5)R0^L*IJ^W9q_iqotse^0O39%{aJ4;(W33OuI zY_ra+^^gzgcT@6dJZf4s_8_aDe;m~WNYv_t3PA_8bhs2a-pWUwX094mQpdbxz(w@Q`#0YpNx-MYB z0w$MXNw(2>il(6%RX=V=rCy8`3Alc#X7*s!k4Eu_7!xZnK!P5DH`_wm`F_sU={8J~ zy?=dF3Six+qUJ+o$cTzOV+ZVwipdrErePVyiZIM9wE!I}m7Xuo9ghO#(zl~jFT99+ zeSh@QLa@Db^`s}ZMAp~hK-Juey5-ykPrk|&{@0f`Psl2_C{~>F@P$b0-njRz{jp?xt^i4YQKA6Jz2L{ z8o1T+e0^DQR299x*4-qnN0!5{SjDN?P%STb>fR;1>YY5-x86Q(I%$lDk`I8(f_7rn zqS{55#4FH}0ykfV1s8sCr029FMoUHC7$5QCelYs+m{XKyP6q(xUQ`Vq;aof!@OpS8+7$c%$9~|qa4uf54?i>!41_%oYG(_6jAze7 zJf^oTY79Zio!OlQ61!F7*k z)bf~?yj4Jp&cti!q7RPwT5>e(?0qLvLFcuq@s658dP6B?zM>H*=9Uzg;@>NWlsx&C zZA*j{d16IFyuSxJ57(kby!7O0xlBSitp)25b+)Wu)b#an92lrSb6e8p`sh_>o_uCP z>TA1C2kNI@;0t9^vaDO-2OstUzK9O=wJ8%V9p|#*WMCC#^uY$0-Fbn{vGI6og#DL8 zi^J`Kg%VdC)OiM=LAcfpD$!$9ijL^AoR_vZ^9d5&LtUu=5&M||Z-|m@G{#!28gG_c zcu|oTtZ9s1_!s8MoUfjytTAC0jt&TI{X*qO4LafC+81Z36!1)nntPkX1{-%Jw{m&~W1XcO82WRIAWM;8=b19;7*LPe6q z6Lx|6w2|YbQs0L{SKv*?qQ>~uwY~h7PN|KKAet?%j^MhZ?sa(Coea&V$O zWM6xxjf{%5(PSxZpuuOUBW&P^s-tLu%Is^92PydM52r$ry(u+Lupsm3lT1yJCeD}r z0k+^AIGgGguZD%b)9KuG1fxV|{jsecv0Q5WCw5N&5I~A|0whl_?YHpu$?BkMb{wf6 z>E2dSEtTPv&c158z`m#O9muAcM{ILiftb|M3a{$gch;1Qh)yndl8zi>{%y?uYGj;c zO0HjU)@1Z)=zUF*%9SaEMDK?L&M}I9YsoT1qZ|5z@#wy+X{t?M0iWYg$fdfQzO$+) z(+8RmA^Cp0&Ww*0V>@I8`f#`T*OD=a}HwCYNNnvn>nF>hGB!evT^WGxZD$_!`&e4G=LM#NULx|U7rK|>^wFwFw?L^l z!Ft(zvNpMF$n*i&3{To-tm*Slj12SS;9HG(@H()imcP%M~uF9FX^+71!& zk$b3yyqfm+{q8W9aZFyaSNWTKa$v1dMJLeleQ8>`4q|V^FisDwuZ}6O#t~}~(Z-s? zrsLnt7rbz3bJ^xFtIZi+gB0R%ID-QCB=irxXik^?eY7JC^=8*(tIdIWaM3gPcBr4% zza8qkpFXB!;E*_0Z%nVtC+^Q@vX_$aqf(~a7$<@yVYjLz=Z~6 z?#T8iC!_j9Ai<>A!1@BbS9U=7=dx)}#&(ENPOgAsPHCzwbgCFoy$H5iu& z9FUu%MD;f&i8U`>w&19YI%@_9!6Ty9h(V=K`rl6El8;d)%l!fP2eDJ%W`XDxI1-3S zHhYbb+Y1Gf0ZGh{4{p&r*RB71{dXM)sO;1OX~6H#4gdPGOXu+Rmxf|{Y^{M(y92DQM`(6$~S&!>mr3P&Zv4u^fugR_2ym*n3Pm>XnTiD%a<{=^vq^x z1=qh>Zub>T2Z`G&Y|FZAR zX)i3D{kbXcZ3MF1r4O%NMb057e5;*IL5qSQ68`%aajOt$U=UZ={yA?7h zt+DZR{FW9ZXZnhF2UKg|n!L|+mw%$wyxmwW&{kr1m$1GxCDk{Su(TEnv=xKWG%g6K zxPLq(tY)TdCj&11>XaC~F;I`zsJPsus*?98@55VRb(6Zy6$@aWHCoAau#0H}D2IE~ zwZ2wf_%8VH2tEWq;zdA}x{ty;;b;YpX6;M3Wd-Skq0?$U%@+xm49VlVQKwtFy%bKM z7Z?}4pA67e>VS&Oc(3`^SRkG7y*_N*e!L0vPG!tr!UnRmkZ)X2C=o1Wkn+nlQ^~38 z^2r{plF+1=hveDCU~_Y62W*TIi2gcE6(L>rpq$3 z&=5^k__EV=5@M6ta$jXsW{XMOyRay>T%MuJwMz`s)ydr^)cgM9UY*U)^pPqIW3XVX zfQMr-T2LACE>6~>wLXjsB@x=5tWwchs`qiVa=w;opsp+ap=sOGr(C72&XGLa#t)vj zc(%`DsPxvo_&N*3+7GS*eHyXID*iH>I8L3gpyUGM0udoHYJdib zey+Xt{l)^*1ZCcG45V>J-EY2Zhm?U4QN0B)i<#)6awuM$UdMu5x8VH(@6)_!+xYgq zRC-X4%)Y;_Mg;;@Uu73rlAwRwxe1pU!2HX@2}0S8?knMxrRl| zJR@WaZgos*b=1^E5|ozmfPcBts>XMb%@VC_O%KR<%_Fj59ApmCWT+jSEoTFE2{3!a zcNo#ia7Q||5UXpo{T0^d>Xh-QAxw@Nmtoa(CCwfK5k@wwj1-yPQ zzd165y48VQIWl_Lp(DlFs|=}skVRNlUf zB(yxLZ6p@7y#nLiNLQ*B8pRjp<_qP(r603}&!=n)`%Vf(I#)My)=Seo``Nb*tuBQn z_mWBGdaUX~K9P2qA&49K0u^|Tv5cPPJ$4=Nn5yiintg zl!eNt$j>TQJt0Q93BkaWOK8eLGw-kQK7(t1u50w-#>1Y*K{G@&;bpM7O!m+ToTq-* z)kJ$Zmnn{wpY|C=?e@p7*Z9$G`k_zzjP&_s&FxY1YaoCA41D*xg zs$B<|iF-593$B?kw(uaBIpbI;OtX{MUTa&ehWMG(1?{Enp8#0o$*9@A=+D=@62@KP z17-?U5*6%U!w%;DH1-%LMyp1P==2G-4N~C8Vu7vgb7h8Qh5CsK2kafJeg7vfOPdrv zU4G|XJD}$o2TB04_J@8z7ZP^&0MMF5H3uDYOx$+|r(W=KkmO!trL|RCLEnIH;#Sba zgVb)H%@|Q8Qml5EX%mG+jeX#3^o5}?+xTQ@4Z)Nsq4&k*#y{hb8R2d{Zk{6nMkUN{#~VwFl$!!7X9PssZB&?q^PO3t8 zan+CESj{VLq~EjXz1M!x0dY6hVP1M!=P3~HEJ*SG#@;0-6Zxe#@uT5#vF4hSdf6rz z3i~9c)HQFbsWqwdBT~IBPDR^F>`gq{uN^)74^S81=j!}gkHXlmvNIRwe$egE@bd&s zu72CnCoG)++h&KnF`G!oQ)OrVpngKaFzovcS%>EOOewp@#$yW5-n)tA>sf6h{tt89 zu3m~62$GVB7mcGEyymeAcrmM9w&z{+@bc zrMZvMWIx$>Y{0Nyo)Fz!oE<(v`^IIr^@Bc<=7&7DY!d?%iKI8yg*7d!pQQE$&74>t z7u`BLmB#YEV7;&_vEnKC%Z3MT>Dk8oDn4Fxb6U5^-d^{=^AG(#drl~8S&Eju^2;O3 zD?PO|sOdtUAonv^)9m}Hx)IqJ6VZ49A%pOG&w}XIgjijB@{eO)oq>u+nI(6f4=ah1 z27*z~M$9H8x4%zoOTj#t$Dva+jH~W_(fFn}a^V=Vjb~O0*bV)Sm#F7^>o3`=G{@}m zy^FG`p(Ku}+YculEA^V};DJcHoI>^B_U~h6hih4*mIp&~ zI;xACuv=?Q+V+FZo(nSfDC6*M4s+mJjCab$PCVk$}@B>w%Wbi;7GqjSg-B8mjCs8xKurzE}5nLr9juf z0kC6BqGOu#wm=8fwv+M>jB7T_12S>*Kk~EDDIWg?Tl|G2O{}xkDGMDIcCD@BCi_!L zCo46^#(mbqN*1vV_}GACe7q_XdG3jbhVR39Cne2Ka>*aLbkNWZHXGQ_r?q?^7NO;@eBw*a z3Vo~-_dnkO9lcxnBU$31+m{Og?jx%vg9QrgKmyXXxAU#~h1jOFk4PW*?CRoZi;9LFI?Lo*DvTQq=&e-MF>BX(-+ e;y}a5mS|{}zqGD8B7ghVySEH(7F~ZF`hNj!^t+<~ literal 20532 zcmZ^~1wa&iyEnWlA_xeGNQbU~Aku=g2rQzcfb>#Q(w$4HfOL0>G=elN-ObWVBeB#< zE#2Rs-p~D=bDnnwm6>s7{#VEEng9hkDT3RSw?QBff%Gehw;<3BAK>>{9BklklkfG` zAdvj2w1k+lGjt>QR?>(BRXg$CX`{R%5iu#LSi!g?{B>m3^)LR>A@<(_?U}zSn@Xv; zZq*%T*zL`_ZPnG!)!V)26O5mDf9SY%u$i)Qcq-1d)%)HtqHd{6rbHUYhyL%+Yo0uf z@AnzPNgn)jF70D3l=wz%ux|dl@4#YyZ;y1NAl6g;=YJ2w=yiulZZB=LlDShht)y;! zU;0EQ^uAMH{T4UlB{FYnS+PFC%pGiStD3lOkv5eHHF=tfIQ*`F*5p z?ciJ=)nQjeTT7x3qFpC9#MSG?U1KP_6@_|D{05tq+ZUAy6ap)&4gI|C*nJKNGwLYKZJ zD#p&(IdKn?o44@~6*v-nQeBTmWYUQ(ZE=r4lsEgwWm!4oygWk+@tPDLC%;^)%~{dCq{ zax|^7(x5OB0-+JU!L<1T6G|78@p18t_R<-ii+vGUp|g`jKgNbWn_bP}Q=Z*{vI#A| zzJ$5#Pkzf!h09F%5wbn+4ox@GN4Iuo%6Nwv6XvE|O@^=rrCz~k1I)6sKpX6(_leRD>x&a1O_@o7@* z&xGBi;A^DBvR2$MA&EWh%`AD*C$Q5Z>tQP|zl$5+@sEr%6TL4J$nW)u`o60^cKYEb zCSHI~3!m%@(_{SXMlRqUtUHcF*dmocj?!z*DfbD_5Dua=FiO_lQzJBJk0;;K`*rlV zsS202U7m;2v@Q|%F#h>O>pjBAEK6(dV-cmS__+GPK4p?&qiN$TzqL}{>Ucf<AA`EDvmshDelLW)#zgB{g++LM{lXhG=`_0 zL)g|ejeNmyhPNf2oT}*#%{!cNPz=kn!SdRO`U}^GLG=G^_jj<*!iNkb0(Xck@+oxa znQ1Y8pqI5i-;o(&!QDq!UV{+*x4l(BKnWYXDjO6;pIAz)RH@kJSZcccvu_Wz%KnM? z%;kg1`lwklImJif|GNhvAlCgQG<(wJ6eC}eci))zgq$m{740jRO<=!~>G;afqusHs ztob}u>zz?oiAs#^#n^nHZpEnXc9P?=9m$>u!-@fEZsb9Yghs_F&H7BI~)RNAr71A?F{RrHmg+GYd%Uvt)REq(W1( z#HHlaFl$4G_&X(*iRrCJxH$YXsa4;J&rq>0BTmhbypt8JZXLTIdZ|p}W>A95;;Cm& zR1ba(wMqmdVpc}`+0NLP6TH=OYQNQ&biSa%6N6Lqx=!K{ zTyHLfd;-m%f~*Unuw*Btl+$J&ym292WRgqwI6qMjin`t3af}k^9j6du`a_PZl*GV5 zy141jM(^gMc!NbP^yS5Ak^kY^6taA)QoVaBo!hX4SO~T(L`weF>m7}jxEmpLxoj-w zk{Li3hbv3z$`hl012e1|M{V)GQ^?Sn$}Q8qTAIDFL*J*218J{jcJvcgHLVEBV34qA zH7P9h`XF8O*c;Q~tjLFS|3_IDCI(kMrfLPRCuwiIML(TcH#ZB^VX3&}+F_=61*rciiCpuHzZ;g_H`->r-IVcYk@mgd+EJ%06 z{n+4ajt|=$@xf}D-T0IB=lC;KHhu>ig7OW#>i6D)<3um5caC4jrqE-WaGL+u-kw6N zwK54QURTPwOeo#!d;FEPd`xlW0eX6e*Ozw~0lV`yV?yHCRV(9b!&Z9m)E%{TMLpW4 zMMM5go=}=%6~9O!uIUvpBqR%3_f_`&Ts_S6q?dp5sJSh?(CoC~lll_#x63o`&T@7q z&GkV*c?7^FVR_;#9~$-u;nt`KuJeJN#WGl|u_zU$T$WKf;!#Lg4}Y8aSyIA_jHK_x z@41XO-_U3?-6>sL3~!Q02kpLoGH4Rv>@9N{ka(Tf$8KfQDL$BZZ*1zurzXwH&8k@9 z_u#`pDe)Pw&)F{NlXukVJ~yS{GQ+wFT!xkCw238NA3>)S2kiklyLfJoSxXKAy87t$ z;Hi0DpE|c964dSr-8>gF*mQK=Kwt1Ppy?+pqeY_fK_k(RIYW$kr>Wk8pX)W>*{PlY z{TFv)fWYz4_QZC8Iwy&&%I(=_J{_@aq;x9S`nI8*wJVax5wcpn%*SliQ+Ka?Lc{M4 zQ+t;*t)PDX9VQoL^NIS{&jfVL_;gfF{{A>fr^a0_TIlB3cdGqg6G}3qG+g#onRjRe zl#GnA2%wugB@BJ9=!$I~(eOLIj^YFC54&V7GJN+muz_*lF<^nB=k`1fTbnMN_`4p} z=_5HScYAmS*;#sbabnU##cRGLBd*3i6iwY{d)+?8MjyEccTQW`<~4eJt`YBq{O z-#O~Zax>M+`9;3Zlr|na_}Ns&V!of%)&~G>YvS-Bsg%3jiNjTLj2DCZ{-r*aW+fD| z4}bbCDO#A_uWNVr6(tWWki*xAq?0{tZQ7!I3Jd!K7Rne)-3YvT?yjq&cW-ODnyJd| zFeQ$w`;rQ>jUFN~MRjNBPv$%bp@M{EyO;2D2mQRoX3)+Rq#MsgV%p?$Lw|j>$(Jk_ z5xCS!cO;{Hjt|u0%FG9KrG40`kW9zK(ac5 zKS?R(p(xW@MZn{HWVFsH@VXY?$Yw-O4;y9r^`=>HCfs4gZyKkYJ#eCO%g6b%;$aCn z?T*>ddty{4f2-jEc2&?Ykz%Ne#1Cg1guiY;#4OmSJy3tv#n=n|(k=v@R-N_Chm(eQ z1o!_&F2^8xl4?sr!`#{^=m)ptln)-ETw{~68OyFv9Hr8^Yp(Uj&s>KL?{QaFi=(iU zDn}l)C{gz<2gLGQ^u}>Qe~58mwo9}^gS1jo^X&k&prxp$Ig_DFte9`{t074GAZRPh z70D=X7i*ls*R)qL7;VN|HRS3~p4bGf18beS*ZlGK{Wu9aw@d9pPYgMe*pSAZNM4nX z-B>5DmGsQ8@>LRLCrSy4doo|kegk)~<8qtudYj+w=$(>2{t%S@nSiVvPHaBs!T(gp z<0IhT7r6{B{pm_ph=p2kQbb^V4vNqHW^LMTlTtE3sapU|NflANN8zF-1deNH#L*~T z$nmFwSkE`#*z4mXX?vW^;genTxfh4hilEJ(J}3?Uf2fV_FA6cE!S$KF*X0g-lc|-f z;n=3-!S3Rx9SkG0=?RSw?N=s#BJrNx4Crh;0s0!&40eB1gsVH6g>%Wmdc7B(Xdu7KI%dr0B!^3^@QYd-j0s)iaik{i(;Xyc$ z6-w+RcVFh@;xxC|66^STy2TXai}6jDgw^G~?AATm7MyqAc>@nN8eUXd&1D*Nu;DFs za$V({gBg_pxv74HI$wD$Vgjo4u+U@4PoU3RlwKWgq(`$LaK>@+u)sLLZgLY)ECpV# zf4ohx1y=k-&!Iw=M$PJegBE04ek;}g=UQ5(tM)gfz+GWvb38GROoCp5GPW$FPzs{z zH{-bE`hLlA`&F9W_2Wyume0(UU?h0BRFz$C?{g@*;hHBc&AsJPV|k6bv0d{lQ6NPy z$8r#*E_xHo+1dlQ_F|`$=*Mj-5pY!?z znPbhw1?g&?h0ufL2?&OIb02=i^>*>s!cr@Kti1-~1{X{3~w7YeM z1E(~WYWiFy#X}T46o9fbIpknE_dDZyLZ~UuKg+vFgbkxMfD>neCO@1FR+lZt=AcQ! zPU#$9p1hM(*OwcN=bFH2kE-JJ;cT-4$32}QS{JswF?#A2j&6qCGwd8l^f?*+rDFIaFb50*cs)}mNem10m zH?v(fA;3^Ba`zg@=SC1c=wfjI=R!JOluf!}BwzlCYT-BF4~}!S+>GlUhDqm(5Jr*} zL~r!_K}TFZXV}e*vYHARkYLu8p3ekSZ-J?1LCmkqzZpW#gfs0?FJ+h*h=}43d-}a$> zCJJk{wc0niC(5PT3+r_&5!8p#@}Jhp1Ef!trwAdiWr5)R_gxW+lV$RX^AFohn!l~Z zRNZ#bmv`k6P_h#6q3x> z!!{!|_d3(|^~Zu9xXdIOWkHaNWwvM$xa~P(a<%oRED6i6%>=Ghi{=qk)RkQD^KCc{ckba?FhS>X2jaNW*==!bo#E;Us_>bAYoZts7s z<2jxxN9?XDY_!CcAryX~4Z3y&owkP7@M2A8Cu#PSYQ$oyUe^buof#TUI;~1<)t}Zg zq&(HUb5bLP^;82MF(zS=o=}c{Tk(s3X6I0}lO?NAvM}hYVGr`{8rR%lN9t1P2s;wZ z(>`vIp@MeYJE2lH=|5w*4!x+exYdE$SP-z^s4xq?qYZ1aOl6z7GsC%Hb-IM%YAQtd zTTQ|fjr!Cj8b-`sg=Wb}8!*WXE)$RnfIGq7a){WzgvyGMCtxadgP9<$_7{c+z7FEA zW@9L71b$im7>}+D>>1yW*8WT6()stE?3WJst>0jI8&fn&T(;V_$?dN6eD1nf*S6_W zAz`VPi)(3{ks2Y?5=9N0vIoBgIb%OuzC|9yi^U`@KY{t8n;R5cu~>$F+#2wy}y(tcxvF%7OX9Auq2)F@u&_Lyvh_{O+S;-`ou9?&XUN<|yB7ZP}e#K{WY zNlq(D*eBh_(6t!xvssZL)6FWi-RxJdxhPos#=rj8nN~~3FbVK;OmzxJR=59FMJGrmP?DFMajQtJXK=*X|?9)7?s?4X_ zV5eDF=*ht)vaY`e=%jjQCKc8OX-~gET6#_ysHV!uOl7}0{3P1puYLNfyQj5GM5Wg9 z91_LuDfR}=V#T2dqGkbnaEQV9^&(P1Y&#a#GX+lj?$F}5{`k~*fGzb&`ZZ6|h6C@teX1WS@ zz>zL4iz(n3TR4Wx(dLGB&ACOWHjInY0?;Kg$J2qJf2lkC)>ig@(ee#E2}uX;WZL^2 z>@nO$c@u0pkH;m}P>+lpcN;YNC6Z11 zv($%o7E@Nz#+cDH7PcR#K`Pq8HBOIowRaYO7-)Xid9PEAedtFv`A&GxT6fQQ8-e}C zL8Y+cephQ5tY9~`2)CvFaMg63%ZL`0H#iu92$~V$F+hrVR&IS0;qPOE=1GbUV)JYF zqepN;D7h7<&u2C_9p5|_aBV78Lb!q6O~&3@Y6e9qnVLS_bwi&k&*G76g7WlD z-Z7W>>|0%i4yf~h#KH2Z)Pv`_2pNt^;~#pva+KU2U#gtXbIotQnQmO;Y(5$mVVZJ! zn`&d;9k*ypL93{=L83CN`<2Vb{KvVl4u(n+1@G%j^+j&`D-ZNwhZry*Qhwk2L5m6#kd3R^U}GhY&gQiIM;J^Yu@X!=Y=4bbSH6!u3J2le~?bA^V(3 z>%&=L&JBdx3aZ9wOTBx&`;>$)!>m$t!{%*jylxrdXNE>{uDjm@{W9B;v+|fK??{-* zPx;d%^EqjlK>VU@y!;0zVg!Eonk_UN61Me0K9OIZim%jl#wbs*G$iifqYi8W8s^PM zp|pZscT4k;s=Yy$RC4T{_Ne4`L;DTKNm>eR7&iRChW`e?cAd%JQW7__r(w>*erF$lo!>|y&61Cj@!L6)fgbPnIe=a~96d6uf;tv99IS zHc1#>Q6(Uxb0YXm8Nxd!*C#^qTiXP3Th<8fYrACIP-xdAR{;5Ws&^p_zLf$v%h?q! zxzKBXBib&9jdC)0Lbcs`k5N3?|Aro&v*rep$E{X^i??P_ksAF;5=?Ubtm)3`_`~jv z_jW2IM|+;VAIFDs3xjhatAlC_n^mcjgd$h+Ya^>}1Me%7`cx>w7`GA0Jp0I}U#nJM znh%)~@xRGvj*~rZPuhVN+nFyV(?w#Y+=ot(c=>fDQCr&sRW z7YOEboHCin`;Lg^y^5vi$?P|kW}$^iY%_&00sDPapX!V0^p)5snMBT5+ofK~xl6UN ziX=8mqzHe*%)!QbWH>sOb3y27FgyMPmdL^Q;zHFJihz^_+cBO(OW7VF95mxn5tio;{sPoLP(wd)isI>X&jHy za-xQfAUgXMV`}pHQkTnb_s@5Ub=29+4b^NDiuN`a@B1rK?D~gM)Wdz+eruH%ggE7jB>t%e|Cgmy+GIqrKB=bdf`o9T57B~}j(hD^98 z(Ml1s)WtkAEFWn6>RkbJD_ZBK=uuJNl!X$6jor#uX9Al3mei&)K3BOq4{0`yvbA;L z*Cqv+&cFFh_+o^q13&1XtMhp2Wcrjx^0w>dG1=&D`ke;cCDW(;t5*X=) zJ9L*f*dgU%dr|HRvRgihYxr$wxT+i;Bf$IZ&^AF~9bT*BnoKCgvE6vQ6-Bi>hb2yz zL-+Woo|A9eRf3BY(S`#_2?|I^Hipyl5tgaw?zIKSjmX_8i@D9Xh~JX+p5FE*#%lC5 z4^BH0I~MvR#KiaM`N5dfCrRjW^SjRsMLi{frAHfS)K=qeLKcG7NtV-aS*CvNyX>UQ zBWX2;HSi7e&{EZF2-Oka$>%yKIxf4Cf1nzJc+E0z#$X`ON7#4f60*Apkhq#nfe2M%jTesxDa1a@Vuj*kM&ys(yG(`duC`)v%^xM- z?%=)F_`3|a6RgW~c1G8L|9K9-d%I+Y+nek2(q7d=;C3&HWMV8(D-Do^UlYAV)*xQ& z7%6;?-AKWW!mXrYogbqG_5OZ_2Zb2u#jopNoEJy)tvJ^~`eawDl`_RTULXMx(UL>L z8VW#O+l?GPwgMpfO)o%vqCs21Q#cq&CJ=q?Pj=?3Qqmo)vw9u0rxui!bnS0x`J(wc z;M4zXcPTW${K6d_N+|AF55*` z?TF?YIq^XLxFNwm&$P*|`KxZ@Vovta^b%>F;&>-~2V$wdN7y0ipcgXM=2+QQHJ}%@ zKJsC)>^j&FuAftB3^WuIo=~^)S@#08`51todknjP^rKn&1cs$jqwnMExU}A_^py`= zL8RXL?>7joQ-g|MZ+^{ev*~1l*W(?kEjU_N4`<6WJ&t%JtuGz;3r%Y_0NAwt#Z2t-(6bo@GeA z!{&B&WW&(%nIMC2*4g*sbnbE}zo`B-?DU{~377E<7B+nSf!aRS4ed)?s`y)U?qNfj zZ=`hGcW(A2@*yJF6`FGi@m~%yYF}DTSB1ZhW|0ICr%Wk2SQOwv#51Hq9XoEAzM(g~ z`w%W-tbb|+G50#By&R+|ZJ*O)RLN6T&QW-vQT`!XRf{d7CAAjhb@a&qJZ^SO!EknK zq1^m9r+MrADUe}+&gNTQ>I}zo8&B`84f|0Zq*`=k0}S*dq^sa?J1~D8$w)vz&f!&I zHOD5?4Pa1~U1Tyxr}Wu3U;bFf#fD!zo2>G@^w5CYGe5JOj(ZE#Xxv7rshP zqxq`Y1?r_Ni;hQ;WFVpjKo4qI`M-a>e8EFq`!Pi(HC&)ybUoUVm5-u6V)o>S+x592 z%j=7VsJ&&Www%6^WT;D^@`snq!{0Kbl(I9wc;aX3t0a6m3(bbbeAtUy=$~>Kln&=} zfUi7m%LpCzlWfSmV|Pbm^5%l*mgh-%6`oZiQ%N%^zjA?A$B-RC{`L!~kk z#Sc>z-x+4SLOTFh!+)^g7OnG(ZyPf;vFpep`L*Hf><(JDp!$mwvq`u^eoe2>O}v~} z;ScwY7DEFSDeF%uNl8(Kh#ePAP0F4%6+DvcYbGq3~umlHan5e z>b|F-vW-p$dk6{WE^kP%?&;0!sBJpz3sJLTx?HvWxu0B^ z39iA}UlXNI&;d{E&+|Vlo*nOg8sr+=5E0Y~+xs;USz$i$kWEYU^cQ#Pe*S@aFy*sW z-m0yji+uIcEdQO0T-Bl!!L5eNi#Mt6n1GCmwlR;vefGK0OMt7bIZ@OG$`-h7JMlz= z`_(gZ_&ObwE$64_hjW36L>p6;WLZIn-o+^lZ(_VKlN;c|K&wVpjWT~;i%AKG^^x?$ zInTK#Y@YXt8U|=emti%o`yV(1UsP@-Q#aV2gSD{%^XQ=UnOyO-z3Uzi)~;)b-^F5o;&OGb@?z?%LwK>a3l;svuF=KY zg?MZVo52euaNfAV{ZX3YrnmiG@?k>3Z(+r?YE?oHn&M;mz&-$et)>@nk`#`#p{pf#1)+qIE0@D`TaC zob5wpF$-;hGd4^Xxb6Rwn>~ER&hhAQWc9_1D;~1-kR7xOcoMoq%~12jh@D9|^d(sD?d`J@%QievKu8o41722J4{d1Gr z>9W2_M>3;-XnL+TbV;f&d*6!qVyb)Az%TlWeA}NsRDboSG4^h>g$c89Bh#ytcBU4m z!&p{zAou>c7@XY}H+-}Z5R4zmW4dS4aY?mjj72BFq2$=4cg@) z`wHC|-gM4M-l|PR&*Sk_2Sp03^u{kjS8A&BD%wcl7b@l9sWuBMLqQHT2+Kyq3j*rr z3Nob6hLi#K$aqM17+)-6HpUumR8TtMe!5XC~HdP{(HJbhhyP8vVgfJ02bO z9VZ@zaV&_0gxdPM`Ei_XtM@!V2@;S!6+vkQsUE246ih&wa%KzBiQ5k62VqN^y4|i7 zs7>`99dxFLsZ^2Cd0axMnw&Nnbr$5t%8;hZZ8y{{+#4QdCOt7vX~N4DnBTaFh|vnz zcV16j3gQDa!H-takNnXZrIE=*8?Eo(=-`>&>!_1MuTZNa8iCky;VmQ3}_c;KSM>v^|aF8q_%;LimU% zQ!X~8-fW=h2^(_W4A$5^{Pk>@f@|0_B0CMgs7}0GfZ(v3@Gkb5ppRU1-8M1?x-&G!!iRT&= zClr2^6>bBy6E=T$%yh5U)X{r`vB3~ zvWv_jR0!i=_2S99f;i`8gn#}C(_e!PDr%r`>_~8TKhiiPjYMu7gloN%Q`&I)9RwUt zN2n_WJ#3NyMCOMyx8uLEN3Ji-s8!x&is#lo*Tf?ubLXr7{uv0Tmwf3v-*iAR3fD2*N-7-T7EP@rh6p2 z@+Uo?uC}9>Xg$0@g$vU%EY4|18qB|N-Sx?ddYi_q@6J05_kjtBn#kP~UjuNJ z`JZaTr`7>|ABT8#Zouav81~N_T5nKQ-eq`QB}?D%O1^)QJtUa^viP6EhUm1+WYA~U zd6D2`Inj!>_yv$}BB1rR{uVRz*Fa#LtKW$TyQ0<@Kp-4)prQgcFK2&uMc{v3{O5W& z`#K2JNC$ukz-9WMm4jWT^zMI8`siZ?&y|KD9hmOvaDrY;TQ3i3=bgU+yPoYR`{=Bn zvkWb{(_2o|uaHMy97w%BRTgmF8;sf;WI8r&j^cmFcsWq8Zne{CqqH`PoK3qtTM=FG zgz_P+*dhh?NtCNr$?laKTD`CtJqX_aT}ud`<3}Hr@I3tzRN~%m?K`FRLqTzHB~VTI29nRPITHy<^TfyBoyQJ0a_*YHRK@rgS9g!th)Vv zw}r1M^C(Nl_25*YM2ve9B0_$j&v6H{AH~=g$>ZMp zUeU32oLL{%^@X6@w&qUKR{;kqr332f8(;D{7MS{HzLirsDek`8_*ks*<9#rLRTWXS zD|e;~*VFUSOeTvNhmQv|{8CCrtZB8!q7EyAu+1tCAI=9NWyH>5|MJB6shpcMn~(B)|Uaxk4FmUWFQuc27zq}`}J=|FXbRvD9TRfZbp!0_G(?#Wr`)2z&X z*!D$psO9En<=m7**|$VR7#qKKY={5(*qIaO>+X!Y7Ag6=jQlEjBYWm2D<p z$gMO)peKVqvyup;O@y6Uruu_mE%l%kM;&Gz9knp;x8_?gVLFi~8?%w$O)F@Z>`@4n zDqHC)lLw$sJIWRKk#kSjgA8)vLbXh68d0~F5?P|>7)crs=;#U~ebJ~i+e;QHc$j(* z{LEH_sB)=ypID_(<4sUj7biDB5JEK7o7X~gHM$+mUc3FZB#Cpuxc0thF9QI;hOO@XdWVpZpQ1CX*E zHGm<_9~wpoJ%RYXj=qqSQH|Qoy=cEUY`EN~EY@>AZ|I72i{}1Goc;2XC<)|gSQUlN zhQ4^qRWE%0x+h^sa{V&Y>7;teUYizNu`)nW+#|8gb9K0U`ObewKjdHYCDN7PxG1)p!_9-{ zr#RaLP%E7W?>k8-NIqULf8;VED@RCX5B6C`G(+B{9CV@yh4;d^8iJ^I%SAkQKI~{c zZWsv|rr4FGvV&IBYA3L?^WpSj$Hn&X5&T-viYA8+ zg>zR?Gy(_1ZC&3zF-kT3TokVZQQZa5D;kO{6eoKFKQ66}+hHh*-Q+m4O_5=*E9hkh zcesDw&C%GZ_igo`&&8`W-I_0j+RT&`@u>7#wj$X29lop8jMnwLa6Tm0S_%{Zfwpe} zUdt;@sdCoY%tXjb%I8Qn{cQO)Z4)Z>_~!~X${kQGyx8v~8JcGm3Mq1(qBKqD3S<+?v#9xZ{nvn? z)^@q;S{h?9Dejfus?V``D4ZU zg$*f0NWM>Q&mr*Q9;Yd;cD{Pa1!LnI14UE|aGV_t9lNi~kA~{v3r2UQ`>h_p32Dnq`D$u%)DurhYvC|2| zpyalm=!mK7FSM?UDV)7600vVHe+uSZL|p^5KF!;D>hCtTB_d;R9~kvEwe1aBw_;5U zyxSn@oVjzNs0z;m{C=ekBHU|%MS17#)04sD9wh79ypMLO6J6yC88Q@e$rWN=`pzPg zcz3L7k(C#odO4|Cu=U*D=Yzwp%u|$U))Zk1P7WKW85hTAA@-#uR!;@pBQ~yj(>2)j zeU&R2tkzf3Z_cj;ki-;ZE3L2xGDnxHS}7%5ADvV4VA}>z%(@}x^X2bTP!zs)t!;9Q z#UwaLgWjgpy&N4msol!$YwKF2i(I)Cl9~y?_S@Z_XTKy51@hkyi)=d3enJhZ8^A6E z5U;*BI9wx=yV6)-_**Rl{Yqe7z+2_aE{7rO$qkUdraR0^%()3+i!o6gDHM;1Tem7` z0Q<1KBo3t|uKgfQD5VVZXfgb@HCsp4SLdeR&3I|ms=l0?b`yR6G)tSzbX=*iC+Yqx zZO})O-y-kD;icn{tRRg~yi zFQ(F8IQwFu+RXkg*xUTN%NOQK*?uav@qHI0=dS7g!Hp~IDXLOVHE%!AMcTyFRDOS8ucnDO>Vieuz1N8&}%=r`q>y9eL7yEGp_J_q}6SbN{$aq z(F#J`?GeM|9=HSb2F9xg$u$d}7tFX!sI!3lM;$Kf;7ce&C?vtN{vmZS+RkIxICgNi zbr*)Tn*F+QDyIxI@}__6!E6EvW5`Bt z^NIdGiDUJfSASg{D1hop1^*<@SMDnuD6LcK+^>A&)%M~#=pXEX?tS;(U4Mq9`djHY z{&TL==;p^e)mvh#S9!*_%S3* zUSTQUt2?#Y9vB50@~8C_ zivAhv+VBOKdi(Kki>|r|#p5CxH~co+!$;()a?qIh_!{ZfWJZx;O-6@&<%j{)kW zhHF^}o88DgfXk@cyeqo}=*nOI^d)=?&rVIhs}qwY8Lk*((SbE;yc12!x`bfvF!0G^ zzXo!BUwZwe-}E89Jysu10@BViDi)iNPD;~>Cf&D#eW*xQQ!yoU_n7s{N_@_fM@Esy zTR5)hm+TUSWp*!uz(OJv+KYd9K%9nfyl%I03{_{PqiXGo6q08oEIs{a9U3CWrmvou9;v2FbCd zh6uy1TkaX_Iw}c8&*yU9q&)njS__mE_Xa)v1ud4Ua+T}#RlYONqYU$T1H$VUjjbN< zav1igrUT9fFXLTdGvd$6w38~8zNy)~aZSsqc#vHLZSWOgzaY(g9i8wt%RT4|3>x7` z^Bfh;_jOL!6*Y=%JKhG8bIAq@o6VXp(fNTGAR`PAaNIClGd4KhYZKhl+?`uHUg7pv z+~4weEbk`|J?QS?Q%!N<6&BuZybFnorr08VV9K37oE~Pnrz$-WE759r+WXb02R`ExzMuKMD zF2#$UhYn#b__ENp?kKp0hLS$(rE(!x`FTbuLo&bPGMwW%FiLxOyG&V*dm)dje(2YN z8Q;eJj*=wW$9Wc=YgX@F0vY8~<)!4cGtZ?ENeKo-W7ryDQXX0%x~?y1I`Gj=%6=jAZs~YL3~+jXCDuUPOb0r_r?qXk*?mExs1Mcg`nFmsb7g zy_+(5j@Lj1|JqYEF);f906LdvELXPf?5Z)DJ)}N##qdRnrk`nlEGZE-+i_NqM(ueV zjl}w#J`jI*mn*b&r_@J?((v1^32A8m4xB=cyFpf?utzmPJ1JFs$#`$+?*fVIW?{Di zm@9=c6SB?MPo$&UQK|(q>(EfGI(5y9%-$mB;HB=Iip(o8@sZJg9Mi{E91O1We2K$C z$a2=kt+vv;m>HelQEz_DODL~NY3#@+DtikkVS6GF%tzuOV&OMyqnpY zsO4azqCUgbk^#$n?YSbivNBPBUZ0dH;?Wdv9RE^98_uJ0wsfqi|0qnBUNp3Gg`VFE za6YEOIV!ct~1NR3vHbBC(?3@d{vk!)nfo_Z}5a;HZFg$ESw3Ww$Qbb`K^bl z(a1ZVnCoG2;eEGpXl&frylP(VW^2cL;zpwj`mxf-LF28&OONv4DRhCb2Waox03du&Kx-88RYnABxW~RiYeTYpG`7q7H`Sx%? zoKW#(B_;a~&1FT|u&N7h*qP%y-eL-__xJc@>`}lM2wI||PdevRFSSkMn8tXQSRYz1)u4 zq^Fv^hj4!Fu{Z2>5&+J9@H%perBYLlyQ6pKs#licvP{7O=om0TK1)ORSvmDn<{QG8 zB?N`cQ?(ynw@Fzfn3b~b&9!_XeKG{xzGO~>#bDh9q#PmE%0LzO+83MPD}Xt&Eave5 zS&SUN?NVBnY~s-I?#fL7jwCkqetk%TNaSM=rV~vGp%s1&z^h-!zH2JgyB`At1S_BC zzvk`%X0a}o`x4zY3_?7&n{L^!^wT&|1|G)uM{RRaeF0{0tA~T^O96~?ZB$iWW+g(0zN% zlJv>(N@`p1H5{M2u~#-M^_=BBWE<%4?p*I?AiIya%9tL#jG3$y}xEtSbQh zbqp)BObq{4*aPv^eWVUqhugugtEjzDpAW5rKTc&P$T7)hFP z?psA*8g{Ka`U%wK6hOAG@OS{AZ%p2NO)R!K2{L_3Qt+Ce$joWn{0zTU|T2eLM1caFeFvj?cJ|MLeaB(|Dc$(tIal;k&Kb;Px!HoCa;cFlFewqCItw(b2QJP}+iVcv`D$B~Z3lp~ zNZ-7DFYOAs5WzgVJymUI%vqOkNIGYKKJQ1D1FicLwR38e0G$iCeV_F)lQ>aS<6onE z!07{gYH?5L<#AyqOW_+|`p28CWNASE(C5gKtM(V-(>Kpb??Rf-1HXm3sf;}LGjQg{xjk=aO$ zIh8nMj%uOy)*Wi=qA6w;mM>8E9ZAkSTrq`(h^vT=BlQW0GTcn=weA zeF-Si-SX)Q3(XG$Y2FNVCWBvj%*Qzn1>}WQg0JUK7QNxtZbfe3GTRM`FbXfG*(++ANft14| zW4jk>Q=n1)`i>Y;6waeR-VqQ)yR-tN|Av^tkv}`z;sS-(Z2#rOp(sB^N%$Yj+VQ;w z)CKly)2B1ko*U)=k3inFazie1?*5ZX`B*@!`VkK>+^$U#AE;RE1VUE{Xob{ds!_2U z+flOGqPas=XB8Gx(`Z1624g%?(LkzgYnWS+dAH%G-&`4GFB$r(_WpN;CCYz%026K3 zig9}oanqc~X&;(`(KGWjWcQ|kyyPNrsJP#q0OMTc4Dm3l+!NI+&F)8dAFK^avF0y) zw$GAa1A_S+>@Zm{In@|Yy(CrI`wc%^&tx9FDSQL0n79FUT5&ZY*@*ySIPbHr{fXu_ z3lclOz?Z*nH#~1w740%T!&db;Wsx5=a^``m)@xQ;KJ0G~&yFjE)@jJBsGvpz4)H>< z5{$QA5JesRUH?@?!rj^G+S%1TYZuP~#%~syCv|q5G}~D{Hdz5V>SJN5S5ipWV-^(e zb&7VKfB2Tm(P7w^BCIKM%`g{O{C=mQGgi0`hrzeqH_G>)YAi+jwV7HqoL8tOXvKzS zy$spqk@i>)_mr|;Y!A+&)Mrzv`Tqti#DJwu_rzW8a#bD@Yu?@69eqpl^qgaClkT58 zrDg`q8X|&%3w6(*zhC?pI1Si;>$88|2Y<&EpI)haU(UGysCd(YBg&xaTClH6RCz^^ zLMrSq8?HWRDV^bVK|c9;ejV&gn+KR zM_|?O@P`f7X$IEr(7{3mh6yKN9cP9H7dGH51O%uUA@#@^p@WGG44piX2{51{j}+jd zLx^GrCFF*~sL>464-nwcFEnNtg!s0>Bhujz3!E(^DW-ga6Rye(g(sJGKi#nD(*;GS ze8Z34H@^{4+^GB;xCb68=keggKH!NRP@a&*ruW_-+%^SOmQ6O-LI2h;pO@E=&w_4779Oq`4 z-u}A~o>ULHz6nkFzv$6@$>$PPnM$#=SUrVRU3YJCHM6gccx00OxyY9;ThFuR=M_NowNKcU9KvXX`fx7 zDB%dpJPRzQ1S|jWy)Ihv@|JE?;RCU?Ru!|uWOw;$^WRx^;;(t;$9K{u*|$Y^70%AM z)t7yx=91&8Tc@+wc!Bj0@W_WFlfE#Seoc0_^Xk5Pi?$i_1up)#dhaWPC%}!j&Faa0H+7Gz!ducT zt&4%)5d!LX^M^O;y-|~N-<@S&-QRHp@A&mVH)`8=wX?S?d%w-!qqM9eZeQJOzj^z; zTBGznt~xy7zFUA_FfgOSn(R+}{CXdV&kYNFds2Pnn-*c<^r!49o5wt%vy0lMz1{5z z^sUh1rsD0fOJ7FoUB2Qg{_@aN>5w(COTuN_n$lQ8pZS|t?MVF{w<>nIo$c?ODzBNJ z47Gk9O&Hb;=TKGP7 zpSK|Q`1_#L>6|$x-+BJpyc5yAS2{WDO}|<5=knOaJFVAU{HeWtMZ|B>xUUjizzrP0 z-DZDpP1*GPglq9L{e{5Y?-!oOPgzj(RJ(HO$?5wQfV&ParQ3pL-Vs)woI zC5zAG-Bd_E<^$SI_x;zU6Q*B)3)`xu&fH!wGh8wh!=8U8&m>G|mbRVZvGzJ$7PBZ< zPk6^&)_yL(yA{3rqzikb{470F+2jO+T`E%wc6J9(&kI~==4b?*Ro7Y;ZRP=NH~?4s z`Ajg$3^M#X`M>$}o4XGGnk{Y!Jj@7shS`FGDRTwiSSRb(TK~`pl`n3pds9DS+PfW^ zJ`XP4HGg^B@#4#+u`g}Y=PWL5e|JIZUnZyc^mX@_G3idPzM87>#4X@!&;4%wv?V*a zr$t=~ecH_01MkK?)UZ}QvF6r}e!I-QbG7(wy;A?#dCcy=w^W`@Zt1GUeZe<74sXf1 z?%P!~^T1ZUFxefx+OcjQey!d8#dEU2e$$Y27T}g4-^*!dzMi_hB$NBpMC0im{kJys z9_yLyQ~6mmVA}Vo&-hW&vV@~r{pY74>wYu-T639E%l566==<7^PyZ@Ayn6P##ry5m z)37``wQl}u^Y;Pkes%A8Wgt=n+#%RjX_D%--UPTZ3b^g}$mXV#!AlnCMBXdO-M)X* zp7kccDQ0-JC-d|Q$FtmBEqwF$`fZ(lXQ`ug$G@9?SL&q$<*)zW8~guz(Zyozzz$<(P0i%@r?C{E+Q|9LPgYY_?$^Ba`qAEWyv3CAZc(KRg$QkSf&w#)_ saZIJ8V;s~1h6x`8-6s5p^D2JWU%vEfp{(_s7od8;)78&qol`;+00;Ck&;S4c diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTimePlugin/DebuggerTimePlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTimePlugin/DebuggerTimePlugin.html index fea1e5b359..c3f81835a9 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTimePlugin/DebuggerTimePlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTimePlugin/DebuggerTimePlugin.html @@ -48,8 +48,7 @@ snapshot. This always applies to "scratch" snapshots produced by emulation, but may also apply if the stepping schedule between recorded events is somehow known. Typically, it is just the number of steps of the source snapshot's event thread; however, the notation does - allow other threads to be stepped, too. See the Go To Time + allow other threads to be stepped, too. See the Go To Time action.
  • Description - a user-modifiable description of the snapshot or event. This defaults to @@ -65,6 +64,38 @@ snapshot. This is a shortcut to modifying the description in the time table, but can be accessed outside of the time window.

    +

    Go To Time

    + +

    This action is available when a trace is active. It prompts for a Time Schedule + expression. This is the same form as the expression in the sub-title of the Threads window. In many + cases, it is simply the snapshot number, e.g., 3, which will go to the snapshot + with key 3. It may optionally include an emulation schedule, for example, 3:10 + will use snapshot 3 for an emulator's initial state and step 10 machine instructions on + snapshot 3's event thread. If the snapshot does not give an event thread, then the thread must + be specified in the expression, e.g., 3:t1-10. That expression will start at + snapshot 3, get the thread with key 1, and step it 10 machine instructions. The stepping + commands can be repeated any number of times, separated by semicolons, to step threads in a + specified sequence, e.g., 3:t1-10;t2-5 will do the same as before, then get thread + 2 and step it 5 times.

    + +

    The emulator's state can also be modified by the schedule. Instead of specifying a number of + steps, write a Sleigh statement, e.g., 3:t1-{r0=0x1234};10. This will start + at snapshot 3, patch thread 1's r0 to 0x1234, then step 10 instructions. Like stepping + commands, the thread may be omitted for Sleigh commands. Each command without a thread + specified implicitly uses the one from the previous command, or in the case of the first + command, the event thread. Only one Sleigh statement is permitted per command.

    + +

    A second command sequence may be appended, following a dot, to command the emulator at the + level of p-code operations as well. This is particularly useful when debugging a processor + specification. See also the P-code Stepper + window. For example, 3:2.10 will start at snapshot 3 and step the event thread 2 + machine instructions then 10 p-code operations. The same thread-by-thread sequencing and state + patching commands are allowed in the p-code command sequence. The entire instruction + sequence precedes the entire p-code sequence, i.e., only a single dot is allowed. Once the + expression enters p-code mode, it cannot re-enter instruction mode.

    +

    Hide Scratch

    This toggle action is always available in the drop-down actions of the Time window. It is diff --git a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html index 4afee181b0..a8e988312f 100644 --- a/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html +++ b/Ghidra/Debug/Debugger/src/main/help/help/topics/DebuggerTraceViewDiffPlugin/DebuggerTraceViewDiffPlugin.html @@ -111,8 +111,8 @@ Remember, the variable's storage should encode its value.

    Optionally, the specified time may also include emulation. See the Go To Time action - for the syntax of the Time Schedule expression. For simple schedules, the step buttons + "help/topics/DebuggerTimePlugin/DebuggerTimePlugin.html#goto_time">Go To Time action for + the syntax of the Time Schedule expression. For simple schedules, the step buttons provide convenient forward and backward changes to the emulation schedule. Perhaps the most common use of this is to see what changes from executing an isolated block of code. Ideally, the baseline is a relatively complete capture or represents the present in a live session, so @@ -123,10 +123,10 @@ interesting block of code.

  • Keeping the target alive, use the Emulate - Forward and/or Go To Time - actions to reach the end of the interesting block.
    • + "help/topics/DebuggerControlPlugin/DebuggerControlPlugin.html#emu_actions">Emulator + Control and/or Go To Time actions to + reach the end of the interesting block.
  • Use this Compare action and select the baseline snapshot.
    • diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceActivatedPluginEvent.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceActivatedPluginEvent.java index b09100f4fe..642b4fbc66 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceActivatedPluginEvent.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceActivatedPluginEvent.java @@ -16,19 +16,27 @@ package ghidra.app.plugin.core.debug.event; import ghidra.app.plugin.core.debug.DebuggerCoordinates; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; import ghidra.framework.plugintool.PluginEvent; public class TraceActivatedPluginEvent extends PluginEvent { + static final String NAME = "Trace Location"; private final DebuggerCoordinates coordinates; + private final ActivationCause cause; - public TraceActivatedPluginEvent(String source, DebuggerCoordinates coordinates) { + public TraceActivatedPluginEvent(String source, DebuggerCoordinates coordinates, ActivationCause cause) { super(source, NAME); this.coordinates = coordinates; + this.cause = cause; } public DebuggerCoordinates getActiveCoordinates() { return coordinates; } + + public ActivationCause getCause() { + return cause; + } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceInactiveCoordinatesPluginEvent.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceInactiveCoordinatesPluginEvent.java new file mode 100644 index 0000000000..e17cf03e3d --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/event/TraceInactiveCoordinatesPluginEvent.java @@ -0,0 +1,34 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.event; + +import ghidra.app.plugin.core.debug.DebuggerCoordinates; +import ghidra.framework.plugintool.PluginEvent; + +public class TraceInactiveCoordinatesPluginEvent extends PluginEvent { + static final String NAME = "Trace Inactive Location"; + + private final DebuggerCoordinates coordinates; + + public TraceInactiveCoordinatesPluginEvent(String source, DebuggerCoordinates coordinates) { + super(source, NAME); + this.coordinates = coordinates; + } + + public DebuggerCoordinates getCoordinates() { + return coordinates; + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/DebuggerResources.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/DebuggerResources.java index 278a317c25..6b4b22e291 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/DebuggerResources.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/DebuggerResources.java @@ -174,17 +174,6 @@ public interface DebuggerResources { Icon ICON_DIFF_PREV = new GIcon("icon.debugger.diff.previous"); Icon ICON_DIFF_NEXT = new GIcon("icon.debugger.diff.next"); - Icon ICON_EDIT_MODE_READ_ONLY = new GIcon("icon.debugger.edit.mode.read.only"); - Icon ICON_EDIT_MODE_WRITE_TARGET = new GIcon("icon.debugger.edit.mode.write.target"); - Icon ICON_EDIT_MODE_WRITE_TRACE = new GIcon("icon.debugger.edit.mode.write.trace"); - Icon ICON_EDIT_MODE_WRITE_EMULATOR = - new GIcon("icon.debugger.edit.mode.write.emulator"); - - String NAME_EDIT_MODE_READ_ONLY = "Control Target w/ Edits Disabled"; - String NAME_EDIT_MODE_WRITE_TARGET = "Control Target"; - String NAME_EDIT_MODE_WRITE_TRACE = "Control Trace"; - String NAME_EDIT_MODE_WRITE_EMULATOR = "Control Emulator"; - HelpLocation HELP_PACKAGE = new HelpLocation("Debugger", "package"); String HELP_ANCHOR_PLUGIN = "plugin"; @@ -419,7 +408,7 @@ public interface DebuggerResources { public AbstractConnectAction(Plugin owner) { super(NAME, owner.getName()); - setDescription("Create a new connection to an debugging agent"); + setDescription("Create a new connection to a debugging agent"); setHelpLocation(new HelpLocation(owner.getName(), HELP_ANCHOR)); } } @@ -1660,23 +1649,6 @@ public interface DebuggerResources { } } - interface SeekTracePresentAction { - String NAME = "Seek Trace Present"; - String DESCRIPTION = "Track the tool to the latest snap"; - Icon ICON = ICON_SEEK_PRESENT; - String GROUP = "zz"; - String HELP_ANCHOR = "seek_trace_present"; - - static ToggleActionBuilder builder(Plugin owner) { - String ownerName = owner.getName(); - return new ToggleActionBuilder(NAME, ownerName) - .description(DESCRIPTION) - .toolBarIcon(ICON) - .toolBarGroup(GROUP) - .helpLocation(new HelpLocation(ownerName, HELP_ANCHOR)); - } - } - // TODO: Perhaps to reduce overloading of "snapshot" we should use "event" instead? interface RenameSnapshotAction { String NAME = "Rename Current Snapshot"; @@ -1712,22 +1684,6 @@ public interface DebuggerResources { } } - interface GoToTimeAction { - String NAME = "Go To Time"; - String DESCRIPTION = "Go to a specific time, optionally using emulation"; - Icon ICON = ICON_TIME; - String HELP_ANCHOR = "goto_time"; - - static ActionBuilder builder(Plugin owner) { - String ownerName = owner.getName(); - return new ActionBuilder(NAME, ownerName).description(DESCRIPTION) - .menuPath(NAME) - .menuIcon(ICON) - .keyBinding("CTRL SHIFT T") - .helpLocation(new HelpLocation(ownerName, HELP_ANCHOR)); - } - } - interface SaveByDefaultAction { String NAME = "Save Traces By Default"; String DESCRIPTION = "Automatically save traces to the project"; diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/AbstractDebuggerSleighInputDialog.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/AbstractDebuggerSleighInputDialog.java new file mode 100644 index 0000000000..29c281b12d --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/AbstractDebuggerSleighInputDialog.java @@ -0,0 +1,140 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.gui.breakpoint; + +import java.awt.BorderLayout; +import java.awt.Color; + +import javax.swing.*; +import javax.swing.border.EmptyBorder; +import javax.swing.text.*; + +import docking.DialogComponentProvider; +import generic.theme.GColor; +import generic.theme.Gui; +import ghidra.framework.plugintool.PluginTool; +import ghidra.pcode.exec.SleighUtils.SleighParseError; +import ghidra.pcode.exec.SleighUtils.SleighParseErrorEntry; +import ghidra.util.*; + +public abstract class AbstractDebuggerSleighInputDialog extends DialogComponentProvider { + protected static final Color COLOR_ERROR = new GColor("color.fg.error"); + protected static final AttributeSet RED_UNDERLINE; + + static { + MutableAttributeSet attributes = new SimpleAttributeSet(); + StyleConstants.setForeground(attributes, COLOR_ERROR); + StyleConstants.setUnderline(attributes, true); + RED_UNDERLINE = attributes; + } + + protected final JPanel panel; + protected final JLabel label; + protected final StyledDocument docInput; + protected final JTextPane textInput; + private JScrollPane spInput; + protected boolean isValid = false; + + static class SleighTextPane extends JTextPane { + public SleighTextPane(StyledDocument document) { + super(document); + Gui.registerFont(this, "font.debugger.sleigh"); + } + } + + protected AbstractDebuggerSleighInputDialog(String title, String prompt) { + super(title, true, true, true, false); + panel = new JPanel(new BorderLayout()); + panel.setBorder(new EmptyBorder(16, 16, 16, 16)); + label = new JLabel(prompt); + label.getMaximumSize().width = 400; + panel.add(label, BorderLayout.NORTH); + + docInput = new DefaultStyledDocument(); + textInput = new SleighTextPane(docInput); + spInput = new JScrollPane(textInput); + spInput.getMaximumSize().height = 300; + panel.add(spInput); + + addWorkPanel(panel); + + addOKButton(); + addCancelButton(); + } + + public String prompt(PluginTool tool, String defaultInput) { + setStatusText(""); + textInput.setText(defaultInput); + validateAndMarkup(); + Swing.runLater(() -> repack()); + tool.showDialog(this); + if (isValid) { + return getInput(); + } + return null; + } + + public String getInput() { + return textInput.getText(); + } + + protected abstract void validate(); + + protected void clearAttributes() { + docInput.setCharacterAttributes(0, docInput.getLength() + 1, SimpleAttributeSet.EMPTY, + true); + } + + protected void addErrorAttribute(int start, int stop) { + int length = stop - start + 1; + docInput.setCharacterAttributes(start, length, RED_UNDERLINE, true); + } + + protected void validateAndMarkup() { + isValid = false; + clearAttributes(); + try { + validate(); + isValid = true; + } + catch (SleighParseError e) { + setStatusText("
    " + HTMLUtilities.escapeHTML(e.getMessage()) + "
    ", + MessageType.ERROR, false); + Swing.runLater(() -> { + if (spInput.getPreferredSize().height > spInput.getSize().height) { + repack(); + } + }); + for (SleighParseErrorEntry error : e.getErrors()) { + addErrorAttribute(error.start(), error.stop()); + } + } + } + + @Override + protected void okCallback() { + validateAndMarkup(); + if (isValid) { + close(); + } + } + + @Override + protected void cancelCallback() { + isValid = false; + close(); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/BreakpointLocationRow.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/BreakpointLocationRow.java index d9e7758e17..2d0fa3bb57 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/BreakpointLocationRow.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/BreakpointLocationRow.java @@ -20,7 +20,7 @@ import java.util.stream.Collectors; import ghidra.app.services.LogicalBreakpoint; import ghidra.app.services.LogicalBreakpoint.State; -import ghidra.app.services.TraceRecorder; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.Address; import ghidra.trace.model.breakpoint.TraceBreakpoint; import ghidra.trace.model.thread.TraceThread; @@ -40,8 +40,8 @@ public class BreakpointLocationRow { } public boolean isEnabled() { - TraceRecorder recorder = provider.modelService.getRecorder(loc.getTrace()); - return recorder != null && loc.isEnabled(recorder.getSnap()); + long snap = provider.traceManager.getCurrentFor(loc.getTrace()).getSnap(); + return loc.isEnabled(snap); } public State getState() { @@ -106,6 +106,10 @@ public class BreakpointLocationRow { } } + public boolean hasSleigh() { + return !SleighUtils.UNCONDITIONAL_BREAK.equals(loc.getEmuSleigh()); + } + public TraceBreakpoint getTraceBreakpoint() { return loc; } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPlugin.java index a80b230451..78a7280986 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPlugin.java @@ -51,7 +51,8 @@ import ghidra.framework.options.annotation.*; import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; import ghidra.framework.plugintool.util.PluginStatus; -import ghidra.program.model.address.*; +import ghidra.program.model.address.Address; +import ghidra.program.model.address.AddressRange; import ghidra.program.model.listing.*; import ghidra.program.model.pcode.PcodeOp; import ghidra.program.model.pcode.Varnode; @@ -576,17 +577,11 @@ public class DebuggerBreakpointMarkerPlugin extends Plugin return false; } ProgramLocation loc = getSingleLocationFromContext(context); - if (!(loc.getProgram() instanceof TraceProgramView)) { + if (!(loc.getProgram() instanceof TraceProgramView view)) { return true; } - TraceRecorder recorder = getRecorderFromContext(context); - if (recorder == null) { - return false; - } - if (!recorder.getSupportedBreakpointKinds().containsAll(kinds)) { - return false; - } - return true; + Set supported = getSupportedKindsFromTrace(view.getTrace()); + return supported.containsAll(kinds); } } @@ -720,6 +715,8 @@ public class DebuggerBreakpointMarkerPlugin extends Plugin private DebuggerTraceManagerService traceManager; @AutoServiceConsumed private DebuggerConsoleService consoleService; + @AutoServiceConsumed + private DebuggerStateEditingService editingService; // @AutoServiceConsumed via method DecompilerMarginService decompilerMarginService; @SuppressWarnings("unused") @@ -830,66 +827,67 @@ public class DebuggerBreakpointMarkerPlugin extends Plugin } } - protected TraceRecorder getRecorderFromContext(ActionContext context) { - if (modelService == null) { - return null; - } - Trace trace = getTraceFromContext(context); - return modelService.getRecorder(trace); - } - - protected Set getRecordersFromContext(ActionContext context) { - TraceRecorder single = getRecorderFromContext(context); + protected Set getTracesFromContext(ActionContext context) { + Trace single = getTraceFromContext(context); if (single != null) { return Set.of(single); } - if (mappingService == null || modelService == null) { + if (mappingService == null) { return Set.of(); } ProgramLocation loc = getSingleLocationFromContext(context); - if (loc == null || loc.getProgram() instanceof TraceProgramView) { + assert !(loc.getProgram() instanceof TraceProgramView); + if (loc == null) { return Set.of(); } Set mappedLocs = mappingService.getOpenMappedLocations(loc); if (mappedLocs == null || mappedLocs.isEmpty()) { return Set.of(); } - Set result = new HashSet<>(); + Set result = new HashSet<>(); for (TraceLocation tloc : mappedLocs) { - TraceRecorder rec = modelService.getRecorder(tloc.getTrace()); - if (rec != null) { - result.add(rec); - } + result.add(tloc.getTrace()); } return result; } - protected boolean contextHasRecorder(ActionContext ctx) { - return getRecorderFromContext(ctx) != null; - } - protected boolean contextCanManipulateBreakpoints(ActionContext ctx) { - if (breakpointService == null) { - return false; - } - if (!contextHasLocation(ctx)) { - return false; - } - // Programs, or live traces, but not dead traces - if (contextHasTrace(ctx) && !contextHasRecorder(ctx)) { + if (breakpointService == null || !contextHasLocation(ctx)) { return false; } return true; } - protected Set getSupportedKindsFromContext(ActionContext context) { - Set recorders = getRecordersFromContext(context); - if (recorders.isEmpty()) { + protected Set getSupportedKindsFromTrace(Trace trace) { + StateEditingMode mode = editingService == null ? StateEditingMode.DEFAULT + : editingService.getCurrentMode(trace); + if (mode.useEmulatedBreakpoints()) { return EnumSet.allOf(TraceBreakpointKind.class); } - return recorders.stream() - .flatMap(rec -> rec.getSupportedBreakpointKinds().stream()) - .collect(Collectors.toSet()); + if (modelService == null) { + return Set.of(); + } + TraceRecorder recorder = modelService.getRecorder(trace); + if (recorder == null) { + return Set.of(); + } + return recorder.getSupportedBreakpointKinds(); + } + + protected Set getSupportedKindsFromContext(ActionContext context) { + Set traces = getTracesFromContext(context); + if (traces.isEmpty()) { + return EnumSet.allOf(TraceBreakpointKind.class); + } + Set result = new HashSet<>(); + for (Trace t : traces) { + result.addAll(getSupportedKindsFromTrace(t)); + if (result.size() == TraceBreakpointKind.COUNT) { + // Short circuit if saturated + return result; + } + } + return result; } protected void doToggleBreakpointsAt(String title, ActionContext context) { diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProvider.java index d20079907e..c89fa5abbd 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProvider.java @@ -28,31 +28,36 @@ import javax.swing.table.TableColumnModel; import docking.ActionContext; import docking.WindowPosition; import docking.action.*; +import docking.action.builder.ActionBuilder; import docking.widgets.table.*; import docking.widgets.table.DefaultEnumeratedColumnTableModel.EnumeratedTableColumn; +import ghidra.app.context.ProgramLocationActionContext; +import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.DebuggerPluginPackage; import ghidra.app.plugin.core.debug.gui.DebuggerResources; import ghidra.app.plugin.core.debug.gui.DebuggerResources.*; import ghidra.app.services.*; +import ghidra.app.services.DebuggerStateEditingService.StateEditingModeChangeListener; import ghidra.app.services.LogicalBreakpoint.State; import ghidra.framework.model.DomainObject; -import ghidra.framework.plugintool.AutoService; -import ghidra.framework.plugintool.ComponentProviderAdapter; +import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressRange; +import ghidra.program.util.MarkerLocation; import ghidra.program.util.ProgramLocation; import ghidra.trace.model.*; import ghidra.trace.model.Trace.TraceBreakpointChangeType; import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.trace.model.breakpoint.TraceBreakpointKind; import ghidra.util.*; import ghidra.util.database.ObjectKey; -import ghidra.util.datastruct.CollectionChangeListener; import ghidra.util.table.GhidraTable; import ghidra.util.table.GhidraTableFilterPanel; public class DebuggerBreakpointsProvider extends ComponentProviderAdapter - implements LogicalBreakpointsChangeListener { + implements LogicalBreakpointsChangeListener, StateEditingModeChangeListener { protected enum LogicalBreakpointTableColumns implements EnumeratedTableColumn { @@ -63,7 +68,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter IMAGE("Image", String.class, LogicalBreakpointRow::getImageName, true), LENGTH("Length", Long.class, LogicalBreakpointRow::getLength, true), KINDS("Kinds", String.class, LogicalBreakpointRow::getKinds, true), - LOCATIONS("Locations", Integer.class, LogicalBreakpointRow::getLocationCount, true); + LOCATIONS("Locations", Integer.class, LogicalBreakpointRow::getLocationCount, true), + SLEIGH("Sleigh", Boolean.class, LogicalBreakpointRow::hasSleigh, true); private final String header; private final Class cls; @@ -132,7 +138,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter public LogicalBreakpointTableModel(DebuggerBreakpointsProvider provider) { super(provider.getTool(), "Breakpoints", LogicalBreakpointTableColumns.class, lb -> lb, - lb -> new LogicalBreakpointRow(provider, lb)); + lb -> new LogicalBreakpointRow(provider, lb), + LogicalBreakpointRow::getLogicalBreakpoint); } @Override @@ -149,7 +156,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter ADDRESS("Address", Address.class, BreakpointLocationRow::getAddress, true), TRACE("Trace", String.class, BreakpointLocationRow::getTraceName, true), THREADS("Threads", String.class, BreakpointLocationRow::getThreads, true), - COMMENT("Comment", String.class, BreakpointLocationRow::getComment, BreakpointLocationRow::setComment, true); + COMMENT("Comment", String.class, BreakpointLocationRow::getComment, BreakpointLocationRow::setComment, true), + SLEIGH("Sleigh", Boolean.class, BreakpointLocationRow::hasSleigh, true); private final String header; private final Function getter; @@ -210,7 +218,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter public BreakpointLocationTableModel(DebuggerBreakpointsProvider provider) { super(provider.getTool(), "Locations", BreakpointLocationTableColumns.class, - TraceBreakpoint::getObjectKey, loc -> new BreakpointLocationRow(provider, loc)); + TraceBreakpoint::getObjectKey, loc -> new BreakpointLocationRow(provider, loc), + BreakpointLocationRow::getTraceBreakpoint); } @Override @@ -525,6 +534,38 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } } + interface SetEmulatedBreakpointConditionAction { + String NAME = "Set Condition (Emulator)"; + String DESCRIPTION = "Set a Sleigh condition for this emulated breakpoint"; + String GROUP = DebuggerResources.GROUP_BREAKPOINTS; + String HELP_ANCHOR = "set_condition"; + + static ActionBuilder builder(Plugin owner) { + String ownerName = owner.getName(); + return new ActionBuilder(NAME, ownerName) + .description(DESCRIPTION) + .popupMenuPath(NAME) + .popupMenuGroup(GROUP) + .helpLocation(new HelpLocation(ownerName, HELP_ANCHOR)); + } + } + + interface SetEmulatedBreakpointInjectionAction { + String NAME = "Set Injection (Emulator)"; + String DESCRIPTION = "Set a Sleigh injection for this emulated breakpoint"; + String GROUP = DebuggerResources.GROUP_BREAKPOINTS; + String HELP_ANCHOR = "set_injection"; + + static ActionBuilder builder(Plugin owner) { + String ownerName = owner.getName(); + return new ActionBuilder(NAME, ownerName) + .description(DESCRIPTION) + .popupMenuPath(NAME) + .popupMenuGroup(GROUP) + .helpLocation(new HelpLocation(ownerName, HELP_ANCHOR)); + } + } + class LocationsBySelectedBreakpointsTableFilter implements TableFilter { @Override public boolean acceptsRow(BreakpointLocationRow locationRow) { @@ -555,28 +596,11 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } } - protected class TrackRecordersListener implements CollectionChangeListener { - @Override - public void elementAdded(TraceRecorder element) { - Swing.runIfSwingOrRunLater(() -> traceRecordingStarted(element)); - } - - @Override - public void elementRemoved(TraceRecorder element) { - Swing.runIfSwingOrRunLater(() -> traceRecordingStopped(element)); - } - } - protected class ForBreakpointLocationsTraceListener extends TraceDomainObjectListener { - private final TraceRecorder recorder; private final Trace trace; - public ForBreakpointLocationsTraceListener(TraceRecorder recorder) { - // TODO: What if recorder advances past a trace breakpoint? - // Tends never to happen during recording, since upper is unbounded - // (Same in LogicalBreak service) - this.recorder = recorder; - this.trace = recorder.getTrace(); + public ForBreakpointLocationsTraceListener(Trace trace) { + this.trace = trace; listenForUntyped(DomainObject.DO_OBJECT_RESTORED, e -> objectRestored()); listenFor(TraceBreakpointChangeType.ADDED, this::locationAdded); listenFor(TraceBreakpointChangeType.CHANGED, this::locationChanged); @@ -587,22 +611,23 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } private void objectRestored() { - reloadBreakpointLocations(recorder); + reloadBreakpointLocations(trace); } - private boolean isLive(TraceBreakpoint location) { - return location.getLifespan().contains(recorder.getSnap()); + private boolean isVisible(TraceBreakpoint location) { + long snap = traceManager.getCurrentFor(trace).getSnap(); + return location.getLifespan().contains(snap); } private void locationAdded(TraceBreakpoint location) { - if (!isLive(location)) { + if (!isVisible(location)) { return; } breakpointLocationAdded(location); } private void locationChanged(TraceBreakpoint location) { - if (!isLive(location)) { + if (!isVisible(location)) { return; } breakpointLocationUpdated(location); @@ -610,8 +635,9 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter private void locationLifespanChanged(TraceBreakpoint location, Lifespan oldSpan, Lifespan newSpan) { - boolean isLiveOld = oldSpan.contains(recorder.getSnap()); - boolean isLiveNew = newSpan.contains(recorder.getSnap()); + long snap = traceManager.getCurrentFor(trace).getSnap(); + boolean isLiveOld = oldSpan.contains(snap); + boolean isLiveNew = newSpan.contains(snap); if (isLiveOld == isLiveNew) { return; } @@ -624,7 +650,7 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } private void locationDeleted(TraceBreakpoint location) { - if (!isLive(location)) { + if (!isVisible(location)) { return; } breakpointLocationRemoved(location); @@ -639,20 +665,19 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter // @AutoServiceConsumed via method DebuggerLogicalBreakpointService breakpointService; - // @AutoServiceConsumed via method, package access for BreakpointLogicalRow - DebuggerModelService modelService; @AutoServiceConsumed private DebuggerListingService listingService; @AutoServiceConsumed - private DebuggerTraceManagerService traceManager; + DebuggerTraceManagerService traceManager; @AutoServiceConsumed private DebuggerConsoleService consoleService; + // @AutoServiceConsumed via method + private DebuggerStateEditingService editingService; @AutoServiceConsumed private GoToService goToService; @SuppressWarnings("unused") private AutoService.Wiring autoServiceWiring; - private final TrackRecordersListener recorderListener = new TrackRecordersListener(); private final Map listenersByTrace = new HashMap<>(); @@ -686,6 +711,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter MakeBreakpointsEffectiveResolutionAction actionMakeBreakpointsEffectiveResolution; ToggleDockingAction actionFilterByCurrentTrace; ToggleDockingAction actionFilterLocationsByBreakpoints; + DockingAction actionSetCondition; + DockingAction actionSetInjection; public DebuggerBreakpointsProvider(final DebuggerBreakpointsPlugin plugin) { super(plugin.getTool(), DebuggerResources.TITLE_PROVIDER_BREAKPOINTS, plugin.getName()); @@ -747,17 +774,6 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter contextChanged(); } - @AutoServiceConsumed - private void setModelService(DebuggerModelService modelService) { - if (this.modelService != null) { - this.modelService.removeTraceRecordersChangedListener(recorderListener); - } - this.modelService = modelService; - if (this.modelService != null) { - this.modelService.addTraceRecordersChangedListener(recorderListener); - } - } - @AutoServiceConsumed private void setConsoleService(DebuggerConsoleService consoleService) { if (consoleService != null) { @@ -767,6 +783,25 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } } + @AutoServiceConsumed + private void setEditingService(DebuggerStateEditingService editingService) { + if (this.editingService != null) { + this.editingService.removeModeChangeListener(this); + } + this.editingService = editingService; + if (this.editingService != null) { + this.editingService.addModeChangeListener(this); + } + } + + @Override + public void modeChanged(Trace trace, StateEditingMode mode) { + Swing.runIfSwingOrRunLater(() -> { + reloadBreakpointLocations(trace); + contextChanged(); + }); + } + protected void loadBreakpoints() { Set all = breakpointService.getAllBreakpoints(); breakpointTableModel.addAllItems(all); @@ -824,22 +859,41 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter }); } - private void loadBreakpointLocations(TraceRecorder recorder) { - Trace trace = recorder.getTrace(); - for (AddressRange range : trace.getBaseAddressFactory().getAddressSet()) { - locationTableModel.addAllItems(trace.getBreakpointManager() - .getBreakpointsIntersecting(Lifespan.at(recorder.getSnap()), range)); + private void loadBreakpointLocations(Trace trace) { + StateEditingMode mode = editingService == null + ? StateEditingMode.DEFAULT + : editingService.getCurrentMode(trace); + DebuggerCoordinates currentFor = traceManager.getCurrentFor(trace); + TraceRecorder recorder = currentFor.getRecorder(); + if (!mode.useEmulatedBreakpoints() && recorder == null) { + return; } + Lifespan span = Lifespan.at(currentFor.getSnap()); + Collection visible = new ArrayList<>(); + for (AddressRange range : trace.getBaseAddressFactory().getAddressSet()) { + Collection breaks = trace.getBreakpointManager() + .getBreakpointsIntersecting(span, range); + if (mode.useEmulatedBreakpoints()) { + visible.addAll(breaks); + } + else { + for (TraceBreakpoint l : breaks) { + if (recorder.getTargetBreakpoint(l) != null) { + visible.add(l); + } + } + } + } + locationTableModel.addAllItems(visible); } private void unloadBreakpointLocations(Trace trace) { - locationTableModel.deleteWith(r -> r.getTraceBreakpoint().getTrace() == trace); + locationTableModel.deleteItemsWith(l -> l.getTrace() == trace); } - private void reloadBreakpointLocations(TraceRecorder recorder) { - Trace trace = recorder.getTrace(); + private void reloadBreakpointLocations(Trace trace) { unloadBreakpointLocations(trace); - loadBreakpointLocations(recorder); + loadBreakpointLocations(trace); } private void breakpointLocationAdded(TraceBreakpoint location) { @@ -858,13 +912,13 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter locationTableModel.deleteItem(location); } - private void doTrackTrace(Trace trace, TraceRecorder recorder) { + private void doTrackTrace(Trace trace) { if (listenersByTrace.containsKey(trace)) { Msg.warn(this, "Already tracking trace breakpoints"); return; } - listenersByTrace.put(trace, new ForBreakpointLocationsTraceListener(recorder)); - loadBreakpointLocations(recorder); + listenersByTrace.put(trace, new ForBreakpointLocationsTraceListener(trace)); + loadBreakpointLocations(trace); } private void doUntrackTrace(Trace trace) { @@ -875,24 +929,8 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter } } - private void traceRecordingStarted(TraceRecorder recorder) { - Trace trace = recorder.getTrace(); - if (!traceManager.getOpenTraces().contains(trace)) { - return; - } - doTrackTrace(trace, recorder); - } - - private void traceRecordingStopped(TraceRecorder recorder) { - doUntrackTrace(recorder.getTrace()); - } - protected void traceOpened(Trace trace) { - TraceRecorder recorder = modelService.getRecorder(trace); - if (recorder == null) { - return; - } - doTrackTrace(trace, recorder); + doTrackTrace(trace); } protected void traceClosed(Trace trace) { @@ -1031,6 +1069,10 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter TableColumn locsCol = bptColModel.getColumn(LogicalBreakpointTableColumns.LOCATIONS.ordinal()); locsCol.setPreferredWidth(20); + TableColumn bptSleighCol = + bptColModel.getColumn(LogicalBreakpointTableColumns.SLEIGH.ordinal()); + bptSleighCol.setMaxWidth(24); + bptSleighCol.setMinWidth(24); GTableColumnModel locColModel = (GTableColumnModel) locationTable.getColumnModel(); TableColumn locEnCol = @@ -1049,7 +1091,13 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter locAddrCol.setCellRenderer(CustomToStringCellRenderer.MONO_OBJECT); TableColumn locThreadsCol = locColModel.getColumn(BreakpointLocationTableColumns.THREADS.ordinal()); + TableColumn locSleighCol = + locColModel.getColumn(BreakpointLocationTableColumns.SLEIGH.ordinal()); + locSleighCol.setMaxWidth(24); + locSleighCol.setMinWidth(24); + locColModel.setVisible(locThreadsCol, false); + locColModel.setVisible(locSleighCol, false); } protected void navigateToSelectedBreakpoint() { @@ -1122,9 +1170,171 @@ public class DebuggerBreakpointsProvider extends ComponentProviderAdapter .onAction(this::toggledFilterLocationsByBreakpoints) .buildAndInstallLocal(this); + actionSetCondition = SetEmulatedBreakpointConditionAction.builder(plugin) + .popupWhen(this::isPopupSetCondition) + .onAction(this::activatedSetCondition) + .buildAndInstall(tool); + actionSetInjection = SetEmulatedBreakpointInjectionAction.builder(plugin) + .popupWhen(this::isPopupSetInjection) + .onAction(this::activatedSetInjection) + .buildAndInstall(tool); + actionMakeBreakpointsEffectiveResolution = new MakeBreakpointsEffectiveResolutionAction(); } + private Collection getLogicalBreakpoints(ActionContext ctx) { + if (ctx instanceof DebuggerLogicalBreakpointsActionContext lbCtx) { + return lbCtx.getBreakpoints(); + } + if (ctx instanceof ProgramLocationActionContext locCtx) { + return breakpointService.getBreakpointsAt(locCtx.getLocation()); + } + if (ctx.getContextObject() instanceof MarkerLocation ml) { + return breakpointService + .getBreakpointsAt(new ProgramLocation(ml.getProgram(), ml.getAddr())); + } + return null; + } + + private boolean isAllInvolvedTracesUsingEmulatedBreakpoints(ActionContext ctx) { + if (editingService == null) { + return false; + } + Set traces = new HashSet<>(); + Collection breakpoints = getLogicalBreakpoints(ctx); + if (breakpoints != null) { + if (breakpoints.isEmpty()) { + return false; + } + for (LogicalBreakpoint lb : breakpoints) { + traces.addAll(lb.getParticipatingTraces()); + } + } + else if (ctx instanceof DebuggerBreakpointLocationsActionContext locCtx) { + Collection locations = locCtx.getLocations(); + if (locations.isEmpty()) { + return false; + } + for (TraceBreakpoint tb : locations) { + traces.add(tb.getTrace()); + } + } + else { + return false; + } + for (Trace trace : traces) { + if (!editingService.getCurrentMode(trace).useEmulatedBreakpoints()) { + return false; + } + } + return true; + } + + private static final Set EXECUTE_KINDS = + Set.of(TraceBreakpointKind.SW_EXECUTE, TraceBreakpointKind.HW_EXECUTE); + + private boolean isAllBreakpointsExecution(ActionContext ctx) { + // TODO GP-2988: Remove this. Implement injection on emu access breakpoints, too + Collection breakpoints = getLogicalBreakpoints(ctx); + if (breakpoints != null) { + for (LogicalBreakpoint lb : breakpoints) { + if (!EXECUTE_KINDS.containsAll(lb.getKinds())) { + return false; + } + } + return true; + } + else if (ctx instanceof DebuggerBreakpointLocationsActionContext locCtx) { + for (TraceBreakpoint tb : locCtx.getLocations()) { + if (!EXECUTE_KINDS.containsAll(tb.getKinds())) { + return false; + } + } + return true; + } + return false; + } + + private boolean isPopupSetCondition(ActionContext ctx) { + return isAllInvolvedTracesUsingEmulatedBreakpoints(ctx) && isAllBreakpointsExecution(ctx); + } + + private boolean isPopupSetInjection(ActionContext ctx) { + return isAllInvolvedTracesUsingEmulatedBreakpoints(ctx) && isAllBreakpointsExecution(ctx); + } + + private String deriveCurrentSleigh(ActionContext ctx) { + String sleigh = null; + Collection breakpoints = getLogicalBreakpoints(ctx); + if (breakpoints != null) { + for (LogicalBreakpoint lb : breakpoints) { + String s = lb.getEmuSleigh(); + if (sleigh != null && !sleigh.equals(s)) { + return null; + } + sleigh = s; + } + return sleigh; + } + else if (ctx instanceof DebuggerBreakpointLocationsActionContext locCtx) { + for (TraceBreakpoint tb : locCtx.getLocations()) { + String s = tb.getEmuSleigh(); + if (sleigh != null && !sleigh.equals(s)) { + return null; + } + sleigh = s; + } + return sleigh; + } + return null; + } + + private String deriveCurrentCondition(ActionContext ctx) { + String sleigh = deriveCurrentSleigh(ctx); + return sleigh == null ? null : SleighUtils.recoverConditionFromBreakpoint(sleigh); + } + + private void injectSleigh(ActionContext ctx, String sleigh) { + Collection breakpoints = getLogicalBreakpoints(ctx); + if (breakpoints != null) { + for (LogicalBreakpoint lb : breakpoints) { + lb.setEmuSleigh(sleigh); + } + } + else if (ctx instanceof DebuggerBreakpointLocationsActionContext locCtx) { + for (TraceBreakpoint tb : locCtx.getLocations()) { + tb.setEmuSleigh(sleigh); + } + } + else { + throw new AssertionError(); + } + } + + private void activatedSetCondition(ActionContext ctx) { + String curCondition = deriveCurrentCondition(ctx); + if (curCondition == null) { + curCondition = SleighUtils.CONDITION_ALWAYS; + } + String condition = DebuggerSleighExpressionInputDialog.INSTANCE.prompt(tool, curCondition); + if (condition == null) { + return; // Cancelled + } + injectSleigh(ctx, SleighUtils.sleighForConditionalBreak(condition)); + } + + private void activatedSetInjection(ActionContext ctx) { + String curSleigh = deriveCurrentSleigh(ctx); + if (curSleigh == null) { + curSleigh = SleighUtils.UNCONDITIONAL_BREAK; + } + String sleigh = DebuggerSleighSemanticInputDialog.INSTANCE.prompt(tool, curSleigh); + if (sleigh == null) { + return; // Cancelled + } + injectSleigh(ctx, sleigh); + } + private void toggledFilterByCurrentTrace(ActionContext ignored) { breakpointTableModel.fireTableDataChanged(); locationTableModel.fireTableDataChanged(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighExpressionInputDialog.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighExpressionInputDialog.java new file mode 100644 index 0000000000..87ac94d678 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighExpressionInputDialog.java @@ -0,0 +1,47 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.gui.breakpoint; + +import ghidra.app.plugin.core.debug.gui.breakpoint.DebuggerBreakpointsProvider.SetEmulatedBreakpointConditionAction; +import ghidra.framework.plugintool.util.PluginUtils; +import ghidra.pcode.exec.SleighUtils; +import ghidra.util.HelpLocation; + +public class DebuggerSleighExpressionInputDialog extends AbstractDebuggerSleighInputDialog { + public static final DebuggerSleighExpressionInputDialog INSTANCE = + new DebuggerSleighExpressionInputDialog(); + + protected DebuggerSleighExpressionInputDialog() { + super("Breakpoint Sleigh Condition", """ + +

    Enter Emulated Breakpoint Sleigh Condition, e.g:

    +
      +
    • 1:1 (Always)
      • +
    • 0:1 (Never)
      • +
    • RAX == 7
      • +
    +

    Press F1 for help.

    + """); + setHelpLocation(new HelpLocation( + PluginUtils.getPluginNameFromClass(DebuggerBreakpointsPlugin.class), + SetEmulatedBreakpointConditionAction.HELP_ANCHOR)); + } + + @Override + protected void validate() { + SleighUtils.parseSleighExpression(getInput()); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighSemanticInputDialog.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighSemanticInputDialog.java new file mode 100644 index 0000000000..3b94db0bc2 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerSleighSemanticInputDialog.java @@ -0,0 +1,47 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.gui.breakpoint; + +import ghidra.app.plugin.core.debug.gui.breakpoint.DebuggerBreakpointsProvider.SetEmulatedBreakpointInjectionAction; +import ghidra.framework.plugintool.util.PluginUtils; +import ghidra.pcode.exec.SleighUtils; +import ghidra.util.HelpLocation; + +public class DebuggerSleighSemanticInputDialog extends AbstractDebuggerSleighInputDialog { + public static final DebuggerSleighSemanticInputDialog INSTANCE = + new DebuggerSleighSemanticInputDialog(); + + protected DebuggerSleighSemanticInputDialog() { + super("Breakpoint Sleigh Injection", """ + +

    Enter Emulated Breakpoint Sleigh Injection, e.g., an unconditional break:

    + 
    +				emu_swi();
+				emu_exec_decoded();
+
    +

    Press F1 for help and more examples.

    +

    Be sure to include control flow, or the emulator may get stuck!

    + """); + setHelpLocation(new HelpLocation( + PluginUtils.getPluginNameFromClass(DebuggerBreakpointsPlugin.class), + SetEmulatedBreakpointInjectionAction.HELP_ANCHOR)); + } + + @Override + protected void validate() { + SleighUtils.parseSleighSemantic(getInput()); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/LogicalBreakpointRow.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/LogicalBreakpointRow.java index 1656787b39..362ee3d67a 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/LogicalBreakpointRow.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/breakpoint/LogicalBreakpointRow.java @@ -22,6 +22,7 @@ import ghidra.app.services.LogicalBreakpoint.Mode; import ghidra.app.services.LogicalBreakpoint.State; import ghidra.framework.model.DomainFile; import ghidra.framework.model.DomainObject; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.Address; import ghidra.program.model.listing.Program; import ghidra.trace.model.breakpoint.TraceBreakpointKind.TraceBreakpointKindSet; @@ -139,6 +140,11 @@ public class LogicalBreakpointRow { return lb.getTraceBreakpoints().size(); } + public boolean hasSleigh() { + String sleigh = lb.getEmuSleigh(); + return sleigh != null && !SleighUtils.UNCONDITIONAL_BREAK.equals(sleigh); + } + /** * Check if it has mapped locations, regardless of whether those locations are present * diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/console/DebuggerConsoleProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/console/DebuggerConsoleProvider.java index c0513000cf..0b2a694df7 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/console/DebuggerConsoleProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/console/DebuggerConsoleProvider.java @@ -205,7 +205,7 @@ public class DebuggerConsoleProvider extends ComponentProviderAdapter LogTableColumns, ActionContext, LogRow, LogRow> { public LogTableModel(PluginTool tool) { - super(tool, "Log", LogTableColumns.class, r -> r.getActionContext(), r -> r); + super(tool, "Log", LogTableColumns.class, r -> r.getActionContext(), r -> r, r -> r); } @Override diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPlugin.java index d56d31723c..6d155f269a 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPlugin.java @@ -42,8 +42,8 @@ import ghidra.app.plugin.core.debug.service.emulation.DebuggerPcodeMachine; import ghidra.app.services.*; import ghidra.app.services.DebuggerEmulationService.CachedEmulator; import ghidra.app.services.DebuggerEmulationService.EmulatorStateListener; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.DebuggerStateEditingService.StateEditingModeChangeListener; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; import ghidra.async.AsyncUtils; import ghidra.dbg.DebuggerObjectModel; import ghidra.dbg.target.*; @@ -210,11 +210,11 @@ public class DebuggerControlPlugin extends AbstractDebuggerPlugin String GROUP = DebuggerResources.GROUP_CONTROL; } - interface EditModeAction { - String NAME = "Edit Mode"; - String DESCRIPTION = "Choose what to edit in dynamic views"; + interface ControlModeAction { + String NAME = "Control Mode"; + String DESCRIPTION = "Choose what to control and edit in dynamic views"; String GROUP = DebuggerResources.GROUP_CONTROL; - String HELP_ANCHOR = "edit_mode"; + String HELP_ANCHOR = "control_mode"; static MultiStateActionBuilder builder(Plugin owner) { String ownerName = owner.getName(); @@ -606,12 +606,13 @@ public class DebuggerControlPlugin extends AbstractDebuggerPlugin protected Set getActionSet(StateEditingMode mode) { switch (mode) { - case READ_ONLY: - case WRITE_TARGET: + case RO_TARGET: + case RW_TARGET: return actionsTarget; - case WRITE_TRACE: + case RO_TRACE: + case RW_TRACE: return actionsTrace; - case WRITE_EMULATOR: + case RW_EMULATOR: return actionsEmulate; default: throw new AssertionError(); @@ -639,7 +640,7 @@ public class DebuggerControlPlugin extends AbstractDebuggerPlugin } protected void createActions() { - actionEditMode = EditModeAction.builder(this) + actionEditMode = ControlModeAction.builder(this) .enabled(false) .enabledWhen(c -> current.getTrace() != null) .onActionStateChanged(this::activateEditMode) @@ -867,7 +868,7 @@ public class DebuggerControlPlugin extends AbstractDebuggerPlugin DebuggerCoordinates current = this.current; emulationService.backgroundRun(current.getPlatform(), current.getTime(), Scheduler.oneThread(current.getThread())).thenAcceptAsync(r -> { - traceManager.activate(current.time(r.schedule())); + traceManager.activate(current.time(r.schedule()), ActivationCause.USER); }, AsyncUtils.SWING_EXECUTOR).exceptionally(ex -> { Msg.showError(this, null, "Emulate", "Error emulating", ex); return null; @@ -974,10 +975,10 @@ public class DebuggerControlPlugin extends AbstractDebuggerPlugin // TODO: We're sort of piggy-backing our mode onto that of the editing service. // Seems we should have our own? if (editingService == null) { - return StateEditingMode.READ_ONLY; + return StateEditingMode.DEFAULT; } if (current.getTrace() == null) { - return StateEditingMode.READ_ONLY; + return StateEditingMode.DEFAULT; } return editingService.getCurrentMode(current.getTrace()); } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/copying/DebuggerCopyPlan.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/copying/DebuggerCopyPlan.java index b8e224a785..72dd6647e8 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/copying/DebuggerCopyPlan.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/copying/DebuggerCopyPlan.java @@ -20,7 +20,7 @@ import java.util.*; import javax.swing.JCheckBox; import ghidra.app.plugin.core.debug.gui.DebuggerResources; -import ghidra.app.plugin.core.debug.service.breakpoint.LogicalBreakpointInternal.ProgramBreakpoint; +import ghidra.app.plugin.core.debug.service.breakpoint.ProgramBreakpoint; import ghidra.app.util.viewer.listingpanel.PropertyBasedBackgroundColorModel; import ghidra.program.database.IntRangeMap; import ghidra.program.model.address.*; @@ -233,6 +233,7 @@ public class DebuggerCopyPlan { else { pb.disable(); } + pb.setEmuSleigh(bpt.getEmuSleigh()); } } }, diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/listing/DebuggerListingProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/listing/DebuggerListingProvider.java index 9054ae7f2b..648c4ab67e 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/listing/DebuggerListingProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/listing/DebuggerListingProvider.java @@ -52,7 +52,6 @@ import ghidra.app.plugin.core.marker.MarkerMarginProvider; import ghidra.app.plugin.core.marker.MarkerOverviewProvider; import ghidra.app.services.*; import ghidra.app.services.DebuggerListingService.LocationTrackingSpecChangeListener; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.util.viewer.format.FormatManager; import ghidra.app.util.viewer.listingpanel.ListingPanel; import ghidra.framework.model.DomainFile; diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerLegacyRegionsPanel.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerLegacyRegionsPanel.java index a6844aecdb..6305335d24 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerLegacyRegionsPanel.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerLegacyRegionsPanel.java @@ -113,7 +113,7 @@ public class DebuggerLegacyRegionsPanel extends JPanel { public RegionTableModel(PluginTool tool) { super(tool, "Regions", RegionTableColumns.class, TraceMemoryRegion::getObjectKey, - RegionRow::new); + RegionRow::new, RegionRow::getRegion); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerRegionsProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerRegionsProvider.java index d9bc4b9775..3c65bf5065 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerRegionsProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerRegionsProvider.java @@ -204,10 +204,6 @@ public class DebuggerRegionsProvider extends ComponentProviderAdapter { createActions(); } - protected static boolean isLegacy(Trace trace) { - return trace != null && trace.getObjectManager().getRootSchema() == null; - } - protected void buildMainPanel() { panel = new DebuggerRegionsPanel(this); mainPanel.add(panel); @@ -246,7 +242,7 @@ public class DebuggerRegionsProvider extends ComponentProviderAdapter { @Override public ActionContext getActionContext(MouseEvent event) { final ActionContext context; - if (isLegacy(current.getTrace())) { + if (Trace.isLegacy(current.getTrace())) { context = legacyPanel.getActionContext(); } else { @@ -395,7 +391,7 @@ public class DebuggerRegionsProvider extends ComponentProviderAdapter { } public void setSelectedRegions(Set sel) { - if (isLegacy(current.getTrace())) { + if (Trace.isLegacy(current.getTrace())) { legacyPanel.setSelectedRegions(sel); } else { @@ -465,7 +461,7 @@ public class DebuggerRegionsProvider extends ComponentProviderAdapter { current = coordinates; - if (isLegacy(coordinates.getTrace())) { + if (Trace.isLegacy(coordinates.getTrace())) { panel.coordinatesActivated(DebuggerCoordinates.NOWHERE); legacyPanel.coordinatesActivated(coordinates); if (ArrayUtils.indexOf(mainPanel.getComponents(), legacyPanel) == -1) { diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacyModulesPanel.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacyModulesPanel.java index 0d030f6f6d..d9ade9941d 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacyModulesPanel.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacyModulesPanel.java @@ -146,7 +146,7 @@ public class DebuggerLegacyModulesPanel extends JPanel { public ModuleTableModel(PluginTool tool) { super(tool, "Modules", ModuleTableColumns.class, TraceModule::getObjectKey, - ModuleRow::new); + ModuleRow::new, ModuleRow::getModule); } @Override diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacySectionsPanel.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacySectionsPanel.java index 39f0b93c7d..93d44ee24e 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacySectionsPanel.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerLegacySectionsPanel.java @@ -130,7 +130,7 @@ public class DebuggerLegacySectionsPanel extends JPanel { public SectionTableModel(PluginTool tool) { super(tool, "Sections", SectionTableColumns.class, TraceSection::getObjectKey, - SectionRow::new); + SectionRow::new, SectionRow::getSection); } @Override diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerModulesProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerModulesProvider.java index b5ce14bab5..ab2c663686 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerModulesProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerModulesProvider.java @@ -513,10 +513,6 @@ public class DebuggerModulesProvider extends ComponentProviderAdapter { } } - protected static boolean isLegacy(Trace trace) { - return trace != null && trace.getObjectManager().getRootSchema() == null; - } - @Override public ActionContext getActionContext(MouseEvent event) { if (myActionContext == null) { @@ -1026,7 +1022,7 @@ public class DebuggerModulesProvider extends ComponentProviderAdapter { current = coordinates; - if (isLegacy(coordinates.getTrace())) { + if (Trace.isLegacy(coordinates.getTrace())) { modulesPanel.coordinatesActivated(DebuggerCoordinates.NOWHERE); sectionsPanel.coordinatesActivated(DebuggerCoordinates.NOWHERE); legacyModulesPanel.coordinatesActivated(coordinates); @@ -1057,7 +1053,7 @@ public class DebuggerModulesProvider extends ComponentProviderAdapter { } public void setSelectedModules(Set sel) { - if (isLegacy(current.getTrace())) { + if (Trace.isLegacy(current.getTrace())) { legacyModulesPanel.setSelectedModules(sel); } else { @@ -1066,7 +1062,7 @@ public class DebuggerModulesProvider extends ComponentProviderAdapter { } public void setSelectedSections(Set sel) { - if (isLegacy(current.getTrace())) { + if (Trace.isLegacy(current.getTrace())) { legacySectionsPanel.setSelectedSections(sel); } else { diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerStaticMappingProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerStaticMappingProvider.java index 76bdee41e0..22839ce755 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerStaticMappingProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/modules/DebuggerStaticMappingProvider.java @@ -101,7 +101,8 @@ public class DebuggerStaticMappingProvider extends ComponentProviderAdapter public MappingTableModel(PluginTool tool) { super(tool, "Mappings", StaticMappingTableColumns.class, - TraceStaticMapping::getObjectKey, StaticMappingRow::new); + TraceStaticMapping::getObjectKey, StaticMappingRow::new, + StaticMappingRow::getMapping); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/objects/DebuggerObjectsProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/objects/DebuggerObjectsProvider.java index 94c0b95d99..06477d138a 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/objects/DebuggerObjectsProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/objects/DebuggerObjectsProvider.java @@ -53,6 +53,7 @@ import ghidra.app.plugin.core.debug.gui.objects.components.*; import ghidra.app.plugin.core.debug.mapping.DebuggerMemoryMapper; import ghidra.app.script.*; import ghidra.app.services.*; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; import ghidra.async.*; import ghidra.dbg.*; import ghidra.dbg.error.DebuggerMemoryAccessException; @@ -1489,7 +1490,7 @@ public class DebuggerObjectsProvider extends ComponentProviderAdapter //this.recorder = rec; Trace trace = rec.getTrace(); traceManager.openTrace(trace); - traceManager.activateTrace(trace); + traceManager.activate(traceManager.resolveTrace(trace), ActivationCause.START_RECORDING); } public void stopRecording(TargetObject targetObject) { diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackProvider.java index 153186c853..dfee8e9c01 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackProvider.java @@ -131,14 +131,10 @@ public class DebuggerStackProvider extends ComponentProviderAdapter { return mainPanel; } - protected static boolean isLegacy(Trace trace) { - return trace != null && trace.getObjectManager().getRootSchema() == null; - } - @Override public ActionContext getActionContext(MouseEvent event) { final ActionContext context; - if (isLegacy(current.getTrace())) { + if (Trace.isLegacy(current.getTrace())) { context = legacyPanel.getActionContext(); } else { @@ -167,7 +163,7 @@ public class DebuggerStackProvider extends ComponentProviderAdapter { current = coordinates; - if (isLegacy(coordinates.getTrace())) { + if (Trace.isLegacy(coordinates.getTrace())) { panel.coordinatesActivated(DebuggerCoordinates.NOWHERE); legacyPanel.coordinatesActivated(coordinates); if (ArrayUtils.indexOf(mainPanel.getComponents(), legacyPanel) == -1) { diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerLegacyThreadsPanel.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerLegacyThreadsPanel.java index 47c2066af1..c95313dbb5 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerLegacyThreadsPanel.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerLegacyThreadsPanel.java @@ -120,7 +120,8 @@ public class DebuggerLegacyThreadsPanel extends JPanel { public ThreadTableModel(DebuggerThreadsProvider provider) { super(provider.getTool(), "Threads", ThreadTableColumns.class, - TraceThread::getObjectKey, t -> new ThreadRow(provider.modelService, t)); + TraceThread::getObjectKey, t -> new ThreadRow(provider.modelService, t), + ThreadRow::getThread); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProvider.java index 2aa581c0fc..2349afda78 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProvider.java @@ -26,11 +26,11 @@ import org.apache.commons.lang3.ArrayUtils; import docking.ActionContext; import docking.WindowPosition; import docking.action.*; -import docking.widgets.dialogs.InputDialog; import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.DebuggerPluginPackage; import ghidra.app.plugin.core.debug.gui.DebuggerResources; -import ghidra.app.plugin.core.debug.gui.DebuggerResources.*; +import ghidra.app.plugin.core.debug.gui.DebuggerResources.SynchronizeFocusAction; +import ghidra.app.plugin.core.debug.gui.DebuggerResources.ToToggleSelectionListener; import ghidra.app.services.*; import ghidra.app.services.DebuggerTraceManagerService.BooleanChangeAdapter; import ghidra.framework.model.DomainObject; @@ -42,8 +42,6 @@ import ghidra.trace.model.Trace; import ghidra.trace.model.Trace.TraceSnapshotChangeType; import ghidra.trace.model.TraceDomainObjectListener; import ghidra.trace.model.time.TraceSnapshot; -import ghidra.trace.model.time.schedule.TraceSchedule; -import ghidra.util.Msg; public class DebuggerThreadsProvider extends ComponentProviderAdapter { @@ -108,8 +106,6 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { @SuppressWarnings("unused") private final AutoService.Wiring autoServiceWiring; - private final BooleanChangeAdapter activatePresentChangeListener = - this::changedAutoActivatePresent; private final BooleanChangeAdapter synchronizeFocusChangeListener = this::changedSynchronizeFocus; @@ -123,9 +119,7 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { DebuggerLegacyThreadsPanel legacyPanel; DockingAction actionSaveTrace; - ToggleDockingAction actionSeekTracePresent; ToggleDockingAction actionSyncFocus; - DockingAction actionGoToTime; ActionContext myActionContext; @@ -155,17 +149,11 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { @AutoServiceConsumed public void setTraceManager(DebuggerTraceManagerService traceManager) { if (this.traceManager != null) { - this.traceManager - .removeAutoActivatePresentChangeListener(activatePresentChangeListener); this.traceManager.removeSynchronizeFocusChangeListener(synchronizeFocusChangeListener); } this.traceManager = traceManager; if (traceManager != null) { - traceManager.addAutoActivatePresentChangeListener(activatePresentChangeListener); traceManager.addSynchronizeFocusChangeListener(synchronizeFocusChangeListener); - if (actionSeekTracePresent != null) { - actionSeekTracePresent.setSelected(traceManager.isAutoActivatePresent()); - } if (actionSyncFocus != null) { actionSyncFocus.setSelected(traceManager.isSynchronizeFocus()); } @@ -178,10 +166,6 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { contextChanged(); } - private boolean isLegacy(Trace trace) { - return trace != null && trace.getObjectManager().getRootSchema() == null; - } - public void coordinatesActivated(DebuggerCoordinates coordinates) { if (sameCoordinates(current, coordinates)) { current = coordinates; @@ -191,7 +175,7 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { current = coordinates; traceTabs.coordinatesActivated(coordinates); - if (isLegacy(coordinates.getTrace())) { + if (Trace.isLegacy(coordinates.getTrace())) { panel.coordinatesActivated(DebuggerCoordinates.NOWHERE); legacyPanel.coordinatesActivated(coordinates); if (ArrayUtils.indexOf(mainPanel.getComponents(), legacyPanel) == -1) { @@ -252,43 +236,15 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { } protected void createActions() { - actionSeekTracePresent = SeekTracePresentAction.builder(plugin) - .enabledWhen(this::isSeekTracePresentEnabled) - .onAction(this::toggledSeekTracePresent) - .selected(traceManager == null ? false : traceManager.isAutoActivatePresent()) - .buildAndInstallLocal(this); - actionSyncFocus = SynchronizeFocusAction.builder(plugin) .selected(traceManager != null && traceManager.isSynchronizeFocus()) .enabledWhen(c -> traceManager != null) .onAction(c -> toggleSyncFocus(actionSyncFocus.isSelected())) .buildAndInstallLocal(this); - actionGoToTime = GoToTimeAction.builder(plugin) - .enabledWhen(c -> current.getTrace() != null) - .onAction(c -> activatedGoToTime()) - .buildAndInstallLocal(this); traceManager.addSynchronizeFocusChangeListener(toToggleSelectionListener = new ToToggleSelectionListener(actionSyncFocus)); } - private boolean isSeekTracePresentEnabled(ActionContext context) { - return traceManager != null; - } - - private void toggledSeekTracePresent(ActionContext context) { - if (traceManager == null) { - return; - } - traceManager.setAutoActivatePresent(actionSeekTracePresent.isSelected()); - } - - private void changedAutoActivatePresent(boolean value) { - if (actionSeekTracePresent == null || actionSeekTracePresent.isSelected()) { - return; - } - actionSeekTracePresent.setSelected(value); - } - private void changedSynchronizeFocus(boolean value) { if (actionSyncFocus == null || actionSyncFocus.isSelected()) { return; @@ -303,22 +259,6 @@ public class DebuggerThreadsProvider extends ComponentProviderAdapter { traceManager.setSynchronizeFocus(enabled); } - private void activatedGoToTime() { - InputDialog dialog = - new InputDialog("Go To Time", "Schedule:", current.getTime().toString()); - tool.showDialog(dialog); - if (dialog.isCanceled()) { - return; - } - try { - TraceSchedule time = TraceSchedule.parse(dialog.getValue()); - traceManager.activateTime(time); - } - catch (IllegalArgumentException e) { - Msg.showError(this, getComponent(), "Go To Time", "Could not parse schedule"); - } - } - @Override public JComponent getComponent() { return mainPanel; diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/time/DebuggerTimeProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/time/DebuggerTimeProvider.java index 6f49bc3dec..cf85456fe2 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/time/DebuggerTimeProvider.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/time/DebuggerTimeProvider.java @@ -21,11 +21,13 @@ import java.awt.event.MouseEvent; import java.lang.invoke.MethodHandles; import java.util.Objects; +import javax.swing.Icon; import javax.swing.JComponent; import docking.ActionContext; -import docking.action.DockingActionIf; -import docking.action.ToggleDockingAction; +import docking.action.*; +import docking.action.builder.ActionBuilder; +import docking.widgets.dialogs.InputDialog; import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.DebuggerPluginPackage; import ghidra.app.plugin.core.debug.gui.DebuggerResources; @@ -36,11 +38,32 @@ import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.AutoService.Wiring; import ghidra.framework.plugintool.annotation.AutoConfigStateField; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; +import ghidra.trace.model.time.schedule.TraceSchedule; +import ghidra.util.HelpLocation; +import ghidra.util.Msg; public class DebuggerTimeProvider extends ComponentProviderAdapter { private static final AutoConfigState.ClassHandler CONFIG_STATE_HANDLER = AutoConfigState.wireHandler(DebuggerTimeProvider.class, MethodHandles.lookup()); + interface GoToTimeAction { + String NAME = "Go To Time"; + String DESCRIPTION = "Go to a specific time, optionally using emulation"; + String GROUP = GROUP_TRACE; + Icon ICON = ICON_TIME; + String HELP_ANCHOR = "goto_time"; + + static ActionBuilder builder(Plugin owner) { + String ownerName = owner.getName(); + return new ActionBuilder(NAME, ownerName).description(DESCRIPTION) + .menuPath(DebuggerPluginPackage.NAME, NAME) + .menuGroup(GROUP) + .menuIcon(ICON) + .keyBinding("CTRL G") + .helpLocation(new HelpLocation(ownerName, HELP_ANCHOR)); + } + } + protected static boolean sameCoordinates(DebuggerCoordinates a, DebuggerCoordinates b) { if (!Objects.equals(a.getTrace(), b.getTrace())) { return false; @@ -56,16 +79,17 @@ public class DebuggerTimeProvider extends ComponentProviderAdapter { DebuggerCoordinates current = DebuggerCoordinates.NOWHERE; @AutoServiceConsumed - protected DebuggerTraceManagerService viewManager; + protected DebuggerTraceManagerService traceManager; @SuppressWarnings("unused") private final Wiring autoServiceWiring; /*testing*/ final DebuggerSnapshotTablePanel mainPanel; - private DebuggerSnapActionContext myActionContext; - + DockingAction actionGoToTime; ToggleDockingAction actionHideScratch; + private DebuggerSnapActionContext myActionContext; + @AutoConfigStateField /*testing*/ boolean hideScratch = true; @@ -122,18 +146,38 @@ public class DebuggerTimeProvider extends ComponentProviderAdapter { return; } myActionContext = new DebuggerSnapActionContext(current.getTrace(), snap); - viewManager.activateSnap(snap); + traceManager.activateSnap(snap); contextChanged(); }); } protected void createActions() { + actionGoToTime = GoToTimeAction.builder(plugin) + .enabledWhen(c -> current.getTrace() != null) + .onAction(c -> activatedGoToTime()) + .buildAndInstall(tool); actionHideScratch = DebuggerResources.HideScratchSnapshotsAction.builder(plugin) .selected(hideScratch) .onAction(this::activatedHideScratch) .buildAndInstallLocal(this); } + private void activatedGoToTime() { + InputDialog dialog = + new InputDialog("Go To Time", "Schedule:", current.getTime().toString()); + tool.showDialog(dialog); + if (dialog.isCanceled()) { + return; + } + try { + TraceSchedule time = TraceSchedule.parse(dialog.getValue()); + traceManager.activateTime(time); + } + catch (IllegalArgumentException e) { + Msg.showError(this, getComponent(), "Go To Time", "Could not parse schedule"); + } + } + private void activatedHideScratch(ActionContext ctx) { hideScratch = !hideScratch; mainPanel.setHideScratchSnapshots(hideScratch); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionItem.java index 7bb0c3fb94..59cdd8a5ac 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionItem.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionItem.java @@ -17,6 +17,36 @@ package ghidra.app.plugin.core.debug.service.breakpoint; import java.util.concurrent.CompletableFuture; +import ghidra.async.AsyncUtils; +import ghidra.program.model.address.*; + +/** + * An invocation is planning an action on a breakpoint + * + * @see BreakpointActionSet + */ public interface BreakpointActionItem { + /** + * Compute a range from an address and length + * + * @param address the min address + * @param length the length + * @return the range + */ + default AddressRange range(Address address, long length) { + try { + return new AddressRangeImpl(address, length); + } + catch (AddressOverflowException e) { + throw new AssertionError(e); + } + } + + /** + * Perform the action + * + * @return the future for the action. Synchronous invocations can just return + * {@link AsyncUtils#NIL}. + */ public CompletableFuture execute(); } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionSet.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionSet.java index db6f9761ba..7eae6d3a28 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionSet.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/BreakpointActionSet.java @@ -20,62 +20,122 @@ import java.util.concurrent.CompletableFuture; import ghidra.async.AsyncFence; import ghidra.dbg.target.*; +import ghidra.trace.model.breakpoint.TraceBreakpoint; /** - * A de-duplicated collection of target breakpoint actions necessary to implement a logical - * breakpoint action. + * A de-duplicated collection of breakpoint action items necessary to implement a logical breakpoint + * action. + * + *

    + * This will de-duplicate action items, but it does not check them for sanity. For example, deleting + * a breakpoint then enabling it. Typically, all the items are the same type, so such sanity checks + * are not necessary. */ public class BreakpointActionSet extends LinkedHashSet { - public EnableBreakpointActionItem planEnable(TargetBreakpointLocation loc) { + /** + * Add an item to enable a target breakpoint + * + * @param loc the target breakpoint + * @return the added item + */ + public EnableTargetBreakpointActionItem planEnableTarget(TargetBreakpointLocation loc) { if (loc instanceof TargetTogglable) { - EnableBreakpointActionItem action = - new EnableBreakpointActionItem((TargetTogglable) loc); + EnableTargetBreakpointActionItem action = + new EnableTargetBreakpointActionItem((TargetTogglable) loc); add(action); return action; } TargetBreakpointSpec spec = loc.getSpecification(); if (spec instanceof TargetTogglable) { - EnableBreakpointActionItem action = new EnableBreakpointActionItem(spec); + EnableTargetBreakpointActionItem action = new EnableTargetBreakpointActionItem(spec); add(action); return action; } return null; } - public DisableBreakpointActionItem planDisable(TargetBreakpointLocation loc) { + /** + * Add an item to enable an emulated breakpoint + * + * @param bpt the trace breakpoint + * @return the added item + */ + public EnableEmuBreakpointActionItem planEnableEmu(TraceBreakpoint bpt) { + EnableEmuBreakpointActionItem action = new EnableEmuBreakpointActionItem(bpt); + add(action); + return action; + } + + /** + * Add an item to disable a target breakpoint + * + * @param loc the target breakpoint + * @return the added item + */ + public DisableTargetBreakpointActionItem planDisableTarget(TargetBreakpointLocation loc) { if (loc instanceof TargetTogglable) { - DisableBreakpointActionItem action = - new DisableBreakpointActionItem((TargetTogglable) loc); + DisableTargetBreakpointActionItem action = + new DisableTargetBreakpointActionItem((TargetTogglable) loc); add(action); return action; } TargetBreakpointSpec spec = loc.getSpecification(); if (spec instanceof TargetTogglable) { - DisableBreakpointActionItem action = new DisableBreakpointActionItem(spec); + DisableTargetBreakpointActionItem action = new DisableTargetBreakpointActionItem(spec); add(action); return action; } return null; } - public DeleteBreakpointActionItem planDelete(TargetBreakpointLocation loc) { + /** + * Add an item to disable an emulated breakpoint + * + * @param bpt the trace breakpoint + * @return the added item + */ + public DisableEmuBreakpointActionItem planDisableEmu(TraceBreakpoint bpt) { + DisableEmuBreakpointActionItem action = new DisableEmuBreakpointActionItem(bpt); + add(action); + return action; + } + + /** + * Add an item to delete a target breakpoint + * + * @param loc the target breakpoint + * @return the added item + */ + public DeleteTargetBreakpointActionItem planDeleteTarget(TargetBreakpointLocation loc) { if (loc instanceof TargetDeletable) { - DeleteBreakpointActionItem action = - new DeleteBreakpointActionItem((TargetDeletable) loc); + DeleteTargetBreakpointActionItem action = + new DeleteTargetBreakpointActionItem((TargetDeletable) loc); add(action); return action; } TargetBreakpointSpec spec = loc.getSpecification(); if (spec instanceof TargetTogglable) { - DeleteBreakpointActionItem action = - new DeleteBreakpointActionItem((TargetDeletable) spec); + DeleteTargetBreakpointActionItem action = + new DeleteTargetBreakpointActionItem((TargetDeletable) spec); add(action); return action; } return null; } + /** + * Add an item to delete an emulated breakpoint + * + * @param bpt the trace breakpoint + * @return the added item + */ + public DeleteEmuBreakpointActionItem planDeleteEmu(TraceBreakpoint bpt) { + DeleteEmuBreakpointActionItem action = new DeleteEmuBreakpointActionItem(bpt); + add(action); + return action; + } + /** * Carry out the actions in the order they were added * diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServicePlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServicePlugin.java index 5418a3d6dd..920aedec03 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServicePlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServicePlugin.java @@ -27,11 +27,11 @@ import generic.CatenatedCollection; import ghidra.app.events.ProgramClosedPluginEvent; import ghidra.app.events.ProgramOpenedPluginEvent; import ghidra.app.plugin.PluginCategoryNames; +import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.DebuggerPluginPackage; -import ghidra.app.plugin.core.debug.event.TraceClosedPluginEvent; -import ghidra.app.plugin.core.debug.event.TraceOpenedPluginEvent; -import ghidra.app.plugin.core.debug.service.breakpoint.LogicalBreakpointInternal.ProgramBreakpoint; +import ghidra.app.plugin.core.debug.event.*; import ghidra.app.services.*; +import ghidra.app.services.DebuggerStateEditingService.StateEditingModeChangeListener; import ghidra.app.services.LogicalBreakpoint.State; import ghidra.async.SwingExecutorService; import ghidra.dbg.target.TargetBreakpointLocation; @@ -41,8 +41,7 @@ import ghidra.framework.model.*; import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; import ghidra.framework.plugintool.util.PluginStatus; -import ghidra.program.model.address.Address; -import ghidra.program.model.address.AddressRange; +import ghidra.program.model.address.*; import ghidra.program.model.listing.*; import ghidra.program.util.*; import ghidra.trace.model.*; @@ -65,6 +64,8 @@ import ghidra.util.datastruct.ListenerSet; ProgramOpenedPluginEvent.class, ProgramClosedPluginEvent.class, TraceOpenedPluginEvent.class, + TraceActivatedPluginEvent.class, + TraceInactiveCoordinatesPluginEvent.class, TraceClosedPluginEvent.class, }, servicesRequired = { @@ -186,6 +187,13 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } } + protected class TrackModesListener implements StateEditingModeChangeListener { + @Override + public void modeChanged(Trace trace, StateEditingMode mode) { + processChange(c -> evtModeChanged(c, trace), "modeChanged"); + } + } + private class TraceBreakpointsListener extends TraceDomainObjectListener { private final InfoPerTrace info; private ChangeCollector c; @@ -218,29 +226,28 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } private void breakpointAdded(TraceBreakpoint tb) { - if (!tb.getLifespan().contains(info.recorder.getSnap())) { - // NOTE: User/script probably added historical breakpoint + if (!tb.getLifespan().contains(info.snap)) { return; } try { info.trackTraceBreakpoint(c.a, tb, false); } catch (TrackedTooSoonException e) { - Msg.info(this, "Ignoring " + tb + - " added until service has finished loading its trace"); + Msg.info(this, + "Ignoring " + tb + " added until service has finished loading its trace"); } } private void breakpointChanged(TraceBreakpoint tb) { - if (!tb.getLifespan().contains(info.recorder.getSnap())) { + if (!tb.getLifespan().contains(info.snap)) { return; } try { info.trackTraceBreakpoint(c.a, tb, true); } catch (TrackedTooSoonException e) { - Msg.info(this, "Ignoring " + tb + - " changed until service has finished loading its trace"); + Msg.info(this, + "Ignoring " + tb + " changed until service has finished loading its trace"); } catch (NoSuchElementException e) { // TODO: This catch clause should not be necessary. @@ -252,8 +259,8 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin private void breakpointLifespanChanged(TraceAddressSpace spaceIsNull, TraceBreakpoint tb, Lifespan oldSpan, Lifespan newSpan) { // NOTE: User/script probably modified historical breakpoint - boolean isInOld = oldSpan.contains(info.recorder.getSnap()); - boolean isInNew = newSpan.contains(info.recorder.getSnap()); + boolean isInOld = oldSpan.contains(info.snap); + boolean isInNew = newSpan.contains(info.snap); if (isInOld == isInNew) { return; } @@ -272,11 +279,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } private void breakpointDeleted(TraceBreakpoint tb) { - if (!tb.getLifespan().contains(info.recorder.getSnap())) { - // NOTE: User/script probably removed historical breakpoint - // assert false; - return; - } + // Could check snap, but might as well just be sure it's gone info.forgetTraceBreakpoint(c.r, tb); } } @@ -375,8 +378,6 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin Address address, TraceBreakpoint tb) { Set set = breakpointsByAddress.get(address); if (set == null) { - Msg.warn(this, "Breakpoint to remove is not present: " + tb + ", trace=" + - tb.getTrace()); return null; } for (LogicalBreakpointInternal lb : Set.copyOf(set)) { @@ -393,8 +394,6 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin return lb; } } - Msg.warn(this, "Breakpoint to remove is not present: " + tb + ", trace=" + - tb.getTrace()); return null; } @@ -451,22 +450,41 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } protected class InfoPerTrace extends AbstractInfo { - final TraceRecorder recorder; final Trace trace; final TraceBreakpointsListener breakpointListener; - public InfoPerTrace(TraceRecorder recorder) { - this.recorder = recorder; - this.trace = recorder.getTrace(); + TraceRecorder recorder; + long snap = -1; + + public InfoPerTrace(Trace trace) { + this.trace = Objects.requireNonNull(trace); this.breakpointListener = new TraceBreakpointsListener(this); trace.addListener(breakpointListener); } + protected void setRecorderAndSnap(TraceRecorder recorder, long snap, ChangeCollector c) { + if (this.recorder == recorder && this.snap == snap) { + return; + } + this.recorder = recorder; + this.snap = snap; + + for (InfoPerProgram info : programInfos.values()) { + // This is heavy, but not sure a better method + // Could examine mapping service to narrow down relevant programs... + info.reloadBreakpoints(c); + } + reloadBreakpoints(c); + } + @Override protected LogicalBreakpointInternal createLogicalBreakpoint(Address address, long length, Collection kinds) { - return new LoneLogicalBreakpoint(recorder, address, length, kinds); + LoneLogicalBreakpoint lb = + new LoneLogicalBreakpoint(tool, trace, address, length, kinds); + lb.setRecorder(trace, recorder); + return lb; } @Override @@ -477,33 +495,45 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin protected void reloadBreakpoints(ChangeCollector c) { forgetTraceInvalidBreakpoints(c.r); - trackTraceLiveBreakpoints(c.a); + trackTraceBreakpoints(c.a); } protected void forgetAllBreakpoints(RemoveCollector r) { - Collection live = new ArrayList<>(); + Collection toForget = new ArrayList<>(); for (AddressRange range : trace.getBaseAddressFactory().getAddressSet()) { - live.addAll(trace + toForget.addAll(trace .getBreakpointManager() - .getBreakpointsIntersecting(Lifespan.at(recorder.getSnap()), range)); + .getBreakpointsIntersecting(Lifespan.ALL, range)); } - for (TraceBreakpoint tb : live) { + for (TraceBreakpoint tb : toForget) { forgetTraceBreakpoint(r, tb); } } protected void forgetTraceInvalidBreakpoints(RemoveCollector r) { - // Breakpoint can become invalid because it is itself invalid (deleted) - // Or because the mapping to static space has changed or become invalid - + /** + * Breakpoint can become invalid because it is itself invalid (deleted), because the + * snap has changed to where it's no longer present, because the mapping to static space + * has changed or become invalid, or because it has no live breakpoint in target mode. + */ + StateEditingMode mode = getMode(trace); for (Set set : List .copyOf(breakpointsByAddress.values())) { for (LogicalBreakpointInternal lb : Set.copyOf(set)) { for (TraceBreakpoint tb : Set.copyOf(lb.getTraceBreakpoints(trace))) { + if (!mode.useEmulatedBreakpoints() && + (recorder == null || recorder.getTargetBreakpoint(tb) == null)) { + forgetTraceBreakpoint(r, tb); + continue; + } if (!trace.getBreakpointManager().getAllBreakpoints().contains(tb)) { forgetTraceBreakpoint(r, tb); continue; } + if (!tb.getLifespan().contains(snap)) { + forgetTraceBreakpoint(r, tb); + continue; + } ProgramLocation progLoc = computeStaticLocation(tb); if (!Objects.equals(lb.getProgramLocation(), progLoc)) { // NOTE: This can happen to Lone breakpoints. @@ -516,14 +546,28 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } } - protected void trackTraceLiveBreakpoints(AddCollector a) { - Collection live = new ArrayList<>(); - for (AddressRange range : trace.getBaseAddressFactory().getAddressSet()) { - live.addAll(trace - .getBreakpointManager() - .getBreakpointsIntersecting(Lifespan.at(recorder.getSnap()), range)); + protected void trackTraceBreakpoints(AddCollector a) { + StateEditingMode mode = getMode(trace); + if (!mode.useEmulatedBreakpoints() && recorder == null) { + return; } - trackTraceBreakpoints(a, live); + Collection visible = new ArrayList<>(); + for (AddressRange range : trace.getBaseAddressFactory().getAddressSet()) { + Collection breaks = trace + .getBreakpointManager() + .getBreakpointsIntersecting(Lifespan.at(snap), range); + if (mode.useEmulatedBreakpoints()) { + visible.addAll(breaks); + } + else { + for (TraceBreakpoint tb : breaks) { + if (recorder.getTargetBreakpoint(tb) != null) { + visible.add(tb); + } + } + } + } + trackTraceBreakpoints(a, visible); } protected void trackTraceBreakpoints(AddCollector a, @@ -549,8 +593,8 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin */ return null; } - return mappingService.getOpenMappedLocation(new DefaultTraceLocation(trace, - null, Lifespan.at(recorder.getSnap()), tb.getMinAddress())); + return mappingService.getOpenMappedLocation( + new DefaultTraceLocation(trace, null, Lifespan.at(snap), tb.getMinAddress())); } protected void trackTraceBreakpoint(AddCollector a, TraceBreakpoint tb, boolean forceUpdate) @@ -585,7 +629,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin // Must be shutting down return null; } - return mappingService.getOpenMappedLocation(trace, loc, recorder.getSnap()); + return mappingService.getOpenMappedLocation(trace, loc, snap); } } @@ -606,7 +650,8 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin if (loc == null) { continue; } - lb.setTraceAddress(ti.recorder, loc.getAddress()); + lb.setTraceAddress(ti.trace, loc.getAddress()); + lb.setRecorder(ti.trace, ti.recorder); ti.breakpointsByAddress.computeIfAbsent(loc.getAddress(), __ -> new HashSet<>()) .add(lb); } @@ -616,7 +661,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin protected LogicalBreakpointInternal createLogicalBreakpoint(Address address, long length, Collection kinds) { MappedLogicalBreakpoint lb = - new MappedLogicalBreakpoint(program, address, length, kinds); + new MappedLogicalBreakpoint(tool, program, address, length, kinds); mapTraceAddresses(lb); return lb; } @@ -763,6 +808,8 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin private DebuggerTraceManagerService traceManager; // @AutoServiceConsumed via method private DebuggerStaticMappingService mappingService; + // @AutoServiceConsumed via method + private DebuggerStateEditingService editingService; @SuppressWarnings("unused") private final AutoService.Wiring autoServiceWiring; @@ -772,6 +819,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin private final TrackRecordersListener recorderListener = new TrackRecordersListener(); private final TrackMappingsListener mappingListener = new TrackMappingsListener(); + private final TrackModesListener modeListener = new TrackModesListener(); private final Map traceInfos = new HashMap<>(); private final Map programInfos = new HashMap<>(); @@ -832,6 +880,13 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } } + protected void evtModeChanged(ChangeCollector c, Trace trace) { + InfoPerTrace info = traceInfos.get(trace); + if (info != null) { + info.reloadBreakpoints(c); + } + } + protected void removeLogicalBreakpointGlobally(LogicalBreakpoint lb) { ProgramLocation pLoc = lb.getProgramLocation(); if (pLoc != null) { @@ -871,6 +926,17 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin } } + @AutoServiceConsumed + public void setEditingService(DebuggerStateEditingService editingService) { + if (this.editingService != null) { + this.editingService.removeModeChangeListener(modeListener); + } + this.editingService = editingService; + if (this.editingService != null) { + this.editingService.addModeChangeListener(modeListener); + } + } + private void programOpened(Program program) { processChange(c -> evtProgramOpened(c, program), "programOpened"); } @@ -899,14 +965,13 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin // The mapping removals, if any, will clean up related traces } - private void doTrackTrace(ChangeCollector c, Trace trace, TraceRecorder recorder) { - if (traceInfos.containsKey(trace)) { - Msg.warn(this, "Already tracking trace breakpoints"); - return; + private void doTrackTrace(ChangeCollector c, Trace trace, TraceRecorder recorder, long snap) { + InfoPerTrace info = traceInfos.get(trace); + if (info == null) { + info = new InfoPerTrace(trace); + traceInfos.put(trace, info); } - InfoPerTrace info = new InfoPerTrace(recorder); - traceInfos.put(trace, info); - info.reloadBreakpoints(c); + info.setRecorderAndSnap(recorder, snap, c); } private void doUntrackTrace(ChangeCollector c, Trace trace) { @@ -932,23 +997,35 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin if (!traceManager.getOpenTraces().contains(trace)) { return; } - doTrackTrace(c, trace, recorder); + long snap = traceManager.getCurrentFor(trace).getSnap(); + doTrackTrace(c, trace, recorder, snap); } private void evtTraceRecordingStopped(ChangeCollector c, TraceRecorder recorder) { - doUntrackTrace(c, recorder.getTrace()); + Trace trace = recorder.getTrace(); + if (!traceManager.getOpenTraces().contains(trace)) { + return; + } + long snap = traceManager.getCurrentFor(trace).getSnap(); + doTrackTrace(c, trace, null, snap); } private void traceOpened(Trace trace) { processChange(c -> { TraceRecorder recorder = modelService.getRecorder(trace); - if (recorder == null) { - return; - } - doTrackTrace(c, trace, recorder); + long snap = traceManager.getCurrentFor(trace).getSnap(); + doTrackTrace(c, trace, recorder, snap); }, "traceOpened"); } + private void traceSnapChanged(DebuggerCoordinates coordinates) { + if (coordinates.getTrace() == null) { + return; + } + processChange(c -> doTrackTrace(c, coordinates.getTrace(), coordinates.getRecorder(), + coordinates.getSnap()), "coordinatesActivated"); + } + private void traceClosed(Trace trace) { processChange(c -> doUntrackTrace(c, trace), "traceClosed"); } @@ -1074,14 +1151,16 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin * had to re-implement here, anyway. The actual logical breakpoint is created by event * processors. */ - MappedLogicalBreakpoint lb = new MappedLogicalBreakpoint(program, address, length, kinds); + MappedLogicalBreakpoint lb = + new MappedLogicalBreakpoint(tool, program, address, length, kinds); synchronized (lock) { for (InfoPerTrace ti : traceInfos.values()) { TraceLocation loc = ti.toDynamicLocation(lb.getProgramLocation()); if (loc == null) { continue; } - lb.setTraceAddress(ti.recorder, loc.getAddress()); + lb.setTraceAddress(ti.trace, loc.getAddress()); + lb.setRecorder(ti.trace, ti.recorder); } } return lb; @@ -1097,21 +1176,22 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin @Override public CompletableFuture placeBreakpointAt(Trace trace, Address address, long length, Collection kinds, String name) { + long snap = traceManager.getCurrentFor(trace).getSnap(); TraceRecorder recorder = modelService.getRecorder(trace); - if (recorder == null) { - throw new IllegalArgumentException("Given trace is not live"); - } ProgramLocation staticLocation = mappingService.getOpenMappedLocation( - new DefaultTraceLocation(trace, null, Lifespan.at(recorder.getSnap()), address)); + new DefaultTraceLocation(trace, null, Lifespan.at(snap), address)); if (staticLocation == null) { - return new LoneLogicalBreakpoint(recorder, address, length, kinds) - .enableForTrace(trace); + LoneLogicalBreakpoint lb = + new LoneLogicalBreakpoint(tool, trace, address, length, kinds); + lb.setRecorder(trace, recorder); + return lb.enableForTrace(trace); } - MappedLogicalBreakpoint lb = new MappedLogicalBreakpoint(staticLocation.getProgram(), + MappedLogicalBreakpoint lb = new MappedLogicalBreakpoint(tool, staticLocation.getProgram(), staticLocation.getByteAddress(), length, kinds); - lb.setTraceAddress(recorder, address); + lb.setTraceAddress(trace, address); + lb.setRecorder(trace, recorder); lb.enableForProgramWithName(name); return lb.enableForTrace(trace); } @@ -1126,7 +1206,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin protected CompletableFuture actOnAll(Collection col, Trace trace, Consumer consumerForProgram, - BiConsumer consumerForTarget) { + BiConsumer consumerForTrace) { BreakpointActionSet actions = new BreakpointActionSet(); for (LogicalBreakpoint lb : col) { Set participants = lb.getParticipatingTraces(); @@ -1136,7 +1216,7 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin if (!(lb instanceof LogicalBreakpointInternal lbi)) { continue; } - consumerForTarget.accept(actions, lbi); + consumerForTrace.accept(actions, lbi); } return actions.execute(); } @@ -1174,8 +1254,48 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin }, (actions, lbi) -> lbi.planDelete(actions, trace)); } + private StateEditingMode getMode(Trace trace) { + return editingService == null + ? StateEditingMode.DEFAULT + : editingService.getCurrentMode(trace); + } + + private void planActOnLoc(BreakpointActionSet actions, TraceBreakpoint tb, + BiConsumer targetLocConsumer, + BiConsumer emuLocConsumer) { + StateEditingMode mode = getMode(tb.getTrace()); + if (mode.useEmulatedBreakpoints()) { + planActOnLocEmu(actions, tb, emuLocConsumer); + } + else { + planActOnLocTarget(actions, tb, targetLocConsumer); + } + } + + private void planActOnLocTarget(BreakpointActionSet actions, TraceBreakpoint tb, + BiConsumer targetLocConsumer) { + TraceRecorder recorder = modelService.getRecorder(tb.getTrace()); + if (recorder == null) { + return; + } + List path = PathUtils.parse(tb.getPath()); + TargetObject object = recorder.getTarget().getModel().getModelObject(path); + if (!(object instanceof TargetBreakpointLocation)) { + Msg.error(this, tb.getPath() + " is not a target breakpoint location"); + return; + } + TargetBreakpointLocation loc = (TargetBreakpointLocation) object; + targetLocConsumer.accept(actions, loc); + } + + private void planActOnLocEmu(BreakpointActionSet actions, TraceBreakpoint tb, + BiConsumer emuLocConsumer) { + emuLocConsumer.accept(actions, tb); + } + protected CompletableFuture actOnLocs(Collection col, - BiConsumer locConsumer, + BiConsumer targetLocConsumer, + BiConsumer emuLocConsumer, Consumer progConsumer) { BreakpointActionSet actions = new BreakpointActionSet(); for (TraceBreakpoint tb : col) { @@ -1183,38 +1303,35 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin if (col.containsAll(lb.getTraceBreakpoints())) { progConsumer.accept(lb); } - TraceRecorder recorder = modelService.getRecorder(tb.getTrace()); - if (recorder == null) { - continue; - } - List path = PathUtils.parse(tb.getPath()); - TargetObject object = recorder.getTarget().getModel().getModelObject(path); - if (!(object instanceof TargetBreakpointLocation)) { - Msg.error(this, tb.getPath() + " is not a target breakpoint location"); - continue; - } - TargetBreakpointLocation loc = (TargetBreakpointLocation) object; - locConsumer.accept(actions, loc); + planActOnLoc(actions, tb, targetLocConsumer, emuLocConsumer); } return actions.execute(); } @Override public CompletableFuture enableLocs(Collection col) { - return actOnLocs(col, BreakpointActionSet::planEnable, LogicalBreakpoint::enableForProgram); + return actOnLocs(col, + BreakpointActionSet::planEnableTarget, + BreakpointActionSet::planEnableEmu, + LogicalBreakpoint::enableForProgram); } @Override public CompletableFuture disableLocs(Collection col) { - return actOnLocs(col, BreakpointActionSet::planDisable, + return actOnLocs(col, + BreakpointActionSet::planDisableTarget, + BreakpointActionSet::planDisableEmu, LogicalBreakpoint::disableForProgram); } @Override public CompletableFuture deleteLocs(Collection col) { - return actOnLocs(col, BreakpointActionSet::planDelete, lb -> { - // Never delete bookmark when user requests deleting locations - }); + return actOnLocs(col, + BreakpointActionSet::planDeleteTarget, + BreakpointActionSet::planDeleteEmu, + lb -> { + // Never delete bookmark when user requests deleting locations + }); } @Override @@ -1266,21 +1383,23 @@ public class DebuggerLogicalBreakpointServicePlugin extends Plugin @Override public void processEvent(PluginEvent event) { - if (event instanceof ProgramOpenedPluginEvent) { - ProgramOpenedPluginEvent openedEvt = (ProgramOpenedPluginEvent) event; - programOpened(openedEvt.getProgram()); + if (event instanceof ProgramOpenedPluginEvent evt) { + programOpened(evt.getProgram()); } - else if (event instanceof ProgramClosedPluginEvent) { - ProgramClosedPluginEvent closedEvt = (ProgramClosedPluginEvent) event; - programClosed(closedEvt.getProgram()); + else if (event instanceof ProgramClosedPluginEvent evt) { + programClosed(evt.getProgram()); } - else if (event instanceof TraceOpenedPluginEvent) { - TraceOpenedPluginEvent openedEvt = (TraceOpenedPluginEvent) event; - traceOpened(openedEvt.getTrace()); + else if (event instanceof TraceOpenedPluginEvent evt) { + traceOpened(evt.getTrace()); } - else if (event instanceof TraceClosedPluginEvent) { - TraceClosedPluginEvent closedEvt = (TraceClosedPluginEvent) event; - traceClosed(closedEvt.getTrace()); + else if (event instanceof TraceActivatedPluginEvent evt) { + traceSnapChanged(evt.getActiveCoordinates()); + } + else if (event instanceof TraceInactiveCoordinatesPluginEvent evt) { + traceSnapChanged(evt.getCoordinates()); + } + else if (event instanceof TraceClosedPluginEvent evt) { + traceClosed(evt.getTrace()); } } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteEmuBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteEmuBreakpointActionItem.java new file mode 100644 index 0000000000..731ff4927b --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteEmuBreakpointActionItem.java @@ -0,0 +1,39 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.concurrent.CompletableFuture; + +import ghidra.async.AsyncUtils; +import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.util.database.UndoableTransaction; + +public record DeleteEmuBreakpointActionItem(TraceBreakpoint bpt) implements BreakpointActionItem { + @Override + public CompletableFuture execute() { + try (UndoableTransaction tid = + UndoableTransaction.start(bpt.getTrace(), "Delete Emulated Breakpoint")) { + String emuName = PlaceEmuBreakpointActionItem.createName(bpt.getMinAddress()); + if (bpt.getPath().contains(emuName)) { + bpt.delete(); + } + else { + bpt.setEmuEnabled(false); + } + } + return AsyncUtils.NIL; + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteTargetBreakpointActionItem.java similarity index 57% rename from Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteBreakpointActionItem.java rename to Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteTargetBreakpointActionItem.java index c725b4dd61..1a8e6ae2a9 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteBreakpointActionItem.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DeleteTargetBreakpointActionItem.java @@ -15,35 +15,12 @@ */ package ghidra.app.plugin.core.debug.service.breakpoint; -import java.util.Objects; import java.util.concurrent.CompletableFuture; import ghidra.dbg.target.TargetDeletable; -public class DeleteBreakpointActionItem implements BreakpointActionItem { - private final TargetDeletable deletable; - - public DeleteBreakpointActionItem(TargetDeletable deletable) { - this.deletable = deletable; - } - - @Override - public boolean equals(Object obj) { - if (!(obj instanceof DeleteBreakpointActionItem)) { - return false; - } - DeleteBreakpointActionItem that = (DeleteBreakpointActionItem) obj; - if (this.deletable != that.deletable) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash(getClass(), deletable); - } - +public record DeleteTargetBreakpointActionItem(TargetDeletable deletable) + implements BreakpointActionItem { @Override public CompletableFuture execute() { return deletable.delete(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableEmuBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableEmuBreakpointActionItem.java new file mode 100644 index 0000000000..672138f009 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableEmuBreakpointActionItem.java @@ -0,0 +1,34 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.concurrent.CompletableFuture; + +import ghidra.async.AsyncUtils; +import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.util.database.UndoableTransaction; + +public record DisableEmuBreakpointActionItem(TraceBreakpoint bpt) + implements BreakpointActionItem { + @Override + public CompletableFuture execute() { + try (UndoableTransaction tid = + UndoableTransaction.start(bpt.getTrace(), "Disable Emulated Breakpoint")) { + bpt.setEmuEnabled(false); + } + return AsyncUtils.NIL; + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableTargetBreakpointActionItem.java similarity index 57% rename from Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableBreakpointActionItem.java rename to Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableTargetBreakpointActionItem.java index 1936302739..69d2ca4363 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableBreakpointActionItem.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/DisableTargetBreakpointActionItem.java @@ -15,35 +15,12 @@ */ package ghidra.app.plugin.core.debug.service.breakpoint; -import java.util.Objects; import java.util.concurrent.CompletableFuture; import ghidra.dbg.target.TargetTogglable; -public class DisableBreakpointActionItem implements BreakpointActionItem { - private final TargetTogglable togglable; - - public DisableBreakpointActionItem(TargetTogglable togglable) { - this.togglable = togglable; - } - - @Override - public boolean equals(Object obj) { - if (!(obj instanceof DisableBreakpointActionItem)) { - return false; - } - DisableBreakpointActionItem that = (DisableBreakpointActionItem) obj; - if (this.togglable != that.togglable) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash(getClass(), togglable); - } - +public record DisableTargetBreakpointActionItem(TargetTogglable togglable) + implements BreakpointActionItem { @Override public CompletableFuture execute() { return togglable.disable(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableEmuBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableEmuBreakpointActionItem.java new file mode 100644 index 0000000000..2e830276c6 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableEmuBreakpointActionItem.java @@ -0,0 +1,33 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.concurrent.CompletableFuture; + +import ghidra.async.AsyncUtils; +import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.util.database.UndoableTransaction; + +public record EnableEmuBreakpointActionItem(TraceBreakpoint bpt) implements BreakpointActionItem { + @Override + public CompletableFuture execute() { + try (UndoableTransaction tid = + UndoableTransaction.start(bpt.getTrace(), "Enable Emulated Breakpoint")) { + bpt.setEmuEnabled(true); + } + return AsyncUtils.NIL; + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableTargetBreakpointActionItem.java similarity index 57% rename from Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableBreakpointActionItem.java rename to Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableTargetBreakpointActionItem.java index c175235b6b..8138a885da 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableBreakpointActionItem.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/EnableTargetBreakpointActionItem.java @@ -15,35 +15,12 @@ */ package ghidra.app.plugin.core.debug.service.breakpoint; -import java.util.Objects; import java.util.concurrent.CompletableFuture; import ghidra.dbg.target.TargetTogglable; -public class EnableBreakpointActionItem implements BreakpointActionItem { - private final TargetTogglable togglable; - - public EnableBreakpointActionItem(TargetTogglable togglable) { - this.togglable = togglable; - } - - @Override - public boolean equals(Object obj) { - if (!(obj instanceof EnableBreakpointActionItem)) { - return false; - } - EnableBreakpointActionItem that = (EnableBreakpointActionItem) obj; - if (this.togglable != that.togglable) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash(getClass(), togglable); - } - +public record EnableTargetBreakpointActionItem(TargetTogglable togglable) + implements BreakpointActionItem { @Override public CompletableFuture execute() { return togglable.enable(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LogicalBreakpointInternal.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LogicalBreakpointInternal.java index 9984273f3c..121288fcef 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LogicalBreakpointInternal.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LogicalBreakpointInternal.java @@ -15,427 +15,23 @@ */ package ghidra.app.plugin.core.debug.service.breakpoint; -import java.util.*; - -import com.google.common.collect.Collections2; - import ghidra.app.services.LogicalBreakpoint; import ghidra.app.services.TraceRecorder; -import ghidra.dbg.target.*; -import ghidra.dbg.target.TargetBreakpointSpec.TargetBreakpointKind; -import ghidra.program.model.address.*; +import ghidra.program.model.address.Address; import ghidra.program.model.listing.*; -import ghidra.program.util.ProgramLocation; import ghidra.trace.model.Trace; import ghidra.trace.model.breakpoint.TraceBreakpoint; -import ghidra.trace.model.breakpoint.TraceBreakpointKind; -import ghidra.trace.model.breakpoint.TraceBreakpointKind.TraceBreakpointKindSet; -import ghidra.util.Msg; -import ghidra.util.database.UndoableTransaction; -import ghidra.util.exception.CancelledException; -import ghidra.util.task.TaskMonitor; -import utilities.util.IDHashed; public interface LogicalBreakpointInternal extends LogicalBreakpoint { - public static class ProgramBreakpoint { - public static Set kindsFromBookmark(Bookmark mark) { - String[] parts = mark.getCategory().split(";"); - Set result = TraceBreakpointKindSet.decode(parts[0], false); - if (result.isEmpty()) { - Msg.warn(TraceBreakpointKind.class, - "Decoded empty set of kinds from bookmark. Assuming SW_EXECUTE"); - return Set.of(TraceBreakpointKind.SW_EXECUTE); - } - return result; - } - - public static long lengthFromBookmark(Bookmark mark) { - String[] parts = mark.getCategory().split(";"); - if (parts.length < 2) { - Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, - "No length for bookmark breakpoint. Assuming 1."); - return 1; - } - try { - long length = Long.parseLong(parts[1]); - if (length <= 0) { - Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, - "Non-positive length for bookmark breakpoint? Using 1."); - return 1; - } - return length; - } - catch (NumberFormatException e) { - Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, - "Ill-formatted bookmark breakpoint length: " + e + ". Using 1."); - return 1; - } - } - - private final Program program; - private final Address address; - private final ProgramLocation location; - private final long length; - private final Set kinds; - - private Bookmark eBookmark; // when present - private Bookmark dBookmark; // when present - - public ProgramBreakpoint(Program program, Address address, long length, - Set kinds) { - this.program = program; - this.address = address; - this.location = new ProgramLocation(program, address); - this.length = length; - this.kinds = kinds; - } - - @Override - public String toString() { - // volatile reads - Bookmark eBookmark = this.eBookmark; - Bookmark dBookmark = this.dBookmark; - if (eBookmark != null) { - return String.format("", eBookmark.getTypeString(), - eBookmark.getCategory(), eBookmark.getAddress(), program.getName()); - } - else if (dBookmark != null) { - return String.format("", dBookmark.getTypeString(), - dBookmark.getCategory(), dBookmark.getAddress(), program.getName()); - } - else { - return String.format("", address, program.getName()); - } - } - - public ProgramLocation getLocation() { - return location; - } - - public String getName() { - // TODO: Be prepared to use JSON or something, if more fields are needed - Bookmark bookmark = getBookmark(); - if (bookmark == null) { - return ""; - } - return bookmark.getComment(); - } - - public void setName(String name) { - Bookmark bookmark = getBookmark(); - if (bookmark == null) { - throw new IllegalStateException("Must save breakpoint to program before naming it"); - } - try (UndoableTransaction tid = - UndoableTransaction.start(program, "Rename breakpoint")) { - bookmark.set(bookmark.getCategory(), name); - } - } - - public ProgramMode computeMode() { - if (eBookmark != null) { - return ProgramMode.ENABLED; - } - if (dBookmark != null) { - return ProgramMode.DISABLED; - } - else { - return ProgramMode.MISSING; - } - } - - public boolean isEmpty() { - return eBookmark == null && dBookmark == null; - } - - public void deleteFromProgram() { - // volatile reads - Bookmark eBookmark = this.eBookmark; - Bookmark dBookmark = this.dBookmark; - try (UndoableTransaction tid = UndoableTransaction.start(program, "Clear breakpoint")) { - BookmarkManager bookmarkManager = program.getBookmarkManager(); - if (eBookmark != null) { - bookmarkManager.removeBookmark(eBookmark); - } - if (dBookmark != null) { - bookmarkManager.removeBookmark(dBookmark); - } - // (e,d)Bookmark Gets nulled on program change callback - // If null here, logical breakpoint manager will get confused - } - } - - public boolean canMerge(Program candProgram, Bookmark candBookmark) { - if (program != candProgram) { - return false; - } - if (!address.equals(candBookmark.getAddress())) { - return false; - } - if (length != lengthFromBookmark(candBookmark)) { - return false; - } - if (!Objects.equals(kinds, kindsFromBookmark(candBookmark))) { - return false; - } - return true; - } - - public Program getProgram() { - return program; - } - - public boolean add(Bookmark bookmark) { - if (BREAKPOINT_ENABLED_BOOKMARK_TYPE.equals(bookmark.getTypeString())) { - if (eBookmark == bookmark) { - return false; - } - eBookmark = bookmark; - return true; - } - if (BREAKPOINT_DISABLED_BOOKMARK_TYPE.equals(bookmark.getTypeString())) { - if (dBookmark == bookmark) { - return false; - } - dBookmark = bookmark; - return true; - } - return false; - } - - public boolean remove(Bookmark bookmark) { - if (eBookmark == bookmark) { - eBookmark = null; - return true; - } - if (dBookmark == bookmark) { - dBookmark = null; - return true; - } - return false; - } - - public Bookmark getBookmark() { - Bookmark eBookmark = this.eBookmark; - if (eBookmark != null) { - return eBookmark; - } - return dBookmark; - } - - protected String getComment() { - Bookmark bookmark = getBookmark(); - return bookmark == null ? "" : bookmark.getComment(); - } - - public boolean isEnabled() { - return computeMode() == ProgramMode.ENABLED; - } - - public boolean isDisabled() { - return computeMode() == ProgramMode.DISABLED; - } - - public String computeCategory() { - return TraceBreakpointKindSet.encode(kinds) + ";" + Long.toUnsignedString(length); - } - - public void toggleWithComment(boolean enabled, String comment) { - String addType = - enabled ? BREAKPOINT_ENABLED_BOOKMARK_TYPE : BREAKPOINT_DISABLED_BOOKMARK_TYPE; - String delType = - enabled ? BREAKPOINT_DISABLED_BOOKMARK_TYPE : BREAKPOINT_ENABLED_BOOKMARK_TYPE; - try (UndoableTransaction tid = - UndoableTransaction.start(program, "Enable breakpoint")) { - BookmarkManager manager = program.getBookmarkManager(); - String catStr = computeCategory(); - manager.setBookmark(address, addType, catStr, comment); - manager.removeBookmarks(new AddressSet(address), delType, catStr, - TaskMonitor.DUMMY); - } - catch (CancelledException e) { - throw new AssertionError(e); - } - } - - public void enable() { - if (isEnabled()) { - return; - } - toggleWithComment(true, getComment()); - } - - public void disable() { - if (isDisabled()) { - return; - } - toggleWithComment(false, getComment()); - } - } - - static class TraceBreakpointSet { - private final TraceRecorder recorder; - private final Trace trace; - private final Address address; - private Set> breakpoints = new HashSet<>(); - - public TraceBreakpointSet(TraceRecorder recorder, Address address) { - this.recorder = recorder; - this.trace = recorder.getTrace(); - this.address = address; - } - - @Override - public String toString() { - return String.format("", address, trace.getName(), breakpoints); - } - - public Trace getTrace() { - return trace; - } - - public Address getAddress() { - return address; - } - - public Address computeTargetAddress() { - return recorder.getMemoryMapper().traceToTarget(address); - } - - public TraceMode computeMode() { - TraceMode mode = TraceMode.NONE; - for (IDHashed bpt : breakpoints) { - mode = mode.combine(computeMode(bpt.obj)); - if (mode == TraceMode.MISSING) { - return mode; - } - } - return mode; - } - - public TraceMode computeMode(TraceBreakpoint bpt) { - return TraceMode.fromBool(bpt.isEnabled(recorder.getSnap())); - } - - public boolean isEmpty() { - return breakpoints.isEmpty(); - } - - public Collection getBreakpoints() { - return Collections2.transform(breakpoints, e -> e.obj); - } - - public boolean add(TraceBreakpoint bpt) { - return breakpoints.add(new IDHashed<>(bpt)); - } - - public boolean canMerge(TraceBreakpoint bpt) { - if (trace != bpt.getTrace()) { - return false; - } - if (!address.equals(bpt.getMinAddress())) { - return false; - } - return true; - } - - public boolean remove(TraceBreakpoint bpt) { - return breakpoints.remove(new IDHashed<>(bpt)); - } - - /** - * Plan to enable a logical breakpoint within the trace. - * - *

    - * This method prefers to use the existing breakpoint specifications which result in - * breakpoints at this address. In other words, it favors what the user has already done to - * effect a breakpoint at this logical breakpoint's address. If there is no such existing - * specification, then it attempts to place a new breakpoint via the target's breakpoint - * container, usually resulting in a new spec, which should effect exactly the one specified - * address. - * - *

    - * This method must convert applicable addresses to the target space. If the address cannot - * be mapped, it's usually because this logical breakpoint does not apply to the given - * trace's target. E.g., the trace may not have a live target, or the logical breakpoint may - * be in a module not loaded by the trace. - * - * @param actions the action set to populate - * @param kind the kind of breakpoint - * @return a future which completes when the plan is ready - */ - public void planEnable(BreakpointActionSet actions, long length, - Collection kinds) { - if (breakpoints.isEmpty()) { - Set tKinds = - TraceRecorder.traceToTargetBreakpointKinds(kinds); - - for (TargetBreakpointSpecContainer cont : recorder - .collectBreakpointContainers(null)) { - LinkedHashSet supKinds = new LinkedHashSet<>(tKinds); - supKinds.retainAll(cont.getSupportedBreakpointKinds()); - actions.add(new PlaceBreakpointActionItem(cont, computeTargetAddress(), length, - supKinds)); - } - return; - } - for (IDHashed bpt : breakpoints) { - TargetBreakpointLocation loc = recorder.getTargetBreakpoint(bpt.obj); - if (loc == null) { - continue; - } - actions.planEnable(loc); - } - } - - public void planDisable(BreakpointActionSet actions, long length, - Collection kinds) { - Set tKinds = TraceRecorder.traceToTargetBreakpointKinds(kinds); - Address targetAddr = computeTargetAddress(); - for (TargetBreakpointLocation loc : recorder.collectBreakpoints(null)) { - AddressRange range = loc.getRange(); - if (!targetAddr.equals(range.getMinAddress())) { - continue; - } - if (length != range.getLength()) { - continue; - } - TargetBreakpointSpec spec = loc.getSpecification(); - if (!Objects.equals(spec.getKinds(), tKinds)) { - continue; - } - actions.planDisable(loc); - } - } - - public void planDelete(BreakpointActionSet actions, long length, - Set kinds) { - Set tKinds = TraceRecorder.traceToTargetBreakpointKinds(kinds); - Address targetAddr = computeTargetAddress(); - for (TargetBreakpointLocation loc : recorder.collectBreakpoints(null)) { - AddressRange range = loc.getRange(); - if (!targetAddr.equals(range.getMinAddress())) { - continue; - } - if (length != range.getLength()) { - continue; - } - TargetBreakpointSpec spec = loc.getSpecification(); - if (!Objects.equals(spec.getKinds(), tKinds)) { - continue; - } - actions.planDelete(loc); - } - } - } - /** * Set the expected address for trace breakpoints in the given trace * - * @param recorder the recorder for the given trace + * @param trace the trace * @param address the address of this logical breakpoint in the given trace */ - void setTraceAddress(TraceRecorder recorder, Address address); + void setTraceAddress(Trace trace, Address address); + + void setRecorder(Trace trace, TraceRecorder recorder); /** * Remove the given trace from this set diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LoneLogicalBreakpoint.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LoneLogicalBreakpoint.java index 9b7be1ca93..47ae1a0dd4 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LoneLogicalBreakpoint.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/LoneLogicalBreakpoint.java @@ -21,6 +21,7 @@ import java.util.concurrent.CompletableFuture; import ghidra.app.services.TraceRecorder; import ghidra.async.AsyncUtils; import ghidra.framework.model.DomainObject; +import ghidra.framework.plugintool.PluginTool; import ghidra.program.model.address.Address; import ghidra.program.model.listing.Bookmark; import ghidra.program.model.listing.Program; @@ -35,13 +36,13 @@ public class LoneLogicalBreakpoint implements LogicalBreakpointInternal { private final long length; private final Set kinds; - public LoneLogicalBreakpoint(TraceRecorder recorder, Address address, long length, + public LoneLogicalBreakpoint(PluginTool tool, Trace trace, Address address, long length, Collection kinds) { - this.breaks = new TraceBreakpointSet(recorder, address); + this.breaks = new TraceBreakpointSet(tool, trace, address); this.length = length; this.kinds = Set.copyOf(kinds); - this.justThisTrace = Set.of(recorder.getTrace()); + this.justThisTrace = Set.of(trace); } @Override @@ -85,10 +86,25 @@ public class LoneLogicalBreakpoint implements LogicalBreakpointInternal { } @Override - public void setTraceAddress(TraceRecorder recorder, Address address) { + public String getEmuSleigh() { + return breaks.computeSleigh(); + } + + @Override + public void setEmuSleigh(String sleigh) { + breaks.setEmuSleigh(sleigh); + } + + @Override + public void setTraceAddress(Trace trace, Address address) { throw new AssertionError(); } + @Override + public void setRecorder(Trace trace, TraceRecorder recorder) { + breaks.setRecorder(recorder); + } + @Override public void removeTrace(Trace trace) { throw new AssertionError(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/MappedLogicalBreakpoint.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/MappedLogicalBreakpoint.java index 94b2cc3d4f..1a009898c6 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/MappedLogicalBreakpoint.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/MappedLogicalBreakpoint.java @@ -22,6 +22,8 @@ import ghidra.app.services.DebuggerModelService; import ghidra.app.services.TraceRecorder; import ghidra.async.AsyncUtils; import ghidra.framework.model.DomainObject; +import ghidra.framework.plugintool.PluginTool; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.Address; import ghidra.program.model.listing.Bookmark; import ghidra.program.model.listing.Program; @@ -32,6 +34,7 @@ import ghidra.trace.model.breakpoint.TraceBreakpointKind; public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { + private final PluginTool tool; private final Set kinds; private final long length; @@ -41,10 +44,13 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { // They may have different names and/or different conditions private final Map traceBreaks = new HashMap<>(); - protected MappedLogicalBreakpoint(Program program, Address progAddr, long length, + protected MappedLogicalBreakpoint(PluginTool tool, Program program, Address progAddr, + long length, Collection kinds) { - this.length = length; + this.tool = tool; this.kinds = Set.copyOf(kinds); + this.length = length; + this.progBreak = new ProgramBreakpoint(program, progAddr, length, this.kinds); } @@ -83,26 +89,20 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { return recorder; } - /** - * TODO: How best to allow the user to control behavior when a new static mapping is created - * that could generate new breakpoints in the target. Options: - * - * 1) A toggle during mapping creation for how to sync breakpoints. - * - * 2) A prompt when the mapping is created, asking the user to sync breakpoints. - * - * 3) A UI indicator (probably in the breakpoints provider) that some breakpoints are not in - * sync. Different actions for directions of sync. - * - * I'm thinking both 1 and 3. Option 2 is probably too abrasive, esp., if several mappings are - * created at once. - */ - @Override public void enableForProgram() { progBreak.enable(); } + /** + * Place the program's bookmark with a comment specifying a desired name + * + *

    + * WARNING: Use only when this breakpoint was just placed, otherwise, this will reset + * other extrinsic properties, such as the sleigh injection. + * + * @param name the desired name + */ public void enableForProgramWithName(String name) { progBreak.toggleWithComment(true, name); } @@ -194,21 +194,20 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { @Override public String generateStatusEnable(Trace trace) { + // NB. It'll place a breakpoint if mappable but not present if (trace == null) { - for (TraceBreakpointSet breaks : traceBreaks.values()) { - if (!breaks.isEmpty()) { - return null; - } + if (!traceBreaks.values().isEmpty()) { + return null; } - return "A breakpoint is not mapped to any live trace. Cannot enable it on target. " + + return "A breakpoint is not mapped to any trace. Cannot enable it. " + "Is there a target? Check your module map."; } TraceBreakpointSet breaks = traceBreaks.get(trace); - if (breaks != null && !breaks.isEmpty()) { + if (breaks != null) { return null; } - return "A breakpoint is not mapped to the trace, or the trace is not live. " + - "Cannot enable it on target. Is there a target? Check your module map."; + return "A breakpoint is not mapped to the trace. " + + "Cannot enable it. Is there a target? Check your module map."; } @Override @@ -296,9 +295,18 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { } @Override - public void setTraceAddress(TraceRecorder recorder, Address address) { + public void setTraceAddress(Trace trace, Address address) { synchronized (traceBreaks) { - traceBreaks.put(recorder.getTrace(), new TraceBreakpointSet(recorder, address)); + TraceBreakpointSet newSet = new TraceBreakpointSet(tool, trace, address); + newSet.setEmuSleigh(progBreak.getEmuSleigh()); + traceBreaks.put(trace, newSet); + } + } + + @Override + public void setRecorder(Trace trace, TraceRecorder recorder) { + synchronized (traceBreaks) { + traceBreaks.get(trace).setRecorder(recorder); } } @@ -440,6 +448,39 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { return progMode.combineTrace(traceMode, Perspective.LOGICAL); } + protected String computeTraceSleigh() { + String sleigh = null; + synchronized (traceBreaks) { + for (TraceBreakpointSet breaks : traceBreaks.values()) { + String s = breaks.computeSleigh(); + if (sleigh != null && !sleigh.equals(s)) { + return null; + } + sleigh = s; + } + return sleigh; + } + } + + @Override + public String getEmuSleigh() { + return progBreak.getEmuSleigh(); + } + + protected void setTraceBreakEmuSleigh(String sleigh) { + synchronized (traceBreaks) { + for (TraceBreakpointSet breaks : traceBreaks.values()) { + breaks.setEmuSleigh(sleigh); + } + } + } + + @Override + public void setEmuSleigh(String sleigh) { + progBreak.setEmuSleigh(sleigh); + setTraceBreakEmuSleigh(sleigh); + } + @Override public boolean canMerge(Program program, Bookmark bookmark) { return progBreak.canMerge(program, bookmark); @@ -473,10 +514,21 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { @Override public boolean trackBreakpoint(Bookmark bookmark) { - return progBreak.add(bookmark); + if (progBreak.add(bookmark)) { + String sleigh = progBreak.getEmuSleigh(); + if (sleigh != null && !SleighUtils.UNCONDITIONAL_BREAK.equals(sleigh)) { + setEmuSleigh(sleigh); + } + return true; + } + return false; } protected void makeBookmarkConsistent() { + // NB. Apparently it is specified that the bookmark should be created automatically + /*if (progBreak.isEmpty()) { + return; + }*/ TraceMode traceMode = computeTraceMode(); if (traceMode == TraceMode.ENABLED) { progBreak.enable(); @@ -493,6 +545,15 @@ public class MappedLogicalBreakpoint implements LogicalBreakpointInternal { breaks = traceBreaks.get(breakpoint.getTrace()); } boolean result = breaks.add(breakpoint); + if (result) { + String traceSleigh = computeTraceSleigh(); + if (traceSleigh != null && !SleighUtils.UNCONDITIONAL_BREAK.equals(traceSleigh)) { + String progSleigh = progBreak.getEmuSleigh(); + if (progSleigh == null || SleighUtils.UNCONDITIONAL_BREAK.equals(progSleigh)) { + progBreak.setEmuSleigh(traceSleigh); + } + } + } makeBookmarkConsistent(); return result; } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceBreakpointActionItem.java deleted file mode 100644 index 76c2c9962b..0000000000 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceBreakpointActionItem.java +++ /dev/null @@ -1,73 +0,0 @@ -/* ### - * IP: GHIDRA - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package ghidra.app.plugin.core.debug.service.breakpoint; - -import java.util.*; -import java.util.concurrent.CompletableFuture; - -import ghidra.dbg.target.TargetBreakpointSpecContainer; -import ghidra.dbg.target.TargetBreakpointSpec.TargetBreakpointKind; -import ghidra.program.model.address.*; - -public class PlaceBreakpointActionItem implements BreakpointActionItem { - private final TargetBreakpointSpecContainer container; - private final Address address; - private final long length; - private final Set kinds; - - public PlaceBreakpointActionItem(TargetBreakpointSpecContainer container, Address address, - long length, Collection kinds) { - this.container = Objects.requireNonNull(container); - this.address = Objects.requireNonNull(address); - this.length = length; - this.kinds = Set.copyOf(kinds); - } - - @Override - public boolean equals(Object obj) { - if (!(obj instanceof PlaceBreakpointActionItem)) { - return false; - } - PlaceBreakpointActionItem that = (PlaceBreakpointActionItem) obj; - if (this.container != that.container) { - return false; - } - if (!this.address.equals(that.address)) { - return false; - } - if (!Objects.equals(this.kinds, that.kinds)) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash(getClass(), container, address, kinds); - } - - @Override - public CompletableFuture execute() { - AddressRange range; - try { - range = new AddressRangeImpl(address, length); - } - catch (AddressOverflowException e) { - throw new AssertionError(e); - } - return container.placeBreakpoint(range, kinds); - } -} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceEmuBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceEmuBreakpointActionItem.java new file mode 100644 index 0000000000..f7e0d5b92a --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceEmuBreakpointActionItem.java @@ -0,0 +1,114 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +import ghidra.async.AsyncUtils; +import ghidra.dbg.target.TargetBreakpointSpec; +import ghidra.dbg.target.TargetBreakpointSpecContainer; +import ghidra.dbg.util.PathMatcher; +import ghidra.program.model.address.*; +import ghidra.trace.model.Lifespan; +import ghidra.trace.model.Trace; +import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.trace.model.breakpoint.TraceBreakpointKind; +import ghidra.trace.model.memory.TraceMemoryRegion; +import ghidra.trace.model.memory.TraceObjectMemoryRegion; +import ghidra.trace.model.target.TraceObject; +import ghidra.util.database.UndoableTransaction; +import ghidra.util.exception.DuplicateNameException; + +public record PlaceEmuBreakpointActionItem(Trace trace, long snap, Address address, long length, + Set kinds, String emuSleigh) implements BreakpointActionItem { + + public static String createName(Address address) { + return "emu-" + address; + } + + public PlaceEmuBreakpointActionItem(Trace trace, long snap, Address address, long length, + Set kinds, String emuSleigh) { + this.trace = trace; + this.snap = snap; + this.address = address; + this.length = length; + this.kinds = Set.copyOf(kinds); + this.emuSleigh = emuSleigh; + } + + private TraceObjectMemoryRegion findRegion() { + TraceMemoryRegion region = trace.getMemoryManager().getRegionContaining(snap, address); + if (region != null) { + return (TraceObjectMemoryRegion) region; + } + AddressSpace space = address.getAddressSpace(); + Collection regionsInSpace = trace.getMemoryManager() + .getRegionsIntersecting(Lifespan.at(snap), + new AddressRangeImpl(space.getMinAddress(), space.getMaxAddress())); + if (!regionsInSpace.isEmpty()) { + return (TraceObjectMemoryRegion) regionsInSpace.iterator().next(); + } + return null; + } + + private TraceObject findBreakpointContainer() { + TraceObjectMemoryRegion region = findRegion(); + if (region == null) { + throw new IllegalArgumentException("Address does not belong to a memory in the trace"); + } + return region.getObject().querySuitableTargetInterface(TargetBreakpointSpecContainer.class); + } + + private String computePath() { + String name = createName(address); + if (Trace.isLegacy(trace)) { + return "Breakpoints[" + name + "]"; + } + TraceObject container = findBreakpointContainer(); + if (container == null) { + throw new IllegalArgumentException( + "Address is not associated with a breakpoint container"); + } + PathMatcher specMatcher = + container.getTargetSchema().searchFor(TargetBreakpointSpec.class, true); + if (specMatcher == null) { + throw new IllegalArgumentException("Cannot find path to breakpoint specifications"); + } + List relPath = specMatcher.applyKeys(name).getSingletonPath(); + if (relPath == null) { + throw new IllegalArgumentException("Too many wildcards to breakpoint specification"); + } + return container.getCanonicalPath().extend(relPath).toString(); + } + + @Override + public CompletableFuture execute() { + try (UndoableTransaction tid = + UndoableTransaction.start(trace, "Place Emulated Breakpoint")) { + // Defaults with emuEnable=true + TraceBreakpoint bpt = trace.getBreakpointManager() + .addBreakpoint(computePath(), Lifespan.at(snap), range(address, length), + Set.of(), kinds, false, null); + bpt.setName(createName(address)); + bpt.setEmuSleigh(emuSleigh); + return AsyncUtils.NIL; + } + catch (DuplicateNameException e) { + throw new AssertionError(e); + } + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceTargetBreakpointActionItem.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceTargetBreakpointActionItem.java new file mode 100644 index 0000000000..d17406f773 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/PlaceTargetBreakpointActionItem.java @@ -0,0 +1,41 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.*; +import java.util.concurrent.CompletableFuture; + +import ghidra.dbg.target.TargetBreakpointSpecContainer; +import ghidra.dbg.target.TargetBreakpointSpec.TargetBreakpointKind; +import ghidra.program.model.address.*; + +public record PlaceTargetBreakpointActionItem(TargetBreakpointSpecContainer container, + Address address, long length, Set kinds) + implements BreakpointActionItem { + + public PlaceTargetBreakpointActionItem(TargetBreakpointSpecContainer container, Address address, + long length, Set kinds) { + this.container = container; + this.address = address; + this.length = length; + this.kinds = Set.copyOf(kinds); + } + + @Override + public CompletableFuture execute() { + return container.placeBreakpoint(range(address, length), kinds); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/ProgramBreakpoint.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/ProgramBreakpoint.java new file mode 100644 index 0000000000..6655789ddd --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/ProgramBreakpoint.java @@ -0,0 +1,496 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.*; + +import com.google.gson.*; + +import ghidra.app.services.LogicalBreakpoint.ProgramMode; +import ghidra.program.model.address.Address; +import ghidra.program.model.address.AddressSet; +import ghidra.program.model.listing.*; +import ghidra.program.util.ProgramLocation; +import ghidra.trace.model.breakpoint.TraceBreakpointKind; +import ghidra.trace.model.breakpoint.TraceBreakpointKind.TraceBreakpointKindSet; +import ghidra.util.Msg; +import ghidra.util.database.UndoableTransaction; +import ghidra.util.exception.CancelledException; +import ghidra.util.task.TaskMonitor; + +/** + * The static side of a mapped logical breakpoint + * + *

    + * Programs don't have a built-in concept of breakpoints, so we store them as breakpoints with a + * specific type for each state. We also encode other intrinsic properties (length and kinds) to the + * category. Extrinsic properties (name and sleigh) are encoded in the comment. Because traces are + * fairly ephemeral, the program bookmarks are the primary means a user has to save and manage a + * breakpoint set. + */ +public class ProgramBreakpoint { + private static final Gson GSON = new GsonBuilder().create(); + + /** + * A class for (de)serializing breakoint properties in the bookmark's comments + */ + static class BreakpointProperties { + public String name; + public String sleigh; + + public BreakpointProperties(String name, String sleigh) { + this.name = name; + this.sleigh = sleigh; + } + } + + /** + * Get the kinds of a breakpoint from its bookmark + * + * @param mark the bookmark representing a breakpoint + * @return the kinds + */ + public static Set kindsFromBookmark(Bookmark mark) { + String[] parts = mark.getCategory().split(";"); + Set result = TraceBreakpointKindSet.decode(parts[0], false); + if (result.isEmpty()) { + Msg.warn(TraceBreakpointKind.class, + "Decoded empty set of kinds from bookmark. Assuming SW_EXECUTE"); + return Set.of(TraceBreakpointKind.SW_EXECUTE); + } + return result; + } + + /** + * Get the length of a breakpoint from its bookmark + * + * @param mark the bookmark representing a breakpoint + * @return the length in bytes + */ + public static long lengthFromBookmark(Bookmark mark) { + String[] parts = mark.getCategory().split(";"); + if (parts.length < 2) { + Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, + "No length for bookmark breakpoint. Assuming 1."); + return 1; + } + try { + long length = Long.parseLong(parts[1]); + if (length <= 0) { + Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, + "Non-positive length for bookmark breakpoint? Using 1."); + return 1; + } + return length; + } + catch (NumberFormatException e) { + Msg.warn(DebuggerLogicalBreakpointServicePlugin.class, + "Ill-formatted bookmark breakpoint length: " + e + ". Using 1."); + return 1; + } + } + + private final Program program; + private final Address address; + private final ProgramLocation location; + private final long length; + private final Set kinds; + + private Bookmark eBookmark; // when present + private Bookmark dBookmark; // when present + + private String name; + private String sleigh; + + /** + * Construct a program breakpoint + * + * @param program the program + * @param address the static address of the breakpoint (even if a bookmark is not present there) + * @param length the length of the breakpoint in bytes + * @param kinds the kinds of the breakpoint + */ + public ProgramBreakpoint(Program program, Address address, long length, + Set kinds) { + this.program = program; + this.address = address; + this.location = new ProgramLocation(program, address); + this.length = length; + this.kinds = kinds; + } + + @Override + public String toString() { + // volatile reads + Bookmark eBookmark = this.eBookmark; + Bookmark dBookmark = this.dBookmark; + if (eBookmark != null) { + return String.format("", eBookmark.getTypeString(), + eBookmark.getCategory(), eBookmark.getAddress(), program.getName()); + } + else if (dBookmark != null) { + return String.format("", dBookmark.getTypeString(), + dBookmark.getCategory(), dBookmark.getAddress(), program.getName()); + } + else { + return String.format("", address, program.getName()); + } + } + + /** + * Get the breakpoint's static program location + * + * @return the location + */ + public ProgramLocation getLocation() { + return location; + } + + private void syncProperties(Bookmark bookmark) { + if (bookmark == null) { + name = ""; + sleigh = null; + return; + } + String comment = bookmark.getComment(); + if (comment == null || !comment.startsWith("{")) { + // Backward compatibility. + name = comment; + sleigh = null; + return; + } + try { + BreakpointProperties props = GSON.fromJson(comment, BreakpointProperties.class); + name = props.name; + sleigh = props.sleigh; + return; + } + catch (JsonSyntaxException e) { + Msg.error(this, "Could not parse breakpoint bookmark properties", e); + name = ""; + sleigh = null; + return; + } + } + + private String computeComment() { + if ((name == null || "".equals(name)) && (sleigh == null || "".equals(sleigh))) { + return null; + } + return GSON.toJson(new BreakpointProperties(name, sleigh)); + } + + private void writeProperties(Bookmark bookmark) { + try (UndoableTransaction tid = + UndoableTransaction.start(program, "Rename breakpoint")) { + bookmark.set(bookmark.getCategory(), computeComment()); + } + catch (ConcurrentModificationException e) { + /** + * Can happen during breakpoint deletion. Doesn't seem like there's a good way to check. + * In any case, we need to keep processing events, so log and continue. + */ + Msg.error(this, "Could not update breakpoint properties: " + e); + } + } + + /** + * Get the user-defined name of the breakpoint + * + * @return the name + */ + public String getName() { + return name; + } + + /** + * Set the name of the breakpoint + * + * @param name the name + */ + public void setName(String name) { + Bookmark bookmark = getBookmark(); + if (bookmark == null) { + throw new IllegalStateException("Must save breakpoint to program before naming it"); + } + this.name = name; + writeProperties(bookmark); + } + + /** + * Get the sleigh injection for this breakpoint + * + * @return the sleigh injection + */ + public String getEmuSleigh() { + return sleigh; + } + + /*** + * Set the sleigh injection for this breakpoint + * + * @param sleigh the sleigh injection + */ + public void setEmuSleigh(String sleigh) { + this.sleigh = sleigh; + Bookmark bookmark = getBookmark(); + if (bookmark == null) { + return; + } + writeProperties(bookmark); + } + + /** + * Compute the mode of this breakpoint + * + *

    + * In order to ensure at least the saved state (enablement) can be rendered in the marker margin + * in the absence of the breakpoint marker plugin, we use one type of bookmark for disabled + * breakpoints, and another for enabled breakpoints. As the state is changing, it's possible for + * a brief moment that both bookmarks are present. We thus have a variable for each bookmark and + * prefer the "enabled" state. We can determine are state by examining which variable is + * non-null. If both are null, the breakpoint is not actually saved to the program, yet. We + * cannot return {@link ProgramMode#NONE}, because that would imply there is no static location. + * + * @return the state + */ + public ProgramMode computeMode() { + if (eBookmark != null) { + return ProgramMode.ENABLED; + } + if (dBookmark != null) { + return ProgramMode.DISABLED; + } + return ProgramMode.MISSING; + } + + /** + * Check if either bookmark is present + * + * @return true if both are absent, false if either or both is present + */ + public boolean isEmpty() { + return eBookmark == null && dBookmark == null; + } + + /** + * Remove the bookmark + * + *

    + * Note this does not necessarily destroy the breakpoint, since it may still exist in one or + * more traces. + */ + public void deleteFromProgram() { + // volatile reads + Bookmark eBookmark = this.eBookmark; + Bookmark dBookmark = this.dBookmark; + try (UndoableTransaction tid = UndoableTransaction.start(program, "Clear breakpoint")) { + BookmarkManager bookmarkManager = program.getBookmarkManager(); + if (eBookmark != null) { + bookmarkManager.removeBookmark(eBookmark); + } + if (dBookmark != null) { + bookmarkManager.removeBookmark(dBookmark); + } + // (e,d)Bookmark Gets nulled on program change callback + // If null here, logical breakpoint manager will get confused + } + } + + /** + * Check if the given bookmark can fill the static side of this breakpoint + * + * @param candProgram the program containing the bookmark + * @param candBookmark the bookmark + * @return true if the bookmark can represent this breakpoint, false otherwise + */ + public boolean canMerge(Program candProgram, Bookmark candBookmark) { + if (program != candProgram) { + return false; + } + if (!address.equals(candBookmark.getAddress())) { + return false; + } + if (length != lengthFromBookmark(candBookmark)) { + return false; + } + if (!Objects.equals(kinds, kindsFromBookmark(candBookmark))) { + return false; + } + return true; + } + + /** + * Get the program where this breakpoint is located + * + * @return the program + */ + public Program getProgram() { + return program; + } + + /** + * Fill the static side of this breakpoint with the given bookmark + * + *

    + * The caller should first use {@link #canMerge(Program, Bookmark)} to ensure the bookmark can + * actually represent this breakpoint. + * + * @param bookmark the bookmark + * @return true if this changed the breakpoint state + */ + public boolean add(Bookmark bookmark) { + if (LogicalBreakpointInternal.BREAKPOINT_ENABLED_BOOKMARK_TYPE + .equals(bookmark.getTypeString())) { + if (eBookmark == bookmark) { + return false; + } + eBookmark = bookmark; + syncProperties(bookmark); + return true; + } + if (LogicalBreakpointInternal.BREAKPOINT_DISABLED_BOOKMARK_TYPE + .equals(bookmark.getTypeString())) { + if (dBookmark == bookmark) { + return false; + } + dBookmark = bookmark; + syncProperties(bookmark); + return true; + } + return false; + } + + /** + * Remove a bookmark from the static side of this breakpoint + * + * @param bookmark the bookmark + * @return true if this changed the breakpoint state + */ + public boolean remove(Bookmark bookmark) { + if (eBookmark == bookmark) { + eBookmark = null; + return true; + } + if (dBookmark == bookmark) { + dBookmark = null; + return true; + } + return false; + } + + /** + * Get the bookmark representing this breakpoint, if present + * + * @return the bookmark or null + */ + public Bookmark getBookmark() { + Bookmark eBookmark = this.eBookmark; + if (eBookmark != null) { + return eBookmark; + } + return dBookmark; + } + + protected String getComment() { + Bookmark bookmark = getBookmark(); + return bookmark == null ? computeComment() : bookmark.getComment(); + } + + /** + * Check if the bookmark represents an enabled breakpoint + * + * @return true if enabled, false if anything else + */ + public boolean isEnabled() { + return computeMode() == ProgramMode.ENABLED; + } + + /** + * Check if the bookmark represents a disabled breakpoint + * + * @return true if disabled, false if anything else + */ + public boolean isDisabled() { + return computeMode() == ProgramMode.DISABLED; + } + + /** + * Compute the category for a new bookmark representing this breakpoint + * + * @return the category + */ + public String computeCategory() { + return TraceBreakpointKindSet.encode(kinds) + ";" + Long.toUnsignedString(length); + } + + /** + * Change the state of this breakpoint by manipulating bookmarks + * + *

    + * If the breakpoint is already in the desired state, no change is made. Otherwise, this will + * delete the existing bookmark, if present, and create a new bookmark whose type indicates the + * desired state. Thus, some event processing may need to take place before this breakpoint's + * state is actually updated accordingly. + * + * @param enabled the desired state, true for {@link ProgramMode#ENABLED}, false for + * {@link ProgramMode#DISABLED}. + * @param comment the comment to give the breakpoint, almost always from {@link #getComment()}. + */ + public void toggleWithComment(boolean enabled, String comment) { + String addType = + enabled ? LogicalBreakpointInternal.BREAKPOINT_ENABLED_BOOKMARK_TYPE + : LogicalBreakpointInternal.BREAKPOINT_DISABLED_BOOKMARK_TYPE; + String delType = + enabled ? LogicalBreakpointInternal.BREAKPOINT_DISABLED_BOOKMARK_TYPE + : LogicalBreakpointInternal.BREAKPOINT_ENABLED_BOOKMARK_TYPE; + try (UndoableTransaction tid = + UndoableTransaction.start(program, "Enable breakpoint")) { + BookmarkManager manager = program.getBookmarkManager(); + String catStr = computeCategory(); + manager.setBookmark(address, addType, catStr, comment); + manager.removeBookmarks(new AddressSet(address), delType, catStr, + TaskMonitor.DUMMY); + } + catch (CancelledException e) { + throw new AssertionError(e); + } + } + + /** + * Enable this breakpoint + * + * @see #toggleWithComment(boolean, String) + */ + public void enable() { + if (isEnabled()) { + return; + } + toggleWithComment(true, getComment()); + } + + /** + * Disable this breakpoint + * + * @see #toggleWithComment(boolean, String) + */ + public void disable() { + if (isDisabled()) { + return; + } + toggleWithComment(false, getComment()); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/TraceBreakpointSet.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/TraceBreakpointSet.java new file mode 100644 index 0000000000..f25cb18f8a --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/breakpoint/TraceBreakpointSet.java @@ -0,0 +1,463 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.plugin.core.debug.service.breakpoint; + +import java.util.*; + +import com.google.common.collect.Collections2; + +import ghidra.app.services.*; +import ghidra.app.services.LogicalBreakpoint.TraceMode; +import ghidra.dbg.target.*; +import ghidra.dbg.target.TargetBreakpointSpec.TargetBreakpointKind; +import ghidra.framework.plugintool.PluginTool; +import ghidra.pcode.exec.SleighUtils; +import ghidra.program.model.address.Address; +import ghidra.program.model.address.AddressRange; +import ghidra.trace.model.Trace; +import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.trace.model.breakpoint.TraceBreakpointKind; +import ghidra.util.database.UndoableTransaction; +import utilities.util.IDHashed; + +/** + * The trace side of a logical breakpoint + * + *

    + * If the logical breakpoint is a mapped, it will have one of these sets for each trace where the + * breakpoint has (or could have) a location. For a lone logical breakpoint, it will have just one + * of these for the one trace where its located. + */ +class TraceBreakpointSet { + private final PluginTool tool; + private final Trace trace; + private final Address address; + + private final Set> breakpoints = new HashSet<>(); + + private TraceRecorder recorder; + private String emuSleigh; + + /** + * Create a set of breakpoint locations for a given trace + * + * @param tool the plugin tool for the UI + * @param trace the trace whose locations this set collects + * @param address the dynamic address where the breakpoint is (or would be) located + */ + public TraceBreakpointSet(PluginTool tool, Trace trace, Address address) { + this.tool = Objects.requireNonNull(tool); + this.trace = Objects.requireNonNull(trace); + this.address = Objects.requireNonNull(address); + } + + @Override + public String toString() { + return String.format("", address, trace.getName(), breakpoints); + } + + /** + * Set the recorder when the trace is associated to a live target + * + * @param recorder the recorder + */ + public void setRecorder(TraceRecorder recorder) { + this.recorder = recorder; + } + + private StateEditingMode getStateEditingMode() { + DebuggerStateEditingService service = tool.getService(DebuggerStateEditingService.class); + return service == null ? StateEditingMode.DEFAULT : service.getCurrentMode(trace); + } + + private long getSnap() { + /** + * TODO: Not exactly ideal.... It'd be nice to have it passed in, but that's infecting a lot + * of methods and putting a burden on the caller, when in most cases, it's going to be the + * "current snap" anyway. + */ + DebuggerTraceManagerService service = tool.getService(DebuggerTraceManagerService.class); + if (service == null) { + return trace.getProgramView().getViewport().getReversedSnaps().get(0); + } + return service.getCurrentFor(trace).getSnap(); + } + + /** + * Get the trace + * + * @return + */ + public Trace getTrace() { + return trace; + } + + /** + * Get the dynamic address where the breakpoint is (or would be) located in this trace + * + * @return the dynamic address + */ + public Address getAddress() { + return address; + } + + /** + * If there is a live target, get the dynamic address in the target's space + * + * @return the dynamic address on target + */ + public Address computeTargetAddress() { + if (recorder == null) { + throw new AssertionError(); + } + return recorder.getMemoryMapper().traceToTarget(address); + } + + /** + * Compute the mode (enablement) of this set + * + *

    + * In most cases, there is 0 or 1 trace breakpoints that "fit" the logical breakpoint. The mode + * is derived from one of {@link TraceBreakpoint#isEnabled(long)} or + * {@link TraceBreakpoint#isEmuEnabled(long)}, depending on the UI's control mode for this + * trace. + * + * @return the mode + */ + public TraceMode computeMode() { + TraceMode mode = TraceMode.NONE; + if (getStateEditingMode().useEmulatedBreakpoints()) { + for (IDHashed bpt : breakpoints) { + mode = mode.combine(computeEmuMode(bpt.obj)); + if (mode == TraceMode.MISSING) { + return mode; + } + } + return mode; + } + for (IDHashed bpt : breakpoints) { + mode = mode.combine(computeTargetMode(bpt.obj)); + if (mode == TraceMode.MISSING) { + return mode; + } + } + return mode; + } + + /** + * Compute the mode (enablement) of the given breakpoint + * + *

    + * The mode is derived from one of {@link TraceBreakpoint#isEnabled(long)} or + * {@link TraceBreakpoint#isEmuEnabled(long)}, depending on the UI's control mode for this + * trace. + * + * @param bpt the breakpoint + * @return the mode + */ + public TraceMode computeMode(TraceBreakpoint bpt) { + return getStateEditingMode().useEmulatedBreakpoints() + ? computeEmuMode(bpt) + : computeTargetMode(bpt); + } + + /** + * Compute the mode of the given breakpoint for the target + * + * @param bpt the breakpoint + * @return the mode + */ + public TraceMode computeTargetMode(TraceBreakpoint bpt) { + return TraceMode.fromBool(bpt.isEnabled(getSnap())); + } + + /** + * Compute the mode of the given breakpoint for the emulator + * + * @param bpt the breakpoint + * @return the mode + */ + public TraceMode computeEmuMode(TraceBreakpoint bpt) { + return TraceMode.fromBool(bpt.isEmuEnabled(getSnap())); + } + + /** + * If all breakpoints agree on sleigh injection, get that injection + * + * @return the injection, or null if there's disagreement. + */ + public String computeSleigh() { + String sleigh = null; + for (IDHashed bpt : breakpoints) { + String s = bpt.obj.getEmuSleigh(); + if (sleigh != null && !sleigh.equals(s)) { + return null; + } + sleigh = s; + } + return sleigh; + } + + /** + * Set the sleigh injection for all breakpoints in this set + * + * @param emuSleigh the sleigh injection + */ + public void setEmuSleigh(String emuSleigh) { + this.emuSleigh = emuSleigh; + try (UndoableTransaction tid = UndoableTransaction.start(trace, "Set breakpoint Sleigh")) { + for (IDHashed bpt : breakpoints) { + bpt.obj.setEmuSleigh(emuSleigh); + } + } + } + + /** + * Check if this set actually contains any trace breakpoints + * + * @return true if empty, false otherwise + */ + public boolean isEmpty() { + return breakpoints.isEmpty(); + } + + /** + * Get the breakpoints in this set + * + * @return the breakpoints + */ + public Collection getBreakpoints() { + return Collections2.transform(breakpoints, e -> e.obj); + } + + /** + * Add a breakpoint to this set + * + *

    + * The caller should first call {@link #canMerge(TraceBreakpoint)} to check if the breakpoint + * "fits." + * + * @param bpt + * @return true if the set actually changed as a result + */ + public boolean add(TraceBreakpoint bpt) { + if (SleighUtils.UNCONDITIONAL_BREAK.equals(bpt.getEmuSleigh()) && emuSleigh != null) { + try (UndoableTransaction tid = + UndoableTransaction.start(trace, "Set breakpoint Sleigh")) { + bpt.setEmuSleigh(emuSleigh); + } + } + return breakpoints.add(new IDHashed<>(bpt)); + } + + /** + * Check if the given trace breakpoint "fits" in this set + * + *

    + * The breakpoint fits if it's dynamic location matches that expected in this set + * + * @param bpt the breakpoint + * @return true if it fits + */ + public boolean canMerge(TraceBreakpoint bpt) { + if (trace != bpt.getTrace()) { + return false; + } + if (!address.equals(bpt.getMinAddress())) { + return false; + } + return true; + } + + /** + * Remove a breakpoint from this set + * + * @param bpt the breakpoint + * @return true if the set actually changes as a result + */ + public boolean remove(TraceBreakpoint bpt) { + return breakpoints.remove(new IDHashed<>(bpt)); + } + + /** + * Plan to enable the logical breakpoint within this trace + * + *

    + * This method prefers to use the existing breakpoint specifications which result in breakpoints + * at this address. In other words, it favors what the user has already done to effect a + * breakpoint at this logical breakpoint's address. If there is no such existing specification, + * then it attempts to place a new breakpoint via the target's breakpoint container, usually + * resulting in a new spec, which should effect exactly the one specified address. If the + * control mode indicates emulated breakpoints, then this simply writes the breakpoint to the + * trace database. + * + *

    + * This method may convert applicable addresses to the target space. If the address cannot be + * mapped, it's usually because this logical breakpoint does not apply to the given trace's + * target. E.g., the trace may not have a live target, or the logical breakpoint may be in a + * module not loaded by the trace. + * + * @param actions the action set to populate + * @param length the length in bytes of the breakpoint + * @param kinds the kinds of breakpoint + */ + public void planEnable(BreakpointActionSet actions, long length, + Collection kinds) { + long snap = getSnap(); + if (breakpoints.isEmpty()) { + if (recorder == null || getStateEditingMode().useEmulatedBreakpoints()) { + planPlaceEmu(actions, snap, length, kinds); + } + else { + planPlaceTarget(actions, snap, length, kinds); + } + } + else { + if (recorder == null || getStateEditingMode().useEmulatedBreakpoints()) { + planEnableEmu(actions); + } + else { + planEnableTarget(actions); + } + } + } + + private void planPlaceTarget(BreakpointActionSet actions, long snap, long length, + Collection kinds) { + if (snap != recorder.getSnap()) { + throw new AssertionError("Target breakpoints must be requested at present snap"); + } + Set tKinds = + TraceRecorder.traceToTargetBreakpointKinds(kinds); + + for (TargetBreakpointSpecContainer cont : recorder + .collectBreakpointContainers(null)) { + LinkedHashSet supKinds = new LinkedHashSet<>(tKinds); + supKinds.retainAll(cont.getSupportedBreakpointKinds()); + actions.add(new PlaceTargetBreakpointActionItem(cont, computeTargetAddress(), + length, supKinds)); + } + } + + private void planPlaceEmu(BreakpointActionSet actions, long snap, long length, + Collection kinds) { + actions.add( + new PlaceEmuBreakpointActionItem(trace, snap, address, length, Set.copyOf(kinds), + emuSleigh)); + } + + private void planEnableTarget(BreakpointActionSet actions) { + for (IDHashed bpt : breakpoints) { + TargetBreakpointLocation loc = recorder.getTargetBreakpoint(bpt.obj); + if (loc == null) { + continue; + } + actions.planEnableTarget(loc); + } + } + + private void planEnableEmu(BreakpointActionSet actions) { + for (IDHashed bpt : breakpoints) { + actions.planEnableEmu(bpt.obj); + } + } + + /** + * Plan to disable the logical breakpoint in this trace + * + * @param actions the action set to populate + * @param length the length in bytes of the breakpoint + * @param kinds the kinds of breakpoint + */ + public void planDisable(BreakpointActionSet actions, long length, + Collection kinds) { + if (getStateEditingMode().useEmulatedBreakpoints()) { + planDisableEmu(actions); + } + else { + planDisableTarget(actions, length, kinds); + } + } + + private void planDisableTarget(BreakpointActionSet actions, long length, + Collection kinds) { + Set tKinds = TraceRecorder.traceToTargetBreakpointKinds(kinds); + Address targetAddr = computeTargetAddress(); + for (TargetBreakpointLocation loc : recorder.collectBreakpoints(null)) { + AddressRange range = loc.getRange(); + if (!targetAddr.equals(range.getMinAddress())) { + continue; + } + if (length != range.getLength()) { + continue; + } + TargetBreakpointSpec spec = loc.getSpecification(); + if (!Objects.equals(spec.getKinds(), tKinds)) { + continue; + } + actions.planDisableTarget(loc); + } + } + + private void planDisableEmu(BreakpointActionSet actions) { + for (IDHashed bpt : breakpoints) { + actions.planDisableEmu(bpt.obj); + } + } + + /** + * Plan to delete the logical breakpoint in this trace + * + * @param actions the action set to populate + * @param length the length in bytes of the breakpoint + * @param kinds the kinds of breakpoint + */ + public void planDelete(BreakpointActionSet actions, long length, + Set kinds) { + if (getStateEditingMode().useEmulatedBreakpoints()) { + planDeleteEmu(actions); + } + else { + planDeleteTarget(actions, length, kinds); + } + } + + private void planDeleteTarget(BreakpointActionSet actions, long length, + Set kinds) { + Set tKinds = TraceRecorder.traceToTargetBreakpointKinds(kinds); + Address targetAddr = computeTargetAddress(); + for (TargetBreakpointLocation loc : recorder.collectBreakpoints(null)) { + AddressRange range = loc.getRange(); + if (!targetAddr.equals(range.getMinAddress())) { + continue; + } + if (length != range.getLength()) { + continue; + } + TargetBreakpointSpec spec = loc.getSpecification(); + if (!Objects.equals(spec.getKinds(), tKinds)) { + continue; + } + actions.planDeleteTarget(loc); + } + } + + private void planDeleteEmu(BreakpointActionSet actions) { + for (IDHashed bpt : breakpoints) { + actions.planDeleteEmu(bpt.obj); + } + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServicePlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServicePlugin.java index 6477158de8..a270db4c80 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServicePlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServicePlugin.java @@ -21,32 +21,19 @@ import java.util.concurrent.*; import ghidra.app.plugin.PluginCategoryNames; import ghidra.app.plugin.core.debug.*; -import ghidra.app.plugin.core.debug.event.TraceClosedPluginEvent; -import ghidra.app.plugin.core.debug.event.TraceOpenedPluginEvent; +import ghidra.app.plugin.core.debug.event.*; import ghidra.app.services.*; -import ghidra.async.AsyncUtils; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; import ghidra.framework.plugintool.util.PluginStatus; import ghidra.program.model.address.Address; -import ghidra.program.model.address.AddressRange; -import ghidra.program.model.lang.Language; -import ghidra.program.model.lang.Register; import ghidra.program.model.mem.*; import ghidra.trace.model.Trace; import ghidra.trace.model.Trace.TraceProgramViewListener; -import ghidra.trace.model.guest.TracePlatform; -import ghidra.trace.model.memory.TraceMemoryOperations; -import ghidra.trace.model.memory.TraceMemorySpace; -import ghidra.trace.model.program.*; -import ghidra.trace.model.thread.TraceThread; -import ghidra.trace.model.time.schedule.PatchStep; -import ghidra.trace.model.time.schedule.TraceSchedule; -import ghidra.trace.util.TraceRegisterUtils; -import ghidra.util.database.UndoableTransaction; +import ghidra.trace.model.program.TraceProgramView; +import ghidra.trace.model.program.TraceProgramViewMemory; import ghidra.util.datastruct.ListenerSet; -import ghidra.util.exception.CancelledException; -import ghidra.util.task.TaskMonitor; @PluginInfo( shortDescription = "Debugger machine-state editing service plugin", @@ -56,6 +43,7 @@ import ghidra.util.task.TaskMonitor; status = PluginStatus.RELEASED, eventsConsumed = { TraceOpenedPluginEvent.class, + TraceActivatedPluginEvent.class, TraceClosedPluginEvent.class, }, servicesRequired = { @@ -73,158 +61,14 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin public boolean isVariableEditable(Address address, int length) { DebuggerCoordinates coordinates = getCoordinates(); Trace trace = coordinates.getTrace(); - - switch (getCurrentMode(trace)) { - case READ_ONLY: - return false; - case WRITE_TARGET: - return isTargetVariableEditable(coordinates, address, length); - case WRITE_TRACE: - return isTraceVariableEditable(coordinates, address, length); - case WRITE_EMULATOR: - return isEmulatorVariableEditable(coordinates, address, length); - } - throw new AssertionError(); - } - - protected boolean isTargetVariableEditable(DebuggerCoordinates coordinates, Address address, - int length) { - if (!coordinates.isAliveAndPresent()) { - return false; - } - TraceRecorder recorder = coordinates.getRecorder(); - return recorder.isVariableOnTarget(coordinates.getPlatform(), coordinates.getThread(), - coordinates.getFrame(), address, length); - } - - protected boolean isTraceVariableEditable(DebuggerCoordinates coordinates, Address address, - int length) { - return address.isMemoryAddress() || coordinates.getThread() != null; - } - - protected boolean isEmulatorVariableEditable(DebuggerCoordinates coordinates, - Address address, int length) { - if (coordinates.getThread() == null) { - // A limitation in TraceSchedule, which is used to manifest patches - return false; - } - if (!isTraceVariableEditable(coordinates, address, length)) { - return false; - } - // TODO: Limitation from using Sleigh for patching - Register ctxReg = coordinates.getTrace().getBaseLanguage().getContextBaseRegister(); - if (ctxReg == Register.NO_CONTEXT) { - return true; - } - AddressRange ctxRange = TraceRegisterUtils.rangeForRegister(ctxReg); - if (ctxRange.contains(address)) { - return false; - } - return true; + return getCurrentMode(trace).isVariableEditable(coordinates, address, length); } @Override public CompletableFuture setVariable(Address address, byte[] data) { DebuggerCoordinates coordinates = getCoordinates(); Trace trace = coordinates.getTrace(); - - StateEditingMode mode = getCurrentMode(trace); - switch (mode) { - case READ_ONLY: - return CompletableFuture - .failedFuture(new MemoryAccessException("Read-only mode")); - case WRITE_TARGET: - return writeTargetVariable(coordinates, address, data); - case WRITE_TRACE: - return writeTraceVariable(coordinates, address, data); - case WRITE_EMULATOR: - return writeEmulatorVariable(coordinates, address, data); - } - throw new AssertionError(); - } - - protected CompletableFuture writeTargetVariable(DebuggerCoordinates coordinates, - Address address, byte[] data) { - TraceRecorder recorder = coordinates.getRecorder(); - if (recorder == null) { - return CompletableFuture - .failedFuture(new MemoryAccessException("Trace has no live target")); - } - if (!coordinates.isPresent()) { - return CompletableFuture - .failedFuture(new MemoryAccessException("View is not the present")); - } - return recorder.writeVariable(coordinates.getPlatform(), coordinates.getThread(), - coordinates.getFrame(), address, data); - } - - protected CompletableFuture writeTraceVariable(DebuggerCoordinates coordinates, - Address guestAddress, byte[] data) { - Trace trace = coordinates.getTrace(); - TracePlatform platform = coordinates.getPlatform(); - long snap = coordinates.getViewSnap(); - Address hostAddress = platform.mapGuestToHost(guestAddress); - if (hostAddress == null) { - throw new IllegalArgumentException( - "Guest address " + guestAddress + " is not mapped"); - } - TraceMemoryOperations memOrRegs; - Address overlayAddress; - try (UndoableTransaction txid = - UndoableTransaction.start(trace, "Edit Variable")) { - if (hostAddress.isRegisterAddress()) { - TraceThread thread = coordinates.getThread(); - if (thread == null) { - throw new IllegalArgumentException("Register edits require a thread."); - } - TraceMemorySpace regs = trace.getMemoryManager() - .getMemoryRegisterSpace(thread, coordinates.getFrame(), - true); - memOrRegs = regs; - overlayAddress = regs.getAddressSpace().getOverlayAddress(hostAddress); - } - else { - memOrRegs = trace.getMemoryManager(); - overlayAddress = hostAddress; - } - if (memOrRegs.putBytes(snap, overlayAddress, - ByteBuffer.wrap(data)) != data.length) { - return CompletableFuture.failedFuture(new MemoryAccessException()); - } - } - return AsyncUtils.NIL; - } - - protected CompletableFuture writeEmulatorVariable(DebuggerCoordinates coordinates, - Address address, byte[] data) { - if (!(coordinates.getView() instanceof TraceVariableSnapProgramView)) { - throw new IllegalArgumentException("Cannot emulate using a Fixed Program View"); - } - TraceThread thread = coordinates.getThread(); - if (thread == null) { - // TODO: Well, technically, only for register edits - // It's a limitation in TraceSchedule. Every step requires a thread - throw new IllegalArgumentException("Emulator edits require a thread."); - } - Language language = coordinates.getPlatform().getLanguage(); - TraceSchedule time = coordinates.getTime() - .patched(thread, language, PatchStep.generateSleigh(language, address, data)); - - DebuggerCoordinates withTime = coordinates.time(time); - Long found = traceManager.findSnapshot(withTime); - // Materialize it on the same thread (even if swing) - // It shouldn't take long, since we're only appending one step. - if (found == null) { - // TODO: Could still do it async on another thread, no? - // Not sure it buys anything, since program view will call .get on swing thread - try { - emulationSerivce.emulate(coordinates.getPlatform(), time, TaskMonitor.DUMMY); - } - catch (CancelledException e) { - throw new AssertionError(e); - } - } - return traceManager.activateAndNotify(withTime, false); + return getCurrentMode(trace).setVariable(tool, coordinates, address, data); } } @@ -356,10 +200,6 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin //@AutoServiceConsumed // via method private DebuggerTraceManagerService traceManager; - @AutoServiceConsumed - private DebuggerEmulationService emulationSerivce; - @AutoServiceConsumed - private DebuggerModelService modelService; protected final ListenerForEditorInstallation listenerForEditorInstallation = new ListenerForEditorInstallation(); @@ -368,8 +208,6 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin super(tool); } - private static final StateEditingMode DEFAULT_MODE = StateEditingMode.WRITE_TARGET; - private final Map currentModes = new HashMap<>(); private final ListenerSet listeners = @@ -378,23 +216,23 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin @Override public StateEditingMode getCurrentMode(Trace trace) { synchronized (currentModes) { - return currentModes.getOrDefault(Objects.requireNonNull(trace), DEFAULT_MODE); + return currentModes.getOrDefault(Objects.requireNonNull(trace), + StateEditingMode.DEFAULT); } } @Override - public void setCurrentMode(Trace trace, StateEditingMode mode) { - boolean fire = false; + public void setCurrentMode(Trace trace, StateEditingMode newMode) { + StateEditingMode oldMode; synchronized (currentModes) { - StateEditingMode old = - currentModes.getOrDefault(Objects.requireNonNull(trace), DEFAULT_MODE); - if (mode != old) { - currentModes.put(trace, mode); - fire = true; + oldMode = + currentModes.getOrDefault(Objects.requireNonNull(trace), StateEditingMode.DEFAULT); + if (newMode != oldMode) { + currentModes.put(trace, newMode); } } - if (fire) { - listeners.fire.modeChanged(trace, mode); + if (newMode != oldMode) { + listeners.fire.modeChanged(trace, newMode); tool.contextChanged(null); } } @@ -424,6 +262,29 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin return new FollowsViewStateEditor(view); } + protected void coordinatesActivated(DebuggerCoordinates coordinates, ActivationCause cause) { + if (cause != ActivationCause.USER) { + return; + } + Trace trace = coordinates.getTrace(); + if (trace == null) { + return; + } + StateEditingMode oldMode; + StateEditingMode newMode; + synchronized (currentModes) { + oldMode = currentModes.getOrDefault(trace, StateEditingMode.DEFAULT); + newMode = oldMode.modeOnChange(coordinates); + if (newMode != oldMode) { + currentModes.put(trace, newMode); + } + } + if (newMode != oldMode) { + listeners.fire.modeChanged(trace, newMode); + tool.contextChanged(null); + } + } + protected void installMemoryEditor(TraceProgramView view) { TraceProgramViewMemory memory = view.getMemory(); if (memory.getLiveMemoryHandler() != null) { @@ -481,13 +342,14 @@ public class DebuggerStateEditingServicePlugin extends AbstractDebuggerPlugin @Override public void processEvent(PluginEvent event) { super.processEvent(event); - if (event instanceof TraceOpenedPluginEvent) { - TraceOpenedPluginEvent ev = (TraceOpenedPluginEvent) event; - installAllMemoryEditors(ev.getTrace()); + if (event instanceof TraceOpenedPluginEvent evt) { + installAllMemoryEditors(evt.getTrace()); } - else if (event instanceof TraceClosedPluginEvent) { - TraceClosedPluginEvent ev = (TraceClosedPluginEvent) event; - uninstallAllMemoryEditors(ev.getTrace()); + else if (event instanceof TraceActivatedPluginEvent evt) { + coordinatesActivated(evt.getActiveCoordinates(), evt.getCause()); + } + else if (event instanceof TraceClosedPluginEvent evt) { + uninstallAllMemoryEditors(evt.getTrace()); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServicePlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServicePlugin.java index a6ee33ed06..7008c30e85 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServicePlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServicePlugin.java @@ -41,7 +41,8 @@ import ghidra.async.AsyncLazyMap; import ghidra.framework.plugintool.*; import ghidra.framework.plugintool.annotation.AutoServiceConsumed; import ghidra.framework.plugintool.util.PluginStatus; -import ghidra.pcode.emu.PcodeMachine.AccessKind; +import ghidra.pcode.emu.PcodeMachine.*; +import ghidra.pcode.exec.InjectionErrorPcodeExecutionException; import ghidra.program.model.address.*; import ghidra.program.model.listing.Program; import ghidra.program.util.ProgramLocation; @@ -191,7 +192,12 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm @Override protected EmulationResult compute(TaskMonitor monitor) throws CancelledException { - return doRun(from, monitor, scheduler); + EmulationResult result = doRun(from, monitor, scheduler); + if (result.error() instanceof InjectionErrorPcodeExecutionException) { + Msg.showError(this, null, "Breakpoint Emulation Error", + "Compilation error in user-provided breakpoint Sleigh code."); + } + return result; } } @@ -260,6 +266,8 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm private DebuggerPlatformService platformService; @AutoServiceConsumed private DebuggerStaticMappingService staticMappings; + @AutoServiceConsumed + private DebuggerStateEditingService editingService; @SuppressWarnings("unused") private AutoService.Wiring autoServiceWiring; @@ -359,6 +367,9 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm trace = ProgramEmulationUtils.launchEmulationTrace(program, ctx.getAddress(), this); traceManager.openTrace(trace); traceManager.activateTrace(trace); + if (editingService != null) { + editingService.setCurrentMode(trace, StateEditingMode.RW_EMULATOR); + } } catch (IOException e) { Msg.showError(this, null, actionEmulateProgram.getDescription(), @@ -544,7 +555,7 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm for (AddressSpace as : trace.getBaseAddressFactory().getAddressSpaces()) { for (TraceBreakpoint bpt : bm.getBreakpointsIntersecting(span, new AddressRangeImpl(as.getMinAddress(), as.getMaxAddress()))) { - if (!bpt.isEnabled(snap)) { + if (!bpt.isEmuEnabled(snap)) { continue; } Set kinds = bpt.getKinds(); @@ -554,7 +565,14 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm boolean isRead = kinds.contains(TraceBreakpointKind.READ); boolean isWrite = kinds.contains(TraceBreakpointKind.WRITE); if (isExecute) { - emu.addBreakpoint(bpt.getMinAddress(), "1:1"); + try { + emu.inject(bpt.getMinAddress(), bpt.getEmuSleigh()); + } + catch (Exception e) { // This is a bit broad... + Msg.error(this, + "Error compiling breakpoint Sleigh at " + bpt.getMinAddress(), e); + emu.inject(bpt.getMinAddress(), "emu_injection_err();"); + } } if (isRead && isWrite) { emu.addAccessBreakpoint(bpt.getRange(), AccessKind.RW); @@ -592,6 +610,7 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm emu.clearAllInjects(); emu.clearAccessBreakpoints(); emu.setSuspended(false); + installBreakpoints(key.trace, key.time.getSnap(), be.ce.emulator()); monitor.initialize(time.totalTickCount() - prevKey.time.totalTickCount()); createRegisterSpaces(trace, time, monitor); @@ -603,6 +622,7 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm DebuggerPcodeMachine emu = emulatorFactory.create(tool, platform, time.getSnap(), modelService == null ? null : modelService.getRecorder(trace)); try (BusyEmu be = new BusyEmu(new CachedEmulator(key.trace, emu))) { + installBreakpoints(key.trace, key.time.getSnap(), be.ce.emulator()); monitor.initialize(time.totalTickCount()); createRegisterSpaces(trace, time, monitor); monitor.setMessage("Emulating"); @@ -627,7 +647,15 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm protected TraceSnapshot writeToScratch(CacheKey key, CachedEmulator ce) { try (UndoableTransaction tid = UndoableTransaction.start(key.trace, "Emulate")) { TraceSnapshot destSnap = findScratch(key.trace, key.time); - ce.emulator().writeDown(key.platform, destSnap.getKey(), key.time.getSnap()); + try { + ce.emulator().writeDown(key.platform, destSnap.getKey(), key.time.getSnap()); + } + catch (Throwable e) { + Msg.showError(this, null, "Emulate", + "There was an issue writing the emulation result to trace trace. " + + "The displayed state may be inaccurate and/or incomplete.", + e); + } return destSnap; } } @@ -643,10 +671,11 @@ public class DebuggerEmulationServicePlugin extends Plugin implements DebuggerEm protected EmulationResult doRun(CacheKey key, TaskMonitor monitor, Scheduler scheduler) throws CancelledException { try (BusyEmu be = doEmulateFromCached(key, monitor)) { - installBreakpoints(key.trace, key.time.getSnap(), be.ce.emulator()); TraceThread eventThread = key.time.getEventThread(key.trace); + be.ce.emulator().setSoftwareInterruptMode(SwiMode.IGNORE_STEP); RunResult result = scheduler.run(key.trace, eventThread, be.ce.emulator(), monitor); key = new CacheKey(key.platform, key.time.advanced(result.schedule())); + Msg.info(this, "Stopped emulation at " + key.time); TraceSnapshot destSnap = writeToScratch(key, be.ce); cacheEmulator(key, be.ce); return new RecordEmulationResult(key.time, destSnap.getKey(), result.error()); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/ProgramEmulationUtils.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/ProgramEmulationUtils.java index bc9b811203..cb0903a0c9 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/ProgramEmulationUtils.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/emulation/ProgramEmulationUtils.java @@ -23,6 +23,9 @@ import java.util.stream.Stream; import ghidra.app.plugin.core.debug.service.modules.DebuggerStaticMappingUtils; import ghidra.app.services.DebuggerEmulationService; +import ghidra.dbg.target.*; +import ghidra.dbg.target.schema.TargetObjectSchema; +import ghidra.dbg.util.*; import ghidra.framework.model.DomainFile; import ghidra.program.model.address.*; import ghidra.program.model.lang.*; @@ -34,8 +37,9 @@ import ghidra.trace.database.DBTrace; import ghidra.trace.model.*; import ghidra.trace.model.memory.*; import ghidra.trace.model.modules.TraceConflictedMappingException; -import ghidra.trace.model.thread.TraceThread; -import ghidra.trace.model.thread.TraceThreadManager; +import ghidra.trace.model.target.TraceObject; +import ghidra.trace.model.target.TraceObjectKeyPath; +import ghidra.trace.model.thread.*; import ghidra.trace.model.time.TraceSnapshot; import ghidra.util.*; import ghidra.util.database.UndoableTransaction; @@ -137,10 +141,11 @@ public enum ProgramEmulationUtils { * A transaction must already be started on the destination trace. * * @param snapshot the destination snapshot, usually 0 - * @param program the progam to load + * @param program the program to load */ public static void loadExecutable(TraceSnapshot snapshot, Program program) { Trace trace = snapshot.getTrace(); + PathPattern patRegion = computePatternRegion(trace); Map extremaBySpace = new HashMap<>(); try { for (MemoryBlock block : program.getMemory().getBlocks()) { @@ -156,8 +161,9 @@ public enum ProgramEmulationUtils { String modName = getModuleName(program); // TODO: Do I populate modules, since the mapping will already be done? - String path = "Modules[" + modName + "].Sections[" + block.getName() + "-" + - block.getStart() + "]"; + String path = PathUtils.toString(patRegion + .applyKeys(block.getStart() + "-" + modName + ":" + block.getName()) + .getSingletonPath()); trace.getMemoryManager() .createRegion(path, snapshot.getKey(), range, getRegionFlags(block)); } @@ -176,6 +182,28 @@ public enum ProgramEmulationUtils { // N.B. Bytes will be loaded lazily } + public static PathPattern computePattern(Trace trace, Class iface) { + TargetObjectSchema root = trace.getObjectManager().getRootSchema(); + if (root == null) { + return new PathPattern(PathUtils.parse("Memory[]")); + } + PathMatcher matcher = root.searchFor(iface, true); + PathPattern pattern = matcher.getSingletonPattern(); + if (pattern == null || pattern.countWildcards() != 1) { + throw new IllegalArgumentException( + "Cannot find unique " + iface.getSimpleName() + " container"); + } + return pattern; + } + + public static PathPattern computePatternRegion(Trace trace) { + return computePattern(trace, TargetMemoryRegion.class); + } + + public static PathPattern computePatternThread(Trace trace) { + return computePattern(trace, TargetThread.class); + } + /** * Spawn a new thread in the given trace at the given creation snap * @@ -188,12 +216,16 @@ public enum ProgramEmulationUtils { */ public static TraceThread spawnThread(Trace trace, long snap) { TraceThreadManager tm = trace.getThreadManager(); + PathPattern patThread = computePatternThread(trace); long next = tm.getAllThreads().size(); - while (!tm.getThreadsByPath("Threads[" + next + "]").isEmpty()) { + String path; + while (!tm.getThreadsByPath(path = + PathUtils.toString(patThread.applyKeys(Long.toString(next)).getSingletonPath())) + .isEmpty()) { next++; } try { - return tm.createThread("Threads[" + next + "]", "[" + next + "]", snap); + return tm.createThread(path, "[" + next + "]", snap); } catch (DuplicateNameException e) { throw new AssertionError(e); @@ -214,6 +246,20 @@ public enum ProgramEmulationUtils { public static void initializeRegisters(Trace trace, long snap, TraceThread thread, Program program, Address tracePc, Address programPc, TraceMemoryRegion stack) { TraceMemoryManager memory = trace.getMemoryManager(); + if (thread instanceof TraceObjectThread ot) { + TraceObject object = ot.getObject(); + PathPredicates regsMatcher = object.getRoot() + .getTargetSchema() + .searchForRegisterContainer(0, object.getCanonicalPath().getKeyList()); + if (regsMatcher.isEmpty()) { + throw new IllegalArgumentException("Cannot create register container"); + } + for (PathPattern regsPattern : regsMatcher.getPatterns()) { + trace.getObjectManager() + .createObject(TraceObjectKeyPath.of(regsPattern.getSingletonPath())); + break; + } + } TraceMemorySpace regSpace = memory.getMemoryRegisterSpace(thread, true); if (program != null) { ProgramContext ctx = program.getProgramContext(); @@ -269,11 +315,18 @@ public enum ProgramEmulationUtils { TraceMemoryManager mm = trace.getMemoryManager(); AddressSetView left = new DifferenceAddressSetView(except0, mm.getRegionsAddressSet(snap)); + PathPattern patRegion = computePatternRegion(trace); try { for (AddressRange candidate : left) { if (Long.compareUnsigned(candidate.getLength(), size) > 0) { AddressRange alloc = new AddressRangeImpl(candidate.getMinAddress(), size); - return mm.createRegion(thread.getPath() + ".Stack", snap, alloc, + String threadName = PathUtils.isIndex(thread.getName()) + ? PathUtils.parseIndex(thread.getName()) + : thread.getName(); + String path = PathUtils.toString( + patRegion.applyKeys(alloc.getMinAddress() + "-stack " + threadName) + .getSingletonPath()); + return mm.createRegion(path, snap, alloc, TraceMemoryFlag.READ, TraceMemoryFlag.WRITE); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/model/DebuggerModelServicePlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/model/DebuggerModelServicePlugin.java index 45451c2cfc..9d06e75f10 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/model/DebuggerModelServicePlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/model/DebuggerModelServicePlugin.java @@ -40,6 +40,7 @@ import ghidra.app.plugin.core.debug.mapping.*; import ghidra.app.plugin.core.debug.service.model.launch.DebuggerProgramLaunchOffer; import ghidra.app.plugin.core.debug.service.model.launch.DebuggerProgramLaunchOpinion; import ghidra.app.services.*; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; import ghidra.async.AsyncFence; import ghidra.dbg.*; import ghidra.dbg.target.*; @@ -459,7 +460,8 @@ public class DebuggerModelServicePlugin extends Plugin if (traceManager != null) { Trace trace = recorder.getTrace(); traceManager.openTrace(trace); - traceManager.activateTrace(trace); + traceManager.activate(traceManager.resolveTrace(trace), + ActivationCause.ACTIVATE_DEFAULT); } return recorder; } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServicePlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServicePlugin.java index 273db9727d..be9ba6fc64 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServicePlugin.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServicePlugin.java @@ -32,6 +32,7 @@ import ghidra.app.plugin.core.debug.event.*; import ghidra.app.plugin.core.debug.gui.DebuggerResources.*; import ghidra.app.plugin.core.debug.mapping.DebuggerPlatformMapper; import ghidra.app.services.*; +import ghidra.app.services.DebuggerStateEditingService.StateEditingModeChangeListener; import ghidra.async.*; import ghidra.async.AsyncConfigFieldCodec.BooleanAsyncConfigFieldCodec; import ghidra.dbg.target.*; @@ -112,7 +113,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin if (supportsFocus(recorder)) { // TODO: Same for stack frame? I can't imagine it's as common as this.... if (thread == recorder.getTraceThreadForSuccessor(recorder.getFocus())) { - activate(current.thread(thread)); + activate(current.thread(thread), ActivationCause.SYNC_MODEL); } return; } @@ -122,16 +123,18 @@ public class DebuggerTraceManagerServicePlugin extends Plugin if (current.getThread() != null) { return; } - activate(current.thread(thread)); + activate(current.thread(thread), ActivationCause.ACTIVATE_DEFAULT); } private void threadDeleted(TraceThread thread) { - DebuggerCoordinates last = lastCoordsByTrace.get(trace); - if (last != null && last.getThread() == thread) { - lastCoordsByTrace.remove(trace); + synchronized (listenersByTrace) { + DebuggerCoordinates last = lastCoordsByTrace.get(trace); + if (last != null && last.getThread() == thread) { + lastCoordsByTrace.remove(trace); + } } if (current.getThread() == thread) { - activate(current.thread(null)); + activate(current.thread(null), ActivationCause.ACTIVATE_DEFAULT); } } @@ -146,7 +149,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin if (!object.isRoot()) { return; } - activate(current.object(object)); + activate(current.object(object), ActivationCause.SYNC_MODEL); } } @@ -231,17 +234,32 @@ public class DebuggerTraceManagerServicePlugin extends Plugin } } + class ForFollowPresentListener implements StateEditingModeChangeListener { + @Override + public void modeChanged(Trace trace, StateEditingMode mode) { + if (trace != current.getTrace() || !mode.followsPresent()) { + return; + } + TraceRecorder curRecorder = current.getRecorder(); + if (curRecorder == null) { + return; + } + // TODO: Also re-sync focused thread/frame? + activateNoFocus(current.snap(curRecorder.getSnap()), ActivationCause.FOLLOW_PRESENT); + } + } + protected final Map lastCoordsByTrace = new WeakHashMap<>(); protected final Map listenersByTrace = new WeakHashMap<>(); protected final Set tracesView = Collections.unmodifiableSet(listenersByTrace.keySet()); private final ForRecordersListener forRecordersListener = new ForRecordersListener(); + private final ForFollowPresentListener forFollowPresentListener = + new ForFollowPresentListener(); protected DebuggerCoordinates current = DebuggerCoordinates.NOWHERE; protected TargetObject curObj; @AutoConfigStateField(codec = BooleanAsyncConfigFieldCodec.class) - protected final AsyncReference autoActivatePresent = new AsyncReference<>(true); - @AutoConfigStateField(codec = BooleanAsyncConfigFieldCodec.class) protected final AsyncReference saveTracesByDefault = new AsyncReference<>(true); @AutoConfigStateField(codec = BooleanAsyncConfigFieldCodec.class) protected final AsyncReference synchronizeFocus = new AsyncReference<>(true); @@ -254,6 +272,8 @@ public class DebuggerTraceManagerServicePlugin extends Plugin private DebuggerEmulationService emulationService; @AutoServiceConsumed private DebuggerPlatformService platformService; + // @AutoServiceConsumed via method + private DebuggerStateEditingService editingService; @SuppressWarnings("unused") private final AutoService.Wiring autoServiceWiring; @@ -448,6 +468,17 @@ public class DebuggerTraceManagerServicePlugin extends Plugin } } + @AutoServiceConsumed + private void setEditingService(DebuggerStateEditingService editingService) { + if (this.editingService != null) { + this.editingService.removeModeChangeListener(forFollowPresentListener); + } + this.editingService = editingService; + if (this.editingService != null) { + this.editingService.addModeChangeListener(forFollowPresentListener); + } + } + @Override public Class[] getSupportedDataTypes() { return new Class[] { Trace.class }; @@ -574,20 +605,38 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return false; } } - activateNoFocus(getCurrentFor(trace).object(obj)); + activateNoFocus(getCurrentFor(trace).object(obj), ActivationCause.SYNC_MODEL); return true; } + private boolean isFollowsPresent(Trace trace) { + StateEditingMode mode = editingService == null + ? StateEditingMode.DEFAULT + : editingService.getCurrentMode(trace); + return mode.followsPresent(); + } + protected void doTraceRecorderAdvanced(TraceRecorder recorder, long snap) { - if (!autoActivatePresent.get()) { + Trace trace = recorder.getTrace(); + if (!isFollowsPresent(trace)) { return; } - if (recorder.getTrace() != current.getTrace()) { - // TODO: Could advance view, which might be desirable anyway - // Would also obviate checks in resolveCoordinates and updateCurrentRecorder + if (trace != current.getTrace()) { + /** + * The snap needs to match upon re-activating this trace, lest it look like the user + * intentionally navigated to the past, causing the mode to switch away from target. + */ + DebuggerCoordinates inactive = null; + synchronized (listenersByTrace) { + DebuggerCoordinates curForTrace = getCurrentFor(trace); + inactive = curForTrace.snap(snap); + lastCoordsByTrace.put(trace, inactive); + } + trace.getProgramView().setSnap(snap); + firePluginEvent(new TraceInactiveCoordinatesPluginEvent(getName(), inactive)); return; } - activateSnap(snap); + activate(resolveSnap(snap), ActivationCause.FOLLOW_PRESENT); } protected TracePlatform getPlatformForMapper(Trace trace, TraceObject object, @@ -607,7 +656,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin lastCoordsByTrace.put(trace, adj); if (trace == current.getTrace()) { current = adj; - fireLocationEvent(adj); + fireLocationEvent(adj, ActivationCause.MAPPER_CHANGED); } } } @@ -628,12 +677,10 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return; } DebuggerCoordinates toActivate = current.recorder(recorder); - if (autoActivatePresent.get()) { - activate(toActivate.snap(recorder.getSnap())); - } - else { - activate(toActivate); + if (isFollowsPresent(current.getTrace())) { + toActivate = toActivate.snap(recorder.getSnap()); } + activate(toActivate, ActivationCause.FOLLOW_PRESENT); } @Override @@ -740,10 +787,11 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return emulationService.backgroundEmulate(coordinates.getPlatform(), coordinates.getTime()); } - protected CompletableFuture prepareViewAndFireEvent(DebuggerCoordinates coordinates) { + protected CompletableFuture prepareViewAndFireEvent(DebuggerCoordinates coordinates, + ActivationCause cause) { TraceVariableSnapProgramView varView = (TraceVariableSnapProgramView) coordinates.getView(); if (varView == null) { // Should only happen with NOWHERE - fireLocationEvent(coordinates); + fireLocationEvent(coordinates, cause); return AsyncUtils.NIL; } return materialize(coordinates).thenAcceptAsync(snap -> { @@ -751,12 +799,12 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return; // We navigated elsewhere before emulation completed } varView.setSnap(snap); - fireLocationEvent(coordinates); + fireLocationEvent(coordinates, cause); }, SwingExecutorService.MAYBE_NOW); } - protected void fireLocationEvent(DebuggerCoordinates coordinates) { - firePluginEvent(new TraceActivatedPluginEvent(getName(), coordinates)); + protected void fireLocationEvent(DebuggerCoordinates coordinates, ActivationCause cause) { + firePluginEvent(new TraceActivatedPluginEvent(getName(), coordinates, cause)); } @Override @@ -980,7 +1028,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin //Msg.debug(this, "Remaining Consumers of " + trace + ": " + trace.getConsumerList()); } if (current.getTrace() == trace) { - activate(DebuggerCoordinates.NOWHERE); + activate(DebuggerCoordinates.NOWHERE, ActivationCause.ACTIVATE_DEFAULT); } else { contextChanged(); @@ -1004,7 +1052,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin @Override protected void dispose() { super.dispose(); - activate(DebuggerCoordinates.NOWHERE); + activate(DebuggerCoordinates.NOWHERE, ActivationCause.ACTIVATE_DEFAULT); synchronized (listenersByTrace) { Iterator it = listenersByTrace.keySet().iterator(); while (it.hasNext()) { @@ -1027,12 +1075,12 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return elem.toString(); } - protected void activateNoFocus(DebuggerCoordinates coordinates) { + protected void activateNoFocus(DebuggerCoordinates coordinates, ActivationCause cause) { DebuggerCoordinates resolved = doSetCurrent(coordinates); if (resolved == null) { return; } - prepareViewAndFireEvent(resolved); + prepareViewAndFireEvent(resolved, cause); } protected static boolean isSameFocus(DebuggerCoordinates prev, DebuggerCoordinates resolved) { @@ -1082,7 +1130,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin @Override public CompletableFuture activateAndNotify(DebuggerCoordinates coordinates, - boolean syncTargetFocus) { + ActivationCause cause, boolean syncTargetFocus) { DebuggerCoordinates prev; DebuggerCoordinates resolved; @@ -1098,7 +1146,7 @@ public class DebuggerTraceManagerServicePlugin extends Plugin if (resolved == null) { return AsyncUtils.NIL; } - CompletableFuture future = prepareViewAndFireEvent(resolved); + CompletableFuture future = prepareViewAndFireEvent(resolved, cause); if (!syncTargetFocus) { return future; } @@ -1118,12 +1166,8 @@ public class DebuggerTraceManagerServicePlugin extends Plugin } @Override - public void activate(DebuggerCoordinates coordinates) { - activateAndNotify(coordinates, true); // Drop future on floor - } - - public void activateNoFocusChange(DebuggerCoordinates coordinates) { - activateAndNotify(coordinates, false); // Drop future on floor + public void activate(DebuggerCoordinates coordinates, ActivationCause cause) { + activateAndNotify(coordinates, cause, true); // Drop future on floor } @Override @@ -1169,38 +1213,6 @@ public class DebuggerTraceManagerServicePlugin extends Plugin return current.object(object); } - @Override - public void setAutoActivatePresent(boolean enabled) { - autoActivatePresent.set(enabled, null); - TraceRecorder curRecorder = current.getRecorder(); - if (enabled) { - // TODO: Re-sync focus. This wasn't working. Not sure it's appropriate anyway. - /*if (synchronizeFocus && curRef != null) { - if (doModelObjectFocused(curRef, false)) { - return; - } - }*/ - if (curRecorder != null) { - activateNoFocus(current.snap(curRecorder.getSnap())); - } - } - } - - @Override - public boolean isAutoActivatePresent() { - return autoActivatePresent.get(); - } - - @Override - public void addAutoActivatePresentChangeListener(BooleanChangeAdapter listener) { - autoActivatePresent.addChangeListener(listener); - } - - @Override - public void removeAutoActivatePresentChangeListener(BooleanChangeAdapter listener) { - autoActivatePresent.removeChangeListener(listener); - } - @Override public void setSynchronizeFocus(boolean enabled) { synchronizeFocus.set(enabled, null); @@ -1315,17 +1327,20 @@ public class DebuggerTraceManagerServicePlugin extends Plugin @Override public void readDataState(SaveState saveState) { - int traceCount = saveState.getInt(KEY_TRACE_COUNT, 0); - for (int index = 0; index < traceCount; index++) { - String stateName = PREFIX_OPEN_TRACE + index; - // Trace will be opened by readDataState, resolve causes update to focus and view - DebuggerCoordinates coords = - DebuggerCoordinates.readDataState(tool, saveState, stateName); - if (coords.getTrace() != null) { - lastCoordsByTrace.put(coords.getTrace(), coords); + synchronized (listenersByTrace) { + int traceCount = saveState.getInt(KEY_TRACE_COUNT, 0); + for (int index = 0; index < traceCount; index++) { + String stateName = PREFIX_OPEN_TRACE + index; + // Trace will be opened by readDataState, resolve causes update to focus and view + DebuggerCoordinates coords = + DebuggerCoordinates.readDataState(tool, saveState, stateName); + if (coords.getTrace() != null) { + lastCoordsByTrace.put(coords.getTrace(), coords); + } } } - activate(DebuggerCoordinates.readDataState(tool, saveState, KEY_CURRENT_COORDS)); + activate(DebuggerCoordinates.readDataState(tool, saveState, KEY_CURRENT_COORDS), + ActivationCause.RESTORE_STATE); } } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/utils/DebouncedRowWrappedEnumeratedColumnTableModel.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/utils/DebouncedRowWrappedEnumeratedColumnTableModel.java index b986a821db..8c5f32f6ed 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/utils/DebouncedRowWrappedEnumeratedColumnTableModel.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/utils/DebouncedRowWrappedEnumeratedColumnTableModel.java @@ -30,9 +30,9 @@ public class DebouncedRowWrappedEnumeratedColumnTableModel & E AsyncDebouncer debouncer = new AsyncDebouncer(AsyncTimer.DEFAULT_TIMER, 100); public DebouncedRowWrappedEnumeratedColumnTableModel(PluginTool tool, String name, - Class colType, - Function keyFunc, Function wrapper) { - super(tool, name, colType, keyFunc, wrapper); + Class colType, Function keyFunc, Function wrapper, + Function getter) { + super(tool, name, colType, keyFunc, wrapper, getter); debouncer.addListener(this::settled); } diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerLogicalBreakpointService.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerLogicalBreakpointService.java index 6e9d14c5c1..c82255606a 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerLogicalBreakpointService.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerLogicalBreakpointService.java @@ -33,7 +33,7 @@ import ghidra.trace.model.program.TraceProgramView; @ServiceInfo( // defaultProvider = DebuggerLogicalBreakpointServicePlugin.class, - description = "Aggregate breakpoints for programs and live traces") + description = "Aggregate breakpoints for programs and traces") public interface DebuggerLogicalBreakpointService { /** * Get all logical breakpoints known to the tool. @@ -54,11 +54,11 @@ public interface DebuggerLogicalBreakpointService { NavigableMap> getBreakpoints(Program program); /** - * Get a map of addresses to collected logical breakpoints (at present) for a given trace. + * Get a map of addresses to collected logical breakpoints for a given trace. * *

    - * The trace must be associated with a live target. The returned map collects live breakpoints - * in the recorded target, using trace breakpoints from the recorder's current snapshot. + * The map only includes breakpoints visible in the trace's primary view. Visibility depends on + * the view's snapshot. * * @param trace the trace database * @return the map of logical breakpoints @@ -78,12 +78,11 @@ public interface DebuggerLogicalBreakpointService { Set getBreakpointsAt(Program program, Address address); /** - * Get the collected logical breakpoints (at present) at the given trace location. + * Get the collected logical breakpoints at the given trace location. * *

    - * The trace must be associated with a live target. The returned collection includes live - * breakpoints in the recorded target, using trace breakpoints from the recorders' current - * snapshot. + * The set only includes breakpoints visible in the trace's primary view. Visibility depends on + * the view's snapshot. * * @param trace the trace database * @param address the address @@ -95,8 +94,8 @@ public interface DebuggerLogicalBreakpointService { * Get the logical breakpoint of which the given trace breakpoint is a part * *

    - * If the given trace breakpoint is not part of any logical breakpoint, e.g., because it is not - * on a live target, then null is returned. + * If the given trace breakpoint is not part of any logical breakpoint, e.g., because the trace + * is not opened in the tool or events are still being processed, then null is returned. * * @param bpt the trace breakpoint * @return the logical breakpoint, or null @@ -108,8 +107,8 @@ public interface DebuggerLogicalBreakpointService { * *

    * The {@code program} field for the location may be either a program database (static image) or - * a view for a trace associated with a live target. If it is the latter, the view's current - * snapshot is ignored, in favor of the associated recorder's current snapshot. + * a view for a trace. If it is the latter, the view's snapshot is ignored in favor of the + * trace's primary view's snapshot. * *

    * If {@code program} is a static image, this is equivalent to using @@ -252,8 +251,7 @@ public interface DebuggerLogicalBreakpointService { } /** - * Create an enabled breakpoint at the given program location and each mapped live trace - * location. + * Create an enabled breakpoint at the given program location and each mapped trace location. * *

    * The implementation should take care not to create the same breakpoint multiple times. The @@ -278,12 +276,12 @@ public interface DebuggerLogicalBreakpointService { * this is the case, the breakpoint will have no name. * *

    - * Note, the debugger ultimately determines the placement behavior. If it is managing multiple - * targets, it is possible the breakpoint will be effective in another trace. This fact should - * be reflected correctly in the resulting logical markings once all resulting events have been - * processed. + * Note for live targets, the debugger ultimately determines the placement behavior. If it is + * managing multiple targets, it is possible the breakpoint will be effective in another trace. + * This fact should be reflected correctly in the resulting logical markings once all resulting + * events have been processed. * - * @param trace the given trace, which must be live + * @param trace the given trace * @param address the address in the trace (as viewed in the present) * @param length size of the breakpoint, may be ignored by debugger * @param kinds the kinds of breakpoint @@ -367,7 +365,7 @@ public interface DebuggerLogicalBreakpointService { CompletableFuture deleteAll(Collection col, Trace trace); /** - * Presuming the given locations are live, enable them + * Enable the given locations * * @param col the trace breakpoints * @return a future which completes when the command has been processed @@ -375,7 +373,7 @@ public interface DebuggerLogicalBreakpointService { CompletableFuture enableLocs(Collection col); /** - * Presuming the given locations are live, disable them + * Disable the given locations * * @param col the trace breakpoints * @return a future which completes when the command has been processed @@ -383,7 +381,7 @@ public interface DebuggerLogicalBreakpointService { CompletableFuture disableLocs(Collection col); /** - * Presuming the given locations are live, delete them + * Delete the given locations * * @param col the trace breakpoints * @return a future which completes when the command has been processed diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerStateEditingService.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerStateEditingService.java index aec0106e2f..345be70c51 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerStateEditingService.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerStateEditingService.java @@ -17,16 +17,12 @@ package ghidra.app.services; import java.util.concurrent.CompletableFuture; -import javax.swing.Icon; - import ghidra.app.plugin.core.debug.DebuggerCoordinates; -import ghidra.app.plugin.core.debug.gui.DebuggerResources; import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; import ghidra.framework.plugintool.ServiceInfo; import ghidra.pcode.utils.Utils; import ghidra.program.model.address.Address; -import ghidra.program.model.lang.Register; -import ghidra.program.model.lang.RegisterValue; +import ghidra.program.model.lang.*; import ghidra.program.model.mem.LiveMemoryHandler; import ghidra.trace.model.Trace; import ghidra.trace.model.program.TraceProgramView; @@ -35,47 +31,6 @@ import ghidra.trace.model.program.TraceProgramView; defaultProvider = DebuggerStateEditingServicePlugin.class, description = "Centralized service for modifying machine states") public interface DebuggerStateEditingService { - enum StateEditingMode { - READ_ONLY(DebuggerResources.NAME_EDIT_MODE_READ_ONLY, // - DebuggerResources.ICON_EDIT_MODE_READ_ONLY) { - @Override - public boolean canEdit(DebuggerCoordinates coordinates) { - return false; - } - }, - WRITE_TARGET(DebuggerResources.NAME_EDIT_MODE_WRITE_TARGET, // - DebuggerResources.ICON_EDIT_MODE_WRITE_TARGET) { - @Override - public boolean canEdit(DebuggerCoordinates coordinates) { - return coordinates.isAliveAndPresent(); - } - }, - WRITE_TRACE(DebuggerResources.NAME_EDIT_MODE_WRITE_TRACE, // - DebuggerResources.ICON_EDIT_MODE_WRITE_TRACE) { - @Override - public boolean canEdit(DebuggerCoordinates coordinates) { - return coordinates.getTrace() != null; - } - }, - WRITE_EMULATOR(DebuggerResources.NAME_EDIT_MODE_WRITE_EMULATOR, // - DebuggerResources.ICON_EDIT_MODE_WRITE_EMULATOR) { - @Override - public boolean canEdit(DebuggerCoordinates coordinates) { - return coordinates.getTrace() != null; - } - }; - - public final String name; - public final Icon icon; - - private StateEditingMode(String name, Icon icon) { - this.name = name; - this.icon = icon; - } - - public abstract boolean canEdit(DebuggerCoordinates coordinates); - } - interface StateEditor { DebuggerStateEditingService getService(); diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerTraceManagerService.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerTraceManagerService.java index 23b9593227..101fa0b922 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerTraceManagerService.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/DebuggerTraceManagerService.java @@ -38,6 +38,49 @@ import ghidra.util.TriConsumer; @ServiceInfo(defaultProvider = DebuggerTraceManagerServicePlugin.class) public interface DebuggerTraceManagerService { + /** + * The reason coordinates were activated + */ + public enum ActivationCause { + /** + * The change was driven by the user + * + *

    + * TODO: Distinguish between API and GUI? + */ + USER, + /** + * A trace was activated because a recording was started, usually when a target is launched + */ + START_RECORDING, + /** + * The change was driven by the model focus, possibly indirectly by the user + */ + SYNC_MODEL, + /** + * The change was driven by the recorder advancing a snapshot + */ + FOLLOW_PRESENT, + /** + * The change was caused by a change to the mapper selection, probably indirectly by the + * user + */ + MAPPER_CHANGED, + /** + * Some default coordinates were activated + * + *

    + * Please don't misunderstand this as the "default cause." Rather, e.g., when the current + * trace is closed, and the manager needs to activate new coordinates, it is activating + * "default coordinates." + */ + ACTIVATE_DEFAULT, + /** + * The tool is restoring its data state + */ + RESTORE_STATE, + } + /** * An adapter that works nicely with an {@link AsyncReference} * @@ -69,7 +112,7 @@ public interface DebuggerTraceManagerService { * Get the current coordinates * *

    - * This entails everything except the current address + * This entails everything except the current address. * * @return the current coordinates */ @@ -233,11 +276,22 @@ public interface DebuggerTraceManagerService { * thread for the desired trace. * * @param coordinates the desired coordinates + * @param cause the cause of the activation * @param syncTargetFocus true synchronize the current target to the same coordinates * @return a future which completes when emulation and navigation is complete */ CompletableFuture activateAndNotify(DebuggerCoordinates coordinates, - boolean syncTargetFocus); + ActivationCause cause, boolean syncTargetFocus); + + /** + * Activate the given coordinates, caused by the user + * + * @see #activate(DebuggerCoordinates, ActivationCause) + * @param coordinates the desired coordinates + */ + default void activate(DebuggerCoordinates coordinates) { + activate(coordinates, ActivationCause.USER); + } /** * Activate the given coordinates, synchronizing the current target, if possible @@ -247,8 +301,9 @@ public interface DebuggerTraceManagerService { * {@link #activateAndNotify(DebuggerCoordinates, boolean)}. * * @param coordinates the desired coordinates + * @param cause the cause of activation */ - void activate(DebuggerCoordinates coordinates); + void activate(DebuggerCoordinates coordinates, ActivationCause cause); /** * Resolve coordinates for the given trace using the manager's "best judgment" @@ -388,38 +443,6 @@ public interface DebuggerTraceManagerService { activate(resolveObject(object)); } - /** - * Control whether the trace manager automatically activates the "present snapshot" - * - *

    - * Auto activation only applies when the current trace advances. It never changes to another - * trace. - * - * @param enabled true to enable auto activation - */ - void setAutoActivatePresent(boolean enabled); - - /** - * Check if the trace manager automatically activate the "present snapshot" - * - * @return true if auto activation is enabled - */ - boolean isAutoActivatePresent(); - - /** - * Add a listener for changes to auto activation enablement - * - * @param listener the listener to receive change notifications - */ - void addAutoActivatePresentChangeListener(BooleanChangeAdapter listener); - - /** - * Remove a listener for changes to auto activation enablement - * - * @param listener the listener receiving change notifications - */ - void removeAutoActivatePresentChangeListener(BooleanChangeAdapter listener); - /** * Control whether trace activation is synchronized with debugger focus/select * diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/LogicalBreakpoint.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/LogicalBreakpoint.java index b770d1c814..c5b684825b 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/LogicalBreakpoint.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/LogicalBreakpoint.java @@ -30,6 +30,30 @@ import ghidra.trace.model.Trace; import ghidra.trace.model.breakpoint.TraceBreakpoint; import ghidra.trace.model.breakpoint.TraceBreakpointKind; +/** + * A logical breakpoint + * + *

    + * This is a collection of at most one program breakpoint, which is actually a bookmark with a + * special type, and any number of trace breakpoints. The program breakpoint represents the logical + * breakpoint, as this is the most stable anchor for keeping the user's breakpoint set. All + * breakpoints in the set correspond to the same address when considering the module map (or other + * source of static-to-dynamic mapping), which may involve relocation. They also share the same + * kinds and length, since these are more or less intrinsic to the breakpoints specification. Thus, + * more than one logical breakpoint may occupy the same address. A logical breakpoints having a + * program bookmark (or that at least has a static address) is called a "mapped" breakpoint. This is + * the ideal, ordinary case. A breakpoint that cannot be mapped to a static address (and thus cannot + * have a program bookmark) is called a "lone" breakpoint. + * + *

    + * WARNING: The lifecycle of a logical breakpoint is fairly volatile. It is generally not + * safe to "hold onto" a logical breakpoint, since with any event, the logical breakpoint service + * may discard and re-create the object, even if it's composed of the same program and trace + * breakpoints. If it is truly necessary to hold onto logical breakpoints, consider using + * {@link DebuggerLogicalBreakpointService#addChangeListener(LogicalBreakpointsChangeListener)}. A + * logical breakpoint is valid until the service invokes + * {@link LogicalBreakpointsChangeListener#breakpointRemoved(LogicalBreakpoint)}. + */ public interface LogicalBreakpoint { String BREAKPOINT_ENABLED_BOOKMARK_TYPE = "BreakpointEnabled"; String BREAKPOINT_DISABLED_BOOKMARK_TYPE = "BreakpointDisabled"; @@ -605,6 +629,22 @@ public interface LogicalBreakpoint { */ void setName(String name); + /** + * Get the sleigh injection when emulating this breakpoint + * + * @return the sleigh injection + * @see TraceBreakpoint#getEmuSleigh() + */ + String getEmuSleigh(); + + /** + * Set the sleigh injection when emulating this breakpoint + * + * @param sleigh the sleigh injection + * @see TraceBreakpoint#setEmuSleigh(String) + */ + void setEmuSleigh(String sleigh); + /** * If the logical breakpoint has a mapped program location, get that location. * diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/StateEditingMode.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/StateEditingMode.java new file mode 100644 index 0000000000..29254837a3 --- /dev/null +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/services/StateEditingMode.java @@ -0,0 +1,431 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.app.services; + +import java.nio.ByteBuffer; +import java.util.Objects; +import java.util.concurrent.CompletableFuture; + +import javax.swing.Icon; + +import generic.theme.GIcon; +import ghidra.app.plugin.core.debug.DebuggerCoordinates; +import ghidra.app.services.DebuggerTraceManagerService.ActivationCause; +import ghidra.async.AsyncUtils; +import ghidra.framework.plugintool.PluginTool; +import ghidra.program.model.address.Address; +import ghidra.program.model.address.AddressRange; +import ghidra.program.model.lang.Language; +import ghidra.program.model.lang.Register; +import ghidra.program.model.mem.MemoryAccessException; +import ghidra.trace.model.Trace; +import ghidra.trace.model.guest.TracePlatform; +import ghidra.trace.model.memory.TraceMemoryOperations; +import ghidra.trace.model.memory.TraceMemorySpace; +import ghidra.trace.model.program.TraceVariableSnapProgramView; +import ghidra.trace.model.thread.TraceThread; +import ghidra.trace.model.time.schedule.PatchStep; +import ghidra.trace.model.time.schedule.TraceSchedule; +import ghidra.trace.util.TraceRegisterUtils; +import ghidra.util.database.UndoableTransaction; +import ghidra.util.exception.CancelledException; +import ghidra.util.task.TaskMonitor; + +/** + * The control / state editing modes + */ +public enum StateEditingMode { + /** + * Control actions, breakpoint commands are directed to the target, but state edits are + * rejected. + */ + RO_TARGET("Control Target w/ Edits Disabled", new GIcon("icon.debugger.edit.mode.ro.target")) { + @Override + public boolean followsPresent() { + return true; + } + + @Override + public boolean canEdit(DebuggerCoordinates coordinates) { + return false; + } + + @Override + public boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length) { + return false; + } + + @Override + public CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address address, byte[] data) { + return CompletableFuture.failedFuture(new MemoryAccessException("Read-only mode")); + } + + @Override + public boolean useEmulatedBreakpoints() { + return false; + } + + @Override + public boolean isSelectable(DebuggerCoordinates coordinates) { + return coordinates.isAliveAndPresent(); + } + + @Override + public StateEditingMode getAlternative(DebuggerCoordinates coordinates) { + return RO_TRACE; + } + }, + /** + * Control actions, breakpoint commands, and state edits are all directed to the target. + */ + RW_TARGET("Control Target", new GIcon("icon.debugger.edit.mode.rw.target")) { + @Override + public boolean followsPresent() { + return true; + } + + @Override + public boolean canEdit(DebuggerCoordinates coordinates) { + return coordinates.isAliveAndPresent(); + } + + @Override + public boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length) { + if (!coordinates.isAliveAndPresent()) { + return false; + } + TraceRecorder recorder = coordinates.getRecorder(); + return recorder.isVariableOnTarget(coordinates.getPlatform(), + coordinates.getThread(), coordinates.getFrame(), address, length); + } + + @Override + public CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address address, byte[] data) { + TraceRecorder recorder = coordinates.getRecorder(); + if (recorder == null) { + return CompletableFuture + .failedFuture(new MemoryAccessException("Trace has no live target")); + } + if (!coordinates.isPresent()) { + return CompletableFuture + .failedFuture(new MemoryAccessException("View is not the present")); + } + return recorder.writeVariable(coordinates.getPlatform(), coordinates.getThread(), + coordinates.getFrame(), address, data); + } + + @Override + public boolean useEmulatedBreakpoints() { + return false; + } + + @Override + public boolean isSelectable(DebuggerCoordinates coordinates) { + return coordinates.isAliveAndPresent(); + } + + @Override + public StateEditingMode getAlternative(DebuggerCoordinates coordinates) { + return RW_EMULATOR; + } + }, + /** + * Control actions activate trace snapshots, breakpoint commands are directed to the emulator, + * and state edits are rejected. + */ + RO_TRACE("Control Trace w/ Edits Disabled", new GIcon("icon.debugger.edit.mode.ro.trace")) { + @Override + public boolean followsPresent() { + return false; + } + + @Override + public boolean canEdit(DebuggerCoordinates coordinates) { + return false; + } + + @Override + public boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length) { + return false; + } + + @Override + public CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address address, byte[] data) { + return CompletableFuture.failedFuture(new MemoryAccessException("Read-only mode")); + } + + @Override + public boolean useEmulatedBreakpoints() { + return true; + } + }, + /** + * Control actions activate trace snapshots, breakpoint commands are directed to the emulator, + * and state edits modify the current trace snapshot. + */ + RW_TRACE("Control Trace", new GIcon("icon.debugger.edit.mode.rw.trace")) { + @Override + public boolean followsPresent() { + return false; + } + + @Override + public boolean canEdit(DebuggerCoordinates coordinates) { + return coordinates.getTrace() != null; + } + + @Override + public boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length) { + return address.isMemoryAddress() || coordinates.getThread() != null; + } + + @Override + public CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address guestAddress, byte[] data) { + Trace trace = coordinates.getTrace(); + TracePlatform platform = coordinates.getPlatform(); + long snap = coordinates.getViewSnap(); + Address hostAddress = platform.mapGuestToHost(guestAddress); + if (hostAddress == null) { + throw new IllegalArgumentException( + "Guest address " + guestAddress + " is not mapped"); + } + TraceMemoryOperations memOrRegs; + Address overlayAddress; + try (UndoableTransaction txid = + UndoableTransaction.start(trace, "Edit Variable")) { + if (hostAddress.isRegisterAddress()) { + TraceThread thread = coordinates.getThread(); + if (thread == null) { + throw new IllegalArgumentException("Register edits require a thread."); + } + TraceMemorySpace regs = trace.getMemoryManager() + .getMemoryRegisterSpace(thread, coordinates.getFrame(), + true); + memOrRegs = regs; + overlayAddress = regs.getAddressSpace().getOverlayAddress(hostAddress); + } + else { + memOrRegs = trace.getMemoryManager(); + overlayAddress = hostAddress; + } + if (memOrRegs.putBytes(snap, overlayAddress, + ByteBuffer.wrap(data)) != data.length) { + return CompletableFuture.failedFuture(new MemoryAccessException()); + } + } + return AsyncUtils.NIL; + } + + @Override + public boolean useEmulatedBreakpoints() { + return true; + } + }, + /** + * Control actions, breakpoint commands, and state edits are directed to the emulator. + * + *

    + * Edits are accomplished by appending patch steps to the current schedule and activating that + * schedule. + */ + RW_EMULATOR("Control Emulator", new GIcon("icon.debugger.edit.mode.rw.emulator")) { + @Override + public boolean followsPresent() { + return false; + } + + @Override + public boolean canEdit(DebuggerCoordinates coordinates) { + return coordinates.getTrace() != null; + } + + @Override + public boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length) { + if (coordinates.getThread() == null) { + // A limitation in TraceSchedule, which is used to manifest patches + return false; + } + if (!RW_TRACE.isVariableEditable(coordinates, address, length)) { + return false; + } + // TODO: Limitation from using Sleigh for patching + Register ctxReg = coordinates.getTrace().getBaseLanguage().getContextBaseRegister(); + if (ctxReg == Register.NO_CONTEXT) { + return true; + } + AddressRange ctxRange = TraceRegisterUtils.rangeForRegister(ctxReg); + if (ctxRange.contains(address)) { + return false; + } + return true; + } + + @Override + public CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address address, byte[] data) { + if (!(coordinates.getView() instanceof TraceVariableSnapProgramView)) { + throw new IllegalArgumentException("Cannot emulate using a Fixed Program View"); + } + TraceThread thread = coordinates.getThread(); + if (thread == null) { + // TODO: Well, technically, only for register edits + // It's a limitation in TraceSchedule. Every step requires a thread + throw new IllegalArgumentException("Emulator edits require a thread."); + } + Language language = coordinates.getPlatform().getLanguage(); + TraceSchedule time = coordinates.getTime() + .patched(thread, language, + PatchStep.generateSleigh(language, address, data)); + + DebuggerCoordinates withTime = coordinates.time(time); + DebuggerTraceManagerService traceManager = + Objects.requireNonNull(tool.getService(DebuggerTraceManagerService.class), + "No trace manager service"); + Long found = traceManager.findSnapshot(withTime); + // Materialize it on the same thread (even if swing) + // It shouldn't take long, since we're only appending one step. + if (found == null) { + // TODO: Could still do it async on another thread, no? + // Not sure it buys anything, since program view will call .get on swing thread + DebuggerEmulationService emulationService = Objects.requireNonNull( + tool.getService(DebuggerEmulationService.class), "No emulation service"); + try { + emulationService.emulate(coordinates.getPlatform(), time, + TaskMonitor.DUMMY); + } + catch (CancelledException e) { + throw new AssertionError(e); + } + } + return traceManager.activateAndNotify(withTime, ActivationCause.USER, false); + } + + @Override + public boolean useEmulatedBreakpoints() { + return true; + } + }; + + public static final StateEditingMode DEFAULT = RO_TARGET; + + public final String name; + public final Icon icon; + + private StateEditingMode(String name, Icon icon) { + this.name = name; + this.icon = icon; + } + + /** + * Check if the UI should keep its active snapshot in sync with the recorder's latest. + * + * @return true to follow, false if not + */ + public abstract boolean followsPresent(); + + /** + * Check if (broadly speaking) the mode supports editing the given coordinates + * + * @param coordinates the coordinates to check + * @return true if editable, false if not + */ + public abstract boolean canEdit(DebuggerCoordinates coordinates); + + /** + * Check if the given variable can be edited under this mode + * + * @param coordinates the coordinates to check + * @param address the address of the variable + * @param length the length of the variable, in bytes + * @return true if editable, false if not + */ + public abstract boolean isVariableEditable(DebuggerCoordinates coordinates, Address address, + int length); + + /** + * Set the value of a variable + * + *

    + * Because the edit may be directed to a live target, the return value is a + * {@link CompletableFuture}. Additionally, when directed to the emulator, this allows the + * emulated state to be computed in the background. + * + * @param tool the tool requesting the edit + * @param coordinates the coordinates of the edit + * @param address the address of the variable + * @param data the desired value of the variable + * @return a future which completes when the edit is finished + */ + public abstract CompletableFuture setVariable(PluginTool tool, + DebuggerCoordinates coordinates, Address address, byte[] data); + + /** + * Check if this mode operates on target breakpoints or emulator breakpoints + * + * @return false for target, true for emulator + */ + public abstract boolean useEmulatedBreakpoints(); + + /** + * Check if this mode can be selected for the given coordinates + * + * @param coordinates the current coordinates + * @return true to enable selection, false to disable + */ + public boolean isSelectable(DebuggerCoordinates coordinates) { + return true; + } + + /** + * If the mode can no longer be selected for new coordinates, get the new mode + * + *

    + * For example, if a target terminates while the mode is {@link #RO_TARGET}, this specifies the + * new mode. + * + * @param coordinates the new coordinates + * @return the new mode + */ + public StateEditingMode getAlternative(DebuggerCoordinates coordinates) { + throw new AssertionError("INTERNAL: Non-selectable mode must provide alternative"); + } + + /** + * Find the new mode (or same) mode when activating the given coordinates + * + *

    + * The default is implemented using {@link #isSelectable(DebuggerCoordinates)} followed by + * {@link #getAlternative(DebuggerCoordinates)}. + * + * @param coordinates the new coordinates + * @return the mode + */ + public StateEditingMode modeOnChange(DebuggerCoordinates coordinates) { + if (isSelectable(coordinates)) { + return this; + } + return getAlternative(coordinates); + } +} diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/debug/flatapi/FlatDebuggerAPI.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/debug/flatapi/FlatDebuggerAPI.java index 2a3ba7bb04..28501649fa 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/debug/flatapi/FlatDebuggerAPI.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/debug/flatapi/FlatDebuggerAPI.java @@ -30,7 +30,6 @@ import ghidra.app.plugin.core.debug.service.model.launch.DebuggerProgramLaunchOf import ghidra.app.script.GhidraScript; import ghidra.app.script.GhidraState; import ghidra.app.services.*; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.DebuggerStateEditingService.StateEditor; import ghidra.dbg.AnnotatedDebuggerAttributeListener; import ghidra.dbg.DebuggerObjectModel; @@ -766,9 +765,9 @@ public interface FlatDebuggerAPI { } /** - * Apply the given SLEIGH patch to the emulator + * Apply the given Sleigh patch to the emulator * - * @param sleigh the SLEIGH source, without terminating semicolon + * @param sleigh the Sleigh source, without terminating semicolon * @param monitor a monitor for the emulation * @return true if successful, false otherwise * @throws CancelledException if the user cancelled via the given monitor diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/pcode/exec/DebuggerPcodeUtils.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/pcode/exec/DebuggerPcodeUtils.java index 55983a510d..b8948a7873 100644 --- a/Ghidra/Debug/Debugger/src/main/java/ghidra/pcode/exec/DebuggerPcodeUtils.java +++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/pcode/exec/DebuggerPcodeUtils.java @@ -16,12 +16,9 @@ package ghidra.pcode.exec; import java.math.BigInteger; -import java.util.HashMap; -import java.util.Map; +import java.util.*; import java.util.Map.Entry; -import org.bouncycastle.util.Arrays; - import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.service.emulation.*; import ghidra.app.plugin.core.debug.service.emulation.data.DefaultPcodeDebuggerAccess; @@ -214,7 +211,7 @@ public enum DebuggerPcodeUtils { if (this.bigEndian != that.bigEndian) { return false; } - return Arrays.areEqual(this.bytes, that.bytes); + return Arrays.equals(this.bytes, that.bytes); } /** diff --git a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsPluginScreenShots.java b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsPluginScreenShots.java index 458ceed800..803116cc5c 100644 --- a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsPluginScreenShots.java +++ b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsPluginScreenShots.java @@ -137,6 +137,18 @@ public class DebuggerBreakpointsPluginScreenShots extends GhidraScreenShotGenera new DefaultTraceLocation(trace3, null, Lifespan.nowOn(0), addr(trace3, 0x7fac0000)), new ProgramLocation(program, addr(program, 0x00400000)), 0x00010000, false); } + waitForSwing(); + + try (UndoableTransaction tid = UndoableTransaction.start(program, "Add breakpoint")) { + program.getBookmarkManager() + .setBookmark(addr(program, 0x00401234), + LogicalBreakpoint.BREAKPOINT_ENABLED_BOOKMARK_TYPE, "SW_EXECUTE;1", + "before connect"); + program.getBookmarkManager() + .setBookmark(addr(program, 0x00604321), + LogicalBreakpoint.BREAKPOINT_ENABLED_BOOKMARK_TYPE, "WRITE;4", + "write version"); + } TargetBreakpointSpecContainer bc1 = waitFor(() -> Unique.assertAtMostOne(recorder1.collectBreakpointContainers(null)), @@ -156,17 +168,6 @@ public class DebuggerBreakpointsPluginScreenShots extends GhidraScreenShotGenera trace3.getBreakpointManager() .getBreakpointsAt(recorder3.getSnap(), addr(trace3, 0x7fac1234)))); - try (UndoableTransaction tid = UndoableTransaction.start(program, "Add breakpoint")) { - program.getBookmarkManager() - .setBookmark(addr(program, 0x00401234), - LogicalBreakpoint.BREAKPOINT_ENABLED_BOOKMARK_TYPE, "SW_EXECUTE;1", - "before connect"); - program.getBookmarkManager() - .setBookmark(addr(program, 0x00604321), - LogicalBreakpoint.BREAKPOINT_ENABLED_BOOKMARK_TYPE, "WRITE;4", - "write version"); - } - waitForPass(() -> { Set allBreakpoints = breakpointService.getAllBreakpoints(); assertEquals(2, allBreakpoints.size()); diff --git a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackPluginScreenShots.java b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackPluginScreenShots.java index 953847f7e8..0ca315d77c 100644 --- a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackPluginScreenShots.java +++ b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/DebuggerStackPluginScreenShots.java @@ -38,7 +38,6 @@ import ghidra.app.plugin.core.debug.stack.*; import ghidra.app.plugin.core.progmgr.ProgramManagerPlugin; import ghidra.app.services.*; import ghidra.app.services.DebuggerEmulationService.EmulationResult; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.DebuggerStateEditingService.StateEditor; import ghidra.async.AsyncTestUtils; import ghidra.framework.model.DomainFolder; @@ -297,7 +296,7 @@ public class DebuggerStackPluginScreenShots extends GhidraScreenShotGenerator traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); DebuggerCoordinates atSetup = traceManager.getCurrent(); diff --git a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/vars/VariableValueHoverPluginScreenShots.java b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/vars/VariableValueHoverPluginScreenShots.java index 109fedbd0a..faffaefba5 100644 --- a/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/vars/VariableValueHoverPluginScreenShots.java +++ b/Ghidra/Debug/Debugger/src/screen/java/ghidra/app/plugin/core/debug/gui/stack/vars/VariableValueHoverPluginScreenShots.java @@ -45,7 +45,6 @@ import ghidra.app.plugin.core.decompile.DecompilerProvider; import ghidra.app.plugin.core.progmgr.ProgramManagerPlugin; import ghidra.app.services.*; import ghidra.app.services.DebuggerEmulationService.EmulationResult; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.DebuggerStateEditingService.StateEditor; import ghidra.app.util.viewer.listingpanel.ListingPanel; import ghidra.async.AsyncTestUtils; @@ -259,7 +258,7 @@ public class VariableValueHoverPluginScreenShots extends GhidraScreenShotGenerat } waitForDomainObject(tb.trace); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); DebuggerCoordinates atSetup = traceManager.getCurrent(); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/disassemble/DebuggerDisassemblyTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/disassemble/DebuggerDisassemblyTest.java index 2786eb68b2..9c76cad603 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/disassemble/DebuggerDisassemblyTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/disassemble/DebuggerDisassemblyTest.java @@ -39,7 +39,6 @@ import ghidra.app.plugin.core.debug.service.platform.DebuggerPlatformServicePlug import ghidra.app.plugin.core.debug.service.workflow.DebuggerWorkflowServiceProxyPlugin; import ghidra.app.plugin.core.debug.workflow.DisassembleAtPcDebuggerBot; import ghidra.app.services.*; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.dbg.target.TargetEnvironment; import ghidra.dbg.target.schema.SchemaContext; import ghidra.dbg.target.schema.TargetObjectSchema.SchemaName; @@ -411,7 +410,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest createLegacyTrace("ARM:LE:32:v8", 0x00400000, () -> tb.buf(0x00, 0x00, 0x00, 0x00)); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, null, 0)); @@ -444,7 +443,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest // Don't cheat here and choose v8T! createLegacyTrace("ARM:LE:32:v8", 0x00400000, () -> tb.buf(0x00, 0x00)); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, null, 0)); @@ -481,7 +480,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest TraceObjectThread thread = createPolyglotTrace("armv8le", 0x00400000, () -> tb.buf(0x00, 0x00, 0x00, 0x00)); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, thread.getObject(), 0)); @@ -516,7 +515,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest TraceObjectThread thread = createPolyglotTrace("armv8le", 0x00400000, () -> tb.buf(0x00, 0x00)); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, thread.getObject(), 0)); @@ -573,7 +572,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest createLegacyTrace("ARM:LE:32:v8", 0x00400000, () -> tb.buf()); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, null, 0)); @@ -593,7 +592,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest TraceObjectThread thread = createPolyglotTrace("armv8le", 0x00400000, () -> tb.buf()); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, thread.getObject(), 0)); @@ -613,7 +612,7 @@ public class DebuggerDisassemblyTest extends AbstractGhidraHeadedDebuggerGUITest TraceObjectThread thread = createPolyglotTrace("armv8le", 0x00400000, () -> tb.buf()); Address start = tb.addr(0x00400000); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); // Ensure the mapper is added to the trace assertNotNull(platformService.getMapper(tb.trace, thread.getObject(), 0)); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/AbstractGhidraHeadedDebuggerGUITest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/AbstractGhidraHeadedDebuggerGUITest.java index d4f7a275b6..9b07978308 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/AbstractGhidraHeadedDebuggerGUITest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/AbstractGhidraHeadedDebuggerGUITest.java @@ -269,6 +269,24 @@ public abstract class AbstractGhidraHeadedDebuggerGUITest }, () -> lastError.get().getMessage()); } + public static T waitForPass(Supplier supplier) { + var locals = new Object() { + AssertionError lastError; + T value; + }; + waitForCondition(() -> { + try { + locals.value = supplier.get(); + return true; + } + catch (AssertionError e) { + locals.lastError = e; + return false; + } + }, () -> locals.lastError.getMessage()); + return locals.value; + } + protected static Set getMenuElementsText(MenuElement menu) { Set result = new HashSet<>(); for (MenuElement sub : menu.getSubElements()) { diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPluginTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPluginTest.java index c74c63eda0..45edec6ed1 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPluginTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointMarkerPluginTest.java @@ -455,8 +455,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu } waitForDomainObject(program); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - staticCtx(addr(program, 0x00400123)), false); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, false); DebuggerPlaceBreakpointDialog dialog = waitForDialogComponent(DebuggerPlaceBreakpointDialog.class); runSwing(() -> dialog.okCallback()); @@ -482,8 +483,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu } waitForDomainObject(program); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - staticCtx(addr(program, 0x00400123)), false); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, false); DebuggerPlaceBreakpointDialog dialog = waitForDialogComponent(DebuggerPlaceBreakpointDialog.class); runSwing(() -> dialog.okCallback()); @@ -502,13 +504,14 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu addMappedBreakpointOpenAndWait(); LogicalBreakpoint lb = Unique.assertOne(breakpointService.getAllBreakpoints()); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - staticCtx(addr(program, 0x00400123)), false); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, false); waitForPass(() -> assertEquals(State.DISABLED, lb.computeState())); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - staticCtx(addr(program, 0x00400123)), false); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, false); waitForPass(() -> assertEquals(State.ENABLED, lb.computeState())); } @@ -522,13 +525,14 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu // NB. addMappedBreakpointOpenAndWait already makes this assertion. Just a reminder: waitForPass(() -> assertEquals(State.ENABLED, lb.computeStateForTrace(trace))); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + ProgramLocationActionContext ctx = dynamicCtx(trace, addr(trace, 0x55550123)); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.DISABLED, lb.computeStateForTrace(trace))); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.ENABLED, lb.computeStateForTrace(trace))); @@ -538,8 +542,8 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu lb.disableForProgram(); waitForPass(() -> assertEquals(State.INCONSISTENT_ENABLED, lb.computeStateForTrace(trace))); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, true); // NB. toggling from dynamic view, this toggles trace bpt, not logical/program bpt waitForPass(() -> assertEquals(State.DISABLED, lb.computeStateForTrace(trace))); @@ -548,8 +552,8 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu waitForPass( () -> assertEquals(State.INCONSISTENT_DISABLED, lb.computeStateForTrace(trace))); - performAction(breakpointMarkerPlugin.actionToggleBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + assertTrue(breakpointMarkerPlugin.actionToggleBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionToggleBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.ENABLED, lb.computeStateForTrace(trace))); } @@ -558,7 +562,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu Set expectedKinds) throws Throwable { addMappedBreakpointOpenAndWait(); // Adds an unneeded breakpoint. Aw well. - performAction(action, staticCtx(addr(program, 0x0400321)), false); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x0400321)); + assertTrue(action.isAddToPopup(ctx)); + performAction(action, ctx, false); DebuggerPlaceBreakpointDialog dialog = waitForDialogComponent(DebuggerPlaceBreakpointDialog.class); runSwing(() -> { @@ -580,7 +586,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu TraceRecorder recorder = addMappedBreakpointOpenAndWait(); // Adds an unneeded breakpoint. Aw well. Trace trace = recorder.getTrace(); - performAction(action, dynamicCtx(trace, addr(trace, 0x55550321)), false); + ProgramLocationActionContext ctx = dynamicCtx(trace, addr(trace, 0x55550321)); + assertTrue(action.isAddToPopup(ctx)); + performAction(action, ctx, false); DebuggerPlaceBreakpointDialog dialog = waitForDialogComponent(DebuggerPlaceBreakpointDialog.class); runSwing(() -> dialog.okCallback()); @@ -664,8 +672,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu lb.disable(); waitForPass(() -> assertEquals(State.DISABLED, lb.computeState())); - performAction(breakpointMarkerPlugin.actionEnableBreakpoint, - staticCtx(addr(program, 0x00400123)), true); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionEnableBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionEnableBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.ENABLED, lb.computeState())); } @@ -678,8 +687,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu lb.disable(); waitForPass(() -> assertEquals(State.DISABLED, lb.computeState())); - performAction(breakpointMarkerPlugin.actionEnableBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + ProgramLocationActionContext ctx = dynamicCtx(trace, addr(trace, 0x55550123)); + assertTrue(breakpointMarkerPlugin.actionEnableBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionEnableBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.ENABLED, lb.computeStateForTrace(trace))); // TODO: Same test but with multiple traces @@ -690,8 +700,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu addMappedBreakpointOpenAndWait(); LogicalBreakpoint lb = Unique.assertOne(breakpointService.getAllBreakpoints()); - performAction(breakpointMarkerPlugin.actionDisableBreakpoint, - staticCtx(addr(program, 0x00400123)), true); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionDisableBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionDisableBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.DISABLED, lb.computeState())); } @@ -702,8 +713,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu Trace trace = recorder.getTrace(); LogicalBreakpoint lb = Unique.assertOne(breakpointService.getAllBreakpoints()); - performAction(breakpointMarkerPlugin.actionDisableBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + ProgramLocationActionContext ctx = dynamicCtx(trace, addr(trace, 0x55550123)); + assertTrue(breakpointMarkerPlugin.actionDisableBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionDisableBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.DISABLED, lb.computeStateForTrace(trace))); // TODO: Same test but with multiple traces @@ -713,8 +725,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu public void testActionClearBreakpointProgram() throws Throwable { addMappedBreakpointOpenAndWait(); - performAction(breakpointMarkerPlugin.actionClearBreakpoint, - staticCtx(addr(program, 0x00400123)), true); + ProgramLocationActionContext ctx = staticCtx(addr(program, 0x00400123)); + assertTrue(breakpointMarkerPlugin.actionClearBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionClearBreakpoint, ctx, true); waitForPass(() -> assertTrue(breakpointService.getAllBreakpoints().isEmpty())); } @@ -725,8 +738,9 @@ public class DebuggerBreakpointMarkerPluginTest extends AbstractGhidraHeadedDebu Trace trace = recorder.getTrace(); LogicalBreakpoint lb = Unique.assertOne(breakpointService.getAllBreakpoints()); - performAction(breakpointMarkerPlugin.actionClearBreakpoint, - dynamicCtx(trace, addr(trace, 0x55550123)), true); + ProgramLocationActionContext ctx = dynamicCtx(trace, addr(trace, 0x55550123)); + assertTrue(breakpointMarkerPlugin.actionClearBreakpoint.isAddToPopup(ctx)); + performAction(breakpointMarkerPlugin.actionClearBreakpoint, ctx, true); waitForPass(() -> assertEquals(State.NONE, lb.computeStateForTrace(trace))); // TODO: Same test but with multiple traces diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderObjectTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderObjectTest.java index 6ebabf53af..592d1bf08a 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderObjectTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderObjectTest.java @@ -24,6 +24,7 @@ import ghidra.dbg.target.schema.SchemaContext; import ghidra.dbg.target.schema.TargetObjectSchema.SchemaName; import ghidra.dbg.target.schema.XmlSchemaContext; import ghidra.trace.model.Trace; +import ghidra.trace.model.target.TraceObjectKeyPath; import ghidra.util.database.UndoableTransaction; @Category(NightlyCategory.class) @@ -57,46 +58,58 @@ public class DebuggerBreakpointsProviderObjectTest extends DebuggerBreakpointsPr // NOTE the use of index='...' allowing object-based managers to ID unique path // TODO: I guess this'll burn down if the naming scheme changes.... int index = tb.trace.getName().startsWith("[3]") ? 3 : 1; - ctx = XmlSchemaContext.deserialize("" + // - "" + // - " " + // - " " + // - " " + // - " " + // - " " + // <---- NOTE HERE - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - ""); + ctx = XmlSchemaContext.deserialize(String.format(""" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + """, index)); try (UndoableTransaction tid = tb.startTransaction()) { tb.trace.getObjectManager().createRootObject(ctx.getSchema(new SchemaName("Session"))); + tb.trace.getObjectManager() + .createObject( + TraceObjectKeyPath.of("Processes", "[" + index + "]", "Breakpoints")); } } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderTest.java index 76bf66db00..5e5d438475 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/breakpoint/DebuggerBreakpointsProviderTest.java @@ -34,6 +34,8 @@ import ghidra.app.plugin.core.debug.gui.AbstractGhidraHeadedDebuggerGUITest; import ghidra.app.plugin.core.debug.gui.DebuggerResources.*; import ghidra.app.plugin.core.debug.gui.breakpoint.DebuggerBreakpointsProvider.LogicalBreakpointTableModel; import ghidra.app.plugin.core.debug.gui.console.DebuggerConsolePlugin; +import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; +import ghidra.app.plugin.core.debug.service.emulation.ProgramEmulationUtils; import ghidra.app.plugin.core.debug.service.modules.DebuggerStaticMappingUtils; import ghidra.app.services.*; import ghidra.app.services.LogicalBreakpoint.State; @@ -41,12 +43,14 @@ import ghidra.dbg.model.TestTargetProcess; import ghidra.dbg.target.TargetBreakpointSpec.TargetBreakpointKind; import ghidra.dbg.target.TargetBreakpointSpecContainer; import ghidra.framework.store.LockException; +import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressOverflowException; import ghidra.program.model.listing.Program; import ghidra.program.model.mem.MemoryConflictException; import ghidra.program.util.ProgramLocation; import ghidra.trace.model.*; import ghidra.trace.model.breakpoint.TraceBreakpoint; +import ghidra.trace.model.time.TraceSnapshot; import ghidra.util.SystemUtilities; import ghidra.util.database.UndoableTransaction; import ghidra.util.exception.CancelledException; @@ -682,4 +686,110 @@ public class DebuggerBreakpointsProviderTest extends AbstractGhidraHeadedDebugge // NOTE: With no selection, no actions (even table built-in) apply, so no menu } + + @Test + public void testEmuBreakpointState() throws Throwable { + addPlugin(tool, DebuggerStateEditingServicePlugin.class); + + createProgram(); + intoProject(program); + programManager.openProgram(program); + waitForSwing(); + + addStaticMemoryAndBreakpoint(); + waitForProgram(program); + + LogicalBreakpointRow row = waitForValue( + () -> Unique.assertAtMostOne(breakpointsProvider.breakpointTableModel.getModelData())); + assertEquals(State.INEFFECTIVE_ENABLED, row.getState()); + + // Do our own launch, so that object mode is enabled during load (region creation) + createTrace(program.getLanguageID().getIdAsString()); + try (UndoableTransaction startTransaction = tb.startTransaction()) { + TraceSnapshot initial = tb.trace.getTimeManager().getSnapshot(0, true); + ProgramEmulationUtils.loadExecutable(initial, program); + Address pc = program.getMinAddress(); + ProgramEmulationUtils.doLaunchEmulationThread(tb.trace, 0, program, pc, pc); + } + + traceManager.openTrace(tb.trace); + traceManager.activateTrace(tb.trace); + waitForSwing(); + waitOn(mappingService.changesSettled()); + waitOn(breakpointService.changesSettled()); + waitForSwing(); + + row = waitForValue( + () -> Unique.assertAtMostOne(breakpointsProvider.breakpointTableModel.getModelData())); + assertEquals(State.INEFFECTIVE_ENABLED, row.getState()); + + row.setEnabled(true); + waitForSwing(); + + row = waitForValue( + () -> Unique.assertAtMostOne(breakpointsProvider.breakpointTableModel.getModelData())); + assertEquals(State.ENABLED, row.getState()); + } + + @Test + public void testTablesAndStatesWhenhModeChanges() throws Throwable { + DebuggerStateEditingService editingService = + addPlugin(tool, DebuggerStateEditingServicePlugin.class); + + createTestModel(); + mb.createTestProcessesAndThreads(); + TraceRecorder recorder = modelService.recordTarget(mb.testProcess1, + createTargetTraceMapper(mb.testProcess1), ActionSource.AUTOMATIC); + Trace trace = recorder.getTrace(); + createProgramFromTrace(trace); + intoProject(trace); + intoProject(program); + + mb.testProcess1.addRegion("bin:.text", mb.rng(0x55550000, 0x55550fff), "rx"); + waitRecorder(recorder); + addMapping(trace, program); + addStaticMemoryAndBreakpoint(); + programManager.openProgram(program); + traceManager.openTrace(trace); + waitForSwing(); + + LogicalBreakpointRow lbRow1 = waitForPass(() -> { + LogicalBreakpointRow newRow = + Unique.assertOne(breakpointsProvider.breakpointTableModel.getModelData()); + LogicalBreakpoint lb = newRow.getLogicalBreakpoint(); + assertEquals(program, lb.getProgram()); + assertEquals(Set.of(trace), lb.getMappedTraces()); + assertEquals(Set.of(), lb.getParticipatingTraces()); + assertEquals(State.INEFFECTIVE_ENABLED, newRow.getState()); + return newRow; + }); + + editingService.setCurrentMode(trace, StateEditingMode.RW_EMULATOR); + lbRow1.setEnabled(true); + TraceBreakpoint emuBpt = waitForValue( + () -> Unique.assertAtMostOne(trace.getBreakpointManager().getAllBreakpoints())); + assertNull(recorder.getTargetBreakpoint(emuBpt)); + + LogicalBreakpointRow lbRow2 = + Unique.assertOne(breakpointsProvider.breakpointTableModel.getModelData()); + waitForPass(() -> assertEquals(State.ENABLED, lbRow2.getState())); + + waitForPass(() -> { + BreakpointLocationRow newRow = + Unique.assertOne(breakpointsProvider.locationTableModel.getModelData()); + assertEquals(State.ENABLED, newRow.getState()); + }); + + for (int i = 0; i < 3; i++) { + editingService.setCurrentMode(trace, StateEditingMode.RO_TARGET); + waitOn(breakpointService.changesSettled()); + waitForSwing(); + assertEquals(0, breakpointsProvider.locationTableModel.getModelData().size()); + + editingService.setCurrentMode(trace, StateEditingMode.RW_EMULATOR); + waitOn(breakpointService.changesSettled()); + waitForSwing(); + assertEquals(1, breakpointsProvider.locationTableModel.getModelData().size()); + } + } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPluginTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPluginTest.java index e3b7952eb4..5e045bf9df 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPluginTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/control/DebuggerControlPluginTest.java @@ -48,7 +48,6 @@ import ghidra.app.plugin.core.debug.service.emulation.DebuggerEmulationServicePl import ghidra.app.services.*; import ghidra.app.services.DebuggerEmulationService.CachedEmulator; import ghidra.app.services.DebuggerEmulationService.EmulationResult; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.dbg.model.*; import ghidra.dbg.target.TargetObject; import ghidra.dbg.target.TargetSteppable.TargetStepKind; @@ -73,8 +72,8 @@ import ghidra.util.database.UndoableTransaction; * *

    * In these and other machine-state-editing integration tests, we use - * {@link StateEditingMode#WRITE_EMULATOR} as a stand-in for any mode. We also use - * {@link StateEditingMode#READ_ONLY} just to verify the mode is heeded. Other modes may be tested + * {@link StateEditingMode#RW_EMULATOR} as a stand-in for any mode. We also use + * {@link StateEditingMode#RO_TARGET} just to verify the mode is heeded. Other modes may be tested * if bugs crop up in various combinations. */ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITest { @@ -294,7 +293,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testEmulateResumeAction() throws Throwable { TraceThread thread = createToyLoopTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); traceManager.activateThread(thread); waitForSwing(); @@ -311,7 +310,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testEmulateInterruptAction() throws Throwable { TraceThread thread = createToyLoopTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); traceManager.activateThread(thread); waitForSwing(); @@ -333,7 +332,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testEmulateStepBackAction() throws Throwable { TraceThread thread = createToyLoopTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); traceManager.activateThread(thread); waitForSwing(); @@ -352,7 +351,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testEmulateStepIntoAction() throws Throwable { TraceThread thread = createToyLoopTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); traceManager.activateThread(thread); waitForSwing(); @@ -365,7 +364,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testEmulateSkipOverAction() throws Throwable { TraceThread thread = createToyLoopTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); traceManager.activateThread(thread); waitForSwing(); @@ -386,7 +385,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testTraceSnapBackwardAction() throws Throwable { create2SnapTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); traceManager.activateTrace(tb.trace); waitForSwing(); @@ -403,7 +402,7 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe @Test public void testTraceSnapForwardAction() throws Throwable { create2SnapTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); traceManager.activateTrace(tb.trace); waitForSwing(); @@ -444,14 +443,14 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe assertTrue(controlPlugin.actionEditMode.isEnabled()); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.READ_ONLY)); - assertEquals(StateEditingMode.READ_ONLY, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RO_TARGET)); + assertEquals(StateEditingMode.RO_TARGET, editingService.getCurrentMode(tb.trace)); assertFalse( helper.patchInstructionAction.isAddToPopup(listingProvider.getActionContext(null))); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.WRITE_EMULATOR)); - assertEquals(StateEditingMode.WRITE_EMULATOR, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RW_EMULATOR)); + assertEquals(StateEditingMode.RW_EMULATOR, editingService.getCurrentMode(tb.trace)); assertTrue( helper.patchInstructionAction.isAddToPopup(listingProvider.getActionContext(null))); @@ -494,13 +493,13 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe assertTrue(controlPlugin.actionEditMode.isEnabled()); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.READ_ONLY)); - assertEquals(StateEditingMode.READ_ONLY, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RO_TARGET)); + assertEquals(StateEditingMode.RO_TARGET, editingService.getCurrentMode(tb.trace)); assertFalse(helper.patchDataAction.isAddToPopup(listingProvider.getActionContext(null))); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.WRITE_EMULATOR)); - assertEquals(StateEditingMode.WRITE_EMULATOR, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RW_EMULATOR)); + assertEquals(StateEditingMode.RW_EMULATOR, editingService.getCurrentMode(tb.trace)); goTo(listingProvider.getListingPanel(), new ProgramLocation(view, tb.addr(0x00400123))); assertTrue(helper.patchDataAction.isAddToPopup(listingProvider.getActionContext(null))); @@ -545,15 +544,15 @@ public class DebuggerControlPluginTest extends AbstractGhidraHeadedDebuggerGUITe assertTrue(controlPlugin.actionEditMode.isEnabled()); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.READ_ONLY)); - assertEquals(StateEditingMode.READ_ONLY, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RO_TARGET)); + assertEquals(StateEditingMode.RO_TARGET, editingService.getCurrentMode(tb.trace)); ctx = listingProvider.getActionContext(null); assertTrue(pasteAction.isAddToPopup(ctx)); assertFalse(pasteAction.isEnabledForContext(ctx)); runSwing(() -> controlPlugin.actionEditMode - .setCurrentActionStateByUserData(StateEditingMode.WRITE_EMULATOR)); - assertEquals(StateEditingMode.WRITE_EMULATOR, editingService.getCurrentMode(tb.trace)); + .setCurrentActionStateByUserData(StateEditingMode.RW_EMULATOR)); + assertEquals(StateEditingMode.RW_EMULATOR, editingService.getCurrentMode(tb.trace)); goTo(listingPlugin.getListingPanel(), new ProgramLocation(view, tb.addr(0x00400123))); ctx = listingProvider.getActionContext(null); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java index 90856c40c3..f98fcdf479 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java @@ -49,9 +49,7 @@ import ghidra.app.plugin.core.debug.gui.DebuggerResources.FollowsCurrentThreadAc import ghidra.app.plugin.core.debug.gui.action.*; import ghidra.app.plugin.core.debug.gui.listing.DebuggerListingPlugin; import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; -import ghidra.app.services.DebuggerStateEditingService; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; -import ghidra.app.services.TraceRecorder; +import ghidra.app.services.*; import ghidra.async.SwingExecutorService; import ghidra.program.model.address.*; import ghidra.program.model.lang.Register; @@ -510,6 +508,7 @@ public class DebuggerMemoryBytesProviderTest extends AbstractGhidraHeadedDebugge * Assure ourselves the block under test is not on screen */ waitForPass(() -> { + goToDyn(addr(trace, 0x55551800)); AddressSetView visible = memBytesProvider.readsMemTrait.getVisible(); assertFalse(visible.isEmpty()); assertFalse(visible.contains(addr(trace, 0x55550000))); @@ -1101,10 +1100,11 @@ public class DebuggerMemoryBytesProviderTest extends AbstractGhidraHeadedDebugge createTargetTraceMapper(mb.testProcess1)); Trace trace = recorder.getTrace(); - editingService.setCurrentMode(trace, StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(trace, StateEditingMode.RW_TARGET); DockingActionIf actionEdit = getAction(memBytesPlugin, "Enable/Disable Byteviewer Editing"); mb.testProcess1.addRegion("exe:.text", mb.rng(0x55550000, 0x5555ffff), "rx"); + waitRecorder(recorder); waitFor(() -> !trace.getMemoryManager().getAllRegions().isEmpty()); byte[] data = new byte[4]; @@ -1132,12 +1132,17 @@ public class DebuggerMemoryBytesProviderTest extends AbstractGhidraHeadedDebugge createTargetTraceMapper(mb.testProcess1)); Trace trace = recorder.getTrace(); - editingService.setCurrentMode(trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(trace, StateEditingMode.RW_TRACE); DockingActionIf actionEdit = getAction(memBytesPlugin, "Enable/Disable Byteviewer Editing"); mb.testProcess1.addRegion("exe:.text", mb.rng(0x55550000, 0x5555ffff), "rx"); + waitRecorder(recorder); waitFor(() -> !trace.getMemoryManager().getAllRegions().isEmpty()); + // Because mode is RW_TRACE, we're not necessarily at recorder's snap + traceManager.activateSnap(recorder.getSnap()); + waitForSwing(); + byte[] data = new byte[4]; performAction(actionEdit); waitForPass(noExc(() -> { @@ -1174,7 +1179,7 @@ public class DebuggerMemoryBytesProviderTest extends AbstractGhidraHeadedDebugge createTargetTraceMapper(mb.testProcess1)); Trace trace = recorder.getTrace(); - editingService.setCurrentMode(trace, StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(trace, StateEditingMode.RW_TARGET); mb.testProcess1.addRegion("exe:.text", mb.rng(0x55550000, 0x5555ffff), "rx"); waitFor(() -> !trace.getMemoryManager().getAllRegions().isEmpty()); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/register/DebuggerRegistersProviderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/register/DebuggerRegistersProviderTest.java index e738cdb0ac..09c3c79d59 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/register/DebuggerRegistersProviderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/register/DebuggerRegistersProviderTest.java @@ -33,9 +33,7 @@ import ghidra.app.plugin.core.debug.gui.listing.DebuggerListingPlugin; import ghidra.app.plugin.core.debug.gui.register.DebuggerRegistersProvider.RegisterDataSettingsDialog; import ghidra.app.plugin.core.debug.gui.register.DebuggerRegistersProvider.RegisterTableColumns; import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; -import ghidra.app.services.DebuggerStateEditingService; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; -import ghidra.app.services.TraceRecorder; +import ghidra.app.services.*; import ghidra.docking.settings.FormatSettingsDefinition; import ghidra.docking.settings.Settings; import ghidra.program.model.address.AddressSpace; @@ -385,7 +383,7 @@ public class DebuggerRegistersProviderTest extends AbstractGhidraHeadedDebuggerG activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); assertTrue(registersProvider.actionEnableEdits.isEnabled()); performAction(registersProvider.actionEnableEdits); @@ -423,7 +421,7 @@ public class DebuggerRegistersProviderTest extends AbstractGhidraHeadedDebuggerG activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); assertTrue(registersProvider.actionEnableEdits.isEnabled()); performAction(registersProvider.actionEnableEdits); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderLegacyTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderLegacyTest.java index 7d8f1256c5..0bc41451c9 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderLegacyTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderLegacyTest.java @@ -28,12 +28,10 @@ import org.junit.experimental.categories.Category; import generic.test.category.NightlyCategory; import ghidra.app.plugin.core.debug.gui.AbstractGhidraHeadedDebuggerGUITest; import ghidra.app.plugin.core.debug.gui.thread.DebuggerLegacyThreadsPanel.ThreadTableColumns; -import ghidra.app.services.TraceRecorder; import ghidra.trace.model.Lifespan; import ghidra.trace.model.Trace; import ghidra.trace.model.thread.TraceThread; import ghidra.trace.model.thread.TraceThreadManager; -import ghidra.trace.model.time.TraceSnapshot; import ghidra.trace.model.time.TraceTimeManager; import ghidra.util.database.UndoableTransaction; @@ -400,53 +398,4 @@ public class DebuggerThreadsProviderLegacyTest extends AbstractGhidraHeadedDebug assertEquals(6, threadsProvider.legacyPanel.headerRenderer.getCursorPosition().longValue()); } - @Test - public void testActionSeekTracePresent() throws Exception { - assertTrue(threadsProvider.actionSeekTracePresent.isSelected()); - - createAndOpenTrace(); - addThreads(); - traceManager.activateTrace(tb.trace); - waitForSwing(); - - assertEquals(0, traceManager.getCurrentSnap()); - - try (UndoableTransaction tid = tb.startTransaction()) { - tb.trace.getTimeManager().createSnapshot("Next snapshot"); - } - waitForDomainObject(tb.trace); - - // Not live, so no seek - assertEquals(0, traceManager.getCurrentSnap()); - - tb.close(); - - createTestModel(); - mb.createTestProcessesAndThreads(); - // Threads needs registers to be recognized by the recorder - mb.createTestThreadRegisterBanks(); - - TraceRecorder recorder = modelService.recordTargetAndActivateTrace(mb.testProcess1, - createTargetTraceMapper(mb.testProcess1)); - Trace trace = recorder.getTrace(); - - // Wait till two threads are observed in the database - waitForPass(() -> assertEquals(2, trace.getThreadManager().getAllThreads().size())); - waitForSwing(); - - TraceSnapshot snapshot = recorder.forceSnapshot(); - waitForDomainObject(trace); - - assertEquals(snapshot.getKey(), traceManager.getCurrentSnap()); - - performAction(threadsProvider.actionSeekTracePresent); - waitForSwing(); - - assertFalse(threadsProvider.actionSeekTracePresent.isSelected()); - - recorder.forceSnapshot(); - waitForSwing(); - - assertEquals(snapshot.getKey(), traceManager.getCurrentSnap()); - } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderTest.java index 8e08331c40..4e77bac93e 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/thread/DebuggerThreadsProviderTest.java @@ -31,13 +31,13 @@ import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.gui.AbstractGhidraHeadedDebuggerGUITest; import ghidra.app.plugin.core.debug.gui.model.ObjectTableModel; import ghidra.app.plugin.core.debug.gui.model.ObjectTableModel.*; +import ghidra.app.plugin.core.debug.gui.model.QueryPanelTestHelper; import ghidra.app.plugin.core.debug.mapping.DebuggerTargetTraceMapper; import ghidra.app.plugin.core.debug.mapping.ObjectBasedDebuggerTargetTraceMapper; -import ghidra.app.plugin.core.debug.gui.model.QueryPanelTestHelper; import ghidra.app.services.TraceRecorder; import ghidra.dbg.target.TargetExecutionStateful; -import ghidra.dbg.target.TargetObject; import ghidra.dbg.target.TargetExecutionStateful.TargetExecutionState; +import ghidra.dbg.target.TargetObject; import ghidra.dbg.target.schema.SchemaContext; import ghidra.dbg.target.schema.TargetObjectSchema.SchemaName; import ghidra.dbg.target.schema.XmlSchemaContext; @@ -51,7 +51,6 @@ import ghidra.trace.model.target.TraceObject.ConflictResolution; import ghidra.trace.model.target.TraceObjectKeyPath; import ghidra.trace.model.target.TraceObjectManager; import ghidra.trace.model.thread.TraceObjectThread; -import ghidra.trace.model.time.TraceSnapshot; import ghidra.trace.model.time.TraceTimeManager; import ghidra.util.database.UndoableTransaction; import ghidra.util.table.GhidraTable; @@ -564,52 +563,4 @@ public class DebuggerThreadsProviderTest extends AbstractGhidraHeadedDebuggerGUI waitForPass(() -> assertEquals(Long.valueOf(6), renderer.getCursorPosition())); } - - @Test - public void testActionSeekTracePresent() throws Throwable { - assertTrue(provider.actionSeekTracePresent.isSelected()); - - createAndOpenTrace(); - addThreads(); - traceManager.activateTrace(tb.trace); - waitForTasks(); - - assertEquals(0, traceManager.getCurrentSnap()); - - try (UndoableTransaction tid = tb.startTransaction()) { - tb.trace.getTimeManager().createSnapshot("Next snapshot"); - } - waitForDomainObject(tb.trace); - waitForTasks(); - - // Not live, so no seek - waitForPass(() -> assertEquals(0, traceManager.getCurrentSnap())); - - tb.close(); - - createTestModel(); - mb.createTestProcessesAndThreads(); - // Threads needs registers to be recognized by the recorder - mb.createTestThreadRegisterBanks(); - - TraceRecorder recorder = recordAndWaitSync(); - traceManager.openTrace(tb.trace); - traceManager.activateTrace(tb.trace); - - TraceSnapshot snapshot = recorder.forceSnapshot(); - waitForDomainObject(tb.trace); - waitForTasks(); - - waitForPass(() -> assertEquals(snapshot.getKey(), traceManager.getCurrentSnap())); - - performEnabledAction(provider, provider.actionSeekTracePresent, true); - waitForTasks(); - - assertFalse(provider.actionSeekTracePresent.isSelected()); - - recorder.forceSnapshot(); - waitForTasks(); - - waitForPass(() -> assertEquals(snapshot.getKey(), traceManager.getCurrentSnap())); - } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/watch/DebuggerWatchesProviderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/watch/DebuggerWatchesProviderTest.java index 70a6b01b67..0b5e8da716 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/watch/DebuggerWatchesProviderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/gui/watch/DebuggerWatchesProviderTest.java @@ -35,7 +35,6 @@ import ghidra.app.plugin.core.debug.gui.watch.DebuggerWatchesProvider.WatchDataS import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; import ghidra.app.plugin.core.debug.service.modules.DebuggerStaticMappingServicePlugin; import ghidra.app.services.*; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.dbg.model.TestTargetRegisterBankInThread; import ghidra.docking.settings.FormatSettingsDefinition; import ghidra.docking.settings.Settings; @@ -350,7 +349,7 @@ public class DebuggerWatchesProviderTest extends AbstractGhidraHeadedDebuggerGUI assertFalse(row.isRawValueEditable()); traceManager.openTrace(tb.trace); traceManager.activateThread(thread); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); waitForWatches(); assertNoErr(row); @@ -384,7 +383,7 @@ public class DebuggerWatchesProviderTest extends AbstractGhidraHeadedDebuggerGUI traceManager.openTrace(tb.trace); traceManager.activateThread(thread); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); waitForWatches(); performAction(watchesProvider.actionEnableEdits); @@ -547,7 +546,7 @@ public class DebuggerWatchesProviderTest extends AbstractGhidraHeadedDebuggerGUI traceManager.openTrace(trace); traceManager.activateThread(thread); - editingService.setCurrentMode(trace, StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(trace, StateEditingMode.RW_TARGET); waitForSwing(); performAction(watchesProvider.actionAdd); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceObjectTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceObjectTest.java index acee8c2a9a..dbe87dcc97 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceObjectTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceObjectTest.java @@ -21,6 +21,7 @@ import ghidra.dbg.target.schema.SchemaContext; import ghidra.dbg.target.schema.XmlSchemaContext; import ghidra.dbg.target.schema.TargetObjectSchema.SchemaName; import ghidra.trace.model.Trace; +import ghidra.trace.model.target.TraceObjectKeyPath; import ghidra.util.database.UndoableTransaction; public class DebuggerLogicalBreakpointServiceObjectTest @@ -54,46 +55,58 @@ public class DebuggerLogicalBreakpointServiceObjectTest // NOTE the use of index='...' allowing object-based managers to ID unique path // TODO: I guess this'll burn down if the naming scheme changes.... int index = tb.trace.getName().startsWith("[3]") ? 3 : 1; - ctx = XmlSchemaContext.deserialize("" + // - "" + // - " " + // - " " + // - " " + // - " " + // - " " + // <---- NOTE HERE - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - " " + // - ""); + ctx = XmlSchemaContext.deserialize(String.format(""" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + """, index)); try (UndoableTransaction tid = tb.startTransaction()) { tb.trace.getObjectManager().createRootObject(ctx.getSchema(new SchemaName("Session"))); + tb.trace.getObjectManager() + .createObject( + TraceObjectKeyPath.of("Processes", "[" + index + "]", "Breakpoints")); } } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceTest.java index e81e2856ba..291ac97444 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/breakpoint/DebuggerLogicalBreakpointServiceTest.java @@ -38,9 +38,10 @@ import ghidra.program.model.address.Address; import ghidra.program.model.listing.Bookmark; import ghidra.program.model.listing.Program; import ghidra.program.util.ProgramLocation; -import ghidra.trace.model.DefaultTraceLocation; -import ghidra.trace.model.Trace; +import ghidra.trace.database.ToyDBTraceBuilder; +import ghidra.trace.model.*; import ghidra.trace.model.breakpoint.*; +import ghidra.trace.model.memory.TraceMemoryFlag; import ghidra.trace.model.memory.TraceMemoryRegion; import ghidra.trace.model.modules.TraceStaticMapping; import ghidra.util.Msg; @@ -1552,4 +1553,125 @@ public class DebuggerLogicalBreakpointServiceTest extends AbstractGhidraHeadedDe waitForPass( () -> assertEquals(State.MIXED, lbEx.computeState().sameAdddress(lbRw.computeState()))); } + + protected void addTextMappingDead(Program p, ToyDBTraceBuilder tb) throws Throwable { + addProgramTextBlock(p); + try (UndoableTransaction tid = tb.startTransaction()) { + TraceMemoryRegion textRegion = tb.trace.getMemoryManager() + .addRegion("Processes[1].Memory[bin:.text]", Lifespan.nowOn(0), + tb.range(0x55550000, 0x55550fff), + Set.of(TraceMemoryFlag.READ, TraceMemoryFlag.EXECUTE)); + DebuggerStaticMappingUtils.addMapping( + new DefaultTraceLocation(tb.trace, null, textRegion.getLifespan(), + textRegion.getMinAddress()), + new ProgramLocation(p, addr(p, 0x00400000)), 0x1000, + false); + } + } + + protected void addEnabledProgramBreakpointWithSleigh(Program p) { + try (UndoableTransaction tid = + UndoableTransaction.start(p, "Create bookmark bp with sleigh")) { + enBm = p.getBookmarkManager() + .setBookmark(addr(p, 0x00400123), + LogicalBreakpoint.BREAKPOINT_ENABLED_BOOKMARK_TYPE, "SW_EXECUTE;1", + "{sleigh: 'r0=0xbeef;'}"); + } + } + + @Test + public void testMapThenAddProgramBreakpointWithSleighThenEnableOnTraceCopiesSleigh() + throws Throwable { + createTrace(); + traceManager.openTrace(tb.trace); + createProgramFromTrace(); + intoProject(program); + programManager.openProgram(program); + + addTextMappingDead(program, tb); + waitForSwing(); + + addEnabledProgramBreakpointWithSleigh(program); + LogicalBreakpoint lb = waitForValue(() -> Unique.assertAtMostOne( + breakpointService.getBreakpointsAt(program, addr(program, 0x00400123)))); + + assertEquals("r0=0xbeef;", lb.getEmuSleigh()); + + waitOn(lb.enable()); + waitForSwing(); + + TraceBreakpoint bpt = Unique.assertOne( + tb.trace.getBreakpointManager().getBreakpointsAt(0, tb.addr(0x55550123))); + assertEquals("r0=0xbeef;", bpt.getEmuSleigh()); + } + + @Test + public void testAddProgramBreakpointWithSleighThenMapThenEnableOnTraceCopiesSleigh() + throws Throwable { + createTrace(); + traceManager.openTrace(tb.trace); + createProgramFromTrace(); + intoProject(program); + programManager.openProgram(program); + + addEnabledProgramBreakpointWithSleigh(program); + LogicalBreakpoint lb = waitForValue(() -> Unique.assertAtMostOne( + breakpointService.getBreakpointsAt(program, addr(program, 0x00400123)))); + + assertEquals("r0=0xbeef;", lb.getEmuSleigh()); + + addTextMappingDead(program, tb); + lb = waitForPass(() -> { + LogicalBreakpoint newLb = Unique.assertOne( + breakpointService.getBreakpointsAt(program, addr(program, 0x00400123))); + assertTrue(newLb.getMappedTraces().contains(tb.trace)); + return newLb; + }); + + waitOn(lb.enable()); + waitForSwing(); + + TraceBreakpoint bpt = Unique.assertOne( + tb.trace.getBreakpointManager().getBreakpointsAt(0, tb.addr(0x55550123))); + assertEquals("r0=0xbeef;", bpt.getEmuSleigh()); + } + + @Test + public void testAddTraceBreakpointSetSleighThenMapThenSaveToProgramCopiesSleigh() + throws Throwable { + // TODO: What if already mapped? + // Not sure I care about tb.setEmuSleigh() out of band + + createTrace(); + traceManager.openTrace(tb.trace); + createProgramFromTrace(); + intoProject(program); + programManager.openProgram(program); + + try (UndoableTransaction tid = tb.startTransaction()) { + TraceBreakpoint bpt = tb.trace.getBreakpointManager() + .addBreakpoint("Processes[1].Breakpoints[0]", Lifespan.nowOn(0), + tb.addr(0x55550123), + Set.of(), Set.of(TraceBreakpointKind.SW_EXECUTE), + false /* emuEnabled defaults to true */, ""); + bpt.setEmuSleigh("r0=0xbeef;"); + } + LogicalBreakpoint lb = waitForValue(() -> Unique.assertAtMostOne( + breakpointService.getBreakpointsAt(tb.trace, tb.addr(0x55550123)))); + + assertEquals("r0=0xbeef;", lb.getEmuSleigh()); + + addTextMappingDead(program, tb); + lb = waitForPass(() -> { + LogicalBreakpoint newLb = Unique.assertOne( + breakpointService.getBreakpointsAt(program, addr(program, 0x00400123))); + assertTrue(newLb.getMappedTraces().contains(tb.trace)); + return newLb; + }); + + lb.enableForProgram(); + waitForSwing(); + + assertEquals("{\"sleigh\":\"r0\\u003d0xbeef;\"}", lb.getProgramBookmark().getComment()); + } } diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServiceTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServiceTest.java index eec650971e..142965fabf 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServiceTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/editing/DebuggerStateEditingServiceTest.java @@ -26,10 +26,8 @@ import org.junit.Test; import ghidra.app.plugin.assembler.*; import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.gui.AbstractGhidraHeadedDebuggerGUITest; -import ghidra.app.services.DebuggerStateEditingService; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; +import ghidra.app.services.*; import ghidra.app.services.DebuggerStateEditingService.StateEditor; -import ghidra.app.services.TraceRecorder; import ghidra.async.AsyncUtils.TemperamentalRunnable; import ghidra.dbg.target.TargetRegisterBank; import ghidra.program.model.lang.*; @@ -56,6 +54,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge protected void activateTrace() { traceManager.activateTrace(tb.trace); + waitForSwing(); } protected TracePlatform getPlatform() { @@ -105,7 +104,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge createAndOpenTrace(); activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); StateEditor editor = createStateEditor(); assertFalse(editor.isVariableEditable(tb.addr(0x00400000), 4)); @@ -117,7 +116,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuRegisterNoThreadErr() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); activateTrace(); waitForSwing(); @@ -132,7 +131,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuMemory() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); try (UndoableTransaction tid = tb.startTransaction()) { // NB. TraceManager should automatically activate the first thread @@ -158,7 +157,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuRegister() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); TraceThread thread; try (UndoableTransaction tid = tb.startTransaction()) { @@ -187,7 +186,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuMemoryAfterStep() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); try (UndoableTransaction tid = tb.startTransaction()) { // NB. TraceManager should automatically activate the first thread @@ -200,7 +199,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge tb.exec(getPlatform(), 0, thread, 0, "pc = 0x00400000;"); } activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); waitForSwing(); TraceSchedule step1 = TraceSchedule.parse("0:t0-1"); @@ -225,7 +224,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuRegisterAfterStep() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); TraceThread thread; try (UndoableTransaction tid = tb.startTransaction()) { @@ -239,7 +238,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge tb.exec(getPlatform(), 0, thread, 0, "pc = 0x00400000;"); } activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); waitForSwing(); TraceSchedule step1 = TraceSchedule.parse("0:t0-1"); @@ -265,7 +264,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuMemoryTwice() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); try (UndoableTransaction tid = tb.startTransaction()) { // NB. TraceManager should automatically activate the first thread @@ -294,7 +293,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge @Test public void testWriteEmuRegisterTwice() throws Throwable { createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_EMULATOR); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_EMULATOR); TraceThread thread; try (UndoableTransaction tid = tb.startTransaction()) { @@ -325,7 +324,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteTraceMemory() throws Throwable { // NB. Definitely no thread required createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); activateTrace(); waitForSwing(); @@ -348,7 +347,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteTraceRegisterNoThreadErr() throws Throwable { // NB. Definitely no thread required createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); activateTrace(); waitForSwing(); @@ -364,7 +363,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteTraceRegister() throws Throwable { // NB. Definitely no thread required createAndOpenTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); TraceThread thread; try (UndoableTransaction tid = tb.startTransaction()) { @@ -397,7 +396,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge activateTrace(); traceManager.activateThread(recorder.getTraceThread(mb.testThread1)); waitForSwing(); - editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.RW_TARGET); StateEditor editor = createStateEditor(); assertTrue(editor.isVariableEditable(tb.addr(0x00400000), 4)); @@ -417,7 +416,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge waitForSwing(); traceManager.activateThread(recorder.getTraceThread(mb.testThread1)); waitForSwing(); - editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.RW_TARGET); StateEditor editor = createStateEditor(); assertTrue(editor.isRegisterEditable(r0)); @@ -436,7 +435,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge TraceThread thread = recorder.getTraceThread(mb.testThread1); traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.RW_TARGET); StateEditor editor = createStateEditor(); assertTrue(editor.isRegisterEditable(r0)); @@ -461,7 +460,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge activateTrace(); traceManager.activateThread(recorder.getTraceThread(mb.testThread1)); waitForSwing(); - editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.RW_TARGET); traceManager.activateSnap(traceManager.getCurrentSnap() - 1); @@ -479,7 +478,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge activateTrace(); traceManager.activateThread(recorder.getTraceThread(mb.testThread1)); waitForSwing(); - editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(recorder.getTrace(), StateEditingMode.RW_TARGET); traceManager.activateSnap(traceManager.getCurrentSnap() - 1); @@ -494,7 +493,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteTargetMemoryNotAliveErr() throws Throwable { createAndOpenTrace(); activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TARGET); StateEditor editor = createStateEditor(); assertFalse(editor.isVariableEditable(tb.addr(0x00400000), 4)); @@ -507,7 +506,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteTargetRegisterNotAliveErr() throws Throwable { createAndOpenTrace(); activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TARGET); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TARGET); StateEditor editor = createStateEditor(); assertFalse(editor.isRegisterEditable(r0)); @@ -520,7 +519,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteReadOnlyMemoryErr() throws Throwable { createAndOpenTrace(); activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.READ_ONLY); + editingService.setCurrentMode(tb.trace, StateEditingMode.RO_TARGET); StateEditor editor = createStateEditor(); assertFalse(editor.isVariableEditable(tb.addr(0x00400000), 4)); @@ -533,7 +532,7 @@ public class DebuggerStateEditingServiceTest extends AbstractGhidraHeadedDebugge public void testWriteReadOnlyRegisterErr() throws Throwable { createAndOpenTrace(); activateTrace(); - editingService.setCurrentMode(tb.trace, StateEditingMode.READ_ONLY); + editingService.setCurrentMode(tb.trace, StateEditingMode.RO_TARGET); StateEditor editor = createStateEditor(); assertFalse(editor.isRegisterEditable(r0)); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServiceTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServiceTest.java index ff687bd181..98ae36cdcd 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServiceTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/emulation/DebuggerEmulationServiceTest.java @@ -47,6 +47,7 @@ import ghidra.program.model.mem.Memory; import ghidra.program.model.mem.MemoryBlock; import ghidra.program.util.ProgramLocation; import ghidra.trace.model.*; +import ghidra.trace.model.breakpoint.TraceBreakpoint; import ghidra.trace.model.breakpoint.TraceBreakpointKind; import ghidra.trace.model.guest.TracePlatform; import ghidra.trace.model.memory.TraceMemoryManager; @@ -402,6 +403,132 @@ public class DebuggerEmulationServiceTest extends AbstractGhidraHeadedDebuggerGU regs.getViewValue(scratch, regR2).getUnsignedValue()); } + @Test + public void testRunAfterExecutionBreakpoint() throws Exception { + createProgram(); + intoProject(program); + Assembler asm = Assemblers.getAssembler(program); + Memory memory = program.getMemory(); + Address addrText = addr(program, 0x000400000); + Address addrI1; + Address addrI2; + try (UndoableTransaction tid = UndoableTransaction.start(program, "Initialize")) { + MemoryBlock blockText = memory.createInitializedBlock(".text", addrText, 0x1000, + (byte) 0, TaskMonitor.DUMMY, false); + blockText.setExecute(true); + InstructionIterator ii = asm.assemble(addrText, + "mov r0, r0", + "mov r0, r1", + "mov r2, r0"); + ii.next(); // addrText + addrI1 = ii.next().getMinAddress(); + addrI2 = ii.next().getMinAddress(); + } + + programManager.openProgram(program); + waitForSwing(); + codeBrowser.goTo(new ProgramLocation(program, addrText)); + waitForSwing(); + + performEnabledAction(codeBrowser.getProvider(), emulationPlugin.actionEmulateProgram, true); + + Trace trace = traceManager.getCurrentTrace(); + assertNotNull(trace); + + TraceThread thread = Unique.assertOne(trace.getThreadManager().getAllThreads()); + + try (UndoableTransaction tid = UndoableTransaction.start(trace, "Add breakpoint")) { + trace.getBreakpointManager() + .addBreakpoint("Breakpoints[0]", Lifespan.nowOn(0), addrText, Set.of(thread), + Set.of(TraceBreakpointKind.SW_EXECUTE), true, "test"); + trace.getBreakpointManager() + .addBreakpoint("Breakpoints[1]", Lifespan.nowOn(0), addrI1, Set.of(thread), + Set.of(TraceBreakpointKind.SW_EXECUTE), true, "test"); + trace.getBreakpointManager() + .addBreakpoint("Breakpoints[2]", Lifespan.nowOn(0), addrI2, Set.of(thread), + Set.of(TraceBreakpointKind.SW_EXECUTE), true, "test"); + } + + // This is already testing if the one set at the entry is ignored + EmulationResult result1 = emulationPlugin.run(trace.getPlatformManager().getHostPlatform(), + TraceSchedule.snap(0), monitor, Scheduler.oneThread(thread)); + assertEquals(TraceSchedule.parse("0:t0-1"), result1.schedule()); + assertTrue(result1.error() instanceof InterruptPcodeExecutionException); + + // This will test if the one just hit gets ignored + EmulationResult result2 = emulationPlugin.run(trace.getPlatformManager().getHostPlatform(), + result1.schedule(), monitor, Scheduler.oneThread(thread)); + assertEquals(TraceSchedule.parse("0:t0-2"), result2.schedule()); + assertTrue(result1.error() instanceof InterruptPcodeExecutionException); + } + + @Test + public void testExecutionInjection() throws Exception { + createProgram(); + intoProject(program); + Assembler asm = Assemblers.getAssembler(program); + Memory memory = program.getMemory(); + Address addrText = addr(program, 0x000400000); + Register regPC = program.getRegister("pc"); + Register regR0 = program.getRegister("r0"); + Register regR1 = program.getRegister("r1"); + Register regR2 = program.getRegister("r2"); + Address addrI2; + try (UndoableTransaction tid = UndoableTransaction.start(program, "Initialize")) { + MemoryBlock blockText = memory.createInitializedBlock(".text", addrText, 0x1000, + (byte) 0, TaskMonitor.DUMMY, false); + blockText.setExecute(true); + InstructionIterator ii = asm.assemble(addrText, + "mov r0, r1", + "mov r2, r0"); + ii.next(); + addrI2 = ii.next().getMinAddress(); + program.getProgramContext() + .setValue(regR1, addrText, addrText, new BigInteger("1234", 16)); + } + + programManager.openProgram(program); + waitForSwing(); + codeBrowser.goTo(new ProgramLocation(program, addrText)); + waitForSwing(); + + performEnabledAction(codeBrowser.getProvider(), emulationPlugin.actionEmulateProgram, true); + + Trace trace = traceManager.getCurrentTrace(); + assertNotNull(trace); + + TraceThread thread = Unique.assertOne(trace.getThreadManager().getAllThreads()); + TraceMemorySpace regs = trace.getMemoryManager().getMemoryRegisterSpace(thread, false); + + try (UndoableTransaction tid = UndoableTransaction.start(trace, "Add breakpoint")) { + TraceBreakpoint tb = trace.getBreakpointManager() + .addBreakpoint("Breakpoints[0]", Lifespan.nowOn(0), addrI2, Set.of(thread), + Set.of(TraceBreakpointKind.SW_EXECUTE), true, "test"); + tb.setEmuSleigh(""" + r1 = 0x5678; + emu_swi(); + emu_exec_decoded(); + """); + } + + EmulationResult result = emulationPlugin.run(trace.getPlatformManager().getHostPlatform(), + TraceSchedule.snap(0), TaskMonitor.DUMMY, Scheduler.oneThread(thread)); + + assertEquals(TraceSchedule.parse("0:t0-1.t0-2"), result.schedule()); + assertTrue(result.error() instanceof InterruptPcodeExecutionException); + + long scratch = result.snapshot(); + + assertEquals(new BigInteger("00400002", 16), + regs.getViewValue(scratch, regPC).getUnsignedValue()); + assertEquals(new BigInteger("1234", 16), + regs.getViewValue(scratch, regR0).getUnsignedValue()); + assertEquals(new BigInteger("5678", 16), + regs.getViewValue(scratch, regR1).getUnsignedValue()); + assertEquals(new BigInteger("0", 16), + regs.getViewValue(scratch, regR2).getUnsignedValue()); + } + @Test public void testAccessBreakpoint() throws Exception { createProgram(); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServiceTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServiceTest.java index 8c8e8c2373..18502096f9 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServiceTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/service/tracemgr/DebuggerTraceManagerServiceTest.java @@ -19,14 +19,15 @@ import static org.junit.Assert.*; import java.util.*; +import org.junit.Before; import org.junit.Test; import org.junit.experimental.categories.Category; import generic.test.category.NightlyCategory; import ghidra.app.plugin.core.debug.DebuggerCoordinates; import ghidra.app.plugin.core.debug.gui.AbstractGhidraHeadedDebuggerGUITest; -import ghidra.app.services.ActionSource; -import ghidra.app.services.TraceRecorder; +import ghidra.app.plugin.core.debug.service.editing.DebuggerStateEditingServicePlugin; +import ghidra.app.services.*; import ghidra.dbg.model.TestTargetStack; import ghidra.dbg.model.TestTargetStackFrameHasRegisterBank; import ghidra.dbg.target.schema.SchemaContext; @@ -46,6 +47,14 @@ import ghidra.util.database.UndoableTransaction; @Category(NightlyCategory.class) // this may actually be an @PortSensitive test public class DebuggerTraceManagerServiceTest extends AbstractGhidraHeadedDebuggerGUITest { + protected DebuggerStateEditingService editingService; + + @Before + public void setUpTraceManagerTest() throws Exception { + addPlugin(tool, DebuggerStateEditingServicePlugin.class); + editingService = tool.getService(DebuggerStateEditingService.class); + } + @Test public void testGetOpenTraces() throws Exception { assertEquals(Set.of(), traceManager.getOpenTraces()); @@ -337,9 +346,7 @@ public class DebuggerTraceManagerServiceTest extends AbstractGhidraHeadedDebugge } @Test - public void testAutoActivatePresent() throws Throwable { - assertTrue(traceManager.isAutoActivatePresent()); - + public void testFollowPresent() throws Throwable { createTestModel(); mb.createTestProcessesAndThreads(); @@ -352,6 +359,7 @@ public class DebuggerTraceManagerServiceTest extends AbstractGhidraHeadedDebugge traceManager.activateTrace(trace); waitForSwing(); + assertEquals(StateEditingMode.RO_TARGET, editingService.getCurrentMode(trace)); long initSnap = recorder.getSnap(); assertEquals(initSnap, traceManager.getCurrentSnap()); @@ -361,7 +369,7 @@ public class DebuggerTraceManagerServiceTest extends AbstractGhidraHeadedDebugge assertEquals(initSnap + 1, recorder.getSnap()); assertEquals(initSnap + 1, traceManager.getCurrentSnap()); - traceManager.setAutoActivatePresent(false); + editingService.setCurrentMode(trace, StateEditingMode.RO_TRACE); recorder.forceSnapshot(); waitForSwing(); @@ -369,7 +377,11 @@ public class DebuggerTraceManagerServiceTest extends AbstractGhidraHeadedDebugge assertEquals(initSnap + 2, recorder.getSnap()); assertEquals(initSnap + 1, traceManager.getCurrentSnap()); - traceManager.setAutoActivatePresent(true); + editingService.setCurrentMode(trace, StateEditingMode.RO_TARGET); + waitForSwing(); + + assertEquals(initSnap + 2, recorder.getSnap()); + assertEquals(initSnap + 2, traceManager.getCurrentSnap()); recorder.forceSnapshot(); waitForSwing(); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/stack/StackUnwinderTest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/stack/StackUnwinderTest.java index c8ba1092d7..1591c56a44 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/stack/StackUnwinderTest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/app/plugin/core/debug/stack/StackUnwinderTest.java @@ -49,7 +49,6 @@ import ghidra.app.plugin.core.decompile.DecompilerProvider; import ghidra.app.plugin.core.disassembler.DisassemblerPlugin; import ghidra.app.services.*; import ghidra.app.services.DebuggerEmulationService.EmulationResult; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.DebuggerStateEditingService.StateEditor; import ghidra.app.util.viewer.field.FieldFactory; import ghidra.app.util.viewer.field.ListingField; @@ -692,7 +691,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); DebuggerCoordinates atSetup = traceManager.getCurrent(); @@ -752,7 +751,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); DebuggerCoordinates atSetup = traceManager.getCurrent(); @@ -895,7 +894,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); DebuggerCoordinates atSetup = traceManager.getCurrent(); @@ -945,7 +944,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); // Move stack where it shows in UI. Not required, but nice for debugging. Register sp = program.getCompilerSpec().getStackPointer(); @@ -989,7 +988,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); // Move stack where it shows in UI. Not required, but nice for debugging. Register sp = program.getCompilerSpec().getStackPointer(); @@ -1033,7 +1032,7 @@ public class StackUnwinderTest extends AbstractGhidraHeadedDebuggerGUITest { traceManager.activateThread(thread); waitForSwing(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); StateEditor editor = editingService.createStateEditor(tb.trace); // Move stack where it shows in UI. Not required, but nice for debugging. Register sp = program.getCompilerSpec().getStackPointer(); diff --git a/Ghidra/Debug/Debugger/src/test/java/ghidra/debug/flatapi/FlatDebuggerAPITest.java b/Ghidra/Debug/Debugger/src/test/java/ghidra/debug/flatapi/FlatDebuggerAPITest.java index 1682fe0355..0360f3ba75 100644 --- a/Ghidra/Debug/Debugger/src/test/java/ghidra/debug/flatapi/FlatDebuggerAPITest.java +++ b/Ghidra/Debug/Debugger/src/test/java/ghidra/debug/flatapi/FlatDebuggerAPITest.java @@ -44,7 +44,6 @@ import ghidra.app.plugin.core.debug.service.model.launch.DebuggerProgramLaunchOf import ghidra.app.plugin.core.debug.service.model.launch.DebuggerProgramLaunchOffer.LaunchResult; import ghidra.app.script.GhidraState; import ghidra.app.services.*; -import ghidra.app.services.DebuggerStateEditingService.StateEditingMode; import ghidra.app.services.LogicalBreakpoint.State; import ghidra.dbg.DebuggerModelFactory; import ghidra.dbg.DebuggerObjectModel; @@ -690,7 +689,7 @@ public class FlatDebuggerAPITest extends AbstractGhidraHeadedDebuggerGUITest { @Test public void testWriteMemoryGivenContext() throws Throwable { createTraceWithBinText(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); assertTrue(flat.writeMemory(tb.trace, 0, tb.addr(0x00400123), tb.arr(3, 2, 1))); ByteBuffer buf = ByteBuffer.allocate(3); @@ -701,7 +700,7 @@ public class FlatDebuggerAPITest extends AbstractGhidraHeadedDebuggerGUITest { @Test public void testWriteMemoryCurrentContext() throws Throwable { createTraceWithBinText(); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); assertTrue(flat.writeMemory(tb.addr(0x00400123), tb.arr(3, 2, 1))); ByteBuffer buf = ByteBuffer.allocate(3); @@ -712,7 +711,7 @@ public class FlatDebuggerAPITest extends AbstractGhidraHeadedDebuggerGUITest { @Test public void testWriteRegisterGivenContext() throws Throwable { TraceThread thread = createTraceWithThreadAndStack(true); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); traceManager.activateThread(thread); waitForSwing(); @@ -728,7 +727,7 @@ public class FlatDebuggerAPITest extends AbstractGhidraHeadedDebuggerGUITest { @Test public void testWriteRegisterCurrentContext() throws Throwable { TraceThread thread = createTraceWithThreadAndStack(true); - editingService.setCurrentMode(tb.trace, StateEditingMode.WRITE_TRACE); + editingService.setCurrentMode(tb.trace, StateEditingMode.RW_TRACE); traceManager.activateThread(thread); waitForSwing(); diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/pcode/exec/trace/TraceSleighUtils.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/pcode/exec/trace/TraceSleighUtils.java index f029a85f81..b53f5929d7 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/pcode/exec/trace/TraceSleighUtils.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/pcode/exec/trace/TraceSleighUtils.java @@ -59,7 +59,7 @@ public enum TraceSleighUtils { new DirectBytesTracePcodeExecutorState(platform, snap, thread, frame); Language language = platform.getLanguage(); if (!(language instanceof SleighLanguage)) { - throw new IllegalArgumentException("TracePlatform must use a SLEIGH language"); + throw new IllegalArgumentException("TracePlatform must use a Sleigh language"); } return new PcodeExecutor<>((SleighLanguage) language, BytesPcodeArithmetic.forLanguage(language), state, Reason.INSPECT); @@ -99,7 +99,7 @@ public enum TraceSleighUtils { PcodeExecutorState> paired = state.withMemoryState(); Language language = platform.getLanguage(); if (!(language instanceof SleighLanguage)) { - throw new IllegalArgumentException("TracePlatform must use a SLEIGH language"); + throw new IllegalArgumentException("TracePlatform must use a Sleigh language"); } return new PcodeExecutor<>((SleighLanguage) language, new PairedPcodeArithmetic<>( BytesPcodeArithmetic.forLanguage(language), TraceMemoryStatePcodeArithmetic.INSTANCE), diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpoint.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpoint.java index 1415d917ef..0bdd7787a3 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpoint.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpoint.java @@ -19,6 +19,7 @@ import java.io.IOException; import java.util.*; import db.DBRecord; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.*; import ghidra.trace.database.DBTrace; import ghidra.trace.database.DBTraceUtils; @@ -38,19 +39,21 @@ import ghidra.util.database.DBObjectColumn; import ghidra.util.database.annot.*; import ghidra.util.exception.DuplicateNameException; -@DBAnnotatedObjectInfo(version = 0) +@DBAnnotatedObjectInfo(version = 1) public class DBTraceBreakpoint extends AbstractDBTraceAddressSnapRangePropertyMapData implements TraceBreakpoint { protected static final String TABLE_NAME = "Breakpoints"; private static final byte ENABLED_MASK = (byte) (1 << 7); + private static final byte EMU_ENABLED_MASK = (byte) (1 << 6); static final String PATH_COLUMN_NAME = "Path"; static final String NAME_COLUMN_NAME = "Name"; static final String THREADS_COLUMN_NAME = "Threads"; static final String FLAGS_COLUMN_NAME = "Flags"; static final String COMMENT_COLUMN_NAME = "Comment"; + static final String SLEIGH_COLUMN_NAME = "Sleigh"; @DBAnnotatedColumn(PATH_COLUMN_NAME) static DBObjectColumn PATH_COLUMN; @@ -62,6 +65,8 @@ public class DBTraceBreakpoint static DBObjectColumn FLAGS_COLUMN; @DBAnnotatedColumn(COMMENT_COLUMN_NAME) static DBObjectColumn COMMENT_COLUMN; + @DBAnnotatedColumn(SLEIGH_COLUMN_NAME) + static DBObjectColumn SLEIGH_COLUMN; protected static String tableName(AddressSpace space, long threadKey) { return DBTraceUtils.tableName(TABLE_NAME, space, threadKey, 0); @@ -77,10 +82,13 @@ public class DBTraceBreakpoint private byte flagsByte; @DBAnnotatedField(column = COMMENT_COLUMN_NAME) private String comment; + @DBAnnotatedField(column = SLEIGH_COLUMN_NAME) + private String emuSleigh; private final Set kinds = EnumSet.noneOf(TraceBreakpointKind.class); private final Set kindsView = Collections.unmodifiableSet(kinds); private boolean enabled; + private boolean emuEnabled; protected final DBTraceBreakpointSpace space; @@ -108,7 +116,7 @@ public class DBTraceBreakpoint } } enabled = (flagsByte & ENABLED_MASK) != 0; - // Msg.debug(this, "trace: breakpoint " + this + " enabled=" + enabled + ", because doFresh"); + emuEnabled = (flagsByte & EMU_ENABLED_MASK) != 0; } @Override @@ -127,7 +135,8 @@ public class DBTraceBreakpoint } public void set(String path, String name, Collection threads, - Collection kinds, boolean enabled, String comment) { + Collection kinds, boolean enabled, boolean emuEnabled, + String comment) { // TODO: Check that the threads exist and that each's lifespan covers the breakpoint's // TODO: This would require additional validation any time those are updated // TODO: For efficiency, would also require index of breakpoints by thread @@ -150,9 +159,13 @@ public class DBTraceBreakpoint if (enabled) { this.flagsByte |= ENABLED_MASK; } + if (emuEnabled) { + this.flagsByte |= EMU_ENABLED_MASK; + } this.comment = comment; update(PATH_COLUMN, NAME_COLUMN, THREADS_COLUMN, FLAGS_COLUMN, COMMENT_COLUMN); this.enabled = enabled; + this.emuEnabled = emuEnabled; // Msg.debug(this, "trace: breakpoint " + this + " enabled=" + enabled + ", because set"); } @@ -360,6 +373,17 @@ public class DBTraceBreakpoint update(FLAGS_COLUMN); } + protected void doSetEmuEnabled(boolean emuEnabled) { + this.emuEnabled = emuEnabled; + if (emuEnabled) { + flagsByte |= EMU_ENABLED_MASK; + } + else { + flagsByte &= ~EMU_ENABLED_MASK; + } + update(FLAGS_COLUMN); + } + protected void doSetKinds(Collection kinds) { for (TraceBreakpointKind k : TraceBreakpointKind.values()) { if (kinds.contains(k)) { @@ -391,6 +415,23 @@ public class DBTraceBreakpoint } } + @Override + public void setEmuEnabled(boolean enabled) { + try (LockHold hold = LockHold.lock(space.lock.writeLock())) { + doSetEmuEnabled(enabled); + } + space.trace.setChanged(new TraceChangeRecord<>(TraceBreakpointChangeType.CHANGED, + space, this)); + } + + @Override + public boolean isEmuEnabled(long snap) { + // NB. Only object mode support per-snap emu-enablement + try (LockHold hold = LockHold.lock(space.lock.readLock())) { + return emuEnabled; + } + } + @Override public void setKinds(Collection kinds) { try (LockHold hold = LockHold.lock(space.lock.writeLock())) { @@ -424,6 +465,29 @@ public class DBTraceBreakpoint } } + @Override + public void setEmuSleigh(String emuSleigh) { + try (LockHold hold = LockHold.lock(space.lock.writeLock())) { + if (emuSleigh == null || SleighUtils.UNCONDITIONAL_BREAK.equals(emuSleigh)) { + this.emuSleigh = null; + } + else { + this.emuSleigh = emuSleigh.trim(); + } + update(SLEIGH_COLUMN); + } + space.trace.setChanged(new TraceChangeRecord<>(TraceBreakpointChangeType.CHANGED, + space, this)); + } + + @Override + public String getEmuSleigh() { + try (LockHold hold = LockHold.lock(space.lock.readLock())) { + return emuSleigh == null || emuSleigh.isBlank() ? SleighUtils.UNCONDITIONAL_BREAK + : emuSleigh; + } + } + @Override public void delete() { space.deleteBreakpoint(this); diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpointSpace.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpointSpace.java index ce09ca2efb..fa1296c007 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpointSpace.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceBreakpointSpace.java @@ -100,7 +100,7 @@ public class DBTraceBreakpointSpace implements DBTraceSpaceBased { } DBTraceBreakpoint breakpoint = breakpointMapSpace.put(new ImmutableTraceAddressSnapRange(range, lifespan), null); - breakpoint.set(path, path, threads, kinds, enabled, comment); + breakpoint.set(path, path, threads, kinds, enabled, true, comment); trace.setChanged( new TraceChangeRecord<>(TraceBreakpointChangeType.ADDED, this, breakpoint)); return breakpoint; diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointLocation.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointLocation.java index b0a8b1a59c..22e46a0df4 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointLocation.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointLocation.java @@ -15,13 +15,13 @@ */ package ghidra.trace.database.breakpoint; -import java.util.Collection; -import java.util.Set; +import java.util.*; import java.util.stream.Collectors; import ghidra.dbg.target.*; import ghidra.dbg.target.schema.TargetObjectSchema; import ghidra.dbg.util.PathMatcher; +import ghidra.pcode.exec.SleighUtils; import ghidra.program.model.address.Address; import ghidra.program.model.address.AddressRange; import ghidra.trace.database.target.*; @@ -208,6 +208,11 @@ public class DBTraceObjectBreakpointLocation object.setValue(Lifespan.span(snap, getClearedSnap()), TargetBreakpointSpec.ENABLED_ATTRIBUTE_NAME, enabled); } + Set asSet = + kinds instanceof Set yes ? yes : Set.copyOf(kinds); + if (!Objects.equals(asSet, getKinds())) { + this.setKinds(Lifespan.span(snap, getClearedSnap()), asSet); + } return this; } } @@ -297,8 +302,55 @@ public class DBTraceObjectBreakpointLocation @Override public String getComment() { - return TraceObjectInterfaceUtils.getValue(object, getPlacedSnap(), KEY_COMMENT, - String.class, ""); + try (LockHold hold = object.getTrace().lockRead()) { + return TraceObjectInterfaceUtils.getValue(object, getPlacedSnap(), KEY_COMMENT, + String.class, ""); + } + } + + @Override + public void setEmuEnabled(Lifespan lifespan, boolean emuEnabled) { + object.setValue(lifespan, KEY_EMU_ENABLED, emuEnabled ? null : false); + } + + @Override + public void setEmuEnabled(boolean emuEnabled) { + try (LockHold hold = object.getTrace().lockWrite()) { + setEmuEnabled(getLifespan(), emuEnabled); + } + } + + @Override + public boolean isEmuEnabled(long snap) { + try (LockHold hold = object.getTrace().lockRead()) { + return TraceObjectInterfaceUtils.getValue(object, getPlacedSnap(), KEY_EMU_ENABLED, + Boolean.class, true); + } + } + + @Override + public void setEmuSleigh(Lifespan lifespan, String sleigh) { + if (sleigh == null || SleighUtils.UNCONDITIONAL_BREAK.equals(sleigh)) { + object.setValue(lifespan, KEY_EMU_SLEIGH, null); + } + else { + object.setValue(lifespan, KEY_EMU_SLEIGH, sleigh.trim()); + } + } + + @Override + public void setEmuSleigh(String sleigh) { + try (LockHold hold = object.getTrace().lockWrite()) { + setEmuSleigh(getLifespan(), sleigh); + } + } + + @Override + public String getEmuSleigh() { + try (LockHold hold = object.getTrace().lockRead()) { + return TraceObjectInterfaceUtils.getValue(object, getPlacedSnap(), KEY_EMU_SLEIGH, + String.class, SleighUtils.UNCONDITIONAL_BREAK); + } } @Override diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointSpec.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointSpec.java index 47248d4647..4adde4af9a 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointSpec.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/breakpoint/DBTraceObjectBreakpointSpec.java @@ -131,7 +131,8 @@ public class DBTraceObjectBreakpointSpec @Override public void setEnabled(boolean enabled) { try (LockHold hold = object.getTrace().lockWrite()) { - object.setValue(getLifespan(), TargetBreakpointSpec.ENABLED_ATTRIBUTE_NAME, enabled); + object.setValue(getLifespan(), TargetBreakpointSpec.ENABLED_ATTRIBUTE_NAME, + enabled ? true : null); } } @@ -190,6 +191,26 @@ public class DBTraceObjectBreakpointSpec throw new UnsupportedOperationException("Ask a location instead"); } + @Override + public void setEmuEnabled(boolean enabled) { + throw new UnsupportedOperationException("Set on a location instead"); + } + + @Override + public boolean isEmuEnabled(long snap) { + throw new UnsupportedOperationException("Ask a location instead"); + } + + @Override + public void setEmuSleigh(String sleigh) { + throw new UnsupportedOperationException("Set on a location instead"); + } + + @Override + public String getEmuSleigh() { + throw new UnsupportedOperationException("Ask a location instead"); + } + @Override public void delete() { try (LockHold hold = object.getTrace().lockWrite()) { diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/Trace.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/Trace.java index 8b1dd3847e..e79a37e6d0 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/Trace.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/Trace.java @@ -53,6 +53,16 @@ import resources.ResourceManager; public interface Trace extends DataTypeManagerDomainObject { ImageIcon TRACE_ICON = ResourceManager.loadImage("images/video-x-generic16.png"); + /** + * TEMPORARY: An a/b switch while both table- (legacy) and object-mode traces are supported + * + * @param trace the trace, or null + * @return true if the trace is non-null and has no root schema + */ + public static boolean isLegacy(Trace trace) { + return trace != null && trace.getObjectManager().getRootSchema() == null; + } + public static final class TraceObjectChangeType extends DefaultTraceChangeType { /** diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpoint.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpoint.java index 370d7b57b2..320cf37b48 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpoint.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpoint.java @@ -28,7 +28,6 @@ import ghidra.util.exception.DuplicateNameException; * A breakpoint in a trace */ public interface TraceBreakpoint extends TraceUniqueObject { - /** * Get the trace containing this breakpoint * @@ -161,10 +160,30 @@ public interface TraceBreakpoint extends TraceUniqueObject { /** * Check whether this breakpoint is enabled or disabled at the given snap * + * @param snap the snap * @return true if enabled, false if disabled */ boolean isEnabled(long snap); + /** + * Set whether this breakpoint is enabled or disabled for emulation + * + *

    + * This change applies to the entire lifespan of the record. It's not intended to record a + * history, but to toggle the breakpoint in the integrated emulator. + * + * @param enabled true if enabled, false if disabled + */ + void setEmuEnabled(boolean enabled); + + /** + * Check whether this breakpoint is enabled or disabled for emulation at the given snap + * + * @param snap the snap + * @return true if enabled, false if disabled + */ + boolean isEmuEnabled(long snap); + /** * Set the kinds included in this breakpoint * @@ -213,6 +232,36 @@ public interface TraceBreakpoint extends TraceUniqueObject { */ String getComment(); + /** + * Set Sleigh source to replace the breakpointed instruction in emulation + * + *

    + * The default is simply "{@link PcodeEmulationLibrary#emu_swi() emu_swi()}; + * {@link PcodeEmulationLibrary#emu_exec_decoded() emu_exec_decoded()};", effectively a + * non-conditional breakpoint followed by execution of the actual instruction. Modifying this + * allows clients to create conditional breakpoints or simply override or inject additional + * logic into an emulated target. + * + *

    + * NOTE: This current has no effect on access breakpoints, but only execution + * breakpoints. + * + *

    + * If the specified source fails to compile during emulator set-up, this will fall back to + * {@link PcodeEmulationLibrary#emu_err + * + * @see #DEFAULT_SLEIGH + * @param sleigh the Sleigh source + */ + void setEmuSleigh(String sleigh); + + /** + * Get the Sleigh source that replaces the breakpointed instruction in emulation + * + * @return the Sleigh source + */ + String getEmuSleigh(); + /** * Delete this breakpoint from the trace */ diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpointKind.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpointKind.java index a5a63c64d6..4d6d0543f4 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpointKind.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceBreakpointKind.java @@ -37,6 +37,8 @@ public enum TraceBreakpointKind { HW_EXECUTE(1 << 2), SW_EXECUTE(1 << 3); + public static final int COUNT = values().length; + public static class TraceBreakpointKindSet extends AbstractSetDecorator { public static final TraceBreakpointKindSet SW_EXECUTE = of(TraceBreakpointKind.SW_EXECUTE); public static final TraceBreakpointKindSet HW_EXECUTE = of(TraceBreakpointKind.HW_EXECUTE); diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceObjectBreakpointLocation.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceObjectBreakpointLocation.java index 9751cf53f6..b9f20ee67d 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceObjectBreakpointLocation.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/breakpoint/TraceObjectBreakpointLocation.java @@ -32,9 +32,12 @@ import ghidra.util.exception.DuplicateNameException; TargetObject.DISPLAY_ATTRIBUTE_NAME, TargetBreakpointLocation.RANGE_ATTRIBUTE_NAME, TraceObjectBreakpointLocation.KEY_COMMENT, + TraceObjectBreakpointLocation.KEY_EMU_ENABLED, }) public interface TraceObjectBreakpointLocation extends TraceBreakpoint, TraceObjectInterface { String KEY_COMMENT = "_comment"; + String KEY_EMU_ENABLED = "_emu_enabled"; + String KEY_EMU_SLEIGH = "_emu_sleigh"; TraceObjectBreakpointSpec getSpecification(); @@ -48,5 +51,9 @@ public interface TraceObjectBreakpointLocation extends TraceBreakpoint, TraceObj void setEnabled(Lifespan lifespan, boolean enabled); + void setEmuEnabled(Lifespan lifespan, boolean emuEnabled); + + void setEmuSleigh(Lifespan lifespan, String sleigh); + void setComment(Lifespan lifespan, String comment); } diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/Scheduler.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/Scheduler.java index b45abe10aa..ee3b55aa27 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/Scheduler.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/Scheduler.java @@ -132,14 +132,16 @@ public interface Scheduler { } catch (PcodeExecutionException e) { completedSteps = completedSteps.steppedForward(eventThread, completedTicks); - if (emuThread.getInstruction() == null) { + PcodeFrame frame = emuThread.getFrame(); + if (frame == null) { return new RecordRunResult(completedSteps, e); } - PcodeFrame frame = e.getFrame(); // Rewind one so stepping retries the op causing the error - int count = frame.count() - 1; - if (frame == null || count == 0) { - // If we've decoded, but could execute the first op, just drop the p-code steps + frame.stepBack(); + int count = frame.count(); + if (count == 0) { + // If we've decoded, but could not execute the first op, just drop the p-code steps + emuThread.dropInstruction(); return new RecordRunResult(completedSteps, e); } // The +1 accounts for the decode step diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/TraceSchedule.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/TraceSchedule.java index a436e195af..12b71d2fdd 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/TraceSchedule.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/model/time/schedule/TraceSchedule.java @@ -18,6 +18,7 @@ package ghidra.trace.model.time.schedule; import java.util.*; import ghidra.pcode.emu.PcodeMachine; +import ghidra.pcode.emu.PcodeMachine.SwiMode; import ghidra.program.model.lang.Language; import ghidra.trace.model.Trace; import ghidra.trace.model.thread.TraceThread; @@ -25,9 +26,18 @@ import ghidra.trace.model.time.TraceSnapshot; import ghidra.util.exception.CancelledException; import ghidra.util.task.TaskMonitor; +/** + * A sequence of emulator stepping commands, essentially comprising a "point in time." + */ public class TraceSchedule implements Comparable { public static final TraceSchedule ZERO = TraceSchedule.snap(0); + /** + * Create a schedule that consists solely of a snapshot + * + * @param snap the snapshot key + * @return the schedule + */ public static final TraceSchedule snap(long snap) { return new TraceSchedule(snap, new Sequence(), new Sequence()); } @@ -337,11 +347,10 @@ public class TraceSchedule implements Comparable { */ public void execute(Trace trace, PcodeMachine machine, TaskMonitor monitor) throws CancelledException { + machine.setSoftwareInterruptMode(SwiMode.IGNORE_ALL); TraceThread lastThread = getEventThread(trace); - lastThread = - steps.execute(trace, lastThread, machine, Stepper.instruction(), monitor); - lastThread = - pSteps.execute(trace, lastThread, machine, Stepper.pcode(), monitor); + lastThread = steps.execute(trace, lastThread, machine, Stepper.instruction(), monitor); + lastThread = pSteps.execute(trace, lastThread, machine, Stepper.pcode(), monitor); } /** @@ -380,6 +389,7 @@ public class TraceSchedule implements Comparable { TaskMonitor monitor) throws CancelledException { TraceThread lastThread = position.getLastThread(trace); Sequence remains = steps.relativize(position.steps); + machine.setSoftwareInterruptMode(SwiMode.IGNORE_ALL); if (remains.isNop()) { Sequence pRemains = this.pSteps.relativize(position.pSteps); lastThread = @@ -388,8 +398,7 @@ public class TraceSchedule implements Comparable { else { lastThread = remains.execute(trace, lastThread, machine, Stepper.instruction(), monitor); - lastThread = - pSteps.execute(trace, lastThread, machine, Stepper.pcode(), monitor); + lastThread = pSteps.execute(trace, lastThread, machine, Stepper.pcode(), monitor); } } diff --git a/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/AbstractTracePcodeEmulatorTest.java b/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/AbstractTracePcodeEmulatorTest.java index 5b91d5469d..a3aaf25d98 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/AbstractTracePcodeEmulatorTest.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/AbstractTracePcodeEmulatorTest.java @@ -46,8 +46,8 @@ public class AbstractTracePcodeEmulatorTest extends AbstractGhidraHeadlessIntegr *

    * This creates a relatively bare-bones trace with initial state for testing trace * emulation/interpolation. It adds ".text" and "stack" regions, creates a thread, assembles - * given instructions, and then executes the given SLEIGH source (in the context of the new - * thread) to finish initializing the trace. Note, though given first, the SLEIGH is executed + * given instructions, and then executes the given Sleigh source (in the context of the new + * thread) to finish initializing the trace. Note, though given first, the Sleigh is executed * after assembly. Thus, it can be used to modify the resulting machine code by modifying the * memory where it was assembled. * diff --git a/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/BytesTracePcodeEmulatorTest.java b/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/BytesTracePcodeEmulatorTest.java index d708d0f8e2..bced23293b 100644 --- a/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/BytesTracePcodeEmulatorTest.java +++ b/Ghidra/Debug/Framework-TraceModeling/src/test/java/ghidra/pcode/exec/trace/BytesTracePcodeEmulatorTest.java @@ -312,7 +312,7 @@ public class BytesTracePcodeEmulatorTest extends AbstractTracePcodeEmulatorTest * This may not reflect the semantics of an actual processor in these situations, since they may * have instruction caching. Emulating such semantics is TODO, if at all. NB. This also tests * that PC-relative addressing works, since internally the emulator advances the counter after - * execution of each instruction. Addressing is computed by the SLEIGH instruction parser and + * execution of each instruction. Addressing is computed by the Sleigh instruction parser and * encoded as a constant deref in the p-code. */ @Test diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/docking/widgets/table/RowWrappedEnumeratedColumnTableModel.java b/Ghidra/Debug/ProposedUtils/src/main/java/docking/widgets/table/RowWrappedEnumeratedColumnTableModel.java index f9ca2c1a90..c335224f37 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/docking/widgets/table/RowWrappedEnumeratedColumnTableModel.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/docking/widgets/table/RowWrappedEnumeratedColumnTableModel.java @@ -17,6 +17,7 @@ package docking.widgets.table; import java.util.*; import java.util.function.Function; +import java.util.function.Predicate; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -37,13 +38,15 @@ public class RowWrappedEnumeratedColumnTableModel & Enumerated extends DefaultEnumeratedColumnTableModel { private final Function keyFunc; private final Function wrapper; + private final Function getter; private final Map map = new HashMap<>(); public RowWrappedEnumeratedColumnTableModel(PluginTool tool, String name, Class colType, - Function keyFunc, Function wrapper) { + Function keyFunc, Function wrapper, Function getter) { super(tool, name, colType); this.keyFunc = keyFunc; this.wrapper = wrapper; + this.getter = getter; } protected synchronized R addRowFor(T t) { @@ -130,6 +133,11 @@ public class RowWrappedEnumeratedColumnTableModel & Enumerated return r; } + public synchronized void deleteItemsWith(Predicate predicate) { + List deleted = deleteWith(r -> predicate.test(getter.apply(r))); + map.values().removeAll(deleted); + } + public synchronized void deleteAllItems(Collection c) { deleteWith(getRows(c)::contains); map.keySet().removeAll(c.stream().map(keyFunc).collect(Collectors.toList())); diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/AbstractPcodeMachine.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/AbstractPcodeMachine.java index 286aaeed24..b01c9922c8 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/AbstractPcodeMachine.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/AbstractPcodeMachine.java @@ -64,6 +64,8 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { protected final PcodeUseropLibrary stubLibrary; + protected SwiMode swiMode = SwiMode.ACTIVE; + /* for abstract thread access */ PcodeStateInitializer initializer; private PcodeExecutorState sharedState; protected final Map> threads = new LinkedHashMap<>(); @@ -145,12 +147,12 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { protected abstract PcodeExecutorState createLocalState(PcodeThread thread); /** - * A factory method to create a stub library for compiling thread-local SLEIGH source + * A factory method to create a stub library for compiling thread-local Sleigh source * *

    * Because threads may introduce p-code userops using libraries unique to that thread, it * becomes necessary to at least export stub symbols, so that p-code programs can be compiled - * from SLEIGH source before the thread has necessarily been created. A side effect of this + * from Sleigh source before the thread has necessarily been created. A side effect of this * strategy is that all threads, though they may have independent libraries, must export * identically-named symbols. * @@ -160,6 +162,16 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { return new DefaultPcodeThread.PcodeEmulationLibrary(null); } + @Override + public void setSoftwareInterruptMode(SwiMode mode) { + this.swiMode = mode; + } + + @Override + public SwiMode getSoftwareInterruptMode() { + return swiMode; + } + /** * A factory method to create a new thread in this machine * @@ -319,7 +331,17 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { accessBreakpoints.clear(); } - protected void checkLoad(AddressSpace space, T offset) { + /** + * Perform checks on a requested LOAD + * + *

    + * Throw an exception if the LOAD should cause an interrupt. + * + * @param space the address space being accessed + * @param offset the offset being accessed + * @param size the size of the variable being accessed + */ + protected void checkLoad(AddressSpace space, T offset, int size) { if (accessBreakpoints.isEmpty()) { return; } @@ -334,7 +356,17 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { } } - protected void checkStore(AddressSpace space, T offset) { + /** + * Perform checks on a requested STORE + * + *

    + * Throw an exception if the STORE should cause an interrupt. + * + * @param space the address space being accessed + * @param offset the offset being accessed + * @param size the size of the variable being accessed + */ + protected void checkStore(AddressSpace space, T offset, int size) { if (accessBreakpoints.isEmpty()) { return; } @@ -348,4 +380,23 @@ public abstract class AbstractPcodeMachine implements PcodeMachine { // Consider this not hitting any breakpoint } } + + /** + * Throw a software interrupt exception if those interrupts are active + */ + protected void swi() { + if (swiMode == SwiMode.ACTIVE) { + throw new InterruptPcodeExecutionException(null, null); + } + } + + /** + * Notify the machine a thread has been stepped, so that it may re-enable software interrupts, + * if applicable + */ + protected void stepped() { + if (swiMode == SwiMode.IGNORE_STEP) { + swiMode = SwiMode.ACTIVE; + } + } } diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/DefaultPcodeThread.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/DefaultPcodeThread.java index 25b0d275a9..9a0d908116 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/DefaultPcodeThread.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/DefaultPcodeThread.java @@ -121,7 +121,21 @@ public class DefaultPcodeThread implements PcodeThread { */ @PcodeUserop public void emu_swi() { - throw new InterruptPcodeExecutionException(null, null); + thread.swi(); + } + + /** + * Notify the client of a failed Sleigh inject compilation. + * + *

    + * To avoid pestering the client during emulator set-up, a service may effectively defer + * notifying the user of Sleigh compilation errors by replacing the erroneous injects with + * calls to this p-code op. Then, only if and when an erroneous inject is encountered will + * the client be notified. + */ + @PcodeUserop + public void emu_injection_err() { + throw new InjectionErrorPcodeExecutionException(null, null); } } @@ -162,16 +176,17 @@ public class DefaultPcodeThread implements PcodeThread { throw new SuspendedPcodeExecutionException(frame, null); } super.stepOp(op, frame, library); + thread.stepped(); } @Override - protected void checkLoad(AddressSpace space, T offset) { - thread.checkLoad(space, offset); + protected void checkLoad(AddressSpace space, T offset, int size) { + thread.checkLoad(space, offset, size); } @Override - protected void checkStore(AddressSpace space, T offset) { - thread.checkStore(space, offset); + protected void checkStore(AddressSpace space, T offset, int size) { + thread.checkStore(space, offset, size); } @Override @@ -623,11 +638,46 @@ public class DefaultPcodeThread implements PcodeThread { injects.clear(); } - protected void checkLoad(AddressSpace space, T offset) { - machine.checkLoad(space, offset); + /** + * Perform checks on a requested LOAD + * + *

    + * Throw an exception if the LOAD should cause an interrupt. + * + * @param space the address space being accessed + * @param offset the offset being accessed + * @param size the size of the variable being accessed + */ + protected void checkLoad(AddressSpace space, T offset, int size) { + machine.checkLoad(space, offset, size); } - protected void checkStore(AddressSpace space, T offset) { - machine.checkStore(space, offset); + /** + * Perform checks on a requested STORE + * + *

    + * Throw an exception if the STORE should cause an interrupt. + * + * @param space the address space being accessed + * @param offset the offset being accessed + * @param size the size of the variable being accessed + */ + protected void checkStore(AddressSpace space, T offset, int size) { + machine.checkStore(space, offset, size); + } + + /** + * Throw a software interrupt exception if those interrupts are active + */ + protected void swi() { + machine.swi(); + } + + /** + * Notify the machine a thread has been stepped, so that it may re-enable software interrupts, + * if applicable + */ + protected void stepped() { + machine.stepped(); } } diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeMachine.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeMachine.java index 1348ed1b4f..dc020c7b35 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeMachine.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeMachine.java @@ -20,9 +20,9 @@ import java.util.Collection; import ghidra.app.plugin.processors.sleigh.SleighLanguage; import ghidra.pcode.emu.DefaultPcodeThread.PcodeEmulationLibrary; import ghidra.pcode.exec.*; +import ghidra.pcode.exec.PcodeArithmetic.Purpose; import ghidra.pcode.exec.PcodeExecutorStatePiece.Reason; -import ghidra.program.model.address.Address; -import ghidra.program.model.address.AddressRange; +import ghidra.program.model.address.*; import ghidra.program.model.pcode.PcodeOp; import ghidra.program.model.pcode.Varnode; @@ -33,6 +33,28 @@ import ghidra.program.model.pcode.Varnode; */ public interface PcodeMachine { + /** + * Specifies whether or not to interrupt on p-code breakpoints + */ + enum SwiMode { + /** + * Heed {@link PcodeEmulationLibrary#emu_swi()} calls + */ + ACTIVE, + /** + * Ignore all {@link PcodeEmulationLibrary#emu_swi()} calls + */ + IGNORE_ALL, + /** + * Ignore {@link PcodeEmulationLibrary#emu_swi()} calls for one p-code step + * + *

    + * The mode is reset to {@link #ACTIVE} after one p-code step, whether or not that step + * causes an SWI. + */ + IGNORE_STEP, + } + /** * The kind of access breakpoint */ @@ -86,6 +108,25 @@ public interface PcodeMachine { */ PcodeArithmetic getArithmetic(); + /** + * Change the efficacy of p-code breakpoints + * + *

    + * This is used to prevent breakpoints from interrupting at inappropriate times, e.g., upon + * continuing from a breakpoint. + * + * @param mode the new mode + * @see #withSoftwareInterruptMode(SwiMode) + */ + void setSoftwareInterruptMode(SwiMode mode); + + /** + * Get the current software interrupt mode + * + * @return the mode + */ + SwiMode getSoftwareInterruptMode(); + /** * Get the userop library common to all threads in the machine. * diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeStateInitializer.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeStateInitializer.java index 8f71749332..44983120c4 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeStateInitializer.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeStateInitializer.java @@ -22,7 +22,7 @@ import ghidra.util.classfinder.ExtensionPoint; * An extension for preparing execution state for sleigh emulation * *

    - * As much as possible, it's highly-recommended to use SLEIGH execution to perform any + * As much as possible, it's highly-recommended to use Sleigh execution to perform any * modifications. This will help it remain agnostic to various state types. * *

    @@ -40,7 +40,7 @@ public interface PcodeStateInitializer extends ExtensionPoint { /** * The machine's memory state has just been initialized, and additional initialization is needed - * for SLEIGH execution + * for Sleigh execution * *

    * There's probably not much preparation of memory @@ -53,11 +53,11 @@ public interface PcodeStateInitializer extends ExtensionPoint { /** * The thread's register state has just been initialized, and additional initialization is - * needed for SLEIGH execution + * needed for Sleigh execution * *

    * Initialization generally consists of setting "virtual" registers using data from the real - * ones. Virtual registers are those specified in the SLEIGH, but which don't actually exist on + * ones. Virtual registers are those specified in the Sleigh, but which don't actually exist on * the target processor. Often, they exist to simplify static analysis, but unfortunately cause * a minor headache for dynamic execution. * diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeThread.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeThread.java index 5aaf8db45a..c858148988 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeThread.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/PcodeThread.java @@ -19,6 +19,7 @@ import java.util.List; import ghidra.app.plugin.processors.sleigh.SleighLanguage; import ghidra.pcode.emu.DefaultPcodeThread.PcodeEmulationLibrary; +import ghidra.pcode.emu.PcodeMachine.SwiMode; import ghidra.pcode.exec.*; import ghidra.program.model.address.Address; import ghidra.program.model.lang.Register; diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java index 8c50ad1939..c613dffac2 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/emu/SleighInstructionDecoder.java @@ -28,7 +28,7 @@ import ghidra.util.Msg; import ghidra.util.task.TaskMonitor; /** - * The default instruction decoder, based on SLEIGH + * The default instruction decoder, based on Sleigh * *

    * This simply uses a {@link Disassembler} on the machine's memory state. @@ -53,7 +53,7 @@ public class SleighInstructionDecoder implements InstructionDecoder { private PseudoInstruction instruction; /** - * Construct a SLEIGH instruction decoder + * Construct a Sleigh instruction decoder * * @see {@link DefaultPcodeThread#createInstructionDecoder(PcodeExecutorState)} * @param language the language to decoder diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/InjectionErrorPcodeExecutionException.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/InjectionErrorPcodeExecutionException.java new file mode 100644 index 0000000000..1b9897c866 --- /dev/null +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/InjectionErrorPcodeExecutionException.java @@ -0,0 +1,26 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.pcode.exec; + +/** + * Exception thrown by {@link PcodeEmulationLibrary#emu_injection_err(), a p-code userop invoked + * when client-provided Sleigh code in an injection could not be compiled. + */ +public class InjectionErrorPcodeExecutionException extends PcodeExecutionException { + public InjectionErrorPcodeExecutionException(PcodeFrame frame, Throwable cause) { + super("Error compiling injected Sleigh source", frame, cause); + } +} diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExecutor.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExecutor.java index bb59ee9a30..6267adf898 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExecutor.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExecutor.java @@ -35,7 +35,7 @@ import ghidra.program.model.pcode.Varnode; * An executor of p-code programs * *

    - * This is the kernel of SLEIGH expression evaluation and p-code emulation. For a complete example + * This is the kernel of Sleigh expression evaluation and p-code emulation. For a complete example * of a p-code emulator, see {@link PcodeEmulator}. * * @param the type of values processed by the executor @@ -68,7 +68,7 @@ public class PcodeExecutor { } /** - * Get the executor's SLEIGH language (processor model) + * Get the executor's Sleigh language (processor model) * * @return the language */ @@ -334,8 +334,9 @@ public class PcodeExecutor { * * @param space the address space to be loaded from * @param offset the offset about to be loaded from + * @param size the size in bytes to be loaded */ - protected void checkLoad(AddressSpace space, T offset) { + protected void checkLoad(AddressSpace space, T offset, int size) { } /** @@ -348,8 +349,8 @@ public class PcodeExecutor { AddressSpace space = language.getAddressFactory().getAddressSpace(spaceID); Varnode inOffset = op.getInput(1); T offset = state.getVar(inOffset, reason); - checkLoad(space, offset); Varnode outVar = op.getOutput(); + checkLoad(space, offset, outVar.getSize()); T out = state.getVar(space, offset, outVar.getSize(), true, reason); T mod = arithmetic.modAfterLoad(outVar.getSize(), inOffset.getSize(), offset, @@ -362,8 +363,9 @@ public class PcodeExecutor { * * @param space the address space to be stored to * @param offset the offset about to be stored to + * @param size the size in bytes to be stored */ - protected void checkStore(AddressSpace space, T offset) { + protected void checkStore(AddressSpace space, T offset, int size) { } /** @@ -376,8 +378,8 @@ public class PcodeExecutor { AddressSpace space = language.getAddressFactory().getAddressSpace(spaceID); Varnode inOffset = op.getInput(1); T offset = state.getVar(inOffset, reason); - checkStore(space, offset); Varnode valVar = op.getInput(2); + checkStore(space, offset, valVar.getSize()); T val = state.getVar(valVar, reason); T mod = arithmetic.modBeforeStore(valVar.getSize(), inOffset.getSize(), offset, diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExpression.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExpression.java index 73f5f5af71..9d9a3e7971 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExpression.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeExpression.java @@ -23,7 +23,7 @@ import ghidra.pcodeCPort.slghsymbol.UserOpSymbol; import ghidra.program.model.pcode.PcodeOp; /** - * A p-code program derived from, i.e., implementing, a SLEIGH expression + * A p-code program that evaluates a Sleigh expression */ public class PcodeExpression extends PcodeProgram { public static final String RESULT_NAME = "___result"; diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeFrame.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeFrame.java index fb130cd6a9..01b6ec9d73 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeFrame.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeFrame.java @@ -39,7 +39,7 @@ import ghidra.program.model.pcode.PcodeOp; *

    * A p-code emulator feeds p-code to an executor by decoding one instruction at a time. Thus, the * "current p-code program" comprises only those ops generated by a single instruction. Or else, it - * is a user-supplied p-code program, e.g., to evaluate a SLEIGH expression. The frame completes the + * is a user-supplied p-code program, e.g., to evaluate a Sleigh expression. The frame completes the * program by falling-through, i.e., stepping past the final op, or by branching externally, i.e., * to a different machine instruction. The emulator must then update its program counter accordingly * and proceed to the next instruction. @@ -222,7 +222,7 @@ public class PcodeFrame { * Get the name of the userop for the given number * * @param userop the userop number, as encoded in the first operand of {@link PcodeOp#CALLOTHER} - * @return the name of the userop, as expressed in the SLEIGH source + * @return the name of the userop, as expressed in the Sleigh source */ public String getUseropName(int userop) { return useropNames.get(userop); diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java index 5b9a485d64..b9cba81972 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/PcodeUseropLibrary.java @@ -101,7 +101,7 @@ public interface PcodeUseropLibrary { * Get the name of the userop. * *

    - * This is the symbol assigned to the userop when compiling new SLEIGH code. It cannot + * This is the symbol assigned to the userop when compiling new Sleigh code. It cannot * conflict with existing userops (except those declared, but not defined, by the executor's * language) or other symbols of the executor's language. If this userop is to be used * generically across many languages, choose an unlikely name. Conventionally, these start diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighPcodeUseropDefinition.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighPcodeUseropDefinition.java index 9a0110575a..6236bb22a3 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighPcodeUseropDefinition.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighPcodeUseropDefinition.java @@ -22,7 +22,7 @@ import ghidra.pcode.exec.PcodeUseropLibrary.PcodeUseropDefinition; import ghidra.program.model.pcode.Varnode; /** - * A p-code userop defined using SLEIGH source + * A p-code userop defined using Sleigh source * * @param no type in particular, except to match any executor */ @@ -107,7 +107,7 @@ public class SleighPcodeUseropDefinition implements PcodeUseropDefinition *

    * NOTE: Compilation of the sleigh source is delayed until the first invocation, since the * compiler must know about the varnodes used as parameters. TODO: There may be some way to - * template it at the p-code level instead of the SLEIGH source level. + * template it at the p-code level instead of the Sleigh source level. * * @param no particular type, except to match the executor * @return the definition diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighProgramCompiler.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighProgramCompiler.java index d8d8986a3f..54e80fe237 100644 --- a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighProgramCompiler.java +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighProgramCompiler.java @@ -42,8 +42,8 @@ import ghidra.util.Msg; * resulting program. Many utility methods are declared public here because they, well, they have * utility. The main public methods of this class, however, all start with {@code compile}.... */ -public class SleighProgramCompiler { - +public enum SleighProgramCompiler { + ; private static final String EXPRESSION_SOURCE_NAME = "expression"; public static final String NIL_SYMBOL_NAME = "__nil"; diff --git a/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighUtils.java b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighUtils.java new file mode 100644 index 0000000000..52332022fc --- /dev/null +++ b/Ghidra/Debug/ProposedUtils/src/main/java/ghidra/pcode/exec/SleighUtils.java @@ -0,0 +1,776 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.pcode.exec; + +import java.io.*; +import java.util.*; +import java.util.function.Consumer; +import java.util.stream.Collectors; + +import org.antlr.runtime.*; +import org.antlr.runtime.tree.CommonTree; +import org.antlr.runtime.tree.Tree; + +import ghidra.sleigh.grammar.*; + +/** + * A collection of utilities for parsing and manipulating Sleigh semantic source + */ +public enum SleighUtils { + ; + + public static final String CONDITION_ALWAYS = "1:1"; + public static final String UNCONDITIONAL_BREAK = """ + emu_swi(); + emu_exec_decoded(); + """; + + /** + * A Sleigh parsing error + */ + public record SleighParseErrorEntry(String header, String message, int start, int stop) { + public String fullMessage() { + return header + " " + message; + } + } + + /** + * An exception carrying one or more Sleigh parsing errors + */ + public static class SleighParseError extends RuntimeException { + private final List errors; + + public SleighParseError(Collection errors) { + super(errors.stream().map(e -> e.fullMessage()).collect(Collectors.joining("\n"))); + this.errors = List.copyOf(errors); + } + + /** + * Get the actual errors + * + * @return the list of entries + */ + public List getErrors() { + return errors; + } + } + + /** + * A function representing a non-terminal in the Sleigh semantic grammar + * + * @param the return type + */ + public interface ParseFunction { + T apply(SleighParser parser) throws RecognitionException; + } + + /** + * Parse a non-terminal symbol from the Sleigh semantic grammar + * + *

    + * Because the ANTLR parsing function for the non-terminal symbol depends on the "follows" set + * to determine when it has finished, we can't just invoke the function in isolation without + * some hacking. If EOF is not in the non-terminal's follows set, then it won't recognize EOF as + * completing the non-terminal. Instead, we have to present some token that it will recognize. + * Furthermore, regardless of the follow token, we have to check that all of the given input was + * consumed by the parser. + * + * @param the type of result from parsing + * @param nt the function from the parser implementing the non-terminal symbol + * @param text the text to parse + * @param follow a token that would ordinarily follow the non-terminal symbol, or empty for EOF + * @return the parsed result + */ + public static T parseSleigh(ParseFunction nt, + String text, String follow) { + LineArrayListWriter writer = new LineArrayListWriter(); + ParsingEnvironment env = new ParsingEnvironment(writer); + + // inject pcode statement lines into writer (needed for error reporting) + BufferedReader r = new BufferedReader(new StringReader(text)); + String line; + try { + while ((line = r.readLine()) != null) { + writer.write(line); + writer.newLine(); + } + } + catch (IOException e) { + throw new AssertionError(e); + } + + String inputText = writer.toString().stripTrailing(); + CharStream input = new ANTLRStringStream(inputText + follow); + + env.getLocator().registerLocation(0, new Location("sleigh", 0)); + + SleighLexer lex = new SleighLexer(input); + lex.setEnv(env); + UnbufferedTokenStream tokens = new UnbufferedTokenStream(lex); + List errors = new ArrayList<>(); + SleighParser parser = new SleighParser(tokens) { + private void collectError(String[] tokenNames, RecognitionException e) { + String hdr = getErrorHeader(e); + String msg = getErrorMessage(e, tokenNames); + CommonToken ct = (CommonToken) e.token; + errors.add(new SleighParseErrorEntry(hdr, msg, ct.getStartIndex(), + ct.getStopIndex())); + } + + { + this.gSemanticParser = new SleighParser_SemanticParser(input, state, this) { + @Override + public void displayRecognitionError(String[] tokenNames, + RecognitionException e) { + collectError(tokenNames, e); + } + + @Override + public void emitErrorMessage(String msg) { + throw new AssertionError(); + } + }; + } + + @Override + public void displayRecognitionError(String[] tokenNames, RecognitionException e) { + collectError(tokenNames, e); + } + + @Override + public void emitErrorMessage(String msg) { + throw new AssertionError(); + } + }; + parser.setEnv(env); + parser.setLexer(lex); + lex.pushMode(SleighRecognizerConstants.SEMANTIC); + T t; + try { + t = nt.apply(parser); + } + catch (RecognitionException e) { + parser.reportError(e); + return null; + } + lex.popMode(); + + CommonToken lastTok = (CommonToken) tokens.elementAt(0); + if (follow.isEmpty()) { + if (!tokens.isEOF(lastTok)) { + parser.reportError(new UnwantedTokenException(Token.EOF, tokens)); + } + } + else { + if (inputText.length() != lastTok.getStartIndex()) { + parser.reportError(new UnwantedTokenException(Token.EOF, tokens)); + } + } + + if (!errors.isEmpty()) { + throw new SleighParseError(errors); + } + + return t; + } + + /** + * Parse a semantic block, that is a list of Sleigh semantic statements + * + * @param sleigh the source + * @return the parse tree + */ + public static Tree parseSleighSemantic(String sleigh) { + return parseSleigh(SleighParser::semantic, sleigh, "").getTree(); + } + + /** + * Parse a semantic expression + * + * @param expression the expression as a string + * @return the parse tree + */ + public static Tree parseSleighExpression(String expression) { + return parseSleigh(SleighParser::expr, expression, ";").getTree(); + } + + /** + * An exception indicating the parse tree did not match a pattern + */ + public static class MismatchException extends RuntimeException { + } + + private static String getIdentifier(Tree tree) { + if (tree.getType() != SleighParser.IDENTIFIER) { + throw new MismatchException(); + } + return tree.getText(); + } + + private static boolean isIdentifier(Tree tree, String id) { + return id.equals(getIdentifier(tree)); + } + + private static void matchIdentifier(Tree tree, String id) { + if (!isIdentifier(tree, id)) { + throw new MismatchException(); + } + } + + /** + * Get the children of a parse tree node + * + * @param tree the node + * @return the list of children + */ + public static List getChildren(Tree tree) { + final int count = tree.getChildCount(); + List children = Arrays.asList(new Tree[count]); + for (int i = 0; i < count; i++) { + children.set(i, tree.getChild(i)); + } + return children; + } + + /** + * Match the given tree to a given pattern + * + * @param tree the (sub-)tree to match, actually its root node + * @param type the expected type of the given node + * @param onChildren actions (usually sub-matching) to perform on the children + */ + public static void matchTree(Tree tree, int type, Consumer> onChildren) { + if (tree.getType() != type) { + throw new MismatchException(); + } + onChildren.accept(getChildren(tree)); + } + + /** + * Require (as part of pattern matching) that the given list of children has a particular size + * + * @param count the required size + * @param list the list of children + */ + public static void requireCount(int count, List list) { + if (count != list.size()) { + throw new MismatchException(); + } + } + + /** + * Match the given tree to a given pattern with per-child actions + * + * @param tree the (sub-)tree to match, actually its root node + * @param type the expected type of the given node + * @param onChild a list of actions (usually sub-matching) to perform on each corresponding + * child. The matcher will verify the number of children matches the number of + * actions. + */ + @SafeVarargs + public static void match(Tree tree, int type, Consumer... onChild) { + matchTree(tree, type, children -> { + requireCount(onChild.length, children); + for (int i = 0; i < onChild.length; i++) { + onChild[i].accept(children.get(i)); + } + }); + } + + /** + * Check if the given tree represents an unconditional breakpoint in the emulator + * + * @param tree the result of parsing a semantic block + * @return true if an unconditional breakpoint, false otherwise + */ + public static boolean isUnconditionalBreakpoint(Tree tree) { + try { + match(tree, SleighParser.OP_SEMANTIC, wantApplyEmuSwi -> { + match(wantApplyEmuSwi, SleighParser.OP_APPLY, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + matchIdentifier(id, "emu_swi"); + }); + }); + }, wantApplyEmuExecDecoded -> { + match(wantApplyEmuExecDecoded, SleighParser.OP_APPLY, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + matchIdentifier(id, "emu_exec_decoded"); + }); + }); + }); + return true; + } + catch (MismatchException e) { + return false; + } + } + + /** + * Check if the given tree represents a conditional breakpoint, and recover that condition + * + * @param tree the result of parsing a semantic block + * @return the condition if matched, null otherwise + */ + public static String recoverConditionFromBreakpoint(Tree tree) { + try { + var l = new Object() { + Tree cond; + String labelId; + }; + match(tree, SleighParser.OP_SEMANTIC, wantIf -> { + match(wantIf, SleighParser.OP_IF, cond -> { + l.cond = cond; + }, wantGotoLabel -> { + match(wantGotoLabel, SleighParser.OP_GOTO, wantJumpDest -> { + match(wantJumpDest, SleighParser.OP_JUMPDEST_LABEL, wantLabel -> { + match(wantLabel, SleighParser.OP_LABEL, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + l.labelId = getIdentifier(id); + }); + }); + }); + }); + }); + }, wantApplyEmuSwi -> { + match(wantApplyEmuSwi, SleighParser.OP_APPLY, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + matchIdentifier(id, "emu_swi"); + }); + }); + }, wantLabel -> { + match(wantLabel, SleighParser.OP_LABEL, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + matchIdentifier(id, l.labelId); + }); + }); + }, wantApplyEmuExecDecoded -> { + match(wantApplyEmuExecDecoded, SleighParser.OP_APPLY, wantId -> { + match(wantId, SleighParser.OP_IDENTIFIER, id -> { + matchIdentifier(id, "emu_exec_decoded"); + }); + }); + }); + return generateSleighExpression(notTree(l.cond)); + } + catch (MismatchException e) { + return null; + } + } + + /** + * Check if the given Sleigh semantic block implements a conditional breakpoint, and recover + * that condition + * + * @param sleigh the source for a Sleigh semantic block + * @return the condition if matched, null otherwise + */ + public static String recoverConditionFromBreakpoint(String sleigh) { + try { + Tree tree = parseSleighSemantic(sleigh); + if (isUnconditionalBreakpoint(tree)) { + return CONDITION_ALWAYS; + } + return recoverConditionFromBreakpoint(tree); + } + catch (SleighParseError e) { + return null; + } + } + + /** + * Synthesize a tree (node) + * + * @param type the type of the node + * @param text the "text" of the node + * @param children the children + * @return the new node + */ + public static Tree makeTree(int type, String text, List children) { + CommonTree tree = new CommonTree(new CommonToken(type, text)); + tree.addChildren(children); + return tree; + } + + private static void catChildrenWithSep(Tree tree, String sep, int chopFront, int chopBack, + StringBuilder sb) { + int count = tree.getChildCount() - chopFront - chopBack; + for (int i = 0; i < count; i++) { + if (i != 0) { + sb.append(sep); + } + generateSleighExpression(tree.getChild(i + chopFront), sb); + } + } + + private static void generateSleighExpression(Tree tree, StringBuilder sb) { + switch (tree.getType()) { + case SleighParser.BIN_INT: + case SleighParser.DEC_INT: + case SleighParser.HEX_INT: + case SleighParser.IDENTIFIER: + sb.append(tree.getText()); + break; + + case SleighParser.OP_BIN_CONSTANT: + case SleighParser.OP_DEC_CONSTANT: + case SleighParser.OP_HEX_CONSTANT: + case SleighParser.OP_IDENTIFIER: + generateSleighExpression(tree.getChild(0), sb); + break; + + case SleighParser.OP_NOT: + sb.append("!"); + generateSleighExpression(tree.getChild(0), sb); + break; + case SleighParser.OP_INVERT: + sb.append("~"); + generateSleighExpression(tree.getChild(0), sb); + break; + case SleighParser.OP_NEGATE: + sb.append("-"); + generateSleighExpression(tree.getChild(0), sb); + break; + case SleighParser.OP_FNEGATE: + sb.append("f-"); + generateSleighExpression(tree.getChild(0), sb); + break; + + case SleighParser.OP_ADD: + catChildrenWithSep(tree, " + ", 0, 0, sb); + break; + case SleighParser.OP_SUB: + catChildrenWithSep(tree, " - ", 0, 0, sb); + break; + case SleighParser.OP_MULT: + catChildrenWithSep(tree, " * ", 0, 0, sb); + break; + case SleighParser.OP_DIV: + catChildrenWithSep(tree, " / ", 0, 0, sb); + break; + case SleighParser.OP_REM: + catChildrenWithSep(tree, " % ", 0, 0, sb); + break; + + case SleighParser.OP_SDIV: + catChildrenWithSep(tree, " s/ ", 0, 0, sb); + break; + case SleighParser.OP_SREM: + catChildrenWithSep(tree, " s% ", 0, 0, sb); + break; + + case SleighParser.OP_FADD: + catChildrenWithSep(tree, " f+ ", 0, 0, sb); + break; + case SleighParser.OP_FSUB: + catChildrenWithSep(tree, " f- ", 0, 0, sb); + break; + case SleighParser.OP_FMULT: + catChildrenWithSep(tree, " f* ", 0, 0, sb); + break; + case SleighParser.OP_FDIV: + catChildrenWithSep(tree, " f/ ", 0, 0, sb); + break; + + case SleighParser.OP_LEFT: + catChildrenWithSep(tree, " << ", 0, 0, sb); + break; + case SleighParser.OP_RIGHT: + catChildrenWithSep(tree, " >> ", 0, 0, sb); + break; + case SleighParser.OP_SRIGHT: + catChildrenWithSep(tree, " s>> ", 0, 0, sb); + break; + + case SleighParser.OP_AND: + catChildrenWithSep(tree, " & ", 0, 0, sb); + break; + case SleighParser.OP_OR: + catChildrenWithSep(tree, " | ", 0, 0, sb); + break; + case SleighParser.OP_XOR: + catChildrenWithSep(tree, " ^ ", 0, 0, sb); + break; + case SleighParser.OP_BOOL_AND: + catChildrenWithSep(tree, " && ", 0, 0, sb); + break; + case SleighParser.OP_BOOL_OR: + catChildrenWithSep(tree, " || ", 0, 0, sb); + break; + case SleighParser.OP_BOOL_XOR: + catChildrenWithSep(tree, " ^^ ", 0, 0, sb); + break; + + case SleighParser.OP_EQUAL: + catChildrenWithSep(tree, " == ", 0, 0, sb); + break; + case SleighParser.OP_NOTEQUAL: + catChildrenWithSep(tree, " != ", 0, 0, sb); + break; + case SleighParser.OP_FEQUAL: + catChildrenWithSep(tree, " f== ", 0, 0, sb); + break; + case SleighParser.OP_FNOTEQUAL: + catChildrenWithSep(tree, " f!= ", 0, 0, sb); + break; + + case SleighParser.OP_LESS: + catChildrenWithSep(tree, " < ", 0, 0, sb); + break; + case SleighParser.OP_LESSEQUAL: + catChildrenWithSep(tree, " <= ", 0, 0, sb); + break; + case SleighParser.OP_GREATEQUAL: + catChildrenWithSep(tree, " >= ", 0, 0, sb); + break; + case SleighParser.OP_GREAT: + catChildrenWithSep(tree, " > ", 0, 0, sb); + break; + + case SleighParser.OP_SLESS: + catChildrenWithSep(tree, " s< ", 0, 0, sb); + break; + case SleighParser.OP_SLESSEQUAL: + catChildrenWithSep(tree, " s<= ", 0, 0, sb); + break; + case SleighParser.OP_SGREATEQUAL: + catChildrenWithSep(tree, " s>= ", 0, 0, sb); + break; + case SleighParser.OP_SGREAT: + catChildrenWithSep(tree, " s> ", 0, 0, sb); + break; + + case SleighParser.OP_FLESS: + catChildrenWithSep(tree, " f< ", 0, 0, sb); + break; + case SleighParser.OP_FLESSEQUAL: + catChildrenWithSep(tree, " f<= ", 0, 0, sb); + break; + case SleighParser.OP_FGREATEQUAL: + catChildrenWithSep(tree, " f>= ", 0, 0, sb); + break; + case SleighParser.OP_FGREAT: + catChildrenWithSep(tree, " f> ", 0, 0, sb); + break; + + case SleighParser.OP_DEREFERENCE: + if (tree.getChildCount() == 3) { + sb.append("*["); + generateSleighExpression(tree.getChild(0), sb); + sb.append("]:"); + generateSleighExpression(tree.getChild(1), sb); + sb.append(" "); + generateSleighExpression(tree.getChild(2), sb); + } + else if (tree.getChildCount() == 2) { + Tree child0 = tree.getChild(0); + switch (child0.getType()) { + case SleighParser.OP_IDENTIFIER: + sb.append("*["); + generateSleighExpression(child0, sb); + sb.append("] "); + generateSleighExpression(tree.getChild(1), sb); + break; + case SleighParser.OP_BIN_CONSTANT: + case SleighParser.OP_DEC_CONSTANT: + case SleighParser.OP_HEX_CONSTANT: + sb.append("*:"); + generateSleighExpression(child0, sb); + sb.append(" "); + generateSleighExpression(tree.getChild(1), sb); + break; + default: + throw new AssertionError( + "OP_DEREFERENCE with 2 children where child[0] is " + + SleighParser.tokenNames[child0.getType()]); + } + } + else if (tree.getChildCount() == 1) { + sb.append("*"); + generateSleighExpression(tree.getChild(0), sb); + } + else { + throw new AssertionError( + "OP_DEREFERENCE with " + tree.getChildCount() + " children"); + } + break; + case SleighParser.OP_ADDRESS_OF: + if (tree.getChildCount() == 2) { + sb.append("&"); + generateSleighExpression(tree.getChild(0), sb); + sb.append(" "); + generateSleighExpression(tree.getChild(1), sb); + } + else if (tree.getChildCount() == 1) { + sb.append("&"); + generateSleighExpression(tree.getChild(0), sb); + } + else { + throw new AssertionError( + "OP_ADDRESS_OF with " + tree.getChildCount() + " children"); + } + break; + case SleighParser.OP_SIZING_SIZE: + sb.append(":"); + generateSleighExpression(tree.getChild(0), sb); + break; + case SleighParser.OP_APPLY: + generateSleighExpression(tree.getChild(0), sb); + sb.append("("); + catChildrenWithSep(tree, ", ", 1, 0, sb); + sb.append(")"); + break; + case SleighParser.OP_TRUNCATION_SIZE: + generateSleighExpression(tree.getChild(0), sb); + sb.append(":"); + generateSleighExpression(tree.getChild(1), sb); + break; + case SleighParser.OP_BITRANGE: + generateSleighExpression(tree.getChild(0), sb); + sb.append("["); + generateSleighExpression(tree.getChild(1), sb); + sb.append(","); + generateSleighExpression(tree.getChild(2), sb); + sb.append("]"); + break; + case SleighParser.OP_BITRANGE2: + generateSleighExpression(tree.getChild(0), sb); + sb.append(":"); + generateSleighExpression(tree.getChild(1), sb); + break; + case SleighParser.OP_ARGUMENTS: + catChildrenWithSep(tree, ", ", 0, 0, sb); + break; + case SleighParser.OP_PARENTHESIZED: + sb.append("("); + generateSleighExpression(tree.getChild(0), sb); + sb.append(")"); + break; + default: + throw new AssertionError("type = " + SleighParser.tokenNames[tree.getType()]); + } + } + + /** + * Generate source for the given Sleigh parse tree + * + *

    + * Currently, only nodes that could appear in a Sleigh expression are supported. + * + * @param tree the expression tree + * @return the generated string + */ + public static String generateSleighExpression(Tree tree) { + StringBuilder sb = new StringBuilder(); + generateSleighExpression(tree, sb); + return sb.toString(); + } + + /** + * Remove parenthesis from the root of the given tree + * + *

    + * If the root is parenthesis, this simply gets the child. This is applied recursively until a + * non-parenthesis child is encountered. + * + * @param tree the result of parsing a Sleigh expression + * @return the same or sub-tree + */ + public static Tree removeParenthesisTree(Tree tree) { + if (tree.getType() == SleighParser.OP_PARENTHESIZED) { + return removeParenthesisTree(tree.getChild(0)); + } + return tree; + } + + /** + * Apply the boolean "not" operator to a Sleigh expression + * + *

    + * This will attempt to invert the expression when possible, e.g., by changing a top-level + * "equals" to "not equals." If that is not possible, the this adds parenthesis and applies the + * actual Sleigh boolean "not" operator. + * + * @param boolExpr the result of parsing a Sleigh expression + * @return the tree for the inverted expression + */ + public static Tree notTree(Tree boolExpr) { + boolExpr = removeParenthesisTree(boolExpr); + switch (boolExpr.getType()) { + case SleighParser.OP_EQUAL: + return makeTree(SleighParser.OP_NOTEQUAL, "!=", getChildren(boolExpr)); + case SleighParser.OP_NOTEQUAL: + return makeTree(SleighParser.OP_EQUAL, "==", getChildren(boolExpr)); + case SleighParser.OP_FEQUAL: + return makeTree(SleighParser.OP_FNOTEQUAL, "f!=", getChildren(boolExpr)); + case SleighParser.OP_FNOTEQUAL: + return makeTree(SleighParser.OP_FEQUAL, "f==", getChildren(boolExpr)); + + case SleighParser.OP_LESS: + return makeTree(SleighParser.OP_GREATEQUAL, ">=", getChildren(boolExpr)); + case SleighParser.OP_LESSEQUAL: + return makeTree(SleighParser.OP_GREAT, ">", getChildren(boolExpr)); + case SleighParser.OP_GREATEQUAL: + return makeTree(SleighParser.OP_LESS, "<", getChildren(boolExpr)); + case SleighParser.OP_GREAT: + return makeTree(SleighParser.OP_LESSEQUAL, "<=", getChildren(boolExpr)); + + case SleighParser.OP_SLESS: + return makeTree(SleighParser.OP_SGREATEQUAL, "s>=", getChildren(boolExpr)); + case SleighParser.OP_SLESSEQUAL: + return makeTree(SleighParser.OP_SGREAT, "s>", getChildren(boolExpr)); + case SleighParser.OP_SGREATEQUAL: + return makeTree(SleighParser.OP_SLESS, "s<", getChildren(boolExpr)); + case SleighParser.OP_SGREAT: + return makeTree(SleighParser.OP_SLESSEQUAL, "s<=", getChildren(boolExpr)); + + case SleighParser.OP_FLESS: + return makeTree(SleighParser.OP_FGREATEQUAL, "f>=", getChildren(boolExpr)); + case SleighParser.OP_FLESSEQUAL: + return makeTree(SleighParser.OP_FGREAT, "f>", getChildren(boolExpr)); + case SleighParser.OP_FGREATEQUAL: + return makeTree(SleighParser.OP_FLESS, "f<", getChildren(boolExpr)); + case SleighParser.OP_FGREAT: + return makeTree(SleighParser.OP_FLESSEQUAL, "f<=", getChildren(boolExpr)); + + case SleighParser.OP_NOT: + return removeParenthesisTree(boolExpr.getChild(0)); + default: + return makeTree(SleighParser.OP_NOT, "!", List.of( + makeTree(SleighParser.OP_PARENTHESIZED, "(...)", List.of( + boolExpr)))); + } + } + + /** + * Generate Sleigh source for a breakpoint predicated on the given condition + * + * @param condition a Sleigh expression + * @return the Sleigh source + */ + public static String sleighForConditionalBreak(String condition) { + if (CONDITION_ALWAYS.equals(condition)) { + return UNCONDITIONAL_BREAK; + } + Tree tree = parseSleighExpression(condition); + String negCond = generateSleighExpression(notTree(tree)); + return String.format(""" + if %s goto ; + emu_swi(); + + emu_exec_decoded(); + """, negCond); + } +} diff --git a/Ghidra/Debug/ProposedUtils/src/test/java/ghidra/pcode/exec/SleighUtilsTest.java b/Ghidra/Debug/ProposedUtils/src/test/java/ghidra/pcode/exec/SleighUtilsTest.java new file mode 100644 index 0000000000..38c90810ef --- /dev/null +++ b/Ghidra/Debug/ProposedUtils/src/test/java/ghidra/pcode/exec/SleighUtilsTest.java @@ -0,0 +1,300 @@ +/* ### + * IP: GHIDRA + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package ghidra.pcode.exec; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.fail; + +import org.antlr.runtime.RecognitionException; +import org.antlr.runtime.tree.Tree; +import org.junit.Test; + +import ghidra.pcode.exec.SleighUtils.SleighParseError; + +public class SleighUtilsTest { + @Test + public void testParseSleighSemantic() throws RecognitionException { + String mySleigh = """ + if !(RAX == 0) goto ; + emu_swi(); + + emu_exec_decoded(); + """; + Tree tree = SleighUtils.parseSleighSemantic(mySleigh); + assertEquals( + "(OP_SEMANTIC (if (! ((...) (== (IDENTIFIER RAX) (DEC_INT 0)))) (goto " + + "(OP_JUMPDEST_LABEL (< (IDENTIFIER L1))))) (OP_APPLY (IDENTIFIER emu_swi)) " + + "(< (IDENTIFIER L1)) (OP_APPLY (IDENTIFIER emu_exec_decoded)))", + tree.toStringTree()); + } + + @Test + public void testParseSleighSemanticErr() throws RecognitionException { + String mySleigh = """ + if (!(RAX == 0)) goto ; + emu_swi(); + + emu_exec_decoded + """; + try { + SleighUtils.parseSleighSemantic(mySleigh); + fail(); + } + catch (SleighParseError e) { + assertEquals(""" + sleigh line 4: no viable alternative on EOF (missing semi-colon after this?): + + emu_exec_decoded + ----------------^ + """, e.getMessage()); + } + } + + @Test + public void testRecoverConditionEqDec() { + assertEquals("RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if !(RAX == 0) goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionNeqHex() { + assertEquals("RAX != 0x3", + SleighUtils.recoverConditionFromBreakpoint(""" + if RAX == 0x3 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionUserop() { + assertEquals("userop(a, b, c)", + SleighUtils.recoverConditionFromBreakpoint(""" + if !(userop(a,b,c)) goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionAddition() { + assertEquals("RAX + RBX + RCX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if RAX + RBX + RCX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionDeref() { + assertEquals("*RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if *RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionSizedDeref() { + assertEquals("*:4 RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if *:4 RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionSpacedSizedDeref() { + assertEquals("*[ram]:4 RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if *[ram]:4 RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionSpacedDeref() { + assertEquals("*[ram] RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if *[ram] RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionSizedAddressOf() { + assertEquals("&:8 RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if &:8 RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionAddressOf() { + assertEquals("&RAX == 0", + SleighUtils.recoverConditionFromBreakpoint(""" + if &RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionSizedConst() { + assertEquals("!(1:1)", + SleighUtils.recoverConditionFromBreakpoint(""" + if 1:1 goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionNotSizedConst() { + assertEquals("1:1", + SleighUtils.recoverConditionFromBreakpoint(""" + if !(1:1) goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionBitRange() { + assertEquals("RAX[0,1]", + SleighUtils.recoverConditionFromBreakpoint(""" + if !(RAX[0,1]) goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionBitRange2() { + assertEquals("RAX:4", + SleighUtils.recoverConditionFromBreakpoint(""" + if !(RAX:4) goto ; + emu_swi(); + + emu_exec_decoded(); + """)); + } + + @Test + public void testRecoverConditionAlways() { + assertEquals("1:1", + SleighUtils.recoverConditionFromBreakpoint(""" + emu_swi(); + emu_exec_decoded(); + """)); + } + + @Test + public void testParseSleighExpression() throws RecognitionException { + assertEquals("(|| (== (IDENTIFIER RAX) (DEC_INT 0)) (== (IDENTIFIER RBX) (DEC_INT 7)))", + SleighUtils.parseSleighExpression("RAX == 0 || RBX == 7").toStringTree()); + } + + @Test + public void testParseSleighExpressionErr() throws RecognitionException { + try { + SleighUtils.parseSleighExpression("RAX RBX RCX"); + fail(); + } + catch (SleighParseError e) { + assertEquals(""" + sleigh line 1: no viable alternative on IDENTIFIER: 'RBX': + + RAX RBX RCX + ----^ + """, e.getMessage()); + } + } + + @Test + public void testParseSleighExpressionTooMuch() throws RecognitionException { + try { + SleighUtils.parseSleighExpression("RAX == 0;"); + fail(); + } + catch (SleighParseError e) { + assertEquals(""" + sleigh line 1: extraneous input ';' expecting EOF: + + RAX == 0; + --------^ + """, e.getMessage()); + } + } + + @Test + public void testParseSleighExpressionTooLittle() throws RecognitionException { + try { + SleighUtils.parseSleighExpression("RAX =="); + fail(); + } + catch (SleighParseError e) { + assertEquals(""" + sleigh line 1: no viable alternative on SEMI: ';': + + RAX == + ------^ + """, e.getMessage()); + } + } + + @Test + public void testSleighForConditionalBreakpointAlways() throws RecognitionException { + assertEquals(""" + emu_swi(); + emu_exec_decoded(); + """, SleighUtils.sleighForConditionalBreak("1:1")); + } + + @Test + public void testSleighForConditionalBreakpoint() throws RecognitionException { + assertEquals(""" + if RAX != 0 goto ; + emu_swi(); + + emu_exec_decoded(); + """, SleighUtils.sleighForConditionalBreak("RAX == 0")); + } +}