From patchwork Mon Sep 9 17:12:06 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ian Jackson X-Patchwork-Id: 11138299 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 51B621395 for ; Mon, 9 Sep 2019 17:14:39 +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 227692089F for ; Mon, 9 Sep 2019 17:14:39 +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="F9mna6WP" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 227692089F 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 1i7NE3-0007v5-9t; Mon, 09 Sep 2019 17:13:15 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1i7NE1-0007uh-Kc for xen-devel@lists.xenproject.org; Mon, 09 Sep 2019 17:13:13 +0000 X-Inumbo-ID: 1a729180-d325-11e9-978d-bc764e2007e4 Received: from esa1.hc3370-68.iphmx.com (unknown [216.71.145.142]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id 1a729180-d325-11e9-978d-bc764e2007e4; Mon, 09 Sep 2019 17:13:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1568049193; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version; bh=RexG8BU5FSOE8clmrP1waELHqzuOyqhzkXqTPPj+cu4=; b=F9mna6WPYqs9TGbFaoj33scHNQenZEY7A8egkS52BPVI6/toaSDlylB8 MGAGEaR/Oi5ToLNbxSQQJE+etfGw/yaCKc78rY0rTlq7Vv1Zzh790yIdX pODbamaeeYZCDbqwmPu7LtxGCil8Sn4+eYORhytocnoxa0sgKdE3MhpcN Y=; Authentication-Results: esa1.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 (esa1.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=esa1.hc3370-68.iphmx.com; envelope-from="Ian.Jackson@citrix.com"; x-sender="ian.jackson@eu.citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa1.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=esa1.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 (esa1.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=esa1.hc3370-68.iphmx.com; envelope-from="Ian.Jackson@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: pu7M8ZWeiAJI+foKqAHgXdGDSQqLQvyXLZpdS1+Uz4BPy+815XbCnaW16TdXQOVUHSzWvfQSxi 17CW9xBNxQa1J00NNenMkUq4hfGZC5NbGnFZ/bUXzZ9DhdAsmDnA8xpGn3yNS0jcC3qYXLt9jX Bof+Z+dfK6OsbVnRU5TXGtv+WUEQW1isWMYInrv/4XmmsAf775TeMrKR5jYGcCro3sEGaO7H4L rlYm79CDuq9NchuCTowZBdt5+eb/D4HZYjoGXvFORdXsYyATLVVVMuN8Sbnmz2i5/eumH9bb2q XW8= X-SBRS: 2.7 X-MesageID: 5380502 X-Ironport-Server: esa1.hc3370-68.iphmx.com X-Remote-IP: 162.221.158.21 X-Policy: $RELAYED X-IronPort-AV: E=Sophos;i="5.64,486,1559534400"; d="scan'208";a="5380502" From: Ian Jackson To: Date: Mon, 9 Sep 2019 18:12:06 +0100 Message-ID: <20190909171206.25585-3-ian.jackson@eu.citrix.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20190909171206.25585-1-ian.jackson@eu.citrix.com> References: <20190909171206.25585-1-ian.jackson@eu.citrix.com> MIME-Version: 1.0 Subject: [Xen-devel] [PATCH 3/3] tools/ocaml: Introduce xenctrl ABI build-time checks 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: Stefano Stabellini , Wei Liu , Konrad Rzeszutek Wilk , George Dunlap , Tim Deegan , Ian Jackson , Julien Grall , Andrew Cooper , Christian Lindig , Jan Beulich , David Scott Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" c/s f089fddd941 broke the Ocaml ABI by renumering XEN_SYSCTL_PHYSCAP_directio without adjusting the Ocaml physinfo_cap_flag enumeration. Add build machinery which will check the ABI correspondence. This will result in a compile time failure whenever constants get renumbered/added without a compatible adjustment to the Ocaml ABI. Signed-off-by: Andrew Cooper Signed-off-by: Ian Jackson Acked-by: Christian Lindig --- v2: Script with ad-hoc parsers rather than handwritten BUILD_BUG_ON list (which was out of date even in v1 of this patch!) --- .gitignore | 1 + tools/ocaml/libs/xc/Makefile | 5 +++ tools/ocaml/libs/xc/abi-check | 84 +++++++++++++++++++++++++++++++++++++ tools/ocaml/libs/xc/xenctrl_stubs.c | 69 +++++++++++++++++++++--------- xen/include/public/sysctl.h | 4 ++ 5 files changed, 143 insertions(+), 20 deletions(-) create mode 100755 tools/ocaml/libs/xc/abi-check diff --git a/.gitignore b/.gitignore index 3c947ac948..3ada0c4f0b 100644 --- a/.gitignore +++ b/.gitignore @@ -392,6 +392,7 @@ tools/ocaml/libs/xentoollog/_xtl_levels.* tools/ocaml/libs/xentoollog/xentoollog.ml tools/ocaml/libs/xentoollog/xentoollog.mli tools/ocaml/libs/xs/paths.ml +tools/ocaml/libs/xc/xenctrl_abi_check.h tools/ocaml/xenstored/_paths.h tools/ocaml/xenstored/oxenstored tools/ocaml/xenstored/oxenstored.conf diff --git a/tools/ocaml/libs/xc/Makefile b/tools/ocaml/libs/xc/Makefile index d24b0144d0..ac780627d2 100644 --- a/tools/ocaml/libs/xc/Makefile +++ b/tools/ocaml/libs/xc/Makefile @@ -31,4 +31,9 @@ install: $(LIBS) META uninstall: $(OCAMLFIND) remove -destdir $(OCAMLDESTDIR) xenctrl +xenctrl_stubs.o: xenctrl_abi_check.h + +xenctrl_abi_check.h: abi-check xenctrl_stubs.c xenctrl.ml + $(PERL) -w $^ >$@.tmp && mv -f $@.tmp $@ + include $(TOPLEVEL)/Makefile.rules diff --git a/tools/ocaml/libs/xc/abi-check b/tools/ocaml/libs/xc/abi-check new file mode 100755 index 0000000000..c987cd8454 --- /dev/null +++ b/tools/ocaml/libs/xc/abi-check @@ -0,0 +1,84 @@ +#!/usr/bin/perl -w + +use strict; +use Data::Dumper; + +our %enums; + +@ARGV == 2 or die; +our ($c, $o) = @ARGV; + +open STDIN, "<", $c or die $!; + +our $cline = -1; +our $ei; + +while (<>) { + if ($cline == -1) { + if (m/c_bitmap_to_ocaml_list/) { + $cline = 0; + $ei = { }; + } + } else { + $cline++; + m{^\s+/\* \s+ ! \s+ (.*?) \s* \*/\s*$}x or die "$cline $_ ?"; + my @vals = split /\s+/, $1; + if ($cline == 1 && !@vals) { + $cline = -1; + } elsif ($cline == 1 && @vals == 3) { + $ei->{$_} = shift @vals foreach qw(OType OPrefix Mangle); + } elsif ($cline == 2 && @vals == 3) { + $ei->{$_} = shift @vals foreach qw(CPrefix CFinal CFinalHow); + die if $enums{ $ei->{OType} }; + $enums{ $ei->{OType} } = $ei; + $cline = -1; + } else { + die "$_ ?"; + } + } +} + +sub expect ($$) { + printf "BUILD_BUG_ON( %-30s != %-10s );\n", @_ or die $!; +} + +open STDIN, "<", $o or die $!; +my $cval; +$ei = undef; +my $bitnum = 0; +while (<>) { + if (!$ei) { + if (m{^type \s+ (\w+) \s* \= \s* $/}x && $enums{$1}) { + $ei = $enums{$1}; + $cval = ''; + $bitnum = 0; + } + } else { + if (m{^\s+ \| \s* $ei->{OPrefix} (\w+) \s*$}x) { + $cval = $1; + if ($ei->{Mangle} eq 'lc') { + $cval = lc $cval; + } elsif ($ei->{Mangle} eq 'none') { + } else { + die; + } + $cval = $ei->{CPrefix}.$cval; + expect($cval, "(1u << $bitnum)"); + $bitnum++; + } elsif (m/^\w|\{/) { + if ($ei->{CFinalHow} eq 'max') { + expect($ei->{CFinal}, "(1u << ".($bitnum-1).")"); + } elsif ($ei->{CFinalHow} eq 'all') { + expect($ei->{CFinal}, "(1u << $bitnum)-1u"); + } else { + die Dumper($ei)." ?"; + } + $ei = undef; + } elsif (!m{\S}) { + } else { + die "$_ ?"; + } + } +} + +close STDOUT or die $!; diff --git a/tools/ocaml/libs/xc/xenctrl_stubs.c b/tools/ocaml/libs/xc/xenctrl_stubs.c index 2e1b29ce33..352a6bd2d6 100644 --- a/tools/ocaml/libs/xc/xenctrl_stubs.c +++ b/tools/ocaml/libs/xc/xenctrl_stubs.c @@ -32,6 +32,7 @@ #define XC_WANT_COMPAT_MAP_FOREIGN_API #include +#include #include "mmap_stubs.h" @@ -119,6 +120,39 @@ static void domain_handle_of_uuid_string(xen_domain_handle_t h, #undef X } +/* + * Various fields which are a bitmap in the C ABI are converted to lists of + * integers in the Ocaml ABI for more idiomatic handling. + */ +static value c_bitmap_to_ocaml_list + /* ! */ + /* + * All calls to this function must be in a form suitable + * for xenctrl_abi_check. The parsing there is ad-hoc. + */ + (unsigned int bitmap) +{ + CAMLparam0(); + CAMLlocal2(list, tmp); + +#include "xenctrl_abi_check.h" + + list = tmp = Val_emptylist; + + for ( unsigned int i = 0; bitmap; i++, bitmap >>= 1 ) + { + if ( !(bitmap & 1) ) + continue; + + tmp = caml_alloc_small(2, Tag_cons); + Field(tmp, 0) = Val_int(i); + Field(tmp, 1) = list; + list = tmp; + } + + CAMLreturn(list); +} + CAMLprim value stub_xc_domain_create(value xch, value config) { CAMLparam2(xch, config); @@ -315,16 +349,13 @@ static value alloc_domaininfo(xc_domaininfo_t * info) Store_field(result, 15, tmp); #if defined(__i386__) || defined(__x86_64__) - /* emulation_flags: x86_arch_emulation_flags list; */ - tmp = emul_list = Val_emptylist; - for (i = 0; i < 10; i++) { - if ((info->arch_config.emulation_flags >> i) & 1) { - tmp = caml_alloc_small(2, Tag_cons); - Field(tmp, 0) = Val_int(i); - Field(tmp, 1) = emul_list; - emul_list = tmp; - } - } + /* + * emulation_flags: x86_arch_emulation_flags list; + */ + emul_list = c_bitmap_to_ocaml_list + /* ! x86_arch_emulation_flags X86_EMU_ none */ + /* ! XEN_X86_EMU_ XEN_X86_EMU_ALL all */ + (info->arch_config.emulation_flags); /* xen_x86_arch_domainconfig */ x86_arch_config = caml_alloc_tuple(1); @@ -635,7 +666,7 @@ CAMLprim value stub_xc_send_debug_keys(value xch, value keys) CAMLprim value stub_xc_physinfo(value xch) { CAMLparam1(xch); - CAMLlocal3(physinfo, cap_list, tmp); + CAMLlocal2(physinfo, cap_list); xc_physinfo_t c_physinfo; int r; @@ -646,15 +677,13 @@ CAMLprim value stub_xc_physinfo(value xch) if (r) failwith_xc(_H(xch)); - tmp = cap_list = Val_emptylist; - for (r = 0; r < 2; r++) { - if ((c_physinfo.capabilities >> r) & 1) { - tmp = caml_alloc_small(2, Tag_cons); - Field(tmp, 0) = Val_int(r); - Field(tmp, 1) = cap_list; - cap_list = tmp; - } - } + /* + * capabilities: physinfo_cap_flag list; + */ + cap_list = c_bitmap_to_ocaml_list + /* ! physinfo_cap_flag CAP_ lc */ + /* ! XEN_SYSCTL_PHYSCAP_ XEN_SYSCTL_PHYSCAP_MAX max */ + (c_physinfo.capabilities); physinfo = caml_alloc_tuple(10); Store_field(physinfo, 0, Val_int(c_physinfo.threads_per_core)); diff --git a/xen/include/public/sysctl.h b/xen/include/public/sysctl.h index 36b3f8c429..5401f9c2fe 100644 --- a/xen/include/public/sysctl.h +++ b/xen/include/public/sysctl.h @@ -90,6 +90,10 @@ struct xen_sysctl_tbuf_op { /* The platform supports direct access to I/O devices with IOMMU. */ #define _XEN_SYSCTL_PHYSCAP_directio 2 #define XEN_SYSCTL_PHYSCAP_directio (1u<<_XEN_SYSCTL_PHYSCAP_directio) + +/* Max XEN_SYSCTL_PHYSCAP_* constant. Used for ABI checking. */ +#define XEN_SYSCTL_PHYSCAP_MAX XEN_SYSCTL_PHYSCAP_directio + struct xen_sysctl_physinfo { uint32_t threads_per_core; uint32_t cores_per_socket;