From nobody Tue Feb 10 04:17:37 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; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1661520844; cv=none; d=zohomail.com; s=zohoarc; b=mSVNut/DB24GGzZ3znffaig6LIjLjY75ueF6HEnkyyNPd5ngNjwWO6aL40d0y1clG16XMs2ix42791A/wbDQ2WPfsWXweqFNz4ric5IYsumQjhc5kzPBzquAk/4myi4oB6juLp7ubLKbaTmLaK/hdSRRsNDgzXbPBePyLnTsRl4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1661520844; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=R7E7FE+LhZ+NHyRNMywoPpolP8FJ9rrZkHKcD5djleQ=; b=ODWOdBS5Wx4KpW7DGrDu5ASb/rQoSHGmTg1EI48U1K+7eS+RRbVVopcaEbf044+rgo/2z36Dx19ZiyEsHpCzZJ30sn7aYcmoshYcD4DtdK+/l11WoIt9un6r1t+M0qQXAy04wbE72ffNJOyQA398G1tboZY3zFmICJdQhV7VvDA= 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; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1661520844902891.7988506687376; Fri, 26 Aug 2022 06:34:04 -0700 (PDT) Received: from localhost ([::1]:55100 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oRZTG-0005Qv-Uw for importer@patchew.org; Fri, 26 Aug 2022 09:34:02 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:55868) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oRZH8-00013I-Cp for qemu-devel@nongnu.org; Fri, 26 Aug 2022 09:21:30 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:25261) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oRZGx-0003zY-1S for qemu-devel@nongnu.org; Fri, 26 Aug 2022 09:21:30 -0400 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-43-Aa1JaN8POLuNP-mbmiEr-A-1; Fri, 26 Aug 2022 09:21:14 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4E90A185A794; Fri, 26 Aug 2022 13:21:14 +0000 (UTC) Received: from virtlab701.virt.lab.eng.bos.redhat.com (virtlab701.virt.lab.eng.bos.redhat.com [10.19.152.228]) by smtp.corp.redhat.com (Postfix) with ESMTP id F2389492C3B; Fri, 26 Aug 2022 13:21:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1661520078; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=R7E7FE+LhZ+NHyRNMywoPpolP8FJ9rrZkHKcD5djleQ=; b=cCN07UJJbLG0iMlp7EKJ4geBjy1HsYcD4dchN05xOO5pvzk6NMjRbcaMs6mK5zuHWm76F8 uY0Ae+cuwoagmn55q5KLoGvW3jJyg3Vl1vANGx0J7V3kN3GcluOBhmLT6XETERBMW5GfsF 10SK+c5UtmD9g5CaIRGHRZgbxDiZMmY= X-MC-Unique: Aa1JaN8POLuNP-mbmiEr-A-1 From: Emanuele Giuseppe Esposito To: qemu-block@nongnu.org Cc: Kevin Wolf , Hanna Reitz , Paolo Bonzini , John Snow , Vladimir Sementsov-Ogievskiy , Wen Congyang , Xie Changlong , Markus Armbruster , Stefan Hajnoczi , Fam Zheng , qemu-devel@nongnu.org, Emanuele Giuseppe Esposito Subject: [PATCH v11 17/21] job.h: categorize JobDriver callbacks that need the AioContext lock Date: Fri, 26 Aug 2022 09:21:00 -0400 Message-Id: <20220826132104.3678958-18-eesposit@redhat.com> In-Reply-To: <20220826132104.3678958-1-eesposit@redhat.com> References: <20220826132104.3678958-1-eesposit@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 2.85 on 10.11.54.10 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=170.10.129.124; envelope-from=eesposit@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1661520846590100001 Content-Type: text/plain; charset="utf-8" Some callbacks implementation use bdrv_* APIs that assume the AioContext lock is held. Make sure this invariant is documented. Signed-off-by: Emanuele Giuseppe Esposito Reviewed-by: Vladimir Sementsov-Ogievskiy --- include/qemu/job.h | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/include/qemu/job.h b/include/qemu/job.h index cede227e67..b24aa89737 100644 --- a/include/qemu/job.h +++ b/include/qemu/job.h @@ -65,7 +65,11 @@ typedef struct Job { /** True if this job should automatically dismiss itself */ bool auto_dismiss; =20 - /** The completion function that will be called when the job completes= . */ + /** + * The completion function that will be called when the job completes. + * Called with AioContext lock held, since many callback implementatio= ns + * use bdrv_* functions that require to hold the lock. + */ BlockCompletionFunc *cb; =20 /** The opaque value that is passed to the completion function. */ @@ -260,6 +264,9 @@ struct JobDriver { * * This callback will not be invoked if the job has already failed. * If it fails, abort and then clean will be called. + * + * Called with AioContext lock held, since many callbacs implementatio= ns + * use bdrv_* functions that require to hold the lock. */ int (*prepare)(Job *job); =20 @@ -270,6 +277,9 @@ struct JobDriver { * * All jobs will complete with a call to either .commit() or .abort() = but * never both. + * + * Called with AioContext lock held, since many callback implementatio= ns + * use bdrv_* functions that require to hold the lock. */ void (*commit)(Job *job); =20 @@ -280,6 +290,9 @@ struct JobDriver { * * All jobs will complete with a call to either .commit() or .abort() = but * never both. + * + * Called with AioContext lock held, since many callback implementatio= ns + * use bdrv_* functions that require to hold the lock. */ void (*abort)(Job *job); =20 @@ -288,6 +301,9 @@ struct JobDriver { * .commit() or .abort(). Regardless of which callback is invoked after * completion, .clean() will always be called, even if the job does not * belong to a transaction group. + * + * Called with AioContext lock held, since many callbacs implementatio= ns + * use bdrv_* functions that require to hold the lock. */ void (*clean)(Job *job); =20 @@ -302,11 +318,18 @@ struct JobDriver { * READY). * (If the callback is NULL, the job is assumed to terminate * without I/O.) + * + * Called with AioContext lock held, since many callback implementatio= ns + * use bdrv_* functions that require to hold the lock. */ bool (*cancel)(Job *job, bool force); =20 =20 - /** Called when the job is freed */ + /** + * Called when the job is freed. + * Called with AioContext lock held, since many callback implementatio= ns + * use bdrv_* functions that require to hold the lock. + */ void (*free)(Job *job); }; =20 --=20 2.31.1