Merge pull request #5726 from alexrp/master

[profiler] Clean up the makefile and address some issues with it.

* Don't link the profilers to libmono, except on mobile.
* The coverage profiler doesn't use zlib. Don't link to it.
* Fix the LIBADD variable for the VTune profiler.
* Add some comments for certain non-obvious aspects.
* Some style cleanup.

Also introduce a HOST_IOS variable in the build system which covers iOS, watchOS, and tvOS.

configure.ac

@@ -113,6 +113,7 @@ ikvm_native=yes
 host_win32=no
 target_win32=no
 platform_android=no
+platform_ios=no
 host_darwin=no
 
 
@@ -344,8 +345,12 @@ case "$host" in
 				with_sgen_default_concurrent=yes
 				;;
 			arm*-darwin*)
+				platform_ios=yes
 				has_dtrace=no
-				;;			
+				;;
+			aarch64*-darwin*)
+				platform_ios=yes
+				;;
 		esac
 		;;
 	*-*-haiku*)
@@ -400,6 +405,7 @@ AM_CONDITIONAL(HOST_LINUX, echo x$target_os | grep -q linux)
 AM_CONDITIONAL(HOST_DARWIN, test x$host_darwin = xyes)
 AM_CONDITIONAL(HOST_SIGPOSIX, test x$use_sigposix = xyes)
 AM_CONDITIONAL(HOST_ANDROID, test x$platform_android = xyes)
+AM_CONDITIONAL(HOST_IOS, test x$platform_ios = xyes)
 
 if test -z "$HOST_DARWIN_TRUE"; then :
 PLATFORM_AOT_SUFFIX=.dylib

mono/profiler/Makefile.am

@@ -1,21 +1,18 @@
-if HAVE_ZLIB
-Z_LIBS= -lz
-else
-Z_LIBS=
-endif
-
 AM_CPPFLAGS = \
-	-DSUPPRESSION_DIR=\""$(datadir)/mono-$(API_VER)/mono/profiler"\"        \
-	-I$(top_srcdir) 	\
+	-DSUPPRESSION_DIR=\""$(datadir)/mono-$(API_VER)/mono/profiler"\" \
+	-I$(top_srcdir) \
 	$(GLIB_CFLAGS)
 
 if !HOST_WIN32
 if !DISABLE_LIBRARIES
 if !DISABLE_PROFILER
+
 bin_PROGRAMS = mprof-report
 
 if HAVE_VTUNE
-vtune_libs = libmono-profiler-vtune.la libmono-profiler-vtune-static.la
+vtune_libs = \
+	libmono-profiler-vtune.la \
+	libmono-profiler-vtune-static.la
 endif
 
 lib_LTLIBRARIES = \
@@ -32,25 +29,10 @@ lib_LTLIBRARIES = \
 suppressiondir = $(datadir)/mono-$(API_VER)/mono/profiler
 suppression_DATA = mono-profiler-log.suppression
 
-if HOST_DARWIN
-if BITCODE
-prof_ldflags = -no-undefined
-else
-prof_ldflags = -Wl,-undefined -Wl,suppress -Wl,-flat_namespace
-endif
-endif
-
-if TARGET_OSX
-libmono_dep =
-else
-libmono_dep = $(monodir)/mono/mini/$(LIBMONO_LA)
-endif
-
-if HOST_ANDROID
-prof_ldflags = -avoid-version
-endif
-
-# FIXME fix the profiler tests to work with coop.
+# FIXME: The profiler tests currently don't work with coop because the
+# sampling infrastructure depends on signals being available.
+#
+# See: https://bugzilla.xamarin.com/show_bug.cgi?id=57011
 if !ENABLE_COOP
 check_targets = testlog
 endif
@@ -59,13 +41,58 @@ endif
 endif
 endif
 
-monodir=$(top_builddir)
+# On Apple hosts, we want to allow undefined symbols when building the
+# profiler modules as, just like on Linux, we don't link them to libmono,
+# but rather let the dynamic linker sort things out.
+#
+# Bitcode, specifically, doesn't allow undefined symbols at all, even for
+# shared libraries, so we want errors if the profiler modules contain any.
+if HOST_DARWIN
+if BITCODE
+prof_ldflags = -no-undefined
+else
+prof_ldflags = -Wl,-undefined -Wl,suppress -Wl,-flat_namespace
+endif
+endif
 
-# The log profiler uses eglib functions, so it needs to be linked against
-# libeglib in shared mode, but not in static mode, since that would
-# leads to duplicate symbols when it is linked into an app which
-# also uses eglib (e.g. the runtime). Automake doesn't support this
-# functionality, so create a separate static version of the library.
+# Versioned libraries are problematic on Android. In particular, we're not
+# allowed to place versioned libraries inside APKs, so if libmono and the
+# profiler modules contain versioned sonames, things will fail to resolve
+# at runtime.
+if HOST_ANDROID
+prof_ldflags = -avoid-version
+endif
+
+# Linking to libmono on desktop can cause problems when loading a profiler
+# module into a statically-linked mono executable, e.g. running library
+# constructors multiple times, which can easily break LLVM libraries. So,
+# we don't want to link to libmono on desktop. On Android, libmono is
+# always loaded dynamically, so we do need to link to libmono there or the
+# dynamic linker will have trouble resolving everything. On iOS, the story
+# is similar to Android when running in the simulator.
+if HOST_ANDROID
+libmono_dep = $(top_builddir)/mono/mini/$(LIBMONO_LA)
+else
+if HOST_IOS
+# Note that BITCODE implies HOST_IOS, so this case ensures that we link to
+# libmono when building a bitcode runtime.
+libmono_dep = $(top_builddir)/mono/mini/$(LIBMONO_LA)
+else
+libmono_dep =
+endif
+endif
+
+if HAVE_ZLIB
+# The log profiler uses zlib for output compression when available.
+zlib_dep = -lz
+else
+zlib_dep =
+endif
+
+# We build a separate, static version of each profiler for use on targets
+# which do not support dynamic linking (e.g. iOS). We still want to build
+# the shared version on those targets since it's useful for e.g. simulator
+# builds.
 
 libmono_profiler_aot_la_SOURCES = aot.c
 libmono_profiler_aot_la_LIBADD =  $(libmono_dep) $(GLIB_LIBS) $(LIBICONV)
@@ -80,13 +107,13 @@ libmono_profiler_iomap_static_la_SOURCES = iomap.c
 libmono_profiler_iomap_static_la_LDFLAGS = -static
 
 libmono_profiler_log_la_SOURCES = log.c log-args.c
-libmono_profiler_log_la_LIBADD = $(libmono_dep) $(GLIB_LIBS) $(Z_LIBS)
+libmono_profiler_log_la_LIBADD = $(libmono_dep) $(GLIB_LIBS) $(zlib_dep)
 libmono_profiler_log_la_LDFLAGS = $(prof_ldflags)
 libmono_profiler_log_static_la_SOURCES = log.c log-args.c
 libmono_profiler_log_static_la_LDFLAGS = -static
 
 libmono_profiler_coverage_la_SOURCES = coverage.c
-libmono_profiler_coverage_la_LIBADD = $(libmono_dep) $(GLIB_LIBS) $(Z_LIBS)
+libmono_profiler_coverage_la_LIBADD = $(libmono_dep) $(GLIB_LIBS)
 libmono_profiler_coverage_la_LDFLAGS = $(prof_ldflags)
 libmono_profiler_coverage_static_la_SOURCES = coverage.c
 libmono_profiler_coverage_static_la_LDFLAGS = -static
@@ -94,7 +121,7 @@ libmono_profiler_coverage_static_la_LDFLAGS = -static
 if HAVE_VTUNE
 libmono_profiler_vtune_la_SOURCES = vtune.c
 libmono_profiler_vtune_la_CFLAGS = $(VTUNE_CFLAGS)
-libmono_profiler_vtune_la_LIBADD = $(VTUNE_LIBS) $(LIBMONO) $(GLIB_LIBS) $(LIBICONV)
+libmono_profiler_vtune_la_LIBADD = $(VTUNE_LIBS) $(libmono_dep) $(GLIB_LIBS) $(LIBICONV)
 libmono_profiler_vtune_la_LDFLAGS = $(prof_ldflags)
 libmono_profiler_vtune_static_la_SOURCES = vtune.c
 libmono_profiler_vtune_static_la_LDFLAGS = -static
@@ -103,14 +130,19 @@ libmono_profiler_vtune_static_la_LIBADD = $(VTUNE_LIBS)
 endif
 
 mprof_report_SOURCES = mprof-report.c
-mprof_report_LDADD = $(Z_LIBS) $(GLIB_LIBS) $(LIBICONV)
+mprof_report_LDADD = $(GLIB_LIBS) $(LIBICONV) $(zlib_dep)
 
-PLOG_TESTS_SRC=test-alloc.cs test-busy.cs test-monitor.cs test-excleave.cs \
-	test-heapshot.cs test-traces.cs
-PLOG_TESTS=$(PLOG_TESTS_SRC:.cs=.exe)
+PLOG_TESTS_SRC = \
+	test-alloc.cs \
+	test-busy.cs \
+	test-monitor.cs \
+	test-excleave.cs \
+	test-heapshot.cs \
+	test-traces.cs
 
-CLASS=$(mcs_topdir)/class/lib/$(DEFAULT_PROFILE)
+PLOG_TESTS = $(PLOG_TESTS_SRC:.cs=.exe)
 
+CLASS = $(mcs_topdir)/class/lib/$(DEFAULT_PROFILE)
 TOOLS_RUNTIME = MONO_PATH=$(mcs_topdir)/class/lib/build $(top_builddir)/runtime/mono-wrapper
 MCS = $(TOOLS_RUNTIME) $(CSC) -lib:$(CLASS) -unsafe -nologo -noconfig -nowarn:0162 -nowarn:0168 -nowarn:0219 -debug:portable
 
@@ -122,7 +154,8 @@ testlog: $(PLOG_TESTS)
 
 check-local: $(check_targets)
 
-EXTRA_DIST=log.h \
+EXTRA_DIST = \
+	log.h \
 	aot.h \
 	$(PLOG_TESTS_SRC) \
 	ptestrunner.pl \

mono/profiler/coverage.c

@@ -68,9 +68,6 @@
 #ifdef HAVE_SYS_MMAN_H
 #include <sys/mman.h>
 #endif
-#if defined (HAVE_SYS_ZLIB)
-#include <zlib.h>
-#endif
 
 #include <mono/metadata/assembly.h>
 #include <mono/metadata/debug-helpers.h>