-
Notifications
You must be signed in to change notification settings - Fork 5.8k
/
DebuggerRegistersProvider.java
1331 lines (1186 loc) · 42.1 KB
/
DebuggerRegistersProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ###
* 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.register;
import java.awt.*;
import java.awt.event.*;
import java.math.BigInteger;
import java.util.*;
import java.util.List;
import java.util.Map.Entry;
import java.util.concurrent.CompletableFuture;
import java.util.function.*;
import javax.swing.*;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import org.apache.commons.lang3.exception.ExceptionUtils;
import db.Transaction;
import docking.*;
import docking.action.*;
import docking.action.builder.ActionBuilder;
import docking.actions.PopupActionProvider;
import docking.widgets.table.*;
import docking.widgets.table.ColumnSortState.SortDirection;
import docking.widgets.table.DefaultEnumeratedColumnTableModel.EnumeratedTableColumn;
import generic.theme.GColor;
import ghidra.app.plugin.core.data.DataSettingsDialog;
import ghidra.app.plugin.core.debug.DebuggerPluginPackage;
import ghidra.app.plugin.core.debug.gui.DebuggerProvider;
import ghidra.app.plugin.core.debug.gui.DebuggerResources;
import ghidra.app.plugin.core.debug.gui.DebuggerResources.GoToAction;
import ghidra.app.services.*;
import ghidra.app.services.DebuggerControlService.StateEditor;
import ghidra.async.AsyncLazyValue;
import ghidra.async.AsyncUtils;
import ghidra.base.widgets.table.DataTypeTableCellEditor;
import ghidra.dbg.error.DebuggerModelAccessException;
import ghidra.debug.api.target.Target;
import ghidra.debug.api.tracemgr.DebuggerCoordinates;
import ghidra.docking.settings.*;
import ghidra.framework.model.DomainObjectChangeRecord;
import ghidra.framework.model.DomainObjectEvent;
import ghidra.framework.options.AutoOptions;
import ghidra.framework.options.SaveState;
import ghidra.framework.plugintool.*;
import ghidra.framework.plugintool.annotation.AutoServiceConsumed;
import ghidra.program.model.address.*;
import ghidra.program.model.data.*;
import ghidra.program.model.lang.*;
import ghidra.program.model.listing.Data;
import ghidra.program.model.util.CodeUnitInsertionException;
import ghidra.program.util.ProgramLocation;
import ghidra.trace.model.*;
import ghidra.trace.model.guest.TracePlatform;
import ghidra.trace.model.listing.*;
import ghidra.trace.model.memory.*;
import ghidra.trace.model.program.TraceProgramView;
import ghidra.trace.model.target.TraceObject;
import ghidra.trace.model.thread.TraceThread;
import ghidra.trace.util.*;
import ghidra.util.HelpLocation;
import ghidra.util.Msg;
import ghidra.util.classfinder.ClassSearcher;
import ghidra.util.data.DataTypeParser.AllowedDataTypes;
import ghidra.util.exception.CancelledException;
import ghidra.util.table.GhidraTable;
import ghidra.util.table.GhidraTableFilterPanel;
import ghidra.util.table.column.GColumnRenderer;
import ghidra.util.task.TaskMonitor;
public class DebuggerRegistersProvider extends ComponentProviderAdapter
implements DebuggerProvider, PopupActionProvider {
private static final GColor COLOR_BORDER_DISCONNECTED =
new GColor("color.border.provider.disconnected");
private static final Color COLOR_FOREGROUND_STALE =
new GColor("color.debugger.plugin.resources.register.stale");
private static final Color COLOR_FOREGROUND_STALE_SEL =
new GColor("color.debugger.plugin.resources.register.stale.selected");
private static final Color COLOR_FOREGROUND_CHANGED =
new GColor("color.debugger.plugin.resources.register.changed");
private static final Color COLOR_FOREGROUND_CHANGED_SEL =
new GColor("color.debugger.plugin.resources.register.changed.selected");
private static final String KEY_DEBUGGER_COORDINATES = "DebuggerCoordinates";
interface ClearRegisterType {
String NAME = DebuggerResources.NAME_CLEAR_REGISTER_TYPE;
String DESCRIPTION = DebuggerResources.DESCRIPTION_CLEAR_REGISTER_TYPE;
static ActionBuilder builder(Plugin owner) {
String ownerName = owner.getName();
return new ActionBuilder(NAME, ownerName).description(DESCRIPTION);
}
}
interface RegisterTypeSettings {
String NAME = DebuggerResources.NAME_REGISTER_TYPE_SETTINGS;
String DESCRIPTION = DebuggerResources.DESCRIPTION_REGISTER_TYPE_SETTINGS;
String HELP_ANCHOR = "type_settings";
static ActionBuilder builder(Plugin owner) {
String ownerName = owner.getName();
return new ActionBuilder(NAME, ownerName).description(DESCRIPTION)
.popupMenuPath(NAME)
.helpLocation(new HelpLocation(ownerName, HELP_ANCHOR));
}
}
/**
* This only exists so that tests can access it
*/
protected static class RegisterDataSettingsDialog extends DataSettingsDialog {
public RegisterDataSettingsDialog(Data data) {
super(data);
}
@Override
protected Settings getSettings() {
return super.getSettings();
}
@Override
protected void okCallback() {
super.okCallback();
}
}
protected enum RegisterTableColumns
implements EnumeratedTableColumn<RegisterTableColumns, RegisterRow> {
FAV("Fav", 1, Boolean.class, RegisterRow::isFavorite, RegisterRow::setFavorite, //
r -> true, SortDirection.DESCENDING),
NUMBER("#", 1, Integer.class, RegisterRow::getNumber),
NAME("Name", 40, String.class, RegisterRow::getName),
VALUE("Value", 100, BigInteger.class, RegisterRow::getValue, RegisterRow::setValue, //
RegisterRow::isValueEditable, SortDirection.ASCENDING) {
private static final RegisterValueCellRenderer RENDERER =
new RegisterValueCellRenderer();
private static final SettingsDefinition[] DEFS =
new SettingsDefinition[] { FormatSettingsDefinition.DEF_HEX, };
@Override
public GColumnRenderer<BigInteger> getRenderer() {
return RENDERER;
}
@Override
public SettingsDefinition[] getSettingsDefinitions() {
return DEFS;
}
},
TYPE("Type", 40, DataType.class, RegisterRow::getDataType, RegisterRow::setDataType, //
r -> true, SortDirection.ASCENDING),
REPR("Repr", 100, String.class, RegisterRow::getRepresentation, RegisterRow::setRepresentation, //
RegisterRow::isRepresentationEditable, SortDirection.ASCENDING);
private final String header;
private final int width;
private final Function<RegisterRow, ?> getter;
private final BiConsumer<RegisterRow, Object> setter;
private final Predicate<RegisterRow> editable;
private final Class<?> cls;
private final SortDirection direction;
<T> RegisterTableColumns(String header, int width, Class<T> cls,
Function<RegisterRow, T> getter) {
this(header, width, cls, getter, null, null, SortDirection.ASCENDING);
}
@SuppressWarnings("unchecked")
<T> RegisterTableColumns(String header, int width, Class<T> cls,
Function<RegisterRow, T> getter, BiConsumer<RegisterRow, T> setter,
Predicate<RegisterRow> editable, SortDirection direction) {
this.header = header;
this.width = width;
this.cls = cls;
this.getter = getter;
this.setter = (BiConsumer<RegisterRow, Object>) setter;
this.editable = editable;
this.direction = direction;
}
@Override
public Class<?> getValueClass() {
return cls;
}
@Override
public Object getValueOf(RegisterRow row) {
return getter.apply(row);
}
@Override
public String getHeader() {
return header;
}
@Override
public boolean isEditable(RegisterRow row) {
return editable != null && editable.test(row);
}
@Override
public void setValueOf(RegisterRow row, Object value) {
setter.accept(row, value);
}
@Override
public SortDirection defaultSortDirection() {
return direction;
}
@Override
public int getPreferredWidth() {
return width;
}
}
protected static class RegistersTableModel
extends DefaultEnumeratedColumnTableModel<RegisterTableColumns, RegisterRow> {
public RegistersTableModel(PluginTool tool) {
super(tool, "Registers", RegisterTableColumns.class);
}
@Override
public List<RegisterTableColumns> defaultSortOrder() {
return List.of(RegisterTableColumns.FAV, RegisterTableColumns.NUMBER);
}
@Override
protected TableColumnDescriptor<RegisterRow> createTableColumnDescriptor() {
TableColumnDescriptor<RegisterRow> descriptor = super.createTableColumnDescriptor();
for (DebuggerRegisterColumnFactory factory : ClassSearcher
.getInstances(DebuggerRegisterColumnFactory.class)) {
descriptor.addHiddenColumn(factory.create());
}
return descriptor;
}
}
protected static boolean sameCoordinates(DebuggerCoordinates a, DebuggerCoordinates b) {
if (!Objects.equals(a.getPlatform(), b.getPlatform())) {
return false; // subsumes trace
}
if (!Objects.equals(a.getTarget(), b.getTarget())) {
return false; // For live read/writes
}
if (!Objects.equals(a.getThread(), b.getThread())) {
return false;
}
if (!Objects.equals(a.getTime(), b.getTime())) {
return false;
}
if (!Objects.equals(a.getFrame(), b.getFrame())) {
return false;
}
return true;
}
class TraceChangeListener extends TraceDomainObjectListener {
public TraceChangeListener() {
listenForUntyped(DomainObjectEvent.RESTORED, e -> objectRestored(e));
listenFor(TraceEvents.BYTES_CHANGED, this::registerValueChanged);
listenFor(TraceEvents.BYTES_STATE_CHANGED, this::registerStateChanged);
listenFor(TraceEvents.CODE_ADDED, this::registerTypeAdded);
listenFor(TraceEvents.CODE_DATA_TYPE_REPLACED, this::registerTypeReplaced);
listenFor(TraceEvents.CODE_LIFESPAN_CHANGED, this::registerTypeLifespanChanged);
listenFor(TraceEvents.CODE_REMOVED, this::registerTypeRemoved);
listenFor(TraceEvents.THREAD_DELETED, this::threadDeleted);
listenFor(TraceEvents.THREAD_LIFESPAN_CHANGED, this::threadDestroyed);
}
private boolean isVisibleObjectsMode(AddressSpace space) {
TraceObject container = current.getRegisterContainer();
return container != null &&
container.getCanonicalPath().toString().equals(space.getName());
}
private boolean isVisible(TraceAddressSpace space) {
TraceThread curThread = current.getThread();
if (curThread == null) {
return false;
}
if (space.getAddressSpace().isOverlaySpace()) {
return isVisibleObjectsMode(space.getAddressSpace());
}
if (!space.getAddressSpace().isRegisterSpace()) {
return true; // Memory-mapped, visible no matter the active thread
}
if (space.getThread() != curThread) {
return false;
}
if (space.getFrameLevel() != current.getFrame()) {
return false;
}
return true;
}
private boolean isVisible(TraceAddressSpace space, TraceAddressSnapRange range) {
if (!isVisible(space)) {
return false;
}
if (space.getAddressSpace().isMemorySpace()) {
return current.getPlatform()
.getLanguage()
.getRegisterAddresses()
.intersects(range.getX1(), range.getX2());
}
TraceProgramView view = current.getView();
if (view == null || !view.getViewport().containsAnyUpper(range.getLifespan())) {
return false;
}
// Probably not worth checking for occlusion here. Just a little refresh waste.
return true;
}
private void refreshRange(AddressRange range) {
TraceMemorySpace mem = getRegisterMemorySpace(range.getAddressSpace(), false);
// ... If I got an event for it, it ought to exist.
assert mem != null;
// TODO: Just certain rows?
regsTableModel.fireTableDataChanged();
}
private void objectRestored(DomainObjectChangeRecord rec) {
coordinatesActivated(current.reFindThread());
}
private void registerValueChanged(TraceAddressSpace space, TraceAddressSnapRange range,
byte[] oldIsNull, byte[] newVal) {
if (!isVisible(space, range)) {
return;
}
refreshRange(range.getRange());
}
private void registerStateChanged(TraceAddressSpace space, TraceAddressSnapRange range,
TraceMemoryState oldState, TraceMemoryState newState) {
if (!isVisible(space, range)) {
return;
}
recomputeViewKnown();
refreshRange(range.getRange());
}
private void registerTypeAdded(TraceAddressSpace space, TraceAddressSnapRange range,
TraceCodeUnit oldIsNull, TraceCodeUnit newUnit) {
if (!isVisible(space, range)) {
return;
}
refreshRange(range.getRange());
}
private void registerTypeReplaced(TraceAddressSpace space, TraceAddressSnapRange range,
long oldTypeID, long newTypeID) {
if (!isVisible(space, range)) {
return;
}
refreshRange(range.getRange());
}
private void registerTypeLifespanChanged(TraceAddressSpace space, TraceCodeUnit unit,
Lifespan oldSpan, Lifespan newSpan) {
if (!isVisible(space)) {
return;
}
TraceProgramView view = current.getView();
if (view == null) {
return;
}
TraceTimeViewport viewport = view.getViewport();
if (viewport.containsAnyUpper(oldSpan) == viewport.containsAnyUpper(newSpan)) {
return;
}
// A little waste if occluded, but probably cheaper than checking.
AddressRange range = new AddressRangeImpl(unit.getMinAddress(), unit.getMaxAddress());
refreshRange(range); // Slightly wasteful, as we already have the data unit
}
private void registerTypeRemoved(TraceAddressSpace space, TraceAddressSnapRange range,
TraceCodeUnit oldUnit, TraceCodeUnit newIsNull) {
if (!isVisible(space)) {
return;
}
refreshRange(range.getRange());
}
private void threadDeleted(TraceThread thread) {
//checkEditsEnabled();
}
private void threadDestroyed(TraceThread thread, Lifespan oldSpan, Lifespan newSpan) {
//checkEditsEnabled();
}
}
static class RegisterValueCellRenderer extends HexDefaultGColumnRenderer<BigInteger> {
@Override
public final Component getTableCellRendererComponent(GTableCellRenderingData data) {
super.getTableCellRendererComponent(data);
RegisterRow row = (RegisterRow) data.getRowObject();
if (!row.isKnown()) {
if (data.isSelected()) {
setForeground(COLOR_FOREGROUND_STALE_SEL);
}
else {
setForeground(COLOR_FOREGROUND_STALE);
}
}
else if (row.isChanged()) {
if (data.isSelected()) {
setForeground(COLOR_FOREGROUND_CHANGED_SEL);
}
else {
setForeground(COLOR_FOREGROUND_CHANGED);
}
}
return this;
}
}
class RegisterDataTypeEditor extends DataTypeTableCellEditor {
public RegisterDataTypeEditor() {
super(plugin.getTool());
}
@Override
protected AllowedDataTypes getAllowed(int row, int column) {
return AllowedDataTypes.FIXED_LENGTH;
}
@Override
protected boolean validateSelection(DataType dataType) {
RegisterRow row = regsTableModel.getModelData().get(regsTable.getEditingRow());
if (row == null) {
return false;
}
return dataType.getLength() == row.getRegister().getMinimumByteSize();
}
@Override
protected DataType resolveSelection(DataType dataType) {
if (dataType == null) {
return null;
}
try (Transaction tx = currentTrace.openTransaction("Resolve DataType")) {
return currentTrace.getDataTypeManager().resolve(dataType, null);
}
}
}
final DebuggerRegistersPlugin plugin;
private final Map<LanguageCompilerSpecPair, LinkedHashSet<Register>> selectionByCSpec;
private final Map<LanguageCompilerSpecPair, LinkedHashSet<Register>> favoritesByCSpec;
private final boolean isClone;
DebuggerCoordinates previous = DebuggerCoordinates.NOWHERE;
DebuggerCoordinates current = DebuggerCoordinates.NOWHERE;
private AsyncLazyValue<Void> readTheseCoords =
new AsyncLazyValue<>(this::readRegistersIfLiveAndAccessible); /* "read" past tense */
private Trace currentTrace; // Copy for transition
@AutoServiceConsumed
private DebuggerTraceManagerService traceManager;
@AutoServiceConsumed
private DebuggerListingService listingService;
@AutoServiceConsumed
private DebuggerControlService controlService;
@AutoServiceConsumed
private DebuggerConsoleService consoleService;
@AutoServiceConsumed
private MarkerService markerService; // TODO: Mark address types (separate plugin?)
@SuppressWarnings("unused")
private final AutoService.Wiring autoServiceWiring;
@SuppressWarnings("unused")
private final AutoOptions.Wiring autoOptionsWiring;
private final TraceChangeListener traceChangeListener = new TraceChangeListener();
private JPanel mainPanel = new JPanel(new BorderLayout());
final RegistersTableModel regsTableModel;
GhidraTable regsTable;
GhidraTableFilterPanel<RegisterRow> regsFilterPanel;
Map<Register, RegisterRow> regMap = new HashMap<>();
private final DebuggerAvailableRegistersDialog availableRegsDialog;
DockingAction actionSelectRegisters;
DockingAction actionCreateSnapshot;
ToggleDockingAction actionEnableEdits;
DockingAction actionClearDataType;
DockingAction actionDataTypeSettings;
DebuggerRegisterActionContext myActionContext;
AddressSetView viewKnown;
protected DebuggerRegistersProvider(final DebuggerRegistersPlugin plugin,
Map<LanguageCompilerSpecPair, LinkedHashSet<Register>> selectionByCSpec,
Map<LanguageCompilerSpecPair, LinkedHashSet<Register>> favoritesByCSpec,
boolean isClone) {
super(plugin.getTool(), DebuggerResources.TITLE_PROVIDER_REGISTERS, plugin.getName());
this.plugin = plugin;
regsTableModel = new RegistersTableModel(tool);
this.selectionByCSpec = selectionByCSpec;
this.favoritesByCSpec = favoritesByCSpec;
this.isClone = isClone;
this.autoServiceWiring = AutoService.wireServicesConsumed(plugin, this);
this.autoOptionsWiring = AutoOptions.wireOptions(plugin, this);
setIcon(DebuggerResources.ICON_PROVIDER_REGISTERS);
setHelpLocation(DebuggerResources.HELP_PROVIDER_REGISTERS);
setWindowMenuGroup(DebuggerPluginPackage.NAME);
buildMainPanel();
plugin.getTool().addPopupActionProvider(this);
availableRegsDialog = new DebuggerAvailableRegistersDialog(this);
setDefaultWindowPosition(WindowPosition.RIGHT);
createActions();
if (isClone) {
setTitle("[" + DebuggerResources.TITLE_PROVIDER_REGISTERS + "]");
setWindowGroup("Debugger.Core.disconnected");
setIntraGroupPosition(WindowPosition.STACK);
mainPanel.setBorder(BorderFactory.createLineBorder(COLOR_BORDER_DISCONNECTED, 2));
setTransient();
}
else {
setTitle(DebuggerResources.TITLE_PROVIDER_REGISTERS);
setWindowGroup("Debugger.Core");
}
setVisible(true);
contextChanged();
}
@Override
public void removeFromTool() {
availableRegsDialog.dispose();
plugin.providerRemoved(this);
plugin.getTool().removePopupActionProvider(this);
super.removeFromTool();
}
protected void buildMainPanel() {
regsTable = new GhidraTable(regsTableModel);
// TODO: Allow multiple selection for copy, etc.?
mainPanel.add(new JScrollPane(regsTable));
regsFilterPanel = new GhidraTableFilterPanel<>(regsTable, regsTableModel);
mainPanel.add(regsFilterPanel, BorderLayout.SOUTH);
String namePrefix = "Registers";
regsTable.setAccessibleNamePrefix(namePrefix);
regsFilterPanel.setAccessibleNamePrefix(namePrefix);
regsTable.getSelectionModel().addListSelectionListener(evt -> {
if (evt.getValueIsAdjusting()) {
return;
}
myActionContext = new DebuggerRegisterActionContext(this,
regsFilterPanel.getSelectedItem(), regsTable);
contextChanged();
});
regsTable.addMouseListener(new MouseAdapter() {
@Override
public void mouseClicked(MouseEvent e) {
if (e.getClickCount() == 2 && e.getButton() == MouseEvent.BUTTON1) {
navigateToAddress();
}
}
});
regsTable.addKeyListener(new KeyAdapter() {
@Override
public void keyPressed(KeyEvent e) {
if (e.getKeyCode() == KeyEvent.VK_ENTER) {
navigateToAddress();
}
}
});
TableColumnModel columnModel = regsTable.getColumnModel();
TableColumn valCol = columnModel.getColumn(RegisterTableColumns.VALUE.ordinal());
valCol.setCellEditor(new HexBigIntegerTableCellEditor());
TableColumn typeCol = columnModel.getColumn(RegisterTableColumns.TYPE.ordinal());
typeCol.setCellEditor(new RegisterDataTypeEditor());
}
@Override
public List<DockingActionIf> getPopupActions(Tool t, ActionContext context) {
if (context != myActionContext || context == null || listingService == null) {
return List.of();
}
Register register = myActionContext.getSelected().getRegister();
BigInteger value = getRegisterValue(register);
if (value == null) {
return List.of();
}
long lv = value.longValue();
List<DockingActionIf> result = new ArrayList<>();
String pluginName = plugin.getName();
for (AddressSpace space : currentTrace.getBaseAddressFactory().getAddressSpaces()) {
if (!space.isMemorySpace()) {
continue;
}
if (space.getType() == AddressSpace.TYPE_OTHER) {
continue;
}
Address address;
try {
address = space.getAddress(lv, true);
}
catch (AddressOutOfBoundsException e) {
continue;
}
String name = GoToAction.NAME + " " + address.toString(true);
// Use program view, not memory manager, so that "Force Full View" is respected.
boolean enabled = currentTrace.getProgramView().getMemory().contains(address);
String extraDesc = enabled ? "" : ". Enable via Force Full View.";
result.add(new ActionBuilder(name, pluginName)
.popupMenuPath(name)
.popupMenuGroup("Go To")
.description(
"Navigate the dynamic listing to " + address.toString(true) + extraDesc)
.helpLocation(
new HelpLocation(pluginName, DebuggerResources.GoToAction.HELP_ANCHOR))
.enabledWhen(ctx -> enabled)
.popupWhen(ctx -> true)
.onAction(ctx -> {
if (listingService == null) {
return;
}
ProgramLocation loc = new ProgramLocation(current.getView(), address);
listingService.goTo(loc, true);
})
.build());
}
return result;
}
protected void navigateToAddress() {
if (listingService == null || myActionContext == null) {
return;
}
RegisterRow row = myActionContext.getSelected();
TraceData data = getRegisterData(row.getRegister());
if (data == null || data.getValueClass() != Address.class) {
return;
}
Address address = (Address) data.getValue();
if (address == null) {
return;
}
ProgramLocation loc = new ProgramLocation(current.getView(), address);
listingService.goTo(loc, true);
}
@Override
public ActionContext getActionContext(MouseEvent event) {
if (myActionContext == null) {
return super.getActionContext(event);
}
return myActionContext;
}
protected void createActions() {
actionSelectRegisters = DebuggerResources.SelectRegistersAction.builder(plugin)
.enabledWhen(c -> current.getThread() != null)
.onAction(c -> selectRegistersActivated())
.buildAndInstallLocal(this);
if (!isClone) {
actionCreateSnapshot = DebuggerResources.CloneWindowAction.builder(plugin)
.enabledWhen(c -> current.getThread() != null)
.onAction(c -> cloneWindowActivated())
.buildAndInstallLocal(this);
}
actionEnableEdits = DebuggerResources.EnableEditsAction.builder(plugin)
.enabledWhen(c -> current.getThread() != null)
.onAction(c -> {
})
.buildAndInstallLocal(this);
actionClearDataType = ClearRegisterType.builder(plugin)
.enabledWhen(c -> current.getThread() != null)
.keyBinding(KeyStroke.getKeyStroke(KeyEvent.VK_DELETE, 0))
.onAction(c -> clearDataTypeActivated())
.buildAndInstallLocal(this);
actionDataTypeSettings = RegisterTypeSettings.builder(plugin)
.withContext(DebuggerRegisterActionContext.class)
.enabledWhen(this::contextHasSingleRegisterWithType)
.onAction(this::dataTypeSettingsActivated)
.buildAndInstallLocal(this);
}
private void selectRegistersActivated() {
TracePlatform curPlatform = current.getPlatform();
if (current.getThread() == null) {
return;
}
availableRegsDialog.setLanguage(curPlatform.getLanguage());
Set<Register> viewKnown = computeDefaultRegisterSelection(curPlatform);
availableRegsDialog.setKnown(viewKnown);
Set<Register> selection = getSelectionFor(curPlatform);
// NOTE: Modifies selection in place
availableRegsDialog.setSelection(selection);
tool.showDialog(availableRegsDialog);
}
private void cloneWindowActivated() {
DebuggerRegistersProvider clone = cloneAsDisconnected();
clone.setIntraGroupPosition(WindowPosition.RIGHT);
tool.showComponentProvider(clone, true);
}
private void clearDataTypeActivated() {
if (myActionContext == null) {
return;
}
RegisterRow row = myActionContext.getSelected();
row.setDataType(null);
}
private boolean contextHasSingleRegisterWithType(DebuggerRegisterActionContext ctx) {
return ctx.getSelected() != null && ctx.getSelected().getData() != null;
}
private void dataTypeSettingsActivated(DebuggerRegisterActionContext ctx) {
RegisterRow row = ctx.getSelected();
if (row == null) {
return;
}
Data data = row.getData();
if (data == null) {
return;
}
tool.showDialog(new RegisterDataSettingsDialog(data));
}
// TODO: "Refresh" action to flush cache and re-fetch selected registers
@Override
public JComponent getComponent() {
return mainPanel;
}
@Override
public boolean isSnapshot() {
return isClone;
}
protected String computeSubTitle() {
TraceThread curThread = current.getThread();
return curThread == null ? "" : curThread.getName();
}
protected void updateSubTitle() {
setSubTitle(computeSubTitle());
}
private void removeOldTraceListener() {
if (currentTrace == null) {
return;
}
currentTrace.removeListener(traceChangeListener);
}
private void addNewTraceListener() {
if (currentTrace == null) {
return;
}
currentTrace.addListener(traceChangeListener);
}
private void doSetTrace(Trace trace) {
if (currentTrace == trace) {
return;
}
actionEnableEdits.setSelected(false);
removeOldTraceListener();
this.currentTrace = trace;
addNewTraceListener();
}
public void coordinatesActivated(DebuggerCoordinates coordinates) {
if (sameCoordinates(current, coordinates)) {
current = coordinates;
return;
}
previous = current;
current = coordinates;
readTheseCoords.forget();
doSetTrace(current.getTrace());
updateSubTitle();
prepareRegisterSpace();
recomputeViewKnown();
loadRegistersAndValues();
contextChanged();
}
protected void traceClosed(Trace trace) {
if (isClone) {
if (current.getTrace() == trace) {
coordinatesActivated(DebuggerCoordinates.NOWHERE);
removeFromTool();
}
}
}
boolean canWriteRegister(Register register) {
if (!isEditsEnabled()) {
return false;
}
if (controlService == null) {
return false;
}
StateEditor editor = controlService.createStateEditor(current);
return editor.isRegisterEditable(register);
}
BigInteger getRegisterValue(Register register) {
TraceMemorySpace regs = getRegisterMemorySpace(register.getAddressSpace(), false);
if (regs == null) {
return BigInteger.ZERO;
}
return regs.getViewValue(current.getPlatform(), current.getViewSnap(), register)
.getUnsignedValue();
}
void writeRegisterValue(Register register, BigInteger value) {
writeRegisterValue(new RegisterValue(register, value));
}
void writeRegisterValue(RegisterValue rv) {
if (controlService == null) {
Msg.showError(this, getComponent(), "Edit Register", "No control service.");
return;
}
StateEditor editor = controlService.createStateEditor(current);
if (!editor.isRegisterEditable(rv.getRegister())) {
Msg.showError(this, getComponent(), "Edit Register",
"Neither the register nor any parent can be edited.");
return;
}
CompletableFuture<Void> future = editor.setRegister(rv);
future.exceptionally(ex -> {
ex = AsyncUtils.unwrapThrowable(ex);
reportError("Edit Register", "Could not write target register", ex);
return null;
});
return;
}
/**
* TODO: Make this smart enough to replace a component type when applicable? NOTE: Would require
* cloning the type to avoid effects elsewhere. Maybe just keep a dedicated data type for this
* register and modify it.... Well, that works until you consider changes in time....
*/
void writeRegisterDataType(Register register, DataType dataType) {
try (Transaction tx = current.getTrace().openTransaction("Edit Register Type")) {
if (dataType instanceof Pointer ptrType && register.getAddress().isRegisterAddress()) {
// Because we're about to use the size, resolve it first
ptrType = (Pointer) current.getTrace()
.getDataTypeManager()
.resolve(dataType, DataTypeConflictHandler.DEFAULT_HANDLER);
/**
* TODO: This should be the current platform instead, but it's not clear how to do
* that. The PointerTypedef uses the program (taken from the MemBuffer) to lookup
* the configured address space by name. Might be better if MemBuffer/CodeUnit had
* getAddressFactory(). Still, I'd need guest-platform data units before I could
* override that meaningfully.
*/
/**
* AddressSpace space =
* current.getPlatform().getAddressFactory().getDefaultAddressSpace();
*/
AddressSpace space =
current.getTrace().getBaseAddressFactory().getDefaultAddressSpace();
dataType = new PointerTypedef(null, ptrType.getDataType(), ptrType.getLength(),
ptrType.getDataTypeManager(), space);
}
TraceCodeSpace code =
getRegisterMemorySpace(register.getAddressSpace(), true).getCodeSpace(true);
long snap = current.getViewSnap();
TracePlatform platform = current.getPlatform();
code.definedUnits().clear(platform, Lifespan.at(snap), register, TaskMonitor.DUMMY);
if (dataType != null) {
code.definedData().create(platform, Lifespan.nowOn(snap), register, dataType);
}
}
catch (CodeUnitInsertionException | CancelledException e) {
throw new AssertionError(e);
}
}
TraceData getRegisterData(Register register) {
TraceCodeSpace space = getRegisterCodeSpace(register.getAddressSpace(), false);
if (space == null) {
return null;
}
TracePlatform platform = current.getPlatform();
long snap = current.getViewSnap();
return space.definedData().getForRegister(platform, snap, register);
}
DataType getRegisterDataType(Register register) {
TraceData data = getRegisterData(register);
if (data == null) {
return null;
}
return data.getDataType();
}
void writeRegisterValueRepresentation(Register register, String representation) {
TraceData data = getRegisterData(register);
if (data == null) {
// isEditable should have been false
tool.setStatusInfo("Register has no data type", true);
return;
}
try {
RegisterValue rv = TraceRegisterUtils.encodeValueRepresentationHackPointer(register,
data, representation);
writeRegisterValue(rv);
}
catch (DataTypeEncodeException e) {
tool.setStatusInfo(e.getMessage(), true);
return;
}
}
boolean canWriteRegisterRepresentation(Register register) {
if (!canWriteRegister(register)) {
return false;
}
TraceData data = getRegisterData(register);
if (data == null) {
return false;
}
return data.getBaseDataType().isEncodable();
}
String getRegisterValueRepresentation(Register register) {
TraceData data = getRegisterData(register);
if (data == null) {
return null;
}
return data.getDefaultValueRepresentation();
}
/**
* Ensure the register space exists and has been populated from register object values.
*
* <p>
* TODO: I wish this were not necessary. Maybe I should create the space when register object
* values are populated.
*/
void prepareRegisterSpace() {
Trace trace = current.getTrace();
if (current.getThread() != null && trace.getObjectManager().getRootSchema() != null) {
AddressSpace regSpace = current.getPlatform().getAddressFactory().getRegisterSpace();
if (regSpace != null) {
try (Transaction tx = trace.openTransaction("Create/initialize register space")) {
getRegisterMemorySpace(regSpace, true);
}
}
}
}
void recomputeViewKnown() {
TracePlatform platform = current.getPlatform();
if (platform == null) {
viewKnown = null;
return;