X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fabstract-worker-choice-strategy.ts;h=d9a573417ec2f96c0cbf68bc88a6931aeb68de29;hb=930dcf12982091cb5658b5a44acd47676fbae631;hp=bddb8b76566fd62545e1552618712dc39d98e7b9;hpb=cb70b19deb97dc2c8ad1a769e59e870ee37f8e4d;p=poolifier.git

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index bddb8b76..d9a57341 100644
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -1,9 +1,10 @@
+import { cpus } from 'node:os'
 import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
-import { PoolType, type IPool } from '../pool'
+import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
@@ -24,12 +25,22 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   private toggleFindLastFreeWorkerNodeKey: boolean = false
   /** @inheritDoc */
-  protected readonly isDynamicPool: boolean
-  /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
-    runTime: false,
-    avgRunTime: false,
-    medRunTime: false
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
+    waitTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
+    elu: {
+      aggregate: false,
+      average: false,
+      median: false
+    }
   }
 
   /**
@@ -42,24 +53,66 @@ export abstract class AbstractWorkerChoiceStrategy<
     protected readonly pool: IPool<Worker, Data, Response>,
     protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
-    this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
     this.choose = this.choose.bind(this)
   }
 
-  protected checkOptions (opts: WorkerChoiceStrategyOptions): void {
-    if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
-      this.requiredStatistics.avgRunTime = false
-      this.requiredStatistics.medRunTime = opts.medRunTime as boolean
+  protected setTaskStatisticsRequirements (
+    opts: WorkerChoiceStrategyOptions
+  ): void {
+    if (
+      this.taskStatisticsRequirements.runTime.average &&
+      opts.runTime?.median === true
+    ) {
+      this.taskStatisticsRequirements.runTime.average = false
+      this.taskStatisticsRequirements.runTime.median = opts.runTime
+        .median as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.runTime.median &&
+      opts.runTime?.median === false
+    ) {
+      this.taskStatisticsRequirements.runTime.average = true
+      this.taskStatisticsRequirements.runTime.median = opts.runTime
+        .median as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.waitTime.average &&
+      opts.waitTime?.median === true
+    ) {
+      this.taskStatisticsRequirements.waitTime.average = false
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.waitTime.median &&
+      opts.waitTime?.median === false
+    ) {
+      this.taskStatisticsRequirements.waitTime.average = true
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.elu.average &&
+      opts.elu?.median === true
+    ) {
+      this.taskStatisticsRequirements.elu.average = false
+      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
     }
-    if (this.requiredStatistics.medRunTime && opts.medRunTime === false) {
-      this.requiredStatistics.avgRunTime = true
-      this.requiredStatistics.medRunTime = opts.medRunTime as boolean
+    if (
+      this.taskStatisticsRequirements.elu.median &&
+      opts.elu?.median === false
+    ) {
+      this.taskStatisticsRequirements.elu.average = true
+      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
     }
   }
 
   /** @inheritDoc */
   public abstract reset (): boolean
 
+  /** @inheritDoc */
+  public abstract update (workerNodeKey: number): boolean
+
   /** @inheritDoc */
   public abstract choose (): number
 
@@ -69,7 +122,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
     opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.checkOptions(opts)
+    this.setTaskStatisticsRequirements(opts)
     this.opts = opts
   }
 
@@ -81,9 +134,105 @@ export abstract class AbstractWorkerChoiceStrategy<
   protected findFreeWorkerNodeKey (): number {
     if (this.toggleFindLastFreeWorkerNodeKey) {
       this.toggleFindLastFreeWorkerNodeKey = false
-      return this.pool.findLastFreeWorkerNodeKey()
+      return this.findLastFreeWorkerNodeKey()
     }
     this.toggleFindLastFreeWorkerNodeKey = true
-    return this.pool.findFreeWorkerNodeKey()
+    return this.findFirstFreeWorkerNodeKey()
+  }
+
+  /**
+   * Gets the worker task runtime.
+   * If the task statistics require the average runtime, the average runtime is returned.
+   * If the task statistics require the median runtime , the median runtime is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task runtime.
+   */
+  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.runTime.median
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+  }
+
+  /**
+   * Gets the worker task wait time.
+   * If the task statistics require the average wait time, the average wait time is returned.
+   * If the task statistics require the median wait time, the median wait time is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task wait time.
+   */
+  protected getWorkerTaskWaitTime (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.waitTime.median
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+  }
+
+  /**
+   * Gets the worker task ELU.
+   * If the task statistics require the average ELU, the average ELU is returned.
+   * If the task statistics require the median ELU, the median ELU is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task ELU.
+   */
+  protected getWorkerTaskElu (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.elu.median
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.average
+  }
+
+  protected computeDefaultWorkerWeight (): number {
+    let cpusCycleTimeWeight = 0
+    for (const cpu of cpus()) {
+      // CPU estimated cycle time
+      const numberOfDigits = cpu.speed.toString().length - 1
+      const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
+      cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
+    }
+    return Math.round(cpusCycleTimeWeight / cpus().length)
+  }
+
+  /**
+   * Finds the first free worker node key based on the number of tasks the worker has applied.
+   *
+   * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
+   *
+   * If no free worker is found, `-1` is returned.
+   *
+   * @returns A worker node key if there is one, `-1` otherwise.
+   */
+  private findFirstFreeWorkerNodeKey (): number {
+    return this.pool.workerNodes.findIndex(workerNode => {
+      return workerNode.workerUsage.tasks.executing === 0
+    })
+  }
+
+  /**
+   * Finds the last free worker node key based on the number of tasks the worker has applied.
+   *
+   * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
+   *
+   * If no free worker is found, `-1` is returned.
+   *
+   * @returns A worker node key if there is one, `-1` otherwise.
+   */
+  private findLastFreeWorkerNodeKey (): number {
+    // It requires node >= 18.0.0:
+    // return this.workerNodes.findLastIndex(workerNode => {
+    //   return workerNode.workerUsage.tasks.executing === 0
+    // })
+    for (
+      let workerNodeKey = this.pool.workerNodes.length - 1;
+      workerNodeKey >= 0;
+      workerNodeKey--
+    ) {
+      if (
+        this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
+      ) {
+        return workerNodeKey
+      }
+    }
+    return -1
   }
 }