-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add QuickJS as a Javascript engine option
https://bellard.org/quickjs Some benefits over SM: * Small. We're using 6 or so C files vs 700+ SM91 C++ files. * Built with Apache CouchDB as opposed having to maintain a separate SM package, like for RHEL9, for instance, where they dropped support for SM already. (see #4154). * Embedding friendly. Designed from ground-up for embedding. SM has been updating the C++ API such that we have to keep copy-pasting new versions of our C++ code every year or so. (see #4305). * Easy to modify to accept Spidermonkey 1.8.5 top level functions for map/reduce code so we don't have have to parse the JS, AST transform it, and then re-compile it. * Configurable runtime feature set - can disable workers, promises and other API and features which may not work well in a backend JS environment. Some users may want more, some may want to disable even Date(time) features to hedge again Spectre-style attacks (spectreattack.com). * Allows granular time (reduction) tracking if we wanted to provide a runtime allowance for each function. * Better sandboxing. Creating a whole JSRuntime takes only 300 microseconds, so we can afford to do that on reset. JSRuntimes cannot share JS data or object between them. * Seems to be faster in preliminary benchmarking with small concurrent VDU and view builds: https://gist.github.com/nickva/ed239651114794ebb138b1f16c5f6758 Results seem promising: - 4x faster than SM 1.8.5 - 5x faster than SM 91 - 6x reduced memory usage per couchjs process (5MB vs 30MB) * Allows compiling JS bytecode ahead of time a C array of bytes. QuickJS can be built alongside Spidermonkey and toggled on/off at runtime: ``` ./configure --dev --js-engine=quickjs ``` This makes it the default engine. But Spidermonkey can still be set in the config option. ``` [couchdb] js_engine = spidermonkey | quickjs ``` To test individual views, without switching the default use the `javascript_quickjs` language in the design docs. To keep using Spidermonkey engine after switching the default, can use `javascript_spidermonkey` language in design docs. However, language selection will reset the view and the view will have to be rebuilt. Tested on MacOS and Linux. All `make check` tests pass there. Issue: #4448
- Loading branch information
Showing
55 changed files
with
85,884 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| // use this file except in compliance with the License. You may obtain a copy of | ||
| // the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| // License for the specific language governing permissions and limitations under | ||
| // the License. | ||
|
|
||
| function create_sandbox() { | ||
| var sandbox = {}; | ||
| sandbox.emit = Views.emit; | ||
| sandbox.sum = Views.sum; | ||
| sandbox.log = log; | ||
| sandbox.toJSON = JSON.stringify; | ||
| sandbox.JSON = JSON; | ||
| sandbox.provides = Mime.provides; | ||
| sandbox.registerType = Mime.registerType; | ||
| sandbox.start = Render.start; | ||
| sandbox.send = Render.send; | ||
| sandbox.getRow = Render.getRow; | ||
| sandbox.isArray = isArray; | ||
| return sandbox; | ||
| }; | ||
|
|
||
| function create_filter_sandbox() { | ||
| var sandbox = create_sandbox(); | ||
| sandbox.emit = Filter.emit; | ||
| return sandbox; | ||
| }; | ||
|
|
||
| function create_dreyfus_sandbox() { | ||
| var sandbox = create_sandbox(); | ||
| sandbox.index = Dreyfus.index; | ||
| return sandbox; | ||
| }; | ||
|
|
||
| function create_nouveau_sandbox() { | ||
| var sandbox = create_sandbox(); | ||
| sandbox.index = Nouveau.index; | ||
| return sandbox; | ||
| }; | ||
|
|
||
| function seal(obj, flag) { | ||
| Object.freeze(obj); | ||
| }; | ||
|
|
||
| // This is a copy from loop.js | ||
| var DDoc = (function() { | ||
| var ddoc_dispatch = { | ||
| "lists" : Render.list, | ||
| "shows" : Render.show, | ||
| "filters" : Filter.filter, | ||
| "views" : Filter.filter_view, | ||
| "updates" : Render.update, | ||
| "validate_doc_update" : Validate.validate, | ||
| "rewrites" : Render.rewrite | ||
| }; | ||
| var ddocs = {}; | ||
| return { | ||
| ddoc : function() { | ||
| var args = []; | ||
| for (var i=0; i < arguments.length; i++) { | ||
| args.push(arguments[i]); | ||
| }; | ||
| var ddocId = args.shift(); | ||
| if (ddocId == "new") { | ||
| // get the real ddocId. | ||
| ddocId = args.shift(); | ||
| // store the ddoc, functions are lazily compiled. | ||
| ddocs[ddocId] = args.shift(); | ||
| print("true"); | ||
| } else { | ||
| // Couch makes sure we know this ddoc already. | ||
| var ddoc = ddocs[ddocId]; | ||
| if (!ddoc) throw(["fatal", "query_protocol_error", "uncached design doc: "+ddocId]); | ||
| var funPath = args.shift(); | ||
| var cmd = funPath[0]; | ||
| // the first member of the fun path determines the type of operation | ||
| var funArgs = args.shift(); | ||
| if (ddoc_dispatch[cmd]) { | ||
| // get the function, call the command with it | ||
| var point = ddoc; | ||
| for (var i=0; i < funPath.length; i++) { | ||
| if (i+1 == funPath.length) { | ||
| var fun = point[funPath[i]]; | ||
| if (!fun) { | ||
| throw(["error","not_found", | ||
| "missing " + funPath[0] + " function " + funPath[i] + | ||
| " on design doc " + ddocId]); | ||
| } | ||
| if (typeof fun != "function") { | ||
| // For filter_view we want the emit() function | ||
| // to be overridden and just toggle a flag instead of | ||
| // accumulating rows | ||
| var sandbox = (cmd === "views") ? create_filter_sandbox() : create_sandbox(); | ||
| fun = Couch.compileFunction(fun, ddoc, funPath.join('.'), sandbox); | ||
| // cache the compiled fun on the ddoc | ||
| point[funPath[i]] = fun; | ||
| }; | ||
| } else { | ||
| point = point[funPath[i]]; | ||
| } | ||
| }; | ||
|
|
||
| // run the correct responder with the cmd body | ||
| ddoc_dispatch[cmd].apply(null, [fun, ddoc, funArgs]); | ||
| } else { | ||
| // unknown command, quit and hope the restarted version is better | ||
| throw(["fatal", "unknown_command", "unknown ddoc command '" + cmd + "'"]); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| })(); | ||
|
|
||
| // This mostly a copy from loop.js handleError | ||
| function handleError(e) { | ||
| if (e === null) { | ||
| // internal error, another possibility when out of memory | ||
| // nothing to do except rethrow and let main.c catch it and exit(1) | ||
| throw(null); | ||
| } | ||
| const type = e[0]; | ||
| if (type == "fatal") { | ||
| e[0] = "error"; // we tell the client it was a fatal error by dying | ||
| respond(e); | ||
| return false; | ||
| } else if (type == "error") { | ||
| respond(e); | ||
| return true; | ||
| } else if (e.name == "InternalError") { | ||
| // If the internal error is caught by handleViewError it will be | ||
| // re-thrown as a ["fatal", ...] error, and we already handle that above. | ||
| // Here we handle the case when the error is thrown outside of | ||
| // handleViewError, for instance when serializing the rows to be sent | ||
| // back to the user | ||
| respond(["error", e.name, e.message]); | ||
| return false; | ||
| } else if (e.error && e.reason) { | ||
| // compatibility with old error format | ||
| respond(["error", e.error, e.reason]); | ||
| return true; | ||
| } else if (e.name) { | ||
| respond(["error", e.name, e]); | ||
| return true; | ||
| } else { | ||
| respond(["error","unnamed_error", e.stack]); | ||
| return true; | ||
| } | ||
| }; | ||
|
|
||
| globalThis.dispatch = function(line) { | ||
| const cmd = JSON.parse(line); | ||
| State.line_length = line.length; | ||
| try { | ||
| switch (cmd.shift()) { | ||
| case "ddoc": | ||
| DDoc.ddoc.apply(null, cmd); | ||
| break; | ||
| case "reset": | ||
| State.reset.apply(null, cmd); | ||
| break; | ||
| case "add_fun": | ||
| State.addFun.apply(null, cmd); | ||
| break; | ||
| case "add_lib": | ||
| State.addLib.apply(null, cmd); | ||
| break; | ||
| case "map_doc": | ||
| Views.mapDoc.apply(null, cmd); | ||
| break; | ||
| case "index_doc": | ||
| Dreyfus.indexDoc.apply(null, cmd); | ||
| break; | ||
| case "nouveau_index_doc": | ||
| Nouveau.indexDoc.apply(null, cmd); | ||
| break; | ||
| case "reduce": | ||
| Views.reduce.apply(null, cmd); | ||
| break; | ||
| case "rereduce": | ||
| Views.rereduce.apply(null, cmd); | ||
| break; | ||
| default: | ||
| // unknown command, quit and hope the restarted version is better | ||
| throw(["fatal", "unknown_command", "unknown command '" + cmdkey + "'"]); | ||
| } | ||
| } catch(e) { | ||
| return handleError(e); | ||
| }; | ||
| return true; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.