Files
R8Forge/tests/byte_op_test.cc
T
dsh 6e67eb4678 The multiplier: shift and add, one bit at a time, 3977 characters
clb_mul was repeated addition -- add MC into the product, MUL times.  That is
the shortest thing to write, but the runtime is proportional to MUL's value:
255 * 255 took 733428 steps, and 2047 * 2047 ran into the 5000000 step ceiling
and hung outright (tape_run: HANG after 5000000 steps).  So the multiplier was
a ceiling on what any program could compute.

The new body is the plain binary multiplication from school: hold the
multiplicand, look at the multiplier's low bit, add the multiplicand into the
high half of the product when that bit is 1, then shift the whole product one
place right -- the multiplier lives in the low half of that register, so its
bits fall out one at a time.  The loop runs _CELL_SIZE rounds whatever the
operands are, and the tape got shorter as well:

    82 * 141     358586 -> 8374 steps
    255 * 255    733428 -> 17785 steps
    2047 * 2047      HANG -> 26123 steps
    tape           5007 -> 3977 characters

(Step counts are the tape's own, with no trailing newline -- tape_run counts
one if the file has one, which is where the first draft of this message got
numbers two out.)

Counter, carry and cross cell shift are the three pieces that needed care:

  * the round counter is _CELL_SIZE ones in NR, one eaten per round by
    set_0 + ror -- the same trick clb_inc_ip counts rotations with, so "how
    many rounds" costs no tape length, only runtime;
  * the carry out of the W bit add is not scratch: it is the top bit of the
    2W+1 bit shift register, and the next shift moves it into PH's top bit;
  * (F:PH:PL) >>= 1 is a cross cell shift.  ror all three, bring the bit to
    inject down to bit 0 with rol, move it with clb_bit_mov, ror back.  The
    low pair (PH -> PL) moves first, otherwise PH's bit 0 has already been
    overwritten by the carry.

And biz/rnz is a loop pair, not an if/else: a one shot conditional has to eat
the bit it tested (a trailing flb) or rnz jumps straight back.  The first
version of this hung exactly there -- no output at all, counter still 0x7ff.
The bit eaten is PL's low bit, which the shift discards anyway.

r8forge_byte_op_test now sweeps 0..255 x 0..255 exhaustively (65536/65536 ok,
6.7s instead of 1.5s) instead of sampling 64 combinations: the cost no longer
grows with the multiplier, so sampling was the only reason not to.  asm/
test.r8asm still prints 1322 1786 1600 5 94 127, now as 28729 characters and
57330 steps (was 31901 and about two million), and derive and tape_run agree.

AGENTS.md and README record all of it, plus one correction: the old note said
shift and add had been dismissed because "only tape length is the target".  It
is in fact 1000 characters shorter, so the reason given was wrong -- the
tradeoff was not.  What changed is the target function: the 5000000 step
ceiling is part of it, and a loop whose length does not depend on its operands
can still have a runtime that does.
2026-11-07 12:09:45 +08:00

528 lines
18 KiB
C++

// Runs the byte level library macros over every input pair on a ROT-8 machine.
//
// r8forge_byte_op_test [repo root]
//
// The machine below follows the reference implementation in ROT-8-viz
// (src/rot8.c): `biz` jumps when the LOW BIT of the cell is 0 and `rnz` jumps
// back when it is 1, so `set_0` (= [-]) clears the low bit of whatever is in
// the cell. Reading `[`/`]` as a Brainfuck style "is the cell zero" test makes
// every one of these programs look like an endless loop -- which is exactly the
// mistake three interpreters in this repo used to make.
#include "r8forge/r8asm.hh"
#include <cstdint>
#include <cstdlib>
#include <iostream>
#include <string>
#include <vector>
namespace {
// The cell width is a knob (geometry.hh), so every expectation below is
// written in terms of it instead of in terms of a byte: kCellMod is one past
// the largest value a cell holds. The sweeps walk the first 256 values, which
// is a sample of the cell range rather than all of it.
constexpr int kBits = int(kDefaultCellBits);
constexpr int kCellMod = 1 << kBits;
constexpr int kCellMask = int(kDefaultCellMask);
struct machine {
std::vector<uint16_t> cells = std::vector<uint16_t>(kDefaultMemoryCells, 0);
std::vector<uint16_t> out;
size_t dp = 0;
size_t steps = 0;
bool finished = true; // false: the step limit ran out
static uint16_t ror(uint16_t v) {
return uint16_t((v >> 1) | ((v & 1u) << (kDefaultCellBits - 1)));
}
void run(const std::string &tape, size_t limit) {
for (size_t pc = 0; pc < tape.size(); pc++) {
if (++steps > limit) {
finished = false;
return;
}
switch (tape[pc]) {
case '>':
dp = (dp + 1) % cells.size();
break;
case '<':
dp = (dp + cells.size() - 1) % cells.size();
break;
case '-': // flb
cells[dp] ^= 1;
break;
case '+': // ror
cells[dp] = ror(cells[dp]);
break;
case '[': // biz: branch when the low bit is zero
if ((cells[dp] & 1) == 0) {
int depth = 1;
while (depth) {
pc++;
if (tape[pc] == '[')
depth++;
else if (tape[pc] == ']')
depth--;
}
}
break;
case ']': // rnz: return when the low bit is one
if ((cells[dp] & 1) == 1) {
int depth = 1;
while (depth) {
pc--;
if (tape[pc] == ']')
depth++;
else if (tape[pc] == '[')
depth--;
}
}
break;
case '.':
out.push_back(cells[dp]);
break;
default: // ',' (input) is not modelled
break;
}
}
}
};
std::string assemble(const std::string &file) {
r8asm assembler;
if (!assembler.import_file(file, kDefaultCellBits) || assembler.failed()) {
std::cerr << "could not assemble " << file << "\n";
std::exit(1);
}
return assembler.export_rot8();
}
int failures = 0;
void report(const std::string &name, int a, int b, const machine &m,
const std::string &want) {
if (failures++ < 5) {
std::cerr << " WRONG " << name << " a=" << a << " b=" << b << " out";
for (uint16_t v : m.out)
std::cerr << " " << int(v);
std::cerr << " want " << want << " finished=" << m.finished
<< " steps=" << m.steps << "\n";
}
}
// raw_and / raw_or / raw_xor: both operands are preserved, the result is third.
int test_bitop(const std::string &file, const char *name, int op) {
const std::string tape = assemble(file);
std::cout << name << ": " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++)
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.cells[2] = uint16_t(b); // B
m.run(tape, 100'000);
const int want = op == 0 ? (a & b) : op == 1 ? (a | b) : (a ^ b);
const bool ok = m.finished && m.out.size() == 3 && m.out[0] == a &&
m.out[1] == b && m.out[2] == want;
if (!ok) {
bad++;
if (bad <= 3)
report(name, a, b, m,
std::to_string(a) + " " + std::to_string(b) + " " +
std::to_string(want));
}
}
std::cout << " " << (bad ? "FAILED" : "all 65536 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// raw_add: out is A, B, Ci, S, Co.
int test_add(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "raw_add: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++)
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(a);
m.cells[2] = uint16_t(b);
m.run(tape, 100'000);
const int sum = a + b;
const bool ok = m.finished && m.out.size() == 5 && m.out[0] == a &&
m.out[1] == b && m.out[2] == 0 &&
m.out[3] == (sum & kCellMask) && m.out[4] == (sum >> kBits);
if (!ok) {
bad++;
if (bad <= 3)
report("raw_add", a, b, m,
std::to_string(a) + " " + std::to_string(b) + " 0 " +
std::to_string(sum & kCellMask) + " " +
std::to_string(sum >> kBits));
}
}
std::cout << " " << (bad ? "FAILED" : "all 65536 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// raw_inc: out is A, Ci, S, Co; S = A + Ci.
int test_inc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "raw_inc: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++)
for (int ci = 0; ci < 2; ci++) {
machine m;
m.cells[0] = uint16_t(a);
m.cells[2] = uint16_t(ci);
m.run(tape, 100'000);
const int sum = a + ci;
const bool ok = m.finished && m.out.size() == 4 && m.out[0] == a &&
m.out[1] == ci && m.out[2] == (sum & kCellMask) &&
m.out[3] == (sum >> kBits);
if (!ok) {
bad++;
if (bad <= 3)
report("raw_inc", a, ci, m,
std::to_string(a) + " " + std::to_string(ci) + " " +
std::to_string(sum & kCellMask) + " " +
std::to_string(sum >> kBits));
}
}
std::cout << " " << (bad ? "FAILED" : "all 512 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_add_nc: out is A, B, S, Ci. This one eats both operands, so A and B have
// to come back zero -- that is what lets it use the 4 cell slice.
int test_add_nc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_add_nc: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++)
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.cells[2] = uint16_t(b); // B
m.run(tape, 100'000);
const int sum = a + b;
const bool ok = m.finished && m.out.size() == 4 && m.out[0] == 0 &&
m.out[1] == 0 && m.out[2] == (sum & kCellMask) &&
m.out[3] == (sum >> kBits);
if (!ok) {
bad++;
if (bad <= 3)
report("clb_add_nc", a, b, m,
"0 0 " + std::to_string(sum & kCellMask) + " " +
std::to_string(sum >> kBits));
}
}
std::cout << " " << (bad ? "FAILED" : "all 65536 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_inc_nc: out is A, S, Ci.
int test_inc_nc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_inc_nc: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int sum = a + 1;
const bool ok = m.finished && m.out.size() == 3 && m.out[0] == 0 &&
m.out[1] == (sum & kCellMask) && m.out[2] == (sum >> kBits);
if (!ok) {
bad++;
if (bad <= 3)
report("clb_inc_nc", a, 1, m,
"0 " + std::to_string(sum & kCellMask) + " " +
std::to_string(sum >> kBits));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_neg_nc: out is A, S, Ci; S = -A, A is eaten.
int test_neg_nc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_neg_nc: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int neg = (kCellMod - a) & kCellMask;
const int carry = a == 0 ? 1 : 0; // -0 is 0 but it does carry out
const bool ok = m.finished && m.out.size() == 3 && m.out[0] == 0 &&
m.out[1] == neg && m.out[2] == carry;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_neg_nc", a, 0, m,
"0 " + std::to_string(neg) + " " + std::to_string(carry));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_sub_nc: out is A, B, S, Ci; S = A - B and Ci = 1 means no borrow.
int test_sub_nc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_sub_nc: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++)
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.cells[2] = uint16_t(b); // B
m.run(tape, 100'000);
const int diff = (a - b) & kDefaultCellMask;
const int no_borrow = a >= b ? 1 : 0;
const bool ok = m.finished && m.out.size() == 4 && m.out[0] == 0 &&
m.out[1] == 0 && m.out[2] == diff && m.out[3] == no_borrow;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_sub_nc", a, b, m,
"0 0 " + std::to_string(diff) + " " +
std::to_string(no_borrow));
}
}
std::cout << " " << (bad ? "FAILED" : "all 65536 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// Same macro with its carry in at 0 is the ones' complement: S = ~A.
int test_not_nc(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_neg_nc (carry 0): " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int inv = (~a) & kDefaultCellMask;
const bool ok = m.finished && m.out.size() == 3 && m.out[0] == 0 &&
m.out[1] == inv && m.out[2] == 0;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_neg_nc/0", a, 0, m, "0 " + std::to_string(inv) + " 0");
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_not_ip: the ones' complement done in place, one cell, no carry.
int test_not_ip(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_not_ip: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int inv = (~a) & kDefaultCellMask;
const bool ok =
m.finished && m.out.size() == 1 && m.out[0] == inv;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_not_ip", a, 0, m, std::to_string(inv));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_inc_ip: A = A + 1, both in place and in two cells.
int test_inc_ip(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_inc_ip: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int want = (a + 1) & kDefaultCellMask;
const bool ok = m.finished && m.out.size() == 1 && m.out[0] == want &&
m.cells[1] == 0; // the counter cell is spent
if (!ok) {
bad++;
if (bad <= 3)
report("clb_inc_ip", a, 0, m, std::to_string(want));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_neg_ip: A = -A, in place, two cells.
int test_neg_ip(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_neg_ip: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.run(tape, 100'000);
const int want = (kCellMod - a) & kCellMask;
const bool ok = m.finished && m.out.size() == 1 && m.out[0] == want;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_neg_ip", a, 0, m, std::to_string(want));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_dec_ip: A = A - 1, in place.
int test_dec_ip(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_dec_ip: " << tape.size() << " characters\n";
int bad = 0;
for (int a = 0; a < 256; a++) {
machine m;
m.cells[0] = uint16_t(a);
m.run(tape, 100'000);
const int want = (a - 1) & kDefaultCellMask;
const bool ok = m.finished && m.out.size() == 1 && m.out[0] == want;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_dec_ip", a, 0, m, std::to_string(want));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_nonzero: F = (B != 0), B untouched.
int test_nonzero(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_nonzero: " << tape.size() << " characters\n";
int bad = 0;
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(b); // B
m.run(tape, 100'000);
const bool ok = m.finished && m.out.size() == 2 && m.out[0] == b &&
m.out[1] == (b != 0 ? 1 : 0);
if (!ok) {
bad++;
if (bad <= 3)
report("clb_nonzero", b, 0, m,
std::to_string(b) + " " + std::to_string(b != 0 ? 1 : 0));
}
}
std::cout << " " << (bad ? "FAILED" : "all 256 combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_add_ip: A = A + B in place, B is eaten. The loop runs B times, so this
// one is sampled rather than exhaustive -- 256 addends x 8 accumulators.
int test_add_ip(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_add_ip: " << tape.size() << " characters (sampled)\n";
const int accs[] = {0, 1, 5, 127, 128, 200, 254, 255};
int bad = 0, n = 0;
for (int a : accs)
for (int b = 0; b < 256; b++) {
machine m;
m.cells[0] = uint16_t(a); // A
m.cells[1] = uint16_t(b); // B
m.run(tape, 5'000'000);
n++;
const int want = (a + b) & kDefaultCellMask;
const bool ok = m.finished && m.out.size() == 2 && m.out[0] == want &&
m.out[1] == 0;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_add_ip", a, b, m, std::to_string(want) + " 0");
}
}
std::cout << " " << (bad ? "FAILED" : "all " + std::to_string(n) + " sampled combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
// clb_mul: (PH:PL) = MC * MUL, MC preserved. Shift and add: the loop runs
// once per bit of MUL whatever MUL's value is, so the classic 8 bit domain can
// be swept exhaustively. (The repeated addition version this replaced looped
// MUL times, so it could only be sampled -- and it hit the step limit outright
// for large multipliers.)
int test_mul(const std::string &file) {
const std::string tape = assemble(file);
std::cout << "clb_mul: " << tape.size() << " characters\n";
int bad = 0, n = 0;
for (int mc = 0; mc < 256; mc++)
for (int mu = 0; mu < 256; mu++) {
machine m;
m.cells[0] = uint16_t(mc); // MC
m.cells[1] = uint16_t(mu); // MUL
m.run(tape, 5'000'000);
n++;
const int p = mc * mu;
const bool ok = m.finished && m.out.size() == 3 &&
m.out[0] == (p & kCellMask) && m.out[1] == ((p >> kBits) & kCellMask) &&
m.out[2] == mc;
if (!ok) {
bad++;
if (bad <= 3)
report("clb_mul", mc, mu, m,
std::to_string(p & kCellMask) + " " + std::to_string((p >> kBits) & kCellMask) +
" " + std::to_string(mc));
}
}
std::cout << " " << (bad ? "FAILED" : "all " + std::to_string(n) + " combinations ok")
<< (bad ? " (" + std::to_string(bad) + " wrong)" : "") << "\n";
return bad;
}
} // namespace
int main(int argc, char **argv) {
const std::string root = argc > 1 ? argv[1] : ".";
const std::string drv = root + "/drv/";
const int bad = test_add(drv + "raw_add_byte.r8asm") +
test_bitop(drv + "raw_and_byte.r8asm", "raw_and", 0) +
test_bitop(drv + "raw_or_byte.r8asm", "raw_or", 1) +
test_bitop(drv + "raw_xor_byte.r8asm", "raw_xor", 2) +
test_inc(drv + "raw_inc_byte.r8asm") +
test_add_nc(drv + "raw_add_nc_byte.r8asm") +
test_inc_nc(drv + "raw_inc_nc_byte.r8asm") +
test_neg_nc(drv + "raw_neg_nc_byte.r8asm") +
test_not_nc(drv + "raw_not_nc_byte.r8asm") +
test_not_ip(drv + "not_ip_byte.r8asm") +
test_inc_ip(drv + "inc_ip_byte.r8asm") +
test_neg_ip(drv + "neg_ip_byte.r8asm") +
test_dec_ip(drv + "dec_ip_byte.r8asm") +
test_nonzero(drv + "nonzero_byte.r8asm") +
test_add_ip(drv + "add_ip_byte.r8asm") +
test_mul(drv + "mul_byte.r8asm") +
test_sub_nc(drv + "raw_sub_nc_byte.r8asm");
std::cout << (bad ? "FAILED\n" : "byte level library ok\n");
return bad ? 1 : 0;
}