Merge remote-tracking branch 'origin/master' into gh-pages

Author: msune

.github/workflows/ci.yaml

@@ -10,24 +10,54 @@ env:
   ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
 
 jobs:
-  gcc_ubuntu_18_04:
+  ubuntu_18_04_gcc:
     strategy:
       matrix:
         version: [4.8, 5, 6, 8]
-    runs-on: ubuntu-22.04
-    container:
-      image: ubuntu:18.04
+    runs-on: ubuntu-24.04
     env:
       CPP: cpp-${{ matrix.version }}
       CC: gcc-${{ matrix.version }}
       CXX: g++-${{ matrix.version }}
     steps:
-      - name: "Install git..."
+      - name: "Checkout libcdada"
+        uses: actions/checkout@v3
+        with:
+          path: libcdada
+
+      - name: Run tests in Ubuntu 18.04 container
         run: |
-          apt-get update && apt-get install -y software-properties-common && \
-          apt-get update && add-apt-repository -y ppa:git-core/ppa && \
-          apt-get update && apt-get install -y git
+          docker run --rm \
+            -v ${{ github.workspace }}:/workspace \
+            -w /workspace \
+            -e CPP="${CPP}" \
+            -e CC="${CC}" \
+            -e CXX="${CXX}" \
+            -e CONFIG_FLAGS="--disable-silent-rules" \
+            ubuntu:18.04 \
+            bash -c "
+              set -e
+              apt-get update
+              apt-get install -y software-properties-common
+              add-apt-repository -y ppa:git-core/ppa
+              apt-get update
+              apt-get install -y git
+              git config --global --add safe.directory /workspace/libcdada
+              ./libcdada/.github/workflows/deps.sh gcc ${{ matrix.version }}
+              cd libcdada && .github/workflows/test_script.sh
+              CONFIG_FLAGS=\"\$CONFIG_FLAGS --enable-debug\" .github/workflows/test_script.sh
+            "
 
+  ubuntu_22_04_gcc:
+    strategy:
+      matrix:
+        version: [9, 10, 11, 12]
+    runs-on: ubuntu-22.04
+    env:
+      CPP: cpp-${{ matrix.version }}
+      CC: gcc-${{ matrix.version }}
+      CXX: g++-${{ matrix.version }}
+    steps:
       - name: "Checkout libcdada"
         uses: actions/checkout@v3
         with:
@@ -45,11 +75,11 @@ jobs:
         env:
           CONFIG_FLAGS: --disable-silent-rules --enable-debug
 
-  gcc_ubuntu_22_04:
+  ubuntu_24_04_gcc:
     strategy:
       matrix:
-        version: [9, 10, 11, 12]
-    runs-on: ubuntu-22.04
+        version: [13, 14]
+    runs-on: ubuntu-24.04
     env:
       CPP: cpp-${{ matrix.version }}
       CC: gcc-${{ matrix.version }}
@@ -72,7 +102,7 @@ jobs:
         env:
           CONFIG_FLAGS: --disable-silent-rules --enable-debug
 
-  clang_ubuntu_22_04:
+  ubuntu_22_04_clang:
     strategy:
       matrix:
         version: [11, 12, 13, 14]
@@ -100,3 +130,32 @@ jobs:
         run: cd libcdada && .github/workflows/test_script.sh
         env:
           CONFIG_FLAGS: --disable-silent-rules --enable-debug
+
+  ubuntu_24_04_clang:
+    strategy:
+      matrix:
+        version: [15, 16, 17, 18, 19]
+    runs-on: ubuntu-24.04
+    env:
+      CPP: clang-cpp-${{ matrix.version }}
+      CC: clang-${{ matrix.version }}
+      CXX: clang++-${{ matrix.version }}
+      CFLAGS: -gdwarf-4 #clang14 and on use dwarf5, but valgrind doesn't support it
+      CXXFLAGS: -gdwarf-4
+    steps:
+      - name: "Checkout libcdada"
+        uses: actions/checkout@v3
+        with:
+          path: libcdada
+
+      - name: "Install deps"
+        run: ./libcdada/.github/workflows/deps.sh clang ${{ matrix.version }}
+
+      - name: "Compile and test using clang-${{ matrix.version }}"
+        run: cd libcdada && .github/workflows/test_script.sh
+        env:
+          CONFIG_FLAGS: --disable-silent-rules
+      - name: "Compile and test using clang-${{ matrix.version }} (DEBUG)"
+        run: cd libcdada && .github/workflows/test_script.sh
+        env:
+          CONFIG_FLAGS: --disable-silent-rules --enable-debug

.gitignore

@@ -45,3 +45,4 @@ include/cdada/version.h
 
 !.gitignore
 !.travis.yml
+!.github/

CHANGELOG.md

@@ -9,6 +9,11 @@ Legend:
 - [O] Other
 ```
 
+### v0.6.2 (24th October 2025)
+
+- [B] map: fix garbage in `prev_val` when key not in map for `cdada_map_insert_replace()`
+- [O] CI fixes
+
 ### v0.6.1 (29th July 2024)
 
 - [O] tests: fix segfault in map_test.c

README.md

@@ -1,4 +1,4 @@
-master [![Build status](https://github.com/msune/libcdada/workflows/ci/badge.svg?branch=master)](https://github.com/msune/libcdada/actions), devel [![Build status](https://github.com/msune/libcdada/workflows/ci/badge.svg?branch=devel)](https://github.com/msune/libcdada/actions)
+master [![Build status](https://github.com/msune/libcdada/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/msune/libcdada/actions/workflows/ci.yaml), devel [![Build status](https://github.com/msune/libcdada/actions/workflows/ci.yaml/badge.svg?branch=devel)](https://github.com/msune/libcdada/actions/workflows/ci.yaml)
 
 **libcdada** - basic data structures in C (`libstdc++` wrapper)
 ---------------------------------------------------------------

VERSION

@@ -1 +1 @@
-v0.6.1
+v0.6.2

include/cdada/__map_internal.h

@@ -105,17 +105,23 @@ int cdada_map_insert_u(__cdada_map_int_t* m, std::map<T, void*>* m_u,
 							void** prev_val){
 	typename std::map<T, void*>::iterator it;
 
+	if(prev_val)
+		*prev_val = NULL;
+
 	if(m->key_len == m->user_key_len){
 		T* __attribute((__may_alias__)) aux;
 
 		aux = (T*)key;
 
 		it = m_u->find(*aux);
-		if(!replace && it != m_u->end())
-			return CDADA_E_EXISTS;
 
-		if(replace && prev_val)
-			*prev_val = it->second;
+		if(it != m_u->end()){
+			if(!replace)
+				return CDADA_E_EXISTS;
+
+			if(prev_val)
+				*prev_val = it->second;
+		}
 
 		(*m_u)[*aux] = val;
 
@@ -132,8 +138,13 @@ int cdada_map_insert_u(__cdada_map_int_t* m, std::map<T, void*>* m_u,
 	if(!replace && it != m_u->end())
 		return CDADA_E_EXISTS;
 
-	if(replace && prev_val)
-		*prev_val = it->second;
+	if(it != m_u->end()){
+		if(!replace)
+			return CDADA_E_EXISTS;
+
+		if(prev_val)
+			*prev_val = it->second;
+	}
 
 	(*m_u)[aux] = val;
 

include/cdada/map.h

@@ -179,8 +179,9 @@ int cdada_map_insert(cdada_map_t* map, const void* key, void* val);
 * @param map Map pointer
 * @param key Key. The key type _must_ have all bytes initialized
 * @param val Pointer to the value
-* @param prev_val If not NULL, when replacing a value the previous value will be
-*                 set here, regardless if the operation is successful or not
+* @param prev_val If not NULL the previous stored value for that key will be set
+*                 here (*prev_val = old_value_ptr). If the key didn't exist, it
+*                 will be set to NULL.
 *
 * @returns Return codes:
 *          CDADA_SUCCESS: element is inserted

test/map_test.c

@@ -993,6 +993,51 @@ int test_u3552_insert_removal_traverse_custom(){
 	return 0;
 }
 
+int test_insert_replace_bug_empty(){
+	int rv;
+	uint8_t key;
+	test_u552_t key2;
+	int value, *prev = NULL;
+
+	//Test insert_replace when key doesn't exist in the map
+	map = cdada_map_create(uint8_t);
+	TEST_ASSERT(map != NULL);
+
+	key = 1;
+	//Note: prev is deliberately != NULL, as code MUST nullify
+	prev = (int*)0x1234;
+	rv = cdada_map_insert_replace(map, &key, &value, (void**)&prev);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+	TEST_ASSERT(prev == NULL);
+
+	rv = cdada_map_insert_replace(map, &key, &value, (void**)&prev);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+	TEST_ASSERT(prev == &value);
+	rv = cdada_map_destroy(map);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+
+	//Test insert_replace when key doesn't exist in the map
+	map = cdada_map_create(test_u552_t);
+	TEST_ASSERT(map != NULL);
+
+	memset(&key2, 0, sizeof(key2));
+	key2.mid = 1;
+	prev = (int*)0x1234;
+
+	//if not found
+	rv = cdada_map_insert_replace(map, &key2, &value, (void**)&prev);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+	TEST_ASSERT(prev == NULL);
+
+	rv = cdada_map_insert_replace(map, &key2, &value, (void**)&prev);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+	TEST_ASSERT(prev == &value);
+	rv = cdada_map_destroy(map);
+	TEST_ASSERT(rv == CDADA_SUCCESS);
+
+	return 0;
+}
+
 int main(int args, char** argv){
 
 	int rv;
@@ -1012,6 +1057,8 @@ int main(int args, char** argv){
 	rv |= test_u552_insert_removal_traverse_custom();
 	rv |= test_u3552_insert_removal_traverse_custom();
 
+	rv |= test_insert_replace_bug_empty();
+
 	//Add your test here, and return a code appropriately...
 	return rv == 0? EXIT_SUCCESS : EXIT_FAILURE;
 }