Add CBMC spec and proof for aarch64 poly_caddq native function

Signed-off-by: Matthias J. Kannwischer <[email protected]>

Author: mkannwischer

dev/aarch64_clean/src/arith_native_aarch64.h

@@ -8,6 +8,7 @@
 #define MLD_NATIVE_AARCH64_SRC_ARITH_NATIVE_AARCH64_H
 
 #include <stdint.h>
+#include "../../../cbmc.h"
 #include "../../../common.h"
 
 #define mld_aarch64_ntt_zetas_layer123456 \
@@ -74,7 +75,15 @@ void mld_poly_decompose_32_asm(int32_t *a1, int32_t *a0);
 void mld_poly_decompose_88_asm(int32_t *a1, int32_t *a0);
 
 #define mld_poly_caddq_asm MLD_NAMESPACE(poly_caddq_asm)
-void mld_poly_caddq_asm(int32_t *a);
+void mld_poly_caddq_asm(int32_t *a)
+/* This must be kept in sync with the HOL-Light specification
+ * in proofs/hol_light/aarch64/proofs/mldsa_poly_caddq.ml */
+__contract__(
+  requires(memory_no_alias(a, sizeof(int32_t) * MLDSA_N))
+  requires(array_abs_bound(a, 0, MLDSA_N, MLDSA_Q))
+  assigns(memory_slice(a, sizeof(int32_t) * MLDSA_N))
+  ensures(array_bound(a, 0, MLDSA_N, 0, MLDSA_Q))
+);
 
 #define mld_poly_use_hint_32_asm MLD_NAMESPACE(poly_use_hint_32_asm)
 void mld_poly_use_hint_32_asm(int32_t *b, const int32_t *a, const int32_t *h);

dev/aarch64_opt/src/arith_native_aarch64.h

@@ -8,6 +8,7 @@
 #define MLD_NATIVE_AARCH64_SRC_ARITH_NATIVE_AARCH64_H
 
 #include <stdint.h>
+#include "../../../cbmc.h"
 #include "../../../common.h"
 
 #define mld_aarch64_ntt_zetas_layer123456 \
@@ -74,7 +75,15 @@ void mld_poly_decompose_32_asm(int32_t *a1, int32_t *a0);
 void mld_poly_decompose_88_asm(int32_t *a1, int32_t *a0);
 
 #define mld_poly_caddq_asm MLD_NAMESPACE(poly_caddq_asm)
-void mld_poly_caddq_asm(int32_t *a);
+void mld_poly_caddq_asm(int32_t *a)
+/* This must be kept in sync with the HOL-Light specification
+ * in proofs/hol_light/aarch64/proofs/mldsa_poly_caddq.ml */
+__contract__(
+  requires(memory_no_alias(a, sizeof(int32_t) * MLDSA_N))
+  requires(array_abs_bound(a, 0, MLDSA_N, MLDSA_Q))
+  assigns(memory_slice(a, sizeof(int32_t) * MLDSA_N))
+  ensures(array_bound(a, 0, MLDSA_N, 0, MLDSA_Q))
+);
 
 #define mld_poly_use_hint_32_asm MLD_NAMESPACE(poly_use_hint_32_asm)
 void mld_poly_use_hint_32_asm(int32_t *b, const int32_t *a, const int32_t *h);

mldsa/src/native/aarch64/src/arith_native_aarch64.h

@@ -8,6 +8,7 @@
 #define MLD_NATIVE_AARCH64_SRC_ARITH_NATIVE_AARCH64_H
 
 #include <stdint.h>
+#include "../../../cbmc.h"
 #include "../../../common.h"
 
 #define mld_aarch64_ntt_zetas_layer123456 \
@@ -74,7 +75,15 @@ void mld_poly_decompose_32_asm(int32_t *a1, int32_t *a0);
 void mld_poly_decompose_88_asm(int32_t *a1, int32_t *a0);
 
 #define mld_poly_caddq_asm MLD_NAMESPACE(poly_caddq_asm)
-void mld_poly_caddq_asm(int32_t *a);
+void mld_poly_caddq_asm(int32_t *a)
+/* This must be kept in sync with the HOL-Light specification
+ * in proofs/hol_light/aarch64/proofs/mldsa_poly_caddq.ml */
+__contract__(
+  requires(memory_no_alias(a, sizeof(int32_t) * MLDSA_N))
+  requires(array_abs_bound(a, 0, MLDSA_N, MLDSA_Q))
+  assigns(memory_slice(a, sizeof(int32_t) * MLDSA_N))
+  ensures(array_bound(a, 0, MLDSA_N, 0, MLDSA_Q))
+);
 
 #define mld_poly_use_hint_32_asm MLD_NAMESPACE(poly_use_hint_32_asm)
 void mld_poly_use_hint_32_asm(int32_t *b, const int32_t *a, const int32_t *h);

proofs/cbmc/poly_caddq_native_aarch64/Makefile

@@ -0,0 +1,58 @@
+# Copyright (c) The mldsa-native project authors
+# SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+include ../Makefile_params.common
+
+HARNESS_ENTRY = harness
+HARNESS_FILE = poly_caddq_native_aarch64_harness
+
+# This should be a unique identifier for this proof, and will appear on the
+# Litani dashboard. It can be human-readable and contain spaces if you wish.
+PROOF_UID = poly_caddq_native_aarch64
+
+# We need to set MLD_CHECK_APIS as otherwise mldsa/src/native/api.h won't be
+# included, which contains the CBMC specifications.
+DEFINES += -DMLD_CONFIG_USE_NATIVE_BACKEND_ARITH -DMLD_CONFIG_ARITH_BACKEND_FILE="\"$(SRCDIR)/mldsa/src/native/aarch64/meta.h\"" -DMLD_CHECK_APIS
+INCLUDES +=
+
+REMOVE_FUNCTION_BODY +=
+UNWINDSET +=
+
+PROOF_SOURCES += $(PROOFDIR)/$(HARNESS_FILE).c
+PROJECT_SOURCES += $(SRCDIR)/mldsa/src/poly.c
+
+CHECK_FUNCTION_CONTRACTS=mld_poly_caddq_native
+USE_FUNCTION_CONTRACTS = $(MLD_NAMESPACE)poly_caddq_asm
+USE_FUNCTION_CONTRACTS += mld_sys_check_capability
+APPLY_LOOP_CONTRACTS=on
+USE_DYNAMIC_FRAMES=1
+
+# Disable any setting of EXTERNAL_SAT_SOLVER, and choose SMT backend instead
+EXTERNAL_SAT_SOLVER=
+CBMCFLAGS=--smt2
+
+FUNCTION_NAME = poly_caddq_native_aarch64
+
+# If this proof is found to consume huge amounts of RAM, you can set the
+# EXPENSIVE variable. With new enough versions of the proof tools, this will
+# restrict the number of EXPENSIVE CBMC jobs running at once. See the
+# documentation in Makefile.common under the "Job Pools" heading for details.
+# EXPENSIVE = true
+
+# This function is large enough to need...
+CBMC_OBJECT_BITS = 8
+
+# If you require access to a file-local ("static") function or object to conduct
+# your proof, set the following (and do not include the original source file
+# ("mldsa/src/poly.c") in PROJECT_SOURCES).
+# REWRITTEN_SOURCES = $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i
+# include ../Makefile.common
+# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_SOURCE = $(SRCDIR)/mldsa/src/poly.c
+# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_FUNCTIONS = foo bar
+# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_OBJECTS = baz
+# Care is required with variables on the left-hand side: REWRITTEN_SOURCES must
+# be set before including Makefile.common, but any use of variables on the
+# left-hand side requires those variables to be defined. Hence, _SOURCE,
+# _FUNCTIONS, _OBJECTS is set after including Makefile.common.
+
+include ../Makefile.common

proofs/cbmc/poly_caddq_native_aarch64/poly_caddq_native_aarch64_harness.c

@@ -0,0 +1,15 @@
+// Copyright (c) The mldsa-native project authors
+// SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
+
+#include <stdint.h>
+#include "cbmc.h"
+#include "params.h"
+
+int mld_poly_caddq_native(int32_t a[MLDSA_N]);
+
+void harness(void)
+{
+  int32_t *a;
+  int t;
+  t = mld_poly_caddq_native(a);
+}