From patchwork Fri Jul 12 13:24:37 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= X-Patchwork-Id: 13731775 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 63241C2BD09 for ; Fri, 12 Jul 2024 13:25:33 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sSGGv-0001Gr-Ja; Fri, 12 Jul 2024 09:25:14 -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 1sSGGt-0001AT-Lq for qemu-devel@nongnu.org; Fri, 12 Jul 2024 09:25:11 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sSGGq-0003if-R7 for qemu-devel@nongnu.org; Fri, 12 Jul 2024 09:25:11 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720790707; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=7kQW+zbmzPtbJpIZ28hiYI3SnjnoVQpst4GbVNOp3WU=; b=bCidklPRfCkv0tdCsPeGUan89lRPtnsScdqkPxRtoeGMh0Iay0iCISbyXUSYUQcqnaoDZT 1jnSe+kCtr9DXpVAqFyDIufxqhjsu2rvJED+LLoVHLRJkLZ1ul+4FbRdxR7YHKHAOXK/Ln Aq9fV+VYYWt/upz+HNhhYMVsFKgUvvA= Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-683--1RwHkUUPlKb62VOrhGLZQ-1; Fri, 12 Jul 2024 09:25:06 -0400 X-MC-Unique: -1RwHkUUPlKb62VOrhGLZQ-1 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 397AC1954B0C; Fri, 12 Jul 2024 13:25:04 +0000 (UTC) Received: from toolbox.redhat.com (unknown [10.42.28.56]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E88A91955F40; Fri, 12 Jul 2024 13:25:00 +0000 (UTC) From: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: Thomas Huth , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Michael Roth , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , Konstantin Kostiuk Subject: [PATCH v3 00/22] qga: clean up command source locations and conditionals Date: Fri, 12 Jul 2024 14:24:37 +0100 Message-ID: <20240712132459.3974109-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 Received-SPF: pass client-ip=170.10.129.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.138, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org This series is a side effect of other work I started, to attempt to make the QGA safe to use in confidential VMs by automatically restricting the permitted commands. Since this cleanup stands on its own, I'm sending it now. The QGA codebase has a very complicated maze of #ifdefs to create stubs for the various commands that cannot be implemented on certain platforms. It then has further logic to dynamically disable the stub commands at runtime, except this is not consistently applied, so some commands remain enabled despite being merely stubs. The resulting code is hard to follow, when trying to understand exactly what commands are available under what circumstances, and when changing impls it is easy to get the #ifdefs wrong, resulting in stubs getting missed on platforms without a real impl. In some cases, we have multiple stubs for the same command, due to the maze of #ifdefs. The QAPI schema language has support for many years for expressing conditions against commands when declaring them. This results in the QAPI code generator omitting their implementation entirely at build time. This has mutliple benefits * The unsupported commands are guaranteed to not exist at runtime * No stubs need ever be defined in the code * The generated QAPI reference manual documents the build conditions This series is broadly split into three parts * Moving tonnes of Linux only commands out of commands-posix.c into commands-linux.c to remove many #ifdefs. * Adding 'if' conditions in the QAPI schema to reflect the build conditions, removing many more #ifdefs * Sanitizing the logic for disabling/enabling commands at runtime to guarantee consistency Changed in v3: - Fix missing --help output for new -c / --config arg - Fix typos - Avoid repeated qmp_command_is_enabled call Changed in v2: - Make FSFreeze error reporting distinguish inability to enable VSS from user config choice - Fully remove ga_command_init_blockedrpcs() methods. No more special case disabling of commands. Either they're disabled at build time, or disabled by user config, or by well defined rule ie not permitted during FS freeze. - Apply rules later in startup to avoid crash from NULL config pointer - Document changed error messages in commit messages - Add -c / --config command line parameter - Fix mistaken enabling of fsfreeze hooks on win32 Daniel P. Berrangé (22): qga: drop blocking of guest-get-memory-block-size command qga: move linux vcpu command impls to commands-linux.c qga: move linux suspend command impls to commands-linux.c qga: move linux fs/disk command impls to commands-linux.c qga: move linux disk/cpu stats command impls to commands-linux.c qga: move linux memory block command impls to commands-linux.c qga: move CONFIG_FSFREEZE/TRIM to be meson defined options qga: conditionalize schema for commands unsupported on Windows qga: conditionalize schema for commands unsupported on non-Linux POSIX qga: conditionalize schema for commands requiring getifaddrs qga: conditionalize schema for commands requiring linux/win32 qga: conditionalize schema for commands only supported on Windows qga: conditionalize schema for commands requiring fsfreeze qga: conditionalize schema for commands requiring fstrim qga: conditionalize schema for commands requiring libudev qga: conditionalize schema for commands requiring utmpx qga: conditionalize schema for commands not supported on other UNIX qga: don't disable fsfreeze commands if vss_init fails qga: move declare of QGAConfig struct to top of file qga: remove pointless 'blockrpcs_key' variable qga: allow configuration file path via the cli qga: centralize logic for disabling/enabling commands docs/interop/qemu-ga.rst | 19 + meson.build | 16 + qga/commands-bsd.c | 24 - qga/commands-common.h | 9 - qga/commands-linux.c | 1805 +++++++++++++++++++++++++++++ qga/commands-posix.c | 2373 +++----------------------------------- qga/commands-win32.c | 78 +- qga/main.c | 224 ++-- qga/qapi-schema.json | 153 ++- 9 files changed, 2240 insertions(+), 2461 deletions(-)