From patchwork Thu Oct 4 17:33:40 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Roth X-Patchwork-Id: 189221 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id B05C62C03BD for ; Fri, 5 Oct 2012 03:55:04 +1000 (EST) Received: from localhost ([::1]:54544 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TJpJo-0007q5-8n for incoming@patchwork.ozlabs.org; Thu, 04 Oct 2012 13:34:40 -0400 Received: from eggs.gnu.org ([208.118.235.92]:49650) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TJpJc-0007cs-Ob for qemu-devel@nongnu.org; Thu, 04 Oct 2012 13:34:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TJpJZ-00012C-SY for qemu-devel@nongnu.org; Thu, 04 Oct 2012 13:34:28 -0400 Received: from mail-oa0-f45.google.com ([209.85.219.45]:46731) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TJpJZ-0000hT-Jl for qemu-devel@nongnu.org; Thu, 04 Oct 2012 13:34:25 -0400 Received: by mail-oa0-f45.google.com with SMTP id i18so707994oag.4 for ; Thu, 04 Oct 2012 10:34:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:cc:subject:date:message-id:x-mailer:in-reply-to :references; bh=ZQdY3kXmBlytm/2dCFlLqB9lbHVU0ufJ1tYoYE3irDQ=; b=N300EWatECn2SqFdauzYfHtIrzJXxVdC2P8o2oatq4YErIVvNideBMnPzasrrl6hdV BOxZlbC3FHNnYVhtUqelmGIG9VttUAqR4M1nl81qQ9ditwFMnk38iESSOPO2cSgQGVx1 59aVxm1LKV6w53y9/M/kny36rT3LYiGp5KADmarzdhqR6MZcpjZOUe7qPPV0vRZ74wV3 rREXmA3k78PPXw9QSTyiFeRssolvdmo8Trn5+OXIBOwaaxk1bwQJFkRXrlkkjC74KQST cPAoGBdbT6X+/B+nOKi1mnVx+IX5B0s1EX1NIcFNsiN4SdfFg2N8PBFcBchR39j+8i9u vmcQ== Received: by 10.60.28.162 with SMTP id c2mr5054839oeh.3.1349372065180; Thu, 04 Oct 2012 10:34:25 -0700 (PDT) Received: from loki.austin.ibm.com ([32.97.110.59]) by mx.google.com with ESMTPS id h2sm7131923obn.11.2012.10.04.10.34.23 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 04 Oct 2012 10:34:24 -0700 (PDT) From: Michael Roth To: qemu-devel@nongnu.org Date: Thu, 4 Oct 2012 12:33:40 -0500 Message-Id: <1349372021-31212-22-git-send-email-mdroth@linux.vnet.ibm.com> X-Mailer: git-send-email 1.7.9.5 In-Reply-To: <1349372021-31212-1-git-send-email-mdroth@linux.vnet.ibm.com> References: <1349372021-31212-1-git-send-email-mdroth@linux.vnet.ibm.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 209.85.219.45 Cc: kwolf@redhat.com, peter.maydell@linaro.org, aliguori@us.ibm.com, blauwirbel@gmail.com, pbonzini@redhat.com, eblake@redhat.com Subject: [Qemu-devel] [PATCH v3 21/22] qidl: qidl.h, definitions for qidl annotations X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Signed-off-by: Michael Roth --- qidl.h | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 qidl.h diff --git a/qidl.h b/qidl.h new file mode 100644 index 0000000..eae0202 --- /dev/null +++ b/qidl.h @@ -0,0 +1,113 @@ +/* + * QEMU IDL Macros/stubs + * + * See docs/qidl.txt for usage information. + * + * Copyright IBM, Corp. 2012 + * + * Authors: + * Michael Roth + * + * This work is licensed under the terms of the GNU GPLv2 or later. + * See the COPYING file in the top-level directory. + * + */ + +#ifndef QIDL_H +#define QIDL_H + +#include +#include "qapi/qapi-visit-core.h" +#include "qemu/object.h" +#include "hw/qdev-properties.h" + +#ifdef QIDL_GEN + +/* we pass the code through the preprocessor with QIDL_GEN defined to parse + * structures as they'd appear after preprocessing, and use the following + * definitions mostly to re-insert the initial macros/annotations so they + * stick around for the parser to process + */ +#define QIDL(...) QIDL(__VA_ARGS__) +#define QIDL_START(name, ...) QIDL_START(name, ##__VA_ARGS__) + +#define QIDL_VISIT_TYPE(name, v, s, f, e) +#define QIDL_SCHEMA_ADD_LINK(name, obj, path, errp) +#define QIDL_PROPERTIES(name) +#define QIDL_DECLARE(name, ...) \ + QIDL_START(name, ##__VA_ARGS__) \ + struct name + +#else /* !QIDL_GEN */ + +#define QIDL(...) +#ifdef QIDL_ENABLED +#define QIDL_START(name, ...) \ + static struct { \ + void (*visitor)(Visitor *, struct name **, const char *, Error **); \ + const char *schema_json_text; \ + Object *schema_obj; \ + Property *properties; \ + } qidl_data_##name; +#else +#define QIDL_START(name, ...) +#endif + +#define QIDL_DECLARE(name, ...) \ + QIDL_START(name, ##__VA_ARGS__) \ + struct name + +#define QIDL_VISIT_TYPE(name, v, s, f, e) \ + g_assert(qidl_data_##name.visitor); \ + qidl_data_##name.visitor(v, s, NULL, e) + +#define QIDL_SCHEMA_ADD_LINK(name, obj, path, errp) \ + g_assert(qidl_data_##name.schema_obj); \ + object_property_add_link(obj, path, "container", \ + &qidl_data_##name.schema_obj, errp) + +#define QIDL_PROPERTIES(name) \ + qidl_data_##name.properties + +#endif /* QIDL_GEN */ + +/* must be "called" in any C files that make use of QIDL-generated code */ +#define QIDL_ENABLE() + +/* QIDL annotations/markers + * + * q_immutable: state is fully restorable via device + * [re-]initialization/realization + * + * q_derived: state can be fully reconstructed from other fields (and will be, + * via [re-]initialization of the device or a separate hook) + * + * q_broken: state should (or possibly should) be saved, but isn't. mostly an aid + * for device developers having issues with serialization of a particular + * field, committed code should contain these except in special circumstances + * + * q_optional: should only be serialized if the field by the name of + * has_ is true + * + * q_elsewhere: state should be serialized, but is done so elsewhere (for + * instance, by another device with a pointer to the same data) + * + * q_size(field): for static/dynamically-allocated arrays. specifies the field + * in the structure containing the number of elements that should be + * serialized. if argument is wrapped in parenthesis it is instead interpreted + * as an expression that should be invaluated to determine the size. + * + * q_property( [, ]): specifies that field is a + * qdev-style property. all properties of the struct are then accessible via + * QIDL_PROPERTIES() macro. + */ + +#define q_immutable QIDL(immutable) +#define q_derived QIDL(derived) +#define q_broken QIDL(broken) +#define q_optional QIDL(optional) +#define q_elsewhere QIDL(elsewhere) +#define q_size(...) QIDL(size_is, ##__VA_ARGS__) +#define q_property(name, ...) QIDL(property, name, ##__VA_ARGS__) + +#endif