Ghidra is a software reverse engineering (SRE) framework
GP-0: Fix synchronization in memory / byte viewer set-then-update.
Dan7d2452f80353
diff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesPlugin.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesPlugin.javaindex f614fa1b05..9e18898f32 100644--- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesPlugin.java+++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesPlugin.java@@ -39,6 +39,7 @@ import ghidra.framework.plugintool.*;import ghidra.framework.plugintool.annotation.AutoServiceConsumed;import ghidra.framework.plugintool.util.PluginStatus;import ghidra.program.util.ProgramSelection;+import ghidra.trace.model.Trace;import ghidra.trace.model.program.TraceProgramView;@PluginInfo(@@ -149,14 +150,16 @@ public class DebuggerMemoryBytesPluginpublic void processEvent(PluginEvent event) {// do not delegate to superif (event instanceof TraceActivatedPluginEvent ev) {- current = ev.getActiveCoordinates();- allProviders(p -> p.coordinatesActivated(current));+ DebuggerCoordinates coords = ev.getActiveCoordinates();+ current = coords;+ allProviders(p -> p.coordinatesActivated(coords));}else if (event instanceof TraceClosedPluginEvent ev) {- if (current.getTrace() == ev.getTrace()) {+ Trace trace = ev.getTrace();+ if (current.getTrace() == trace) {current = DebuggerCoordinates.NOWHERE;}- allProviders(p -> p.traceClosed(ev.getTrace()));+ allProviders(p -> p.traceClosed(trace));}else if (event instanceof TraceLocationPluginEvent ev) {currentLocation = ev.getLocation();@@ -171,7 +174,9 @@ public class DebuggerMemoryBytesPluginif (provider == null || traceManager == null) {return;}- provider.coordinatesActivated(current = traceManager.getCurrent());+ DebuggerCoordinates coords = traceManager.getCurrent();+ this.current = coords;+ allProviders(p -> p.coordinatesActivated(coords));}@Overridediff --git a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProvider.java b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProvider.javaindex 3a09c47faf..dba4cfb77f 100644--- a/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProvider.java+++ b/Ghidra/Debug/Debugger/src/main/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProvider.java@@ -28,12 +28,12 @@ import java.util.concurrent.*;import javax.swing.*;-import docking.action.builder.ActionBuilder;import org.apache.commons.lang3.StringUtils;import docking.ActionContext;import docking.action.DockingAction;import docking.action.ToggleDockingAction;+import docking.action.builder.ActionBuilder;import docking.menu.MultiStateDockingAction;import docking.widgets.fieldpanel.support.ViewerPosition;import generic.theme.GThemeDefaults.Colors;@@ -254,7 +254,7 @@ public class DebuggerMemoryBytesProvider extends ProgramByteViewerComponentProvi// TODO: followsCurrentSnap?private final ListenerForChanges listenerForChanges = new ListenerForChanges();- private final ControlModeChangeListener controlModeChangeListener = (trace, mode) -> {+ private final ControlModeChangeListener controlModeChangeListener = (trace, _) -> {if (trace == getCurrent().getTrace()) {// for Paste actioncontextChanged();@@ -533,13 +533,13 @@ public class DebuggerMemoryBytesProvider extends ProgramByteViewerComponentProvi.buildAndInstallLocal(this);actionConvertToStackView =- new ActionBuilder("Convert To Stack View", plugin.getName()).description(- "Convert current byte viewer into a stack view")- .enabled(true)- .menuPath("Convert To Stack View")- .menuGroup("aa")- .onAction(this::convertToStackViewActivated)- .buildAndInstallLocal(this);+ new ActionBuilder("Convert To Stack View", plugin.getName()).description(+ "Convert current byte viewer into a stack view")+ .enabled(true)+ .menuPath("Convert To Stack View")+ .menuGroup("aa")+ .onAction(this::convertToStackViewActivated)+ .buildAndInstallLocal(this);}actionGoTo = goToTrait.installAction();@@ -608,10 +608,15 @@ public class DebuggerMemoryBytesProvider extends ProgramByteViewerComponentProvicurrent = coordinates;return;}+ boolean doListeners = coordinates.getTrace() != current.getTrace();previous = current;- removeOldListeners();+ if (doListeners) {+ removeOldListeners();+ }current = coordinates;- addNewListeners();+ if (doListeners) {+ addNewListeners();+ }doSetProgram(current.getView());// NB. Also avoid a stale location being reported to the history service.setLocation(null);diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/AbstractDBTraceProgramViewListing.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/AbstractDBTraceProgramViewListing.javaindex ac0af52788..ff12350742 100644--- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/AbstractDBTraceProgramViewListing.java+++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/AbstractDBTraceProgramViewListing.java@@ -793,12 +793,14 @@ public abstract class AbstractDBTraceProgramViewListing implements TraceProgramV@Overridepublic ProgramFragment getFragment(String treeName, String name) {- RegionEntry entry = program.memory.getRegionsByName().get(name);- if (entry == null) {- return null;+ try (LockHold _ = program.trace.lockRead()) {+ RegionEntry entry = program.memory.getRegionsByName().get(name);+ if (entry == null) {+ return null;+ }+ return fragmentsByRegion.computeIfAbsent(entry.region,+ r -> new DBTraceProgramViewFragment(this, r, entry.snap));}- return fragmentsByRegion.computeIfAbsent(entry.region,- r -> new DBTraceProgramViewFragment(this, r, entry.snap));}@Overridediff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewMemory.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewMemory.javaindex 20dacbaa9e..aab4531289 100644--- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewMemory.java+++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewMemory.java@@ -29,16 +29,16 @@ import ghidra.util.datastruct.WeakValueHashMap;public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {// NB. Keep both per-region and force-full (per-space) block sets ready- private final Map<TraceMemoryRegion, DBTraceProgramViewMemoryRegionBlock> regionBlocks =- new WeakValueHashMap<>();- private final Map<AddressSpace, DBTraceProgramViewMemorySpaceBlock> spaceBlocks =- new WeakValueHashMap<>();+ private final Map<TraceMemoryRegion, DBTraceProgramViewMemoryRegionBlock> regionBlocks;+ private final Map<AddressSpace, DBTraceProgramViewMemorySpaceBlock> spaceBlocks;- private NavigableMap<Address, RegionEntry> regionsByAddress;- private Map<String, RegionEntry> regionsByName;+ private volatile NavigableMap<Address, RegionEntry> regionsByAddress;+ private volatile Map<String, RegionEntry> regionsByName;private volatile boolean regionsValid;public DBTraceProgramViewMemory(DBTraceProgramView program) {+ regionBlocks = new WeakValueHashMap<>();+ spaceBlocks = new WeakValueHashMap<>();super(program);}@@ -145,23 +145,26 @@ public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {return result;}- protected NavigableMap<Address, RegionEntry> getRegionsByAddress() {- if (!regionsValid) {+ protected void validateRegionMaps() {+ synchronized (regionBlocks) {+ if (regionsValid) {+ return;+ }NavigableMap<Address, RegionEntry> byAddr = computeRegionsByAddress();+ Map<String, RegionEntry> byName = computeRegionsByName(byAddr.values());regionsByAddress = byAddr;- regionsByName = computeRegionsByName(byAddr.values());+ regionsByName = byName;regionsValid = true;}+ }++ protected NavigableMap<Address, RegionEntry> getRegionsByAddress() {+ validateRegionMaps();return regionsByAddress;}protected Map<String, RegionEntry> getRegionsByName() {- if (!regionsValid) {- NavigableMap<Address, RegionEntry> byAddr = computeRegionsByAddress();- regionsByAddress = byAddr;- regionsByName = computeRegionsByName(byAddr.values());- regionsValid = true;- }+ validateRegionMaps();return regionsByName;}@@ -180,7 +183,7 @@ public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {protected AddressSet computeRegionsAddressSet() {AddressSet result = new AddressSet();- try (LockHold hold = program.trace.lockRead()) {+ try (LockHold _ = program.trace.lockRead()) {forVisibleRegions(e -> result.add(e.range));}return result;@@ -188,7 +191,7 @@ public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {protected AddressSet computeSpacesAddressSet() {AddressSet result = new AddressSet();- try (LockHold hold = program.trace.lockRead()) {+ try (LockHold _ = program.trace.lockRead()) {forPhysicalSpaces(space -> result.add(space.getMinAddress(), space.getMaxAddress()));}return result;@@ -202,69 +205,81 @@ public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {}protected MemoryBlock getRegionBlock(RegionEntry entry) {- return regionBlocks.computeIfAbsent(entry.region,- r -> new DBTraceProgramViewMemoryRegionBlock(program, entry.region, entry.snap));+ synchronized (regionBlocks) {+ return regionBlocks.computeIfAbsent(entry.region,+ _ -> new DBTraceProgramViewMemoryRegionBlock(program, entry.region, entry.snap));+ }}protected MemoryBlock getSpaceBlock(AddressSpace space) {- return spaceBlocks.computeIfAbsent(space,- s -> new DBTraceProgramViewMemorySpaceBlock(program, space));+ synchronized (spaceBlocks) {+ return spaceBlocks.computeIfAbsent(space,+ _ -> new DBTraceProgramViewMemorySpaceBlock(program, space));+ }}@Overridepublic MemoryBlock getBlock(Address addr) {- if (isForceFullView()) {- return getSpaceBlock(addr.getAddressSpace());- }+ try (LockHold _ = program.trace.lockRead()) {+ if (isForceFullView()) {+ return getSpaceBlock(addr.getAddressSpace());+ }- Entry<Address, RegionEntry> entry = getRegionsByAddress().floorEntry(addr);- if (entry == null || !entry.getValue().range.contains(addr)) {- return null;+ Entry<Address, RegionEntry> entry = getRegionsByAddress().floorEntry(addr);+ if (entry == null || !entry.getValue().range.contains(addr)) {+ return null;+ }+ return getRegionBlock(entry.getValue());}- return getRegionBlock(entry.getValue());}@Overridepublic MemoryBlock getBlock(String blockName) {- if (isForceFullView()) {- AddressSpace space = program.getAddressFactory().getAddressSpace(blockName);- return space == null ? null : getSpaceBlock(space);- }+ try (LockHold _ = program.trace.lockRead()) {+ if (isForceFullView()) {+ AddressSpace space = program.getAddressFactory().getAddressSpace(blockName);+ return space == null ? null : getSpaceBlock(space);+ }- RegionEntry entry = getRegionsByName().get(blockName);- if (entry == null) {- return null;+ RegionEntry entry = getRegionsByName().get(blockName);+ if (entry == null) {+ return null;+ }+ return getRegionBlock(entry);}- return getRegionBlock(entry);}@Overridepublic MemoryBlock[] getBlocks() {- List<MemoryBlock> result = new ArrayList<>();- if (isForceFullView()) {- forPhysicalSpaces(space -> result.add(getSpaceBlock(space)));- }- else {- forVisibleRegions(reg -> result.add(getRegionBlock(reg)));+ try (LockHold _ = program.trace.lockRead()) {+ List<MemoryBlock> result = new ArrayList<>();+ if (isForceFullView()) {+ forPhysicalSpaces(space -> result.add(getSpaceBlock(space)));+ }+ else {+ forVisibleRegions(reg -> result.add(getRegionBlock(reg)));+ }+ Collections.sort(result, Comparator.comparing(b -> b.getStart()));+ return result.toArray(new MemoryBlock[result.size()]);}- Collections.sort(result, Comparator.comparing(b -> b.getStart()));- return result.toArray(new MemoryBlock[result.size()]);}@Overridepublic AddressSetView getExecuteSet() {AddressSet result = new AddressSet();- forVisibleRegions(e -> {- if (e.region.isExecute(e.snap)) {- result.add(e.range);- }- });+ try (LockHold _ = program.trace.lockRead()) {+ forVisibleRegions(e -> {+ if (e.region.isExecute(e.snap)) {+ result.add(e.range);+ }+ });+ }return result;}protected void invalidateRegions() {- regionsValid = false;- if (regionBlocks != null) { // <init> order+ synchronized (regionBlocks) {+ regionsValid = false;regionBlocks.clear();}if (!isForceFullView()) {@@ -277,18 +292,19 @@ public class DBTraceProgramViewMemory extends AbstractDBTraceProgramViewMemory {}public void updateDeleteSpaceBlock(AddressSpace space) {- spaceBlocks.remove(space);+ synchronized (spaceBlocks) {+ spaceBlocks.remove(space);+ }}public void updateRefreshBlocks() {invalidateRegions();- spaceBlocks.clear();+ synchronized (spaceBlocks) {+ spaceBlocks.clear();+ }}public void updateBytesChanged(AddressRange range) {- if (regionBlocks == null) { // <init> order- return;- }cache.invalidate(range);}}diff --git a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewRootModule.java b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewRootModule.javaindex 7a88b6fdb4..a4fb6625e7 100644--- a/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewRootModule.java+++ b/Ghidra/Debug/Framework-TraceModeling/src/main/java/ghidra/trace/database/program/DBTraceProgramViewRootModule.java@@ -188,20 +188,26 @@ public class DBTraceProgramViewRootModule implements ProgramModule {@Overridepublic Address getMinAddress() {- NavigableMap<Address, RegionEntry> regionsByAddress = program.memory.getRegionsByAddress();- if (regionsByAddress.isEmpty()) {- return null;+ try (LockHold _ = program.trace.lockRead()) {+ NavigableMap<Address, RegionEntry> regionsByAddress =+ program.memory.getRegionsByAddress();+ if (regionsByAddress.isEmpty()) {+ return null;+ }+ return regionsByAddress.firstKey();}- return regionsByAddress.firstKey();}@Overridepublic Address getMaxAddress() {- NavigableMap<Address, RegionEntry> regionsByAddress = program.memory.getRegionsByAddress();- if (regionsByAddress.isEmpty()) {- return null;+ try (LockHold _ = program.trace.lockRead()) {+ NavigableMap<Address, RegionEntry> regionsByAddress =+ program.memory.getRegionsByAddress();+ if (regionsByAddress.isEmpty()) {+ return null;+ }+ return regionsByAddress.lastEntry().getValue().range.getMaxAddress();}- return regionsByAddress.lastEntry().getValue().range.getMaxAddress();}@Overridediff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteBlockChangeManager.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteBlockChangeManager.javaindex 4bbd943d45..ba0a016d3b 100644--- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteBlockChangeManager.java+++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteBlockChangeManager.java@@ -4,9 +4,9 @@* 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.@@ -30,14 +30,14 @@ import ghidra.program.model.address.Address;*/public class ByteBlockChangeManager {- private ProgramByteBlockSet blockSet;- private List<ByteEditInfo> changeList; // list of changes for this tool+ private final ProgramByteBlockSet blockSet;+ private final List<ByteEditInfo> changeList; // list of changes for this toolprivate final static String NUMBER_OF_CHANGES = "NumberOfByteBlockChanges";- private static String BLOCK_NUMBER = "BlockNumber";- private static String BLOCK_OFFSET = "BlockOffset";- private static String OLD_VALUE = "OldValue";- private static String NEW_VALUE = "NewValue";+ private final static String BLOCK_NUMBER = "BlockNumber";+ private final static String BLOCK_OFFSET = "BlockOffset";+ private final static String OLD_VALUE = "OldValue";+ private final static String NEW_VALUE = "NewValue";/*** Construct new change manager.@@ -130,7 +130,6 @@ public class ByteBlockChangeManager {return false;}- ///////////////////////////////////////////////////////////////////////*** Return true if the block and offset are in the list.*diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteViewerPlugin.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteViewerPlugin.javaindex fe826d5ca8..f621bf33cf 100644--- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteViewerPlugin.java+++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ByteViewerPlugin.java@@ -65,16 +65,16 @@ public class ByteViewerPlugin extends AbstractByteViewerPlugin<ProgramByteViewer@Overridepublic void processEvent(PluginEvent event) {- if (event instanceof ProgramClosedPluginEvent) {- Program program = ((ProgramClosedPluginEvent) event).getProgram();+ if (event instanceof ProgramClosedPluginEvent ev) {+ Program program = ev.getProgram();programClosed(program);}- else if (event instanceof ProgramActivatedPluginEvent) {- currentProgram = ((ProgramActivatedPluginEvent) event).getActiveProgram();+ else if (event instanceof ProgramActivatedPluginEvent ev) {+ currentProgram = ev.getActiveProgram();currentLocation = null;}- else if (event instanceof ProgramLocationPluginEvent) {- currentLocation = ((ProgramLocationPluginEvent) event).getLocation();+ else if (event instanceof ProgramLocationPluginEvent ev) {+ currentLocation = ev.getLocation();}connectedProvider.doHandleEvent(event);diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteBlockSet.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteBlockSet.javaindex cb6d73cd27..fd05d96cbe 100644--- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteBlockSet.java+++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteBlockSet.java@@ -183,7 +183,6 @@ public class ProgramByteBlockSet implements ByteBlockSet {provider.notifyEdit(edit);}- ///////////////////////////////////////////////////////////////////////SaveState getUndoRedoState() {return bbcm.getUndoRedoState();}diff --git a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteViewerComponentProvider.java b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteViewerComponentProvider.javaindex 7cf1f54763..70964136d0 100644--- a/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteViewerComponentProvider.java+++ b/Ghidra/Features/ByteViewer/src/main/java/ghidra/app/plugin/core/byteviewer/ProgramByteViewerComponentProvider.java@@ -245,6 +245,10 @@ public class ProgramByteViewerComponentProvider extends ByteViewerComponentProviprogram = newProgram;clipboardProvider.setProgram(newProgram);++ if (newProgram != null) {+ newProgram.addListener(this);+ }for (ByteViewerComponent byteViewerComponent : viewMap.values()) {DataFormatModel dataModel = byteViewerComponent.getDataModel();if (dataModel instanceof ProgramDataFormatModel pdfm) {@@ -252,9 +256,6 @@ public class ProgramByteViewerComponentProvider extends ByteViewerComponentProvi}}- if (newProgram != null) {- newProgram.addListener(this);- }setByteBlocks(null);updateTitle();contextChanged();diff --git a/Ghidra/Test/DebuggerIntegrationTest/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java b/Ghidra/Test/DebuggerIntegrationTest/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.javaindex 1b6aa0a3bd..69d66b0e55 100644--- a/Ghidra/Test/DebuggerIntegrationTest/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java+++ b/Ghidra/Test/DebuggerIntegrationTest/src/test/java/ghidra/app/plugin/core/debug/gui/memory/DebuggerMemoryBytesProviderTest.java@@ -124,7 +124,7 @@ public class DebuggerMemoryBytesProviderTest extends AbstractGhidraHeadedDebuggepublic void testBytesViewIsRegionsActivateThenAdd() throws Exception {createAndOpenTrace();traceManager.activateTrace(tb.trace);- try (Transaction tx = tb.startTransaction()) {+ try (Transaction _ = tb.startTransaction()) {tb.createRootObject(buildContext(), "Target");DBTraceMemoryManager memory = tb.trace.getMemoryManager();memory.addRegion("Memory[exe:.text]", Lifespan.nowOn(0),