From patchwork Tue Sep 10 12:02:00 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Jackson X-Patchwork-Id: 11139331 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 54800112B for ; Tue, 10 Sep 2019 12:06:04 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (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 3044A2089F for ; Tue, 10 Sep 2019 12:06:04 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=citrix.com header.i=@citrix.com header.b="biNK/QN7" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3044A2089F Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=eu.citrix.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1i7esT-0007Su-Tr; Tue, 10 Sep 2019 12:04:09 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1i7esS-0007Sb-QG for xen-devel@lists.xenproject.org; Tue, 10 Sep 2019 12:04:08 +0000 X-Inumbo-ID: 16aa7b6f-d3c3-11e9-ac1c-12813bfff9fa Received: from esa3.hc3370-68.iphmx.com (unknown [216.71.145.155]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTPS id 16aa7b6f-d3c3-11e9-ac1c-12813bfff9fa; Tue, 10 Sep 2019 12:04:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1568117047; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version; bh=bSRcze2/xAPYtafYw9UG0/rO0XL6ABwnUfMOl7e3MGA=; b=biNK/QN7FurJLx/6n7ESy7EVtuLxzu6LCEdMqlnGWVOstqQiVCGlXNIh pEGizsH9Wu3H91a+pUWyDY+MW5PoMvDlp0LUX1ZAiGgktHo4DkMV7RuB6 leoWfwfRBfNn2I5N2DkgCTaKHLmUb1QGS1FSsGRnFjzJc2xqGKr14qXpk s=; Authentication-Results: esa3.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=ian.jackson@eu.citrix.com; spf=Pass smtp.mailfrom=Ian.Jackson@citrix.com; spf=None smtp.helo=postmaster@mail.citrix.com Received-SPF: None (esa3.hc3370-68.iphmx.com: no sender authenticity information available from domain of ian.jackson@eu.citrix.com) identity=pra; client-ip=162.221.158.21; receiver=esa3.hc3370-68.iphmx.com; envelope-from="Ian.Jackson@citrix.com"; x-sender="ian.jackson@eu.citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa3.hc3370-68.iphmx.com: domain of Ian.Jackson@citrix.com designates 162.221.158.21 as permitted sender) identity=mailfrom; client-ip=162.221.158.21; receiver=esa3.hc3370-68.iphmx.com; envelope-from="Ian.Jackson@citrix.com"; x-sender="Ian.Jackson@citrix.com"; x-conformance=sidf_compatible; x-record-type="v=spf1"; x-record-text="v=spf1 ip4:209.167.231.154 ip4:178.63.86.133 ip4:195.66.111.40/30 ip4:85.115.9.32/28 ip4:199.102.83.4 ip4:192.28.146.160 ip4:192.28.146.107 ip4:216.52.6.88 ip4:216.52.6.188 ip4:162.221.158.21 ip4:162.221.156.83 ~all" Received-SPF: None (esa3.hc3370-68.iphmx.com: no sender authenticity information available from domain of postmaster@mail.citrix.com) identity=helo; client-ip=162.221.158.21; receiver=esa3.hc3370-68.iphmx.com; envelope-from="Ian.Jackson@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: 9iPnHVN4wMgqeXdmmPCzRbQ154ssZF+Uvni1AUAWa6/03qOKUXGDzgxFQG9lv2aP2t8Z88TkQ5 IB9qu1so2t6y4JhZvpgnBIWFBFRdID/ajiUDrQAktuvxm8t0Z9iXy0M0b07CaFkAjfwpJXiIOy R997DiwmN97qK4gJXQr1BblWYqupzbc54p5PP1CTWnncboTMGnPodscE9reJVMtHMWL8AICD1M 5aVA1It2cb+8ZnSodzpVeUI/ec+W5/Keu30q9ZBVUWRIKYIo9dmiknCHYehxqCGbk3OzvVxOMY 3ow= X-SBRS: 2.7 X-MesageID: 5370543 X-Ironport-Server: esa3.hc3370-68.iphmx.com X-Remote-IP: 162.221.158.21 X-Policy: $RELAYED X-IronPort-AV: E=Sophos;i="5.64,489,1559534400"; d="scan'208";a="5370543" From: Ian Jackson To: Date: Tue, 10 Sep 2019 13:02:00 +0100 Message-ID: <20190910120207.10358-6-ian.jackson@eu.citrix.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20190910120207.10358-1-ian.jackson@eu.citrix.com> References: <20190910120207.10358-1-ian.jackson@eu.citrix.com> MIME-Version: 1.0 Subject: [Xen-devel] [PATCH v3 05/12] tools/ocaml: abi-check: Add comments X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: Andrew Cooper , Ian Jackson , Christian Lindig , Wei Liu , David Scott Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" Provide interface documentation for this script. Explain why we check .ml not .mli. Signed-off-by: Andrew Cooper Signed-off-by: Ian Jackson --- tools/ocaml/libs/xc/abi-check | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/tools/ocaml/libs/xc/abi-check b/tools/ocaml/libs/xc/abi-check index c987cd8454..ccc35e79e9 100755 --- a/tools/ocaml/libs/xc/abi-check +++ b/tools/ocaml/libs/xc/abi-check @@ -5,6 +5,13 @@ use Data::Dumper; our %enums; +# Usage: abi-check C-file Ocaml-file +# Writes out a BUILD_BUG_ON() list to be included back into C. +# +# Ocaml-file should be the .ml file. The ocaml compiler will check +# that any declarations in a .mli correspond. We check the .ml +# rather than the .mli in case there are private types in future. + @ARGV == 2 or die; our ($c, $o) = @ARGV; @@ -13,6 +20,14 @@ open STDIN, "<", $c or die $!; our $cline = -1; our $ei; +# Parse the C file looking for calls to: +# c_bitmap_to_ocaml_list() +# +# followed by anotations of the following form: +# /* ! OType OPrefix Mangle */ +# /* ! CPrefix CFinal CFinalHow */ +# +# The function definitions use /* ! */ which simply skips that instance. while (<>) { if ($cline == -1) { if (m/c_bitmap_to_ocaml_list/) {