Commit | Line | Data |
---|---|---|
b3432a63 | 1 | import { cpus } from 'os' |
b3432a63 | 2 | import type { IPoolInternal } from '../pool-internal' |
ea7a90d3 | 3 | import type { IPoolWorker } from '../pool-worker' |
b3432a63 | 4 | import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy' |
10fcfaf4 | 5 | import type { RequiredStatistics } from './selection-strategies-types' |
b3432a63 JB |
6 | |
7 | /** | |
23135a89 | 8 | * Virtual task runtime. |
b3432a63 JB |
9 | */ |
10 | type TaskRunTime = { | |
11 | weight: number | |
12 | runTime: number | |
13 | } | |
14 | ||
15 | /** | |
16 | * Selects the next worker with a weighted round robin scheduling algorithm. | |
17 | * Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin. | |
18 | * | |
19 | * @template Worker Type of worker which manages the strategy. | |
20 | * @template Data Type of data sent to the worker. This can only be serializable data. | |
21 | * @template Response Type of response of execution. This can only be serializable data. | |
22 | */ | |
23 | export class WeightedRoundRobinWorkerChoiceStrategy< | |
ea7a90d3 | 24 | Worker extends IPoolWorker, |
b3432a63 JB |
25 | Data, |
26 | Response | |
27 | > extends AbstractWorkerChoiceStrategy<Worker, Data, Response> { | |
10fcfaf4 | 28 | /** @inheritDoc */ |
ea7a90d3 | 29 | public readonly requiredStatistics: RequiredStatistics = { |
10fcfaf4 JB |
30 | runTime: true |
31 | } | |
32 | ||
b3432a63 JB |
33 | /** |
34 | * Worker index where the current task will be submitted. | |
35 | */ | |
36 | private currentWorkerIndex: number = 0 | |
37 | /** | |
38 | * Default worker weight. | |
39 | */ | |
777af0ac | 40 | private readonly defaultWorkerWeight: number |
b3432a63 | 41 | /** |
2377984d | 42 | * Per worker virtual task runtime map. |
b3432a63 | 43 | */ |
ea7a90d3 | 44 | private readonly workersTaskRunTime: Map<Worker, TaskRunTime> = new Map< |
b3432a63 JB |
45 | Worker, |
46 | TaskRunTime | |
47 | >() | |
48 | ||
49 | /** | |
23ff945a | 50 | * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm. |
b3432a63 JB |
51 | * |
52 | * @param pool The pool instance. | |
53 | */ | |
54 | public constructor (pool: IPoolInternal<Worker, Data, Response>) { | |
55 | super(pool) | |
56 | this.defaultWorkerWeight = this.computeWorkerWeight() | |
2377984d | 57 | this.initWorkersTaskRunTime() |
b3432a63 JB |
58 | } |
59 | ||
ea7a90d3 | 60 | /** @inheritDoc */ |
a6f7f1b4 | 61 | public reset (): boolean { |
a6f7f1b4 | 62 | this.currentWorkerIndex = 0 |
ea7a90d3 JB |
63 | this.workersTaskRunTime.clear() |
64 | this.initWorkersTaskRunTime() | |
65 | return true | |
66 | } | |
67 | ||
b3432a63 JB |
68 | /** @inheritDoc */ |
69 | public choose (): Worker { | |
d8a610ca | 70 | const chosenWorker = this.pool.workers[this.currentWorkerIndex] |
2377984d JB |
71 | if ( |
72 | this.isDynamicPool === true && | |
11df3590 | 73 | this.workersTaskRunTime.has(chosenWorker) === false |
2377984d | 74 | ) { |
11df3590 | 75 | this.initWorkerTaskRunTime(chosenWorker) |
b3432a63 | 76 | } |
d8a610ca JB |
77 | const workerTaskRunTime = |
78 | this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0 | |
b3432a63 | 79 | const workerTaskWeight = |
11df3590 | 80 | this.workersTaskRunTime.get(chosenWorker)?.weight ?? |
b3432a63 | 81 | this.defaultWorkerWeight |
553ad720 | 82 | if (workerTaskRunTime < workerTaskWeight) { |
2377984d | 83 | this.setWorkerTaskRunTime( |
11df3590 | 84 | chosenWorker, |
2377984d | 85 | workerTaskWeight, |
553ad720 | 86 | workerTaskRunTime + |
11df3590 | 87 | (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0) |
2377984d | 88 | ) |
b3432a63 | 89 | } else { |
b3432a63 | 90 | this.currentWorkerIndex = |
553ad720 | 91 | this.currentWorkerIndex === this.pool.workers.length - 1 |
b3432a63 JB |
92 | ? 0 |
93 | : this.currentWorkerIndex + 1 | |
11df3590 | 94 | this.setWorkerTaskRunTime(chosenWorker, workerTaskWeight, 0) |
b3432a63 | 95 | } |
11df3590 | 96 | return chosenWorker |
b3432a63 JB |
97 | } |
98 | ||
2377984d JB |
99 | private initWorkersTaskRunTime (): void { |
100 | for (const worker of this.pool.workers) { | |
101 | this.initWorkerTaskRunTime(worker) | |
102 | } | |
103 | } | |
104 | ||
105 | private initWorkerTaskRunTime (worker: Worker): void { | |
106 | this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0) | |
107 | } | |
108 | ||
109 | private setWorkerTaskRunTime ( | |
110 | worker: Worker, | |
111 | weight: number, | |
112 | runTime: number | |
113 | ): void { | |
114 | this.workersTaskRunTime.set(worker, { | |
115 | weight, | |
116 | runTime | |
117 | }) | |
118 | } | |
119 | ||
120 | private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined { | |
121 | return this.pool.getWorkerAverageTasksRunTime(worker) | |
122 | } | |
123 | ||
124 | private computeWorkerWeight (): number { | |
b3432a63 | 125 | let cpusCycleTimeWeight = 0 |
a59e741b | 126 | for (const cpu of cpus()) { |
b3432a63 | 127 | // CPU estimated cycle time |
d8a610ca JB |
128 | const numberOfDigits = cpu.speed.toString().length - 1 |
129 | const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits)) | |
130 | cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits) | |
b3432a63 | 131 | } |
7b0d35b8 | 132 | return Math.round(cpusCycleTimeWeight / cpus().length) |
b3432a63 | 133 | } |
b3432a63 | 134 | } |