src/bindings/python/bt2/Makefile.am

   1 # SPDX-FileCopyrightText: 2019-2023 EfficiOS, Inc.
   2 # SPDX-License-Identifier: MIT
   3
   4 # Since the shared object used by the python bindings is not built with
   5 # libtool, we need to add the directory containing libbabeltrace2 to the
   6 # linker path.
   7 AM_LDFLAGS += -L$(top_builddir)/src/lib/.libs
   8
   9 INSTALLED_FILES=$(builddir)/installed_files.txt
  10
  11 SWIG_INTERFACE_FILES =                                  \
  12         bt2/native_bt.i                                 \
  13         bt2/native_bt_autodisc.i                        \
  14         bt2/native_bt_autodisc.i.h                      \
  15         bt2/native_bt_bt2_objects.h                     \
  16         bt2/native_bt_clock_class.i                     \
  17         bt2/native_bt_clock_snapshot.i                  \
  18         bt2/native_bt_component.i                       \
  19         bt2/native_bt_component_class.i                 \
  20         bt2/native_bt_component_class.i.h               \
  21         bt2/native_bt_connection.i                      \
  22         bt2/native_bt_error.i                           \
  23         bt2/native_bt_error.i.h                         \
  24         bt2/native_bt_event.i                           \
  25         bt2/native_bt_event_class.i                     \
  26         bt2/native_bt_field.i                           \
  27         bt2/native_bt_field_class.i                     \
  28         bt2/native_bt_field_path.i                      \
  29         bt2/native_bt_graph.i                           \
  30         bt2/native_bt_graph.i.h                         \
  31         bt2/native_bt_integer_range_set.i               \
  32         bt2/native_bt_interrupter.i                     \
  33         bt2/native_bt_log_and_append_error.h            \
  34         bt2/native_bt_logging.i                         \
  35         bt2/native_bt_message.i                         \
  36         bt2/native_bt_message_iterator.i                \
  37         bt2/native_bt_message_iterator.i.h              \
  38         bt2/native_bt_mip.i                             \
  39         bt2/native_bt_mip.i.h                           \
  40         bt2/native_bt_packet.i                          \
  41         bt2/native_bt_plugin.i                          \
  42         bt2/native_bt_plugin.i.h                        \
  43         bt2/native_bt_port.i                            \
  44         bt2/native_bt_query_exec.i                      \
  45         bt2/native_bt_query_exec.i.h                    \
  46         bt2/native_bt_stream.i                          \
  47         bt2/native_bt_stream_class.i                    \
  48         bt2/native_bt_trace.i                           \
  49         bt2/native_bt_trace.i.h                         \
  50         bt2/native_bt_trace_class.i                     \
  51         bt2/native_bt_trace_class.i.h                   \
  52         bt2/native_bt_value.i                           \
  53         bt2/native_bt_value.i.h                         \
  54         bt2/native_bt_version.i
  55
  56 # Non-generated files built into the native library.
  57 STATIC_NATIVE_LIB_SRCS =                                \
  58         bt2/logging.c                                   \
  59         bt2/logging.h
  60
  61 STATIC_BINDINGS_DEPS =                                  \
  62         bt2/__init__.py                                 \
  63         bt2/clock_class.py                              \
  64         bt2/clock_snapshot.py                           \
  65         bt2/component.py                                \
  66         bt2/component_descriptor.py                     \
  67         bt2/connection.py                               \
  68         bt2/error.py                                    \
  69         bt2/event.py                                    \
  70         bt2/event_class.py                              \
  71         bt2/field.py                                    \
  72         bt2/field_class.py                              \
  73         bt2/field_path.py                               \
  74         bt2/graph.py                                    \
  75         bt2/integer_range_set.py                        \
  76         bt2/interrupter.py                              \
  77         bt2/logging.py                                  \
  78         bt2/message.py                                  \
  79         bt2/message_iterator.py                         \
  80         bt2/mip.py                                      \
  81         bt2/object.py                                   \
  82         bt2/packet.py                                   \
  83         bt2/plugin.py                                   \
  84         bt2/port.py                                     \
  85         bt2/py_plugin.py                                \
  86         bt2/query_executor.py                           \
  87         bt2/stream.py                                   \
  88         bt2/stream_class.py                             \
  89         bt2/trace.py                                    \
  90         bt2/trace_class.py                              \
  91         bt2/trace_collection_message_iterator.py        \
  92         bt2/utils.py                                    \
  93         bt2/value.py
  94
  95 # Convenience static libraries on which the Python bindings library depends.
  96 # These are listed in the setup.py(.in) file.
  97 STATIC_LIBRARIES_DEPS = \
  98         $(top_builddir)/src/autodisc/libautodisc.la \
  99         $(top_builddir)/src/logging/liblogging.la \
 100         $(top_builddir)/src/common/libcommon.la \
 101         $(top_builddir)/src/py-common/libpy-common.la \
 102         $(top_builddir)/src/string-format/libstring-format.la
 103
 104 GENERATED_BINDINGS_DEPS =       \
 105         bt2/native_bt.c         \
 106         bt2/version.py          \
 107         setup.py
 108
 109 # Some versions of SWIG (like 3.0.12) generate code where a parameter called
 110 # `swig_this` shadows a global of the same name.  Later versions (like 4.0.1)
 111 # have renamed this global to `Swig_This_global`.
 112 #
 113 # Disable -Wshadow for that file.
 114 WARN_CFLAGS = -Wno-shadow
 115
 116 WARN_CFLAGS += -Wno-null-dereference
 117
 118 # Python 3.8 with SWIG 4.0.2 generates a deprecated warning for 'tp_print'
 119 # and in general there is not much we can do about deprecations in generated
 120 # code.
 121 WARN_CFLAGS += -Wno-deprecated-declarations
 122
 123 # Python 3.11 + gcc 12.2.0 gave warnings of this kind in Python.h.
 124 WARN_CFLAGS += -Wno-redundant-decls
 125
 126 # For SWIG generated code
 127 WARN_CFLAGS += -Wno-missing-field-initializers
 128 WARN_CFLAGS += -Wno-unused-parameter
 129
 130 # SWIG 4.2.0 generates:
 131 #
 132 #   #if __cplusplus >=201103L
 133 #
 134 # ... leading to some `-Wundef` warnings when building the extension as C, where
 135 # `__cplusplus` is not defined.
 136 WARN_CFLAGS += -Wno-undef
 137
 138 BUILD_FLAGS=CC="$(CC)" \
 139                 CFLAGS="$(GLIB_CFLAGS) $(AM_CFLAGS) $(CFLAGS) $(WARN_CFLAGS)" \
 140                 CPPFLAGS="$(AM_CPPFLAGS) $(CPPFLAGS) -I$(srcdir)/bt2" \
 141                 LDFLAGS="$(AM_LDFLAGS) $(LDFLAGS) $(GLIB_LIBS) $(PYTHON_LDFLAGS) $(LIBS)"
 142
 143 all-local: build-python-bindings.stamp
 144
 145 copy-static-deps.stamp: $(addprefix $(srcdir)/, $(STATIC_BINDINGS_DEPS))
 146         @if [ x"$(srcdir)" != x"$(builddir)" ]; then \
 147                 for file in $(STATIC_BINDINGS_DEPS); do \
 148                         cp -f $(srcdir)/$$file $(builddir)/$$file; \
 149                 done; \
 150         fi
 151         touch $@
 152
 153 build-python-bindings.stamp: copy-static-deps.stamp $(GENERATED_BINDINGS_DEPS) \
 154                 $(STATIC_NATIVE_LIB_SRCS) $(STATIC_LIBRARIES_DEPS)
 155         $(BUILD_FLAGS) $(PYTHON) $(builddir)/setup.py build --force
 156         touch $@
 157
 158 swig_verbose = $(swig_verbose_@AM_V@)
 159 swig_verbose_ = $(swig_verbose_@AM_DEFAULT_V@)
 160 swig_verbose_0 = @echo "  SWIG     " $@;
 161
 162 $(builddir)/bt2/native_bt.c: $(SWIG_INTERFACE_FILES)
 163         $(swig_verbose)$(SWIG) -MD -python -I"$(top_srcdir)/include" -o "$@" "$<"
 164
 165 -include bt2/native_bt.d
 166
 167 pyinstall_verbose = $(pyinstall_verbose_@AM_V@)
 168 pyinstall_verbose_ = $(pyinstall_verbose_@AM_DEFAULT_V@)
 169 pyinstall_verbose_0 = @
 170
 171 # For Python < 3.12, force the use of distutils even if setuptools is
 172 # installed. For Python >= 3.12, set the externally managed option to allow
 173 # installation in a directory which isn't in the current PYTHONPATH.
 174 if HAVE_PYTHON_312_OR_GREATER
 175 PY_INSTALL_OPTS = --single-version-externally-managed
 176 else
 177 export SETUPTOOLS_USE_DISTUTILS=stdlib
 178 endif
 179
 180 install-exec-local: build-python-bindings.stamp
 181         $(pyinstall_verbose)opts="--prefix=$(prefix) --exec-prefix=$(exec_prefix) --record $(INSTALLED_FILES) --verbose --no-compile $(DISTSETUPOPTS)"; \
 182         if [ "$(DESTDIR)" != "" ]; then \
 183                 opts="$$opts --root=$(DESTDIR)"; \
 184         fi; \
 185         $(PYTHON) $(builddir)/setup.py install $(PY_INSTALL_OPTS) $$opts;
 186
 187 clean-local:
 188         rm -rf $(builddir)/build
 189         @if [ x"$(srcdir)" != x"$(builddir)" ]; then \
 190                 for file in $(STATIC_BINDINGS_DEPS); do \
 191                         rm -f $(builddir)/$$file; \
 192                 done; \
 193         fi
 194
 195 # Distutils' setup.py does not include an uninstall target, we thus need to do
 196 # it manually. We save the path of the files that were installed during the install target
 197 # and delete them during the uninstallation.
 198 uninstall-local:
 199         if [ "$(DESTDIR)" != "" ]; then \
 200                 $(SED) -i "s|^|$(DESTDIR)/|g" $(INSTALLED_FILES); \
 201         fi
 202         cat $(INSTALLED_FILES) | xargs rm -rf || true
 203         $(GREP) "__init__.py" $(INSTALLED_FILES) | xargs dirname | xargs rm -rf || true
 204         rm -f $(INSTALLED_FILES)
 205
 206 # distribute: extra Python modules and SWIG interface files
 207 EXTRA_DIST = $(STATIC_BINDINGS_DEPS) $(SWIG_INTERFACE_FILES) $(STATIC_NATIVE_LIB_SRCS)
 208
 209 # clean: generated C and Python files (by SWIG)
 210 CLEANFILES = \
 211         build-python-bindings.stamp \
 212         bt2/native_bt.c \
 213         bt2/native_bt.d \
 214         bt2/native_bt.py \
 215         copy-static-deps.stamp