-
-
Notifications
You must be signed in to change notification settings - Fork 46
/
Copy pathtest-Z80.c
1013 lines (813 loc) · 33.7 KB
/
test-Z80.c
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
/* test-Z80
______ ______ ______
/\___ \/\ __ \\ __ \
____ \/__/ /\_\ __ \\ \/\ \ ________________________________________________
| /\_____\\_____\\_____\ |
| Zilog \/_____//_____//_____/ CPU Emulator - Testing Tool |
| Copyright (C) 2021-2025 Manuel Sainz de Baranda y Goñi. |
| |
| This program is free software: you can redistribute it and/or modify it |
| under the terms of the GNU General Public License as published by the Free |
| Software Foundation, either version 3 of the License, or (at your option) |
| any later version. |
| |
| This program is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| for more details. |
| |
| You should have received a copy of the GNU General Public License along |
| with this program. If not, see <http://www.gnu.org/licenses/>. |
| |
'=============================================================================*/
#ifdef TEST_Z80_WITH_ARCHIVE_EXTRACTION
# include <zip.h>
# include <zlib.h>
# include <Z/formats/archive/TAR.h>
#endif
#include <Z/constants/pointer.h>
#include <Z/macros/array.h>
#include <Z/macros/hash.h>
#include <Z80.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
/* MARK: - Macros */
#ifdef TEST_Z80_WITH_EXECUTE
# define RUN z80_execute
#else
# define RUN z80_run
#endif
#define OPCODE_NOP 0x00
#define OPCODE_RET 0xC9
#define OPCODE_HALT 0x76
#define OPCODE_JP_WORD 0xC3
#define TEST_FORMAT_CPM 0 /* CP/M program in COM format. */
#define TEST_FORMAT_HARSTON 1 /* Z80 Instruction Set Exerciser for Spectrum. */
#define TEST_FORMAT_RAK 2 /* Patrik Rak's Zilog Z80 CPU Test Suite. */
#define TEST_FORMAT_WOODMASS 3 /* Mark Woodmass' Z80 Test Suite. */
/* MARK: - Types */
typedef struct {
/* Name of the archive if the file is compressed; `Z_NULL` otherwise. */
char const* archive_name;
/* Name of the file, or path to the file inside the archive if the file
* is compressed. */
char const* file_path;
/* Total number of clock cycles executed when the test passes. */
zusize cycles[1 + (Z_USIZE_WIDTH < 64)];
/* FNV-1 hash of the entire text output when the test passes
* (i.e., of all bytes sent by the program to the print routine). */
zuint32 hash;
/* Memory address to jump to in order to start executing the program.
* The lower byte is zeroed to obtain the address where to load the
* executable code. */
zuint16 start_address;
/* Value of the PC register once the program completes. */
zuint16 exit_address;
/* Size of the file. */
zuint16 file_size;
/* Size of the executable code. */
zuint16 code_size;
/* Offset of the executable code inside the file. */
zuint8 code_offset;
/* Format of the program. */
zuint8 format;
/* Number of lines printed when the test passes. */
zuint8 lines;
/* Rightmost position reached by the cursor when the test passes. */
zuint8 columns;
} Test;
/* MARK: - Global Variables */
#if Z_USIZE_WIDTH < 64
# define CYCLES(high, low) {Z_USIZE(0x##low), Z_USIZE(0x##high)}
#else
# define CYCLES(high, low) {Z_USIZE(0x##high##low)}
#endif
static Test const tests[22] = {
{"Yaze v1.10 (1998-01-28)(Cringle, Frank D.)(Sources)[!].tar.gz", "yaze-1.10/test/zexdoc.com", CYCLES(A, E19F287A) /* 46,734,977,146 */, Z_UINT32(0xEDE3CB62), Z_UINT16(0x0100), Z_UINT16( 0), 8704, 8704, 0, TEST_FORMAT_CPM, 68, 34},
{Z_NULL, "Z80 Documented Instruction Set Exerciser for Spectrum (2018)(Harston, Jonathan Graham)[!].tap", CYCLES(A, E4E22836) /* 46,789,699,638 */, Z_UINT32(0x9F8B1839), Z_UINT16(0x8000), Z_UINT16(0x803D), 8716, 8624, 91, TEST_FORMAT_HARSTON, 69, 32},
{"Yaze v1.10 (1998-01-28)(Cringle, Frank D.)(Sources)[!].tar.gz", "yaze-1.10/test/zexall.com", CYCLES(A, E19F287A) /* 46,734,977,146 */, Z_UINT32(0xEDE3CB62), Z_UINT16(0x0100), Z_UINT16( 0), 8704, 8704, 0, TEST_FORMAT_CPM, 68, 34},
{Z_NULL, "Z80 Full Instruction Set Exerciser for Spectrum (2009)(Bobrowski, Jan)[!].tap", CYCLES(A, E4E1B837) /* 46,789,670,967 */, Z_UINT32(0xD4910BEE), Z_UINT16(0x8000), Z_UINT16(0x803D), 8656, 8547, 108, TEST_FORMAT_HARSTON, 69, 31},
{Z_NULL, "Z80 Full Instruction Set Exerciser for Spectrum (2011)(Bobrowski, Jan)(Narrowed to BIT Instructions)[!].tap", CYCLES(0, 4F67AEDF) /* 1,332,195,039 */, Z_UINT32(0x680D4830), Z_UINT16(0x8000), Z_UINT16(0x803D), 8656, 8547, 108, TEST_FORMAT_HARSTON, 4, 31},
{Z_NULL, "Z80 Full Instruction Set Exerciser for Spectrum (2017-0x)(Harston, Jonathan Graham)[!].tap", CYCLES(A, E4E20746) /* 46,789,691,206 */, Z_UINT32(0x9F50D128), Z_UINT16(0x8000), Z_UINT16(0x803D), 8704, 8612, 91, TEST_FORMAT_HARSTON, 69, 32},
{Z_NULL, "Z80 Full Instruction Set Exerciser for Spectrum (2018)(Harston, Jonathan Graham)[!].tap", CYCLES(A, E4E22836) /* 46,789,699,638 */, Z_UINT32(0x9F50D128), Z_UINT16(0x8000), Z_UINT16(0x803D), 8716, 8624, 91, TEST_FORMAT_HARSTON, 69, 32},
{"Z80 Instruction Set Exerciser for Spectrum 2 v0.1 (2012-11-27)(Rak, Patrik)[!].zip", "zexall2-0.1/zexall2.tap", CYCLES(C, 18A43876) /* 51,953,023,094 */, Z_UINT32(0x05C746F7), Z_UINT16(0x8000), Z_UINT16(0x8040), 9316, 9228, 87, TEST_FORMAT_HARSTON, 76, 31},
{Z_NULL, "Z80 Test Suite (2008)(Woodmass, Mark)[!].tap", CYCLES(0, 9C3040EF) /* 2,620,408,047 */, Z_UINT32(0xF787CA8E), Z_UINT16(0x8057), Z_UINT16(0x80E6), 5573, 5452, 120, TEST_FORMAT_WOODMASS, 50, 32},
{Z_NULL, "Z80 Test Suite (2008)(Woodmass, Mark)[!].tap", CYCLES(0, 0308BF63) /* 50,904,931 */, Z_UINT32(0xF5AE5140), Z_UINT16(0x8049), Z_UINT16(0x80E6), 5573, 5452, 120, TEST_FORMAT_WOODMASS, 61, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80full.tap", CYCLES(0, 4303ABE0) /* 1,124,314,097 */, Z_UINT32(0xB8707D12), Z_UINT16(0x8000), Z_UINT16( 0), 13758, 13666, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80doc.tap", CYCLES(0, 436E8254) /* 1,131,315,813 */, Z_UINT32(0x9E9DD1F5), Z_UINT16(0x8000), Z_UINT16( 0), 13758, 13666, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80flags.tap", CYCLES(0, 20ED11CB) /* 552,407,516 */, Z_UINT32(0x27CB27A2), Z_UINT16(0x8000), Z_UINT16( 0), 13758, 13666, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80docflags.tap", CYCLES(0, 2110B9A0) /* 554,744,241 */, Z_UINT32(0x3966C46C), Z_UINT16(0x8000), Z_UINT16( 0), 13758, 13666, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80ccf.tap", CYCLES(0, 23AB74B9) /* 598,439,114 */, Z_UINT32(0xB34ED107), Z_UINT16(0x8000), Z_UINT16( 0), 14219, 14127, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.0 (2012-12-08)(Rak, Patrik)[!].zip", "z80test-1.0/z80memptr.tap", CYCLES(0, 215CF3AC) /* 559,739,837 */, Z_UINT32(0x840ACD96), Z_UINT16(0x8000), Z_UINT16( 0), 13758, 13666, 91, TEST_FORMAT_RAK, 156, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80full.tap", CYCLES(0, 4382DC59) /* 1,132,649,578 */, Z_UINT32(0x4C578BC6), Z_UINT16(0x8000), Z_UINT16( 0), 14390, 14298, 91, TEST_FORMAT_RAK, 164, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80doc.tap", CYCLES(0, 43EE72BD) /* 1,139,700,430 */, Z_UINT32(0x02114A09), Z_UINT16(0x8000), Z_UINT16( 0), 14390, 14298, 91, TEST_FORMAT_RAK, 164, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80flags.tap", CYCLES(0, 212F17C4) /* 556,734,421 */, Z_UINT32(0x91826856), Z_UINT16(0x8000), Z_UINT16( 0), 14390, 14298, 91, TEST_FORMAT_RAK, 164, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80docflags.tap", CYCLES(0, 2152FFC9) /* 559,087,578 */, Z_UINT32(0x408190F0), Z_UINT16(0x8000), Z_UINT16( 0), 14390, 14298, 91, TEST_FORMAT_RAK, 164, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80ccf.tap", CYCLES(0, 23F34E32) /* 603,147,843 */, Z_UINT32(0x27FF6693), Z_UINT16(0x8000), Z_UINT16( 0), 14875, 14783, 91, TEST_FORMAT_RAK, 164, 32},
{"Zilog Z80 CPU Test Suite v1.2a (2023-12-02)(Rak, Patrik)[!].zip", "z80test-1.2a/z80memptr.tap", CYCLES(0, 219FC265) /* 564,118,134 */, Z_UINT32(0xDB7B18AA), Z_UINT16(0x8000), Z_UINT16( 0), 14390, 14298, 91, TEST_FORMAT_RAK, 164, 32}};
#undef CYCLES
static struct {char const *key; zuint8 options;} const cpu_models[4] = {
{"zilog-nmos", Z80_MODEL_ZILOG_NMOS},
{"zilog-cmos", Z80_MODEL_ZILOG_CMOS},
{"nec-nmos", Z80_MODEL_NEC_NMOS },
{"st-cmos", Z80_MODEL_ST_CMOS }};
static char const new_line[2] = "\n";
/*---------------------------------------------------------------------------.
| The search paths specified by using the `-p` option are collected into the |
| `search_paths` array of size `search_path_count`. `path_buffer` is used to |
| compose a complete file path consisting of "<search-path>/<filename>". |
'===========================================================================*/
static char* path_buffer = Z_NULL;
static char** search_paths = Z_NULL;
static zuint search_path_count = 0;
/*-----------------------------------------------------------------------------.
| `verbosity` contains the verbosity level specified by using the `-v` option; |
| `show_test_output` indicates whether to print the text output of the tests; |
| `test_spacing` points to the string to print beetween each test: "\n" or "". |
'=============================================================================*/
static zuint8 verbosity = 4;
static zboolean show_test_output;
static char const* test_spacing;
/*-----------------------------------------------------------------------------.
| [0]: The byte read from even I/O ports (specified by using the `-0` option). |
| [1]: The byte read from odd I/O ports (specified by using the `-1` option). |
| The default values are those of a Sinclair ZX Spectrum 48K with no devices |
| connected. |
'=============================================================================*/
static zuint8 in_values[2] = {191, 255};
/*---------------------------------------------------.
| Instance of the Z80 emulator and 64 KiB of memory. |
'===================================================*/
static Z80 cpu;
static zuint8 memory[Z_USIZE(65536)];
/*-----------------------------------------------------------------------------.
| `completed` indicates whether the test has reached its exit address; `lines` |
| is incremented every time the test prints a new line; `cursor_x` holds the X |
| position of the cursor in the current line; `columns` contains the rightmost |
| position reached by the cursor throughout the test; and `hash` keeps a FNV-1 |
| hash of all bytes sent by the test to the print routine. |
'=============================================================================*/
static zboolean completed;
static zusize lines, cursor_x, columns;
static zuint32 hash;
/*-----------------------------------------------------------------------------.
| `zx_spectrum_print_hook_address` contains the address of the hook that |
| intercepts the routine called by the test to print characters. When a <TAB> |
| character (17h) is printed, the `zx_spectrum_tab` counter is set to 2 to |
| indicate that it is necessary to process the incoming <TAB n> and <TAB STOP> |
| bytes before continuing to print characters. `zx_spectrum_bad_character` is |
| set to `Z_TRUE` if the test prints any unsupported control characters. |
| |
| For more information about the TAB control sequence of the ZX Spectrum, see: |
| * Sinclair Research (1983). "Sinclair ZX Spectrum BASIC Programming" 2nd |
| ed., pp. 103, 196. |
| * Ardley, Neil (1984). "ZX Spectrum + User Guide" (Dorling Kindersley; |
| Sinclair Research. ISBN 0863180809), pp. 67-68. |
| |
| These three variables are only used for ZX Spectrum tests. |
'=============================================================================*/
static zuint16 zx_spectrum_print_hook_address;
static zuint zx_spectrum_tab;
static zboolean zx_spectrum_bad_character;
/* MARK: - CPU Callbacks: Auxiliary Functions */
static void lf(void)
{
if (show_test_output) putchar('\n');
if (cursor_x > columns) columns = cursor_x;
cursor_x = 0;
lines++;
}
/* MARK: - CPU Callbacks: Common */
static zuint8 cpu_read(void *context, zuint16 address)
{
Z_UNUSED(context)
return memory[address];
}
static zuint8 cpu_in(void *context, zuint16 port)
{
Z_UNUSED(context)
return in_values[port & 1];
}
static void cpu_out(void *context, zuint16 port, zuint8 value)
{Z_UNUSED(context) Z_UNUSED(port) Z_UNUSED(value)}
static void cpu_halt(void *context, zuint8 state)
{
Z_UNUSED(context) Z_UNUSED(state)
completed = Z_TRUE;
z80_break(&cpu);
}
/* MARK: - CPU Callbacks: CP/M */
static void cpm_cpu_write(void *context, zuint16 address, zuint8 value)
{
Z_UNUSED(context)
memory[address] = value;
}
static zuint8 cpm_cpu_hook(void *context, zuint16 address)
{
zuint8 character;
Z_UNUSED(context)
if (address != 5) return OPCODE_NOP;
/* BDOS function 2 (C_WRITE) - Console output */
if (Z80_C(cpu) == 2)
{
hash = Z_FNV1_32_UPDATE(hash, (character = Z80_E(cpu)));
switch (character)
{
case 0x0A: /* LF */ lf();
case 0x0D: /* CR */ break;
default:
if (show_test_output) putchar(character);
cursor_x++;
}
}
/* BDOS function 9 (C_WRITESTR) - Output string */
else if (Z80_C(cpu) == 9)
{
zuint16 i = Z80_DE(cpu);
zuint c = 255;
while (c--)
{
hash = Z_FNV1_32_UPDATE(hash, (character = memory[i++]));
switch (character)
{
case 0x24: /* $ */ return OPCODE_RET;
case 0x0A: /* LF */ lf();
case 0x0D: /* CR */ break;
default:
if (show_test_output) putchar(character);
cursor_x++;
}
}
if (show_test_output) puts(" [TRUNCATED]");
}
return OPCODE_RET;
}
/* MARK: - CPU Callbacks: ZX Spectrum */
static void zx_spectrum_cpu_write(void *context, zuint16 address, zuint8 value)
{
Z_UNUSED(context)
if (address > 0x3FFF) memory[address] = value;
}
static zuint8 zx_spectrum_cpu_hook(void *context, zuint16 address)
{
zuint8 character;
Z_UNUSED(context)
if (address != zx_spectrum_print_hook_address) return OPCODE_NOP;
hash = Z_FNV1_32_UPDATE(hash, (character = Z80_A(cpu)));
if (!zx_spectrum_tab) switch (character)
{
case 0x0D: /* ENTER */
lf();
break;
case 0x17: /* TAB */
zx_spectrum_tab = 2;
break;
case 0x7F: /* © */
if (show_test_output) printf("©");
cursor_x++;
break;
default:
if (character >= 32 && character < 127)
{
if (show_test_output) putchar(character);
cursor_x++;
}
else zx_spectrum_bad_character = Z_TRUE;
}
else if (--zx_spectrum_tab)
{
zuint c = character & (32 - 1), x = cursor_x & (32 - 1);
if (c < x) lf();
else cursor_x += (c -= x);
if (show_test_output) while (c--) putchar(' ');
}
return OPCODE_RET;
}
/* Only needed for Woody's Z80 Test Suite. */
static zuint8 zx_spectrum_cpu_fetch_opcode(void *context, zuint16 address)
{
Z_UNUSED(context)
return address == 0x1601 /* 1601: THE 'CHAN_OPEN' SUBROUTINE */
? OPCODE_RET : memory[address];
}
/* MARK: - Main Section */
static char const *compose_path(char const *base_path, char const *file_path)
{
zusize base_path_size;
if (base_path == Z_NULL) return file_path;
base_path_size = strlen(base_path);
memcpy(path_buffer, base_path, base_path_size);
path_buffer[base_path_size] = '/';
strcpy(path_buffer + base_path_size + 1, file_path);
return path_buffer;
}
static zboolean load_file(
char const* base_path,
char const* file_path,
zuint16 file_size,
zuint16 offset,
zuint16 size,
void* buffer
)
{
zboolean success = Z_FALSE;
FILE *file = fopen(compose_path(base_path, file_path), "rb");
if (file != Z_NULL)
{
if ( !fseek(file, 0, SEEK_END) &&
(zulong)ftell(file) == file_size &&
!fseek(file, offset, SEEK_SET) &&
fread(buffer, size, 1, file) == 1
)
success = Z_TRUE;
fclose(file);
}
return success;
}
static zboolean load_test(char const *search_path, Test const *test, void *buffer)
{
# ifdef TEST_Z80_WITH_ARCHIVE_EXTRACTION
zboolean success = load_file(
search_path, test->file_path, test->file_size,
test->code_offset, test->code_size, buffer);
if (!success && test->archive_name != Z_NULL)
{
search_path = compose_path(search_path, test->archive_name);
/* .tar.gz */
if (strrchr(test->archive_name, '.')[1] == 'g')
{
gzFile gz = gzopen(search_path, "rb");
if (gz != Z_NULL)
{
union {zuint8 data[Z_TAR_BLOCK_SIZE]; Z_TARPOSIXHeader header;} block;
while (!gzeof(gz))
{
char *end;
zulong file_size;
if (gzread(gz, block.data, Z_TAR_BLOCK_SIZE) != Z_TAR_BLOCK_SIZE) break;
block.header.size[Z_ARRAY_SIZE(block.header.size) - 1] = 0;
file_size = strtoul((char const *)block.header.size, &end, 8);
if ((zuint8 *)end == block.header.size || *end) break;
if (!strcmp(test->file_path, (char const *)block.header.name))
{
success =
file_size == test->file_size &&
gzseek(gz, (z_off_t)test->code_offset, SEEK_CUR) != -1 &&
(zuint)gzread(gz, buffer, test->code_size) == test->code_size;
break;
}
if (file_size % Z_TAR_BLOCK_SIZE)
file_size += Z_TAR_BLOCK_SIZE - (file_size % Z_TAR_BLOCK_SIZE);
for (; file_size > (zulong)(Z_SINT_MAXIMUM / 2);
file_size -= (zulong)(Z_SINT_MAXIMUM / 2)
)
if (gzseek(gz, (z_off_t)(Z_SINT_MAXIMUM / 2), SEEK_CUR) == -1)
goto close_gz;
if (gzseek(gz, (z_off_t)file_size, SEEK_CUR) == -1) break;
}
close_gz:
gzclose(gz);
}
}
/* .zip */
else {
int error;
zip_t *zip = zip_open(search_path, ZIP_RDONLY | ZIP_CHECKCONS, &error);
if (zip != Z_NULL)
{
zip_file_t *file;
zip_stat_t stat;
if ( !zip_stat(zip, test->file_path, ZIP_FL_ENC_STRICT, &stat) &&
(stat.valid & ZIP_STAT_SIZE) && stat.size == test->file_size &&
(file = zip_fopen(zip, test->file_path, 0)) != Z_NULL
)
{
if ( zip_fread(file, buffer, test->code_offset) == test->code_offset &&
zip_fread(file, buffer, test->code_size ) == test->code_size
)
success = Z_TRUE;
zip_fclose(file);
}
zip_close(zip);
}
}
}
return success;
# else
return load_file(
search_path, test->file_path, test->file_size,
test->code_offset, test->code_size, buffer);
# endif
}
static zuint8 run_test(int test_index)
{
char const *failure;
Test const *test = &tests[test_index];
zuint16 start_address = test->start_address;
zusize cycles;
zuint i;
# if Z_USIZE_WIDTH < 64
zuint32 j;
# endif
if (verbosity)
{
printf("[%02d] ", test_index);
if (verbosity >= 2)
{
if (test->archive_name == Z_NULL) printf("%s", test->file_path);
else printf("%s/%s", test->archive_name, test->file_path);
printf(verbosity == 2 ? "... " : "\n* Loading program... ");
}
}
memset(memory, 0, Z_USIZE(65536));
for ( i = search_path_count;
i && !load_test(search_paths[i - 1], test, &memory[start_address & Z_UINT16(0xFF00)]);
i--
);
if (!i && !load_test(Z_NULL, test, &memory[start_address & Z_UINT16(0xFF00)]))
{
failure = "program";
error_loading_file:
if (verbosity > 2) printf("error\n%s", test_spacing);
else if (verbosity) printf("error: cannot load %s\n%s", failure, test_spacing);
return Z_FALSE;
}
if (verbosity >= 3) puts("OK");
z80_power(&cpu, Z_TRUE);
if (test->format == TEST_FORMAT_CPM)
{
cpu.fetch_opcode = cpu_read;
cpu.write = cpm_cpu_write;
cpu.hook = cpm_cpu_hook;
memory[0] = OPCODE_HALT;
memory[5] = Z80_HOOK; /* PRINT */
}
else {
if (test->format == TEST_FORMAT_WOODMASS)
{
if (verbosity >= 3) printf("* Loading firmware... ");
for ( i = search_path_count;
i && !load_file(search_paths[i - 1], "ZX Spectrum.rom", 16384, 0, 16384, memory);
i--
);
if (!i && !load_file(Z_NULL, "ZX Spectrum.rom", 16384, 0, 16384, memory))
{
failure = "firmware";
goto error_loading_file;
}
if (verbosity >= 3) puts("OK");
cpu.fetch_opcode = zx_spectrum_cpu_fetch_opcode;
Z80_SP(cpu) = 0x7FE8;
Z80_AF(cpu) = 0x3222;
/* 0010: THE 'PRINT A CHARACTER' RESTART */
memory[0x0010] = OPCODE_JP_WORD; /* jp PRINT */
memory[0x0011] = 0xF2;
memory[0x0012] = 0x70;
/* 70F2: PRINT */
memory[zx_spectrum_print_hook_address = 0x70F2] = Z80_HOOK;
}
else {
cpu.fetch_opcode = cpu_read;
if (test->format == TEST_FORMAT_RAK) Z80_SP(cpu) -= 2;
/* 0010: THE 'PRINT A CHARACTER' RESTART */
memory[zx_spectrum_print_hook_address = 0x0010] = Z80_HOOK;
/* 1601: THE 'CHAN_OPEN' SUBROUTINE */
memory[0x1601] = OPCODE_RET;
}
cpu.write = zx_spectrum_cpu_write;
cpu.hook = zx_spectrum_cpu_hook;
cpu.i = 0x3F;
/* 0D6B: THE 'CLS' COMMAND ROUTINE */
memory[0x0D6B] = OPCODE_RET;
}
memory[test->exit_address] = OPCODE_HALT;
Z80_PC(cpu) = start_address;
hash = Z_FNV1_32_INITIALIZER;
lines =
columns =
cursor_x = 0;
zx_spectrum_tab = 0;
zx_spectrum_bad_character =
completed = Z_FALSE;
if (verbosity >= 3) printf("* Running program%s", show_test_output ? ":\n\n" : "... ");
# if Z_USIZE_WIDTH < 64
j = 0;
for (i = 0; i < test->cycles[1];)
{
cycles = RUN(&cpu, Z_UINT32_MAXIMUM / 2);
if (completed)
{
if ((j += (zuint32)cycles) < cycles) i++;
cycles = j;
goto check_results;
}
if ((j += (zuint32)cycles) < cycles) i++;
}
cycles = RUN(&cpu, test->cycles[0] + Z_UINT32(0x10000000) - j) + j;
check_results:
# else
cycles = RUN(&cpu, test->cycles[0] + Z_USIZE(0x10000000));
# endif
if (cursor_x > columns) columns = cursor_x;
/*--------------------------------------------------------------------.
| The test is considered passed if it has reached its exit address at |
| the correct clock cycle, has not printed any unsupported characters |
| and has printed the expected output within the correct margins. |
'====================================================================*/
if (!completed) failure = "clock cycle limit exceeded; program aborted";
else if (
zx_spectrum_bad_character ||
hash != test->hash ||
lines != test->lines ||
columns != test->columns
)
failure = "incorrect behavior detected";
else if (
# if Z_USIZE_WIDTH < 64
i != test->cycles[1] ||
# endif
cycles != test->cycles[0]
)
failure = "incorrect number of clock cycles";
else failure = Z_NULL;
if (verbosity)
{
if (show_test_output)
{
zuint has_final_new_line = test->format == TEST_FORMAT_RAK;
if (failure == Z_NULL) puts(&new_line[has_final_new_line]);
else printf(
"%s> Test failed: %s.\n\n",
&new_line[!lines || (completed && has_final_new_line)],
failure);
}
else {
if (failure == Z_NULL) printf("passed\n%s", test_spacing);
else printf("failed: %s\n%s", failure, test_spacing);
}
}
return failure == Z_NULL;
}
static zboolean string_is_option(char const* string, char const* short_option, char const* long_option)
{return !strcmp(string, short_option) || !strcmp(string, long_option);}
static zboolean string_to_uint8(char const* string, zuint8 maximum, zuint8 *value)
{
char *end;
zulong parsed = strtoul(string, &end, 0);
if (end == string || *end || parsed > maximum) return Z_FALSE;
*value = (zuint8)parsed;
return Z_TRUE;
}
int main(int argc, char **argv)
{
zboolean all = Z_FALSE;
zusize maximum_search_path_size = 0;
zuint32 tests_run;
int j, i = 0;
/*--------------------------------------------.
| String specifying what has been detected as |
| invalid when parsing the command line. |
'============================================*/
char const *invalid;
/*------------------------------.
| [0] = Number of tests failed. |
| [1] = Number of tests passed. |
'==============================*/
zuint results[2] = {0, 0};
/*--------------------------------------------.
| The emulator will behave as a Zilog NMOS if |
| the user does not specify a CPU model. |
'============================================*/
cpu.options = Z80_MODEL_ZILOG_NMOS;
while (++i < argc && *argv[i] == '-')
{
if (string_is_option(argv[i], "-V", "--version"))
{
puts( "test-Z80 v" Z80_LIBRARY_VERSION_STRING "\n"
"Copyright (C) 2021-2025 Manuel Sainz de Baranda y Goñi.\n"
"Released under the terms of the GNU General Public License v3.");
goto exit_without_error;
}
else if (string_is_option(argv[i], "-h", "--help"))
{
puts( "Usage:\n"
" test-Z80 [options] --all [<test>...]\n"
" test-Z80 [options] <test>...\n"
"\n"
"Options:\n"
" -V, --version Print version information and exit.\n"
" -0, --even-in (0..255) Set the byte read from even I/O ports [default: 191].\n"
" -1, --odd-in (0..255) Set the byte read from odd I/O ports [default: 255].\n"
" -a, --all Run all tests.\n"
" -h, --help Print this help message and exit.\n"
" -m, --model <model> Specify the CPU model to emulate.\n"
" -p, --path <path> Add a path where to look for the required files.\n"
" -v, --verbosity (0..4) Set the verbosity level [default: 4].\n"
"\n"
"CPU models:\n"
" zilog-nmos Zilog NMOS [default]\n"
" zilog-cmos Zilog CMOS\n"
" nec-nmos NEC NMOS\n"
" st-cmos SGS-Thomson CMOS\n"
"\n"
"Tests:\n"
" Versions of the Z80 Documented Instruction Set Exerciser:\n"
" 00 CP/M ~ Cringle, Frank D. (1998-01-28).\n"
" 01 ZX Spectrum ~ Harston, Jonathan Graham (2018).\n"
" Versions of the Z80 Full Instruction Set Exerciser:\n"
" 02 CP/M ~ Cringle, Frank D. (1998-01-28).\n"
" 03 ZX Spectrum ~ Bobrowski, Jan (2009).\n"
" 04 ZX Spectrum ~ Bobrowski, Jan (2011). Narrowed to `bit` instructions.\n"
" 05 ZX Spectrum ~ Harston, Jonathan Graham (2017).\n"
" 06 ZX Spectrum ~ Harston, Jonathan Graham (2018).\n"
" 07 ZX Spectrum ~ Rak, Patrik (2012-11-27).\n"
" Z80 Test Suite ~ ZX Spectrum ~ Woodmass, Mark (2008):\n"
" 08 Flags test.\n"
" 09 MEMPTR test.\n"
" Zilog Z80 CPU Test Suite v1.0 ~ ZX Spectrum ~ Rak, Patrik (2012-12-08):\n"
" 10 Tests all flags and registers.\n"
" 11 Tests all registers, but only officially documented flags.\n"
" 12 Tests all flags, ignores registers.\n"
" 13 Tests documented flags only, ignores registers.\n"
" 14 Tests all flags after executing `ccf` after each instruction.\n"
" 15 Tests all flags after executing `bit N,(hl)` after each instruction.\n"
" Zilog Z80 CPU Test Suite v1.2a ~ ZX Spectrum ~ Rak, Patrik (2023-12-02):\n"
" 16 Tests all flags and registers.\n"
" 17 Tests all registers, but only officially documented flags.\n"
" 18 Tests all flags, ignores registers.\n"
" 19 Tests documented flags only, ignores registers.\n"
" 20 Tests all flags after executing `ccf` after each instruction.\n"
" 21 Tests all flags after executing `bit N,(hl)` after each instruction.\n"
"\n"
"Email bug reports to <[email protected]>\n"
"Open issues at <https://github.com/redcode/Z80>");
goto exit_without_error;
}
else if (string_is_option(argv[i], "-0", "--even-in"))
{
if (++i == argc) goto incomplete_option;
if (!string_to_uint8(argv[i], 255, &in_values[0])) goto invalid_io_value;
}
else if (string_is_option(argv[i], "-1", "--odd-in"))
{
if (++i == argc) goto incomplete_option;
if (!string_to_uint8(argv[i], 255, &in_values[1])) goto invalid_io_value;
}
else if (string_is_option(argv[i], "-a", "--all"))
all = Z_TRUE;
else if (string_is_option(argv[i], "-m", "--model"))
{
if (++i == argc) goto incomplete_option;
for (j = 0; j < (int)Z_ARRAY_SIZE(cpu_models); j++)
if (!strcmp(argv[i], cpu_models[j].key))
{
cpu.options = cpu_models[j].options;
goto cpu_model_found;
}
invalid = "CPU model";
goto invalid_argument;
cpu_model_found: continue;
}
else if (string_is_option(argv[i], "-p", "--path"))
{
char **p;
zusize s;
if (++i == argc) goto incomplete_option;
if (!(s = strlen(argv[i])))
{
invalid = "path";
goto invalid_argument;
}
if (s > maximum_search_path_size) maximum_search_path_size = s;
if ((p = realloc(search_paths, (search_path_count + 1) * sizeof(char *))) == Z_NULL)
goto cannot_allocate_memory;
search_paths = p;
search_paths[search_path_count++] = argv[i];
}
else if (string_is_option(argv[i], "-v", "--verbosity"))
{
if (++i == argc) goto incomplete_option;
if (!string_to_uint8(argv[i], 4, &verbosity))
{
invalid = "verbosity level";
goto invalid_argument;
}
}
else {
invalid = "option";
goto invalid_argument;
}
}
/*------------------------------------------------.
| The user must specify at least one test number, |
| or the `-a` option otherwise. |
'================================================*/
if (i == argc && !all)
{
fputs("test-Z80: No test specified.\n", stderr);
goto bad_syntax;
}
/*-------------------------------------------------------------.
| Check that all test numbers specified by the user are valid. |
'=============================================================*/
for (j = i; i < argc; i++)
{
char const *string = argv[i];
char *end;
if (strtoul(string, &end, 10) >= Z_ARRAY_SIZE(tests) || end == string || *end)
{
invalid = "test number";
goto invalid_argument;
}
}
if ( search_path_count &&
(path_buffer = malloc(maximum_search_path_size + 110)) == Z_NULL
)
{
cannot_allocate_memory:
fputs("test-Z80: Cannot allocate memory.\n", stderr);
goto exit_with_error;
}
/*--------------------------------------------------------------.
| Disable buffering on stdout if the verbosity level is greater |
| than 0 so that progress messages are visible immediately. |
'==============================================================*/
if (verbosity) setvbuf(stdout, Z_NULL, _IONBF, 0);
/*------------------------------------------------------------------.
| The output of the test programs will only be printed at verbosity |
| level 4. For levels 3 and 4, we also have to print an extra line |
| feed between tests to make everything look pretty. |
'==================================================================*/
show_test_output = verbosity == 4;
test_spacing = &new_line[verbosity < 3];
/*------------------------------------------------------------------.
| Initialize the Z80 CPU emulator members: |
| * `context` is not necessary, as we are using global variables. |
| * `fetch_opcode`, `write`, and `hook` are set by `run_test()`. |
| * `fetch` and `read` use the same function because it is not |
| necessary to distinguish between different cases of memory read |
| M-cycles, as the test programs require neither precise timing |
| nor memory contention. |
| * `nmia`, `inta`, and `int_fetch` will never be called because |
| the test programs do not require interrupts. |
| * There is no need to use `nop`, `ld_i_a`, `ld_r_a`, `reti`, |
| `retn`, or `illegal` either. |
'==================================================================*/
cpu.context = Z_NULL;
cpu.fetch =
cpu.read = cpu_read;
cpu.in = cpu_in;
cpu.out = cpu_out;
cpu.halt = cpu_halt;
cpu.nop =
cpu.nmia =
cpu.inta =
cpu.int_fetch = Z_NULL;
cpu.ld_i_a =
cpu.ld_r_a =
cpu.reti =
cpu.retn = Z_NULL;
cpu.illegal = Z_NULL;
/*------------------------------------------------------------.
| Run the tests whose numbers have been explicitly specified. |
'============================================================*/
for (tests_run = 0; j < argc;)
{
tests_run |= Z_UINT32(1) << (i = atoi(argv[j++]));
results[run_test(i)]++;
}
/*-----------------------------------------------.
| If the `-a` option has been specified, run all |
| tests except those that have already been run. |
'===============================================*/
if (all) for (i = 0; i < (int)Z_ARRAY_SIZE(tests); i++)
if (!(tests_run & (Z_UINT32(1) << i))) results[run_test(i)]++;
/*---------------------------------------------------.
| Finaly, print results, deallocate memory and exit. |
'===================================================*/
printf( "%sResults%s: %u test%s passed, %u failed.\n",
&new_line[!verbosity || *test_spacing],
show_test_output ? " summary" : "",
results[1],
results[1] == 1 ? "" : "s",
results[0]);
exit_without_error:
free(search_paths);
free(path_buffer);
return results[0] ? -1 : 0;
incomplete_option:
fprintf(stderr, "test-Z80: Incomplete option: %s\n", argv[i - 1]);
goto bad_syntax;
invalid_io_value:
invalid = "I/O value";
invalid_argument: