From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Tue, 11 Jan 2022 20:57:37 +0000 (-0500)
Subject: Introduce libcommon-lgpl for liblttng-ctl
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=93903fd582c3b4b3528eed37ad5631ebcb74ca2b;p=deliverable%2Flttng-tools.git

Introduce libcommon-lgpl for liblttng-ctl

liblttng-ctl is a LGPLv2.1 library should should not use GPLv2 code.
Introduce libcommon-lgpl as a static archive containing only LGPLv2.1
compatible code.

This also removes the dependency from liblttng-ctl to liburcu.

Include some source files in libcommon-lgpl.a which are indirectly needed
by source files required in libcommon-lgpl.a:

- endpoint.cpp,
- lttng-elf.cpp,
- lttng-elf.h.

Include some source files in libcommon-lgpl.a which are only needed to
link the lttng executable:

- domain.cpp,
- spawn-viewer.cpp, spawn-viewer.h.

Introduce the new source file hashtable/seed.cpp to move the
lttng_ht_seed symbol in a source file which does not require
liburcu-cds, so it can be present in libcommon-lgpl. This allows
building compile units which are needed in the lgpl common library which
also contain functions which directly refer to lttng_ht_seed.

Programs and libraries which use libhashtable.la are changed to use
libcommon-gpl.la instead. libhashtable becomes internal to libcommon.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I27d2acb823a6d951692a5da88ce32bbe6bafb072
---

diff --git a/src/bin/lttng-consumerd/Makefile.am b/src/bin/lttng-consumerd/Makefile.am
index 0e8ec982a..82df3e375 100644
--- a/src/bin/lttng-consumerd/Makefile.am
+++ b/src/bin/lttng-consumerd/Makefile.am
@@ -10,7 +10,6 @@ lttng_consumerd_SOURCES = \
 
 lttng_consumerd_LDADD = \
 	   $(top_builddir)/src/common/consumer/libconsumer.la \
-	   $(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la \
 	   $(top_builddir)/src/common/libcommon-gpl.la \
 	   $(top_builddir)/src/common/index/libindex.la \
 	   $(top_builddir)/src/common/health/libhealth.la \
diff --git a/src/bin/lttng-relayd/Makefile.am b/src/bin/lttng-relayd/Makefile.am
index f16a98d64..9fe11f287 100644
--- a/src/bin/lttng-relayd/Makefile.am
+++ b/src/bin/lttng-relayd/Makefile.am
@@ -31,7 +31,6 @@ lttng_relayd_SOURCES = main.cpp lttng-relayd.h utils.h utils.cpp cmd.h \
 lttng_relayd_LDADD = $(URCU_LIBS) \
 		$(top_builddir)/src/common/libcommon-gpl.la \
 		$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la \
-		$(top_builddir)/src/common/hashtable/libhashtable.la \
 		$(top_builddir)/src/common/compat/libcompat.la \
 		$(top_builddir)/src/common/index/libindex.la \
 		$(top_builddir)/src/common/health/libhealth.la \
diff --git a/src/bin/lttng-sessiond/Makefile.am b/src/bin/lttng-sessiond/Makefile.am
index a7cbdc523..1ab26e0a0 100644
--- a/src/bin/lttng-sessiond/Makefile.am
+++ b/src/bin/lttng-sessiond/Makefile.am
@@ -72,7 +72,6 @@ liblttng_sessiond_common_la_LIBADD = $(URCU_LIBS) $(KMOD_LIBS) \
 		$(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la \
 		$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la \
 		$(top_builddir)/src/common/kernel-ctl/libkernel-ctl.la \
-		$(top_builddir)/src/common/hashtable/libhashtable.la \
 		$(top_builddir)/src/common/libcommon-gpl.la \
 		$(top_builddir)/src/common/compat/libcompat.la \
 		$(top_builddir)/src/common/relayd/librelayd.la \
diff --git a/src/common/Makefile.am b/src/common/Makefile.am
index 8cd93af44..b7b59f95a 100644
--- a/src/common/Makefile.am
+++ b/src/common/Makefile.am
@@ -38,10 +38,14 @@ DIST_SUBDIRS = \
 	argpar-utils
 
 # Common library
-noinst_LTLIBRARIES = libcommon-gpl.la
+noinst_LTLIBRARIES = libcommon-lgpl.la libcommon-gpl.la
 EXTRA_DIST = mi-lttng-4.1.xsd
 
-libcommon_gpl_la_SOURCES = \
+# The libcommon-lgpl static archive contains only LGPLv2.1 code. It is
+# meant to be used by LGPLv2.1 libraries such as liblttng-ctl. It also
+# contains libcommon-lgpl.la.
+
+libcommon_lgpl_la_SOURCES = \
 	actions/action.cpp \
 	actions/list.cpp \
 	actions/notify.cpp \
@@ -52,15 +56,12 @@ libcommon_gpl_la_SOURCES = \
 	actions/stop-session.cpp \
 	actions/rate-policy.cpp \
 	buffer-view.h buffer-view.cpp \
-	common.h \
 	conditions/buffer-usage.cpp \
 	conditions/condition.cpp \
 	conditions/event-rule-matches.cpp \
 	conditions/session-consumed-size.cpp \
 	conditions/session-rotation.cpp \
-	context.cpp context.h \
 	credentials.cpp credentials.h \
-	daemonize.cpp daemonize.h \
 	defaults.cpp \
 	domain.cpp \
 	dynamic-array.cpp dynamic-array.h \
@@ -69,7 +70,6 @@ libcommon_gpl_la_SOURCES = \
 	error.cpp error.h \
 	error-query.cpp \
 	evaluation.cpp \
-	event.cpp \
 	event-expr/event-expr.cpp \
 	event-field-value.cpp \
 	event-rule/event-rule.cpp \
@@ -81,54 +81,67 @@ libcommon_gpl_la_SOURCES = \
 	event-rule/log4j-logging.cpp \
 	event-rule/jul-logging.cpp \
 	event-rule/python-logging.cpp \
-	filter.cpp filter.h \
 	fd-handle.cpp fd-handle.h \
-	fs-handle.cpp fs-handle.h fs-handle-internal.h \
-	futex.cpp futex.h \
 	kernel-probe.cpp \
-	index-allocator.cpp index-allocator.h \
 	location.cpp \
 	log-level-rule.cpp \
 	mi-lttng.cpp mi-lttng.h \
 	notification.cpp \
-	optional.h \
 	payload.cpp payload.h \
 	payload-view.cpp payload-view.h \
-	pipe.cpp pipe.h \
 	readwrite.cpp readwrite.h \
 	runas.cpp runas.h \
-	shm.cpp shm.h \
 	session-descriptor.cpp \
 	snapshot.cpp snapshot.h \
 	spawn-viewer.cpp spawn-viewer.h \
+	thread.cpp thread.h \
 	time.cpp \
-	trace-chunk.cpp trace-chunk.h \
-	trace-chunk-registry.h \
+	tracker.cpp tracker.h \
 	trigger.cpp \
 	unix.cpp unix.h \
 	uri.cpp uri.h \
 	userspace-probe.cpp \
-	utils.cpp utils.h \
-	uuid.cpp uuid.h \
-	thread.cpp thread.h \
-	tracker.cpp tracker.h \
-	waiter.cpp waiter.h
+	utils.cpp utils.h
 
 if HAVE_ELF_H
-libcommon_gpl_la_SOURCES += \
+libcommon_lgpl_la_SOURCES += \
 	lttng-elf.cpp lttng-elf.h
 endif
 
-libcommon_gpl_la_LIBADD = \
+libcommon_lgpl_la_LIBADD = \
 	$(top_builddir)/src/common/bytecode/libbytecode.la \
-	$(top_builddir)/src/common/config/libconfig.la \
-	$(top_builddir)/src/common/ini-config/libini-config.la \
 	$(top_builddir)/src/common/compat/libcompat.la \
-	$(top_builddir)/src/common/hashtable/libhashtable.la \
-	$(top_builddir)/src/common/fd-tracker/libfd-tracker.la \
+	$(top_builddir)/src/common/config/libconfig.la \
 	$(top_builddir)/src/common/filter/libfilter.la \
+	$(top_builddir)/src/common/hashtable/libhashtable-lgpl.la \
 	$(top_builddir)/src/vendor/msgpack/libmsgpack.la
 
+# The libcommon-gpl static archive contains GPLv2 compatible code. It is
+# meant to be used by GPL executables.
+
+libcommon_gpl_la_SOURCES = \
+	common.h \
+	context.cpp context.h \
+	daemonize.cpp daemonize.h \
+	event.cpp \
+	filter.cpp filter.h \
+	fs-handle.cpp fs-handle.h fs-handle-internal.h \
+	futex.cpp futex.h \
+	index-allocator.cpp index-allocator.h \
+	optional.h \
+	pipe.cpp pipe.h \
+	shm.cpp shm.h \
+	trace-chunk.cpp trace-chunk.h \
+	trace-chunk-registry.h \
+	uuid.cpp uuid.h \
+	waiter.cpp waiter.h
+
+libcommon_gpl_la_LIBADD = \
+	libcommon-lgpl.la \
+	$(top_builddir)/src/common/ini-config/libini-config.la \
+	$(top_builddir)/src/common/hashtable/libhashtable-gpl.la \
+	$(top_builddir)/src/common/fd-tracker/libfd-tracker.la
+
 if BUILD_LIB_HEALTH
 SUBDIRS += health
 endif
@@ -181,8 +194,7 @@ noinst_HEADERS = \
 
 noinst_PROGRAMS = filter-grammar-test
 filter_grammar_test_SOURCES = filter-grammar-test.cpp
-filter_grammar_test_LDADD = \
-	libcommon-gpl.la
+filter_grammar_test_LDADD = libcommon-gpl.la
 
 all-local:
 	@if [ x"$(srcdir)" != x"$(builddir)" ]; then \
diff --git a/src/common/consumer/Makefile.am b/src/common/consumer/Makefile.am
index ba3ecf1da..46810d116 100644
--- a/src/common/consumer/Makefile.am
+++ b/src/common/consumer/Makefile.am
@@ -18,8 +18,6 @@ libconsumer_la_SOURCES = \
 libconsumer_la_LIBADD = \
 		$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la \
 		$(top_builddir)/src/common/kernel-consumer/libkernel-consumer.la \
-		$(top_builddir)/src/common/hashtable/libhashtable.la \
-		$(top_builddir)/src/common/compat/libcompat.la \
 		$(top_builddir)/src/common/relayd/librelayd.la
 
 if HAVE_LIBLTTNG_UST_CTL
diff --git a/src/common/hashtable/Makefile.am b/src/common/hashtable/Makefile.am
index b14254b34..f16b1b513 100644
--- a/src/common/hashtable/Makefile.am
+++ b/src/common/hashtable/Makefile.am
@@ -1,12 +1,17 @@
 # SPDX-License-Identifier: GPL-2.0-only
 
-noinst_LTLIBRARIES = libhashtable.la
+noinst_LTLIBRARIES = libhashtable-gpl.la libhashtable-lgpl.la
 
-libhashtable_la_SOURCES = \
+libhashtable_lgpl_la_SOURCES = \
+	seed.cpp \
+	utils.cpp \
+	utils.h
+
+libhashtable_gpl_la_SOURCES = \
 	hashtable.cpp \
 	hashtable.h \
-	hashtable-symbols.h \
-        utils.cpp \
-	utils.h
+	hashtable-symbols.h
 
-libhashtable_la_LIBADD = $(URCU_LIBS) $(URCU_CDS_LIBS)
+libhashtable_gpl_la_LIBADD = \
+	$(URCU_LIBS) \
+	$(URCU_CDS_LIBS)
diff --git a/src/common/hashtable/hashtable.cpp b/src/common/hashtable/hashtable.cpp
index 5ae7f26e0..c641dad3c 100644
--- a/src/common/hashtable/hashtable.cpp
+++ b/src/common/hashtable/hashtable.cpp
@@ -19,7 +19,6 @@
 /* seed_lock protects both seed_init and lttng_ht_seed. */
 static pthread_mutex_t seed_lock = PTHREAD_MUTEX_INITIALIZER;
 static bool seed_init;
-unsigned long lttng_ht_seed;
 
 static unsigned long min_hash_alloc_size = 1;
 static unsigned long max_hash_buckets_size = 0;
diff --git a/src/common/hashtable/seed.cpp b/src/common/hashtable/seed.cpp
new file mode 100644
index 000000000..24da1bc95
--- /dev/null
+++ b/src/common/hashtable/seed.cpp
@@ -0,0 +1,11 @@
+/*
+ * Copyright (C) 2021 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+#define _LGPL_SOURCE
+#include "hashtable.h"
+#include "utils.h"
+
+unsigned long lttng_ht_seed;
diff --git a/src/common/kernel-consumer/Makefile.am b/src/common/kernel-consumer/Makefile.am
index b1184130e..4e7205cbe 100644
--- a/src/common/kernel-consumer/Makefile.am
+++ b/src/common/kernel-consumer/Makefile.am
@@ -6,6 +6,4 @@ libkernel_consumer_la_SOURCES = \
 	kernel-consumer.cpp \
 	kernel-consumer.h
 
-libkernel_consumer_la_LIBADD = \
-		   $(top_builddir)/src/common/kernel-ctl/libkernel-ctl.la \
-		   $(top_builddir)/src/common/relayd/librelayd.la
+libkernel_consumer_la_LIBADD = $(top_builddir)/src/common/kernel-ctl/libkernel-ctl.la
diff --git a/src/common/ust-consumer/Makefile.am b/src/common/ust-consumer/Makefile.am
index 26f166785..5e1005372 100644
--- a/src/common/ust-consumer/Makefile.am
+++ b/src/common/ust-consumer/Makefile.am
@@ -8,8 +8,6 @@ libust_consumer_la_SOURCES = \
 	ust-consumer.cpp \
 	ust-consumer.h
 
-libust_consumer_la_LIBADD = \
-			$(UST_CTL_LIBS) \
-			$(top_builddir)/src/common/relayd/librelayd.la
+libust_consumer_la_LIBADD = $(UST_CTL_LIBS)
 
 endif
diff --git a/src/lib/lttng-ctl/Makefile.am b/src/lib/lttng-ctl/Makefile.am
index 590ed2fd8..281806c1f 100644
--- a/src/lib/lttng-ctl/Makefile.am
+++ b/src/lib/lttng-ctl/Makefile.am
@@ -31,7 +31,7 @@ EXTRA_DIST = liblttng-ctl.sym
 
 liblttng_ctl_la_LIBADD = \
 		$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la \
-		$(top_builddir)/src/common/libcommon-gpl.la
+		$(top_builddir)/src/common/libcommon-lgpl.la
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = lttng-ctl.pc
diff --git a/tests/regression/tools/live/Makefile.am b/tests/regression/tools/live/Makefile.am
index dcbeba9a4..494b982df 100644
--- a/tests/regression/tools/live/Makefile.am
+++ b/tests/regression/tools/live/Makefile.am
@@ -3,13 +3,6 @@
 AM_CPPFLAGS += -I$(top_srcdir)/tests/utils/ -I$(srcdir)
 
 LIBTAP=$(top_builddir)/tests/utils/tap/libtap.la
-
-LIBCOMMON_GPL=$(top_builddir)/src/common/libcommon-gpl.la
-LIBSESSIOND_COMM=$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la
-LIBHASHTABLE=$(top_builddir)/src/common/hashtable/libhashtable.la
-LIBRELAYD=$(top_builddir)/src/common/relayd/librelayd.la
-LIBHEALTH=$(top_builddir)/src/common/health/libhealth.la
-LIBCOMPAT=$(top_builddir)/src/common/compat/libcompat.la
 LIBLTTNG_SESSIOND_COMMON=$(top_builddir)/src/bin/lttng-sessiond/liblttng-sessiond-common.la
 
 noinst_PROGRAMS = live_test
diff --git a/tests/unit/Makefile.am b/tests/unit/Makefile.am
index 6441e2efb..bcba28fdb 100644
--- a/tests/unit/Makefile.am
+++ b/tests/unit/Makefile.am
@@ -40,7 +40,6 @@ LIBCOMMON_GPL=$(top_builddir)/src/common/libcommon-gpl.la
 LIBSTRINGUTILS=$(top_builddir)/src/common/string-utils/libstring-utils.la
 LIBFDTRACKER=$(top_builddir)/src/common/fd-tracker/libfd-tracker.la
 LIBSESSIOND_COMM=$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la
-LIBHASHTABLE=$(top_builddir)/src/common/hashtable/libhashtable.la
 LIBRELAYD=$(top_builddir)/src/common/relayd/librelayd.la
 LIBLTTNG_CTL=$(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la
 LIBLTTNG_SESSIOND_COMMON=$(top_builddir)/src/bin/lttng-sessiond/liblttng-sessiond-common.la
@@ -79,7 +78,7 @@ endif
 
 # URI unit tests
 test_uri_SOURCES = test_uri.cpp
-test_uri_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(LIBHASHTABLE) $(DL_LIBS)
+test_uri_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(DL_LIBS)
 
 RELAYD_OBJS = $(top_builddir)/src/bin/lttng-relayd/backward-compatibility-group-by.$(OBJEXT)
 
@@ -104,15 +103,15 @@ test_kernel_data_LDADD = $(LIBTAP) $(LIBLTTNG_SESSIOND_COMMON) $(DL_LIBS)
 
 # parse_size_suffix unit test
 test_utils_parse_size_suffix_SOURCES = test_utils_parse_size_suffix.cpp
-test_utils_parse_size_suffix_LDADD = $(LIBTAP) $(LIBHASHTABLE) $(LIBCOMMON_GPL) $(DL_LIBS)
+test_utils_parse_size_suffix_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(DL_LIBS)
 
 # parse_time_suffix unit test
 test_utils_parse_time_suffix_SOURCES = test_utils_parse_time_suffix.cpp
-test_utils_parse_time_suffix_LDADD = $(LIBTAP) $(LIBHASHTABLE) $(LIBCOMMON_GPL)
+test_utils_parse_time_suffix_LDADD = $(LIBTAP) $(LIBCOMMON_GPL)
 
 # compat_poll unit test
 test_utils_compat_poll_SOURCES = test_utils_compat_poll.cpp
-test_utils_compat_poll_LDADD  = $(LIBTAP) $(LIBHASHTABLE) $(DL_LIBS) \
+test_utils_compat_poll_LDADD  = $(LIBTAP) $(DL_LIBS) \
 		      $(top_builddir)/src/common/compat/libcompat.la $(LIBCOMMON_GPL)
 
 # compat_pthread unit test
@@ -122,11 +121,11 @@ test_utils_compat_pthread_LDADD  = $(LIBTAP) \
 
 # expand_path unit test
 test_utils_expand_path_SOURCES = test_utils_expand_path.cpp
-test_utils_expand_path_LDADD = $(LIBTAP) $(LIBHASHTABLE) $(LIBCOMMON_GPL) $(DL_LIBS)
+test_utils_expand_path_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(DL_LIBS)
 
 # directory handle unit test
 test_directory_handle_SOURCES = test_directory_handle.cpp
-test_directory_handle_LDADD = $(LIBTAP) $(LIBHASHTABLE) $(LIBCOMMON_GPL) $(DL_LIBS)
+test_directory_handle_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(DL_LIBS)
 
 # string utilities unit test
 test_string_utils_SOURCES = test_string_utils.cpp
@@ -157,7 +156,7 @@ test_rate_policy_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(LIBLTTNG_CTL) $(DL_LIBS) \
 
 # fd tracker unit test
 test_fd_tracker_SOURCES = test_fd_tracker.cpp
-test_fd_tracker_LDADD = $(LIBTAP) $(LIBFDTRACKER) $(DL_LIBS) $(URCU_LIBS) $(LIBCOMMON_GPL) $(LIBHASHTABLE)
+test_fd_tracker_LDADD = $(LIBTAP) $(LIBFDTRACKER) $(DL_LIBS) $(URCU_LIBS) $(LIBCOMMON_GPL)
 
 # uuid unit test
 test_uuid_SOURCES = test_uuid.cpp
diff --git a/tests/unit/ini_config/Makefile.am b/tests/unit/ini_config/Makefile.am
index 76a6cb6bf..6bb88df48 100644
--- a/tests/unit/ini_config/Makefile.am
+++ b/tests/unit/ini_config/Makefile.am
@@ -4,13 +4,12 @@ AM_CPPFLAGS += -I$(top_srcdir)/tests/utils/
 
 LIBTAP=$(top_builddir)/tests/utils/tap/libtap.la
 LIBCOMMON_GPL=$(top_builddir)/src/common/libcommon-gpl.la
-LIBHASHTABLE=$(top_builddir)/src/common/hashtable/libhashtable.la
 
 noinst_PROGRAMS = ini_config
 EXTRA_DIST = test_ini_config sample.ini
 
 ini_config_SOURCES = ini_config.cpp
-ini_config_LDADD = $(LIBTAP) $(LIBCOMMON_GPL) $(LIBHASHTABLE)
+ini_config_LDADD = $(LIBTAP) $(LIBCOMMON_GPL)
 
 all-local:
 	@if [ x"$(srcdir)" != x"$(builddir)" ]; then \