gateconvert 0.1.2

The library to convert Gate circuit from/to foreign logic format.
Documentation
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
use gateconvert::blif;
use gateconvert::AssignEntry;
use gateutil::gatesim::*;

use std::fs;

fn to_blif_helper(circuit: Circuit<usize>, state_len: usize, clock_num: usize) -> String {
    let mut out = vec![];
    blif::to_blif(&circuit, state_len, clock_num, "top", &mut out).unwrap();
    String::from_utf8(out).unwrap()
}

#[test]
fn test_to_blif() {
    assert_eq!(
        ".model top\n.end\n",
        to_blif_helper(Circuit::new(0, [], []).unwrap(), 0, 0).as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.outputs o5
.outputs o6
.outputs o7
.names i0 i1 o0
11 1
.names i0 i1 o1
00 1
.names i0 i1 o2
10 1
.names i0 i1 o3
10 1
01 1
.names o0 o4
0 1
.names o1 o5
0 1
.names o2 o6
0 1
.names o3 o7
0 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                2,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(0, 1),
                    Gate::new_nimpl(0, 1),
                    Gate::new_xor(0, 1),
                ],
                [
                    (2, false),
                    (3, false),
                    (4, false),
                    (5, false),
                    (2, true),
                    (3, true),
                    (4, true),
                    (5, true),
                ]
            )
            .unwrap(),
            0,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.outputs o5
.outputs o6
.outputs o7
.names i0 i1 o4
11 1
.names i0 i1 o5
00 1
.names i0 i1 o6
10 1
.names i0 i1 o7
10 1
01 1
.names o4 o0
0 1
.names o5 o1
0 1
.names o6 o2
0 1
.names o7 o3
0 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                2,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(0, 1),
                    Gate::new_nimpl(0, 1),
                    Gate::new_xor(0, 1),
                ],
                [
                    (2, true),
                    (3, true),
                    (4, true),
                    (5, true),
                    (2, false),
                    (3, false),
                    (4, false),
                    (5, false),
                ]
            )
            .unwrap(),
            0,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.outputs o5
.outputs o6
.outputs o7
.outputs o8
.outputs o9
.outputs o10
.outputs o11
.outputs o12
.outputs o13
.outputs o14
.outputs o15
.names i0 i1 o0
11 1
.names i0 i1 o1
00 1
.names i0 i1 o2
10 1
.names i0 i1 o3
10 1
01 1
.names o0 o4
0 1
.names o1 o5
0 1
.names o2 o6
0 1
.names o3 o7
0 1
.names o0 o8
1 1
.names o1 o9
1 1
.names o2 o10
1 1
.names o3 o11
1 1
.names o4 o12
1 1
.names o5 o13
1 1
.names o6 o14
1 1
.names o7 o15
1 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                2,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(0, 1),
                    Gate::new_nimpl(0, 1),
                    Gate::new_xor(0, 1),
                ],
                [
                    (2, false),
                    (3, false),
                    (4, false),
                    (5, false),
                    (2, true),
                    (3, true),
                    (4, true),
                    (5, true),
                    (2, false),
                    (3, false),
                    (4, false),
                    (5, false),
                    (2, true),
                    (3, true),
                    (4, true),
                    (5, true),
                ]
            )
            .unwrap(),
            0,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.inputs i2
.inputs i3
.inputs i4
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.latch o0 i0
.latch o1 i1
.latch o2 i2
.names i0 i1 i5
11 1
.names i2 i3 o1
00 1
.names i0 i2 o2
10 1
.names i1 i4 i8
10 1
01 1
.names i5 o0
0 1
.names i8 o3
0 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                5,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(2, 3),
                    Gate::new_nimpl(0, 2),
                    Gate::new_xor(1, 4),
                ],
                [(5, true), (6, false), (7, false), (8, true)]
            )
            .unwrap(),
            3,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.inputs i2
.inputs i3
.inputs i4
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.outputs o5
.outputs o6
.latch o0 i0
.latch o1 i1
.latch o2 i2
.names i0 i1 o1
11 1
.names i2 i3 o3
00 1
.names i0 i2 o4
10 1
.names i1 i4 i8
10 1
01 1
.names o1 o0
0 1
.names i8 o5
0 1
.names o0 o2
1 1
.names o3 o6
1 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                5,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(2, 3),
                    Gate::new_nimpl(0, 2),
                    Gate::new_xor(1, 4),
                ],
                [
                    (5, true),
                    (5, false),
                    (5, true),
                    (6, false),
                    (7, false),
                    (8, true),
                    (6, false)
                ]
            )
            .unwrap(),
            3,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.inputs i2
.inputs i3
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.names i0 i2 o0
11 1
.names i1 i2 i5
11 1
.names i0 i3 i6
11 1
.names i1 i3 i7
11 1
.names i5 i6 o1
10 1
01 1
.names i5 i6 i9
11 1
.names i7 i9 o2
10 1
01 1
.names i7 i9 o3
11 1
.names o1 o2 i12
10 1
01 1
.names i12 o4
0 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                4,
                [
                    Gate::new_and(0, 2),
                    Gate::new_and(1, 2),
                    Gate::new_and(0, 3),
                    Gate::new_and(1, 3),
                    // add a1*b0 + a0*b1
                    Gate::new_xor(5, 6),
                    Gate::new_and(5, 6),
                    // add c(a1*b0 + a0*b1) + a1*b1
                    Gate::new_xor(7, 9),
                    Gate::new_and(7, 9),
                    Gate::new_xor(8, 10),
                ],
                [(4, false), (8, false), (10, false), (11, false), (12, true)],
            )
            .unwrap(),
            0,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.inputs i2
.inputs i3
.inputs i4
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.outputs o4
.outputs o5
.outputs o6
.outputs o7
.outputs o8
.outputs o9
.outputs o10
.outputs o11
.outputs o12
.outputs o13
.outputs o14
.outputs o15
.outputs o16
.outputs o17
.outputs o18
.outputs o19
.names o0 i1 o4
11 1
.names o2 o4 o10
00 1
.names i3 o10 o6
10 1
.names i4 o6 o8
10 1
01 1
.names o0 o3
0 1
.names o2 o1
0 1
.names o4 o11
0 1
.names o10 o5
0 1
.names o6 o9
0 1
.names o8 o7
0 1
.names o7 o12
1 1
.names o6 o13
1 1
.names o5 o14
1 1
.names o4 o15
1 1
.names o11 o16
1 1
.names o10 o17
1 1
.names o9 o18
1 1
.names o8 o19
1 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                5,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(2, 5),
                    Gate::new_nimpl(3, 6),
                    Gate::new_xor(4, 7),
                ],
                [
                    (0, false), // 0
                    (2, true),  // 1
                    (2, false), // 2
                    (0, true),  // 3
                    (5, false), // 4
                    (6, true),  // 5
                    (7, false), // 6
                    (8, true),  // 7
                    (8, false), // 8
                    (7, true),  // 9
                    (6, false), // 10
                    (5, true),  // 11
                    (8, true),  // 12
                    (7, false), // 13
                    (6, true),  // 14
                    (5, false), // 15
                    (5, true),  // 16
                    (6, false), // 17
                    (7, true),  // 18
                    (8, false), // 19
                ]
            )
            .unwrap(),
            0,
            0
        )
        .as_str()
    );
    assert_eq!(
        r##".model top
.inputs i0
.inputs i1
.inputs i2
.inputs i5
.inputs i6
.outputs o0
.outputs o1
.outputs o2
.outputs o3
.clock i3
.clock i4
.latch o0 i0
.latch o1 i1
.latch o2 i2
.names i0 i1 i7
11 1
.names i2 i3 o1
00 1
.names i3 i4 o2
10 1
.names i5 i6 i10
10 1
01 1
.names i7 o0
0 1
.names i10 o3
0 1
.end
"##,
        to_blif_helper(
            Circuit::new(
                7,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(2, 3),
                    Gate::new_nimpl(3, 4),
                    Gate::new_xor(5, 6),
                ],
                [(7, true), (8, false), (9, false), (10, true)]
            )
            .unwrap(),
            3,
            2
        )
        .as_str()
    );
}

fn strs2_to_vec_string<'a>(
    iter: impl IntoIterator<Item = (&'a str, &'a str)>,
) -> Vec<(String, String)> {
    iter.into_iter()
        .map(|(s1, s2)| (s1.to_string(), s2.to_string()))
        .collect()
}

struct FilesToRemove(Vec<String>);

impl Drop for FilesToRemove {
    fn drop(&mut self) {
        for s in &self.0 {
            let _ = fs::remove_file(s);
        }
    }
}

fn write_files(files: impl IntoIterator<Item = (String, String)>) -> FilesToRemove {
    let mut files_to_remove = FilesToRemove(vec![]);
    for (path, content) in files {
        fs::write(&path, content.as_bytes()).unwrap();
        files_to_remove.0.push(path.clone());
    }
    files_to_remove
}

fn from_blif_helper(
    files: impl IntoIterator<Item = (String, String)>,
) -> (Circuit<usize>, Vec<(String, AssignEntry)>) {
    let to_remove = write_files(files);
    blif::from_blif(&to_remove.0[0]).unwrap()
}

#[test]
fn test_from_blif() {
    assert_eq!(
        (
            Circuit::<usize>::new(
                2,
                [
                    Gate::new_and(0, 1),
                    Gate::new_nor(0, 1),
                    Gate::new_xor(0, 1),
                ],
                [(2, false), (3, true), (4, false)]
            )
            .unwrap(),
            vec![
                ("a".to_string(), AssignEntry::Var(0, false)),
                ("b".to_string(), AssignEntry::Var(1, false)),
                ("x".to_string(), AssignEntry::Var(2, false)),
                ("y".to_string(), AssignEntry::Var(3, true)),
                ("z".to_string(), AssignEntry::Var(4, false)),
            ]
        ),
        from_blif_helper(strs2_to_vec_string([
            (
                "xxxmain2.blif",
                r##".search xxxtop2.blif
.search xxxgates2.blif
"##
            ),
            (
                "xxxtop2.blif",
                r##".model simple
.inputs a b
.outputs x y z
.subckt and a0=a a1=b x=x
.subckt or a0=a a1=b x=y
.subckt xor a0=a a1=b x=z
.end
"##
            ),
            (
                "xxxgates2.blif",
                r##".search xxxand2.blif
.search xxxor2.blif
"##
            ),
            (
                "xxxand2.blif",
                r##".model and
.input a0 a1
.outputs x
.names a0 a1 x
11 1
.end
"##
            ),
            (
                "xxxor2.blif",
                r##".model or
.input a0 a1
.outputs x
.names a0 a1 x
1- 1
-1 1
.end
.search xxxxor2.blif
"##
            ),
            (
                "xxxxor2.blif",
                r##".model xor
.input a0 a1
.outputs x
.names a0 a1 x
10 1
01 1
.end
"##
            ),
        ]))
    );
}