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
|
Each architecture must implement the following types and APIs.
Architectures can either inherit from `ArchAPI<ArchRanges>`, which is a pure virtual description of the architecture API; or `BaseArch<ArchRanges>` which provides some default implementations described below.
`ArchRanges` is a `struct` of `using`s that allows arches to return custom range types. These ranges can be anything that has a `begin()` and `end()` method that return const forward iterators. This can be a `std::list<T>`, `std::vector<T>`, a (const) reference to those, or anything else that behaves in a similar way.
The contents of `ArchRanges` is as follows:
| Type | Range of |
|---------------------------|----------------------------------|
|`ArchArgsT` | N/A (struct of device params) |
|`AllBelsRangeT` | `BelId` |
|`TileBelsRangeT` | `BelId` |
|`BelAttrsRangeT` | std::pair<IdString, std::string> |
|`BelPinsRangeT` | `IdString` |
|`CellBelPinRangeT` | `IdString` |
|`AllWiresRangeT` | `WireId` |
|`DownhillPipRangeT` | `PipId` |
|`UphillPipRangeT` | `PipId` |
|`WireBelPinRangeT` | `BelPin` |
|`AllPipsRangeT` | `PipId` |
|`PipAttrsRangeT` | std::pair<IdString, std::string> |
|`AllGroupsRangeT` | `GroupId` |
|`GroupBelsRangeT` | `BelId` |
|`GroupWiresRangeT` | `WireId` |
|`GroupPipsRangeT` | `PipId` |
|`GroupGroupsRangeT` | `GroupId` |
|`DecalGfxRangeT` | `GraphicElement` |
|`CellTypeRangeT` | `IdString` |
|`BelBucketRangeT` | `BelBucketRange` |
|`BucketBelRangeT` | `BelId` |
The functions that return a particular type are described below. Where a default function implementation is provided, `BaseArchRanges` (which `ArchRanges` can inherit from) will set the range type appropriately.
archdefs.h
==========
The architecture-specific `archdefs.h` must define the following types.
With the exception of `ArchNetInfo` and `ArchCellInfo`, the following types should be "lightweight" enough so that passing them by value is sensible.
### delay\_t
A scalar type that is used to represent delays. May be an integer or float type.
### BelId
A type representing a bel name. `BelId()` must construct a unique null-value. Must provide `==`, `!=`, and `<` operators and a `unsigned int hash() const` member function.
### WireId
A type representing a wire name. `WireId()` must construct a unique null-value. Must provide `==`, `!=`, and `<` operators and a `unsigned int hash() const` member function.
### PipId
A type representing a pip name. `PipId()` must construct a unique null-value. Must provide `==`, `!=`, and `<` operators and a `unsigned int hash() const` member function.
### BelBucketId
A type representing a bel bucket. `BelBucketId()` must construct a unique null-value. Must provide `==`, `!=`, and `<` operators and a `unsigned int hash() const` member function.
### GroupId
A type representing a group name. `GroupId()` must construct a unique null-value. Must provide `==` and `!=` operators and a `unsigned int hash() const` member function.
### DecalId
A type representing a reference to a graphical decal. `DecalId()` must construct a unique null-value. Must provide `==` and `!=` operators and a `unsigned int hash() const` member function.
### ClusterId
A type representing a reference to a constrained cluster of cells. `ClusterId()` must construct a unique null-value. Must provide `==` and `!=` operators and `unsigned int hash() const` member function.
### ArchNetInfo
The global `NetInfo` type derives from this one. Can be used to add arch-specific data (caches of information derived from wire attributes, bound wires and pips, and other net state). Must be declared as empty struct if unused.
### ArchCellInfo
The global `CellInfo` type derives from this one. Can be used to add arch-specific data (caches of information derived from cell attributes and parameters, bound bel, and other cell state). Must be declared as empty struct if unused.
arch.h
======
Each architecture must provide their own implementation of the `Arch` struct in `arch.h`. `Arch` must derive from `ArchAPI<ArchRanges>` or `BaseArch<ArchRanges>` (see above) and must provide the following methods:
General Methods
---------------
### Arch(ArchArgs args)
Constructor. ArchArgs is a architecture-specific type (usually a struct also defined in `arch.h`).
### std::string getChipName() const
Return a user-friendly string representation of the ArchArgs that was used to construct this object.
### ArchArgs archArgs() const
Return the `ArchArgs` used to construct this object.
### IdString archArgsToId(ArchArgs args) const
Return an internal IdString representation of the ArchArgs that was used to construct this object.
*BaseArch default: returns empty IdString*
### int getGridDimX() const
Get grid X dimension. All bels and pips must have Y coordinates in the range `0 .. getGridDimX()-1` (inclusive).
### int getGridDimY() const
Get grid Y dimension. All bels and pips must have Y coordinates in the range `0 .. getGridDimY()-1` (inclusive).
### int getTileBelDimZ(int x, int y) const
Get Z dimension for the specified tile for bels. All bels with at specified X and Y coordinates must have a Z coordinate in the range `0 .. getTileDimZ(X,Y)-1` (inclusive).
### int getTilePipDimZ(int x, int y) const
Get Z dimension for the specified tile for pips. All pips with at specified X and Y coordinates must have a Z coordinate in the range `0 .. getTileDimZ(X,Y)-1` (inclusive).
*BaseArch default: returns 1*
### char getNameDelimiter() const
Returns a delimiter that can be used to build up bel, wire and pip names out of hierarchical components (such as tiles and sites) to avoid the high memory usage of storing full names for every object.
*BaseArch default: returns ' '*
Cell Methods
-----------
### CellTypeRangeT getCellTypes() const
Get list of cell types that this architecture accepts.
*BaseArch default: returns list derived from bel types set up by `init_cell_types()`*
Bel Methods
-----------
### BelId getBelByName(IdStringList name) const
Lookup a bel by its name, which is a list of IdStrings joined by `getNameDelimiter()`.
### IdStringList getBelName(BelId bel) const
Get the name for a bel. (Bel names must be unique.)
### Loc getBelLocation(BelId bel) const
Get the X/Y/Z location of a given bel. Each bel must have a unique X/Y/Z location.
### BelId getBelByLocation(Loc loc) const
Lookup a bel by its X/Y/Z location.
### TileBelsRangeT getBelsByTile(int x, int y) const
Return a list of all bels at the give X/Y location.
### bool getBelGlobalBuf(BelId bel) const
Returns true if the given bel is a global buffer. A global buffer does not "pull in" other cells it drives to be close to the location of the global buffer.
*BaseArch default: returns false*
### uint32\_t getBelChecksum(BelId bel) const
Return a (preferably unique) number that represents this bel. This is used in design state checksum calculations.
*BaseArch default: returns `std::hash` of `BelId` cast to `uint32_t`*
### void bindBel(BelId bel, CellInfo \*cell, PlaceStrength strength)
|
