git ssb

1
const Message = require('primea-message')
2
const BN = require('bn.js')
3
const PortManager = require('./portManager.js')
4
const DeleteMessage = require('./deleteMessage')
5
6
module.exports = class Kernel {
7
  /**
8
   * the Kernel manages the varous message passing functions and provides
9
   * an interface for the containers to use
10
   * @param {Object} opts
11
   * @param {Object} opts.id - the UUID of the Kernel
12
   * @param {Object} opts.state - the state of the container
13
   * @param {Object} opts.hypervisor
14
   * @param {Object} opts.container - the container constuctor and argments
15
   */
16
  constructor (opts) {
17
    this.state = opts.state
18
    this.code = opts.code
19
    this.hypervisor = opts.hypervisor
20
    this.id = opts.id
21
    this.container = new opts.container.Constructor(this, opts.container.args)
22
    this.timeout = 0
23
24
    this.ticks = 0
25
    this.containerState = 'idle'
26
27
    // create the port manager
28
    this.ports = new PortManager(Object.assign({
29
      kernel: this
30
    }, opts))
31
  }
32
33
  /**
34
   * adds a message to this containers message queue
35
   * @param {string} portName
36
   * @param {object} message
37
   */
38
  queue (portName, message) {
39
    this.ports.queue(portName, message)
40
    return this._startMessageLoop()
41
  }
42
43
  async initialize (message) {
44
    await this.run(message, 'initialize')
45
    return this._startMessageLoop()
46
  }
47
48
  // waits for the next message
49
  async _startMessageLoop () {
50
    // this ensure we only every have one loop running at a time
51
    if (this.containerState !== 'running') {
52
      this.containerState = 'running'
53
54
      while (1) {
55
        const message = await this.ports.getNextMessage(this.timeout)
56
        if (!message) break
57
58
        // dequqe message
59
        message.fromPort.messages.shift()
60
        // if the message we recived had more ticks then we currently have the
61
        // update it
62
        if (message._fromTicks > this.ticks) {
63
          this.ticks = message._fromTicks
64
          this.hypervisor.scheduler.update(this)
65
        }
66
        // run the next message
67
        await this.run(message)
68
      }
69
70
      this.containerState = 'idle'
71
      this.container.onIdle()
72
    }
73
  }
74
75
  shutdown () {
76
    this.hypervisor.scheduler.done(this.id)
77
  }
78
79
  startup () {
80
    if (this.container.startup) {
81
      return this.container.startup()
82
    }
83
  }
84
85
  /**
86
   * run the kernels code with a given enviroment
87
   * @param {object} message - the message to run
88
   * @param {boolean} init - whether or not to run the intialization routine
89
   * @returns {Promise}
90
   */
91
  async run (message, method = 'run') {
92
    if (message.constructor === DeleteMessage) {
93
      this.ports._delete(message.fromName)
94
    } else {
95
      const responsePort = message.responsePort
96
      delete message.responsePort
97
98
      this.ports.addReceivedPorts(message)
99
      let result
100
      try {
101
        result = await this.container[method](message)
102
      } catch (e) {
103
        result = {
104
          exception: true,
105
          exceptionError: e
106
        }
107
      }
108
109
      if (responsePort) {
110
        this.send(responsePort, new Message({
111
          data: result
112
        }))
113
      }
114
    }
115
116
    this.ports.clearUnboundedPorts()
117
  }
118
119
  getResponsePort (message) {
120
    if (message.responsePort) {
121
      return message.responsePort.destPort
122
    } else {
123
      const [portRef1, portRef2] = this.ports.createChannel()
124
      message.responsePort = portRef2
125
      this.ports._unboundPorts.delete(portRef2)
126
      return portRef1
127
    }
128
  }
129
130
  /**
131
   * updates the number of ticks that the container has run
132
   * @param {Number} count - the number of ticks to add
133
   */
134
  incrementTicks (count) {
135
    this.ticks += count
136
    this.hypervisor.scheduler.update(this)
137
  }
138
139
  /**
140
   * creates a new message
141
   * @param {*} data
142
   */
143
  createMessage (opts) {
144
    const message = new Message(opts)
145
    this.ports.checkSendingPorts(message)
146
    return message
147
  }
148
149
  /**
150
   * creates a new container. Returning a port to it.
151
   * @param {String} type
152
   * @param {*} data - the data to populate the initail state with
153
   * @returns {Object}
154
   */
155
  createInstance (type, message) {
156
    let nonce = this.state.nonce
157
158
    const id = {
159
      nonce: nonce,
160
      parent: this.id
161
    }
162
163
    // incerment the nonce
164
    nonce = new BN(nonce)
165
    nonce.iaddn(1)
166
    this.state.nonce = nonce.toArray()
167
    this.ports.removeSentPorts(message)
168
169
    return this.hypervisor.createInstance(type, message, id)
170
  }
171
172
  /**
173
   * sends a message to a given port
174
   * @param {Object} portRef - the port
175
   * @param {Message} message - the message
176
   */
177
  send (port, message) {
178
    message._hops++
179
    // set the port that the message came from
180
    message._fromTicks = this.ticks
181
    this.ports.removeSentPorts(message)
182
183
    // if (this.currentMessage !== message && !message.responsePort) {
184
    //   this.currentMessage._addSubMessage(message)
185
    // }
186
    return this.hypervisor.send(port, message)
187
  }
188
}
189