libreda-db 0.0.4

Layout and netlist datastructures for chip design.
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


use libreda_db::netlist::prelude::*;
use itertools::Itertools;


// Test circuit equality.
#[test]
fn test_circuit_eq() {
    let mut netlist = RcNetlist::new();
    let a = netlist.create_circuit("a", vec![]);
    let b = netlist.create_circuit("b", vec![]);
    assert_eq!(a.clone(), a.clone());
    assert_eq!(&a, &a);
    assert_ne!(a.clone(), b.clone());
    assert_ne!(&a, &b);
}

// Check if creating recursive circuits leads to an error.
#[test]
#[should_panic(expected = "Cannot create recursive instances.")]
fn test_circuit_no_recursion_1() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![]);
    // This should fail:
    let _top_inst = top.create_circuit_instance(&top, Some("top_inst"));
}

#[test]
#[should_panic(expected = "Cannot create recursive instances.")]
fn test_circuit_no_recursion_2() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![]);
    let sub = netlist.create_circuit("sub", vec![]);
    let _sub_inst = top.create_circuit_instance(&sub, Some("sub_inst"));
    // This should fail:
    let _top_inst = sub.create_circuit_instance(&top, Some("recursive_inst"));
}

#[test]
fn test_create_and_remove_instance() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![]);
    let sub = netlist.create_circuit("sub", vec![]);
    assert_ne!(top.id(), sub.id());

    let sub_inst = top.create_circuit_instance(&sub, Some("sub_inst"));

    assert_eq!(sub_inst.name(), Some(&"sub_inst".to_string()));

    assert_eq!(top.each_instance().collect_vec(), vec![sub_inst.clone()]);

    assert_eq!(top.num_instances(), 1);
    assert_eq!(top.num_references(), 0);
    assert_eq!(sub.num_references(), 1);

    assert_eq!(sub_inst.parent_circuit().upgrade(), Some(top.clone()));

    // Remove the instance.
    top.remove_circuit_instance(&sub_inst);
    assert_eq!(top.each_instance().collect_vec(), vec![]);

    assert_eq!(top.num_instances(), 0);
    assert_eq!(top.num_references(), 0);
    assert_eq!(sub.num_references(), 0);
}

#[test]
fn test_dependent_circuits() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![]);
    let sub = netlist.create_circuit("sub", vec![]);
    let sub_inst = top.create_circuit_instance(&sub, Some("sub_inst"));

    assert_eq!(sub.each_dependent_circuit().collect_vec(), vec![top.clone()]);
    assert_eq!(top.each_dependent_circuit().collect_vec(), vec![]);

    assert_eq!(top.each_circuit_dependency().collect_vec(), vec![sub.clone()]);
    assert_eq!(sub.each_circuit_dependency().collect_vec(), vec![]);

    // Remove the instance and see if dependencies are updated correctly.
    top.remove_circuit_instance(&sub_inst);
    assert_eq!(sub.each_dependent_circuit().collect_vec(), vec![]);
    assert_eq!(top.each_circuit_dependency().collect_vec(), vec![]);
}

#[test]
fn test_simple_net() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![Pin::new_input("A")]);
    let a = netlist.create_circuit("a", vec![Pin::new_input("A")]);
    let b = netlist.create_circuit("b", vec![Pin::new_input("A")]);
    let a_inst = top.create_circuit_instance(&a, Some("a_inst"));
    let b_inst = top.create_circuit_instance(&b, Some("b_inst"));

    let net1 = top.create_net(Some("Net1"));
    assert_eq!(net1.parent_circuit().upgrade(), Some(top.clone()));

    assert_eq!(Some(net1.clone()), top.net_by_name("Net1"));

    top.connect_pin_by_id(0, Some(net1.clone()));
    a_inst.connect_pin_by_id(0, Some(net1.clone()));
    b_inst.connect_pin_by_id(0, Some(net1.clone()));

    assert_eq!(net1.num_terminals(), 3);
    assert_eq!(net1.each_terminal().count(), 3);

    assert_eq!(net1.each_terminal()
                   .filter_map(|t| match t {
                       TerminalRef::Pin(p) => Some(p),
                       _ => None
                   })
                   .count(), 1, "Number of connections to `Pin`s is wrong.");

    assert_eq!(net1.each_terminal()
                   .filter_map(|t| match t {
                       TerminalRef::PinInstance(p) => Some(p),
                       _ => None
                   })
                   .count(), 2, "Number of connections to `PinInstance`s is wrong.");

    assert_eq!(net1.each_instance().unique().count(), 2);
}


#[test]
fn test_rename_net() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![Pin::new_input("A")]);

    let net1 = top.create_net(Some("Net1"));
    assert_eq!(Some(net1.clone()), top.net_by_name("Net1"));

    // Change name.
    net1.rename(Some("NewName"));
    assert_eq!(Some(net1.clone()), top.net_by_name("NewName"));

    // Change back to original.
    net1.rename(Some("Net1"));
    assert_eq!(Some(net1.clone()), top.net_by_name("Net1"));

    // No name.
    net1.rename::<String>(None);
    assert_eq!(None, top.net_by_name("Net1"));

}

#[test]
fn test_flatten_circuit_instance() {
    let mut netlist = RcNetlist::new();
    let top = netlist.create_circuit("top", vec![Pin::new_input("A")]);
    let a = netlist.create_circuit("a", vec![Pin::new_input("A")]);
    let b = netlist.create_circuit("b", vec![Pin::new_input("A")]);
    let a_inst = top.create_circuit_instance(&a, Some("a_inst"));
    let b_inst = a.create_circuit_instance(&b, Some("b_inst"));

    let net1 = top.create_net(Some("Net1"));
    top.connect_pin_by_id(0, Some(net1.clone()));
    a_inst.connect_pin_by_id(0, Some(net1.clone()));

    let net2 = a.create_net(Some("Net2"));
    a.connect_pin_by_id(0, Some(net2.clone()));
    b_inst.connect_pin_by_id(0, Some(net2));

    // Flatten the middle circuit.
    top.flatten_circuit_instance(&a_inst);
    assert_eq!(top.num_instances(), 1);
    assert!(top.circuit_instance_by_name("a_inst").is_none());
    assert!(top.circuit_instance_by_name("a_inst:b_inst").is_some());

    assert_eq!(net1.num_terminals(), 2);
}