From nobody Fri Apr 26 05:59:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org ARC-Seal: i=1; a=rsa-sha256; t=1568036687; cv=none; d=zoho.com; s=zohoarc; b=Y9B3wGyxrRN6hDkzZHwC2Od4Cq4Z0vdPem7FbmWrRSdepMzQsvez7aFQtY8GyCo/rqgHCR+SM4E8Z3c9W1zfpgGhRrfl2ETpcXuWtHzSymryA72pAUfCSOdKFYVpQUNJj5cp+4r8HVFfJ0CBjfW3k/9+ks4vrpTt4DBvnhKd3tQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1568036687; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=xe8otj0imbELjaZat5ZTWOTNJsb2AFraAIGJgVUn8o4=; b=FggRI1kCc1kR1PByP6ZOhlZTmCnZ3bC696WdDE+V5Msp89XePozyZiaVuVvopZGl12D4NTpp2BtVOvm5JesWUN+FWDB7+4ENCXi6p76Gb9DcMCy+LVr9IaQ9zJK6tLbUfEU07UOzUBCyRrepPG45DLueSUN86oZpxHnXlJYNh0M= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1568036687524198.35825657403336; Mon, 9 Sep 2019 06:44:47 -0700 (PDT) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1i7JxF-000559-3i; Mon, 09 Sep 2019 13:43:41 +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 1i7JxD-000552-Hl for xen-devel@lists.xenproject.org; Mon, 09 Sep 2019 13:43:39 +0000 Received: from esa3.hc3370-68.iphmx.com (unknown [216.71.145.155]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTPS id d32f44de-d307-11e9-ac0b-12813bfff9fa; Mon, 09 Sep 2019 13:43:37 +0000 (UTC) X-Inumbo-ID: d32f44de-d307-11e9-ac0b-12813bfff9fa DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1568036618; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=YAZ4775fBadIlBfI5JqH7rk7PZPNkVMwoLJpEBsCQ6w=; b=PEIamQaSscMXcZUul/LwmgQu1AWEPN9uodJxdirtxmvIF9DtvIvkU/kJ hPnLw9anTQemiB88b6D4hJCwc2pzxBQWVrrfOtTYhf6jJ3UCCxmzbfTzL 3NfJ85EBq155YHaWMpPVYu3ON5g3TrMWQxHsVzssqplpCTqCD2+QmPVVb o=; Authentication-Results: esa3.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=andrew.cooper3@citrix.com; spf=Pass smtp.mailfrom=Andrew.Cooper3@citrix.com; spf=None smtp.helo=postmaster@mail.citrix.com Received-SPF: none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Received-SPF: None (esa3.hc3370-68.iphmx.com: no sender authenticity information available from domain of andrew.cooper3@citrix.com) identity=pra; client-ip=162.221.158.21; receiver=esa3.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="andrew.cooper3@citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa3.hc3370-68.iphmx.com: domain of Andrew.Cooper3@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="Andrew.Cooper3@citrix.com"; x-sender="Andrew.Cooper3@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="Andrew.Cooper3@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: tGFVU+aAkkSXmXYTAdfU0WoI5LMYF4awI2DfQa6F2q839fCHkw3eekZqXg2lXMc4HnAI/4VeEr Ae9WTXER4hTi/t1TEChEPElsF3hU6EYakuK2k1RM2kQChY335W0sG2NBkDPuE7U6vqMTucUKfY rOPibIwoHf8fRlqRmyn5whPyDUCwdz6Ojrok7RlMj4f+Y0tV9CUhqKGPQdrddmvfWi5nOL+U7F 2T2cCJdSDJ9LZdD7lQSgagCTynyctFU38bqlr87oL6TvIUGLZybcgXPD0/GuOGMmIswPNCjARW xsw= X-SBRS: 2.7 X-MesageID: 5320671 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,484,1559534400"; d="scan'208";a="5320671" From: Andrew Cooper To: Xen-devel Date: Mon, 9 Sep 2019 14:43:33 +0100 Message-ID: <20190909134333.10927-1-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.11.0 MIME-Version: 1.0 Subject: [Xen-devel] [PATCH v2] tools/ocaml: Fix xenctrl ABI and introduce 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: Wei Liu , Andrew Cooper , Rob Hoes , =?UTF-8?q?Edwin=20T=C3=B6r=C3=B6k?= , Christian Lindig , Ian Jackson , =?UTF-8?q?Roger=20Pau=20Monn=C3=A9?= Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) c/s f089fddd941 broke the Ocaml ABI by renumering XEN_SYSCTL_PHYSCAP_direct= io without adjusting the Ocaml physinfo_cap_flag enumeration. Fix this by inserting CAP_PV between CAP_HVM and CAP_DirectIO. Factor out the bitmap-to-list conversion logic into a helper, to avoid an opencoded truncation of the bitmap. To cover this, add BUILD_BUG_ON()'s at the caller for each constant in the C-to-Ocaml conversion, and for the the applicable max/all constant. 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 --- CC: Ian Jackson CC: Wei Liu CC: Roger Pau Monn=C3=A9 CC: Christian Lindig CC: Rob Hoes CC: Edwin T=C3=B6r=C3=B6k This needs backporting to Xen 4.12 v2: * Base this patch correctly. --- tools/ocaml/libs/xc/xenctrl.ml | 1 + tools/ocaml/libs/xc/xenctrl.mli | 5 ++- tools/ocaml/libs/xc/xenctrl_stubs.c | 77 +++++++++++++++++++++++++++------= ---- xen/include/public/sysctl.h | 4 ++ 4 files changed, 66 insertions(+), 21 deletions(-) diff --git a/tools/ocaml/libs/xc/xenctrl.ml b/tools/ocaml/libs/xc/xenctrl.ml index 35958b94d5..cd7e95a6fa 100644 --- a/tools/ocaml/libs/xc/xenctrl.ml +++ b/tools/ocaml/libs/xc/xenctrl.ml @@ -99,6 +99,7 @@ type sched_control =3D =20 type physinfo_cap_flag =3D | CAP_HVM + | CAP_PV | CAP_DirectIO =20 type physinfo =3D diff --git a/tools/ocaml/libs/xc/xenctrl.mli b/tools/ocaml/libs/xc/xenctrl.= mli index 6c4268d453..0bd06ed920 100644 --- a/tools/ocaml/libs/xc/xenctrl.mli +++ b/tools/ocaml/libs/xc/xenctrl.mli @@ -82,7 +82,10 @@ type domaininfo =3D { arch_config : arch_domainconfig; } type sched_control =3D { weight : int; cap : int; } -type physinfo_cap_flag =3D CAP_HVM | CAP_DirectIO +type physinfo_cap_flag =3D + | CAP_HVM + | CAP_PV + | CAP_DirectIO type physinfo =3D { threads_per_core : int; cores_per_socket : int; diff --git a/tools/ocaml/libs/xc/xenctrl_stubs.c b/tools/ocaml/libs/xc/xenc= trl_stubs.c index 2e1b29ce33..ce8dbba437 100644 --- a/tools/ocaml/libs/xc/xenctrl_stubs.c +++ b/tools/ocaml/libs/xc/xenctrl_stubs.c @@ -32,6 +32,7 @@ =20 #define XC_WANT_COMPAT_MAP_FOREIGN_API #include +#include =20 #include "mmap_stubs.h" =20 @@ -119,6 +120,31 @@ static void domain_handle_of_uuid_string(xen_domain_ha= ndle_t h, #undef X } =20 +/* + * 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(unsigned int bitmap) +{ + CAMLparam0(); + CAMLlocal2(list, tmp); + + list =3D tmp =3D Val_emptylist; + + for ( unsigned int i =3D 0; bitmap; i++, bitmap >>=3D 1 ) + { + if ( !(bitmap & 1) ) + continue; + + tmp =3D caml_alloc_small(2, Tag_cons); + Field(tmp, 0) =3D Val_int(i); + Field(tmp, 1) =3D list; + list =3D tmp; + } + + CAMLreturn(list); +} + CAMLprim value stub_xc_domain_create(value xch, value config) { CAMLparam2(xch, config); @@ -315,16 +341,25 @@ static value alloc_domaininfo(xc_domaininfo_t * info) Store_field(result, 15, tmp); =20 #if defined(__i386__) || defined(__x86_64__) - /* emulation_flags: x86_arch_emulation_flags list; */ - tmp =3D emul_list =3D Val_emptylist; - for (i =3D 0; i < 10; i++) { - if ((info->arch_config.emulation_flags >> i) & 1) { - tmp =3D caml_alloc_small(2, Tag_cons); - Field(tmp, 0) =3D Val_int(i); - Field(tmp, 1) =3D emul_list; - emul_list =3D tmp; - } - } + /* + * emulation_flags: x86_arch_emulation_flags list; + * + * These BUILD_BUG_ON()'s map the C ABI to the Ocaml ABI. If they + * trip, xenctrl.ml{,i} need updating to match. + */ + BUILD_BUG_ON(XEN_X86_EMU_LAPIC !=3D (1u << 0)); + BUILD_BUG_ON(XEN_X86_EMU_HPET !=3D (1u << 1)); + BUILD_BUG_ON(XEN_X86_EMU_PM !=3D (1u << 2)); + BUILD_BUG_ON(XEN_X86_EMU_RTC !=3D (1u << 3)); + BUILD_BUG_ON(XEN_X86_EMU_IOAPIC !=3D (1u << 4)); + BUILD_BUG_ON(XEN_X86_EMU_PIC !=3D (1u << 5)); + BUILD_BUG_ON(XEN_X86_EMU_VGA !=3D (1u << 6)); + BUILD_BUG_ON(XEN_X86_EMU_IOMMU !=3D (1u << 7)); + BUILD_BUG_ON(XEN_X86_EMU_PIT !=3D (1u << 8)); + BUILD_BUG_ON(XEN_X86_EMU_USE_PIRQ !=3D (1u << 9)); + BUILD_BUG_ON(XEN_X86_EMU_VPCI !=3D (1u << 10)); + BUILD_BUG_ON(XEN_X86_EMU_ALL !=3D 0x7ff); + emul_list =3D c_bitmap_to_ocaml_list(info->arch_config.emulation_flags); =20 /* xen_x86_arch_domainconfig */ x86_arch_config =3D caml_alloc_tuple(1); @@ -635,7 +670,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; =20 @@ -646,15 +681,17 @@ CAMLprim value stub_xc_physinfo(value xch) if (r) failwith_xc(_H(xch)); =20 - tmp =3D cap_list =3D Val_emptylist; - for (r =3D 0; r < 2; r++) { - if ((c_physinfo.capabilities >> r) & 1) { - tmp =3D caml_alloc_small(2, Tag_cons); - Field(tmp, 0) =3D Val_int(r); - Field(tmp, 1) =3D cap_list; - cap_list =3D tmp; - } - } + /* + * capabilities: physinfo_cap_flag list; + * + * These BUILD_BUG_ON()'s map the C ABI to the Ocaml ABI. If they + * trip, xenctrl.ml{,i} need updating to match. + */ + BUILD_BUG_ON(XEN_SYSCTL_PHYSCAP_hvm !=3D (1u << 0)); + BUILD_BUG_ON(XEN_SYSCTL_PHYSCAP_pv !=3D (1u << 1)); + BUILD_BUG_ON(XEN_SYSCTL_PHYSCAP_directio !=3D (1u << 2)); + BUILD_BUG_ON(XEN_SYSCTL_PHYSCAP_MAX !=3D XEN_SYSCTL_PHYSCAP_directio= ); + cap_list =3D c_bitmap_to_ocaml_list(c_physinfo.capabilities); =20 physinfo =3D 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; --=20 2.11.0 _______________________________________________ Xen-devel mailing list Xen-devel@lists.xenproject.org https://lists.xenproject.org/mailman/listinfo/xen-devel