Commit b84e1faf authored by Vladimir Malenovsky's avatar Vladimir Malenovsky
Browse files

Merge branch 'main' into float-1489-add-rtp-dump-tests-with-isar

parents afb6e620 6db0830c

.gitlab/issue_templates/msan_ltv_error.md

+3 −8
Original line number Diff line number Diff line
@@ -16,12 +16,6 @@ Link to test pipeline: XXX 


### Ways to reproduce



Activate [origin-tracking](https://clang.llvm.org/docs/MemorySanitizer.html#msan-origins) (more detailed traceback about where the undefined value came from) by appending

```

 -fsanitize-memory-track-origins

```

in the `Makefile` at lines 71 and 72. Note that this may increase runtime heavily.



Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/Software-development/pyivastest-howto#how-to-reproduce-tests):

<!--- check correct sanitizer type -->

<!--- add error pattern if needed -->
@@ -30,11 +24,12 @@ Using the [scripts](https://forge.3gpp.org/rep/ivas-codec-pc/ivas-codec/-/wikis/ 
```

python3 scripts/IvasBuildAndRunChecks.py --checks CLANG1 -m MODE -p /path/to/my/local/ci_linux_ltv_local.json

```



or directly:



```

make clean

make -j CLANG=1

make -j CLANG=1 MSAN_TRACK_ORIGINS=1

./IVAS_cod ...

networkSimulator_g192 dly_profile.dat bit bit_err trace_dump 1

./IVAS_dec ...

CMakeLists.txt

+12 −12
Original line number Diff line number Diff line
@@ -37,7 +37,8 @@ set(CMAKE_C_STANDARD 99) 
if(UNIX)

  set(TARGET_PLATFORM ""  CACHE STRING "i686 / x86_64")

  set(CLANG           ""  CACHE STRING "1=msan / 2=asan / 3=usan")

  set(GCOV            OFF CACHE BOOL   "enable GCOV")

  set(MSAN_TRACK_ORIGINS OFF CACHE BOOL "enable origin tracking for Clang MSAN")

  set(COVERAGE            OFF CACHE BOOL   "enable coverage instrumentation")

  set(STRIP           OFF CACHE BOOL   "enable STRIP")



  if(NOT CMAKE_BUILD_TYPE)
@@ -62,13 +63,19 @@ if(UNIX) 
  # to be uncommented in CI

  # set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror")



  # set C compiler

  find_program(cc NAMES clang-18 clang REQUIRED)

  set(CMAKE_C_COMPILER "${cc}" CACHE STRING "")



  # CLANG

  if(CLANG)

    find_program(clangBin NAMES /home/amm-archiv/soft/Linux/clang/current/bin/clang clang REQUIRED)

    set(CMAKE_C_COMPILER "${clangBin}" CACHE STRING "")

    if("${CLANG}" MATCHES "1" OR "${CLANG}" MATCHES "msan")

      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=memory")

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=memory")

      if(MSAN_TRACK_ORIGINS)

        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize-memory-track-origins")

        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize-memory-track-origins")

      endif()

    elseif("${CLANG}" MATCHES "2" OR "${CLANG}" MATCHES "asan")

      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address")

      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
@@ -89,8 +96,8 @@ if(UNIX) 
      message(FATAL_ERROR "Unknown CLANG setting: ${CLANG}")

    endif()

  endif()

  # GCOV

  if(GCOV)

  # COVERAGE

  if(COVERAGE)

    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage -fprofile-update=atomic")

    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fprofile-arcs -ftest-coverage -fprofile-update=atomic")

  endif()
@@ -192,12 +199,6 @@ if(WIN32) 
  target_link_libraries(IVAS_cod Ws2_32)

endif()



add_executable(IVAS_cod_fmtsw apps/encoder_fmtsw.c)

target_link_libraries(IVAS_cod_fmtsw lib_enc lib_util)

if(WIN32)

  target_link_libraries(IVAS_cod_fmtsw Ws2_32)

endif()



add_executable(IVAS_dec apps/decoder.c)

target_link_libraries(IVAS_dec lib_dec lib_util)

if(WIN32)
@@ -222,7 +223,6 @@ target_include_directories(ambi_converter PRIVATE lib_util) 
if(COPY_EXECUTABLES_FROM_BUILD_DIR)

  # Optionally copy executables to the same place where Make puts them (useful for tests that expect executables in specific places)

  add_custom_command(TARGET IVAS_cod POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:IVAS_cod>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  add_custom_command(TARGET IVAS_cod_fmtsw POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:IVAS_cod_fmtsw>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  add_custom_command(TARGET IVAS_dec POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:IVAS_dec>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  add_custom_command(TARGET IVAS_rend POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:IVAS_rend>" "${CMAKE_CURRENT_SOURCE_DIR}/")

  add_custom_command(TARGET ISAR_post_rend POST_BUILD VERBATIM COMMAND "${CMAKE_COMMAND}" -E copy "$<TARGET_FILE:ISAR_post_rend>" "${CMAKE_CURRENT_SOURCE_DIR}/")

Makefile

+26 −18
Original line number Diff line number Diff line
@@ -18,7 +18,6 @@ SRC_DIRS = $(sort -u $(SRC_LIBCOM) $(SRC_LIBDEBUG) $(SRC_LIBDEC) $(SRC_LIBENC) 
# Name of CLI binaries

CLI_APIDEC   	?= IVAS_dec

CLI_APIENC   	?= IVAS_cod

CLI_APIENC_FMTSW   	?= IVAS_cod_fmtsw

CLI_APIREND  	?= IVAS_rend

CLI_APIPOSTREND ?= ISAR_post_rend

CLI_AMBICONVERT ?= ambi_converter
@@ -31,9 +30,8 @@ LIB_LIBISAR ?= libisar.a 
LIB_LC3PLUS  	?= liblc3plus.a

LIB_LIBUTIL  	?= libivasutil.a





# Default tool settings

CC        ?= gcc

CC        ?= cc

RM        ?= rm -f

AR        ?= ar
@@ -63,30 +61,44 @@ endif 
# C compiler flags

CFLAGS   += -std=c99 -pedantic -Wcast-qual -Wall -W -Wextra -Wno-long-long     \

            -Wpointer-arith -Wstrict-prototypes -Wmissing-prototypes  \

            -Wno-implicit-fallthrough -ffp-contract=off

            -Werror-implicit-function-declaration \

            -Wno-implicit-fallthrough -ffp-contract=off \

            -Winit-self -Wunused-but-set-variable

# to be uncommented in CI

# CFLAGS += -Werror



# libs to link

LDLIBS   += -lm



# Clang sanitizer compiler options

CCCLANG = clang

ifeq "$(CLANG)" "0"

CC       = $(CCCLANG)

# check if clang is available on system and use it if it is there

CLANG_EXISTS := $(shell which clang)



ifneq "$(CLANG_EXISTS)" ""

CC = clang

else

$(warning clang compiler not found - falling back to cc)

endif



# Clang sanitizer compiler options

ifeq "$(CLANG)" "1"

CC       = $(CCCLANG)

CC       = clang

CFLAGS  += -fsanitize=memory

LDFLAGS += -fsanitize=memory



# can be set in call to make, e.g. "make CLANG=1 MSAN_TRACK_ORIGINS=1"

ifeq "$(MSAN_TRACK_ORIGINS)" "1"

CFLAGS  += -fsanitize-memory-track-origins

LDFLAGS += -fsanitize-memory-track-origins

endif



endif

ifeq "$(CLANG)" "2"

CC       = $(CCCLANG)

CC       = clang

CFLAGS  += -fsanitize=address

LDFLAGS += -fsanitize=address

endif

ifeq "$(CLANG)" "3"

CC       = $(CCCLANG) 

CC       = clang

# NOTE: keep in sync with list in CMakeLists.txt

usan_checks = undefined,float-divide-by-zero,implicit-conversion,local-bounds

CFLAGS  += -fsanitize=$(usan_checks)
@@ -105,7 +117,7 @@ CFLAGS += -g3 
LDFLAGS  += -g3

endif



ifeq "$(GCOV)" "1"

ifeq "$(COVERAGE)" "1"

CFLAGS  += -fprofile-arcs -ftest-coverage -fprofile-update=atomic

LDFLAGS += -fprofile-arcs -ftest-coverage -fprofile-update=atomic

endif
@@ -158,7 +170,6 @@ OBJS_LIBUTIL = $(addprefix $(OBJDIR)/,$(SRCS_LIBUTIL:.c=.o)) 
OBJS_AMBICONVERT = $(OBJDIR)/ambi_convert.o

OBJS_CLI_APIDEC  = $(OBJDIR)/decoder.o

OBJS_CLI_APIENC  = $(OBJDIR)/encoder.o

OBJS_CLI_APIENC_FMTSW  = $(OBJDIR)/encoder_fmtsw.o

OBJS_CLI_APPREND = $(OBJDIR)/renderer.o

OBJS_CLI_APPPOSTREND = $(OBJDIR)/isar_post_rend.o

OBJS_CLI_AMBICONVERT = $(OBJDIR)/ambi_converter.o
@@ -171,7 +182,7 @@ DEPS = $(addprefix $(OBJDIR)/,$(SRCS_LIBCOM:.c=.P) $(SRCS_LIBDEBUG:.c=.P) $(SRCS 


.PHONY: all clean



all: $(CLI_APIENC) $(CLI_APIENC_FMTSW) $(CLI_APIDEC) $(CLI_APIREND) $(CLI_APIPOSTREND) $(CLI_AMBICONVERT)

all: $(CLI_APIENC) $(CLI_APIDEC) $(CLI_APIREND) $(CLI_APIPOSTREND) $(CLI_AMBICONVERT)



$(OBJDIR):

	$(QUIET)mkdir -p $(OBJDIR)
@@ -203,9 +214,6 @@ $(LIB_LIBUTIL): $(OBJS_LIBUTIL) 
$(CLI_APIENC): $(OBJS_CLI_APIENC) $(LIB_LIBENC) $(LIB_LIBCOM) $(LIB_LIBUTIL) $(LIB_LIBDEBUG) $(LIB_LC3PLUS)

	$(QUIET_LINK)$(CC) $(LDFLAGS) $(OBJS_CLI_APIENC) -L. -livasenc -livascom -livasutil -livasdebug $(LDLIBS) -o $(CLI_APIENC)



$(CLI_APIENC_FMTSW): $(OBJS_CLI_APIENC_FMTSW) $(LIB_LIBENC) $(LIB_LIBCOM) $(LIB_LIBUTIL) $(LIB_LIBDEBUG) $(LIB_LC3PLUS)

	$(QUIET_LINK)$(CC) $(LDFLAGS) $(OBJS_CLI_APIENC_FMTSW) -L. -livasenc -livascom -livasutil -livasdebug $(LDLIBS) -o $(CLI_APIENC_FMTSW)



$(CLI_APIDEC): $(OBJS_CLI_APIDEC) $(LIB_LIBDEC) $(LIB_LIBCOM) $(LIB_LIBUTIL) $(LIB_LIBDEBUG) $(LIB_LC3PLUS) $(LIB_LIBISAR)

	$(QUIET_LINK)$(CC) $(LDFLAGS) $(OBJS_CLI_APIDEC) -L. -livasdec -livascom -livasutil -livasdebug -llc3plus $(LDLIBS) -o $(CLI_APIDEC)
@@ -224,7 +232,7 @@ clean: 
	$(QUIET)$(RM) $(OBJS_LIBENC) $(OBJS_LIBDEC) $(DEPS)

	$(QUIET)$(RM) $(DEPS:.P=.d)

	$(QUIET)test ! -d $(OBJDIR) || rm -rf $(OBJDIR)

	$(QUIET)$(RM) $(CLI_APIENC) $(CLI_APIENC_FMTSW) $(CLI_APIDEC) $(CLI_APIREND) $(CLI_APIPOSTREND) $(CLI_AMBICONVERT) $(LIB_LIBENC) $(LIB_LIBDEBUG) $(LIB_LIBCOM) $(LIB_LIBDEC) $(LIB_LIBUTIL) $(LIB_LIBREND) $(LIB_LIBISAR) $(LIB_LC3PLUS)

	$(QUIET)$(RM) $(CLI_APIENC) $(CLI_APIDEC) $(CLI_APIREND) $(CLI_APIPOSTREND) $(CLI_AMBICONVERT) $(LIB_LIBENC) $(LIB_LIBDEBUG) $(LIB_LIBCOM) $(LIB_LIBDEC) $(LIB_LIBUTIL) $(LIB_LIBREND) $(LIB_LIBISAR) $(LIB_LC3PLUS)



$(OBJDIR)/%.o : %.c | $(OBJDIR)

	$(QUIET_CC)$(CC) $(CFLAGS) -c -MD -o $@ $<

Workspace_msvc/Workspace_msvc.sln

+0 −8
Original line number Diff line number Diff line
@@ -18,8 +18,6 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "decoder", "decoder.vcxproj" 
EndProject

Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "encoder", "encoder.vcxproj", "{B3FC9DFC-7268-8660-7C0D-B60BAF02C554}"

EndProject

Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "encoder_fmtsw", "encoder_fmtsw.vcxproj", "{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}"

EndProject

Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "renderer", "renderer.vcxproj", "{12B4C8A5-1E06-4E30-B443-D1F916F52B47}"

EndProject

Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "lib_lc3plus", "lib_lc3plus.vcxproj", "{95030B82-70CD-4C6B-84D4-61096035BEA2}"
@@ -91,12 +89,6 @@ Global 
		{B3FC9DFC-7268-8660-7C0D-B60BAF02C554}.Release|Win32.ActiveCfg = Release|Win32

		{B3FC9DFC-7268-8660-7C0D-B60BAF02C554}.Release|Win32.Build.0 = Release|Win32

		{B3FC9DFC-7268-8660-7C0D-B60BAF02C554}.Release|x64.ActiveCfg = Release|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Debug|Win32.ActiveCfg = Debug|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Debug|Win32.Build.0 = Debug|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Debug|x64.ActiveCfg = Debug|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Release|Win32.ActiveCfg = Release|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Release|Win32.Build.0 = Release|Win32

		{CA7EA15E-09A4-4196-A8EA-2A5F6F84862B}.Release|x64.ActiveCfg = Release|Win32

		{12B4C8A5-1E06-4E30-B443-D1F916F52B47}.Debug|Win32.ActiveCfg = Debug|Win32

		{12B4C8A5-1E06-4E30-B443-D1F916F52B47}.Debug|Win32.Build.0 = Debug|Win32

		{12B4C8A5-1E06-4E30-B443-D1F916F52B47}.Debug|x64.ActiveCfg = Debug|Win32

Workspace_msvc/lib_dec.vcxproj

+0 −2
Original line number Diff line number Diff line
@@ -270,7 +270,6 @@ 
    <ClCompile Include="..\lib_dec\jbm_jb4_inputbuffer.c" />

    <ClCompile Include="..\lib_dec\jbm_jb4_jmf.c" />

    <ClCompile Include="..\lib_dec\jbm_pcmdsp_apa.c" />

    <ClCompile Include="..\lib_dec\jbm_pcmdsp_fifo.c" />

    <ClCompile Include="..\lib_dec\jbm_pcmdsp_similarityestimation.c" />

    <ClCompile Include="..\lib_dec\jbm_pcmdsp_window.c" />

    <ClCompile Include="..\lib_dec\LD_music_post_filter.c" />
@@ -318,7 +317,6 @@ 
    <ClInclude Include="..\lib_dec\jbm_jb4_inputbuffer.h" />

    <ClInclude Include="..\lib_dec\jbm_jb4_jmf.h" />

    <ClInclude Include="..\lib_dec\jbm_pcmdsp_apa.h" />

    <ClInclude Include="..\lib_dec\jbm_pcmdsp_fifo.h" />

    <ClInclude Include="..\lib_dec\jbm_pcmdsp_similarityestimation.h" />

    <ClInclude Include="..\lib_dec\jbm_pcmdsp_window.h" />

    <ClInclude Include="..\lib_dec\lib_dec.h" />