Merge pull request #731 from pq-code-package/multi_simp

Simplify configurations in multilevel example
pq-code-package · Feb 2, 2025 · f205192 · f205192 · oqs-bot · Feb 2, 2025
2 parents b6ad677 + 378f65c
commit f205192
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 263 deletions.
diff --git a/examples/monolithic_build_multilevel/README.md b/examples/monolithic_build_multilevel/README.md
@@ -10,9 +10,9 @@ files. Moreover, it clears all `#define`s clauses set by mlkem-native at the end
 inclusion in another compilation unit.
 
 The manually written source file [mlkem_native_all.c](mlkem_native_all.c) includes
-[mlkem_native_monobuild.c](mlkem_native_monobuild.c) three times, once for each of the three configuration files
-[config_512.h](config_512.h), [config_768.h](config_768.h),
-[config_1024.h](config_1024.h) for the different levels. For each inclusion, it sets `MLKEM_NATIVE_CONFIG_FILE`
+[mlkem_native_monobuild.c](mlkem_native_monobuild.c) three times, each time using the fixed config
+[multilevel_config.h](multilevel_config.h), but changing the security level (specified
+by `MLKEM_K`) every time. For each inclusion, it sets `MLKEM_NATIVE_CONFIG_FILE`
 appropriately first, and then includes the monobuild:
 ```C
 /* Three instances of mlkem-native for all security levels */
@@ -21,19 +21,22 @@ appropriately first, and then includes the monobuild:
 #define MLKEM_NATIVE_MULTILEVEL_BUILD_WITH_SHARED
 #define MLKEM_NATIVE_MONOBUILD_KEEP_SHARED_HEADERS
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_512.h"
+#define MLKEM_K 2
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE
 
 /* Exclude level-independent code */
 #undef MLKEM_NATIVE_MULTILEVEL_BUILD_WITH_SHARED
 #define MLKEM_NATIVE_MULTILEVEL_BUILD_NO_SHARED
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_1024.h"
+#define MLKEM_K 3
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_768.h"
+#define MLKEM_K 4
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #undef MLKEM_NATIVE_MONOBUILD_KEEP_SHARED_HEADERS
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE

diff --git a/examples/monolithic_build_multilevel/config_1024.h b/examples/monolithic_build_multilevel/config_1024.h
diff --git a/examples/monolithic_build_multilevel/config_512.h b/examples/monolithic_build_multilevel/config_512.h
diff --git a/examples/monolithic_build_multilevel/mlkem_native_all.c b/examples/monolithic_build_multilevel/mlkem_native_all.c
@@ -11,19 +11,22 @@
 #define MLKEM_NATIVE_MULTILEVEL_BUILD_WITH_SHARED
 #define MLKEM_NATIVE_MONOBUILD_KEEP_SHARED_HEADERS
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_512.h"
+#define MLKEM_K 2
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE
 
 /* Exclude level-independent code */
 #undef MLKEM_NATIVE_MULTILEVEL_BUILD_WITH_SHARED
 #define MLKEM_NATIVE_MULTILEVEL_BUILD_NO_SHARED
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_1024.h"
+#define MLKEM_K 3
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE
 
-#define MLKEM_NATIVE_CONFIG_FILE "config_768.h"
+#define MLKEM_K 4
+#define MLKEM_NATIVE_CONFIG_FILE "multilevel_config.h"
 #undef MLKEM_NATIVE_MONOBUILD_KEEP_SHARED_HEADERS
 #include "mlkem_native_monobuild.c"
 #undef MLKEM_NATIVE_CONFIG_FILE
diff --git a/.../monolithic_build_multilevel/config_768.h → ...thic_build_multilevel/multilevel_config.h b/.../monolithic_build_multilevel/config_768.h → ...thic_build_multilevel/multilevel_config.h
diff --git a/scripts/simpasm b/scripts/simpasm
@@ -99,7 +99,7 @@ def find_header_footer(asm, filename):
 def find_globals(asm):
     global_symbols = []
     for l in asm:
-        r = re.search("^\s*\.global\s+(.*)$", l)
+        r = re.search(r"^\s*\.global\s+(.*)$", l)
         if r is None:
             continue
         global_symbols.append(r.group(1))
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`9305` cycles	`9293` cycles	`1.00`
`ML-KEM-512 encaps`	`10836` cycles	`10795` cycles	`1.00`
`ML-KEM-512 decaps`	`14796` cycles	`14761` cycles	`1.00`
`ML-KEM-768 keypair`	`15863` cycles	`15953` cycles	`0.99`
`ML-KEM-768 encaps`	`17162` cycles	`17246` cycles	`1.00`
`ML-KEM-768 decaps`	`22853` cycles	`22934` cycles	`1.00`
`ML-KEM-1024 keypair`	`21319` cycles	`21315` cycles	`1.00`
`ML-KEM-1024 encaps`	`23256` cycles	`23268` cycles	`1.00`
`ML-KEM-1024 decaps`	`30705` cycles	`30732` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`28941` cycles	`28947` cycles	`1.00`
`ML-KEM-512 encaps`	`34281` cycles	`34270` cycles	`1.00`
`ML-KEM-512 decaps`	`44766` cycles	`44769` cycles	`1.00`
`ML-KEM-768 keypair`	`49281` cycles	`49281` cycles	`1`
`ML-KEM-768 encaps`	`54588` cycles	`54590` cycles	`1.00`
`ML-KEM-768 decaps`	`69409` cycles	`69408` cycles	`1.00`
`ML-KEM-1024 keypair`	`71913` cycles	`71910` cycles	`1.00`
`ML-KEM-1024 encaps`	`80615` cycles	`80612` cycles	`1.00`
`ML-KEM-1024 decaps`	`100361` cycles	`100356` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`29649` cycles	`29636` cycles	`1.00`
`ML-KEM-512 encaps`	`35326` cycles	`35300` cycles	`1.00`
`ML-KEM-512 decaps`	`45910` cycles	`45995` cycles	`1.00`
`ML-KEM-768 keypair`	`47211` cycles	`47126` cycles	`1.00`
`ML-KEM-768 encaps`	`55622` cycles	`55591` cycles	`1.00`
`ML-KEM-768 decaps`	`67646` cycles	`67579` cycles	`1.00`
`ML-KEM-1024 keypair`	`71739` cycles	`71804` cycles	`1.00`
`ML-KEM-1024 encaps`	`82019` cycles	`82219` cycles	`1.00`
`ML-KEM-1024 decaps`	`99307` cycles	`99455` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`11276` cycles	`11277` cycles	`1.00`
`ML-KEM-512 encaps`	`12843` cycles	`12825` cycles	`1.00`
`ML-KEM-512 decaps`	`17668` cycles	`17693` cycles	`1.00`
`ML-KEM-768 keypair`	`19601` cycles	`19622` cycles	`1.00`
`ML-KEM-768 encaps`	`20582` cycles	`20597` cycles	`1.00`
`ML-KEM-768 decaps`	`27697` cycles	`27681` cycles	`1.00`
`ML-KEM-1024 keypair`	`26351` cycles	`26376` cycles	`1.00`
`ML-KEM-1024 encaps`	`28157` cycles	`28163` cycles	`1.00`
`ML-KEM-1024 decaps`	`37649` cycles	`37645` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`15908` cycles	`15918` cycles	`1.00`
`ML-KEM-512 encaps`	`18024` cycles	`18028` cycles	`1.00`
`ML-KEM-512 decaps`	`24503` cycles	`24511` cycles	`1.00`
`ML-KEM-768 keypair`	`27351` cycles	`27367` cycles	`1.00`
`ML-KEM-768 encaps`	`28948` cycles	`28959` cycles	`1.00`
`ML-KEM-768 decaps`	`38371` cycles	`38387` cycles	`1.00`
`ML-KEM-1024 keypair`	`36924` cycles	`36994` cycles	`1.00`
`ML-KEM-1024 encaps`	`39879` cycles	`39941` cycles	`1.00`
`ML-KEM-1024 decaps`	`52323` cycles	`52416` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`16968` cycles	`16976` cycles	`1.00`
`ML-KEM-512 encaps`	`18660` cycles	`18670` cycles	`1.00`
`ML-KEM-512 decaps`	`24053` cycles	`24013` cycles	`1.00`
`ML-KEM-768 keypair`	`28713` cycles	`28762` cycles	`1.00`
`ML-KEM-768 encaps`	`29885` cycles	`29830` cycles	`1.00`
`ML-KEM-768 decaps`	`37600` cycles	`37565` cycles	`1.00`
`ML-KEM-1024 keypair`	`41711` cycles	`41952` cycles	`0.99`
`ML-KEM-1024 encaps`	`43859` cycles	`43967` cycles	`1.00`
`ML-KEM-1024 decaps`	`54184` cycles	`54155` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`17729` cycles	`17724` cycles	`1.00`
`ML-KEM-512 encaps`	`20974` cycles	`20976` cycles	`1.00`
`ML-KEM-512 decaps`	`27656` cycles	`27652` cycles	`1.00`
`ML-KEM-768 keypair`	`30514` cycles	`30515` cycles	`1.00`
`ML-KEM-768 encaps`	`33408` cycles	`33406` cycles	`1.00`
`ML-KEM-768 decaps`	`42990` cycles	`42989` cycles	`1.00`
`ML-KEM-1024 keypair`	`44137` cycles	`44136` cycles	`1.00`
`ML-KEM-1024 encaps`	`49440` cycles	`49417` cycles	`1.00`
`ML-KEM-1024 decaps`	`62366` cycles	`62344` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`36068` cycles	`36077` cycles	`1.00`
`ML-KEM-512 encaps`	`42300` cycles	`42310` cycles	`1.00`
`ML-KEM-512 decaps`	`55417` cycles	`55439` cycles	`1.00`
`ML-KEM-768 keypair`	`58471` cycles	`58485` cycles	`1.00`
`ML-KEM-768 encaps`	`66926` cycles	`66962` cycles	`1.00`
`ML-KEM-768 decaps`	`84172` cycles	`84598` cycles	`0.99`
`ML-KEM-1024 keypair`	`86479` cycles	`86565` cycles	`1.00`
`ML-KEM-1024 encaps`	`97191` cycles	`97227` cycles	`1.00`
`ML-KEM-1024 decaps`	`118867` cycles	`118852` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`28948` cycles	`28943` cycles	`1.00`
`ML-KEM-512 encaps`	`34283` cycles	`34277` cycles	`1.00`
`ML-KEM-512 decaps`	`44784` cycles	`44782` cycles	`1.00`
`ML-KEM-768 keypair`	`49252` cycles	`49252` cycles	`1`
`ML-KEM-768 encaps`	`54606` cycles	`54610` cycles	`1.00`
`ML-KEM-768 decaps`	`69450` cycles	`69446` cycles	`1.00`
`ML-KEM-1024 keypair`	`71939` cycles	`71912` cycles	`1.00`
`ML-KEM-1024 encaps`	`80611` cycles	`80593` cycles	`1.00`
`ML-KEM-1024 decaps`	`100413` cycles	`100446` cycles	`1.00`
Benchmark suite	Current: `f205192`	Previous: `b6ad677`	Ratio
`ML-KEM-512 keypair`	`46461` cycles	`46502` cycles	`1.00`
`ML-KEM-512 encaps`	`54610` cycles	`54682` cycles	`1.00`
`ML-KEM-512 decaps`	`70324` cycles	`70417` cycles	`1.00`
`ML-KEM-768 keypair`	`76718` cycles	`76744` cycles	`1.00`
`ML-KEM-768 encaps`	`87413` cycles	`87371` cycles	`1.00`
`ML-KEM-768 decaps`	`107834` cycles	`107836` cycles	`1.00`
`ML-KEM-1024 keypair`	`112127` cycles	`112227` cycles	`1.00`
`ML-KEM-1024 encaps`	`126181` cycles	`126287` cycles	`1.00`
`ML-KEM-1024 decaps`	`152297` cycles	`152374` cycles	`1.00`