pythongh-108220: Internal header files require Py_BUILD_CORE to be de…

…fined (python#108221) * pycore_intrinsics.h does nothing if included twice (add #ifndef and #define). * Update Tools/cases_generator/generate_cases.py to generate the Py_BUILD_CORE test. * _bz2, _lzma, _opcode and zlib extensions now define the Py_BUILD_CORE_MODULE macro to use internal headers (pycore_code.h, pycore_intrinsics.h and pycore_blocks_output_buffer.h).
vstinner · Aug 21, 2023 · 21c0844 · 21c0844
1 parent db55383
commit 21c0844
Show file tree

Hide file tree

Showing 16 changed files with 65 additions and 4 deletions.
diff --git a/Include/internal/pycore_blocks_output_buffer.h b/Include/internal/pycore_blocks_output_buffer.h
@@ -40,6 +40,10 @@ extern "C" {
 
 #include "Python.h"
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 typedef struct {
  // List of bytes objects
  PyObject *list;
@@ -314,4 +318,4 @@ _BlocksOutputBuffer_OnError(_BlocksOutputBuffer *buffer)
 #ifdef __cplusplus
 }
 #endif
-#endif /* Py_INTERNAL_BLOCKS_OUTPUT_BUFFER_H */
+#endif /* Py_INTERNAL_BLOCKS_OUTPUT_BUFFER_H */
diff --git a/Include/internal/pycore_code.h b/Include/internal/pycore_code.h
@@ -4,6 +4,10 @@
 extern "C" {
 #endif
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 #define CODE_MAX_WATCHERS 8
 
 /* PEP 659

diff --git a/Include/internal/pycore_codecs.h b/Include/internal/pycore_codecs.h
@@ -4,6 +4,10 @@
 extern "C" {
 #endif
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 extern PyObject* _PyCodec_Lookup(const char *encoding);
 
 /* Text codec specific encoding and decoding API.

diff --git a/Include/internal/pycore_emscripten_signal.h b/Include/internal/pycore_emscripten_signal.h
@@ -3,6 +3,10 @@
 
 #if defined(__EMSCRIPTEN__)
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 void
 _Py_CheckEmscriptenSignals(void);
 

diff --git a/Include/internal/pycore_fileutils.h b/Include/internal/pycore_fileutils.h
@@ -5,7 +5,7 @@ extern "C" {
 #endif
 
 #ifndef Py_BUILD_CORE
-# error "Py_BUILD_CORE must be defined to include this header"
+# error "this header requires Py_BUILD_CORE define"
 #endif
 
 #include <locale.h> /* struct lconv */

diff --git a/Include/internal/pycore_fileutils_windows.h b/Include/internal/pycore_fileutils_windows.h
@@ -5,7 +5,7 @@ extern "C" {
 #endif
 
 #ifndef Py_BUILD_CORE
-# error "Py_BUILD_CORE must be defined to include this header"
+# error "this header requires Py_BUILD_CORE define"
 #endif
 
 #ifdef MS_WINDOWS

diff --git a/Include/internal/pycore_frame.h b/Include/internal/pycore_frame.h
@@ -4,6 +4,10 @@
 extern "C" {
 #endif
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 #include <stdbool.h>
 #include <stddef.h> // offsetof()
 #include "pycore_code.h" // STATS

diff --git a/Include/internal/pycore_import.h b/Include/internal/pycore_import.h
@@ -5,6 +5,10 @@
 extern "C" {
 #endif
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
 #include "pycore_hashtable.h" // _Py_hashtable_t
 #include "pycore_time.h" // _PyTime_t
 

diff --git a/Include/internal/pycore_instruments.h b/Include/internal/pycore_instruments.h
@@ -1,7 +1,9 @@
-
 #ifndef Py_INTERNAL_INSTRUMENT_H
 #define Py_INTERNAL_INSTRUMENT_H
 
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
 
 #include "pycore_bitutils.h" // _Py_popcount32
 #include "pycore_frame.h"

diff --git a/Include/internal/pycore_intrinsics.h b/Include/internal/pycore_intrinsics.h
@@ -1,3 +1,9 @@
+#ifndef Py_INTERNAL_INTRINSIC_H
+#define Py_INTERNAL_INTRINSIC_H
+
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
 
 /* Unary Functions: */
 #define INTRINSIC_1_INVALID 0
@@ -40,3 +46,5 @@ typedef struct {
 
 extern const intrinsic_func1_info _PyIntrinsics_UnaryFunctions[];
 extern const intrinsic_func2_info _PyIntrinsics_BinaryFunctions[];
+
+#endif // !Py_INTERNAL_INTRINSIC_H
diff --git a/Include/internal/pycore_opcode_metadata.h b/Include/internal/pycore_opcode_metadata.h
diff --git a/Modules/_bz2module.c b/Modules/_bz2module.c
@@ -1,5 +1,9 @@
 /* _bz2 - Low-level Python interface to libbzip2. */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+# define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 
 #include <bzlib.h>

diff --git a/Modules/_lzmamodule.c b/Modules/_lzmamodule.c
@@ -5,6 +5,10 @@
 
 */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+# define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 
 

diff --git a/Modules/_opcode.c b/Modules/_opcode.c
@@ -1,3 +1,7 @@
+#ifndef Py_BUILD_CORE_BUILTIN
+# define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 #include "compile.h"
 #include "opcode.h"

diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c
@@ -3,6 +3,10 @@
 
 /* Windows users: read Python's PCbuild\readme.txt */
 
+#ifndef Py_BUILD_CORE_BUILTIN
+# define Py_BUILD_CORE_MODULE 1
+#endif
+
 #include "Python.h"
 
 #include "zlib.h"

diff --git a/Tools/cases_generator/generate_cases.py b/Tools/cases_generator/generate_cases.py
@@ -9,6 +9,7 @@
 import os
 import posixpath
 import sys
+import textwrap
 import typing
 from collections.abc import Iterator
 
@@ -403,6 +404,12 @@ def write_metadata(self, metadata_filename: str, pymetadata_filename: str) -> No
 
  self.write_provenance_header()
 
+ self.out.emit("\n" + textwrap.dedent("""
+ #ifndef Py_BUILD_CORE
+ # error "this header requires Py_BUILD_CORE define"
+ #endif
+ """).strip())
+
  self.out.emit("\n#include <stdbool.h>")
 
  self.write_pseudo_instrs()