0.0.35

Fix error message, for most IDEs recognises as URI to file row and column

cli.js

@@ -34,8 +34,16 @@ const argv = require("yargs")
     .alias("o", "output")
     .help("h")
     .alias("h", "help")
-    .alias("v", "verbose")
-    .alias("f", "fast")
+    .option("verbose", {
+        alias: "v",
+        type: "boolean",
+        description: "Run with verbose logging"
+    })
+    .option("fast", {
+        alias: "f",
+        type: "boolean",
+        description: "Do not optimize constraints"
+    })
     .epilogue(`Copyright (C) 2018  0kims association
     This program comes with ABSOLUTELY NO WARRANTY;
     This is free software, and you are welcome to redistribute it
@@ -57,7 +65,7 @@ if (argv._.length == 0) {
 const fullFileName = path.resolve(process.cwd(), inputFile);
 const outName = argv.output ?  argv.output : "circuit.json";
 
-compiler(fullFileName, {reduceConstraints: !argv.fast}).then( (cir) => {
+compiler(fullFileName, {reduceConstraints: !argv.fast, verbose: argv.verbose}).then( (cir) => {
     fs.writeFileSync(outName, JSON.stringify(cir, null, 1), "utf8");
     process.exit(0);
 }, (err) => {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "circom",
-  "version": "0.0.31",
+  "version": "0.0.35",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "circom",
-  "version": "0.0.31",
+  "version": "0.0.35",
   "description": "Language to generate logic circuits",
   "main": "index.js",
   "directories": {

src/compiler.js

@@ -65,7 +65,8 @@ async function compile(srcFile, options) {
         functions: {},
         functionParams: {},
         filePath: fullFilePath,
-        fileName: fullFileName
+        fileName: fullFileName,
+        verbose: options.verbose || false
     };
 
 
@@ -75,8 +76,10 @@ async function compile(srcFile, options) {
         throw new Error("A main component must be defined");
     }
 
+    if (ctx.verbose) console.log("Classify Signals");
     classifySignals(ctx);
 
+    if (ctx.verbose) console.log("Reduce Constraints");
     reduceConstants(ctx);
     if (options.reduceConstraints) {
 
@@ -217,6 +220,7 @@ function generateWitnessNames(ctx) {
 function reduceConstants(ctx) {
     const newConstraints = [];
     for (let i=0; i<ctx.constraints.length; i++) {
+        if ((ctx.verbose)&&(i%10000 == 0)) console.log("reducing constants: ", i);
         const c = lc.canonize(ctx, ctx.constraints[i]);
         if (!lc.isZero(c)) {
             newConstraints.push(c);
@@ -226,8 +230,13 @@ function reduceConstants(ctx) {
 }
 
 function reduceConstrains(ctx) {
-    const newConstraints = [];
-    for (let i=0; i<ctx.constraints.length; i++) {
+    indexVariables();
+    let possibleConstraints = Object.keys(ctx.constraints);
+    while (possibleConstraints.length>0) {
+        let nextPossibleConstraints = {};
+        for (let i in possibleConstraints) {
+            if ((ctx.verbose)&&(i%10000 == 0)) console.log("reducing constraints: ", i);
+            if (!ctx.constraints[i]) continue;
             const c = ctx.constraints[i];
 
             // Swap a and b if b has more variables.
@@ -254,6 +263,13 @@ function reduceConstrains(ctx) {
             if (lc.isZero(c.a) || lc.isZero(c.b)) {
                 const isolatedSignal = getFirstInternalSignal(ctx, c.c);
                 if (isolatedSignal) {
+
+                    let lSignal = ctx.signals[isolatedSignal];
+                    while (lSignal.equivalence) {
+                        lSignal = ctx.signals[lSignal.equivalence];
+                    }
+
+
                     const isolatedSignalEquivalence = {
                         type: "LINEARCOMBINATION",
                         values: {}
@@ -268,24 +284,81 @@ function reduceConstrains(ctx) {
                         }
                     }
 
-                for (let j=0; j<newConstraints.length; j++) {
-                    newConstraints[j] = lc.substitute(newConstraints[j], isolatedSignal, isolatedSignalEquivalence);
-                }
-                for (let j=i+1; j<ctx.constraints.length; j++ ) {
+                    for (let j in lSignal.inConstraints) {
+                        if ((j!=i)&&(ctx.constraints[j])) {
                             ctx.constraints[j] = lc.substitute(ctx.constraints[j], isolatedSignal, isolatedSignalEquivalence);
+                            linkSignalsConstraint(j);
+                            if (j<i) {
+                                nextPossibleConstraints[j] = true;
                             }
-                c.a={ type: "LINEARCOMBINATION", values: {} };
-                c.b={ type: "LINEARCOMBINATION", values: {} };
-                c.c={ type: "LINEARCOMBINATION", values: {} };
-                isolatedSignal.category = "constant";
                         }
                     }
 
-        if (!lc.isZero(c)) {
-            newConstraints.push(c);
+                    ctx.constraints[i] = null;
+
+                    lSignal.category = "constant";
+                } else {
+                    if (lc.isZero(c.c)) ctx.constraints[i] = null;
                 }
             }
-    ctx.constraints = newConstraints;
+        }
+        possibleConstraints = Object.keys(nextPossibleConstraints);
+    }
+    unindexVariables();
+
+    // Pack the constraints
+    let o = 0;
+    for (let i=0; i<ctx.constraints.length; i++) {
+        if (ctx.constraints[i]) {
+            if (o != i) {
+                ctx.constraints[o] = ctx.constraints[i];
+            }
+            o++;
+        }
+    }
+    ctx.constraints.length = o;
+
+    function indexVariables() {
+        for (let i=0; i<ctx.constraints.length; i++) linkSignalsConstraint(i);
+    }
+
+    function linkSignalsConstraint(cidx) {
+        const ct = ctx.constraints[cidx];
+        for (let k in ct.a.values) linkSignal(k, cidx);
+        for (let k in ct.b.values) linkSignal(k, cidx);
+        for (let k in ct.c.values) linkSignal(k, cidx);
+    }
+
+    function unindexVariables() {
+        for (let s in ctx.signals) {
+            let lSignal = ctx.signals[s];
+            while (lSignal.equivalence) {
+                lSignal = ctx.signals[lSignal.equivalence];
+            }
+            if (lSignal.inConstraints) delete lSignal.inConstraints;
+        }
+    }
+
+/*
+    function unlinkSignal(signalName, cidx) {
+        let lSignal = ctx.signals[signalName];
+        while (lSignal.equivalence) {
+            lSignal = ctx.signals[lSignal.equivalence];
+        }
+        if ((lSignal.inConstraints)&&(lSignal.inConstraints[cidx])) {
+            delete lSignal.inConstraints[cidx];
+        }
+    }
+*/
+
+    function linkSignal(signalName, cidx) {
+        let lSignal = ctx.signals[signalName];
+        while (lSignal.equivalence) {
+            lSignal = ctx.signals[lSignal.equivalence];
+        }
+        if (!lSignal.inConstraints) lSignal.inConstraints = {};
+        lSignal.inConstraints[cidx] = true;
+    }
 
     function getFirstInternalSignal(ctx, l) {
         for (let k in l.values) {

src/exec.js

@@ -181,24 +181,6 @@ function iterateSelectors(ctx, sizes, baseName, fn) {
     return res;
 }
 
-function setScope(ctx, name, selectors, value) {
-    let l = getScopeLevel(ctx, name);
-    if (l==-1) l= ctx.scopes.length-1;
-
-    if (selectors.length == 0) {
-        ctx.scopes[l][name] = value;
-    } else {
-        setScopeArray(ctx.scopes[l][name], selectors);
-    }
-
-    function setScopeArray(a, sels) {
-        if (sels.length == 1) {
-            a[sels[0].value] = value;
-        } else {
-            setScopeArray(a[sels[0]], sels.slice(1));
-        }
-    }
-}
 
 function getScope(ctx, name, selectors) {
 
@@ -221,11 +203,57 @@ function getScope(ctx, name, selectors) {
     }
 
     for (let i=ctx.scopes.length-1; i>=0; i--) {
-        if (ctx.scopes[i][name]) return select(ctx.scopes[i][name], sels);
+        if (ctx.scopes[i][name]) return select(ctx.scopes[i][name].value, sels);
     }
     return null;
 }
 
+function getScopeRef(ctx, name, selectors) {
+
+    const sels = [];
+    if (selectors) {
+        for (let i=0; i< selectors.length; i++) {
+            const idx = exec(ctx, selectors[i]);
+            if (ctx.error) return;
+
+            if (idx.type != "NUMBER") return error(ctx, selectors[i], "expected a number");
+            sels.push( idx.value.toJSNumber() );
+        }
+    }
+
+
+    function select(v, s, t) {
+        s = s || [];
+        if (s.length == 0)  return [v, sels, t];
+        return select(v[s[0]], s.slice(1), t);
+    }
+
+    for (let i=ctx.scopes.length-1; i>=0; i--) {
+        if (ctx.scopes[i][name]) return select(ctx.scopes[i][name].value, sels, ctx.scopes[i][name].type);
+    }
+    return [null, [], ""];
+}
+
+
+function setScopeRef(ctx, name, sels, value) {
+    let l = getScopeLevel(ctx, name);
+    if (l==-1) l= ctx.scopes.length-1;
+
+    if (sels.length == 0) {
+        ctx.scopes[l][name].value = value;
+    } else {
+        setScopeArray(ctx.scopes[l][name].value, sels);
+    }
+
+    function setScopeArray(a, sels) {
+        if (sels.length == 1) {
+            a[sels[0]] = value;
+        } else {
+            setScopeArray(a[sels[0]], sels.slice(1));
+        }
+    }
+}
+
 function getScopeLevel(ctx, name) {
     for (let i=ctx.scopes.length-1; i>=0; i--) {
         if (ctx.scopes[i][name]) return i;
@@ -248,12 +276,15 @@ function execTemplateDef(ctx, ast) {
         return error(ctx, ast, "Name already exists: "+ast.name);
     }
     scope[ast.name] = {
+        type: "TEMPLATE",
+        value: {
             type: "TEMPLATE",
             params: ast.params,
             block: ast.block,
             fileName: ctx.fileName,
             filePath: ctx.filePath,
             scopes: copyScope(ctx.scopes)
+        }
     };
 }
 
@@ -265,12 +296,15 @@ function execFunctionDef(ctx, ast) {
     }
     ctx.functionParams[ast.name] = ast.params;
     scope[ast.name] = {
+        type: "FUNCTION",
+        value: {
             type: "FUNCTION",
             params: ast.params,
             block: ast.block,
             fileName: ctx.fileName,
             filePath: ctx.filePath,
             scopes: copyScope(ctx.scopes)
+        }
     };
 }
 
@@ -294,7 +328,9 @@ function execDeclareComponent(ctx, ast) {
     }
 
 
-    scope[ast.name.name] = iterateSelectors(ctx, sizes, baseName, function(fullName) {
+    scope[ast.name.name] = {
+        type: "COMPONENT",
+        value: iterateSelectors(ctx, sizes, baseName, function(fullName) {
 
             ctx.components[fullName] = "UNINSTANTIATED";
 
@@ -302,7 +338,8 @@ function execDeclareComponent(ctx, ast) {
                 type: "COMPONENT",
                 fullName: fullName
             };
-    });
+        })
+    };
 
     return {
         type: "VARIABLE",
@@ -378,7 +415,10 @@ function execInstantiateComponet(ctx, vr, fn) {
 
         const scope = {};
         for (let i=0; i< template.params.length; i++) {
-            scope[template.params[i]] = paramValues[i];
+            scope[template.params[i]] = {
+                type: "VARIABLE",
+                value: paramValues[i]
+            };
             ctx.components[ctx.currentComponent].params[template.params[i]] = extractValue(paramValues[i]);
         }
 
@@ -430,7 +470,10 @@ function execFunctionCall(ctx, ast) {
 
     const scope = {};
     for (let i=0; i< fnc.params.length; i++) {
-        scope[fnc.params[i]] = paramValues[i];
+        scope[fnc.params[i]] = {
+            type: "VARIABLE",
+            value: paramValues[i]
+        };
     }
 
     ctx.fileName = fnc.fileName;
@@ -472,7 +515,9 @@ function execDeclareSignal(ctx, ast) {
         sizes.push( size.value.toJSNumber() );
     }
 
-    scope[ast.name.name] = iterateSelectors(ctx, sizes, baseName, function(fullName) {
+    scope[ast.name.name] = {
+        type: "SIGNAL",
+        value: iterateSelectors(ctx, sizes, baseName, function(fullName) {
             ctx.signals[fullName] = {
                 fullName: fullName,
                 direction: ast.declareType == "SIGNALIN" ? "IN" : (ast.declareType == "SIGNALOUT" ? "OUT" : ""),
@@ -486,7 +531,8 @@ function execDeclareSignal(ctx, ast) {
                 type: "SIGNAL",
                 fullName: fullName,
             };
-    });
+        })
+    };
     return {
         type: "VARIABLE",
         name: ast.name.name,
@@ -509,12 +555,15 @@ function execDeclareVariable(ctx, ast) {
         sizes.push( size.value.toJSNumber() );
     }
 
-    scope[ast.name.name] = iterateSelectors(ctx, sizes, "", function() {
+    scope[ast.name.name] = {
+        type: "VARIABLE",
+        value: iterateSelectors(ctx, sizes, "", function() {
             return {
                 type: "NUMBER",
                 value: bigInt(0)
             };
-    });
+        })
+    };
 
     return {
         type: "VARIABLE",
@@ -631,19 +680,20 @@ function execVarAssignement(ctx, ast) {
     } else {
         v = ast.values[0];
     }
-    const num = getScope(ctx, v.name, v.selectors);
+    const [num, sels, typ] = getScopeRef(ctx, v.name, v.selectors);
     if (ctx.error) return;
 
     if ((typeof(num) != "object")||(num == null)) return  error(ctx, ast, "Variable not defined");
 
-    if (num.type == "COMPONENT") return execInstantiateComponet(ctx, v, ast.values[1]);
+    if (typ == "COMPONENT") return execInstantiateComponet(ctx, v, ast.values[1]);
     if (ctx.error) return;
-//    if (num.type == "SIGNAL") return error(ctx, ast, "Cannot assign to a signal with `=` use <-- or <== ops");
+    if ((typ == "SIGNAL")&&(ast.op == "=")) return error(ctx, ast, "Cannot assign to a signal with `=` use <-- or <== ops");
+    if ((["NUMBER", "COMPONENT"].indexOf(typ) >= 0 )&&(ast.op != "=")) return error(ctx, ast, `Cannot assign to a var with ${ast.op}. use = op`);
 
     const res = exec(ctx, ast.values[1]);
     if (ctx.error) return;
 
-    setScope(ctx, v.name, v.selectors, res);
+    setScopeRef(ctx, v.name, sels, res);
 
     return v;
 }
@@ -915,13 +965,13 @@ function execMul(ctx, ast) {
 function execVarAddAssignement(ctx, ast) {
     const res = execAdd(ctx,{ values: [ast.values[0], ast.values[1]] } );
     if (ctx.error) return;
-    return execVarAssignement(ctx, { values: [ast.values[0], res] });
+    return execVarAssignement(ctx, { op:"=", values: [ast.values[0], res] });
 }
 
 function execVarMulAssignement(ctx, ast) {
     const res = execMul(ctx,{ values: [ast.values[0], ast.values[1]] } );
     if (ctx.error) return;
-    return execVarAssignement(ctx, { values: [ast.values[0], res] });
+    return execVarAssignement(ctx, { op:"=", values: [ast.values[0], res] });
 }
 
 function execPlusPlusRight(ctx, ast) {
@@ -929,7 +979,7 @@ function execPlusPlusRight(ctx, ast) {
     if (ctx.error) return;
     const resAfter = execAdd(ctx,{ values: [ast.values[0], {type: "NUMBER", value: bigInt(1)}] } );
     if (ctx.error) return;
-    execVarAssignement(ctx, { values: [ast.values[0], resAfter] });
+    execVarAssignement(ctx, { op:"=", values: [ast.values[0], resAfter] });
     return resBefore;
 }
 
@@ -937,7 +987,7 @@ function execPlusPlusLeft(ctx, ast) {
     if (ctx.error) return;
     const resAfter = execAdd(ctx,{ values: [ast.values[0], {type: "NUMBER", value: bigInt(1)}] } );
     if (ctx.error) return;
-    execVarAssignement(ctx, { values: [ast.values[0], resAfter] });
+    execVarAssignement(ctx, { op:"=", values: [ast.values[0], resAfter] });
     return resAfter;
 }
 
@@ -946,7 +996,7 @@ function execMinusMinusRight(ctx, ast) {
     if (ctx.error) return;
     const resAfter = execSub(ctx,{ values: [ast.values[0], {type: "NUMBER", value: bigInt(1)}] } );
     if (ctx.error) return;
-    execVarAssignement(ctx, { values: [ast.values[0], resAfter] });
+    execVarAssignement(ctx, { op:"=", values: [ast.values[0], resAfter] });
     return resBefore;
 }
 
@@ -954,7 +1004,7 @@ function execMinusMinusLeft(ctx, ast) {
     if (ctx.error) return;
     const resAfter = execSub(ctx,{ values: [ast.values[0], {type: "NUMBER", value: bigInt(1)}] } );
     if (ctx.error) return;
-    execVarAssignement(ctx, { values: [ast.values[0], resAfter] });
+    execVarAssignement(ctx, { op:"=", values: [ast.values[0], resAfter] });
     return resAfter;
 }
 
@@ -996,7 +1046,12 @@ function execSignalAssign(ctx, ast) {
 
     let sDest=ctx.signals[dst.fullName];
     if (!sDest) return error(ctx, ast, "Invalid signal: "+dst.fullName);
-    while (sDest.equivalence) sDest=ctx.signals[sDest.equivalence];
+
+    let isOut = (sDest.component == "main")&&(sDest.direction=="OUT");
+    while (sDest.equivalence) {
+        sDest=ctx.signals[sDest.equivalence];
+        isOut = isOut || ((sDest.component == "main")&&(sDest.direction=="OUT"));
+    }
 
     if (sDest.value) return error(ctx, ast, "Signals cannot be assigned twice");
 
@@ -1024,11 +1079,21 @@ function execSignalAssign(ctx, ast) {
 
     let assignValue = true;
     if (src.type == "SIGNAL") {
+        let sSrc = ctx.signals[src.fullName];
+        let isIn  = (sSrc.component == "main")&&(sSrc.direction == "IN");
+        while (sSrc.equivalence) {
+            sSrc=ctx.signals[sSrc.equivalence];
+            isIn = isIn || ((sSrc.component == "main")&&(sSrc.direction == "IN"));
+        }
+
+        // Skip if an out is assigned directly to an input.
+        if ((!isIn)||(!isOut)) {
             sDest.equivalence = src.fullName;
             sDest.alias = sDest.alias.concat(src.alias);
             while (sDest.equivalence) sDest=ctx.signals[sDest.equivalence];
             assignValue = false;
         }
+    }
 
     if (assignValue) {
         //        const resLC = exec(ctx, vSrc);
@@ -1046,6 +1111,8 @@ function execSignalAssign(ctx, ast) {
 }
 
 function execConstrain(ctx, ast) {
+    ast.fileName = ctx.fileName;
+    ast.filePath = ctx.filePath;
     const a = exec(ctx, ast.values[0]);
     if (ctx.error) return;
     const b = exec(ctx, ast.values[1]);
@@ -1058,6 +1125,8 @@ function execConstrain(ctx, ast) {
         ctx.constraints.push(lc.toQEQ(res));
     }
 
+    if (ctx.constraints.length % 10000 == 0) console.log("Constraints: " + ctx.constraints.length);
+
     return res;
 }
 

src/gencode.js

@@ -422,11 +422,13 @@ function genConstrain(ctx, ast) {
     if (ctx.error) return;
     const b = gen(ctx, ast.values[1]);
     if (ctx.error) return;
-    return `ctx.assert(${a}, ${b})`;
+    const strErr = ast.fileName + ":" + ast.first_line + ":" + ast.first_column;
+    return `ctx.assert(${a}, ${b}, \"${strErr}\")`;
 }
 
 function genSignalAssignConstrain(ctx, ast) {
-    return genVarAssignement(ctx, ast) + ";\n" + genConstrain(ctx, ast);
+//    return genVarAssignement(ctx, ast) + ";\n" + genConstrain(ctx, ast);
+    return genVarAssignement(ctx, ast);
 }
 
 function genVarAddAssignement(ctx, ast) {

test/cases.js

@@ -59,4 +59,9 @@ describe("Sum test", () => {
         assert(witness[1].equals(bigInt(37)));
         assert(witness[2].equals(bigInt(6)));
     });
+    it("Should compile a code with compute", async () => {
+        const cirDef = await compiler(path.join(__dirname, "circuits", "inout.circom"));
+
+        assert.equal(cirDef.constraints.length, 1);
+    });
 });

test/circuits/inout.circom

@@ -0,0 +1,18 @@
+template Internal() {
+    signal input in;
+    signal output out;
+
+    out <== in;
+}
+
+template InOut() {
+    signal input in;
+    signal output out;
+
+    component internal = Internal();
+
+    internal.in <== in;
+    internal.out ==> out;
+}
+
+component main = InOut();