From patchwork Fri Jan 10 10:49:38 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Victor Toso X-Patchwork-Id: 13934242 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 4B7FCE77188 for ; Fri, 10 Jan 2025 10:51:41 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tWCaT-0004xj-Ee; Fri, 10 Jan 2025 05:49:57 -0500 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 1tWCaS-0004xU-8h for qemu-devel@nongnu.org; Fri, 10 Jan 2025 05:49:56 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tWCaQ-00013L-Mq for qemu-devel@nongnu.org; Fri, 10 Jan 2025 05:49:56 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1736506193; 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; bh=B9m4DpPPDTkVx5Qy27W1IdWtpdnCjcQJQIq9y+H5Yto=; b=PWS9DChNLMKtJBKWTFX750Qz8uZu0TkboZpDSTR+dYhvq4o/5f+ya/HPxZh7z5lEaZByfN CqXXgP4Qw7eLLoIjMKf2sdQrIUnsjDscrpXLSjjfjVOpl7AZ0Xnigyb73x5sku0Yei5oc9 zJIEyIBoinM71cIuBKrfYk8xk7wnKzE= Received: from mx-prod-mc-04.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-278-LWdsd5CQMIC5lJ5Vvio9Fg-1; Fri, 10 Jan 2025 05:49:51 -0500 X-MC-Unique: LWdsd5CQMIC5lJ5Vvio9Fg-1 X-Mimecast-MFC-AGG-ID: LWdsd5CQMIC5lJ5Vvio9Fg 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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 7F52A1955DCC for ; Fri, 10 Jan 2025 10:49:50 +0000 (UTC) Received: from tapioca.redhat.com (unknown [10.45.225.126]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A36EF1954B24; Fri, 10 Jan 2025 10:49:47 +0000 (UTC) From: Victor Toso To: qemu-devel@nongnu.org Cc: Markus Armbruster , John Snow , =?utf-8?q?Daniel_P_=2E_Berrang=C3=A9?= , Andrea Bolognani Subject: [PATCH v3 0/8] qapi-go: add generator for Golang interfaces Date: Fri, 10 Jan 2025 11:49:38 +0100 Message-ID: <20250110104946.74960-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 Received-SPF: pass client-ip=170.10.133.124; envelope-from=victortoso@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -24 X-Spam_score: -2.5 X-Spam_bar: -- X-Spam_report: (-2.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.436, 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_H2=-0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=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 patch series intent is to introduce a generator that produces a Go module for Go applications to interact over QMP with QEMU. The initial Goal is to have a Go module that works as intended and can be improved upon. I'd consider initial releases to be alpha while we work with utilities tools and libraries on top of this. The generated code should reside in a separated Git repository, similar to python-qemu-qmp. Applications should be able to consume this under qemu.org namespace (e.g: import "qemu.org/go/qemu"), see Daniel's suggestion: https://lists.gnu.org/archive/html/qemu-devel/2023-09/msg07024.html This is the third iteration: v2: https://lists.gnu.org/archive/html/qemu-devel/2023-10/msg04785.html I've pushed this series in my gitlab fork: https://gitlab.com/victortoso/qapi-go/ The fork contains some tests, including tests that were generated from QAPI's own examples from another generator created for testing, if you are interested in it: https://lists.gnu.org/archive/html/qemu-devel/2023-09/msg04946.html I've generated the qapi-go module over each commit of this series, see: https://gitlab.com/victortoso/qapi-go/-/commits/qapi-golang-v3-by-patch I've also generated the qapi-go module over QEMU tags: v9.1.0, v9.2.0: https://gitlab.com/victortoso/qapi-go/-/commits/qapi-golang-v3-by-tags --- Sorry that its been awhile between v2 and v3, I had to prioritize other things. I hope to get this back on track in 2025. Cheers, Victor * Changes: On generated go: - the output should be formatted as gofmt/goimports tools (Daniel) - Included QAPI's documentation too (Daniel), see: https://lists.gnu.org/archive/html/qemu-devel/2024-11/msg01621.html - Commands and Events should Marshal directly (Andrea) On python script: - rebased: now uses QAPISchemaBranches, QAPISchemaAlternatives - use textwrap as much as possible (Andrea) - lots of changes to make the output like gofmt does Victor Toso (8): qapi: golang: Generate enum type qapi: golang: Generate alternate types qapi: golang: Generate struct types qapi: golang: structs: Address nullable members qapi: golang: Generate union type qapi: golang: Generate event type qapi: golang: Generate command type docs: add notes on Golang code generator docs/devel/index-build.rst | 1 + docs/devel/qapi-golang-code-gen.rst | 548 +++++++++ scripts/qapi/golang.py | 1645 +++++++++++++++++++++++++++ scripts/qapi/main.py | 3 + 4 files changed, 2197 insertions(+) create mode 100644 docs/devel/qapi-golang-code-gen.rst create mode 100644 scripts/qapi/golang.py