Merge pull request #4948 from randombit/jack/internal-feat-macros

Add the concept of an internal feature macro definition

Author: randombit

configure.py

@@ -841,7 +841,7 @@ def __init__(self, infofile):
             infofile,
             ['header:internal', 'header:public', 'header:external', 'requires',
              'os_features', 'arch', 'isa', 'cc', 'comment', 'warning'],
-            ['defines', 'libs', 'frameworks', 'module_info'],
+            ['defines', 'internal_defines', 'libs', 'frameworks', 'module_info'],
             {
                 'load_on': 'auto',
             })
@@ -890,6 +890,8 @@ def combine_lines(c):
         self.comment = combine_lines(lex.comment)
         self._defines = lex.defines
         self._validate_defines_content(self._defines)
+        self._internal_defines = lex.internal_defines
+        self._validate_defines_content(self._internal_defines)
         self.frameworks = convert_lib_list(lex.frameworks)
         self.libs = convert_lib_list(lex.libs)
         self.load_on = lex.load_on
@@ -1017,6 +1019,9 @@ def isas_needed(self, arch):
     def defines(self):
         return [(key + ' ' + value) for key, value in self._defines.items()]
 
+    def internal_defines(self):
+        return [(key + ' ' + value) for key, value in self._internal_defines.items()]
+
     def compatible_cpu(self, archinfo, options):
         arch_name = archinfo.basename
         cpu_name = options.arch
@@ -2322,6 +2327,7 @@ def test_exe_extra_ldflags():
         'internal_include_flags': build_paths.format_internal_include_flags(cc),
         'external_include_flags': build_paths.format_external_include_flags(cc, options.with_external_includedir),
         'module_defines': sorted(flatten([m.defines() for m in modules])),
+        'module_internal_defines': sorted(flatten([m.internal_defines() for m in modules])),
 
         'build_bogo_shim': bool('bogo_shim' in options.build_targets),
         'bogo_shim_src': os.path.join(source_paths.src_dir, 'bogo_shim', 'bogo_shim.cpp'),

src/build-data/buildh.in

@@ -139,6 +139,17 @@
 #define BOTAN_HAS_%{i}
 %{endfor}
 
+/*
+* Internal module feature definitions
+*
+* These macros have been in the past visible in build.h as feature macros
+* but in the future these will be only visible in an internal header.
+* Applications should not rely on or check for these macros.
+*/
+%{for module_internal_defines}
+#define BOTAN_HAS_%{i}
+%{endfor}
+
 /**
  * @}
  */

src/lib/block/aes/aes_armv8/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 AES_ARMV8 -> 20170903
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "AES ARMv8"

src/lib/block/aes/aes_ni/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 AES_NI -> 20131128
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "AES-NI"

src/lib/block/aes/aes_power8/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 AES_POWER8 -> 20180223
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "AES Power8"

src/lib/block/aes/aes_vaes/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 AES_VAES -> 20240803
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "AES-VAES"

src/lib/block/aes/aes_vperm/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 AES_VPERM -> 20190901
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "AES Vector Permutation"

src/lib/block/camellia/camellia_gfni/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 CAMELLIA_GFNI -> 20250502
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "Camellia using GFNI"

src/lib/block/idea/idea_sse2/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 IDEA_SSE2 -> 20131128
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "IDEA SSE2"

src/lib/block/noekeon/noekeon_simd/info.txt

@@ -1,6 +1,6 @@
-<defines>
+<internal_defines>
 NOEKEON_SIMD -> 20160903
-</defines>
+</internal_defines>
 
 <module_info>
 name -> "Noekeon SIMD"