Introduce gcovpreload repo to support code coverage report generation for swss and sairedis

platform/vs/docker-sonic-vs.mk

@@ -14,7 +14,8 @@ $(DOCKER_SONIC_VS)_DEPENDS += $(SWSS) \
                               $(LIBYANG_PY3) \
                               $(SONIC_UTILITIES_DATA) \
                               $(SONIC_HOST_SERVICES_DATA) \
-                              $(IPROUTE2)
+                              $(IPROUTE2) \
+                              $(LIBGCOV_PRELOAD)
 
 # swsssdk is a dependency of sonic-py-common
 # TODO: sonic-py-common should depend on swsscommon instead

rules/docker-orchagent.mk

@@ -13,7 +13,7 @@ endif
 $(DOCKER_ORCHAGENT)_DBG_DEPENDS = $($(DOCKER_SWSS_LAYER_BULLSEYE)_DBG_DEPENDS)
 $(DOCKER_ORCHAGENT)_DBG_DEPENDS +=   $(SWSS_DBG) \
                                 $(LIBSWSSCOMMON_DBG) \
-                                $(LIBSAIREDIS_DBG)
+                                $(LIBSAIREDIS_DBG) \
 $(DOCKER_ORCHAGENT)_PYTHON_WHEELS += $(SCAPY)
 
 $(DOCKER_ORCHAGENT)_DBG_IMAGE_PACKAGES = $($(DOCKER_SWSS_LAYER_BULLSEYE)_DBG_IMAGE_PACKAGES)

rules/gcov_preload.mk

@@ -0,0 +1,12 @@
+# libgcovpreload package
+# Created for gcda files generations
+
+GCOV_PRELOAD_VERSION = 0.0.1
+GCOV_PRELOAD_VERSION_FULL = $(GCOV_PRELOAD_VERSION)-1
+
+export GCOV_PRELOAD_VERSION GCOV_PRELOAD_VERSION_FULL
+
+LIBGCOV_PRELOAD = libgcovpreload_$(GCOV_PRELOAD_VERSION_FULL)_$(CONFIGURED_ARCH).deb
+$(LIBGCOV_PRELOAD)_SRC_PATH = $(SRC_PATH)/preload
+
+SONIC_MAKE_DEBS += $(LIBGCOV_PRELOAD)

rules/sairedis.mk

@@ -8,40 +8,43 @@ $(LIBSAIREDIS)_DPKG_TARGET = binary-sairedis
 $(LIBSAIREDIS)_SRC_PATH = $(SRC_PATH)/sonic-sairedis
 $(LIBSAIREDIS)_VERSION = $(LIBSAIREDIS_VERSION)
 $(LIBSAIREDIS)_NAME = $(LIBSAIREDIS_NAME)
-$(LIBSAIREDIS)_DEPENDS += $(LIBSWSSCOMMON_DEV)
+$(LIBSAIREDIS)_DEPENDS += $(LIBSWSSCOMMON_DEV) $(LIBGCOV_PRELOAD)
 $(LIBSAIREDIS)_RDEPENDS += $(LIBSWSSCOMMON)
 $(LIBSAIREDIS)_DEB_BUILD_OPTIONS = nocheck
 SONIC_DPKG_DEBS += $(LIBSAIREDIS)
 
 LIBSAIREDIS_DEV = $(LIBSAIREDIS_NAME)-dev_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
+$(LIBSAIREDIS_DEV)_DEPENDS += $(LIBGCOV_PRELOAD)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIREDIS_DEV)))
 
 LIBSAIVS = libsaivs_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
+$(LIBSAIVS)_DEPENDS += $(LIBGCOV_PRELOAD)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIVS)))
 
 LIBSAIVS_DEV = libsaivs-dev_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIVS_DEV)))
-$(LIBSAIVS_DEV)_DEPENDS += $(LIBSAIVS)
+$(LIBSAIVS_DEV)_DEPENDS += $(LIBSAIVS) $(LIBGCOV_PRELOAD)
 
 LIBSAIMETADATA = libsaimetadata_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
+$(LIBSAIMETADATA)_DEPENDS += $(LIBGCOV_PRELOAD)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIMETADATA)))
 
 LIBSAIMETADATA_DEV = libsaimetadata-dev_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
-$(LIBSAIMETADATA_DEV)_DEPENDS += $(LIBSAIMETADATA)
+$(LIBSAIMETADATA_DEV)_DEPENDS += $(LIBSAIMETADATA) $(LIBGCOV_PRELOAD)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIMETADATA_DEV)))
 
 LIBSAIREDIS_DBG = $(LIBSAIREDIS_NAME)-dbg_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
-$(LIBSAIREDIS_DBG)_DEPENDS += $(LIBSAIREDIS)
+$(LIBSAIREDIS_DBG)_DEPENDS += $(LIBSAIREDIS) $(LIBGCOV_PRELOAD)
 $(LIBSAIREDIS_DBG)_RDEPENDS += $(LIBSAIREDIS)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIREDIS_DBG)))
 
 LIBSAIVS_DBG = libsaivs-dbg_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
-$(LIBSAIVS_DBG)_DEPENDS += $(LIBSAIVS)
+$(LIBSAIVS_DBG)_DEPENDS += $(LIBSAIVS) $(LIBGCOV_PRELOAD)
 $(LIBSAIVS_DBG)_RDEPENDS += $(LIBSAIVS)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIVS_DBG)))
 
 LIBSAIMETADATA_DBG = libsaimetadata-dbg_$(LIBSAIREDIS_VERSION)_$(CONFIGURED_ARCH).deb
-$(LIBSAIMETADATA_DBG)_DEPENDS += $(LIBSAIMETADATA)
+$(LIBSAIMETADATA_DBG)_DEPENDS += $(LIBSAIMETADATA) $(LIBGCOV_PRELOAD)
 $(LIBSAIMETADATA_DBG)_RDEPENDS += $(LIBSAIMETADATA)
 $(eval $(call add_derived_package,$(LIBSAIREDIS),$(LIBSAIMETADATA_DBG)))
 

rules/swss.mk

@@ -4,15 +4,16 @@ SWSS = swss_1.0.0_$(CONFIGURED_ARCH).deb
 $(SWSS)_SRC_PATH = $(SRC_PATH)/sonic-swss
 $(SWSS)_DEPENDS += $(LIBSAIREDIS_DEV) $(LIBSAIMETADATA_DEV) $(LIBTEAM_DEV) \
     $(LIBTEAMDCTL) $(LIBTEAM_UTILS) $(LIBSWSSCOMMON_DEV) \
-    $(LIBSAIVS) $(LIBSAIVS_DEV)
+    $(LIBSAIVS) $(LIBSAIVS_DEV) \
+    $(LIBGCOV_PRELOAD)
 $(SWSS)_UNINSTALLS = $(LIBSAIVS_DEV)
 
 $(SWSS)_RDEPENDS += $(LIBSAIREDIS) $(LIBSAIMETADATA) $(LIBTEAM) \
     $(LIBTEAMDCTL) $(LIBSWSSCOMMON) $(PYTHON3_SWSSCOMMON)
 SONIC_DPKG_DEBS += $(SWSS)
 
 SWSS_DBG = swss-dbg_1.0.0_$(CONFIGURED_ARCH).deb
-$(SWSS_DBG)_DEPENDS += $(SWSS)
+$(SWSS_DBG)_DEPENDS += $(SWSS) $(LIBGCOV_PRELOAD)
 $(SWSS_DBG)_RDEPENDS += $(SWSS)
 $(eval $(call add_derived_package,$(SWSS),$(SWSS_DBG)))
 

src/preload/.gitignore

@@ -0,0 +1,5 @@
+gcovpreload/debian/*
+!gcovpreload/debian/changelog 
+!gcovpreload/debian/control
+!gcovpreload/debian/rules 
+!gcovpreload/debian/libgcovpreload.postinst

src/preload/Makefile

@@ -0,0 +1,11 @@
+.ONESHELL:
+SHELL = /bin/bash
+.SHELLFLAGS += -e
+
+MAIN_TARGET = libgcovpreload_$(GCOV_PRELOAD_VERSION_FULL)_$(CONFIGURED_ARCH).deb
+
+$(addprefix $(DEST)/, $(MAIN_TARGET)): $(DEST)/% :
+	pushd gcov_preload
+	dpkg-buildpackage -rfakeroot -d -b -us -uc -j$(SONIC_CONFIG_MAKE_JOBS)
+	popd
+	mv $* $(DEST)/

src/preload/gcov_preload/Makefile

@@ -0,0 +1,22 @@
+#gcov Makefile
+
+MKDIR := mkdir
+MV := mv
+#OBJ=gcov_preload.o
+LIBNAME=libgcovpreload
+
+# Fallback to gcc when $CC is not in $PATH.
+CC:=$(shell sh -c 'type $${CC%% *} >/dev/null 2>/dev/null && echo $(CC) || echo gcc')
+CXX:=$(shell sh -c 'type $${CXX%% *} >/dev/null 2>/dev/null && echo $(CXX) || echo g++')
+
+DYLIBSUFFIX=so
+DYLIBNAME=$(LIBNAME).$(DYLIBSUFFIX)
+DYLIB_MAKE_CMD=$(CC) -shared -fpic gcov_preload.c -o ${DYLIBNAME}
+
+$(DYLIBNAME):
+	$(DYLIB_MAKE_CMD)
+
+# Other Targets
+install:
+	$(MKDIR) -p $(DESTDIR)/usr/lib
+	$(MV) $(DYLIBNAME) $(DESTDIR)/usr/lib

src/preload/gcov_preload/debian/changelog

@@ -0,0 +1,5 @@
+gcovpreload (0.0.1-1) stretch-backports; urgency=medium
+
+  * Rebuild for stretch-backports. (Closes: #911732)
+
+ --Petter Shao <pettershao@ragilenetworks>  Wed, 07 Nov 2021 11:26:50 +0000

src/preload/gcov_preload/debian/control

@@ -0,0 +1,22 @@
+Source: gcovpreload
+Priority: optional
+Maintainer: Petter Shao <pettershao@ragilenetworks>
+Build-Depends:
+ debhelper-compat (= 11),
+ procps <!nocheck>,
+ redis-server (>= 2:2.4.2-2) [linux-any kfreebsd-any] <!nocheck>,
+Standards-Version: 4.2.1
+Section: libs
+Homepage: 
+Vcs-Git: 
+Vcs-Browser: 
+
+Package: libgcovpreload
+Architecture: any
+Depends:
+ ${misc:Depends},
+ ${shlibs:Depends},
+Pre-Depends:
+ ${misc:Pre-Depends},
+Multi-Arch: same
+Description: minimalistic C client library for Redis

src/preload/gcov_preload/debian/copyright

@@ -0,0 +1,8 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: gcovpreload 
+Upstream-Contact: Petter Shao <pettershao@ragilenetworks>
+Source: 
+
+Files: *
+Copyright:
+License: BSD-3-Clause

src/preload/gcov_preload/debian/debhelper-build-stamp

@@ -0,0 +1 @@
+libgcovpreload

src/preload/gcov_preload/debian/libgcovpreload.postinst

@@ -0,0 +1,4 @@
+# !/bin/sh
+# postinst
+echo /usr/lib/libgcovpreload.so > /etc/ld.so.preload
+

src/preload/gcov_preload/debian/rules

@@ -0,0 +1,8 @@
+#!/usr/bin/make -f
+
+%:
+	dh $@
+
+override_dh_auto_install:
+	dh_auto_install -- LIBRARY_PATH="lib/" \
+		PREFIX=/usr

src/preload/gcov_preload/gcov_preload.c

@@ -0,0 +1,43 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <signal.h>
+#include <signal.h>
+#define SIMPLE_WAY
+
+void sighandler(int signo) 
+{ 
+#ifdef SIMPLE_WAY
+    exit(signo); 
+#else
+    extern void __gcov_flush(); /* flush*/
+    __gcov_flush(); /* flush out gcov stats data */
+    raise(signo); /* raise the signal again to crash process */ 
+#endif 
+} 
+
+/**
+* The code for cracking the preloaded dynamic library gcov_preload.so is as follows, where __attribute__((constructor)) is the symbol of gcc,
+* The modified function will be called before the main function is executed. We use it to intercept the exception signal to our own function, and then call __gcov_flush() to output the error message
+*/
+
+__attribute__ ((constructor))
+
+void ctor() 
+{
+    int sigs[] = {
+        SIGILL, SIGFPE, SIGABRT, SIGBUS,
+        SIGSEGV, SIGHUP, SIGINT, SIGQUIT,
+        SIGTERM     
+    };
+    int i; 
+    struct sigaction sa;
+    sa.sa_handler = sighandler;
+    sigemptyset(&sa.sa_mask);
+    sa.sa_flags = SA_RESETHAND;
+
+    for(i = 0; i < sizeof(sigs)/sizeof(sigs[0]); ++i) {
+        if (sigaction(sigs[i], &sa, NULL) == -1) {
+            perror("Could not set signal handler");
+        }
+    } 
+}