Squashed 'src/simplicity/' changes from b549192109..6d503ea4f8

6d503ea4f8 Rename elements/jets.c
c68063f9ef Add testcases that are an even multiple of 1000 milliWU
92887000e6 Add minCost parameter
82d6260ed8 Remove intermedite primitive directory
09b4eee340 Make raw environment struct tags elements specific
a93cd359df Make environment struct tags elements specific
26de216e24 Make primitive.h functions indirect
35d188a247 rename elementsJets.* to jets.*
7fd6dbe2ca simplicity_computeCmr -> simplicity_elements_computeCmr

git-subtree-dir: src/simplicity
git-subtree-split: 6d503ea4f8859ec63ad22a22c0ccef067b1a0b5d

Author: roconnor-blockstream

Makefile

@@ -1,5 +1,5 @@
-OBJS := bitstream.o cmr.o dag.o deserialize.o eval.o frame.o jets.o jets-secp256k1.o rsort.o sha256.o type.o typeInference.o primitive/elements/env.o primitive/elements/exec.o primitive/elements/ops.o primitive/elements/elementsJets.o primitive/elements/primitive.o
-TEST_OBJS := test.o ctx8Pruned.o ctx8Unpruned.o hashBlock.o regression4.o schnorr0.o schnorr6.o typeSkipTest.o primitive/elements/checkSigHashAllTx1.o
+OBJS := bitstream.o dag.o deserialize.o eval.o frame.o jets.o jets-secp256k1.o rsort.o sha256.o type.o typeInference.o elements/env.o elements/exec.o elements/ops.o elements/elementsJets.o elements/primitive.o elements/cmr.o elements/txEnv.o
+TEST_OBJS := test.o ctx8Pruned.o ctx8Unpruned.o hashBlock.o regression4.o schnorr0.o schnorr6.o typeSkipTest.o elements/checkSigHashAllTx1.o
 
 # From https://fastcompression.blogspot.com/2019/01/compiler-warnings.html
 CWARN := -Werror -Wall -Wextra -Wcast-qual -Wcast-align -Wstrict-aliasing -Wpointer-arith -Winit-self -Wshadow -Wswitch-enum -Wstrict-prototypes -Wmissing-prototypes -Wredundant-decls -Wfloat-equal -Wundef -Wconversion
@@ -14,7 +14,7 @@ CFLAGS := $(CFLAGS) -I include
 jets-secp256k1.o: jets-secp256k1.c
 	$(CC) -c $(CFLAGS) $(CWARN) -Wno-conversion $(CPPFLAGS) -o $@ $<
 
-primitive/elements/elementsJets.o: primitive/elements/elementsJets.c
+elements/elementsJets.o: elements/elementsJets.c
 	$(CC) -c $(CFLAGS) $(CWARN) -Wno-switch-enum -Wswitch $(CPPFLAGS) -o $@ $<
 
 sha256.o: sha256.c

deserialize.c

@@ -2,7 +2,6 @@
 
 #include <limits.h>
 #include "limitations.h"
-#include "primitive.h"
 #include "simplicity_alloc.h"
 #include "simplicity_assert.h"
 
@@ -55,15 +54,15 @@ static simplicity_err getHash(sha256_midstate* result, bitstream* stream) {
  *               i < 2^31 - 1
  *               NULL != stream
  */
-static simplicity_err decodeNode(dag_node* dag, uint_fast32_t i, bitstream* stream) {
+static simplicity_err decodeNode(dag_node* dag, simplicity_callback_decodeJet decodeJet, uint_fast32_t i, bitstream* stream) {
   int32_t bit = read1Bit(stream);
   if (bit < 0) return (simplicity_err)bit;
   dag[i] = (dag_node){0};
   if (bit) {
     bit = read1Bit(stream);
     if (bit < 0) return (simplicity_err)bit;
     if (bit) {
-      return simplicity_decodeJet(&dag[i], stream);
+      return decodeJet(&dag[i], stream);
     } else {
       /* Decode WORD. */
       int32_t depth = simplicity_decodeUptoMaxInt(stream);
@@ -153,9 +152,9 @@ static simplicity_err decodeNode(dag_node* dag, uint_fast32_t i, bitstream* stre
  *               len < 2^31
  *               NULL != stream
  */
-static simplicity_err decodeDag(dag_node* dag, const uint_fast32_t len, combinator_counters* census, bitstream* stream) {
+static simplicity_err decodeDag(dag_node* dag, simplicity_callback_decodeJet decodeJet, const uint_fast32_t len, combinator_counters* census, bitstream* stream) {
   for (uint_fast32_t i = 0; i < len; ++i) {
-    simplicity_err error = decodeNode(dag, i, stream);
+    simplicity_err error = decodeNode(dag, decodeJet, i, stream);
     if (!IS_OK(error)) return error;
 
     enumerator(census, dag[i].tag);
@@ -186,7 +185,7 @@ static simplicity_err decodeDag(dag_node* dag, const uint_fast32_t len, combinat
  *                          of the function is positive and when NULL != census;
  *                NULL == *dag when the return value is negative.
  */
-int_fast32_t simplicity_decodeMallocDag(dag_node** dag, combinator_counters* census, bitstream* stream) {
+int_fast32_t simplicity_decodeMallocDag(dag_node** dag, simplicity_callback_decodeJet decodeJet, combinator_counters* census, bitstream* stream) {
   *dag = NULL;
   int32_t dagLen = simplicity_decodeUptoMaxInt(stream);
   if (dagLen <= 0) return dagLen;
@@ -199,7 +198,7 @@ int_fast32_t simplicity_decodeMallocDag(dag_node** dag, combinator_counters* cen
   if (!*dag) return SIMPLICITY_ERR_MALLOC;
 
   if (census) *census = (combinator_counters){0};
-  simplicity_err error = decodeDag(*dag, (uint_fast32_t)dagLen, census, stream);
+  simplicity_err error = decodeDag(*dag, decodeJet, (uint_fast32_t)dagLen, census, stream);
 
   if (IS_OK(error)) {
     error = HIDDEN == (*dag)[dagLen - 1].tag

deserialize.h

@@ -6,6 +6,18 @@
 #include "bitstream.h"
 #include "dag.h"
 
+/* Decode an application specific jet from 'stream' into 'node'.
+ * All jets begin with a bit prefix of '1' which needs to have already been consumed from the 'stream'.
+ * Returns 'SIMPLICITY_ERR_DATA_OUT_OF_RANGE' if the stream's prefix doesn't match any valid code for a jet.
+ * Returns 'SIMPLICITY_ERR_BITSTRING_EOF' if not enough bits are available in the 'stream'.
+ * In the above error cases, 'dag' may be modified.
+ * Returns 'SIMPLICITY_NO_ERROR' if successful.
+ *
+ * Precondition: NULL != node
+ *               NULL != stream
+ */
+typedef simplicity_err (*simplicity_callback_decodeJet)(dag_node* node, bitstream* stream);
+
 /* Decode a length-prefixed Simplicity DAG from 'stream'.
  * Returns 'SIMPLICITY_ERR_DATA_OUT_OF_RANGE' the length prefix's value is too large.
  * Returns 'SIMPLICITY_ERR_DATA_OUT_OF_RANGE' if some node's child isn't a reference to one of the preceding nodes.
@@ -28,6 +40,6 @@
  *                          of the function is positive and when NULL != census;
  *                NULL == *dag when the return value is negative.
  */
-int_fast32_t simplicity_decodeMallocDag(dag_node** dag, combinator_counters* census, bitstream* stream);
+int_fast32_t simplicity_decodeMallocDag(dag_node** dag, simplicity_callback_decodeJet decodeJet, combinator_counters* census, bitstream* stream);
 
 #endif

elements-sources.mk

@@ -5,14 +5,13 @@
 ELEMENTS_SIMPLICITY_INCLUDE_DIR_INT = %reldir%/include
 
 ELEMENTS_SIMPLICITY_DIST_HEADERS_INT =
-ELEMENTS_SIMPLICITY_DIST_HEADERS_INT += %reldir%/include/simplicity/cmr.h
 ELEMENTS_SIMPLICITY_DIST_HEADERS_INT += %reldir%/include/simplicity/errorCodes.h
+ELEMENTS_SIMPLICITY_DIST_HEADERS_INT += %reldir%/include/simplicity/elements/cmr.h
 ELEMENTS_SIMPLICITY_DIST_HEADERS_INT += %reldir%/include/simplicity/elements/env.h
 ELEMENTS_SIMPLICITY_DIST_HEADERS_INT += %reldir%/include/simplicity/elements/exec.h
 
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT =
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/bitstream.c
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/cmr.c
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/dag.c
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/deserialize.c
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/eval.c
@@ -24,11 +23,13 @@ ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/sha256.c
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/type.c
 ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/typeInference.c
 
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/primitive/elements/env.c
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/primitive/elements/exec.c
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/primitive/elements/elementsJets.c
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/primitive/elements/ops.c
-ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/primitive/elements/primitive.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/cmr.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/env.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/exec.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/elementsJets.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/ops.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/primitive.c
+ELEMENTS_SIMPLICITY_LIB_SOURCES_INT += %reldir%/elements/txEnv.c
 
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT =
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/bitstream.h
@@ -42,7 +43,6 @@ ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/frame.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/jets.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/limitations.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/precomputed.h
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/rsort.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/sha256.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/sha256_x86.inc
@@ -89,11 +89,12 @@ ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/secp256k1/secp256k1.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/secp256k1/secp256k1_impl.h
 ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/secp256k1/util.h
 
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/decodeElementsJets.inc
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/elementsJets.h
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/ops.h
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/primitive.h
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/primitiveEnumJet.inc
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/primitiveEnumTy.inc
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/primitiveInitTy.inc
-ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/primitive/elements/primitiveJetNode.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/decodeElementsJets.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/elementsJets.h
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/ops.h
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/primitive.h
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/primitiveEnumJet.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/primitiveEnumTy.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/primitiveInitTy.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/primitiveJetNode.inc
+ELEMENTS_SIMPLICITY_LIB_HEADERS_INT += %reldir%/elements/txEnv.h

primitive/elements/checkSigHashAllTx1.c renamed to elements/checkSigHashAllTx1.c

@@ -1,9 +1,9 @@
-#ifndef SIMPLICITY_PRIMITIVE_ELEMENTS_CHECKSIGHASHALLTX1_H
-#define SIMPLICITY_PRIMITIVE_ELEMENTS_CHECKSIGHASHALLTX1_H
+#ifndef SIMPLICITY_ELEMENTS_CHECKSIGHASHALLTX1_H
+#define SIMPLICITY_ELEMENTS_CHECKSIGHASHALLTX1_H
 
 #include <stddef.h>
 #include <stdint.h>
-#include "../../bounded.h"
+#include "../bounded.h"
 
 /* A length-prefixed encoding of the following Simplicity program:
  *     Simplicity.Programs.CheckSig.Lib.checkSigVerify' Simplicity.Elements.Programs.SigHash.Lib.sigAllHash

primitive/elements/checkSigHashAllTx1.h renamed to elements/checkSigHashAllTx1.h

@@ -1,9 +1,10 @@
-#include <simplicity/cmr.h>
+#include <simplicity/elements/cmr.h>
 
-#include "deserialize.h"
-#include "limitations.h"
-#include "simplicity_alloc.h"
-#include "simplicity_assert.h"
+#include "../deserialize.h"
+#include "../limitations.h"
+#include "../simplicity_alloc.h"
+#include "../simplicity_assert.h"
+#include "primitive.h"
 
 /* Deserialize a Simplicity 'program' and compute its CMR.
  *
@@ -18,15 +19,15 @@
  *               unsigned char cmr[32]
  *               unsigned char program[program_len]
  */
-bool simplicity_computeCmr( simplicity_err* error, unsigned char* cmr
-                          , const unsigned char* program, size_t program_len) {
+bool simplicity_elements_computeCmr( simplicity_err* error, unsigned char* cmr
+                                   , const unsigned char* program, size_t program_len) {
   simplicity_assert(NULL != error);
   simplicity_assert(NULL != cmr);
   simplicity_assert(NULL != program || 0 == program_len);
 
   bitstream stream = initializeBitstream(program, program_len);
   dag_node* dag = NULL;
-  int_fast32_t dag_len = simplicity_decodeMallocDag(&dag, NULL, &stream);
+  int_fast32_t dag_len = simplicity_decodeMallocDag(&dag, simplicity_elements_decodeJet, NULL, &stream);
   if (dag_len <= 0) {
     simplicity_assert(dag_len < 0);
     *error = (simplicity_err)dag_len;

cmr.c renamed to elements/cmr.c

@@ -1,9 +1,9 @@
 #include "elementsJets.h"
 
 #include "ops.h"
-#include "primitive.h"
-#include "../../taptweak.h"
-#include "../../simplicity_assert.h"
+#include "txEnv.h"
+#include "../taptweak.h"
+#include "../simplicity_assert.h"
 
 /* Read a 256-bit hash value from the 'src' frame, advancing the cursor 256 cells.
  *
@@ -145,19 +145,19 @@ static void issuanceTokenAmt(frameItem* dst, const assetIssuance* issuance) {
   }
 }
 
-static uint_fast32_t lockHeight(const transaction* tx) {
+static uint_fast32_t lockHeight(const elementsTransaction* tx) {
   return !tx->isFinal && tx->lockTime < 500000000U ? tx->lockTime : 0;
 }
 
-static uint_fast32_t lockTime(const transaction* tx) {
+static uint_fast32_t lockTime(const elementsTransaction* tx) {
   return !tx->isFinal && 500000000U <= tx->lockTime ? tx->lockTime : 0;
 }
 
-static uint_fast16_t lockDistance(const transaction* tx) {
+static uint_fast16_t lockDistance(const elementsTransaction* tx) {
   return 2 <= tx->version ? tx->lockDistance : 0;
 }
 
-static uint_fast16_t lockDuration(const transaction* tx) {
+static uint_fast16_t lockDuration(const elementsTransaction* tx) {
   return 2 <= tx->version ? tx->lockDuration : 0;
 }
 

primitive/elements/decodeElementsJets.inc renamed to elements/decodeElementsJets.inc

@@ -1,9 +1,9 @@
 /* This module defines primitives and jets that are specific to the Elements application for Simplicity.
  */
-#ifndef SIMPLICITY_PRIMITIVE_ELEMENTS_JETS_H
-#define SIMPLICITY_PRIMITIVE_ELEMENTS_JETS_H
+#ifndef SIMPLICITY_ELEMENTS_ELEMENTSJETS_H
+#define SIMPLICITY_ELEMENTS_ELEMENTSJETS_H
 
-#include "../../jets.h"
+#include "../jets.h"
 
 /* Jets for the Elements application of Simplicity. */
 bool simplicity_version(frameItem* dst, frameItem src, const txEnv* env);