#!/bin/bash ## Helpers # For valid __preserves_regs parameters, look for _getRegByName in SDCC source code. set -eu . firmware_coverage_helper.env #echo "Checking that each c prototype matches one asm-level symbol ..." { for symbolname in $( list_c_function_names ) do #echo -n "." NOWRAPPER_COUNT=$( nowrappers_lines | grep "_$symbolname " | wc -l ) WRAPPER_COUNT=$( list_fw_wrapper_symbols | grep "^_${symbolname}$" | wc -l ) TOTAL=$(( $NOWRAPPER_COUNT + $WRAPPER_COUNT )) if [[ "$TOTAL" != "1" ]] then echo -e "WARNING: $NOWRAPPER_COUNT nowrapper + $WRAPPER_COUNT wrapper = ${TOTAL}, expected 1, call declared in C but not properly implemented: $symbolname" >&2 fi done #echo "done" } & # Sanity check { for ASM_SOURCE_FILE in $( list_fw_wrapper_files ) do for SYMBOL in $( cat $ASM_SOURCE_FILE | sed -n "s|^.*$fw[^:]*$::|\1|p" ) do SYMBOL_NOSUFFIX=$( echo $SYMBOL | sed "s/__.*//" ) if [[ "$ASM_SOURCE_FILE" != "src/${SYMBOL_NOSUFFIX}.s" ]] then echo >&2 "WARNING: $ASM_SOURCE_FILE contains unexpected symbol ${SYMBOL_NOSUFFIX}" fi done done } & # Start output # save stdout and redirect to coverage.html exec 4<&1 exec >coverage.html.tmp TITLE="Firmware coverage in cpc-dev-tool-chain's CFWI (C-firmware interface)" cat < $TITLE EOF function sanity_check_pass_fail() { declare PASSFAIL=$( if [[ "$1" == "$2" ]] then echo 'PASS' RC=1 else echo >&2 "WARNING: Sanity check fail $1 != $2 : $3" echo 'FAIL' RC=0 fi ) html_out_variable "Sanity check $1==$2
$3" "$PASSFAIL" return $RC } function html_out_variable() { echo "$1$2" } ## Sanity check echo "

$TITLE

" echo '

For background information refer to cpc-dev-tool-chain.

' echo '

To start hacking and generate an updated table, see README-maintainer.md.

' echo "

Global Statistics

" PERCENTAGE=$( echo "$TOTAL_C_DECLARED_FW_CALL_COUNT 100 * $TOTAL_FW_CALL_COUNT / p" | dc ) echo "" html_out_variable "Total fw calls as per SOFT968 official documentation" "$TOTAL_FW_CALL_COUNT" html_out_variable "Total fw calls declared at C level" "$TOTAL_C_DECLARED_FW_CALL_COUNT" html_out_variable "Overall coverage percentage" "${PERCENTAGE}%" echo "

" function symbol_level_statistics() { echo "

Function/symbol-level Statistics

" echo "" html_out_variable "Total calls covered at C level" "$TOTAL_C_DECLARED_FW_FUNCTION_NAMES" html_out_variable "Total direct ASM symbols (not wrappers) count" "$TOTAL_FW_NOWRAPPER_COUNT" html_out_variable "Total ASM wrapper count" "$TOTAL_FW_WRAPPER_COUNT" SC_TOTAL_ASM_SYMBOL_COUNT=$(( $TOTAL_FW_WRAPPER_COUNT + $TOTAL_FW_NOWRAPPER_COUNT )) if sanity_check_pass_fail $SC_TOTAL_ASM_SYMBOL_COUNT $TOTAL_C_DECLARED_FW_FUNCTION_NAMES "(wrappers)+(no-wrappers)==(C function count)" then FAILHINT=$( diff -u \ <( list_c_function_names | sort ) \ <( { list_fw_nowrapper_symbols ; list_fw_wrapper_symbols ; } | sort ) ) fi echo "

" if [[ -n "${FAILHINT:-}" ]] then echo "

Hint:

${FAILHINT}

" fi } # disabled for now, since one wrapper file now holds several symbols # (several C-level functions point to same wrapper, they on ly differ # in types) # symbol_level_statistics function firmware_call-level_statistics() { echo "

Firmware-call-level Statistics

" echo "" html_out_variable "Total fw calls covered both without and with wrapper" "$TOTAL_FW_TWICE_COVERED_COUNT" SC_TOTAL_COVERED_WITH_AND_WITHOUT_WRAPPER_NODUPLICATE=$(( $TOTAL_FW_NOWRAPPER_COUNT + $TOTAL_FW_WRAPPER_COUNT - $TOTAL_FW_TWICE_COVERED_COUNT )) html_out_variable "Total fw calls covered, filtering duplicate coverage" "$SC_TOTAL_COVERED_WITH_AND_WITHOUT_WRAPPER_NODUPLICATE" sanity_check_pass_fail $SC_TOTAL_COVERED_WITH_AND_WITHOUT_WRAPPER_NODUPLICATE $TOTAL_C_DECLARED_FW_CALL_COUNT } echo "

" ## Per-package ##function list_packages() ##{ ## list_fw_calls_c_style | sed -n 's/fw_$[^_]*$_.*$/\1/p' | sort | uniq ##} echo "

Statistics per firmware packages

" echo "" echo "" for PACKAGE in $( list_fw_official_packages ) do ALL_CALLS=$( list_fw_official_calls_in_package $PACKAGE | wc -l ) COVERED=$( list_fw_calls_c_style | in_package_count ) COVERAGE_PERCENT=$(( $COVERED * 100 / $ALL_CALLS )) # NOWRAPPERS=$( nowrappers_lines | in_package_count ) # WRAPPED=$( list_fw_wrapper_files | in_package_count ) echo "" # " done echo "

Package	Call count	C-covered	%
$PACKAGE	$ALL_CALLS	$COVERED	${COVERAGE_PERCENT}%	$NOWRAPPERS	$WRAPPED

" echo "

Details per firmware packages

" for PACKAGE in $( list_fw_official_packages ) do echo "

Package $PACKAGE

" echo "" echo "" COLUMNS=4 # For each firmware call, gather a list of variants. # Variants = all symbols, C, asm, gathered. # For each variant generate a table line. # The "name" cell will span all these lines, vertically. # If no variant, then no vertical span, but a horizontal span with an error message "not covered". for CALLNAME in $( list_fw_official_calls_in_package "${PACKAGE}" | tradi_names_to_c_style_names ) do SYMBOLS_C=$( list_c_function_names | grep "$CALLNAME" || true ) SYMBOLS_ASM=$( list_asm_symbols | grep "$CALLNAME" || true ) SYMBOLS_ALL=$( for a in $SYMBOLS_C $SYMBOLS_ASM ; do echo $a ; done | sort | uniq ; ) if [[ -z "$SYMBOLS_ALL" ]] then echo "" continue fi AFTERFIRSTCOLUMN="" SYMBOL_COUNT=$( for a in $SYMBOLS_ALL ; do echo $a ; done | wc -l ) echo -n "" for SYMBOL in $SYMBOLS_ALL do if [[ -n "$AFTERFIRSTCOLUMN" ]] then echo -n "" #echo "" fi AFTERFIRSTCOLUMN=yes # For each variant generate a table line. # echo -n "" # echo -n "" report_implementation_asm $SYMBOL PRESERVE_SPEC="$( list_c_prototypes | grep -w $SYMBOL | sed -n 's|^.* __preserves_regs($[^)]*$).*$|\1|p' || true )" PRESERVE_CSS_CLASS="" if [[ -n "$PRESERVE_SPEC" ]] then PRESERVE_CSS_CLASS="preserve_implemented" fi echo -n "" echo -n "" echo "" done #NOWRAPPERS=$( nowrappers_lines | grep $CALLNAME ) #WRAPPER=$( FILES=$( list_fw_wrapper_files | grep "$CALLNAME" ) ; for FILE in $FILES ; do echo "

In $FILE

" ; grep "$CALLNAME.*::" $FILE ; done ) #PROTOTYPES=$( list_c_prototypes | grep $CALLNAME | prototype_line_to_bare_prototype ) # echo "" done echo "

Call	ASM symbol(s)	Preserved regs optimisation	C prototype(s)
$( echo $CALLNAME \| c_style_names_to_tradi_names )	Not yet covered
$( echo $CALLNAME \| c_style_names_to_tradi_names )
$( echo $CALLNAME \| c_style_names_to_tradi_names )	$( list_asm_symbols \| grep -w $SYMBOL \|\| echo "MISSING ASM SYMBOL $SYMBOL" )	" # $( list_asm_symbols \| grep -w $SYMBOL \|\| echo "MISSING ASM SYMBOL $SYMBOL" ) # echo "	$PRESERVE_SPEC	`$( list_c_prototypes \| prototype_line_to_bare_prototype \| grep -w $SYMBOL \|\| echo "MISSING C PROTOTYPE $SYMBOL" )`
$( echo $CALLNAME \| c_style_names_to_tradi_names )	$NOWRAPPERS	$WRAPPER	$PROTOTYPES

" done echo "

Conclusion

" echo '

Happy hacking! Start there: cpc-dev-tool-chain on GitHub.

' echo "" echo "" # restore stdout exec 1<&4 mv coverage.html.tmp coverage.html exit 0 ## Count functions updated since some commit git diff ${BASECOMMIT}..HEAD -- include/cfwi/ | grep -i '^\+[a-z].* fw_.*;$' | sed 's/^\+//' | grep -o " fw_[^b][^ ]*" | sort | uniq | grep -o 'fw_[^_]*' | sort | uniq -c ## Extract list of updated functions since some commit git diff ${BASECOMMIT}..HEAD -- include/cfwi/ | grep -i '^\+[a-z].* fw_.*;$' | sed 's/^\+//' | grep -o " fw_[^b][^ ]*" | sort | uniq