diff mbox series

[ovs-dev] ovsdb-idl: Fix IDL memory leak.

Message ID 20240902092818.1846942-1-xsimonar@redhat.com
State Accepted
Commit c98759a4f3c8e01063ec0268334e92160f585ed3
Delegated to: Eelco Chaudron
Headers show
Series [ovs-dev] ovsdb-idl: Fix IDL memory leak. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed

Commit Message

Xavier Simonart Sept. 2, 2024, 9:28 a.m. UTC
In the following case, we could see multiple leaks detected for memory allocated
by ovsdb_idl_txn_add_map_op: insert a row in a table, set a key and delete the row
(all within the same transaction).

For instance:
Direct leak of 24 byte(s) in 1 object(s) allocated from:
    0 0x4e60a7 in calloc (./tests/test-ovsdb+0x4e60a7)
    1 0x5f9b32 in xcalloc__ ./lib/util.c:125:31
    2 0x5f9b60 in xzalloc__ ./lib/util.c:135:12
    3 0x5f9c25 in xzalloc ./ovs/lib/util.c:169:12
    4 0x5d4899 in ovsdb_idl_txn_add_map_op ./lib/ovsdb-idl.c:4175:29
    5 0x5d4758 in ovsdb_idl_txn_write_partial_map ./lib/ovsdb-idl.c:4332:5
    6 0x53cbe8 in idltest_simple2_update_smap_setkey ./tests/idltest.c:4701:5
    7 0x526fe2 in do_idl_partial_update_map_column ./tests/test-ovsdb.c:3027:5
    8 0x59d99c in ovs_cmdl_run_command__ ./lib/command-line.c:247:17
    9 0x59d79a in ovs_cmdl_run_command ./lib/command-line.c:278:5
    10 0x51d458 in main ./tests/test-ovsdb.c:80:5
    11 0x7f0a20a79b74 in __libc_start_main (/lib64/libc.so.6+0x27b74)

Signed-off-by: Xavier Simonart <xsimonar@redhat.com>
---
 lib/ovsdb-idl.c    |  2 ++
 tests/ovsdb-idl.at |  9 +++++++--
 tests/test-ovsdb.c | 38 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 47 insertions(+), 2 deletions(-)

Comments

Mike Pattrick Sept. 6, 2024, 3:01 p.m. UTC | #1
On Mon, Sep 2, 2024 at 5:28 AM Xavier Simonart <xsimonar@redhat.com> wrote:
>
> In the following case, we could see multiple leaks detected for memory allocated
> by ovsdb_idl_txn_add_map_op: insert a row in a table, set a key and delete the row
> (all within the same transaction).
>
> For instance:
> Direct leak of 24 byte(s) in 1 object(s) allocated from:
>     0 0x4e60a7 in calloc (./tests/test-ovsdb+0x4e60a7)
>     1 0x5f9b32 in xcalloc__ ./lib/util.c:125:31
>     2 0x5f9b60 in xzalloc__ ./lib/util.c:135:12
>     3 0x5f9c25 in xzalloc ./ovs/lib/util.c:169:12
>     4 0x5d4899 in ovsdb_idl_txn_add_map_op ./lib/ovsdb-idl.c:4175:29
>     5 0x5d4758 in ovsdb_idl_txn_write_partial_map ./lib/ovsdb-idl.c:4332:5
>     6 0x53cbe8 in idltest_simple2_update_smap_setkey ./tests/idltest.c:4701:5
>     7 0x526fe2 in do_idl_partial_update_map_column ./tests/test-ovsdb.c:3027:5
>     8 0x59d99c in ovs_cmdl_run_command__ ./lib/command-line.c:247:17
>     9 0x59d79a in ovs_cmdl_run_command ./lib/command-line.c:278:5
>     10 0x51d458 in main ./tests/test-ovsdb.c:80:5
>     11 0x7f0a20a79b74 in __libc_start_main (/lib64/libc.so.6+0x27b74)
>
> Signed-off-by: Xavier Simonart <xsimonar@redhat.com>

I've tested it out a bit and confirmed that the memory leak does happen.

Acked-by: Mike Pattrick <mkp@redhat.com>
Eelco Chaudron Sept. 9, 2024, 12:13 p.m. UTC | #2
On 2 Sep 2024, at 11:28, Xavier Simonart wrote:

> In the following case, we could see multiple leaks detected for memory allocated
> by ovsdb_idl_txn_add_map_op: insert a row in a table, set a key and delete the row
> (all within the same transaction).
>
> For instance:
> Direct leak of 24 byte(s) in 1 object(s) allocated from:
>     0 0x4e60a7 in calloc (./tests/test-ovsdb+0x4e60a7)
>     1 0x5f9b32 in xcalloc__ ./lib/util.c:125:31
>     2 0x5f9b60 in xzalloc__ ./lib/util.c:135:12
>     3 0x5f9c25 in xzalloc ./ovs/lib/util.c:169:12
>     4 0x5d4899 in ovsdb_idl_txn_add_map_op ./lib/ovsdb-idl.c:4175:29
>     5 0x5d4758 in ovsdb_idl_txn_write_partial_map ./lib/ovsdb-idl.c:4332:5
>     6 0x53cbe8 in idltest_simple2_update_smap_setkey ./tests/idltest.c:4701:5
>     7 0x526fe2 in do_idl_partial_update_map_column ./tests/test-ovsdb.c:3027:5
>     8 0x59d99c in ovs_cmdl_run_command__ ./lib/command-line.c:247:17
>     9 0x59d79a in ovs_cmdl_run_command ./lib/command-line.c:278:5
>     10 0x51d458 in main ./tests/test-ovsdb.c:80:5
>     11 0x7f0a20a79b74 in __libc_start_main (/lib64/libc.so.6+0x27b74)
>
> Signed-off-by: Xavier Simonart <xsimonar@redhat.com>
> ---

I looked at the patch and with my minimal ovsdb knowledge this looks good to me.

Acked-by: Eelco Chaudron <echaudro@redhat.com>
Eelco Chaudron Sept. 11, 2024, 3:10 p.m. UTC | #3
On 2 Sep 2024, at 11:28, Xavier Simonart wrote:

> In the following case, we could see multiple leaks detected for memory allocated
> by ovsdb_idl_txn_add_map_op: insert a row in a table, set a key and delete the row
> (all within the same transaction).
>
> For instance:
> Direct leak of 24 byte(s) in 1 object(s) allocated from:
>     0 0x4e60a7 in calloc (./tests/test-ovsdb+0x4e60a7)
>     1 0x5f9b32 in xcalloc__ ./lib/util.c:125:31
>     2 0x5f9b60 in xzalloc__ ./lib/util.c:135:12
>     3 0x5f9c25 in xzalloc ./ovs/lib/util.c:169:12
>     4 0x5d4899 in ovsdb_idl_txn_add_map_op ./lib/ovsdb-idl.c:4175:29
>     5 0x5d4758 in ovsdb_idl_txn_write_partial_map ./lib/ovsdb-idl.c:4332:5
>     6 0x53cbe8 in idltest_simple2_update_smap_setkey ./tests/idltest.c:4701:5
>     7 0x526fe2 in do_idl_partial_update_map_column ./tests/test-ovsdb.c:3027:5
>     8 0x59d99c in ovs_cmdl_run_command__ ./lib/command-line.c:247:17
>     9 0x59d79a in ovs_cmdl_run_command ./lib/command-line.c:278:5
>     10 0x51d458 in main ./tests/test-ovsdb.c:80:5
>     11 0x7f0a20a79b74 in __libc_start_main (/lib64/libc.so.6+0x27b74)
>
> Signed-off-by: Xavier Simonart <xsimonar@redhat.com>

Thanks for the patch Xavier, it’s been applied to main. I will apply it to other branches later this week.

//Eelco
diff mbox series

Patch

diff --git a/lib/ovsdb-idl.c b/lib/ovsdb-idl.c
index ba720474b..d92df28d1 100644
--- a/lib/ovsdb-idl.c
+++ b/lib/ovsdb-idl.c
@@ -3783,6 +3783,8 @@  ovsdb_idl_txn_delete(const struct ovsdb_idl_row *row_)
     ovsdb_idl_remove_from_indexes(row_);
     if (!row->old_datum) {
         ovsdb_idl_row_unparse(row);
+        ovsdb_idl_destroy_all_map_op_lists(row);
+        ovsdb_idl_destroy_all_set_op_lists(row);
         ovsdb_idl_row_clear_new(row);
         ovs_assert(!row->prereqs);
         hmap_remove(&row->table->rows, &row->hmap_node);
diff --git a/tests/ovsdb-idl.at b/tests/ovsdb-idl.at
index 9070ea051..74ccaccdd 100644
--- a/tests/ovsdb-idl.at
+++ b/tests/ovsdb-idl.at
@@ -1881,7 +1881,10 @@  OVSDB_CHECK_IDL_PARTIAL_UPDATE_MAP_COLUMN([map, simple2 idl-partial-update-map-c
 007: name=String2 smap=[[key2 : value2]] imap=[[3 : myids2]]
 008: After trying to delete a deleted element
 009: name=String2 smap=[[key2 : value2]] imap=[[3 : myids2]]
-010: End test
+010: After Create element, update smap and Delete element
+011: name=String2 smap=[[key2 : value2]] imap=[[3 : myids2]]
+012: After update smap and Delete element
+014: End test
 ]])
 
 OVSDB_CHECK_IDL_PY([partial-map idl],
@@ -1944,7 +1947,9 @@  OVSDB_CHECK_IDL_PARTIAL_UPDATE_SET_COLUMN([set, simple3 idl-partial-update-set-c
 009: table simple3: name=String2 uset=[<0>,<1>,<4>] uref=[] uuid=<2>
 010: After add to other table + set of strong ref
 011: table simple3: name=String2 uset=[<0>,<1>,<4>] uref=[<5>] uuid=<2>
-012: End test
+012: After Create element, update set and Delete element
+013: table simple3: name=String2 uset=[<0>,<1>,<4>] uref=[<5>] uuid=<2>
+014: End test
 ]])
 
 OVSDB_CHECK_IDL_PY([partial-set idl],
diff --git a/tests/test-ovsdb.c b/tests/test-ovsdb.c
index 41c1525f4..710341b65 100644
--- a/tests/test-ovsdb.c
+++ b/tests/test-ovsdb.c
@@ -3020,6 +3020,29 @@  do_idl_partial_update_map_column(struct ovs_cmdl_context *ctx)
     printf("%03d: After trying to delete a deleted element\n", step++);
     dump_simple2(idl, myRow, step++);
 
+    myTxn = ovsdb_idl_txn_create(idl);
+    myRow = idltest_simple2_insert(myTxn);
+    idltest_simple2_update_smap_setkey(myRow, "key3", "myList3");
+    idltest_simple2_set_name(myRow, "String2");
+    idltest_simple2_delete(myRow);
+    ovsdb_idl_txn_commit_block(myTxn);
+    ovsdb_idl_txn_destroy(myTxn);
+    ovsdb_idl_get_initial_snapshot(idl);
+    printf("%03d: After Create element, update smap and Delete element\n",
+           step++);
+    dump_simple2(idl, myRow, step++);
+
+    myTxn = ovsdb_idl_txn_create(idl);
+    myRow = idltest_simple2_first(idl);
+    idltest_simple2_update_smap_setkey(myRow, "key4", "myList4");
+    idltest_simple2_set_name(myRow, "String3");
+    idltest_simple2_delete(myRow);
+    ovsdb_idl_txn_commit_block(myTxn);
+    ovsdb_idl_txn_destroy(myTxn);
+    ovsdb_idl_get_initial_snapshot(idl);
+    printf("%03d: After update smap and Delete element\n", step++);
+    dump_simple2(idl, myRow, step++);
+
     ovsdb_idl_destroy(idl);
     printf("%03d: End test\n", step);
 }
@@ -3118,6 +3141,21 @@  do_idl_partial_update_set_column(struct ovs_cmdl_context *ctx)
     ovsdb_idl_get_initial_snapshot(idl);
     printf("%03d: After add to other table + set of strong ref\n", step++);
     dump_simple3(idl, myRow, step++);
+
+    /* create row, insert key, delete row */
+    myTxn = ovsdb_idl_txn_create(idl);
+    myRow = idltest_simple3_insert(myTxn);
+    uuid_from_string(&uuid_to_add, "12345678-dd3f-4616-ab6a-83a490bb0991");
+    idltest_simple3_update_uset_addvalue(myRow, uuid_to_add);
+    idltest_simple3_set_name(myRow, "String2");
+    idltest_simple3_delete(myRow);
+    ovsdb_idl_txn_commit_block(myTxn);
+    ovsdb_idl_txn_destroy(myTxn);
+    ovsdb_idl_get_initial_snapshot(idl);
+    printf("%03d: After Create element, update set and Delete element\n",
+           step++);
+    dump_simple3(idl, myRow, step++);
+
     ovsdb_idl_destroy(idl);
     printf("%03d: End test\n", step);
 }