added spilling

Author: dderjoel

First_Steps.md

@@ -64,6 +64,7 @@ Parameter    | default     | possible / typical values | description
 --betRatio   | 0.2         | 0.1, 0.3                  | The share from parameter `--evals`, which are spent for all bets, in per cent (i.e. 0.2 means 20% of --evals will be used for the bet part, and 80% for the final run-part)
 --resultDir  | ./results   | /tmp/myresults            | The directory under which `<BRIDGE>/<SYMBOL>` will be created and the result files will be stored
 --no-proof   |             | --no-proof, --proof       | [dis\|en]ables the Fiat-Proofing system. It is enabled by default for `fiat`-bridge, disabled for the rest.
+--spilling   | reversebell | uniform,reversebell       | How to bias where to place an operation during the scheduling mutation. 'reversebell' prefers ends (close to the operation that consumes a value), 'uniform' uniformly selects in the possible interval.
 --memoryConstraints| none  | none, all, out1-arg1      | none: any argN[n] can be read after any outN[n] as been written. That is okay, if all memoy is distinct. 'out1-arg1' specifies that arg1[n] cannnot be read, if out1[n] has been written. It may read arg1[n+m] after out1[n] has been written. Use that if you want to call `mul(r,r,x)` or `sq(a,a)`. all: no argN[n] can be read if any outN[n] has been written. Use that if memory can be overlapping and unaligned.
 
 For more information check `./CryptOpt --help`

completion/_cryptopt

@@ -39,6 +39,7 @@ _arguments -S -s \
     '--memoryConstraints=[Specify any memory contraints. No contraints, all, or out1--arg1 may be aliased]:memorycontraints:->memorycontraintoptions' \
     '--uicaarch=[use uiCA estimation instead of running on hardware.]:uiCAConstraints:->uiCAOptions' \
     '--objectiveFunction=[use objective Function instead of running on hardware.]:objectiveFunctionConstraints:->objectiveFunctionOptions' \
+    '--spilling=[use uniform or biased scheduling mutations]:spillingConstraints:->spillingOptions' \
     '(-h,--help)'{-h,--help}'[Help]:get help prompt' \
     '(--version)'{-v,--version}'[Version]:Version information' \
     && ret=0
@@ -105,6 +106,11 @@ case "$state" in
             'length[length of the function (# instructions)]' \
             'uiCA[throughput estimation from uiCA. Speicfy arch with --uicaarch]' \
             ;;
+    spillingOptions)
+        _values 'spillingConstraints' \
+            'reversebell[bias towards ends of interval]' \
+            'uniform[uniformly at random select from interval]' \
+            ;;
 esac
 
 

src/helper/argParse.ts

@@ -36,6 +36,7 @@ import {
   MEMORY_CONSTRAINTS_OPTIONS,
   ParsedArgsT,
   OBJECTIVE_FUNCTION_OPTIONS,
+  SPILLING,
 } from "../types";
 
 const y = await yargs(process.argv.slice(2));
@@ -233,10 +234,17 @@ export const parsedArgs = y
     default: "cycles",
     string: true,
     describe:
-      "The opjective function which describes which mutation should be kept or discarded. Options: 'cycles' run on hardware, use cycles; stack: size of the used stack slots; length: purely optimise for fewer instructions; uiCA: use uiCA's estimation. Everything but cycles effectively disables monkey-testing becuase the code is not executed.",
+      "The objective function which describes which mutation should be kept or discarded. Options: 'cycles' run on hardware, use cycles; stack: size of the used stack slots; length: purely optimise for fewer instructions; uiCA: use uiCA's estimation. Everything but cycles effectively disables monkey-testing becuase the code is not executed.",
 
     choices: OBJECTIVE_FUNCTION_OPTIONS,
   })
+  .option("spilling", {
+    default: "reversebell",
+    string: true,
+    describe:
+      "How to bias where to place an operation during the scheduling mutation. 'reversebell' , 'uniform' uniformly selects in the possible interval.",
+    choices: SPILLING,
+  })
   .help("help")
   .alias("h", "help")
   .wrap(Math.min(160, y.terminalWidth()))

src/model/model.class.ts

@@ -245,7 +245,7 @@ export class Model {
     return lastRead[0];
   }
 
-  public static mutatePermutation(): void {
+  public static mutatePermutation(bias = BIAS.REVERSE_BELL): void {
     const m = Model.getInstance();
     m.backupbody();
 
@@ -285,7 +285,7 @@ export class Model {
       return this.mutatePermutation();
     }
 
-    const partner = min + 1 == max ? min : Paul.chooseBetween(max, min, BIAS.REVERSE_BELL);
+    const partner = min + 1 == max ? min : Paul.chooseBetween(max, min, bias);
     if (chosen == partner) {
       // would that ever happen ?
       return this.mutatePermutation();

src/optimizer/optimizer.class.ts

@@ -37,7 +37,7 @@ import {
 import globals from "@/helper/globals";
 import Logger from "@/helper/Logger.class";
 import { Model } from "@/model";
-import { Paul, sha1Hash } from "@/paul";
+import { BIAS, Paul, sha1Hash } from "@/paul";
 import { RegisterAllocator } from "@/registerAllocator";
 import type { AnalyseResult, OptimizerArgs } from "@/types";
 
@@ -110,7 +110,7 @@ export class Optimizer {
     Logger.log("Mutationalita");
     switch (choice) {
       case CHOICE.PERMUTE: {
-        Model.mutatePermutation();
+        Model.mutatePermutation(this.args.spilling == "uniform" ? BIAS.UNIFORM : BIAS.REVERSE_BELL);
         this.revertFunction = () => {
           this.numRevert.permutation++;
           Model.revertLastMutation();

src/types/CryptOpt.namespace.ts

@@ -50,9 +50,15 @@ export const OBJECTIVE_FUNCTION_OPTIONS = [
   "length", // purely optimise for fewer instructions
   "uiCA", // use uiCA's estimation
 ] as const;
+export const SPILLING = [
+  "reversebell", // default, prefers ends (close to the operation that consumes a value)
+  "uniform", // 'uniform' uniformly selects in the possible interval.
+] as const;
+
 export type MEMORY_CONSTRAINTS_OPTIONS_T = (typeof MEMORY_CONSTRAINTS_OPTIONS)[number];
 export type UICA_OPTIONS_T = (typeof UICA_OPTIONS)[number];
 export type OBJECTIVE_FUNCTION_OPTIONS_T = (typeof OBJECTIVE_FUNCTION_OPTIONS)[number];
+export type SPILLING_T = (typeof SPILLING)[number];
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace CryptOpt {

src/types/optimizer.types.ts

@@ -21,6 +21,7 @@ import {
   FRAME_POINTER_OPTIONS_T,
   MEMORY_CONSTRAINTS_OPTIONS_T,
   OBJECTIVE_FUNCTION_OPTIONS_T,
+  SPILLING_T,
   UICA_OPTIONS_T,
 } from "@/types";
 
@@ -45,6 +46,7 @@ export type OptimizerArgs = {
   memoryConstraints: MEMORY_CONSTRAINTS_OPTIONS_T;
   uicaarch: UICA_OPTIONS_T;
   objectiveFunction: OBJECTIVE_FUNCTION_OPTIONS_T;
+  spilling: SPILLING_T;
 };
 export type ParsedArgsT = OptimizerArgs & {
   startFromBestJson: boolean;