gcov_support.sh

#!/bin/bash
## This script is to enable the gcov support of the SONiC source codes
work_dir=$(pwd)
env_home=$HOME

GCNO_LIST_FILE="gcno_file_list.txt"
GCDA_DIR_LIST="gcda_dir_list.txt"
TMP_GCDA_FILE_LIST="tmp_gcda_file_list.txt"
GCNO_ALL_TAR_GZ="gcno.tar.gz"

INFO_DIR=info
HTML_DIR=html
ALLMERGE_DIR=AllMergeReport

GCOV_OUTPUT=${work_dir}/gcov_output
GCOV_INFO_OUTPUT=${GCOV_OUTPUT}/${INFO_DIR}
GCOV_HTML_OUTPUT=${GCOV_OUTPUT}/${HTML_DIR}
GCOV_MERGE_REPORT_OUTPUT=${GCOV_OUTPUT}/${ALLMERGE_DIR}

HTML_FILE_PREFIX="GCOVHTML_"
HTML_FILE_LIST=${GCOV_OUTPUT}/htmllist
INFO_FILE_PREFIX="GCOVINFO_"
INFO_FILE_LIST=${GCOV_OUTPUT}/infolist
INFO_ERR_LIST=${work_dir}/info_err_list
CONTAINER_LIST=${work_dir}/containerlist
ALL_INFO_FILES=${work_dir}/allinfofileslist
REPE_INFO_LIST=${work_dir}/tmpinfolist
SINGLE_INFO_LIST=${work_dir}/singleinfolist

# reset compiling environment
gcov_support_clean()
{
    find /tmp/gcov -name $INFO_FILE_PREFIX* | xargs rm -rf
    find /tmp/gcov -name $HTML_FILE_PREFIX* | xargs rm -rf
    find /tmp/gcov -name *.gcno | xargs rm -rf
    find /tmp/gcov -name *.gcda | xargs rm -rf
    find /tmp/gcov -name $TMP_GCDA_FILE_LIST | xargs rm -rf
    rm /tmp/gcov/info_err_list
    rm /tmp/gcov/gcda_dir_list.txt
}

# verify whether the info file generated is valid
verify_info_file()
{
    local file=$1
    local path=$2
    local FILE_OK=`grep "FN:" ${file} | wc -l`
    if [ $FILE_OK -lt 1 ] ;then
        echo ${path}/${file} >> /tmp/gcov/info_err_list
        rm ${file}
    fi
}

# search and save the dir where the lcov should be implemented
list_lcov_path()
{
    local find_gcda_file
    local find_gcno_file
    local gcdastr=".gcda"
    local gcda_dir=$1

    echo ${gcda_dir}

    TMP_FILE=${gcda_dir}/tmpgcdalist
    echo "Start searching .gcda files..."
    exec 4>$TMP_FILE
    find_gcda_file=`find ${gcda_dir} -name *.gcda`
    echo ${find_gcda_file}
    RESULT=${find_gcda_file}
    echo "$RESULT" >&4
    exec 4>&-

    cat ${TMP_FILE} | xargs dirname | uniq > ${gcda_dir}/gcda_dir_list.txt
}

# generate gcov base info and html report for specified range files
lcov_genhtml_report()
{
    local gcda_file_range=$1
    list_lcov_path ${gcda_file_range}

    while read line
    do
        local fullpath=$line
        local infoname=${INFO_FILE_PREFIX}${fullpath##*/}.info

        echo ${fullpath}

        pushd ${fullpath}
        GCDA_COUNT=`find -name "*.gcda" | wc -l`
        echo "gcda count: $GCDA_COUNT"
        if [ $GCDA_COUNT -ge 1 ]; then
            echo "Executing lcov -c -d . -o ${infoname}"
            lcov -c -d . -o ${infoname} &>/dev/null
            if [ "$?" != "0" ]; then
                echo "lcov fail!"
                rm ${infoname}
            fi
        fi
        popd
    done < ${gcda_file_range}/gcda_dir_list.txt
}

# generate html reports for all eligible submodules
lcov_genhtml_all()
{
    local container_id

    container_id=$1

    echo " === Start generating all gcov reports === "
    lcov_genhtml_report ${container_id}/gcov
} 

lcov_merge_all()
{
    cp -rf common_work $1/
    find . -name *.info > infolist
    while read line
    do
        if [ ! -f "total.info" ]; then
            lcov -o total.info -a ${line}
        else
            lcov -o total.info -a total.info -a ${line}
        fi
    done < infolist

    # Remove unit test files.
    lcov -o total.info -r total.info "*tests/*"
    lcov -o total.info -r total.info "/usr/*"

    cp $1/lcov_cobertura.py $1/common_work/gcov/
    python $1/common_work/gcov/lcov_cobertura.py total.info -o coverage.xml

    sed -i "s#\.\./s/##" coverage.xml
    sed -i "s#\.\.\.s\.##" coverage.xml

    cd gcov_output/
    if [ ! -d ${ALLMERGE_DIR} ]; then
        mkdir -p ${ALLMERGE_DIR}
    fi

    cp ../coverage.xml ${ALLMERGE_DIR}

    cd ../
}

gcov_set_environment()
{
    local build_dir

    build_dir=$1
    mkdir -p ${build_dir}/gcov_tmp
    mkdir -p ${build_dir}/gcov_tmp/sonic-gcov

    docker ps -q > ${CONTAINER_LIST}

    echo "### Start collecting info files from existed containers"

    for line in $(cat ${CONTAINER_LIST})
    do
        local container_id=${line}
        echo ${container_id}
        echo "script_count"
        script_count=`docker exec -i ${container_id} find / -name gcov_support.sh | wc -l`
        echo ${script_count}
        if [ ${script_count} -gt 0 ]; then
            docker exec -i ${container_id} killall5 -15
            docker exec -i ${container_id} /tmp/gcov/gcov_support.sh collect_gcda
        fi
        gcda_count=`docker exec -i ${container_id} find / -name *.gcda | wc -l`
        if [ ${gcda_count} -gt 0 ]; then
            echo "find gcda in "
            echo ${container_id}
            mkdir -p ${build_dir}/gcov_tmp/sonic-gcov/${container_id}
            pushd ${build_dir}/gcov_tmp/sonic-gcov/${container_id}
            docker cp ${container_id}:/tmp/gcov/ .
            cp gcov/gcov_support.sh ${build_dir}/gcov_tmp/sonic-gcov
            cp gcov/lcov_cobertura.py ${build_dir}/gcov_tmp/sonic-gcov
            popd
        fi
    done

    echo "cat list"
    cat ${CONTAINER_LIST}
}

gcov_merge_info()
{
    lcov_merge_all $1
}

gcov_support_generate_report()
{
    ls -F | grep "/$" > container_dir_list
    sed -i '/gcov_output/d' container_dir_list
    sed -i "s#\/##g" container_dir_list

    mkdir -p gcov_output
    mkdir -p gcov_output/info

    #for same code path
    mkdir -p common_work/gcov
    tar -zxvf swss.tar.gz -C common_work/gcov

    cat container_dir_list
    while read line
    do
        local container_id=${line}
        echo ${container_id}

        cp -rf ${container_id}/* common_work
        cd common_work/gcov/
        find -name gcda*.tar.gz > tmp_gcda.txt
        while read LINE ; do
            echo ${LINE}
            echo ${LINE#*.}
            tar -zxvf ${LINE}
        done < tmp_gcda.txt
        rm tmp_gcda.txt

        gcno_count=`find -name "*.gcno" | wc -l`
        if [ ${gcno_count} -lt 1 ]; then
            find -name gcno*.tar.gz > tmp_gcno.txt
            while read LINE ; do
                echo ${LINE}
                echo ${LINE%%.*}
                tar -zxvf ${LINE}
            done < tmp_gcno.txt
            rm tmp_gcno.txt
        fi
        cd -

        ls -lh common_work/*
        lcov_genhtml_all common_work
        if [ "$?" != "0" ]; then
            echo "###lcov operation fail.."
            return 0
        fi
        mkdir -p gcov_output/${container_id}
        cp -rf common_work/*  gcov_output/${container_id}/*
        pushd gcov_output/${container_id}
        find . -name "*.gcda" -o -name "*.gcno" -o -name "*.gz" -o -name "*.cpp" -o -name "*.h" | xargs rm -rf
        popd
        pushd common_work
        find . -name "*.gcda" -o -name "*.gz" -o -name "*.info" | xargs rm -rf
        popd
        rm -rf ${container_id}
    done < container_dir_list

    # generate report with code
    pushd common_work/gcov
    find . -name "*.gcno" | xargs rm -rf
    popd

    echo "### Make info generating completed !!"
}

# list and save the generated .gcda files
gcov_support_collect_gcda()
{
    echo "gcov_support_collect_gcda begin"
    local gcda_files_count
    local gcda_count

    pushd /
    # check whether .gcda files exist
    gcda_files_count=`find \. -name "*\.gcda" 2>/dev/null | wc -l`
    if [ ${gcda_files_count} -lt 1 ]; then
        echo "### no gcda files found!"
        return 0
    fi

    CODE_PREFFIX=/__w/1/s/

    pushd ${CODE_PREFFIX}
    tar -zcvf /tmp/gcov/gcda.tar.gz *
    popd

    popd
    echo "### collect gcda done!"

    gcov_support_clean

    pushd /tmp/gcov
    gcno_count=`find -name gcno*.tar.gz 2>/dev/null | wc -l`
    if [ ${gcno_count} -lt 1 ]; then
        echo "### Fail! Cannot find any gcno files, please check."
        return -1
    fi

    gcda_count=`find -name gcda*.tar.gz 2>/dev/null | wc -l`
    if [ ${gcda_count} -lt 1 ]; then
        echo "### Cannot find any gcda files, please check."
        return 0
    fi

    rm -rf /tmp/gcov/gcov_output
    mkdir -p /tmp/gcov/gcov_output

    echo "### Make /tmp/gcov dir completed !!"
    popd

}

# list and save the generated .gcno files
gcov_support_collect_gcno()
{
    local find_command
    local tar_command
    local submodule_name

    find gcno*.tar.gz > tmp_gcno.txt
    while read LINE ; do
        rm -f ${LINE}
    done < tmp_gcno.txt
    rm tmp_gcno.txt

    # rename .tmp*_gcno files generated
    for tmp_gcno in `find -name .tmp_*.gcno`
    do
        new_gcno=`echo ${tmp_gcno} | sed 's/.tmp_//g'`
        echo ${new_gcno}
        mv ${tmp_gcno} ${new_gcno}
    done

    echo " === Start collecting .gcno files... === "
    submodule_name=$1
    exec 3>$GCNO_LIST_FILE
    find_command=`find -name "*.gcno" -o -name "*.gcda"`
    echo "${find_command}"
    if [ -z "${find_command}" ]; then
        echo "### Error! no gcno files found!"
        return -1
    fi
    RESULT=${find_command}
    echo "$RESULT" >&3
    exec 3>&-
    
    local filesize=`ls -l $GCNO_LIST_FILE | awk '{print $5}'`
    # Empty gcno_file_list indicates the non-gcov compling mode
    if [ ${filesize} -le 1 ]; then
        echo "empty gcno_file_list.txt"
        rm $GCNO_LIST_FILE
    else
        echo " === Output archive file... === "
        tar_command="tar -T $GCNO_LIST_FILE -zcvf gcno_$submodule_name.tar.gz"
        echo "${tar_command}"
        ${tar_command}
        # temporarily using fixed dir
        cp gcno_$submodule_name.tar.gz ${work_dir}/debian/$submodule_name/tmp/gcov
        cp ./tests/gcov_support.sh ${work_dir}/debian/$submodule_name/tmp/gcov
        cp ./tests/gcov_support.sh ${work_dir}/tests
        cp ./gcovpreload/lcov_cobertura.py ${work_dir}/debian/$submodule_name/tmp/gcov
        mkdir -p ${work_dir}/debian/$submodule_name/usr
        mkdir -p ${work_dir}/debian/$submodule_name/usr/lib
        cp ./gcovpreload/libgcovpreload.so ${work_dir}/debian/$submodule_name/usr/lib
        sudo chmod 777 -R /${work_dir}/debian/$submodule_name/usr/lib/libgcovpreload.so
        rm $GCNO_LIST_FILE
        echo " === Collect finished... === "
    fi
}

main()
{
    case $1 in
        collect)
            gcov_support_collect_gcno $2
            ;;
        collect_gcda)
            gcov_support_collect_gcda
            ;;
        generate)
            gcov_support_generate_report
            ;;
        merge_container_info)
            gcov_merge_info $2
            ;;
        set_environment)
            gcov_set_environment $2
            ;;
        *)
            echo "Usage:"
            echo " collect               collect .gcno files based on module"
            echo " collect_gcda          collect .gcda files"
            echo " generate              generate gcov report in html form (all or submodule_name)"
            echo " merge_container_info  merge homonymic info files from different container"
            echo " set_environment       set environment ready for report generating in containers"
    esac
}

main $1 $2
exit