1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
/*
This file is part of GNU Taler
(C) 2016 GNUnet e.V.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
/**
* API to access the Taler crypto worker.
*
* @author Florian Dold
*/
/**
* Imports.
*/
import { j2s, Logger, TalerErrorCode } from "@gnu-taler/taler-util";
import { TalerError } from "../../errors.js";
import { openPromise } from "../../util/promiseUtils.js";
import { timer, performanceNow, TimerHandle } from "../../util/timer.js";
import { nullCrypto, TalerCryptoInterface } from "../cryptoImplementation.js";
import { CryptoWorker } from "./cryptoWorkerInterface.js";
const logger = new Logger("cryptoDispatcher.ts");
/**
* State of a crypto worker.
*/
interface WorkerInfo {
/**
* The actual worker thread.
*/
w: CryptoWorker | null;
/**
* Work we're currently executing or null if not busy.
*/
currentWorkItem: WorkItem | null;
/**
* Timer to terminate the worker if it's not busy enough.
*/
idleTimeoutHandle: TimerHandle | null;
}
interface WorkItem {
operation: string;
req: unknown;
resolve: any;
reject: any;
/**
* Serial id to identify a matching response.
*/
rpcId: number;
/**
* Time when the work was submitted to a (non-busy) worker thread.
*/
startTime: BigInt;
state: WorkItemState;
}
/**
* Number of different priorities. Each priority p
* must be 0 <= p < NUM_PRIO.
*/
const NUM_PRIO = 5;
/**
* A crypto worker factory is responsible for creating new
* crypto workers on-demand.
*/
export interface CryptoWorkerFactory {
/**
* Start a new worker.
*/
startWorker(): CryptoWorker;
/**
* Query the number of workers that should be
* run at the same time.
*/
getConcurrency(): number;
}
export class CryptoApiStoppedError extends Error {
constructor() {
super("Crypto API stopped");
Object.setPrototypeOf(this, CryptoApiStoppedError.prototype);
}
}
export enum WorkItemState {
Pending = 1,
Running = 2,
Finished = 3,
}
/**
* Dispatcher for cryptographic operations to underlying crypto workers.
*/
export class CryptoDispatcher {
private nextRpcId = 1;
private workers: WorkerInfo[];
private workQueues: WorkItem[][];
private workerFactory: CryptoWorkerFactory;
/**
* Number of busy workers.
*/
private numBusy = 0;
/**
* Did we stop accepting new requests?
*/
private stopped = false;
/**
* Terminate all worker threads.
*/
terminateWorkers(): void {
for (const worker of this.workers) {
if (worker.idleTimeoutHandle) {
worker.idleTimeoutHandle.clear();
worker.idleTimeoutHandle = null;
}
if (worker.currentWorkItem) {
worker.currentWorkItem.reject(new CryptoApiStoppedError());
worker.currentWorkItem = null;
}
if (worker.w) {
logger.trace("terminating worker");
worker.w.terminate();
worker.w = null;
}
}
}
stop(): void {
this.stopped = true;
this.terminateWorkers();
}
/**
* Start a worker (if not started) and set as busy.
*/
wake(ws: WorkerInfo, work: WorkItem): void {
if (this.stopped) {
return;
}
if (ws.currentWorkItem !== null) {
throw Error("assertion failed");
}
ws.currentWorkItem = work;
this.numBusy++;
let worker: CryptoWorker;
if (!ws.w) {
worker = this.workerFactory.startWorker();
worker.onmessage = (m: any) => this.handleWorkerMessage(ws, m);
worker.onerror = (e: any) => this.handleWorkerError(ws, e);
ws.w = worker;
} else {
worker = ws.w;
}
const msg: any = {
req: work.req,
id: work.rpcId,
operation: work.operation,
};
this.resetWorkerTimeout(ws);
work.startTime = performanceNow();
work.state = WorkItemState.Running;
timer.after(0, () => worker.postMessage(msg));
}
resetWorkerTimeout(ws: WorkerInfo): void {
if (ws.idleTimeoutHandle !== null) {
ws.idleTimeoutHandle.clear();
ws.idleTimeoutHandle = null;
}
const destroy = (): void => {
logger.trace("destroying crypto worker after idle timeout");
// terminate worker if it's idle
if (ws.w && ws.currentWorkItem === null) {
ws.w.terminate();
ws.w = null;
}
};
ws.idleTimeoutHandle = timer.after(15 * 1000, destroy);
ws.idleTimeoutHandle.unref();
}
private resetWorker(ws: WorkerInfo, e: any): void {
try {
if (ws.w) {
ws.w.terminate();
ws.w = null;
}
} catch (e) {
logger.error(e as string);
}
if (ws.currentWorkItem !== null) {
ws.currentWorkItem.state = WorkItemState.Finished;
ws.currentWorkItem.reject(e);
ws.currentWorkItem = null;
this.numBusy--;
}
this.findWork(ws);
}
handleWorkerError(ws: WorkerInfo, e: any): void {
if (ws.currentWorkItem) {
logger.error(`error in worker during ${ws.currentWorkItem.operation}`, e);
} else {
logger.error("error in worker", e);
}
logger.error(e.message);
this.resetWorker(ws, e);
}
private findWork(ws: WorkerInfo): void {
// try to find more work for this worker
for (let i = 0; i < NUM_PRIO; i++) {
const q = this.workQueues[NUM_PRIO - i - 1];
if (q.length !== 0) {
const work: WorkItem | undefined = q.shift();
if (!work) {
continue;
}
this.wake(ws, work);
return;
}
}
}
handleWorkerMessage(ws: WorkerInfo, msg: any): void {
const id = msg.id;
if (typeof id !== "number") {
logger.error("rpc id must be number");
return;
}
const currentWorkItem = ws.currentWorkItem;
ws.currentWorkItem = null;
if (!currentWorkItem) {
logger.error("unsolicited response from worker");
return;
}
if (id !== currentWorkItem.rpcId) {
logger.error(`RPC with id ${id} has no registry entry`);
return;
}
if (currentWorkItem.state === WorkItemState.Running) {
this.numBusy--;
currentWorkItem.state = WorkItemState.Finished;
if (msg.type === "success") {
currentWorkItem.resolve(msg.result);
} else if (msg.type === "error") {
currentWorkItem.reject(
TalerError.fromDetail(TalerErrorCode.WALLET_CRYPTO_WORKER_ERROR, {
innerError: msg.error,
}),
);
} else {
logger.warn(`bad message: ${j2s(msg)}`);
currentWorkItem.reject(new Error("bad message from crypto worker"));
}
}
this.findWork(ws);
}
cryptoApi: TalerCryptoInterface;
constructor(workerFactory: CryptoWorkerFactory) {
const fns: any = {};
for (const name of Object.keys(nullCrypto)) {
fns[name] = (x: any) => this.doRpc(name, 0, x);
}
this.cryptoApi = fns;
this.workerFactory = workerFactory;
this.workers = new Array<WorkerInfo>(workerFactory.getConcurrency());
for (let i = 0; i < this.workers.length; i++) {
this.workers[i] = {
currentWorkItem: null,
idleTimeoutHandle: null,
w: null,
};
}
this.workQueues = [];
for (let i = 0; i < NUM_PRIO; i++) {
this.workQueues.push([]);
}
}
doRpc<T>(
operation: string,
priority: number,
req: unknown,
): Promise<T> {
if (this.stopped) {
throw new CryptoApiStoppedError();
}
const rpcId = this.nextRpcId++;
const myProm = openPromise<T>();
const workItem: WorkItem = {
operation,
req,
resolve: myProm.resolve,
reject: myProm.reject,
rpcId,
startTime: BigInt(0),
state: WorkItemState.Pending,
};
let scheduled = false;
if (this.numBusy === this.workers.length) {
// All workers are busy, queue work item
const q = this.workQueues[priority];
if (!q) {
throw Error("assertion failed");
}
this.workQueues[priority].push(workItem);
scheduled = true;
}
if (!scheduled) {
for (const ws of this.workers) {
if (ws.currentWorkItem !== null) {
continue;
}
this.wake(ws, workItem);
scheduled = true;
break;
}
}
if (!scheduled) {
// Could not schedule work.
throw Error("assertion failed");
}
// Make sure that we wait for the result while a timer is active
// to prevent the event loop from dying, as just waiting for a promise
// does not keep the process alive in Node.
// (The worker child process won't keep us alive either, because we un-ref
// it to make sure it doesn't keep us alive if there is no work.)
return new Promise<T>((resolve, reject) => {
let timeoutHandle: TimerHandle | undefined = undefined;
const timeoutMs = 5000;
const onTimeout = () => {
// FIXME: Maybe destroy and re-init worker if request is in processing
// state and really taking too long?
logger.warn(`crypto RPC call ('${operation}') has been queued for a long time`);
timeoutHandle = timer.after(timeoutMs, onTimeout);
};
myProm.promise
.then((x) => {
timeoutHandle?.clear();
resolve(x);
})
.catch((x) => {
logger.info(`crypto RPC call ${operation} threw`);
timeoutHandle?.clear();
reject(x);
});
});
}
}
|