use _Py prefix to prevent public namespace pollution

python · picnixz · Oct 5, 2024 · Oct 5, 2024 · Oct 5, 2024 · Oct 6, 2024
commit 8b7ecfb856508896e90fd9142968ac6cc2389dda
diff --git a/Include/internal/pycore_cpuinfo.h b/Include/internal/pycore_cpuinfo.h
@@ -27,10 +27,10 @@ extern "C" {
 #include "pycore_cpuinfo_cpuid_features.h"
 #include "pycore_cpuinfo_xsave_features.h"
 
-typedef struct py_cpuid_features {
+typedef struct _Py_cpuid_features_s {
     uint32_t maxleaf;
     /*
-     * Macro to declare a member flag of 'py_cpuid_features' as a uint8_t.
+     * Macro to declare a member flag of '_Py_cpuid_features' as a uint8_t.
      * Whenever this macro is used, do not forget to update the number of
      * fields and the bitsize of the 'ready' member (see structure end).
      */
@@ -116,7 +116,7 @@ typedef struct py_cpuid_features {
     // number of fields (40) and adjust the bitsize of 'ready'
     // so that the size of this structure is a multiple of 8.
     uint8_t ready; // set if the structure is ready for usage
-} py_cpuid_features;
+} _Py_cpuid_features;
 
 /*
  * Explicitly initialize all members to zero to guarantee that
@@ -128,7 +128,7 @@ typedef struct py_cpuid_features {
  * Note: This function does not set any exception and thus never fails.
  */
 PyAPI_FUNC(void)
-_Py_cpuid_disable_features(py_cpuid_features *flags);
+_Py_cpuid_disable_features(_Py_cpuid_features *flags);
 
 /*
  * Check whether the structure is ready and flags are inter-compatible,
@@ -140,7 +140,7 @@ _Py_cpuid_disable_features(py_cpuid_features *flags);
  * Note: This function does not set any exception and thus never fails.
  */
 PyAPI_FUNC(int)
-_Py_cpuid_check_features(const py_cpuid_features *flags);
+_Py_cpuid_check_features(const _Py_cpuid_features *flags);
 
 /*
  * Return 1 if all expected flags are set in 'actual', 0 otherwise.
@@ -150,8 +150,8 @@ _Py_cpuid_check_features(const py_cpuid_features *flags);
  * Note: This function does not set any exception and thus never fails.
  */
 PyAPI_FUNC(int)
-_Py_cpuid_has_features(const py_cpuid_features *actual,
-                       const py_cpuid_features *expect);
+_Py_cpuid_has_features(const _Py_cpuid_features *actual,
+                       const _Py_cpuid_features *expect);
 
 /*
  * Return 1 if 'actual' and 'expect' are identical, 0 otherwise.
@@ -161,16 +161,16 @@ _Py_cpuid_has_features(const py_cpuid_features *actual,
  * Note: This function does not set any exception and thus never fails.
  */
 PyAPI_FUNC(int)
-_Py_cpuid_match_features(const py_cpuid_features *actual,
-                         const py_cpuid_features *expect);
+_Py_cpuid_match_features(const _Py_cpuid_features *actual,
+                         const _Py_cpuid_features *expect);
 
 /*
- * Detect the available features on this machine, storing the result in 'flags'.
+ * Detect the available host features, storing the result in 'flags'.
  *
  * Note: This function does not set any exception and thus never fails.
  */
 PyAPI_FUNC(void)
-_Py_cpuid_detect_features(py_cpuid_features *flags);
+_Py_cpuid_detect_features(_Py_cpuid_features *flags);
 
 #ifdef __cplusplus
 }

diff --git a/Include/internal/pycore_cpuinfo_cpuid_features.h b/Include/internal/pycore_cpuinfo_cpuid_features.h
@@ -1,10 +1,10 @@
-/*
+/**
  * @author Bénédikt Tran
- * @seealso Tools/cpuinfo/cpuid_features_gen.py
+ * @seealso @file Tools/cpuinfo/cpuid_features_gen.py
  *
  * The enumeration describes masks to apply on CPUID output registers.
  *
- * Member names are Py_CPUID_MASK_<REGISTER>_L<LEAF>[S<SUBLEAF>]_<FEATURE>,
+ * Member names are _Py_CPUID_MASK_<REGISTER>_L<LEAF>[S<SUBLEAF>]_<FEATURE>,
  * where <> (resp. []) denotes a required (resp. optional) group and:
  *
  * - REGISTER is EAX, EBX, ECX or EDX,
@@ -35,68 +35,59 @@ extern "C" {
 
 #include "Python.h"
 
-// fmt: off
 /*[python input]
-import importlib
-import os
-import sys
-
-ROOT = os.getcwd()
-TOOL = os.path.join(ROOT, "Tools/cpuinfo/cpuid_features_gen.py")
-TOOL = os.path.realpath(TOOL)
-
-if not os.path.exists(TOOL):
-    raise FileNotFoundError(TOOL)
-
-sys.path.insert(0, os.path.dirname(os.path.dirname(TOOL)))
-module = importlib.import_module("cpuinfo.cpuid_features_gen")
-print(module.generate_cpuid_features_enum("py_cpuid_feature_mask"))
+import os, sys
+sys.path.insert(0, os.path.realpath(os.path.join(os.getcwd(), "Tools")))
+from cpuinfo.cpuid_features_gen import generate_cpuid_features_enum
+print(generate_cpuid_features_enum("_Py_cpuid_feature_mask"))
 [python start generated code]*/
-typedef enum py_cpuid_feature_mask {
+// fmt: off
+/** Enumeration for CPUID features */
+enum _Py_cpuid_feature_mask_e {
     /* CPUID (LEAF=1, SUBLEAF=0) [ECX] */
-    Py_CPUID_MASK_ECX_L1_SSE3                   = 0x00000001,    // bit = 0
-    Py_CPUID_MASK_ECX_L1_PCLMULQDQ              = 0x00000002,    // bit = 1
-    Py_CPUID_MASK_ECX_L1_SSSE3                  = 0x00000200,    // bit = 9
-    Py_CPUID_MASK_ECX_L1_FMA                    = 0x00001000,    // bit = 12
-    Py_CPUID_MASK_ECX_L1_SSE4_1                 = 0x00080000,    // bit = 19
-    Py_CPUID_MASK_ECX_L1_SSE4_2                 = 0x00100000,    // bit = 20
-    Py_CPUID_MASK_ECX_L1_POPCNT                 = 0x00800000,    // bit = 23
-    Py_CPUID_MASK_ECX_L1_XSAVE                  = 0x04000000,    // bit = 26
-    Py_CPUID_MASK_ECX_L1_OSXSAVE                = 0x08000000,    // bit = 27
-    Py_CPUID_MASK_ECX_L1_AVX                    = 0x10000000,    // bit = 28
+    _Py_CPUID_MASK_ECX_L1_SSE3                  = 0x00000001,    // bit = 0
+    _Py_CPUID_MASK_ECX_L1_PCLMULQDQ             = 0x00000002,    // bit = 1
+    _Py_CPUID_MASK_ECX_L1_SSSE3                 = 0x00000200,    // bit = 9
+    _Py_CPUID_MASK_ECX_L1_FMA                   = 0x00001000,    // bit = 12
+    _Py_CPUID_MASK_ECX_L1_SSE4_1                = 0x00080000,    // bit = 19
+    _Py_CPUID_MASK_ECX_L1_SSE4_2                = 0x00100000,    // bit = 20
+    _Py_CPUID_MASK_ECX_L1_POPCNT                = 0x00800000,    // bit = 23
+    _Py_CPUID_MASK_ECX_L1_XSAVE                 = 0x04000000,    // bit = 26
+    _Py_CPUID_MASK_ECX_L1_OSXSAVE               = 0x08000000,    // bit = 27
+    _Py_CPUID_MASK_ECX_L1_AVX                   = 0x10000000,    // bit = 28
     /* CPUID (LEAF=1, SUBLEAF=0) [EDX] */
-    Py_CPUID_MASK_EDX_L1_CMOV                   = 0x00008000,    // bit = 15
-    Py_CPUID_MASK_EDX_L1_SSE                    = 0x02000000,    // bit = 25
-    Py_CPUID_MASK_EDX_L1_SSE2                   = 0x04000000,    // bit = 26
+    _Py_CPUID_MASK_EDX_L1_CMOV                  = 0x00008000,    // bit = 15
+    _Py_CPUID_MASK_EDX_L1_SSE                   = 0x02000000,    // bit = 25
+    _Py_CPUID_MASK_EDX_L1_SSE2                  = 0x04000000,    // bit = 26
     /* CPUID (LEAF=7, SUBLEAF=0) [EBX] */
-    Py_CPUID_MASK_EBX_L7_AVX2                   = 0x00000020,    // bit = 5
-    Py_CPUID_MASK_EBX_L7_AVX512_F               = 0x00010000,    // bit = 16
-    Py_CPUID_MASK_EBX_L7_AVX512_DQ              = 0x00020000,    // bit = 17
-    Py_CPUID_MASK_EBX_L7_AVX512_IFMA            = 0x00200000,    // bit = 21
-    Py_CPUID_MASK_EBX_L7_AVX512_PF              = 0x04000000,    // bit = 26
-    Py_CPUID_MASK_EBX_L7_AVX512_ER              = 0x08000000,    // bit = 27
-    Py_CPUID_MASK_EBX_L7_AVX512_CD              = 0x10000000,    // bit = 28
-    Py_CPUID_MASK_EBX_L7_AVX512_BW              = 0x40000000,    // bit = 30
-    Py_CPUID_MASK_EBX_L7_AVX512_VL              = 0x80000000,    // bit = 31
+    _Py_CPUID_MASK_EBX_L7_AVX2                  = 0x00000020,    // bit = 5
+    _Py_CPUID_MASK_EBX_L7_AVX512_F              = 0x00010000,    // bit = 16
+    _Py_CPUID_MASK_EBX_L7_AVX512_DQ             = 0x00020000,    // bit = 17
+    _Py_CPUID_MASK_EBX_L7_AVX512_IFMA           = 0x00200000,    // bit = 21
+    _Py_CPUID_MASK_EBX_L7_AVX512_PF             = 0x04000000,    // bit = 26
+    _Py_CPUID_MASK_EBX_L7_AVX512_ER             = 0x08000000,    // bit = 27
+    _Py_CPUID_MASK_EBX_L7_AVX512_CD             = 0x10000000,    // bit = 28
+    _Py_CPUID_MASK_EBX_L7_AVX512_BW             = 0x40000000,    // bit = 30
+    _Py_CPUID_MASK_EBX_L7_AVX512_VL             = 0x80000000,    // bit = 31
     /* CPUID (LEAF=7, SUBLEAF=0) [ECX] */
-    Py_CPUID_MASK_ECX_L7_AVX512_VBMI            = 0x00000002,    // bit = 1
-    Py_CPUID_MASK_ECX_L7_AVX512_VBMI2           = 0x00000040,    // bit = 6
-    Py_CPUID_MASK_ECX_L7_AVX512_VNNI            = 0x00000800,    // bit = 11
-    Py_CPUID_MASK_ECX_L7_AVX512_BITALG          = 0x00001000,    // bit = 12
-    Py_CPUID_MASK_ECX_L7_AVX512_VPOPCNTDQ       = 0x00004000,    // bit = 14
+    _Py_CPUID_MASK_ECX_L7_AVX512_VBMI           = 0x00000002,    // bit = 1
+    _Py_CPUID_MASK_ECX_L7_AVX512_VBMI2          = 0x00000040,    // bit = 6
+    _Py_CPUID_MASK_ECX_L7_AVX512_VNNI           = 0x00000800,    // bit = 11
+    _Py_CPUID_MASK_ECX_L7_AVX512_BITALG         = 0x00001000,    // bit = 12
+    _Py_CPUID_MASK_ECX_L7_AVX512_VPOPCNTDQ      = 0x00004000,    // bit = 14
     /* CPUID (LEAF=7, SUBLEAF=0) [EDX] */
-    Py_CPUID_MASK_EDX_L7_AVX512_4VNNIW          = 0x00000004,    // bit = 2
-    Py_CPUID_MASK_EDX_L7_AVX512_4FMAPS          = 0x00000008,    // bit = 3
-    Py_CPUID_MASK_EDX_L7_AVX512_VP2INTERSECT    = 0x00000100,    // bit = 8
+    _Py_CPUID_MASK_EDX_L7_AVX512_4VNNIW         = 0x00000004,    // bit = 2
+    _Py_CPUID_MASK_EDX_L7_AVX512_4FMAPS         = 0x00000008,    // bit = 3
+    _Py_CPUID_MASK_EDX_L7_AVX512_VP2INTERSECT   = 0x00000100,    // bit = 8
     /* CPUID (LEAF=7, SUBLEAF=1) [EAX] */
-    Py_CPUID_MASK_EAX_L7S1_AVX_VNNI             = 0x00000010,    // bit = 4
-    Py_CPUID_MASK_EAX_L7S1_AVX_IFMA             = 0x00800000,    // bit = 23
+    _Py_CPUID_MASK_EAX_L7S1_AVX_VNNI            = 0x00000010,    // bit = 4
+    _Py_CPUID_MASK_EAX_L7S1_AVX_IFMA            = 0x00800000,    // bit = 23
     /* CPUID (LEAF=7, SUBLEAF=1) [EDX] */
-    Py_CPUID_MASK_EDX_L7S1_AVX_VNNI_INT8        = 0x00000010,    // bit = 4
-    Py_CPUID_MASK_EDX_L7S1_AVX_NE_CONVERT       = 0x00000020,    // bit = 5
-    Py_CPUID_MASK_EDX_L7S1_AVX_VNNI_INT16       = 0x00000400,    // bit = 10
-} py_cpuid_feature_mask;
-/*[python end generated code: output=c4460242e465fa91 input=61d2b5f1bc368b94]*/
+    _Py_CPUID_MASK_EDX_L7S1_AVX_VNNI_INT8       = 0x00000010,    // bit = 4
+    _Py_CPUID_MASK_EDX_L7S1_AVX_NE_CONVERT      = 0x00000020,    // bit = 5
+    _Py_CPUID_MASK_EDX_L7S1_AVX_VNNI_INT16      = 0x00000400,    // bit = 10
+};
 // fmt: on
+/*[python end generated code: output=8e58b0997d69bbf8 input=fce00935f64021f9]*/
 
 #endif // !Py_INTERNAL_CPUINFO_CPUID_FEATURES_H
diff --git a/Include/internal/pycore_cpuinfo_xsave_features.h b/Include/internal/pycore_cpuinfo_xsave_features.h
@@ -1,11 +1,12 @@
-/*
+/**
  * @author Bénédikt Tran
- * @seealso Tools/cpuinfo/xsave_features_gen.py
+ * @seealso @file Tools/cpuinfo/xsave_features_gen.py
  *
  * XSAVE state components (XCR0 control register).
  *
  * See https://en.wikipedia.org/wiki/Control_register#XCR0_and_XSS.
  */
+
 #ifndef Py_INTERNAL_CPUINFO_XSAVE_FEATURES_H
 #define Py_INTERNAL_CPUINFO_XSAVE_FEATURES_H
 
@@ -21,29 +22,21 @@ extern "C" {
 
 // fmt: off
 /*[python input]
-import importlib
-import os
-import sys
-
-ROOT = os.getcwd()
-TOOL = os.path.join(ROOT, "Tools/cpuinfo/xsave_features_gen.py")
-TOOL = os.path.realpath(TOOL)
-
-if not os.path.exists(TOOL):
-    raise FileNotFoundError(TOOL)
-
-sys.path.insert(0, os.path.dirname(os.path.dirname(TOOL)))
-module = importlib.import_module("cpuinfo.xsave_features_gen")
-print(module.generate_xsave_features_enum("py_xsave_feature_mask"))
+import os, sys
+sys.path.insert(0, os.path.realpath(os.path.join(os.getcwd(), "Tools")))
+from cpuinfo.xsave_features_gen import generate_xsave_features_enum
+print(generate_xsave_features_enum("_Py_xsave_feature_mask"))
 [python start generated code]*/
-typedef enum py_xsave_feature_mask {
-    Py_XSAVE_MASK_XCR0_SSE              = 0x00000002,    // bit = 1
-    Py_XSAVE_MASK_XCR0_AVX              = 0x00000004,    // bit = 2
-    Py_XSAVE_MASK_XCR0_AVX512_OPMASK    = 0x00000020,    // bit = 5
-    Py_XSAVE_MASK_XCR0_AVX512_ZMM_HI256 = 0x00000040,    // bit = 6
-    Py_XSAVE_MASK_XCR0_AVX512_HI16_ZMM  = 0x00000080,    // bit = 7
-} py_xsave_feature_mask;
-/*[python end generated code: output=9a476ed0abbc617b input=41f35058299c0118]*/
+// fmt: off
+/** Enumeration for XSAVE components */
+enum _Py_xsave_feature_mask_e {
+    _Py_XSAVE_MASK_XCR0_SSE                 = 0x00000002,    // bit = 1
+    _Py_XSAVE_MASK_XCR0_AVX                 = 0x00000004,    // bit = 2
+    _Py_XSAVE_MASK_XCR0_AVX512_OPMASK       = 0x00000020,    // bit = 5
+    _Py_XSAVE_MASK_XCR0_AVX512_ZMM_HI256    = 0x00000040,    // bit = 6
+    _Py_XSAVE_MASK_XCR0_AVX512_HI16_ZMM     = 0x00000080,    // bit = 7
+};
 // fmt: on
+/*[python end generated code: output=35ea9a165938f8ef input=336793a305515376]*/
 
 #endif // !Py_INTERNAL_CPUINFO_XSAVE_FEATURES_H
@@ -16,7 +16,7 @@
 
 #include "Python.h"
 #include "hashlib.h"
-#include "pycore_cpuinfo.h"         // py_cpuid_features
+#include "pycore_cpuinfo.h"         // _Py_cpuid_features
 #include "pycore_strhex.h"          // _Py_strhex()
 #include "pycore_typeobject.h"
 #include "pycore_moduleobject.h"
@@ -111,7 +111,7 @@ _blake2_free(void *module)
 static void
 blake2module_init_cpu_features(Blake2State *state)
 {
-    py_cpuid_features flags;
+    _Py_cpuid_features flags;
     _Py_cpuid_detect_features(&flags);
 #if _Py_HACL_CAN_COMPILE_VEC128
     state->can_run_simd128 = flags.sse && flags.sse2 && flags.sse3

@@ -17,7 +17,7 @@
 #endif
 
 #include "Python.h"
-#include "pycore_cpuinfo.h"             // py_cpuid_features
+#include "pycore_cpuinfo.h"             // _Py_cpuid_features
 #include "pycore_hashtable.h"
 #include "pycore_strhex.h"              // _Py_strhex()
 
@@ -1553,7 +1553,7 @@ hmacmodule_init_globals(PyObject *module, hmacmodule_state *state)
 static void
 hmacmodule_init_cpu_features(hmacmodule_state *state)
 {
-    py_cpuid_features flags;
+    _Py_cpuid_features flags;
     _Py_cpuid_detect_features(&flags);
 #if _Py_HACL_CAN_COMPILE_VEC128
     state->can_run_simd128 = flags.sse && flags.sse2 && flags.sse3