-
Notifications
You must be signed in to change notification settings - Fork 5.7k
/
GdbCommandsTest.java
1185 lines (1106 loc) · 37.8 KB
/
GdbCommandsTest.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:https://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 agent.gdb.rmi;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import java.nio.ByteBuffer;
import java.util.*;
import java.util.Map.Entry;
import java.util.concurrent.atomic.AtomicReference;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import org.junit.Test;
import org.junit.experimental.categories.Category;
import db.Transaction;
import generic.Unique;
import generic.test.category.NightlyCategory;
import ghidra.app.plugin.core.debug.utils.ManagedDomainObject;
import ghidra.dbg.testutil.DummyProc;
import ghidra.dbg.util.PathPredicates;
import ghidra.debug.api.tracermi.TraceRmiAcceptor;
import ghidra.debug.api.tracermi.TraceRmiConnection;
import ghidra.framework.Application;
import ghidra.framework.model.DomainFile;
import ghidra.program.model.address.*;
import ghidra.program.model.data.Float10DataType;
import ghidra.program.model.lang.RegisterValue;
import ghidra.program.model.listing.CodeUnit;
import ghidra.trace.database.ToyDBTraceBuilder;
import ghidra.trace.model.*;
import ghidra.trace.model.breakpoint.TraceBreakpointKind;
import ghidra.trace.model.listing.TraceCodeSpace;
import ghidra.trace.model.listing.TraceData;
import ghidra.trace.model.memory.*;
import ghidra.trace.model.modules.TraceModule;
import ghidra.trace.model.target.*;
import ghidra.trace.model.time.TraceSnapshot;
import ghidra.util.Msg;
@Category(NightlyCategory.class) // this may actually be an @PortSensitive test
public class GdbCommandsTest extends AbstractGdbTraceRmiTest {
//@Test
public void testManual() throws Exception {
TraceRmiAcceptor acceptor = traceRmi.acceptOne(null);
Msg.info(this,
"Use: ghidra trace connect " + sockToStringForGdb(acceptor.getAddress()));
TraceRmiConnection connection = acceptor.accept();
Msg.info(this, "Connected: " + sockToStringForGdb(connection.getRemoteAddress()));
connection.waitClosed();
Msg.info(this, "Closed");
}
@Test
public void testConnectErrorNoArg() throws Exception {
try {
runThrowError("""
%s
ghidra trace connect
quit
""".formatted(PREAMBLE));
fail();
}
catch (GdbError e) {
assertThat(e.stderr, containsString("'ghidra trace connect'"));
assertThat(e.stderr, containsString("'address'"));
}
}
@Test
public void testConnect() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
quit
""".formatted(PREAMBLE, addr));
}
@Test
public void testDisconnect() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace disconnect
quit
""".formatted(PREAMBLE, addr));
}
@Test
public void testStartTraceDefaults() throws Exception {
// Default name and lcsp
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
ghidra trace start
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals("x86:LE:64:default",
tb.trace.getBaseLanguage().getLanguageID().getIdAsString());
assertEquals("gcc",
tb.trace.getBaseCompilerSpec().getCompilerSpecID().getIdAsString());
}
}
@Test
public void testStartTraceDefaultNoFile() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace start
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
assertThat(mdo.get(), instanceOf(Trace.class));
}
}
@Test
public void testStartTraceCustomize() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
set ghidra-language Toy:BE:64:default
set ghidra-compiler default
ghidra trace start myToy
quit
""".formatted(PREAMBLE, addr));
DomainFile dfMyToy = env.getProject().getProjectData().getFile("/New Traces/myToy");
assertNotNull(dfMyToy);
try (ManagedDomainObject mdo = new ManagedDomainObject(dfMyToy, false, false, monitor)) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals("Toy:BE:64:default",
tb.trace.getBaseLanguage().getLanguageID().getIdAsString());
assertEquals("default",
tb.trace.getBaseCompilerSpec().getCompilerSpecID().getIdAsString());
}
}
@Test
public void testStopTrace() throws Exception {
// TODO: This test assumes gdb and the target file bash are x86-64
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
ghidra trace start
ghidra trace stop
quit
""".formatted(PREAMBLE, addr));
DomainFile dfBash = env.getProject().getProjectData().getFile("/New Traces/gdb/bash");
assertNotNull(dfBash);
// TODO: Given the 'quit' command, I'm not sure this assertion is checking anything.
assertFalse(dfBash.isOpen());
}
@Test
public void testInfo() throws Exception {
AtomicReference<String> refAddr = new AtomicReference<>();
String out = runThrowError(addr -> {
refAddr.set(addr);
return """
%s
file bash
echo \\n---Import---\\n
ghidra trace info
echo \\n---BeforeConnect---\\n
ghidra trace connect %s
echo \\n---Connect---\\n
ghidra trace info
ghidra trace start
echo \\n---Start---\\n
ghidra trace info
ghidra trace stop
echo \\n---Stop---\\n
ghidra trace info
ghidra trace disconnect
echo \\n---Disconnect---\\n
ghidra trace info
quit
""".formatted(PREAMBLE, addr);
});
assertEquals("""
Not connected to Ghidra""",
extractOutSection(out, "---Import---"));
assertEquals("""
Connected to %s %s at %s
No trace""".formatted(
Application.getName(), Application.getApplicationVersion(), refAddr.get()),
extractOutSection(out, "---Connect---"));
assertEquals("""
Connected to %s %s at %s
Trace active""".formatted(
Application.getName(), Application.getApplicationVersion(), refAddr.get()),
extractOutSection(out, "---Start---"));
assertEquals("""
Connected to %s %s at %s
No trace""".formatted(
Application.getName(), Application.getApplicationVersion(), refAddr.get()),
extractOutSection(out, "---Stop---"));
assertEquals("""
Not connected to Ghidra""",
extractOutSection(out, "---Disconnect---"));
}
@Test
public void testLcsp() throws Exception {
// TODO: This test assumes x86-64 on test system
String out = runThrowError("""
%s
echo \\n---Import---\\n
ghidra trace lcsp
echo \\n---\\n
file bash
echo \\n---File---\\n
ghidra trace lcsp
set ghidra-language Toy:BE:64:default
echo \\n---Language---\\n
ghidra trace lcsp
set ghidra-compiler posStack
echo \\n---Compiler---\\n
ghidra trace lcsp
quit
""".formatted(PREAMBLE));
assertEquals("""
Selected Ghidra language: x86:LE:32:default
Selected Ghidra compiler: pointer64""",
extractOutSection(out, "---Import---"));
assertEquals("""
Selected Ghidra language: x86:LE:64:default
Selected Ghidra compiler: gcc""",
extractOutSection(out, "---File---"));
assertEquals("""
Selected Ghidra language: Toy:BE:64:default
Selected Ghidra compiler: default""",
extractOutSection(out, "---Language---"));
assertEquals("""
Selected Ghidra language: Toy:BE:64:default
Selected Ghidra compiler: posStack""",
extractOutSection(out, "---Compiler---"));
}
@Test
public void testSave() throws Exception {
traceManager.setSaveTracesByDefault(false);
// For sanity check, verify failing to save drops data
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
ghidra trace start no-save
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/no-save")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals(0, tb.trace.getTimeManager().getAllSnapshots().size());
}
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
ghidra trace start save
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace tx-commit
ghidra trace save
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/save")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals(1, tb.trace.getTimeManager().getAllSnapshots().size());
}
}
@Test
public void testSnapshot() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
ghidra trace start
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceSnapshot snapshot = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots());
assertEquals(0, snapshot.getKey());
assertEquals("Scripted snapshot", snapshot.getDescription());
}
}
@Test
public void testPutmem() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
start
ghidra trace start
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putmem &main 10
ghidra trace tx-commit
echo \\n---Dump---\\n
x/10bx main
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
MemDump dump = parseHexDump(extractOutSection(out, "---Dump---"));
ByteBuffer buf = ByteBuffer.allocate(dump.data().length);
tb.trace.getMemoryManager().getBytes(snap, tb.addr(dump.address()), buf);
assertArrayEquals(dump.data(), buf.array());
}
}
@Test
public void testPutmemInferior2() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
add-inferior
inferior 2
file bash
start
ghidra trace start
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putmem &main 10
ghidra trace tx-commit
echo \\n---Dump---\\n
x/10bx main
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
AddressSpace ram2 = tb.trace.getBaseAddressFactory().getAddressSpace("ram2");
assertNotNull(ram2);
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
MemDump dump = parseHexDump(extractOutSection(out, "---Dump---"));
ByteBuffer buf = ByteBuffer.allocate(dump.data().length);
tb.trace.getMemoryManager().getBytes(snap, ram2.getAddress(dump.address()), buf);
assertArrayEquals(dump.data(), buf.array());
}
}
@Test
public void testPutmemState() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
start
ghidra trace start
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putmem-state &main 10 error
ghidra trace tx-commit
echo \\n---Start---\\n
print/x &main
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
String eval = extractOutSection(out, "---Start---");
Address addr = tb.addr(Long.decode(eval.split("=")[1].trim()));
Entry<TraceAddressSnapRange, TraceMemoryState> entry =
tb.trace.getMemoryManager().getMostRecentStateEntry(snap, addr);
assertEquals(Map.entry(new ImmutableTraceAddressSnapRange(
quantize(rng(addr, 10), 4096), Lifespan.at(0)), TraceMemoryState.ERROR), entry);
}
}
@Test
public void testDelmem() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
start
ghidra trace start
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putmem &main 10
ghidra trace delmem &main 5
ghidra trace tx-commit
echo \\n---Dump---\\n
x/10bx main
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
MemDump dump = parseHexDump(extractOutSection(out, "---Dump---"));
Arrays.fill(dump.data(), 0, 5, (byte) 0);
ByteBuffer buf = ByteBuffer.allocate(dump.data().length);
tb.trace.getMemoryManager().getBytes(snap, tb.addr(dump.address()), buf);
assertArrayEquals(dump.data(), buf.array());
}
}
@Test
public void testPutreg() throws Exception {
String count = IntStream.iterate(0, i -> i < 32, i -> i + 1)
.mapToObj(Integer::toString)
.collect(Collectors.joining(",", "{", "}"));
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
start
ghidra trace start
set $ymm0.v32_int8 = %s
set $st0 = 1.5
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putreg
ghidra trace tx-commit
kill
quit
""".formatted(PREAMBLE, addr, count));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
AddressSpace t1f0 = tb.trace.getBaseAddressFactory()
.getAddressSpace("Inferiors[1].Threads[1].Stack[0].Registers");
TraceMemorySpace regs = tb.trace.getMemoryManager().getMemorySpace(t1f0, false);
RegisterValue ymm0 = regs.getValue(snap, tb.reg("ymm0"));
// GDB treats registers in arch's endian
assertEquals("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100",
ymm0.getUnsignedValue().toString(16));
TraceData st0;
try (Transaction tx = tb.trace.openTransaction("Float80 unit")) {
TraceCodeSpace code = tb.trace.getCodeManager().getCodeSpace(t1f0, true);
st0 = code.definedData()
.create(Lifespan.nowOn(0), tb.reg("st0"), Float10DataType.dataType);
}
assertEquals("1.5", st0.getDefaultValueRepresentation());
}
}
@Test
public void testDelreg() throws Exception {
String count = IntStream.iterate(0, i -> i < 32, i -> i + 1)
.mapToObj(Integer::toString)
.collect(Collectors.joining(",", "{", "}"));
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
start
ghidra trace start
set $ymm0.v32_int8 = %s
set $st0 = 1.5
ghidra trace tx-start "Create snapshot"
ghidra trace new-snap "Scripted snapshot"
ghidra trace putreg
ghidra trace delreg
ghidra trace tx-commit
kill
quit
""".formatted(PREAMBLE, addr, count));
// The spaces will be left over, but the values should be zeroed
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
long snap = Unique.assertOne(tb.trace.getTimeManager().getAllSnapshots()).getKey();
AddressSpace t1f0 = tb.trace.getBaseAddressFactory()
.getAddressSpace("Inferiors[1].Threads[1].Stack[0].Registers");
TraceMemorySpace regs = tb.trace.getMemoryManager().getMemorySpace(t1f0, false);
RegisterValue ymm0 = regs.getValue(snap, tb.reg("ymm0"));
assertEquals("0", ymm0.getUnsignedValue().toString(16));
TraceData st0;
try (Transaction tx = tb.trace.openTransaction("Float80 unit")) {
TraceCodeSpace code = tb.trace.getCodeManager().getCodeSpace(t1f0, true);
st0 = code.definedData()
.create(Lifespan.nowOn(0), tb.reg("st0"), Float10DataType.dataType);
}
assertEquals("0.0", st0.getDefaultValueRepresentation());
}
}
@Test
public void testCreateObj() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace start
ghidra trace tx-start "Create Object"
echo \\n---Id---\\n
ghidra trace create-obj Test.Objects[1]
echo \\n---
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
String created = extractOutSection(out, "---Id---");
long id = Long.parseLong(created.split("id=")[1].split(",")[0]);
assertEquals(object.getKey(), id);
}
}
@Test
public void testInsertObj() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
echo \\n---Lifespan---\\n
ghidra trace insert-obj Test.Objects[1]
echo \\n---
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
Lifespan life = Unique.assertOne(object.getLife().spans());
assertEquals(Lifespan.nowOn(0), life);
String lifeStr = extractOutSection(out, "---Lifespan---");
assertEquals("Inserted object: lifespan=[0,+inf)", lifeStr);
}
}
@Test
public void testRemoveObj() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
ghidra trace set-snap 1
ghidra trace remove-obj Test.Objects[1]
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
Lifespan life = Unique.assertOne(object.getLife().spans());
assertEquals(Lifespan.at(0), life);
}
}
@SuppressWarnings("unchecked")
protected <T> T runTestSetValue(String extra, String gdbExpr, String gtype)
throws Exception {
String expPrint = DummyProc.which("expPrint");
runThrowError(addr -> """
%s
ghidra trace connect %s
file %s
start
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
%s
ghidra trace set-value Test.Objects[1] test "%s" %s
ghidra trace tx-commit
kill
quit
""".formatted(PREAMBLE, addr, expPrint, extra, gdbExpr, gtype));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/expPrint")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
TraceObjectValue value = object.getValue(0, "test");
return value == null ? null : (T) value.getValue();
}
}
@Test
public void testSetValueNull() throws Exception {
assertNull(runTestSetValue("", "(void)0", ""));
}
@Test
public void testSetValueBool() throws Exception {
// C++ required for bool
assertEquals(Boolean.TRUE, runTestSetValue("set language c++", "(bool)1", ""));
}
@Test
public void testSetValueByte() throws Exception {
assertEquals(Byte.valueOf((byte) 1), runTestSetValue("", "(char)1", ""));
}
@Test
public void testSetValueChar() throws Exception {
assertEquals(Character.valueOf('A'), runTestSetValue("", "'A'", "CHAR"));
}
@Test
public void testSetValueShort() throws Exception {
assertEquals(Short.valueOf((short) 1), runTestSetValue("", "(short)1", ""));
}
@Test
public void testSetValueInt() throws Exception {
assertEquals(Integer.valueOf(1), runTestSetValue("", "(int)1", ""));
}
@Test
public void testSetValueLong() throws Exception {
assertEquals(Long.valueOf(1), runTestSetValue("", "(long long)1", ""));
}
@Test
public void testSetValueString() throws Exception {
assertEquals("Hello World!", runTestSetValue("", "\\\"Hello World!\\\"", ""));
}
@Test
public void testSetValueStringWide() throws Exception {
// C++ required for wchar_t
assertEquals("Hello World!",
runTestSetValue("set language c++", "L\\\"Hello World!\\\"", ""));
}
@Test
public void testSetValueBoolArr() throws Exception {
// C++ required for bool, true, false
assertArrayEquals(new boolean[] { true, false },
runTestSetValue("set language c++", "{ true, false }", ""));
}
@Test
public void testSetValueByteArrUsingString() throws Exception {
// Because explicit array type is chosen, we get null terminator
assertArrayEquals(new byte[] { 'H', 0, 'W', 0 },
runTestSetValue("", "\\\"H\\\\0W\\\"", "BYTE_ARR"));
}
@Test
public void testSetValueByteArrUsingArray() throws Exception {
assertArrayEquals(new byte[] { 'H', 0, 'W' },
runTestSetValue("", "(char[3]){'H', 0, 'W'}", "BYTE_ARR"));
}
@Test
public void testSetValueCharArrUsingString() throws Exception {
// Because explicit array type is chosen, we get null terminator
assertArrayEquals(new char[] { 'H', 0, 'W', 0 },
runTestSetValue("", "\\\"H\\\\0W\\\"", "CHAR_ARR"));
}
@Test
public void testSetValueCharArrUsingArray() throws Exception {
assertArrayEquals(new char[] { 'H', 0, 'W' },
runTestSetValue("", "(char[3]){'H', 0, 'W'}", "CHAR_ARR"));
}
@Test
public void testSetValueShortArrUsingString() throws Exception {
// Because explicit array type is chosen, we get null terminator
assertArrayEquals(new short[] { 'H', 0, 'W', 0 },
runTestSetValue("set language c++", "L\\\"H\\\\0W\\\"", "SHORT_ARR"));
}
@Test
public void testSetValueShortArrUsingArray() throws Exception {
assertArrayEquals(new short[] { 'H', 0, 'W' },
runTestSetValue("", "(short[3]){'H', 0, 'W'}", "SHORT_ARR"));
}
@Test
public void testSetValueIntArrayUsingString() throws Exception {
// Because explicit array type is chosen, we get null terminator
assertArrayEquals(new int[] { 'H', 0, 'W', 0 },
runTestSetValue("set language c++", "L\\\"H\\\\0W\\\"", "INT_ARR"));
}
@Test
public void testSetValueIntArrUsingArray() throws Exception {
assertArrayEquals(new int[] { 1, 2, 3, 4 },
runTestSetValue("", "{1, 2, 3, 4}", ""));
}
@Test
public void testSetValueLongArr() throws Exception {
assertArrayEquals(new long[] { 1, 2, 3, 4 },
runTestSetValue("", "{1LL, 2LL, 3LL, 4LL}", ""));
}
// Skip String[]. Trouble is expressing them in GDB....
@Test
public void testSetValueAddress() throws Exception {
Address address = runTestSetValue("", "(void*)0xdeadbeef", "");
// Don't have the address factory to create expected address
assertEquals(0xdeadbeefL, address.getOffset());
assertEquals("ram", address.getAddressSpace().getName());
}
@Test
public void testSetValueObject() throws Exception {
TraceObject object = runTestSetValue("", "Test.Objects[1]", "OBJECT");
assertEquals("Test.Objects[1]", object.getCanonicalPath().toString());
}
@Test
public void testRetainValues() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
set language c++
start
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
ghidra trace set-value Test.Objects[1] [1] '"A"'
ghidra trace set-value Test.Objects[1] [2] '"B"'
ghidra trace set-value Test.Objects[1] [3] '"C"'
ghidra trace set-snap 10
ghidra trace retain-values Test.Objects[1] [1] [3]
ghidra trace tx-commit
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
assertEquals(Map.ofEntries(
Map.entry("[1]", Lifespan.nowOn(0)),
Map.entry("[2]", Lifespan.span(0, 9)),
Map.entry("[3]", Lifespan.nowOn(0))),
object.getValues(Lifespan.ALL)
.stream()
.collect(Collectors.toMap(v -> v.getEntryKey(), v -> v.getLifespan())));
}
}
@Test
public void testGetObj() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
ghidra trace start
ghidra trace tx-start "Create Object"
echo \\n---Id---\\n
ghidra trace create-obj Test.Objects[1]
echo \\n---
ghidra trace tx-commit
echo \\n---GetObject---\\n
ghidra trace get-obj Test.Objects[1]
echo \\n---
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
TraceObject object = tb.trace.getObjectManager()
.getObjectByCanonicalPath(TraceObjectKeyPath.parse("Test.Objects[1]"));
assertNotNull(object);
String getObject = extractOutSection(out, "---GetObject---");
assertEquals("%d\tTest.Objects[1]".formatted(object.getKey()), getObject);
}
}
@Test
public void testGetValues() throws Exception {
String expPrint = DummyProc.which("expPrint");
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file %s
set language c++
start
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
ghidra trace set-value Test.Objects[1] vnull (void)0
ghidra trace set-value Test.Objects[1] vbool true
ghidra trace set-value Test.Objects[1] vbyte (char)1
ghidra trace set-value Test.Objects[1] vchar "'A'" CHAR
ghidra trace set-value Test.Objects[1] vshort (short)2
ghidra trace set-value Test.Objects[1] vint 3
ghidra trace set-value Test.Objects[1] vlong 4LL
ghidra trace set-value Test.Objects[1] vstring '"Hello"'
ghidra trace set-value Test.Objects[1] vboolarr '{true, false}'
ghidra trace set-value Test.Objects[1] vbytearr '(char[3]){1, 2, 3}' BYTE_ARR
ghidra trace set-value Test.Objects[1] vchararr '"Hello"' CHAR_ARR
ghidra trace set-value Test.Objects[1] vshortarr '(short[3]){1, 2, 3}'
ghidra trace set-value Test.Objects[1] vintarr '{1, 2, 3}'
ghidra trace set-value Test.Objects[1] vlongarr '{1LL, 2LL, 3LL}'
ghidra trace set-value Test.Objects[1] vaddr (void*)0xdeadbeef
ghidra trace set-value Test.Objects[1] vobj Test.Objects[1] OBJECT
ghidra trace tx-commit
echo \\n---GetValues---\\n
ghidra trace get-values Test.Objects[1].
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr, expPrint));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/expPrint")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals("""
Parent Key Span Value Type
Test.Objects[1] vaddr [0,+inf) ram:deadbeef ADDRESS
Test.Objects[1] vbool [0,+inf) True BOOL
Test.Objects[1] vboolarr [0,+inf) [True, False] BOOL_ARR
Test.Objects[1] vbyte [0,+inf) 1 BYTE
Test.Objects[1] vbytearr [0,+inf) b'\\x01\\x02\\x03' BYTE_ARR
Test.Objects[1] vchar [0,+inf) 'A' CHAR
Test.Objects[1] vchararr [0,+inf) 'Hello\\x00' CHAR_ARR
Test.Objects[1] vint [0,+inf) 3 INT
Test.Objects[1] vintarr [0,+inf) [1, 2, 3] INT_ARR
Test.Objects[1] vlong [0,+inf) 4 LONG
Test.Objects[1] vlongarr [0,+inf) [1, 2, 3] LONG_ARR
Test.Objects[1] vobj [0,+inf) Test.Objects[1] OBJECT
Test.Objects[1] vshort [0,+inf) 2 SHORT
Test.Objects[1] vshortarr [0,+inf) [1, 2, 3] SHORT_ARR
Test.Objects[1] vstring [0,+inf) 'Hello' STRING""",
extractOutSection(out, "---GetValues---"));
}
}
@Test
public void testGetValuesRng() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
set language c++
start
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
ghidra trace set-value Test.Objects[1] vaddr (void*)0xdeadbeef
ghidra trace tx-commit
echo \\n---GetValues---\\n
ghidra trace get-values-rng (void*)0xdeadbeef 10
echo \\n---
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
assertEquals("""
Parent Key Span Value Type
Test.Objects[1] vaddr [0,+inf) ram:deadbeef ADDRESS""",
extractOutSection(out, "---GetValues---"));
}
}
@Test
public void testActivateObject() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
set language c++
start
ghidra trace start
ghidra trace tx-start "Create Object"
ghidra trace create-obj Test.Objects[1]
ghidra trace insert-obj Test.Objects[1]
ghidra trace tx-commit
ghidra trace activate Test.Objects[1]
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
assertSame(mdo.get(), traceManager.getCurrentTrace());
assertEquals("Test.Objects[1]",
traceManager.getCurrentObject().getCanonicalPath().toString());
}
}
@Test
public void testDisassemble() throws Exception {
String out = runThrowError(addr -> """
%s
ghidra trace connect %s
file bash
set language c++
start
ghidra trace start
ghidra trace tx-start "Tx"
ghidra trace putmem &main 10
echo \\n---Disassemble---\\n
ghidra trace disassemble &main
echo \\n---
ghidra trace tx-commit
kill
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/bash")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
// Not concerned about specifics, so long as disassembly occurs
long total = 0;
for (CodeUnit cu : tb.trace.getCodeManager().definedUnits().get(0, true)) {
total += cu.getLength();
}
assertEquals("Disassembled %d bytes".formatted(total),
extractOutSection(out, "---Disassemble---"));
}
}
@Test
public void testPutInferiors() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
add-inferior
ghidra trace start
ghidra trace tx-start "Tx"
ghidra trace put-inferiors
ghidra trace tx-commit
quit
""".formatted(PREAMBLE, addr));
try (ManagedDomainObject mdo = openDomainObject("/New Traces/gdb/noname")) {
tb = new ToyDBTraceBuilder((Trace) mdo.get());
// Would be nice to control / validate the specifics
Collection<TraceObject> inferiors = tb.trace.getObjectManager()
.getValuePaths(Lifespan.at(0), PathPredicates.parse("Inferiors[]"))
.map(p -> p.getDestination(null))
.toList();
assertEquals(2, inferiors.size());
}
}
@Test
public void testPutAvailable() throws Exception {
runThrowError(addr -> """
%s
ghidra trace connect %s
add-inferior
ghidra trace start
ghidra trace tx-start "Tx"
ghidra trace put-available
ghidra trace tx-commit