From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1C2F4C432BE for ; Thu, 12 Aug 2021 16:13:07 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 62BDA60C40 for ; Thu, 12 Aug 2021 16:13:06 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 62BDA60C40 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:43344 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mEDKL-000777-D2 for qemu-devel@archiver.kernel.org; Thu, 12 Aug 2021 12:13:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:40714) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mEDJ6-0005Av-Bd for qemu-devel@nongnu.org; Thu, 12 Aug 2021 12:11:48 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:47937) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mEDJ2-0001M5-KS for qemu-devel@nongnu.org; Thu, 12 Aug 2021 12:11:47 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1628784702; 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: in-reply-to:in-reply-to:references:references; bh=NTznk6WVjB6j4tC5d3KmZYtmFaLYYucUp8s3eIaVkXI=; b=HlzuMtmoIyF2567vz10MY839wxjpph8cKWKPeXikVWhihN6I/HvA+tiKfUC9lXEFlBlepi KqXOFV1vMypHsc9yj+vTYCo4Du72lAf7lEdyAejJ6Vn7JAxRb0cK0/05AOMpK0vOazqIxC irZaNY/6QQfXf3uA7OLI6yhCmkFmNsc= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-125--Ln3EkukMs2cl2_20iNdAg-1; Thu, 12 Aug 2021 12:11:41 -0400 X-MC-Unique: -Ln3EkukMs2cl2_20iNdAg-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1C4F11008061 for ; Thu, 12 Aug 2021 16:11:40 +0000 (UTC) Received: from merkur.fritz.box (unknown [10.39.194.67]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2BA355FC22; Thu, 12 Aug 2021 16:11:39 +0000 (UTC) From: Kevin Wolf To: qemu-devel@nongnu.org Subject: [PATCH v3 1/6] qapi: Add interfaces for alias support to Visitor Date: Thu, 12 Aug 2021 18:11:26 +0200 Message-Id: <20210812161131.92017-2-kwolf@redhat.com> In-Reply-To: <20210812161131.92017-1-kwolf@redhat.com> References: <20210812161131.92017-1-kwolf@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=kwolf@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" Received-SPF: pass client-ip=216.205.24.124; envelope-from=kwolf@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.701, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kwolf@redhat.com, jsnow@redhat.com, armbru@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" This adds functions to the Visitor interface that can be used to define aliases and alias scopes. Signed-off-by: Kevin Wolf --- include/qapi/visitor-impl.h | 12 ++++++++ include/qapi/visitor.h | 59 ++++++++++++++++++++++++++++++++++--- qapi/qapi-visit-core.c | 22 ++++++++++++++ 3 files changed, 89 insertions(+), 4 deletions(-) diff --git a/include/qapi/visitor-impl.h b/include/qapi/visitor-impl.h index 3b950f6e3d..704c5ad2d9 100644 --- a/include/qapi/visitor-impl.h +++ b/include/qapi/visitor-impl.h @@ -119,6 +119,18 @@ struct Visitor /* Optional */ bool (*deprecated)(Visitor *v, const char *name); + /* + * Optional; intended for input visitors. If not given, aliases are + * ignored. + */ + void (*define_alias)(Visitor *v, const char *name, const char **source); + + /* Must be set if define_alias is set */ + void (*start_alias_scope)(Visitor *v); + + /* Must be set if define_alias is set */ + void (*end_alias_scope)(Visitor *v); + /* Must be set */ VisitorType type; diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h index b3c9ef7a81..3bf0f4dad2 100644 --- a/include/qapi/visitor.h +++ b/include/qapi/visitor.h @@ -220,10 +220,17 @@ * * * This file provides helpers for use by the generated - * visit_type_FOO(): visit_optional() for the 'has_member' field - * associated with optional 'member' in the C struct, - * visit_next_list() for advancing through a FooList linked list, and - * visit_is_input() for cleaning up on failure. + * visit_type_FOO(): + * + * - visit_optional() for the 'has_member' field associated with + * optional 'member' in the C struct, + * - visit_next_list() for advancing through a FooList linked list + * - visit_is_input() for cleaning up on failure + * - visit_define_alias() for defining alternative names for object + * members in input visitors + * - visit_start/end_alias_scope() to limit the scope of aliases + * within a single input object (e.g. aliases defined in the base + * struct should not provide values for the parent struct) */ /*** Useful types ***/ @@ -477,6 +484,50 @@ bool visit_deprecated_accept(Visitor *v, const char *name, Error **errp); */ bool visit_deprecated(Visitor *v, const char *name); +/* + * Defines a new alias rule. + * + * If @name is non-NULL, the member called @name in the external + * representation of the currently visited object is defined as an + * alias for the member described by @source. It is not allowed to + * call this function when the currently visited type is not an + * object. + * + * If @name is NULL, all members of the object described by @source + * are considered to have alias members with the same key in the + * currently visited object. + * + * @source is a NULL-terminated non-empty array of names that describe + * the path to a member, starting from the currently visited object. + * All elements in @source except the last one should describe + * objects. If an intermediate element refers to a member with a + * non-object type, the alias won't work (this case can legitimately + * happen in unions where an alias only makes sense for one branch, + * but not for another). + * + * The alias stays valid until the current alias scope ends. + * visit_start/end_struct() implicitly start/end an alias scope. + * Additionally, visit_start/end_alias_scope() can be used to explicitly + * create a nested alias scope. + */ +void visit_define_alias(Visitor *v, const char *name, const char **source); + +/* + * Begins an explicit alias scope. + * + * Alias definitions after here will only stay valid until the + * corresponding visit_end_alias_scope() is called. + */ +void visit_start_alias_scope(Visitor *v); + +/* + * Ends an explicit alias scope. + * + * Alias definitions between the correspoding visit_start_alias_scope() + * call and here go out of scope and won't apply in later code any more. + */ +void visit_end_alias_scope(Visitor *v); + /* * Visit an enum value. * diff --git a/qapi/qapi-visit-core.c b/qapi/qapi-visit-core.c index a641adec51..79df6901ae 100644 --- a/qapi/qapi-visit-core.c +++ b/qapi/qapi-visit-core.c @@ -153,6 +153,28 @@ bool visit_deprecated(Visitor *v, const char *name) return true; } +void visit_define_alias(Visitor *v, const char *name, const char **source) +{ + assert(source[0] != NULL); + if (v->define_alias) { + v->define_alias(v, name, source); + } +} + +void visit_start_alias_scope(Visitor *v) +{ + if (v->start_alias_scope) { + v->start_alias_scope(v); + } +} + +void visit_end_alias_scope(Visitor *v) +{ + if (v->end_alias_scope) { + v->end_alias_scope(v); + } +} + bool visit_is_input(Visitor *v) { return v->type == VISITOR_INPUT; -- 2.31.1