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 | 9 | */ |
78cea37e | 10 | interface TaskRunTime { |
b3432a63 JB |
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 | * | |
38e795c1 JB |
19 | * @typeParam Worker - Type of worker which manages the strategy. |
20 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. | |
21 | * @typeParam Response - Type of response of execution. This can only be serializable data. | |
b3432a63 JB |
22 | */ |
23 | export class WeightedRoundRobinWorkerChoiceStrategy< | |
ea7a90d3 | 24 | Worker extends IPoolWorker, |
b3432a63 JB |
25 | Data, |
26 | Response | |
27 | > extends AbstractWorkerChoiceStrategy<Worker, Data, Response> { | |
38e795c1 | 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< |
78cea37e JB |
45 | Worker, |
46 | TaskRunTime | |
b3432a63 JB |
47 | >() |
48 | ||
49 | /** | |
23ff945a | 50 | * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm. |
b3432a63 | 51 | * |
38e795c1 | 52 | * @param pool - The pool instance. |
b3432a63 JB |
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 | ||
38e795c1 | 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 | ||
38e795c1 | 68 | /** {@inheritDoc} */ |
b3432a63 | 69 | public choose (): Worker { |
d8a610ca | 70 | const chosenWorker = this.pool.workers[this.currentWorkerIndex] |
78cea37e | 71 | if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorker)) { |
11df3590 | 72 | this.initWorkerTaskRunTime(chosenWorker) |
b3432a63 | 73 | } |
d8a610ca JB |
74 | const workerTaskRunTime = |
75 | this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0 | |
b3432a63 | 76 | const workerTaskWeight = |
11df3590 | 77 | this.workersTaskRunTime.get(chosenWorker)?.weight ?? |
b3432a63 | 78 | this.defaultWorkerWeight |
553ad720 | 79 | if (workerTaskRunTime < workerTaskWeight) { |
2377984d | 80 | this.setWorkerTaskRunTime( |
11df3590 | 81 | chosenWorker, |
2377984d | 82 | workerTaskWeight, |
553ad720 | 83 | workerTaskRunTime + |
11df3590 | 84 | (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0) |
2377984d | 85 | ) |
b3432a63 | 86 | } else { |
b3432a63 | 87 | this.currentWorkerIndex = |
553ad720 | 88 | this.currentWorkerIndex === this.pool.workers.length - 1 |
b3432a63 JB |
89 | ? 0 |
90 | : this.currentWorkerIndex + 1 | |
d354916a JB |
91 | this.setWorkerTaskRunTime( |
92 | this.pool.workers[this.currentWorkerIndex], | |
93 | workerTaskWeight, | |
94 | 0 | |
95 | ) | |
b3432a63 | 96 | } |
11df3590 | 97 | return chosenWorker |
b3432a63 JB |
98 | } |
99 | ||
2377984d JB |
100 | private initWorkersTaskRunTime (): void { |
101 | for (const worker of this.pool.workers) { | |
102 | this.initWorkerTaskRunTime(worker) | |
103 | } | |
104 | } | |
105 | ||
106 | private initWorkerTaskRunTime (worker: Worker): void { | |
107 | this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0) | |
108 | } | |
109 | ||
110 | private setWorkerTaskRunTime ( | |
111 | worker: Worker, | |
112 | weight: number, | |
113 | runTime: number | |
114 | ): void { | |
115 | this.workersTaskRunTime.set(worker, { | |
116 | weight, | |
117 | runTime | |
118 | }) | |
119 | } | |
120 | ||
121 | private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined { | |
122 | return this.pool.getWorkerAverageTasksRunTime(worker) | |
123 | } | |
124 | ||
125 | private computeWorkerWeight (): number { | |
b3432a63 | 126 | let cpusCycleTimeWeight = 0 |
a59e741b | 127 | for (const cpu of cpus()) { |
b3432a63 | 128 | // CPU estimated cycle time |
d8a610ca JB |
129 | const numberOfDigits = cpu.speed.toString().length - 1 |
130 | const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits)) | |
131 | cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits) | |
b3432a63 | 132 | } |
7b0d35b8 | 133 | return Math.round(cpusCycleTimeWeight / cpus().length) |
b3432a63 | 134 | } |
b3432a63 | 135 | } |