Skip to content

Commit

Permalink
pr review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@martyall
martyall committed Aug 2, 2024
1 parent 957baef commit b64ee51
Show file tree
Hide file tree
Showing 2 changed files with 304 additions and 310 deletions.
306 changes: 156 additions & 150 deletions build/main.cjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,165 +80,154 @@ function toArray32(s,size) {

/* globals WebAssembly */

async function builder(code, options) {
let instance;

async function createWASMInstance(wasmSource, options) {

let memorySize = 32767;
let memory;
let memoryAllocated = false;
while (!memoryAllocated){
try{
memory = new WebAssembly.Memory({initial:memorySize});
memoryAllocated = true;
} catch(err){
if(memorySize === 1){
throw err;
}
console.warn("Could not allocate " + memorySize * 1024 * 64 + " bytes. This may cause severe instability. Trying with " + memorySize * 1024 * 64 / 2 + " bytes");
memorySize = Math.floor(memorySize/2);
}
}
// Only circom 2 implements version lookup through exports in the WASM
// We default to `1` and update if we see the `getVersion` export (major version)
// These are updated after the instance is instantiated, assuming the functions are available
let majorVersion = 1;
// After Circom 2.0.7, Blaine added exported functions for getting minor and patch versions
let minorVersion = 0;
// If we can't lookup the patch version, assume the lowest
let patchVersion = 0;

const wasmModule = await WebAssembly.compile(wasmSource);

let errStr = "";
let msgStr = "";

let importsObject = {
env: {
"memory": memory
},
runtime: {
exceptionHandler: function(code) {
let err;
if (code == 1) {
err = "Signal not found. ";
} else if (code == 2) {
err = "Too many signals set. ";
} else if (code == 3) {
err = "Signal already set. ";
} else if (code == 4) {
err = "Assert Failed. ";
} else if (code == 5) {
err = "Not enough memory. ";
} else if (code == 6) {
err = "Input signal array access exceeds the size. ";
} else {
err = "Unknown error. ";
}
console.error("ERROR: ", code, errStr);
throw new Error(err + errStr);
},
// A new way of logging messages was added in Circom 2.0.7 that requires 2 new imports
// `printErrorMessage` and `writeBufferMessage`.
printErrorMessage: function() {
errStr += getMessage() + "\n";
},
writeBufferMessage: function() {
const msg = getMessage();
// Any calls to `log()` will always end with a `\n`, so that's when we print and reset
if (msg === "\n") {
console.log(msgStr);
msgStr = "";
} else {
// If we've buffered other content, put a space in between the items
if (msgStr !== "") {
msgStr += " ";
}
// Then append the message to the message we are creating
msgStr += msg;
}
},
showSharedRWMemory: function() {
const shared_rw_memory_size = instance.exports.getFieldNumLen32();
const arr = new Uint32Array(shared_rw_memory_size);
for (let j=0; j<shared_rw_memory_size; j++) {
arr[shared_rw_memory_size-1-j] = instance.exports.readSharedRWMemory(j);
}
let wc;

// In circom 2.0.7, they changed the log() function to allow strings and changed the
// output API. This smoothes over the breaking change.
{
console.log(ffjavascript.Scalar.fromArray(arr, 0x100000000));
}
},
error: function(code, pstr, a,b,c,d) {
let errStr;
if (code == 7) {
errStr=p2str(pstr) + " " + wc.getFr(b).toString() + " != " + wc.getFr(c).toString() + " " +p2str(d);
} else if (code == 9) {
errStr=p2str(pstr) + " " + wc.getFr(b).toString() + " " +p2str(c);
} else if ((code == 5)&&(options.sym)) {
errStr=p2str(pstr)+ " " + options.sym.labelIdx2Name[c];
} else {
errStr=p2str(pstr)+ " " + a + " " + b + " " + c + " " + d;
}
console.log("ERROR: ", code, errStr);
throw new Error(errStr);
},
log: function(a) {
console.log(wc.getFr(a).toString());
},
logGetSignal: function(signal, pVal) {
if (options.logGetSignal) {
options.logGetSignal(signal, wc.getFr(pVal) );
}
},
logSetSignal: function(signal, pVal) {
if (options.logSetSignal) {
options.logSetSignal(signal, wc.getFr(pVal) );
}
},
logStartComponent: function(cIdx) {
if (options.logStartComponent) {
options.logStartComponent(cIdx);
}
},
logFinishComponent: function(cIdx) {
if (options.logFinishComponent) {
options.logFinishComponent(cIdx);

if (code instanceof WebAssembly.Instance) {
instance = code;
} else {
options = options || {};

let memorySize = 32767;
let memory;
let memoryAllocated = false;
while (!memoryAllocated){
try{
memory = new WebAssembly.Memory({initial:memorySize});
memoryAllocated = true;
} catch(err){
if(memorySize === 1){
throw err;
}
console.warn("Could not allocate " + memorySize * 1024 * 64 + " bytes. This may cause severe instability. Trying with " + memorySize * 1024 * 64 / 2 + " bytes");
memorySize = Math.floor(memorySize/2);
}
}
};

WebAssembly.instantiate(wasmModule, importsObject);
const wasmModule = await WebAssembly.compile(code);

return wasmModule;
let wc;

function getMessage() {
var message = "";
var c = instance.exports.getMessageChar();
while ( c != 0 ) {
message += String.fromCharCode(c);
c = instance.exports.getMessageChar();
}
return message;
}

function p2str(p) {
const i8 = new Uint8Array(memory.buffer);
let errStr = "";
let msgStr = "";

const bytes = [];

for (let i=0; i8[p+i]>0; i++) bytes.push(i8[p+i]);

return String.fromCharCode.apply(null, bytes);
}

}
async function builder(codeOrWasmInstance, options) {

options = options || {};

let instance;
instance = await WebAssembly.instantiate(wasmModule, {
env: {
"memory": memory
},
runtime: {
exceptionHandler: function(code) {
let err;
if (code == 1) {
err = "Signal not found. ";
} else if (code == 2) {
err = "Too many signals set. ";
} else if (code == 3) {
err = "Signal already set. ";
} else if (code == 4) {
err = "Assert Failed. ";
} else if (code == 5) {
err = "Not enough memory. ";
} else if (code == 6) {
err = "Input signal array access exceeds the size. ";
} else {
err = "Unknown error. ";
}
console.error("ERROR: ", code, errStr);
throw new Error(err + errStr);
},
// A new way of logging messages was added in Circom 2.0.7 that requires 2 new imports
// `printErrorMessage` and `writeBufferMessage`.
printErrorMessage: function() {
errStr += getMessage() + "\n";
},
writeBufferMessage: function() {
const msg = getMessage();
// Any calls to `log()` will always end with a `\n`, so that's when we print and reset
if (msg === "\n") {
console.log(msgStr);
msgStr = "";
} else {
// If we've buffered other content, put a space in between the items
if (msgStr !== "") {
msgStr += " ";
}
// Then append the message to the message we are creating
msgStr += msg;
}
},
showSharedRWMemory: function() {
const shared_rw_memory_size = instance.exports.getFieldNumLen32();
const arr = new Uint32Array(shared_rw_memory_size);
for (let j=0; j<shared_rw_memory_size; j++) {
arr[shared_rw_memory_size-1-j] = instance.exports.readSharedRWMemory(j);
}

// In the event that you are running witness generation multiple times, it's
// better to reuse an existing wasm instance.
if (codeOrWasmInstance instanceof WebAssembly.Instance) {
instance = codeOrWasmInstance;
} else {
instance = await createWASMInstance(codeOrWasm, options);
// In circom 2.0.7, they changed the log() function to allow strings and changed the
// output API. This smoothes over the breaking change.
if (majorVersion >= 2 && (minorVersion >= 1 || patchVersion >= 7)) {
// If we've buffered other content, put a space in between the items
if (msgStr !== "") {
msgStr += " ";
}
// Then append the value to the message we are creating
const msg = (ffjavascript.Scalar.fromArray(arr, 0x100000000).toString());
msgStr += msg;
} else {
console.log(ffjavascript.Scalar.fromArray(arr, 0x100000000));
}
},
error: function(code, pstr, a,b,c,d) {
let errStr;
if (code == 7) {
errStr=p2str(pstr) + " " + wc.getFr(b).toString() + " != " + wc.getFr(c).toString() + " " +p2str(d);
} else if (code == 9) {
errStr=p2str(pstr) + " " + wc.getFr(b).toString() + " " +p2str(c);
} else if ((code == 5)&&(options.sym)) {
errStr=p2str(pstr)+ " " + options.sym.labelIdx2Name[c];
} else {
errStr=p2str(pstr)+ " " + a + " " + b + " " + c + " " + d;
}
console.log("ERROR: ", code, errStr);
throw new Error(errStr);
},
log: function(a) {
console.log(wc.getFr(a).toString());
},
logGetSignal: function(signal, pVal) {
if (options.logGetSignal) {
options.logGetSignal(signal, wc.getFr(pVal) );
}
},
logSetSignal: function(signal, pVal) {
if (options.logSetSignal) {
options.logSetSignal(signal, wc.getFr(pVal) );
}
},
logStartComponent: function(cIdx) {
if (options.logStartComponent) {
options.logStartComponent(cIdx);
}
},
logFinishComponent: function(cIdx) {
if (options.logFinishComponent) {
options.logFinishComponent(cIdx);
}
}
}
});
}

if (typeof instance.exports.getVersion == 'function') {
Expand All @@ -261,8 +250,6 @@ async function builder(codeOrWasmInstance, options) {
options.logFinishComponent
);

let wc;

// We explicitly check for major version 2 in case there's a circom v3 in the future
if (majorVersion === 2) {
wc = new WitnessCalculatorCircom2(instance, sanityCheck);
Expand All @@ -272,6 +259,25 @@ async function builder(codeOrWasmInstance, options) {
}
return wc;

function getMessage() {
var message = "";
var c = instance.exports.getMessageChar();
while ( c != 0 ) {
message += String.fromCharCode(c);
c = instance.exports.getMessageChar();
}
return message;
}

function p2str(p) {
const i8 = new Uint8Array(memory.buffer);

const bytes = [];

for (let i=0; i8[p+i]>0; i++) bytes.push(i8[p+i]);

return String.fromCharCode.apply(null, bytes);
}
}
class WitnessCalculatorCircom1 {
constructor(memory, instance, sanityCheck) {
Expand Down
Loading

0 comments on commit b64ee51

Please sign in to comment.