kernel.js

const Message = require('primea-message')
const BN = require('bn.js')
const PortManager = require('./portManager.js')
const DeleteMessage = require('./deleteMessage')

module.exports = class Kernel {
  /**
   * the Kernel manages the varous message passing functions and provides
   * an interface for the containers to use
   * @param {Object} opts
   * @param {Object} opts.id - the UUID of the Kernel
   * @param {Object} opts.state - the state of the container
   * @param {Object} opts.hypervisor
   * @param {Object} opts.container - the container constuctor and argments
   */
  constructor (opts) {
    this.state = opts.state
    this.code = opts.code
    this.hypervisor = opts.hypervisor
    this.id = opts.id
    this.container = new opts.container.Constructor(this, opts.container.args)
    this.timeout = 0

    this.ticks = 0
    this.containerState = 'idle'

    // create the port manager
    this.ports = new PortManager(Object.assign({
      kernel: this
    }, opts))
  }

  /**
   * adds a message to this containers message queue
   * @param {string} portName
   * @param {object} message
   */
  queue (portName, message) {
    this.ports.queue(portName, message)
    return this._startMessageLoop()
  }

  async initialize (message) {
    await this.run(message, 'initialize')
    return this._startMessageLoop()
  }

  // waits for the next message
  async _startMessageLoop () {
    // this ensure we only every have one loop running at a time
    if (this.containerState !== 'running') {
      this.containerState = 'running'

      while (1) {
        const message = await this.ports.getNextMessage(this.timeout)
        if (!message) break

        // dequqe message
        message.fromPort.messages.shift()
        // if the message we recived had more ticks then we currently have the
        // update it
        if (message._fromTicks > this.ticks) {
          this.ticks = message._fromTicks
          this.hypervisor.scheduler.update(this)
        }
        // run the next message
        await this.run(message)
      }

      this.containerState = 'idle'
      this.container.onIdle()
    }
  }

  shutdown () {
    this.hypervisor.scheduler.done(this.id)
  }

  /**
   * run the kernels code with a given enviroment
   * @param {object} message - the message to run
   * @param {boolean} init - whether or not to run the intialization routine
   * @returns {Promise}
   */
  async run (message, method = 'run') {
    if (message.constructor === DeleteMessage) {
      this.ports._delete(message.fromName)
    } else {
      const responsePort = message.responsePort
      delete message.responsePort

      this.ports.addReceivedPorts(message)
      let result
      try {
        result = await this.container[method](message)
      } catch (e) {
        result = {
          exception: true,
          exceptionError: e
        }
      }

      if (responsePort) {
        this.send(responsePort, new Message({
          data: result
        }))
      }
    }

    this.ports.clearUnboundedPorts()
  }

  getResponsePort (message) {
    if (message.responsePort) {
      return message.responsePort.destPort
    } else {
      const [portRef1, portRef2] = this.ports.createChannel()
      message.responsePort = portRef2
      this.ports._unboundPorts.delete(portRef2)
      return portRef1
    }
  }

  /**
   * updates the number of ticks that the container has run
   * @param {Number} count - the number of ticks to add
   */
  incrementTicks (count) {
    this.ticks += count
    this.hypervisor.scheduler.update(this)
  }

  /**
   * creates a new message
   * @param {*} data
   */
  createMessage (opts) {
    const message = new Message(opts)
    this.ports.checkSendingPorts(message)
    return message
  }

  /**
   * creates a new container. Returning a port to it.
   * @param {String} type
   * @param {*} data - the data to populate the initail state with
   * @returns {Object}
   */
  createInstance (type, message) {
    let nonce = this.state.nonce

    const id = {
      nonce: nonce,
      parent: this.id
    }

    // incerment the nonce
    nonce = new BN(nonce)
    nonce.iaddn(1)
    this.state.nonce = nonce.toArray()
    this.ports.removeSentPorts(message)

    return this.hypervisor.createInstance(type, message, id)
  }

  /**
   * sends a message to a given port
   * @param {Object} portRef - the port
   * @param {Message} message - the message
   */
  send (port, message) {
    message._hops++
    // set the port that the message came from
    message._fromTicks = this.ticks
    this.ports.removeSentPorts(message)

    // if (this.currentMessage !== message && !message.responsePort) {
    //   this.currentMessage._addSubMessage(message)
    // }
    return this.hypervisor.send(port, message)
  }
}