From nobody Wed May 8 02:02:31 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 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=1567168188; cv=none; d=zoho.com; s=zohoarc; b=gmxUv/lLHX/MLXn+vMS8ZERQzBkWQYWL1c+m4oKgt+WBabs1vd1sYCYSUrQyvlm1be0Ah4DZcG9nLyB9q2aI0ZLR/IZzMr46LnHbEwlWQP/AMp8dlSpO0scVptOH8mOHz97xTmo04Y0Q+uHIeIdN5VgJfuG1+xRPZF1n7U6ZROQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567168188; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=qc1pZMhYTa+bl04158MAa4YNWVluL7KKIHr0h/aM0UE=; b=jqToDHxsG2/ZP+z9x1uITWCA4gXyhUjkerapQjQm/ItCE8Kh327nOYPdCUTV6EKBXPZ3yzf6gHVEYpQm1zPBn6vF08zLIwmRFJb256pYxZ6Ix6tDggrybGpJtWiB1WyN4LiFl5RQPSG8u+kTNVDm4E4jFh6jKlYaXMp4GbgQPu0= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1567168188586943.1246983010329; Fri, 30 Aug 2019 05:29:48 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 0C1892A09D9; Fri, 30 Aug 2019 12:29:47 +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 8913E5D721; Fri, 30 Aug 2019 12:29:45 +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 D04F11806B00; Fri, 30 Aug 2019 12:29:44 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x7UCThB4019022 for ; Fri, 30 Aug 2019 08:29:43 -0400 Received: by smtp.corp.redhat.com (Postfix) id 1E1F51001959; Fri, 30 Aug 2019 12:29:43 +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 ECB9B100194E; Fri, 30 Aug 2019 12:29:39 +0000 (UTC) From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 30 Aug 2019 13:25:25 +0100 Message-Id: <20190830122525.23080-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-loop: libvir-list@redhat.com Cc: Cedric Bosdonnat Subject: [libvirt] [PATCH] 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: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Fri, 30 Aug 2019 12:29:47 +0000 (UTC) As part of an 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. Signed-off-by: Daniel P. Berrang=C3=A9 --- docs/Makefile.am | 6 +- docs/hvsupport.pl | 458 --------------------------------------------- docs/hvsupport.py | 463 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 466 insertions(+), 461 deletions(-) delete mode 100755 docs/hvsupport.pl create mode 100755 docs/hvsupport.py diff --git a/docs/Makefile.am b/docs/Makefile.am index 1cdb584b0b..f7aba5499d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -194,7 +194,7 @@ EXTRA_DIST=3D \ $(internals_html_in) $(internals_html) $(fonts) \ $(kbase_html_in) $(kbase_html) \ aclperms.htmlinc \ - hvsupport.pl \ + hvsupport.py \ $(schema_DATA) =20 acl_generated =3D aclperms.htmlinc @@ -230,11 +230,11 @@ web: $(dot_html) $(internals_html) $(kbase_html) \ =20 hvsupport.html: $(srcdir)/hvsupport.html.in =20 -$(srcdir)/hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \ +$(srcdir)/hvsupport.html.in: $(srcdir)/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)/src > $@ \ + $(AM_V_GEN)$(PYTHON) $(srcdir)/hvsupport.py $(top_srcdir)/src > $@ \ || { rm $@ && exit 1; } =20 news.html.in: \ diff --git a/docs/hvsupport.pl b/docs/hvsupport.pl deleted file mode 100755 index 494b8a27ec..0000000000 --- a/docs/hvsupport.pl +++ /dev/null @@ -1,458 +0,0 @@ -#!/usr/bin/env perl - -use strict; -use warnings; - -use File::Find; - -die "syntax: $0 SRCDIR\n" unless int(@ARGV) =3D=3D 1; - -my $srcdir =3D shift @ARGV; - -my $symslibvirt =3D "$srcdir/libvirt_public.syms"; -my $symsqemu =3D "$srcdir/libvirt_qemu.syms"; -my $symslxc =3D "$srcdir/libvirt_lxc.syms"; -my @drivertable =3D ( - "$srcdir/driver-hypervisor.h", - "$srcdir/driver-interface.h", - "$srcdir/driver-network.h", - "$srcdir/driver-nodedev.h", - "$srcdir/driver-nwfilter.h", - "$srcdir/driver-secret.h", - "$srcdir/driver-state.h", - "$srcdir/driver-storage.h", - "$srcdir/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/.*/\w+_(driver|common|tmpl|monitor|hal|udev)\.c$!) { - push @srcs, $_ if $_ !~ /vbox_driver\.c/; - } - }, no_chdir =3D> 1}, $srcdir); - -# 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, "$srcdir/../docs/libvirt-ap= i.xml"); - -# And the same for the QEMU specific APIs -parseSymsFile(\%apis, "LIBVIRT_QEMU", $symsqemu, "$srcdir/../docs/libvirt-= qemu-api.xml"); - -# And the same for the LXC specific APIs -parseSymsFile(\%apis, "LIBVIRT_LXC", $symslxc, "$srcdir/../docs/libvirt-lx= c-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/docs/hvsupport.py b/docs/hvsupport.py new file mode 100755 index 0000000000..502389c25f --- /dev/null +++ b/docs/hvsupport.py @@ -0,0 +1,463 @@ +#!/usr/bin/env python + +from __future__ import print_function + +import sys +import os.path +import re + +if len(sys.argv) !=3D 2: + print("syntax: %s SRCDIR\n" % sys.argv[0], fh=3Dsys.stderr) + +srcdir =3D sys.argv[1] + +symslibvirt =3D os.path.join(srcdir, "libvirt_public.syms") +symsqemu =3D os.path.join(srcdir, "libvirt_qemu.syms") +symslxc =3D os.path.join(srcdir, "libvirt_lxc.syms") +drivertablefiles =3D [ + os.path.join(srcdir, "driver-hypervisor.h"), + os.path.join(srcdir, "driver-interface.h"), + os.path.join(srcdir, "driver-network.h"), + os.path.join(srcdir, "driver-nodedev.h"), + os.path.join(srcdir, "driver-nwfilter.h"), + os.path.join(srcdir, "driver-secret.h"), + os.path.join(srcdir, "driver-state.h"), + os.path.join(srcdir, "driver-storage.h"), + os.path.join(srcdir, "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(srcdir): + 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: + prog =3D re.compile(r"\s* hash of APIs { fields -> api name } +groups =3D {} +ingrp =3D None +for drivertablefile in drivertablefiles: + with open(drivertablefile) as fh: + starttableprog =3D re.compile(r"struct _(vir\w*Driver)") + endtableprog =3D re.compile(r"};") + callbackprog =3D re.compile(r"^\s*vir(?:Drv)(\w+)\s+(\w+);\s*$") + ignoreapiprog =3D re.compile(r"\w+(Open|Close|URIProbe)") + for line in fh: + starttablematch =3D starttableprog.match(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 !=3D None: + callbackmatch =3D callbackprog.match(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 ignoreapiprog.match(api) !=3D None: + continue + else: + raise Exception("driver %s does not have a public = API" % name) + elif endtableprog.match(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()) + groupsprog2 =3D re.compile(r"^\s*(static\s+)?(" + groupsre + r")\s= +(\w+)\s*=3D\s*{") + groupsprog3 =3D re.compile(r"^\s*(static\s+)?(" + groupsre + r")\s= +NAME\(\w+\)\s*=3D\s*{") + nodedevimplprog =3D re.compile(r".*/node_device_(\w+)\.c") + miscimplprog =3D re.compile(r".*/(\w+?)_((\w+)_)?(\w+)\.c") + callbackprog =3D re.compile(r"\s*\.(\w+)\s*=3D\s*(\w+)\s*,?\s*(?:/= \*\s*(\d+\.\d+\.\d+)\s*(?:-\s*(\d+\.\d+\.\d+))?\s*\*/\s*)?$") + skipapiprog =3D re.compile(r"\w+(Open|Close|URIProbe)") + + ingrp =3D None + impl =3D None + for line in fh: + if ingrp is None: + m =3D groupsprog2.match(line) + if m is None: + m =3D groupsprog3.match(line) + if m is not None: + ingrp =3D m.group(2) + impl =3D src + + implmatch =3D nodedevimplprog.match(impl) + if implmatch is None: + implmatch =3D miscimplprog.match(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 callbackprog.match(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 n= o deleted version is provided" % api) + + if meth !=3D "NULL" and deleted is not None: + raise Exception("Method impl for %s is non-NULL, b= ut deleted version is provided" % api) + + if vers is None and api !=3D "connectURIProbe": + raise Exception("Method %s in %s is missing versio= n" % (meth, src)) + + if api not in groups[ingrp]["apis"]: + if skipapiprog.match(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 "virConnectOpenR= eadOnly" +groups["virHypervisorDriver"]["apis"]["domainMigrate"] =3D "virDomainMigra= te" + +openAuthVers =3D (0 * 1000 * 1000) + (4 * 1000) + 0; + +for drv in groups["virHypervisorDriver"]["drivers"].keys(): + openVersStr =3D groups["virHypervisorDriver"]["drivers"][drv]["connect= Open"]["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(openVersB= its[1]) * 1000) + int(openVersBits[2]) + + # virConnectOpenReadOnly always matches virConnectOpen version + groups["virHypervisorDriver"]["drivers"][drv]["connectOpenReadOnly"] = =3D \ + groups["virHypervisorDriver"]["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" + groups["virHypervisorDriver"]["drivers"][drv]["connectOpenAuth"] =3D { + "vers": vers, + } + + +# Another special case for the virDomainCreateLinux which was replaced +# with virDomainCreateXML +groups["virHypervisorDriver"]["apis"]["domainCreateLinux"] =3D "virDomainC= reateLinux"; + +createAPIVers =3D (0 * 1000 * 1000) + (0 * 1000) + 3; + +for drv in groups["virHypervisorDriver"]["drivers"].keys(): + if "domainCreateXML" not in groups["virHypervisorDriver"]["drivers"][d= rv]: + continue + createVersStr =3D groups["virHypervisorDriver"]["drivers"][drv]["domai= nCreateXML"]["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(creat= eVersBits[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" + + groups["virHypervisorDriver"]["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('''" % 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<= /td>''' % (htmlgrp, api, api)) + else: + print("\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