Skip to content

Commit

Permalink
Migrated z3 to the browser
Browse files Browse the repository at this point in the history
  • Loading branch information
soaibsafi committed Jun 8, 2024
1 parent c6965c5 commit 0b1c6d9
Show file tree
Hide file tree
Showing 8 changed files with 14,984 additions and 24 deletions.
4 changes: 4 additions & 0 deletions frontend/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
<meta charset="UTF-8" />
<link rel="icon" type="image/png" href="logo_se.png" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<script src="z3-built.js"></script>
<script>
globalThis.global = { initZ3: globalThis.initZ3 };
</script>
<title>FM Playground</title>
</head>
<body>
Expand Down
14,723 changes: 14,723 additions & 0 deletions frontend/public/z3-built.js

Large diffs are not rendered by default.

Binary file added frontend/public/z3-built.wasm
Binary file not shown.
206 changes: 206 additions & 0 deletions frontend/public/z3-built.worker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
/**
* @license
* Copyright 2015 The Emscripten Authors
* SPDX-License-Identifier: MIT
*/

// Pthread Web Worker startup routine:
// This is the entry point file that is loaded first by each Web Worker
// that executes pthreads on the Emscripten application.

'use strict';

var Module = {};

// Node.js support
var ENVIRONMENT_IS_NODE = typeof process == 'object' && typeof process.versions == 'object' && typeof process.versions.node == 'string';
if (ENVIRONMENT_IS_NODE) {
// Create as web-worker-like an environment as we can.

var nodeWorkerThreads = require('worker_threads');

var parentPort = nodeWorkerThreads.parentPort;

parentPort.on('message', function(data) {
onmessage({ data: data });
});

var fs = require('fs');

Object.assign(global, {
self: global,
require: require,
Module: Module,
location: {
href: __filename
},
Worker: nodeWorkerThreads.Worker,
importScripts: function(f) {
(0, eval)(fs.readFileSync(f, 'utf8'));
},
postMessage: function(msg) {
parentPort.postMessage(msg);
},
performance: global.performance || {
now: function() {
return Date.now();
}
},
});
}

// Thread-local guard variable for one-time init of the JS state
var initializedJS = false;

// Proxying queues that were notified before the thread started and need to be
// executed as part of startup.
var pendingNotifiedProxyingQueues = [];

function assert(condition, text) {
if (!condition) abort('Assertion failed: ' + text);
}

function threadPrintErr() {
var text = Array.prototype.slice.call(arguments).join(' ');
// See https://github.com/emscripten-core/emscripten/issues/14804
if (ENVIRONMENT_IS_NODE) {
fs.writeSync(2, text + '\n');
return;
}
console.error(text);
}
function threadAlert() {
var text = Array.prototype.slice.call(arguments).join(' ');
postMessage({cmd: 'alert', text: text, threadId: Module['_pthread_self']()});
}
// We don't need out() for now, but may need to add it if we want to use it
// here. Or, if this code all moves into the main JS, that problem will go
// away. (For now, adding it here increases code size for no benefit.)
var out = () => { throw 'out() is not defined in worker.js.'; }
var err = threadPrintErr;
self.alert = threadAlert;

Module['instantiateWasm'] = (info, receiveInstance) => {
// Instantiate from the module posted from the main thread.
// We can just use sync instantiation in the worker.
var instance = new WebAssembly.Instance(Module['wasmModule'], info);
// TODO: Due to Closure regression https://github.com/google/closure-compiler/issues/3193,
// the above line no longer optimizes out down to the following line.
// When the regression is fixed, we can remove this if/else.
receiveInstance(instance);
// We don't need the module anymore; new threads will be spawned from the main thread.
Module['wasmModule'] = null;
return instance.exports;
}

self.onmessage = (e) => {
try {
if (e.data.cmd === 'load') { // Preload command that is called once per worker to parse and load the Emscripten code.

// Module and memory were sent from main thread
Module['wasmModule'] = e.data.wasmModule;

Module['wasmMemory'] = e.data.wasmMemory;

Module['buffer'] = Module['wasmMemory'].buffer;

Module['ENVIRONMENT_IS_PTHREAD'] = true;

if (typeof e.data.urlOrBlob == 'string') {
importScripts(e.data.urlOrBlob);
} else {
var objectUrl = URL.createObjectURL(e.data.urlOrBlob);
importScripts(objectUrl);
URL.revokeObjectURL(objectUrl);
}
initZ3(Module).then(function (instance) {
Module = instance;
});
} else if (e.data.cmd === 'run') {
// This worker was idle, and now should start executing its pthread entry
// point.
// performance.now() is specced to return a wallclock time in msecs since
// that Web Worker/main thread launched. However for pthreads this can
// cause subtle problems in emscripten_get_now() as this essentially
// would measure time from pthread_create(), meaning that the clocks
// between each threads would be wildly out of sync. Therefore sync all
// pthreads to the clock on the main browser thread, so that different
// threads see a somewhat coherent clock across each of them
// (+/- 0.1msecs in testing).
Module['__performance_now_clock_drift'] = performance.now() - e.data.time;

// Pass the thread address inside the asm.js scope to store it for fast access that avoids the need for a FFI out.
Module['__emscripten_thread_init'](e.data.threadInfoStruct, /*isMainBrowserThread=*/0, /*isMainRuntimeThread=*/0, /*canBlock=*/1);

assert(e.data.threadInfoStruct);
// Also call inside JS module to set up the stack frame for this pthread in JS module scope
Module['establishStackSpace']();
Module['PThread'].receiveObjectTransfer(e.data);
Module['PThread'].threadInitTLS();

if (!initializedJS) {

// Execute any proxied work that came in before the thread was
// initialized. Only do this once because it is only possible for
// proxying notifications to arrive before thread initialization on
// fresh workers.
pendingNotifiedProxyingQueues.forEach(queue => {
Module['executeNotifiedProxyingQueue'](queue);
});
pendingNotifiedProxyingQueues = [];
initializedJS = true;
}

try {
Module['invokeEntryPoint'](e.data.start_routine, e.data.arg);
} catch(ex) {
if (ex != 'unwind') {
// ExitStatus not present in MINIMAL_RUNTIME
if (ex instanceof Module['ExitStatus']) {
if (Module['keepRuntimeAlive']()) {
err('Pthread 0x' + Module['_pthread_self']().toString(16) + ' called exit(), staying alive due to noExitRuntime.');
} else {
err('Pthread 0x' + Module['_pthread_self']().toString(16) + ' called exit(), calling _emscripten_thread_exit.');
Module['__emscripten_thread_exit'](ex.status);
}
}
else
{
// The pthread "crashed". Do not call `_emscripten_thread_exit` (which
// would make this thread joinable. Instead, re-throw the exception
// and let the top level handler propagate it back to the main thread.
throw ex;
}
} else {
// else e == 'unwind', and we should fall through here and keep the pthread alive for asynchronous events.
err('Pthread 0x' + Module['_pthread_self']().toString(16) + ' completed its main entry point with an `unwind`, keeping the worker alive for asynchronous operation.');
}
}
} else if (e.data.cmd === 'cancel') { // Main thread is asking for a pthread_cancel() on this thread.
if (Module['_pthread_self']()) {
Module['__emscripten_thread_exit'](-1/*PTHREAD_CANCELED*/);
}
} else if (e.data.target === 'setimmediate') {
// no-op
} else if (e.data.cmd === 'processProxyingQueue') {
if (initializedJS) {
Module['executeNotifiedProxyingQueue'](e.data.queue);
} else {
// Defer executing this queue until the runtime is initialized.
pendingNotifiedProxyingQueues.push(e.data.queue);
}
} else {
err('worker.js received unknown command ' + e.data.cmd);
err(e.data);
}
} catch(ex) {
err('worker.js onmessage() captured an uncaught exception: ' + ex);
if (ex && ex.stack) err(ex.stack);
if (Module['__emscripten_thread_crashed']) {
Module['__emscripten_thread_crashed']();
}
throw ex;
}
};


9 changes: 0 additions & 9 deletions frontend/src/assets/js/runZ3.js

This file was deleted.

26 changes: 26 additions & 0 deletions frontend/src/assets/js/runZ3WASM.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { init } from "z3-solver"

export default async function runZ3WASM(code) {
const z3p = window.z3Promise || (() => {
console.log("Loading Z3 solver...");
return window.z3Promise = init();
})();
const {Z3} = await z3p;
const cfg = Z3.mk_config();
const ctx = Z3.mk_context(cfg);
Z3.del_config(cfg);

const timeout = 100000;
Z3.global_param_set("timeout", timeout.toString());
let output = "";
let error = "";
try{
output = await Z3.eval_smtlib2_string(ctx, code);
}catch(e){
error = e.toString();
console.error(e);
}finally{
Z3.del_context(ctx);
}
return {output, error};
}
27 changes: 13 additions & 14 deletions frontend/src/components/Playground/Playground.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import FileUploadButton from '../Utils/FileUpload.jsx'
import FileDownload from '../Utils/FileDownload.jsx'
import run_limboole from '../../assets/js/limboole'
import { executeNuxmv, executeZ3, executeSpectra } from '../../api/toolsApi.js'
import runZ3WASM from '../../assets/js/runZ3WASM.js';
import Guides from '../Utils/Guides.jsx';
import CopyToClipboardBtn from '../Utils/CopyToClipboardBtn.jsx';
import ConfirmModal from '../Utils/Modals/ConfirmModal.jsx';
Expand Down Expand Up @@ -157,21 +158,19 @@ const Playground = ({ editorValue, setEditorValue, language, setLanguage, editor
setLineToHighlight(getLineToHighlight(document.getElementById('info').innerText, language.id))
setIsExecuting(false);
} else if (language.value == 3) {
executeZ3(editorValue)
.then((res) => {
setLineToHighlight(getLineToHighlight(res.result, language.id))
setOutput(res.result)
// executeZ3(editorValue)
runZ3WASM(editorValue).then((res) => {
if(res.error) {
showErrorModal(res.error)
}else{
setLineToHighlight(getLineToHighlight(res.output, language.id))
setOutput(res.output);
setIsExecuting(false);
})
.catch((err) => {
if (err.response.status === 503) {
showErrorModal(err.response.data.result)
}
else if (err.response.status === 429) {
showErrorModal("Slow down! You are making too many requests. Please try again later.")
}
setIsExecuting(false);
})
}
}).catch((err) => {
showErrorModal(err.message)
setIsExecuting(false);
})
} else if (language.value == 4) {
executeNuxmv(editorValue)
.then((res) => {
Expand Down
13 changes: 12 additions & 1 deletion frontend/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,18 @@ import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
plugins: [react()],
plugins: [{
// Plugin code is from https://github.com/chaosprint/vite-plugin-cross-origin-isolation
name: "configure-response-headers",
configureServer: (server) => {
server.middlewares.use((_req, res, next) => {
res.setHeader("Cross-Origin-Embedder-Policy", "require-corp");
res.setHeader("Cross-Origin-Opener-Policy", "same-origin");
next();
});
},
},
react()],
build:{
chunkSizeWarningLimit: 1000,
},
Expand Down

0 comments on commit 0b1c6d9

Please sign in to comment.