From nobody Sun Feb 8 05:41:09 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575912149; cv=none; d=zohomail.com; s=zohoarc; b=MRkoOfeM7QcfmOzyTHk6ihgH+rUhMwE/slTcRLuOpQf8Tg3oi18rrb+KmwOTYpu2bukBbruhEsbl/3e2iweZneXHAkpp3m9hYrxjMGBdCoOAAw4sisl0PdWJddHUOTuqbVZptoTlrKtQhkGpAi5FrmdjVgOAD0Dslv+1Wn6VFfE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575912149; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=CZPVV53cn9kh/4TMEb+HS0cOPyHRjj7R5+HjcTzaZRk=; b=Frv4iWsB2xEHdfF2tJsPhVd63V9Ub0M4ryvcKRBrij16ZJWnOUtBfYuE+03Pha5nQLcyqZZJ6c/BZksV8blpTJFeuwJD7U4jdJukHjDDuIdtxbx1gBtCAoMO7IGHWkyHcei25ImQ+e0s27duPS7dFzYJJDhN2RgAqSmFDKRfkZM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1575912149871854.0452211868845; Mon, 9 Dec 2019 09:22:29 -0800 (PST) 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-154-EyxHisOlO8S4f85i6SodLA-1; Mon, 09 Dec 2019 12:22:20 -0500 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 A292C85B6FA; Mon, 9 Dec 2019 17:22:13 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 7F4F15C219; Mon, 9 Dec 2019 17:22:13 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 3FEB318034EC; Mon, 9 Dec 2019 17:22:13 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB9HLaJB015141 for ; Mon, 9 Dec 2019 12:21:36 -0500 Received: by smtp.corp.redhat.com (Postfix) id 862095D6C8; Mon, 9 Dec 2019 17:21:36 +0000 (UTC) Received: from catbus.gsslab.fab.redhat.com (dhcp-32.gsslab.fab.redhat.com [10.33.9.32]) by smtp.corp.redhat.com (Postfix) with ESMTP id A19EB5D6B7; Mon, 9 Dec 2019 17:21:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575912148; h=from:from:sender:sender: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:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=CZPVV53cn9kh/4TMEb+HS0cOPyHRjj7R5+HjcTzaZRk=; b=U0Gadvy3r622dkIY5k70JFi7ryQtzuZJDO5oVL/k/n3+skKq1OG0l/EwgbztBYx5uFFsua d9mh4XsSO56SwQZPcD62T5kFio+HyrE/n+k0/3JEG6CcCzUbEbVAjgeArAOFm5LLOUqWkQ N73Iudtu65Mx4EKK1BjzPUfxJ3xNKHk= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Mon, 9 Dec 2019 17:14:21 +0000 Message-Id: <20191209171422.31091-4-berrange@redhat.com> In-Reply-To: <20191209171422.31091-1-berrange@redhat.com> References: <20191209171422.31091-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com Cc: Cole Robinson Subject: [libvirt] [PATCH v6 3/4] docs: rewrite hvsupport.html page generator in python X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-MC-Unique: EyxHisOlO8S4f85i6SodLA-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) As part of a goal to eliminate Perl from libvirt build tools, rewrite the hvsupport.pl tool in Python. This was a straight conversion, manually going line-by-line to change the syntax from Perl to Python. Thus the overall structure of the file and approach is the same. The new impl generates byte-for-byte identical output to the old impl. Tested-by: Cole Robinson Signed-off-by: Daniel P. Berrang=C3=A9 --- Makefile.am | 1 + docs/Makefile.am | 7 +- docs/hvsupport.pl | 459 --------------------------------------- scripts/hvsupport.py | 502 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 506 insertions(+), 463 deletions(-) delete mode 100755 docs/hvsupport.pl create mode 100755 scripts/hvsupport.py diff --git a/Makefile.am b/Makefile.am index b9d33f5cf8..51ef567d3b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -62,6 +62,7 @@ EXTRA_DIST =3D \ scripts/gensystemtap.py \ scripts/group-qemu-caps.py \ scripts/header-ifdef.py \ + scripts/hvsupport.py \ scripts/hyperv_wmi_generator.py \ scripts/minimize-po.py \ scripts/mock-noinline.py \ diff --git a/docs/Makefile.am b/docs/Makefile.am index 5f5dce28eb..18d17b3727 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -245,7 +245,6 @@ EXTRA_DIST=3D \ $(internals_html_in) $(internals_rst) $(fonts) \ $(kbase_html_in) $(kbase_rst) \ aclperms.htmlinc \ - hvsupport.pl \ $(schema_DATA) =20 acl_generated =3D aclperms.htmlinc @@ -275,12 +274,12 @@ timestamp=3D"$(shell if test -n "$$SOURCE_DATE_EPOCH"= ; \ =20 hvsupport.html: hvsupport.html.in =20 -hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \ +hvsupport.html.in: $(top_srcdir)/scripts/hvsupport.py $(api_DATA) \ $(top_srcdir)/src/libvirt_public.syms \ $(top_srcdir)/src/libvirt_qemu.syms $(top_srcdir)/src/libvirt_lxc.syms \ $(top_srcdir)/src/driver.h - $(AM_V_GEN)$(PERL) $(srcdir)/hvsupport.pl $(top_srcdir) $(top_builddir) >= $@ \ - || { rm $@ && exit 1; } + $(AM_V_GEN)$(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/hvsupport.py \ + $(top_srcdir) $(top_builddir) > $@ || { rm $@ && exit 1; } =20 news.html.in: \ $(srcdir)/news.xml \ diff --git a/docs/hvsupport.pl b/docs/hvsupport.pl deleted file mode 100755 index 0977098eac..0000000000 --- a/docs/hvsupport.pl +++ /dev/null @@ -1,459 +0,0 @@ -#!/usr/bin/env perl - -use strict; -use warnings; - -use File::Find; - -die "syntax: $0 SRCDIR BUILDDIR\n" unless int(@ARGV) =3D=3D 2; - -my $srcdir =3D shift @ARGV; -my $builddir =3D shift @ARGV; - -my $symslibvirt =3D "$srcdir/src/libvirt_public.syms"; -my $symsqemu =3D "$srcdir/src/libvirt_qemu.syms"; -my $symslxc =3D "$srcdir/src/libvirt_lxc.syms"; -my @drivertable =3D ( - "$srcdir/src/driver-hypervisor.h", - "$srcdir/src/driver-interface.h", - "$srcdir/src/driver-network.h", - "$srcdir/src/driver-nodedev.h", - "$srcdir/src/driver-nwfilter.h", - "$srcdir/src/driver-secret.h", - "$srcdir/src/driver-state.h", - "$srcdir/src/driver-storage.h", - "$srcdir/src/driver-stream.h", - ); - -my %groupheaders =3D ( - "virHypervisorDriver" =3D> "Hypervisor APIs", - "virNetworkDriver" =3D> "Virtual Network APIs", - "virInterfaceDriver" =3D> "Host Interface APIs", - "virNodeDeviceDriver" =3D> "Host Device APIs", - "virStorageDriver" =3D> "Storage Pool APIs", - "virSecretDriver" =3D> "Secret APIs", - "virNWFilterDriver" =3D> "Network Filter APIs", - ); - - -my @srcs; -find({ - wanted =3D> sub { - if (m!$srcdir/src/.*/\w+_(driver|common|tmpl|monitor|hal|udev)\.c$= !) { - push @srcs, $_ if $_ !~ /vbox_driver\.c/; - } - }, no_chdir =3D> 1}, "$srcdir/src"); - -# Map API=C2=A0functions to the header and documentation files they're in -# so that we can generate proper hyperlinks to their documentation. -# -# The function names are grep'd from the XML output of apibuild.py. -sub getAPIFilenames { - my $filename =3D shift; - - my %files; - my $line; - - open FILE, "<", $filename or die "cannot read $filename: $!"; - - while (defined($line =3D )) { - if ($line =3D~ /function name=3D'([^']+)' file=3D'([^']+)'/) { - $files{$1} =3D $2; - } - } - - close FILE; - - if (keys %files =3D=3D 0) { - die "No functions found in $filename. Has the apibuild.py output c= hanged?"; - } - return \%files; -} - -sub parseSymsFile { - my $apisref =3D shift; - my $prefix =3D shift; - my $filename =3D shift; - my $xmlfilename =3D shift; - - my $line; - my $vers; - my $prevvers; - - my $filenames =3D getAPIFilenames($xmlfilename); - - open FILE, "<$filename" - or die "cannot read $filename: $!"; - - while (defined($line =3D )) { - chomp $line; - next if $line =3D~ /^\s*#/; - next if $line =3D~ /^\s*$/; - next if $line =3D~ /^\s*(global|local):/; - if ($line =3D~ /^\s*${prefix}_(\d+\.\d+\.\d+)\s*{\s*$/) { - if (defined $vers) { - die "malformed syms file"; - } - $vers =3D $1; - } elsif ($line =3D~ /\s*}\s*;\s*$/) { - if (defined $prevvers) { - die "malformed syms file"; - } - $prevvers =3D $vers; - $vers =3D undef; - } elsif ($line =3D~ /\s*}\s*${prefix}_(\d+\.\d+\.\d+)\s*;\s*$/) { - if ($1 ne $prevvers) { - die "malformed syms file $1 !=3D $vers"; - } - $prevvers =3D $vers; - $vers =3D undef; - } elsif ($line =3D~ /\s*(\w+)\s*;\s*$/) { - $$apisref{$1} =3D {}; - $$apisref{$1}->{vers} =3D $vers; - $$apisref{$1}->{file} =3D $$filenames{$1}; - } else { - die "unexpected data $line\n"; - } - } - - close FILE; -} - -my %apis; -# Get the list of all public APIs and their corresponding version -parseSymsFile(\%apis, "LIBVIRT", $symslibvirt, "$builddir/docs/libvirt-api= .xml"); - -# And the same for the QEMU specific APIs -parseSymsFile(\%apis, "LIBVIRT_QEMU", $symsqemu, "$builddir/docs/libvirt-q= emu-api.xml"); - -# And the same for the LXC specific APIs -parseSymsFile(\%apis, "LIBVIRT_LXC", $symslxc, "$builddir/docs/libvirt-lxc= -api.xml"); - - -# Some special things which aren't public APIs, -# but we want to report -$apis{virConnectSupportsFeature}->{vers} =3D "0.3.2"; -$apis{virDomainMigratePrepare}->{vers} =3D "0.3.2"; -$apis{virDomainMigratePerform}->{vers} =3D "0.3.2"; -$apis{virDomainMigrateFinish}->{vers} =3D "0.3.2"; -$apis{virDomainMigratePrepare2}->{vers} =3D "0.5.0"; -$apis{virDomainMigrateFinish2}->{vers} =3D "0.5.0"; -$apis{virDomainMigratePrepareTunnel}->{vers} =3D "0.7.2"; - -$apis{virDomainMigrateBegin3}->{vers} =3D "0.9.2"; -$apis{virDomainMigratePrepare3}->{vers} =3D "0.9.2"; -$apis{virDomainMigratePrepareTunnel3}->{vers} =3D "0.9.2"; -$apis{virDomainMigratePerform3}->{vers} =3D "0.9.2"; -$apis{virDomainMigrateFinish3}->{vers} =3D "0.9.2"; -$apis{virDomainMigrateConfirm3}->{vers} =3D "0.9.2"; - -$apis{virDomainMigrateBegin3Params}->{vers} =3D "1.1.0"; -$apis{virDomainMigratePrepare3Params}->{vers} =3D "1.1.0"; -$apis{virDomainMigratePrepareTunnel3Params}->{vers} =3D "1.1.0"; -$apis{virDomainMigratePerform3Params}->{vers} =3D "1.1.0"; -$apis{virDomainMigrateFinish3Params}->{vers} =3D "1.1.0"; -$apis{virDomainMigrateConfirm3Params}->{vers} =3D "1.1.0"; - - - -# Now we want to get the mapping between public APIs -# and driver struct fields. This lets us later match -# update the driver impls with the public APis. - -my $line; - -# Group name -> hash of APIs { fields -> api name } -my %groups; -my $ingrp; -foreach my $drivertable (@drivertable) { - open FILE, "<$drivertable" - or die "cannot read $drivertable: $!"; - - while (defined($line =3D )) { - if ($line =3D~ /struct _(vir\w*Driver)/) { - my $grp =3D $1; - if ($grp ne "virStateDriver" && - $grp ne "virStreamDriver") { - $ingrp =3D $grp; - $groups{$ingrp} =3D { apis =3D> {}, drivers =3D> {} }; - } - } elsif ($ingrp) { - if ($line =3D~ /^\s*vir(?:Drv)(\w+)\s+(\w+);\s*$/) { - my $field =3D $2; - my $name =3D $1; - - my $api; - if (exists $apis{"vir$name"}) { - $api =3D "vir$name"; - } elsif ($name =3D~ /\w+(Open|Close|URIProbe)/) { - next; - } else { - die "driver $name does not have a public API"; - } - $groups{$ingrp}->{apis}->{$field} =3D $api; - } elsif ($line =3D~ /};/) { - $ingrp =3D undef; - } - } - } - - close FILE; -} - - -# Finally, we read all the primary driver files and extract -# the driver API tables from each one. - -foreach my $src (@srcs) { - open FILE, "<$src" or - die "cannot read $src: $!"; - - my $groups_regex =3D join("|", keys %groups); - $ingrp =3D undef; - my $impl; - while (defined($line =3D )) { - if (!$ingrp) { - #=C2=A0skip non-matching lines early to save time - next if not $line =3D~ /$groups_regex/; - - if ($line =3D~ /^\s*(?:static\s+)?($groups_regex)\s+(\w+)\s*= =3D\s*{/ || - $line =3D~ /^\s*(?:static\s+)?($groups_regex)\s+NAME\(\w+\= )\s*=3D\s*{/) { - $ingrp =3D $1; - $impl =3D $src; - - if ($impl =3D~ m,.*/node_device_(\w+)\.c,) { - $impl =3D $1; - } else { - $impl =3D~ s,.*/(\w+?)_((\w+)_)?(\w+)\.c,$1,; - } - - if ($groups{$ingrp}->{drivers}->{$impl}) { - die "Group $ingrp already contains $impl"; - } - - $groups{$ingrp}->{drivers}->{$impl} =3D {}; - } - - } else { - if ($line =3D~ m!\s*\.(\w+)\s*=3D\s*(\w+)\s*,?\s*(?:/\*\s*(\d+= \.\d+\.\d+)\s*(?:-\s*(\d+\.\d+\.\d+))?\s*\*/\s*)?$!) { - my $api =3D $1; - my $meth =3D $2; - my $vers =3D $3; - my $deleted =3D $4; - - next if $api eq "no" || $api eq "name"; - - if ($meth eq "NULL" && !defined $deleted) { - die "Method impl for $api is NULL, but no deleted vers= ion is provided"; - } - if ($meth ne "NULL" && defined $deleted) { - die "Method impl for $api is non-NULL, but deleted ver= sion is provided"; - } - - die "Method $meth in $src is missing version" unless defin= ed $vers || $api eq "connectURIProbe"; - - if (!exists($groups{$ingrp}->{apis}->{$api})) { - next if $api =3D~ /\w(Open|Close|URIProbe)/; - - die "Found unexpected method $api in $ingrp\n"; - } - - $groups{$ingrp}->{drivers}->{$impl}->{$api} =3D {}; - $groups{$ingrp}->{drivers}->{$impl}->{$api}->{vers} =3D $v= ers; - $groups{$ingrp}->{drivers}->{$impl}->{$api}->{deleted} = =3D $deleted; - if ($api eq "domainMigratePrepare" || - $api eq "domainMigratePrepare2" || - $api eq "domainMigratePrepare3") { - if (!$groups{$ingrp}->{drivers}->{$impl}->{"domainMigr= ate"}) { - $groups{$ingrp}->{drivers}->{$impl}->{"domainMigra= te"} =3D {}; - $groups{$ingrp}->{drivers}->{$impl}->{"domainMigra= te"}->{vers} =3D $vers; - } - } - - } elsif ($line =3D~ /}/) { - $ingrp =3D undef; - } - } - } - - close FILE; -} - - -# The '.open' driver method is used for 3 public APIs, so we -# have a bit of manual fixup todo with the per-driver versioning -# and support matrix - -$groups{virHypervisorDriver}->{apis}->{"openAuth"} =3D "virConnectOpenAuth= "; -$groups{virHypervisorDriver}->{apis}->{"openReadOnly"} =3D "virConnectOpen= ReadOnly"; -$groups{virHypervisorDriver}->{apis}->{"domainMigrate"} =3D "virDomainMigr= ate"; - -my $openAuthVers =3D (0 * 1000 * 1000) + (4 * 1000) + 0; - -foreach my $drv (keys %{$groups{"virHypervisorDriver"}->{drivers}}) { - my $openVersStr =3D $groups{"virHypervisorDriver"}->{drivers}->{$drv}-= >{"connectOpen"}->{vers}; - my $openVers; - if ($openVersStr =3D~ /(\d+)\.(\d+)\.(\d+)/) { - $openVers =3D ($1 * 1000 * 1000) + ($2 * 1000) + $3; - } - - # virConnectOpenReadOnly always matches virConnectOpen version - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenReadOn= ly"} =3D - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpen"}; - - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenAuth"}= =3D {}; - - # virConnectOpenAuth is always 0.4.0 if the driver existed - # before this time, otherwise it matches the version of - # the driver's virConnectOpen entry - if ($openVersStr eq "Y" || - $openVers >=3D $openAuthVers) { - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenAu= th"}->{vers} =3D $openVersStr; - } else { - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"connectOpenAu= th"}->{vers} =3D "0.4.0"; - } -} - - -# Another special case for the virDomainCreateLinux which was replaced -# with virDomainCreateXML -$groups{virHypervisorDriver}->{apis}->{"domainCreateLinux"} =3D "virDomain= CreateLinux"; - -my $createAPIVers =3D (0 * 1000 * 1000) + (0 * 1000) + 3; - -foreach my $drv (keys %{$groups{"virHypervisorDriver"}->{drivers}}) { - my $createVersStr =3D $groups{"virHypervisorDriver"}->{drivers}->{$drv= }->{"domainCreateXML"}->{vers}; - next unless defined $createVersStr; - my $createVers; - if ($createVersStr =3D~ /(\d+)\.(\d+)\.(\d+)/) { - $createVers =3D ($1 * 1000 * 1000) + ($2 * 1000) + $3; - } - - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateLinux= "} =3D {}; - - # virCreateLinux is always 0.0.3 if the driver existed - # before this time, otherwise it matches the version of - # the driver's virCreateXML entry - if ($createVersStr eq "Y" || - $createVers >=3D $createAPIVers) { - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateL= inux"}->{vers} =3D $createVersStr; - } else { - $groups{"virHypervisorDriver"}->{drivers}->{$drv}->{"domainCreateL= inux"}->{vers} =3D "0.0.3"; - } -} - - -# Finally we generate the HTML file with the tables - -print < - - - -

libvirt API support matrix

- -
    - -

    -This page documents which libvirt calls work on -which libvirt drivers / hypervisors, and which version the API appeared -in. If a hypervisor driver later dropped support for the API, the version -when it was removed is also mentioned (highlighted in -dark red). -

    - -EOF - - foreach my $grp (sort { $a cmp $b } keys %groups) { - print "

    ", $groupheaders{$grp}, "

    \n"; - print < - - -API -Version -EOF - - foreach my $drv (sort { $a cmp $b } keys %{$groups{$grp}->{drivers}}) { - print " $drv\n"; - } - - print < - - -EOF - - my $row =3D 0; - foreach my $field (sort { - $groups{$grp}->{apis}->{$a} - cmp - $groups{$grp}->{apis}->{$b} - } keys %{$groups{$grp}->{apis}}) { - my $api =3D $groups{$grp}->{apis}->{$field}; - my $vers =3D $apis{$api}->{vers}; - my $htmlgrp =3D $apis{$api}->{file}; - print < - -EOF - - if (defined $htmlgrp) { - print <$api -EOF - - } else { - print $api; - } - print < -$vers -EOF - - foreach my $drv (sort {$a cmp $b } keys %{$groups{$grp}->{drivers}= }) { - print ""; - if (exists $groups{$grp}->{drivers}->{$drv}->{$field}) { - if ($groups{$grp}->{drivers}->{$drv}->{$field}->{vers}) { - print $groups{$grp}->{drivers}->{$drv}->{$field}->{ver= s}; - } - if ($groups{$grp}->{drivers}->{$drv}->{$field}->{deleted})= { - print " - ", $groups{$grp}= ->{drivers}->{$drv}->{$field}->{deleted}, ""; - } - } - print "\n"; - } - - print < -EOF - - $row++; - if (($row % 15) =3D=3D 0) { - print < -API -Version -EOF - - foreach my $drv (sort { $a cmp $b } keys %{$groups{$grp}->{dri= vers}}) { - print " $drv\n"; - } - - print < -EOF - } - - } - - print < - -EOF -} - -print < - -EOF diff --git a/scripts/hvsupport.py b/scripts/hvsupport.py new file mode 100755 index 0000000000..14c41da348 --- /dev/null +++ b/scripts/hvsupport.py @@ -0,0 +1,502 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2011-2019 Red Hat, Inc. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library. If not, see +# . + +import sys +import os.path +import re + +if len(sys.argv) !=3D 3: + print("syntax: %s TOP-SRCDIR TOP-BUILDDIR\n" % sys.argv[0], file=3Dsys= .stderr) + +srcdir =3D sys.argv[1] +builddir =3D sys.argv[2] + +symslibvirt =3D os.path.join(srcdir, "src", "libvirt_public.syms") +symsqemu =3D os.path.join(srcdir, "src", "libvirt_qemu.syms") +symslxc =3D os.path.join(srcdir, "src", "libvirt_lxc.syms") +drivertablefiles =3D [ + os.path.join(srcdir, "src", "driver-hypervisor.h"), + os.path.join(srcdir, "src", "driver-interface.h"), + os.path.join(srcdir, "src", "driver-network.h"), + os.path.join(srcdir, "src", "driver-nodedev.h"), + os.path.join(srcdir, "src", "driver-nwfilter.h"), + os.path.join(srcdir, "src", "driver-secret.h"), + os.path.join(srcdir, "src", "driver-state.h"), + os.path.join(srcdir, "src", "driver-storage.h"), + os.path.join(srcdir, "src", "driver-stream.h"), +] + +groupheaders =3D { + "virHypervisorDriver": "Hypervisor APIs", + "virNetworkDriver": "Virtual Network APIs", + "virInterfaceDriver": "Host Interface APIs", + "virNodeDeviceDriver": "Host Device APIs", + "virStorageDriver": "Storage Pool APIs", + "virSecretDriver": "Secret APIs", + "virNWFilterDriver": "Network Filter APIs", +} + + +srcs =3D [] +for root, dirs, files in os.walk(os.path.join(srcdir, "src")): + for file in files: + if ((file.endswith("driver.c") and + not file.endswith("vbox_driver.c")) or + file.endswith("common.c") or + file.endswith("tmpl.c") or + file.endswith("monitor.c") or + file.endswith("hal.c") or + file.endswith("udev.c")): + srcs.append(os.path.join(root, file)) + + +# Map API functions to the header and documentation files they're in +# so that we can generate proper hyperlinks to their documentation. +# +# The function names are grep'd from the XML output of apibuild.py. +def getAPIFilenames(filename): + files =3D {} + + with open(filename) as fh: + for line in fh: + res =3D re.search(r"function name=3D'([^']+)' file=3D'([^']+)'= ", line) + if res is not None: + files[res.group(1)] =3D res.group(2) + + if len(files) =3D=3D 0: + raise Exception(("No functions found in %s. " + + "Has the apibuild.py output changed?") % + filename) + + return files + + +def parseSymsFile(apisref, prefix, filename, xmlfilename): + vers =3D None + prevvers =3D None + + filenames =3D getAPIFilenames(xmlfilename) + + with open(filename) as fh: + for line in fh: + line =3D line.strip() + + if line =3D=3D "": + continue + if line[0] =3D=3D '#': + continue + if line.startswith("global:"): + continue + if line.startswith("local:"): + continue + + groupstartmatch =3D re.search(r"^\s*%s_(\d+\.\d+\.\d+)\s*{\s*$= " % + prefix, line) + groupendmatch1 =3D re.search(r"^\s*}\s*;\s*$", line) + groupendmatch2 =3D re.search(r"^\s*}\s*%s_(\d+\.\d+\.\d+)\s*;\= s*$" % + prefix, line) + symbolmatch =3D re.search(r"^\s*(\w+)\s*;\s*$", line) + if groupstartmatch is not None: + if vers is not None: + raise Exception("malformed syms file when starting gro= up") + + vers =3D groupstartmatch.group(1) + elif groupendmatch1 is not None: + if prevvers is not None: + raise Exception("malformed syms file when ending group= ") + + prevvers =3D vers + vers =3D None + elif groupendmatch2 is not None: + if groupendmatch2.group(1) !=3D prevvers: + raise Exception(("malformed syms file %s !=3D %s " + + "when ending group") % + (groupendmatch2.group(1), prevvers)) + + prevvers =3D vers + vers =3D None + elif symbolmatch is not None: + name =3D symbolmatch.group(1) + apisref[name] =3D { + "vers": vers, + "file": filenames.get(name), + } + else: + raise Exception("unexpected data %s" % line) + + +apis =3D {} +# Get the list of all public APIs and their corresponding version +parseSymsFile(apis, "LIBVIRT", symslibvirt, + os.path.join(builddir, "docs", "libvirt-api.xml")) + +# And the same for the QEMU specific APIs +parseSymsFile(apis, "LIBVIRT_QEMU", symsqemu, + os.path.join(builddir, "docs", "libvirt-qemu-api.xml")) + +# And the same for the LXC specific APIs +parseSymsFile(apis, "LIBVIRT_LXC", symslxc, + os.path.join(builddir, "docs", "libvirt-lxc-api.xml")) + + +# Some special things which aren't public APIs, +# but we want to report +apis["virConnectSupportsFeature"] =3D { + "vers": "0.3.2" +} +apis["virDomainMigratePrepare"] =3D { + "vers": "0.3.2" +} +apis["virDomainMigratePerform"] =3D { + "vers": "0.3.2" +} +apis["virDomainMigrateFinish"] =3D { + "vers": "0.3.2" +} +apis["virDomainMigratePrepare2"] =3D { + "vers": "0.5.0" +} +apis["virDomainMigrateFinish2"] =3D { + "vers": "0.5.0" +} +apis["virDomainMigratePrepareTunnel"] =3D { + "vers": "0.7.2" +} + +apis["virDomainMigrateBegin3"] =3D { + "vers": "0.9.2" +} +apis["virDomainMigratePrepare3"] =3D { + "vers": "0.9.2" +} +apis["virDomainMigratePrepareTunnel3"] =3D { + "vers": "0.9.2" +} +apis["virDomainMigratePerform3"] =3D { + "vers": "0.9.2" +} +apis["virDomainMigrateFinish3"] =3D { + "vers": "0.9.2" +} +apis["virDomainMigrateConfirm3"] =3D { + "vers": "0.9.2" +} + +apis["virDomainMigrateBegin3Params"] =3D { + "vers": "1.1.0" +} +apis["virDomainMigratePrepare3Params"] =3D { + "vers": "1.1.0" +} +apis["virDomainMigratePrepareTunnel3Params"] =3D { + "vers": "1.1.0" +} +apis["virDomainMigratePerform3Params"] =3D { + "vers": "1.1.0" +} +apis["virDomainMigrateFinish3Params"] =3D { + "vers": "1.1.0" +} +apis["virDomainMigrateConfirm3Params"] =3D { + "vers": "1.1.0" +} + + +# Now we want to get the mapping between public APIs +# and driver struct fields. This lets us later match +# update the driver impls with the public APis. + +# Group name -> hash of APIs { fields -> api name } +groups =3D {} +ingrp =3D None +for drivertablefile in drivertablefiles: + with open(drivertablefile) as fh: + for line in fh: + starttablematch =3D re.search(r"struct _(vir\w*Driver)", line) + if starttablematch is not None: + grp =3D starttablematch.group(1) + if grp !=3D "virStateDriver" and grp !=3D "virStreamDriver= ": + ingrp =3D grp + groups[ingrp] =3D { + "apis": {}, + "drivers": {} + } + elif ingrp is not None: + callbackmatch =3D re.search(r"^\s*vir(?:Drv)(\w+)\s+(\w+);= \s*$", + line) + if callbackmatch is not None: + name =3D callbackmatch.group(1) + field =3D callbackmatch.group(2) + + api =3D "vir" + name + if api in apis: + groups[ingrp]["apis"][field] =3D api + elif re.search(r"\w+(Open|Close|URIProbe)", api) is no= t None: + continue + else: + raise Exception(("driver %s does not have " + + "a public API") % name) + elif re.search(r"};", line): + ingrp =3D None + + +# Finally, we read all the primary driver files and extract +# the driver API tables from each one. + +for src in srcs: + with open(src) as fh: + groupsre =3D "|".join(groups.keys()) + + ingrp =3D None + impl =3D None + for line in fh: + if ingrp is None: + m =3D re.search(r"^\s*(static\s+)?(" + + groupsre + + r")\s+(\w+)\s*=3D\s*{", line) + if m is None: + m =3D re.search(r"^\s*(static\s+)?(" + + groupsre + + r")\s+NAME\(\w+\)\s*=3D\s*{", line) + if m is not None: + ingrp =3D m.group(2) + impl =3D src + + implmatch =3D re.search(r".*/node_device_(\w+)\.c", im= pl) + if implmatch is None: + implmatch =3D re.search(r".*/(\w+?)_((\w+)_)?(\w+)= \.c", impl) + if implmatch is None: + raise Exception("Unexpected impl format '%s'" % im= pl) + impl =3D implmatch.group(1) + + if impl in groups[ingrp]["drivers"]: + raise Exception( + "Group %s already contains %s" % (ingrp, impl)) + + groups[ingrp]["drivers"][impl] =3D {} + else: + callbackmatch =3D re.search(r"\s*\.(\w+)\s*=3D\s*(\w+)\s*,= ?\s*" + + r"(?:/\*\s*(\d+\.\d+\.\d+)\s*" + + r"(?:-\s*(\d+\.\d+\.\d+))?\s*\*/= \s*)?$", + line) + if callbackmatch is not None: + api =3D callbackmatch.group(1) + meth =3D callbackmatch.group(2) + vers =3D callbackmatch.group(3) + deleted =3D callbackmatch.group(4) + + if api =3D=3D "no" or api =3D=3D "name": + continue + + if meth =3D=3D "NULL" and deleted is None: + raise Exception( + ("Method impl for %s is NULL, but " + + "no deleted version is provided") % api) + + if meth !=3D "NULL" and deleted is not None: + raise Exception( + ("Method impl for %s is non-NULL, but " + + "deleted version is provided") % api) + + if vers is None and api !=3D "connectURIProbe": + raise Exception( + "Method %s in %s is missing version" % + (meth, src)) + + if api not in groups[ingrp]["apis"]: + if re.search(r"\w+(Open|Close|URIProbe)", api): + continue + + raise Exception("Found unexpected method " + + "%s in %s" % (api, ingrp)) + + groups[ingrp]["drivers"][impl][api] =3D { + "vers": vers, + "deleted": deleted, + } + + if (api =3D=3D "domainMigratePrepare" or + api =3D=3D "domainMigratePrepare2" or + api =3D=3D "domainMigratePrepare3"): + if ("domainMigrate" not in + groups[ingrp]["drivers"][impl]): + groups[ingrp]["drivers"][impl]["domainMigrate"= ] =3D { + "vers": vers, + } + elif line.find("}") !=3D -1: + ingrp =3D None + + +# The '.open' driver method is used for 3 public APIs, so we +# have a bit of manual fixup todo with the per-driver versioning +# and support matrix + +groups["virHypervisorDriver"]["apis"]["openAuth"] =3D \ + "virConnectOpenAuth" +groups["virHypervisorDriver"]["apis"]["openReadOnly"] =3D \ + "virConnectOpenReadOnly" +groups["virHypervisorDriver"]["apis"]["domainMigrate"] =3D \ + "virDomainMigrate" + +openAuthVers =3D (0 * 1000 * 1000) + (4 * 1000) + 0 + +drivers =3D groups["virHypervisorDriver"]["drivers"] +for drv in drivers.keys(): + openVersStr =3D drivers[drv]["connectOpen"]["vers"] + openVers =3D 0 + if openVersStr !=3D "Y": + openVersBits =3D openVersStr.split(".") + if len(openVersBits) !=3D 3: + raise Exception("Expected 3 digit version for %s" % openVersSt= r) + openVers =3D ((int(openVersBits[0]) * 1000 * 1000) + + (int(openVersBits[1]) * 1000) + + int(openVersBits[2])) + + # virConnectOpenReadOnly always matches virConnectOpen version + drivers[drv]["connectOpenReadOnly"] =3D \ + drivers[drv]["connectOpen"] + + # virConnectOpenAuth is always 0.4.0 if the driver existed + # before this time, otherwise it matches the version of + # the driver's virConnectOpen entry + if openVersStr =3D=3D "Y" or openVers >=3D openAuthVers: + vers =3D openVersStr + else: + vers =3D "0.4.0" + drivers[drv]["connectOpenAuth"] =3D { + "vers": vers, + } + + +# Another special case for the virDomainCreateLinux which was replaced +# with virDomainCreateXML +groups["virHypervisorDriver"]["apis"]["domainCreateLinux"] =3D \ + "virDomainCreateLinux" + +createAPIVers =3D (0 * 1000 * 1000) + (0 * 1000) + 3 + +for drv in drivers.keys(): + if "domainCreateXML" not in drivers[drv]: + continue + createVersStr =3D drivers[drv]["domainCreateXML"]["vers"] + createVers =3D 0 + if createVersStr !=3D "Y": + createVersBits =3D createVersStr.split(".") + if len(createVersBits) !=3D 3: + raise Exception("Expected 3 digit version for %s" % createVers= Str) + createVers =3D ((int(createVersBits[0]) * 1000 * 1000) + + (int(createVersBits[1]) * 1000) + + int(createVersBits[2])) + + # virCreateLinux is always 0.0.3 if the driver existed + # before this time, otherwise it matches the version of + # the driver's virCreateXML entry + if createVersStr =3D=3D "Y" or createVers >=3D createAPIVers: + vers =3D createVersStr + else: + vers =3D "0.0.3" + + drivers[drv]["domainCreateLinux"] =3D { + "vers": vers, + } + + +# Finally we generate the HTML file with the tables + +print(''' + + + +

    libvirt API support matrix

    + +
      + +

      +This page documents which libvirt calls work on +which libvirt drivers / hypervisors, and which version the API appeared +in. If a hypervisor driver later dropped support for the API, the version +when it was removed is also mentioned (highlighted in +dark red). +

      +''') + +for grp in sorted(groups.keys()): + print("

      %s

      " % (grp, groupheaders[grp])) + print(''' + + + +''') + + for drv in sorted(groups[grp]["drivers"].keys()): + print(" " % drv) + + print(''' + +''') + + row =3D 0 + + def sortkey(field): + return groups[grp]["apis"][field] + + for field in sorted(groups[grp]["apis"].keys(), key=3Dsortkey): + api =3D groups[grp]["apis"][field] + vers =3D apis[api]["vers"] + htmlgrp =3D apis[api].get("file") + print("") + + if htmlgrp is not None: + print(('''''') % + (htmlgrp, api, api)) + else: + print("" % api) + + print("" % vers) + + for drv in sorted(groups[grp]["drivers"].keys()): + info =3D "" + if field in groups[grp]["drivers"][drv]: + vers =3D groups[grp]["drivers"][drv][field]["vers"] + if vers is not None: + info =3D info + vers + + deleted =3D groups[grp]["drivers"][drv][field].get("delete= d") + if deleted is not None: + info =3D info + (''' - ''' + + '''%s''' % deleted) + + print("" % info) + + print("") + + row =3D row + 1 + if (row % 15) =3D=3D 0: + print(''' + +''') + + for drv in sorted(groups[grp]["drivers"].keys()): + print(" " % drv) + + print("") + + print("\n
      APIVersion%s
      \n''' + + '''%s\n\n%s%s%s
      APIVersion%s
      ") + +print("\n") --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list