gpu.js icon indicating copy to clipboard operation
gpu.js copied to clipboard

JSON prebuild export and import broken?

Open CipSoft-Components opened this issue 5 years ago • 3 comments

What is wrong?

To make the loading time faster, I thought to prebuild my kernels once as JSON with toJSON(), and use this JSON to create my MapKernels. But the toJSON() is out of date (not handling native functions correct), and also the intern fromJSON(...) do not work. I tried to patch them, and now I can export, but I don't get the import working. Additional information: I use a map function with some map return values, and custom native functions.

Where does it happen?

Not specific to a system.

How do we replicate the issue?

  • Create a kernel with createKernelMap(...)
    • Use at least one map function
    • Use at least one native function
  • Export the kernel with toJSON()
  • Try to create a new kernel with that JSON.

How important is this (1-5)?

2

Expected behavior (i.e. solution)

Should work

Other Comments

After some tests to patch fromJSON(...) I got it working, but the compiled fragment shader complains about complains about the missing map result variables. Here are my patched functions:

toJSON = function() {
  return this.traceFunctionCalls(this.rootNode.name).reverse().map(name => {
    const nativeIndex = this.nativeFunctionNames.indexOf(name);
    if (nativeIndex > -1) {
      return {
        name,
        source: this.nativeFunctions[nativeIndex].source
      };
    } else if (this.functionMap[name]) {
      return this.functionMap[name].toJSON();
    } else {
      throw new Error(`function ${ name } not found`);
    }
  });
}
fromJSON = function(jsonFunctionNodes, FunctionNode) {
  this.functionMap = {};
    for (let i = 0; i < jsonFunctionNodes.length; i++) {
      const jsonFunctionNode = jsonFunctionNodes[i];
      if (jsonFunctionNode.settings) {
        const functionNode = new FunctionNode(jsonFunctionNode.ast, jsonFunctionNode.settings);
        functionNode.triggerImplyArgumentType = this.assignArgumentType.bind(this);
        // For some reason the FunctionNode object is missing some members, which I found in the FunctionBuilder.
        // I'm not sure, if this is correct, but it works somehow.
        for (const key of Object.keys(functionNode)) {
          if (functionNode[key] === null && this[key] && typeof this[key] === 'function') {
            functionNode[key] = this[key].bind(this);
          }
        }
        this.addFunctionNode(functionNode);
        if (functionNode.isSubKernel) {
          this.subKernelNodes.push(functionNode);
        }
        this.functionNodes.push(functionNode);
      } else {
        this.nativeFunctions.push(jsonFunctionNode);
      }
    }
    return this;
};

CipSoft-Components avatar Apr 07 '20 14:04 CipSoft-Components

You may find this workaround helpful:

// save kernel to file as a module
require('fs').writeFileSync('kernel.js', 'module.exports = ' + kernel.toString(...kernelArguments));
// execute the saved kernel
const kernelOutput = require('./kernel.js')({})(...kernelArguments)

EDIT: Actually this won't work unless your arguments are the same size and dimensions when you save it as when you load it.

GirkovArpa avatar Apr 08 '20 12:04 GirkovArpa

Any updates on this? :)

y4nnick avatar Jun 19 '20 22:06 y4nnick

Just copy and pasted examples from the readme and it appears v2.10.0 createKernelMap fails for both Object Outputs and Array Outputs with:

Uncaught Error: Identifier is not defined on line 2, position 1

const gpu = new GPU();

const megaKernel = gpu.createKernelMap([
  function add(a, b) {
    return a + b;
  },
  function multiply(a, b) {
    return a * b;
  }
], function(a, b, c) {
  return multiply(add(a[this.thread.x], b[this.thread.x]), c[this.thread.x]);
}, { output: [10] });

const json = megaKernel.toJSON();

evbo avatar Jan 11 '21 02:01 evbo