From nobody Tue Apr 7 21:51:30 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org ARC-Seal: i=1; a=rsa-sha256; t=1773242546; cv=none; d=zohomail.com; s=zohoarc; b=V+1Ksjgnsl5ISetrNbi6i0yC3XfbNwoFxmsD+ac463frSNmEy644vUwrYMDL7J3iWCI2K7HSiiHQ4sofPEz7ZPilIDKc8mHZHjPTIWHyXBoY94CXVEQho2e+SuKmzpriL8zybW4rxRRkZcWyiEk4VJ2m1H/cNdxu43tIKaLZJxw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1773242546; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=/34feIuBJnD43Wat87TqSs/aPaJ/VqAdr7e05XjIQQU=; b=GFbU2zHety9MpldfXeF35He3wjH1svruH+fCUo3fCxiIMptvIehXVSHsUaMijmbP4Fxe4DCGBDYEvw1hoF3BqxIiug2bUONTZcY73tVKP3HRVyBa8QUZ81rrLXjWyw7mBgBX8gSMOtJEznWawUseRdoZVd+skaDDQ5nRx3l86N8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1773242546286118.6621747472841; Wed, 11 Mar 2026 08:22:26 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1w0LDv-0005AB-3D; Wed, 11 Mar 2026 11:11:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1w0LBj-00015f-KX; Wed, 11 Mar 2026 11:09:31 -0400 Received: from isrv.corpit.ru ([212.248.84.144]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1w0LBh-0005hR-BH; Wed, 11 Mar 2026 11:09:31 -0400 Received: from tsrv.corpit.ru (tsrv.tls.msk.ru [192.168.177.2]) by isrv.corpit.ru (Postfix) with ESMTP id 06CBD191E9F; Wed, 11 Mar 2026 18:04:43 +0300 (MSK) Received: from think4mjt.tls.msk.ru (mjtthink.wg.tls.msk.ru [192.168.177.146]) by tsrv.corpit.ru (Postfix) with ESMTP id E846237C2E0; Wed, 11 Mar 2026 18:05:20 +0300 (MSK) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=tls.msk.ru; s=202602; t=1773241483; bh=e14xFKU6PZwBStPyZdwDeVLuMz+xSw0CgIS4SxWRuqc=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=bwqmhYqYf75eV5bF2uGaOf5kzcQopYBwp4J+50l3p1hOOhXrtP/ZUEYCu2ZlyHdJH 5HXPN0KBi0cZgXMRvbzaCrZRQ3n9w/wU4WaKwoYTbSlG30Yy52XEqTtyYBGxI9kwAk nxzoKccZriQan6mlNj+7PHzjlwmTXdTtkGOMPCrWGYPTpHlzyjdHLfCtWr6l5BZg2m qeetV5Q5nsx7PYjyAK6eECKjlSaLC+RwonJ3hw/6/GDvD+TqgCHZSP6SIzRiZrCkq+ MSAP9EBt9SsBgoMBARGgA1dOqmlgaOP4ZLo+FGx38oGlgADfLBtjtt4H0/5cBDOWS+ Hifr34hkWunuA== From: Michael Tokarev To: qemu-devel@nongnu.org Cc: qemu-stable@nongnu.org, =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Michael Tokarev Subject: [Stable-10.1.5 28/46] io: separate freeing of tasks from marking them as complete Date: Wed, 11 Mar 2026 18:03:04 +0300 Message-ID: <20260311150327.1084669-28-mjt@tls.msk.ru> X-Mailer: git-send-email 2.47.3 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=212.248.84.144; envelope-from=mjt@tls.msk.ru; helo=isrv.corpit.ru X-Spam_score_int: -2 X-Spam_score: -0.3 X-Spam_bar: / X-Spam_report: (-0.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.819, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.903, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @tls.msk.ru) X-ZM-MESSAGEID: 1773242548935154100 From: Daniel P. Berrang=C3=A9 The original design of QIOTask was intended to simplify lifecycle management by automatically freeing it when the task was marked as complete. This overlooked the fact that when a QIOTask is used in combination with a GSource, there may be times when the source callback is never invoked. This is typically when a GSource is released before any I/O event arrives. In such cases it is not desirable to mark a QIOTask as complete, but it still needs to be freed. To satisfy this, the task must be released manually. Reviewed-by: Marc-Andr=C3=A9 Lureau Signed-off-by: Daniel P. Berrang=C3=A9 (cherry picked from commit 163cd0ae1182e67509b271f244a73dfd938337b9) Signed-off-by: Michael Tokarev diff --git a/include/io/task.h b/include/io/task.h index 0b5342ee84..98847f5994 100644 --- a/include/io/task.h +++ b/include/io/task.h @@ -96,7 +96,7 @@ typedef void (*QIOTaskWorker)(QIOTask *task, * 1000, * myobject_operation_timer, * task, - * NULL); + * qio_task_free); * } * * @@ -138,9 +138,8 @@ typedef void (*QIOTaskWorker)(QIOTask *task, * the callback func 'myobject_operation_notify' shown * earlier to deal with the results. * - * Once this function returns false, object_unref will be called - * automatically on the task causing it to be released and the - * ref on QMyObject dropped too. + * Once this function returns FALSE, the task will be freed, + * causing it release the ref on QMyObject too. * * The QIOTask module can also be used to perform operations * in a background thread context, while still reporting the @@ -208,8 +207,8 @@ typedef void (*QIOTaskWorker)(QIOTask *task, * 'err' attribute in the task object to determine if * the operation was successful or not. * - * The returned task will be released when qio_task_complete() - * is invoked. + * The returned task must be released by calling + * qio_task_free() when no longer required. * * Returns: the task struct */ @@ -218,6 +217,19 @@ QIOTask *qio_task_new(Object *source, gpointer opaque, GDestroyNotify destroy); =20 +/** + * qio_task_free: + * task: the task object to free + * + * Free the resources associated with the task. Typically + * the qio_task_complete() method will be called immediately + * before this to trigger the task callback, however, it is + * permissible to free the task in the case of cancellation. + * The destroy callback will be used to release the opaque + * data provided to qio_task_new(). + */ +void qio_task_free(QIOTask *task); + /** * qio_task_run_in_thread: * @task: the task struct @@ -268,8 +280,9 @@ void qio_task_wait_thread(QIOTask *task); * qio_task_complete: * @task: the task struct * - * Invoke the completion callback for @task and - * then free its memory. + * Invoke the completion callback for @task. This should typically + * only be invoked once on a task, and then qio_task_free() used + * to free it. */ void qio_task_complete(QIOTask *task); =20 diff --git a/io/channel-tls.c b/io/channel-tls.c index d1c6cf72b2..ce4ee6bb98 100644 --- a/io/channel-tls.c +++ b/io/channel-tls.c @@ -170,6 +170,7 @@ static void qio_channel_tls_handshake_task(QIOChannelTL= S *ioc, trace_qio_channel_tls_handshake_fail(ioc); qio_task_set_error(task, err); qio_task_complete(task); + qio_task_free(task); return; } =20 @@ -183,6 +184,7 @@ static void qio_channel_tls_handshake_task(QIOChannelTL= S *ioc, trace_qio_channel_tls_credentials_allow(ioc); } qio_task_complete(task); + qio_task_free(task); } else { GIOCondition condition; QIOChannelTLSData *data =3D g_new0(typeof(*data), 1); @@ -270,11 +272,13 @@ static void qio_channel_tls_bye_task(QIOChannelTLS *i= oc, QIOTask *task, trace_qio_channel_tls_bye_fail(ioc); qio_task_set_error(task, err); qio_task_complete(task); + qio_task_free(task); return; } =20 if (status =3D=3D QCRYPTO_TLS_BYE_COMPLETE) { qio_task_complete(task); + qio_task_free(task); return; } =20 diff --git a/io/channel-websock.c b/io/channel-websock.c index ec5e09f9ab..13975de4d8 100644 --- a/io/channel-websock.c +++ b/io/channel-websock.c @@ -545,6 +545,7 @@ static gboolean qio_channel_websock_handshake_send(QIOC= hannel *ioc, trace_qio_channel_websock_handshake_fail(ioc, error_get_pretty(err= )); qio_task_set_error(task, err); qio_task_complete(task); + qio_task_free(task); wioc->hs_io_tag =3D 0; return FALSE; } @@ -561,6 +562,7 @@ static gboolean qio_channel_websock_handshake_send(QIOC= hannel *ioc, trace_qio_channel_websock_handshake_complete(ioc); qio_task_complete(task); } + qio_task_free(task); wioc->hs_io_tag =3D 0; return FALSE; } @@ -588,6 +590,7 @@ static gboolean qio_channel_websock_handshake_io(QIOCha= nnel *ioc, trace_qio_channel_websock_handshake_fail(ioc, error_get_pretty(err= )); qio_task_set_error(task, err); qio_task_complete(task); + qio_task_free(task); wioc->hs_io_tag =3D 0; return FALSE; } diff --git a/io/task.c b/io/task.c index 451f26f8b4..331febd4e1 100644 --- a/io/task.c +++ b/io/task.c @@ -70,8 +70,12 @@ QIOTask *qio_task_new(Object *source, return task; } =20 -static void qio_task_free(QIOTask *task) +void qio_task_free(QIOTask *task) { + if (!task) { + return; + } + qemu_mutex_lock(&task->thread_lock); if (task->thread) { if (task->thread->destroy) { @@ -110,6 +114,7 @@ static gboolean qio_task_thread_result(gpointer opaque) =20 trace_qio_task_thread_result(task); qio_task_complete(task); + qio_task_free(task); =20 return FALSE; } @@ -196,7 +201,6 @@ void qio_task_complete(QIOTask *task) { task->func(task, task->opaque); trace_qio_task_complete(task); - qio_task_free(task); } =20 =20 diff --git a/tests/unit/test-io-task.c b/tests/unit/test-io-task.c index 115dba8970..b1c8ecb7ab 100644 --- a/tests/unit/test-io-task.c +++ b/tests/unit/test-io-task.c @@ -73,6 +73,7 @@ static void test_task_complete(void) src =3D qio_task_get_source(task); =20 qio_task_complete(task); + qio_task_free(task); =20 g_assert(obj =3D=3D src); =20 @@ -84,6 +85,28 @@ static void test_task_complete(void) } =20 =20 +static void test_task_cancel(void) +{ + QIOTask *task; + Object *obj =3D object_new(TYPE_DUMMY); + Object *src; + struct TestTaskData data =3D { NULL, NULL, false }; + + task =3D qio_task_new(obj, task_callback, &data, NULL); + src =3D qio_task_get_source(task); + + qio_task_free(task); + + g_assert(obj =3D=3D src); + + object_unref(obj); + + g_assert(data.source =3D=3D NULL); + g_assert(data.err =3D=3D NULL); + g_assert(data.freed =3D=3D false); +} + + static void task_data_free(gpointer opaque) { struct TestTaskData *data =3D opaque; @@ -101,6 +124,7 @@ static void test_task_data_free(void) task =3D qio_task_new(obj, task_callback, &data, task_data_free); =20 qio_task_complete(task); + qio_task_free(task); =20 object_unref(obj); =20 @@ -123,6 +147,7 @@ static void test_task_failure(void) =20 qio_task_set_error(task, err); qio_task_complete(task); + qio_task_free(task); =20 object_unref(obj); =20 @@ -260,6 +285,7 @@ int main(int argc, char **argv) module_call_init(MODULE_INIT_QOM); type_register_static(&dummy_info); g_test_add_func("/crypto/task/complete", test_task_complete); + g_test_add_func("/crypto/task/cancel", test_task_cancel); g_test_add_func("/crypto/task/datafree", test_task_data_free); g_test_add_func("/crypto/task/failure", test_task_failure); g_test_add_func("/crypto/task/thread_complete", test_task_thread_compl= ete); --=20 2.47.3