libdrgn: combine libdrgn and _drgn Python extension into one .so

For the upcoming plugin system, libdrgn needs to call Python extension
code and vice versa. Doing this from two separate libraries would be
messy, so let's combine them into one library. liblldb seems to do the
same thing, so I don't think this is too crazy.

Signed-off-by: Omar Sandoval <[email protected]>

Author: osandov

libdrgn/Makefile.am

@@ -5,7 +5,8 @@ ACLOCAL_AMFLAGS = -I m4
 
 .DELETE_ON_ERROR:
 
-AM_CPPFLAGS = -I $(top_srcdir)/include -D_GNU_SOURCE
+AM_CPPFLAGS = -I $(top_srcdir)/include -iquote $(dir $@) \
+	      -iquote $(srcdir)/$(dir $@) -D_GNU_SOURCE
 AM_CFLAGS = $(WARN_CFLAGS) $(SANITIZER_CFLAGS)
 AM_LDFLAGS= $(SANITIZER_LDFLAGS)
 
@@ -134,7 +135,7 @@ libdrgnimpl_la_SOURCES = $(ARCH_DEFS_PYS:_defs.py=.c) \
 
 libdrgnimpl_la_CFLAGS = $(AM_CFLAGS) -fvisibility=hidden $(OPENMP_CFLAGS) \
 			$(elfutils_CFLAGS)
-libdrgnimpl_la_CPPFLAGS = $(AM_CPPFLAGS) -iquote .
+libdrgnimpl_la_CPPFLAGS = $(AM_CPPFLAGS)
 libdrgnimpl_la_LIBADD = $(OPENMP_LIBS) $(elfutils_LIBS) -lm
 
 if WITH_DEBUGINFOD
@@ -152,6 +153,36 @@ libdrgnimpl_la_CFLAGS += $(libkdumpfile_CFLAGS)
 libdrgnimpl_la_LIBADD += $(libkdumpfile_LIBS)
 endif
 
+if ENABLE_PYTHON
+BUILT_SOURCES += python/docstrings.h
+
+libdrgnimpl_la_SOURCES += python/constants.c \
+			  python/debug_info_options.c \
+			  python/docstrings.c \
+			  python/docstrings.h \
+			  python/drgnpy.h \
+			  python/error.c \
+			  python/helpers.c \
+			  python/language.c \
+			  python/main.c \
+			  python/module.c \
+			  python/module_section_addresses.c \
+			  python/object.c \
+			  python/platform.c \
+			  python/program.c \
+			  python/stack_trace.c \
+			  python/symbol.c \
+			  python/symbol_index.c \
+			  python/test.c \
+			  python/thread.c \
+			  python/type.c \
+			  python/type_kind_set.c \
+			  python/util.c
+
+libdrgnimpl_la_CPPFLAGS += $(PYTHON_CPPFLAGS)
+libdrgnimpl_la_LIBADD += $(PYTHON_LIBS)
+endif
+
 %: %.strswitch build-aux/gen_strswitch.py build-aux/codegen_utils.py
 	$(AM_V_GEN)$(PYTHON) $(word 2, $^) -o $@ $<
 
@@ -167,52 +198,6 @@ drgn_section_name_to_index.inc: build-aux/gen_elf_sections.py build-aux/gen_strs
 elf_sections.h: build-aux/gen_elf_sections.py build-aux/codegen_utils.py
 	$(AM_V_GEN)$(PYTHON) $< -H > $@
 
-lib_LTLIBRARIES = libdrgn.la
-
-libdrgn_la_SOURCES =
-libdrgn_la_LDFLAGS = $(AM_LDFLAGS) -version-info 0:0:0
-libdrgn_la_LIBADD = libdrgnimpl.la
-
-if ENABLE_PYTHON
-BUILT_SOURCES += python/docstrings.h
-
-noinst_LTLIBRARIES += _drgn.la
-endif
-
-_drgn_la_SOURCES = python/constants.c \
-		   python/debug_info_options.c \
-		   python/docstrings.c \
-		   python/docstrings.h \
-		   python/drgnpy.h \
-		   python/error.c \
-		   python/helpers.c \
-		   python/language.c \
-		   python/main.c \
-		   python/module.c \
-		   python/module_section_addresses.c \
-		   python/object.c \
-		   python/platform.c \
-		   python/program.c \
-		   python/stack_trace.c \
-		   python/symbol.c \
-		   python/symbol_index.c \
-		   python/test.c \
-		   python/thread.c \
-		   python/type.c \
-		   python/type_kind_set.c \
-		   python/util.c
-
-_drgn_la_CFLAGS = $(AM_CFLAGS) -fvisibility=hidden
-_drgn_la_CPPFLAGS = $(AM_CPPFLAGS) $(PYTHON_CPPFLAGS) -iquote $(srcdir)/python \
-		    -iquote python
-_drgn_la_LDFLAGS = $(AM_LDFLAGS) -Wl,--exclude-libs,ALL -avoid-version -module \
-		   -shared -rpath $(pkgpyexecdir)
-_drgn_la_LIBADD = libdrgnimpl.la
-
-if WITH_LIBKDUMPFILE
-_drgn_la_CFLAGS += $(libkdumpfile_CFLAGS)
-endif
-
 python/constants.c: drgn.h build-aux/gen_constants.py
 	$(AM_V_GEN)$(PYTHON) $(word 2, $^) < $< > $@
 
@@ -225,6 +210,12 @@ python/docstrings.c: ../_drgn.pyi $(drgndoc_docstrings_deps)
 python/docstrings.h: ../_drgn.pyi $(drgndoc_docstrings_deps)
 	$(AM_V_GEN)$(drgndoc_docstrings) -H -m _drgn:drgn $< > $@
 
+lib_LTLIBRARIES = libdrgn.la
+
+libdrgn_la_SOURCES =
+libdrgn_la_LDFLAGS = $(AM_LDFLAGS) -version-info 0:0:0
+libdrgn_la_LIBADD = libdrgnimpl.la
+
 EXTRA_DIST = $(ARCH_DEFS_PYS) \
 	     $(STRSWITCH_INCS:.inc=.inc.strswitch) \
 	     Doxyfile \

libdrgn/configure.ac

@@ -52,30 +52,7 @@ AC_ARG_ENABLE([python],
 	      [], [enable_python=no])
 
 AM_CONDITIONAL([ENABLE_PYTHON], [test "x$enable_python" != xno])
-AM_COND_IF([ENABLE_PYTHON],
-	   [AS_IF([test -z "$PYTHON_CPPFLAGS"],
-		  [prog="import sysconfig
-include = sysconfig.get_path('include')
-platinclude = sysconfig.get_path('platinclude')
-include_paths = [[include]]
-if platinclude != include:
-    include_paths.append(plat_include)
-print(' '.join('-I' + path for path in include_paths))"
-		   PYTHON_CPPFLAGS=`"$PYTHON" -c "$prog"`])
-	    AC_SUBST(PYTHON_CPPFLAGS)
-	    AC_MSG_CHECKING([for $PYTHON development headers])
-	    save_CPPFLAGS="$CPPFLAGS"
-	    CPPFLAGS="$CPPFLAGS $PYTHON_CPPFLAGS"
-	    AC_COMPILE_IFELSE([AC_LANG_SOURCE([[#include <Python.h>]])],
-			      [AC_MSG_RESULT([yes])],
-			      [AC_MSG_RESULT([no])
-			       AC_MSG_ERROR(
-[Could not compile test program with Python headers.
-
-You may need to install your distribution's Python development package (e.g.,
-python3-devel or python3-dev) or specify the location of the Python development
-headers by setting the PYTHON_CPPFLAGS environment variable.])])
-	    CPPFLAGS="$save_CPPFLAGS"])
+AM_COND_IF([ENABLE_PYTHON], [MY_PYTHON_DEVEL])
 
 PKG_PROG_PKG_CONFIG
 

libdrgn/m4/.gitignore

@@ -7,3 +7,4 @@
 !/my_c_auto.m4
 !/my_c_switch_enum.m4
 !/my_check_va_args_comma_deletion.m4
+!/my_python_devel.m4

libdrgn/m4/my_python_devel.m4

@@ -0,0 +1,47 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+# Check for Python development files and define PYTHON_CPPFLAGS and PYTHON_LIBS
+# accordingly.
+AC_DEFUN([MY_PYTHON_DEVEL],
+[
+AS_IF([test -z "$PYTHON_CPPFLAGS"],
+      [prog="import sysconfig
+include = sysconfig.get_path('include')
+platinclude = sysconfig.get_path('platinclude')
+include_paths = [[include]]
+if platinclude != include:
+    include_paths.append(plat_include)
+print(' '.join('-I' + path for path in include_paths))"
+       PYTHON_CPPFLAGS=`"$PYTHON" -c "$prog"`])
+AC_SUBST(PYTHON_CPPFLAGS)
+AS_IF([test -z "$PYTHON_LIBS"],
+      [prog="import sysconfig
+print('-L' + sysconfig.get_config_var('LIBDIR') +
+      ' -lpython' + sysconfig.get_config_var('LDVERSION'))"
+       PYTHON_LIBS=`"$PYTHON" -c "$prog"`])
+AC_SUBST(PYTHON_LIBS)
+AC_MSG_CHECKING([for $PYTHON development files])
+save_CPPFLAGS="$CPPFLAGS"
+save_LIBS="$LIBS"
+CPPFLAGS="$CPPFLAGS $PYTHON_CPPFLAGS"
+LIBS="$LIBS $PYTHON_LIBS"
+AC_LINK_IFELSE([AC_LANG_SOURCE([[
+#include <Python.h>
+
+int main(void)
+{
+	Py_Initialize();
+}
+]])],
+	       [AC_MSG_RESULT([yes])],
+	       [AC_MSG_RESULT([no])
+		AC_MSG_ERROR(
+[Could not compile Python development test program.
+
+You may need to install your distribution's Python development package (e.g.,
+python3-devel or python3-dev) or set the PYTHON_CPPFLAGS and PYTHON_LIBS
+environment variables.])])
+CPPFLAGS="$save_CPPFLAGS"
+LIBS="$save_LIBS"
+])

setup.py

@@ -123,7 +123,7 @@ def make(self, *make_args):
 
     def run(self):
         self.make()
-        so = os.path.join(self.build_temp, ".libs/_drgn.so")
+        so = os.path.join(self.build_temp, ".libs/libdrgn.so")
         if self.inplace:
             self.copy_file(so, self.get_ext_fullpath("_drgn"))
         old_inplace, self.inplace = self.inplace, 0