1 package mograsim.logic.core.wires;
\r
3 import static mograsim.logic.core.types.Bit.U;
\r
4 import static mograsim.logic.core.types.Bit.Z;
\r
6 import java.util.ArrayList;
\r
7 import java.util.List;
\r
9 import mograsim.logic.core.timeline.Timeline;
\r
10 import mograsim.logic.core.types.Bit;
\r
11 import mograsim.logic.core.types.BitVector;
\r
12 import mograsim.logic.core.types.BitVector.BitVectorMutator;
\r
15 * Represents an array of wires that can store n bits of information.
\r
17 * @author Fabian Stemmler
\r
22 private BitVector values;
\r
23 public final int travelTime;
\r
24 private List<ReadEnd> attached = new ArrayList<ReadEnd>();
\r
25 public final int length;
\r
26 private List<ReadWriteEnd> inputs = new ArrayList<ReadWriteEnd>();
\r
27 private Timeline timeline;
\r
29 public Wire(Timeline timeline, int length, int travelTime)
\r
32 throw new IllegalArgumentException(
\r
33 String.format("Tried to create an array of wires with length %d, but a length of less than 1 makes no sense.", length));
\r
34 this.timeline = timeline;
\r
35 this.length = length;
\r
36 this.travelTime = travelTime;
\r
40 private void initValues()
\r
42 values = U.toVector(length);
\r
45 private void recalculateSingleInput()
\r
47 setNewValues(inputs.get(0).getInputValues());
\r
50 private void recalculateMultipleInputs()
\r
52 BitVectorMutator mutator = BitVectorMutator.empty();
\r
53 for (ReadWriteEnd wireArrayEnd : inputs)
\r
54 mutator.join(wireArrayEnd.getInputValues());
\r
55 setNewValues(mutator.get());
\r
58 private void setNewValues(BitVector newValues)
\r
60 if (values.equals(newValues))
\r
62 BitVector oldValues = values;
\r
64 notifyObservers(oldValues);
\r
67 private void recalculate()
\r
69 switch (inputs.size())
\r
74 recalculateSingleInput();
\r
77 recalculateMultipleInputs();
\r
82 * The {@link Wire} is interpreted as an unsigned integer with n bits.
\r
84 * @return <code>true</code> if all bits are either <code>Bit.ONE</code> or <code>Bit.ZERO</code> (they do not all have to have the same
\r
85 * value), not <code>Bit.X</code> or <code>Bit.Z</code>. <code>false</code> is returned otherwise.
\r
87 * @author Fabian Stemmler
\r
89 public boolean hasNumericValue()
\r
91 for (Bit b : values)
\r
93 if (b != Bit.ZERO && b != Bit.ONE)
\r
100 * The {@link Wire} is interpreted as an unsigned integer with n bits.
\r
102 * @return The unsigned value of the {@link Wire}'s bits, where value 0 corresponds with 2^0, value 1 is 2^1 and so on.
\r
104 * @author Fabian Stemmler
\r
106 public long getUnsignedValue()
\r
110 for (Bit bit : values)
\r
117 return 0; // TODO: Proper handling for getUnsignedValue(), if not all bits are 1 or 0;
\r
129 * The {@link Wire} is interpreted as a signed integer with n bits.
\r
131 * @return The signed value of the {@link Wire}'s bits, where value 0 corresponds with 2^0, value 1 is 2^1 and so on.
\r
133 * @author Fabian Stemmler
\r
135 public long getSignedValue()
\r
137 long val = getUnsignedValue();
\r
138 long mask = 1 << (length - 1);
\r
139 if ((mask & val) != 0)
\r
141 int shifts = 64 - length;
\r
142 return (val << shifts) >> shifts;
\r
147 public Bit getValue()
\r
149 return getValue(0);
\r
152 public Bit getValue(int index)
\r
154 return values.getBit(index);
\r
157 public BitVector getValues(int start, int end)
\r
159 return values.subVector(start, end);
\r
162 public BitVector getValues()
\r
168 * Adds an {@link WireObserver}, who will be notified when the value of the {@link Wire} is updated.
\r
170 * @param ob The {@link WireObserver} to be notified of changes.
\r
171 * @return true if the given {@link WireObserver} was not already registered, false otherwise
\r
173 * @author Fabian Stemmler
\r
175 private void attachEnd(ReadEnd end)
\r
180 private void detachEnd(ReadEnd end)
\r
182 attached.remove(end);
\r
185 private void notifyObservers(BitVector oldValues)
\r
187 for (ReadEnd o : attached)
\r
188 o.update(oldValues);
\r
192 * Create and register a {@link ReadWriteEnd} object, which is tied to this {@link Wire}. This {@link ReadWriteEnd} can be written to.
\r
194 public ReadWriteEnd createReadWriteEnd()
\r
196 return new ReadWriteEnd();
\r
200 * Create a {@link ReadEnd} object, which is tied to this {@link Wire}. This {@link ReadEnd} cannot be written to.
\r
202 public ReadEnd createReadOnlyEnd()
\r
204 return new ReadEnd();
\r
207 private void registerInput(ReadWriteEnd toRegister)
\r
209 inputs.add(toRegister);
\r
213 * A {@link ReadEnd} feeds a constant signal into the {@link Wire} it is tied to. The combination of all inputs determines the
\r
214 * {@link Wire}s final value. X dominates all other inputs Z does not affect the final value, unless there are no other inputs than Z 0
\r
215 * and 1 turn into X when they are mixed
\r
217 * @author Fabian Stemmler
\r
219 public class ReadEnd
\r
221 private List<WireObserver> observers = new ArrayList<WireObserver>();
\r
226 Wire.this.attachEnd(this);
\r
229 public void update(BitVector oldValues)
\r
231 for (WireObserver ob : observers)
\r
232 ob.update(this, oldValues);
\r
236 * Included for convenient use on {@link Wire}s of length 1.
\r
238 * @return The value of bit 0.
\r
240 * @author Fabian Stemmler
\r
242 public Bit getValue()
\r
244 return Wire.this.getValue();
\r
248 * @param index Index of the requested bit.
\r
249 * @return The value of the indexed bit.
\r
251 * @author Fabian Stemmler
\r
253 public Bit getValue(int index)
\r
255 return Wire.this.getValue(index);
\r
259 * @param index Index of the requested bit.
\r
260 * @return The value of the indexed bit.
\r
262 * @author Fabian Stemmler
\r
264 public BitVector getValues()
\r
266 return Wire.this.getValues();
\r
270 * @param start Start of the wanted segment. (inclusive)
\r
271 * @param end End of the wanted segment. (exclusive)
\r
272 * @return The values of the segment of {@link Bit}s indexed.
\r
274 * @author Fabian Stemmler
\r
276 public BitVector getValues(int start, int end)
\r
278 return Wire.this.getValues(start, end);
\r
282 * The {@link Wire} is interpreted as an unsigned integer with n bits.
\r
284 * @return <code>true</code> if all bits are either <code>Bit.ONE</code> or <code>Bit.ZERO</code> (they do not all have to have the
\r
285 * same value), not <code>Bit.X</code> or <code>Bit.Z</code>. <code>false</code> is returned otherwise.
\r
287 * @author Fabian Stemmler
\r
289 public boolean hasNumericValue()
\r
291 return Wire.this.hasNumericValue();
\r
295 * The {@link Wire} is interpreted as an unsigned integer with n bits.
\r
297 * @return The unsigned value of the {@link Wire}'s bits, where value 0 corresponds with 2^0, value 1 is 2^1 and so on.
\r
299 * @author Fabian Stemmler
\r
301 public long getUnsignedValue()
\r
303 return Wire.this.getUnsignedValue();
\r
307 * The {@link Wire} is interpreted as a signed integer with n bits.
\r
309 * @return The signed value of the {@link Wire}'s bits, where value 0 corresponds with 2^0, value 1 is 2^1 and so on.
\r
311 * @author Fabian Stemmler
\r
313 public long getSignedValue()
\r
315 return Wire.this.getSignedValue();
\r
319 public String toString()
\r
321 return Wire.this.toString();
\r
324 public void close()
\r
326 inputs.remove(this);
\r
331 public int length()
\r
336 public boolean addObserver(WireObserver ob)
\r
338 return observers.add(ob);
\r
341 public Wire getWire()
\r
347 public class ReadWriteEnd extends ReadEnd
\r
349 private boolean open;
\r
350 private BitVector inputValues;
\r
352 private ReadWriteEnd()
\r
357 registerInput(this);
\r
360 private void initValues()
\r
362 inputValues = U.toVector(length);
\r
366 * Sets the wires values. This takes up time, as specified by the {@link Wire}s travel time.
\r
368 * @param newValues The new values the wires should take on.
\r
370 * @author Fabian Stemmler
\r
372 public void feedSignals(Bit... newValues)
\r
374 feedSignals(BitVector.of(newValues));
\r
377 public void feedSignals(BitVector newValues)
\r
379 if (newValues.length() != length)
\r
380 throw new IllegalArgumentException(
\r
381 String.format("Attempted to input %d bits instead of %d bits.", newValues.length(), length));
\r
383 throw new RuntimeException("Attempted to write to closed WireArrayEnd.");
\r
384 timeline.addEvent(e -> setValues(newValues), travelTime);
\r
388 * Sets values of a subarray of wires. This takes up time, as specified by the {@link Wire}s travel time.
\r
390 * @param bitVector The new values the wires should take on.
\r
391 * @param startingBit The first index of the subarray of wires.
\r
393 * @author Fabian Stemmler
\r
395 public void feedSignals(int startingBit, BitVector bitVector)
\r
398 throw new RuntimeException("Attempted to write to closed WireArrayEnd.");
\r
399 timeline.addEvent(e -> setValues(startingBit, bitVector), travelTime);
\r
402 private void setValues(int startingBit, BitVector newValues)
\r
404 // index check covered in equals
\r
405 if (!inputValues.equalsWithOffset(newValues, startingBit))
\r
407 Bit[] vals = inputValues.getBits();
\r
408 System.arraycopy(newValues.getBits(), 0, vals, startingBit, newValues.length());
\r
409 inputValues = BitVector.of(vals);
\r
410 Wire.this.recalculate();
\r
414 private void setValues(BitVector newValues)
\r
416 if (inputValues.equals(newValues))
\r
418 inputValues = newValues;
\r
419 Wire.this.recalculate();
\r
423 * @return The value (of bit 0) the {@link ReadEnd} is currently feeding into the associated {@link Wire}.
\r
425 public Bit getInputValue()
\r
427 return getInputValue(0);
\r
431 * @return The value which the {@link ReadEnd} is currently feeding into the associated {@link Wire} at the indexed {@link Bit}.
\r
433 public Bit getInputValue(int index)
\r
435 return inputValues.getBit(index);
\r
439 * @return A copy (safe to modify) of the values the {@link ReadEnd} is currently feeding into the associated {@link Wire}.
\r
441 public BitVector getInputValues()
\r
443 return getInputValues(0, length);
\r
446 public BitVector getInputValues(int start, int end)
\r
448 return inputValues.subVector(start, end);
\r
452 * {@link ReadEnd} now feeds Z into the associated {@link Wire}.
\r
454 public void clearSignals()
\r
456 feedSignals(Z.toVector(length));
\r
459 public BitVector wireValuesExcludingMe()
\r
461 BitVectorMutator mutator = BitVectorMutator.empty();
\r
462 for (ReadWriteEnd wireEnd : inputs)
\r
464 if (wireEnd == this)
\r
466 mutator.join(wireEnd.inputValues);
\r
468 return mutator.get();
\r
472 public String toString()
\r
474 return inputValues.toString();
\r
479 public String toString()
\r
481 return String.format("wire 0x%08x value: %s inputs: %s", hashCode(), values, inputs);
\r
482 // Arrays.toString(values), inputs.stream().map(i -> Arrays.toString(i.inputValues)).reduce((s1, s2) -> s1 + s2)
\r
485 public static ReadEnd[] extractEnds(Wire[] w)
\r
487 ReadEnd[] inputs = new ReadEnd[w.length];
\r
488 for (int i = 0; i < w.length; i++)
\r
489 inputs[i] = w[i].createReadWriteEnd();
\r