Refactor in prep for overhaul

clvm/EvalError.py

@@ -1,4 +1 @@
-class EvalError(Exception):
-    def __init__(self, message: str, sexp):
-        super().__init__(message)
-        self._sexp = sexp
+from .run.EvalError import EvalError  # noqa: F401

clvm/SExp.py

@@ -6,9 +6,9 @@
 from .as_python import as_python
 from .CLVMObject import CLVMObject
 
-from .EvalError import EvalError
+from .run.EvalError import EvalError
 
-from .casts import (
+from .run.casts import (
     int_from_bytes,
     int_to_bytes,
 )

clvm/__init__.py

@@ -1,10 +1,10 @@
 from .SExp import SExp
-from .operators import (  # noqa
+from .run.operators import (  # noqa
     QUOTE_ATOM,
     KEYWORD_TO_ATOM,
     KEYWORD_FROM_ATOM,
 )
-from .run_program import run_program  # noqa
+from .run.run_program import run_program  # noqa
 from .version import __version__  # noqa
 
 to_sexp_f = SExp.to  # noqa

clvm/casts.py

@@ -1,24 +1 @@
-def int_from_bytes(blob):
-    size = len(blob)
-    if size == 0:
-        return 0
-    return int.from_bytes(blob, "big", signed=True)
-
-
-def int_to_bytes(v):
-    byte_count = (v.bit_length() + 8) >> 3
-    if v == 0:
-        return b""
-    r = v.to_bytes(byte_count, "big", signed=True)
-    # make sure the string returned is minimal
-    # ie. no leading 00 or ff bytes that are unnecessary
-    while len(r) > 1 and r[0] == (0xFF if r[1] & 0x80 else 0):
-        r = r[1:]
-    return r
-
-
-def limbs_for_int(v):
-    """
-    Return the number of bytes required to represent this integer.
-    """
-    return (v.bit_length() + 7) >> 3
+from .run.casts import int_from_bytes, int_to_bytes  # noqa: F401

clvm/operators.py

@@ -1,204 +1 @@
-from typing import Dict, Tuple
-
-from . import core_ops, more_ops
-
-from .CLVMObject import CLVMObject
-from .SExp import SExp
-from .EvalError import EvalError
-
-from .casts import int_to_bytes
-from .op_utils import operators_for_module
-
-from .costs import (
-    ARITH_BASE_COST,
-    ARITH_COST_PER_BYTE,
-    ARITH_COST_PER_ARG,
-    MUL_BASE_COST,
-    MUL_COST_PER_OP,
-    MUL_LINEAR_COST_PER_BYTE,
-    MUL_SQUARE_COST_PER_BYTE_DIVIDER,
-    CONCAT_BASE_COST,
-    CONCAT_COST_PER_ARG,
-    CONCAT_COST_PER_BYTE,
-)
-
-KEYWORDS = (
-    # core opcodes 0x01-x08
-    ". q a i c f r l x "
-
-    # opcodes on atoms as strings 0x09-0x0f
-    "= >s sha256 substr strlen concat . "
-
-    # opcodes on atoms as ints 0x10-0x17
-    "+ - * / divmod > ash lsh "
-
-    # opcodes on atoms as vectors of bools 0x18-0x1c
-    "logand logior logxor lognot . "
-
-    # opcodes for bls 1381 0x1d-0x1f
-    "point_add pubkey_for_exp . "
-
-    # bool opcodes 0x20-0x23
-    "not any all . "
-
-    # misc 0x24
-    "softfork "
-).split()
-
-KEYWORD_FROM_ATOM = {int_to_bytes(k): v for k, v in enumerate(KEYWORDS)}
-KEYWORD_TO_ATOM = {v: k for k, v in KEYWORD_FROM_ATOM.items()}
-
-OP_REWRITE = {
-    "+": "add",
-    "-": "subtract",
-    "*": "multiply",
-    "/": "div",
-    "i": "if",
-    "c": "cons",
-    "f": "first",
-    "r": "rest",
-    "l": "listp",
-    "x": "raise",
-    "=": "eq",
-    ">": "gr",
-    ">s": "gr_bytes",
-}
-
-
-def args_len(op_name, args):
-    for arg in args.as_iter():
-        if arg.pair:
-            raise EvalError("%s requires int args" % op_name, arg)
-        yield len(arg.as_atom())
-
-
-# unknown ops are reserved if they start with 0xffff
-# otherwise, unknown ops are no-ops, but they have costs. The cost is computed
-# like this:
-
-# byte index (reverse):
-# | 4 | 3 | 2 | 1 | 0          |
-# +---+---+---+---+------------+
-# | multiplier    |XX | XXXXXX |
-# +---+---+---+---+---+--------+
-#  ^               ^    ^
-#  |               |    + 6 bits ignored when computing cost
-# cost_multiplier  |
-#                  + 2 bits
-#                    cost_function
-
-# 1 is always added to the multiplier before using it to multiply the cost, this
-# is since cost may not be 0.
-
-# cost_function is 2 bits and defines how cost is computed based on arguments:
-# 0: constant, cost is 1 * (multiplier + 1)
-# 1: computed like operator add, multiplied by (multiplier + 1)
-# 2: computed like operator mul, multiplied by (multiplier + 1)
-# 3: computed like operator concat, multiplied by (multiplier + 1)
-
-# this means that unknown ops where cost_function is 1, 2, or 3, may still be
-# fatal errors if the arguments passed are not atoms.
-
-def default_unknown_op(op: bytes, args: CLVMObject) -> Tuple[int, CLVMObject]:
-    # any opcode starting with ffff is reserved (i.e. fatal error)
-    # opcodes are not allowed to be empty
-    if len(op) == 0 or op[:2] == b"\xff\xff":
-        raise EvalError("reserved operator", args.to(op))
-
-    # all other unknown opcodes are no-ops
-    # the cost of the no-ops is determined by the opcode number, except the
-    # 6 least significant bits.
-
-    cost_function = (op[-1] & 0b11000000) >> 6
-    # the multiplier cannot be 0. it starts at 1
-
-    if len(op) > 5:
-        raise EvalError("invalid operator", args.to(op))
-
-    cost_multiplier = int.from_bytes(op[:-1], "big", signed=False) + 1
-
-    # 0 = constant
-    # 1 = like op_add/op_sub
-    # 2 = like op_multiply
-    # 3 = like op_concat
-    if cost_function == 0:
-        cost = 1
-    elif cost_function == 1:
-        # like op_add
-        cost = ARITH_BASE_COST
-        arg_size = 0
-        for length in args_len("unknown op", args):
-            arg_size += length
-            cost += ARITH_COST_PER_ARG
-        cost += arg_size * ARITH_COST_PER_BYTE
-    elif cost_function == 2:
-        # like op_multiply
-        cost = MUL_BASE_COST
-        operands = args_len("unknown op", args)
-        try:
-            vs = next(operands)
-            for rs in operands:
-                cost += MUL_COST_PER_OP
-                cost += (rs + vs) * MUL_LINEAR_COST_PER_BYTE
-                cost += (rs * vs) // MUL_SQUARE_COST_PER_BYTE_DIVIDER
-                # this is an estimate, since we don't want to actually multiply the
-                # values
-                vs += rs
-        except StopIteration:
-            pass
-
-    elif cost_function == 3:
-        # like concat
-        cost = CONCAT_BASE_COST
-        length = 0
-        for arg in args.as_iter():
-            if arg.pair:
-                raise EvalError("unknown op on list", arg)
-            cost += CONCAT_COST_PER_ARG
-            length += len(arg.atom)
-        cost += length * CONCAT_COST_PER_BYTE
-
-    cost *= cost_multiplier
-    if cost >= 2**32:
-        raise EvalError("invalid operator", args.to(op))
-
-    return (cost, SExp.null())
-
-
-class OperatorDict(dict):
-    """
-    This is a nice hack that adds `__call__` to a dictionary, so
-    operators can be added dynamically.
-    """
-
-    def __new__(class_, d: Dict, *args, **kwargs):
-        """
-        `quote_atom` and `apply_atom` must be set
-        `unknown_op_handler` has a default implementation
-        We do not check if quote and apply are distinct
-        We do not check if the opcode values for quote and apply exist in the passed-in dict
-        """
-        self = super(OperatorDict, class_).__new__(class_, d)
-        self.quote_atom = kwargs["quote"] if "quote" in kwargs else d.quote_atom
-        self.apply_atom = kwargs["apply"] if "apply" in kwargs else d.apply_atom
-        if "unknown_op_handler" in kwargs:
-            self.unknown_op_handler = kwargs["unknown_op_handler"]
-        else:
-            self.unknown_op_handler = default_unknown_op
-        return self
-
-    def __call__(self, op: bytes, arguments: CLVMObject) -> Tuple[int, CLVMObject]:
-        f = self.get(op)
-        if f is None:
-            return self.unknown_op_handler(op, arguments)
-        else:
-            return f(arguments)
-
-
-QUOTE_ATOM = KEYWORD_TO_ATOM["q"]
-APPLY_ATOM = KEYWORD_TO_ATOM["a"]
-
-OPERATOR_LOOKUP = OperatorDict(
-    operators_for_module(KEYWORD_TO_ATOM, core_ops, OP_REWRITE), quote=QUOTE_ATOM, apply=APPLY_ATOM
-)
-OPERATOR_LOOKUP.update(operators_for_module(KEYWORD_TO_ATOM, more_ops, OP_REWRITE))
+from .run.operators import OP_REWRITE, OperatorDict, OPERATOR_LOOKUP  # noqa: F401

clvm/run/EvalError.py

@@ -0,0 +1,4 @@
+class EvalError(Exception):
+    def __init__(self, message: str, sexp):
+        super().__init__(message)
+        self._sexp = sexp

clvm/run/casts.py

@@ -0,0 +1,24 @@
+def int_from_bytes(blob):
+    size = len(blob)
+    if size == 0:
+        return 0
+    return int.from_bytes(blob, "big", signed=True)
+
+
+def int_to_bytes(v):
+    byte_count = (v.bit_length() + 8) >> 3
+    if v == 0:
+        return b""
+    r = v.to_bytes(byte_count, "big", signed=True)
+    # make sure the string returned is minimal
+    # ie. no leading 00 or ff bytes that are unnecessary
+    while len(r) > 1 and r[0] == (0xFF if r[1] & 0x80 else 0):
+        r = r[1:]
+    return r
+
+
+def limbs_for_int(v):
+    """
+    Return the number of bytes required to represent this integer.
+    """
+    return (v.bit_length() + 7) >> 3

clvm/core_ops.py → clvm/run/core_ops.py

@@ -1,5 +1,6 @@
+from ..SExp import SExp
+
 from .EvalError import EvalError
-from .SExp import SExp
 
 from .costs import (
     IF_COST,

clvm/more_ops.py → clvm/run/more_ops.py

@@ -5,7 +5,7 @@
 
 from .EvalError import EvalError
 from .casts import limbs_for_int
-from .SExp import SExp
+from ..SExp import SExp
 
 from .costs import (
     ARITH_BASE_COST,