maint: enforce private symbol section sorting

Automating a sorting check is the only way to ensure we don't
regress.  Suggested by Dan Berrange.

* src/check-symsorting.pl (check_sorting): Add a parameter,
validate that groups are in order, and that files exist.
* src/Makefile.am (check-symsorting): Adjust caller.
* src/libvirt_private.syms: Fix typo.
* src/libvirt_linux.syms: Fix file name.
* src/libvirt_vmx.syms: Likewise.
* src/libvirt_xenxs.syms: Likewise.
* src/libvirt_sasl.syms: Likewise.
* src/libvirt_libssh2.syms: Likewise.
* src/libvirt_esx.syms: Mention file name.
* src/libvirt_openvz.syms: Likewise.

src/Makefile.am

@@ -388,7 +388,8 @@ else
 check-symfile:
 endif
 check-symsorting:
-	$(AM_V_GEN)$(PERL) $(srcdir)/check-symsorting.pl $(USED_SYM_FILES)
+	$(AM_V_GEN)$(PERL) $(srcdir)/check-symsorting.pl \
+		$(srcdir) $(USED_SYM_FILES)
 EXTRA_DIST += check-symfile.pl check-symsorting.pl
 
 PROTOCOL_STRUCTS = \

src/check-symsorting.pl

@@ -3,22 +3,28 @@
 use strict;
 use warnings;
 
-die "syntax: $0 SYMFILE..." unless int(@ARGV) >= 1;
+die "syntax: $0 SRCDIR SYMFILE..." unless int(@ARGV) >= 2;
 
 my $ret = 0;
+my $srcdir = shift;
+my $lastgroup = undef;
 foreach my $symfile (@ARGV) {
     open SYMFILE, $symfile or die "cannot read $symfile: $!";
 
     my $line;
+    my $groupfile = "";
     my @group;
 
     while (<SYMFILE>) {
         chomp;
-        next if /^#/;
 
-        if (/^\s*$/) {
+        if (/^#\s*((\w+\/)*(\w+\.h))\s*$/) {
+            $groupfile = $1;
+        } elsif (/^#/) {
+            # Ignore comments
+        } elsif (/^\s*$/) {
             if (@group) {
-                &check_sorting(\@group, $symfile, $line);
+                &check_sorting(\@group, $symfile, $line, $groupfile);
             }
             @group = ();
             $line = $.;
@@ -30,20 +36,38 @@
 
     close SYMFILE;
     if (@group) {
-        &check_sorting(\@group, $symfile, $line);
+        &check_sorting(\@group, $symfile, $line, $groupfile);
     }
+    $lastgroup = undef;
 }
 
 sub check_sorting {
     my $group = shift;
     my $symfile = shift;
     my $line = shift;
+    my $groupfile = shift;
 
     my @group = @{$group};
     my @sorted = sort { lc $a cmp lc $b } @group;
     my $sorted = 1;
     my $first;
     my $last;
+
+    # Check that groups are in order and groupfile exists
+    if (defined $lastgroup && lc $lastgroup ge lc $groupfile) {
+        print "Symbol block at $symfile:$line: block not sorted\n";
+        print "Move $groupfile block before $lastgroup block\n";
+        print "\n";
+        $ret = 1;
+    }
+    if (! -e "$srcdir/$groupfile") {
+        print "Symbol block at $symfile:$line: $groupfile not found\n";
+        print "\n";
+        $ret = 1;
+    }
+    $lastgroup = $groupfile;
+
+    # Check that symbols within a group are in order
     for (my $i = 0 ; $i <= $#sorted ; $i++) {
         if ($sorted[$i] ne $group[$i]) {
             $first = $i unless defined $first;
@@ -54,7 +78,7 @@ sub check_sorting {
     if (!$sorted) {
         @group = splice @group, $first, ($last-$first+1);
         @sorted = splice @sorted, $first, ($last-$first+1);
-        print "Symbol block at $symfile:$line symbols not sorted\n";
+        print "Symbol block at $symfile:$line: symbols not sorted\n";
         print map { "  " . $_ . "\n" } @group;
         print "Correct ordering\n";
         print map { "  " . $_ . "\n" } @sorted;

src/libvirt_esx.syms

@@ -2,6 +2,7 @@
 # These symbols are dependent upon --with-esx via WITH_ESX
 #
 
+# esx/esx_util.h
 esxUtil_EscapeDatastoreItem;
 esxUtil_ParseDatastorePath;
 esxVI_DateTime_ConvertToCalendarTime;

src/libvirt_libssh2.syms

@@ -2,8 +2,7 @@
 # ssh session - specific symbols
 #
 
-# virnetsshsession.h
-#
+# rpc/virnetsshsession.h
 virNetSSHChannelRead;
 virNetSSHChannelWrite;
 virNetSSHSessionAuthAddAgentAuth;

src/libvirt_linux.syms

@@ -5,7 +5,7 @@
 # nodeinfo.h
 linuxNodeInfoCPUPopulate;
 
-# stats_linux.h
+# util/virstatslinux.h
 linuxDomainInterfaceStats;
 
 # Let emacs know we want case-insensitive sorting

src/libvirt_openvz.syms

@@ -1,6 +1,8 @@
 #
 # These symbols are dependent upon --with-openvz via WITH_OPENVZ
 #
+
+# openvz/openvz_conf.h
 openvzLocateConfFile;
 openvzReadConfigParam;
 openvzReadNetworkConf;

src/libvirt_private.syms

@@ -420,7 +420,7 @@ virNetDevVlanFormat;
 virNetDevVlanParse;
 
 
-# conf/netdev_vportprofile_conf.h
+# conf/netdev_vport_profile_conf.h
 virNetDevVPortProfileFormat;
 virNetDevVPortProfileParse;
 virNetDevVPortTypeFromString;

src/libvirt_sasl.syms

@@ -2,10 +2,10 @@
 # SASL-specific symbols
 #
 
-# virnetclient.h
+# rpc/virnetclient.h
 virNetClientSetSASLSession;
 
-# virnetsaslcontext.h
+# rpc/virnetsaslcontext.h
 virNetSASLContextCheckIdentity;
 virNetSASLContextNewClient;
 virNetSASLContextNewServer;
@@ -25,11 +25,11 @@ virNetSASLSessionServerStart;
 virNetSASLSessionServerStep;
 
 
-# virnetserverclient.h
+# rpc/virnetserverclient.h
 virNetServerClientSetSASLSession;
 
 
-# virnetsocket.h
+# rpc/virnetsocket.h
 virNetSocketSetSASLSession;
 
 # Let emacs know we want case-insensitive sorting

src/libvirt_vmx.syms

@@ -2,7 +2,7 @@
 # These symbols are dependent upon --with-esx via WITH_ESX or --with-vmware via WITH_VMWARE.
 #
 
-# vmx.h
+# vmx/vmx.h
 virVMXConvertToUTF8;
 virVMXEscapeHex;
 virVMXFormatCDROM;

src/libvirt_xenxs.syms

@@ -2,7 +2,7 @@
 # These symbols are dependent upon --with-xen via WITH_XEN or --with-libxl via WITH_LIBXL.
 #
 
-# xen_sxpr.h
+# xenxs/xen_sxpr.h
 xenFormatSxpr;
 xenFormatSxprChr;
 xenFormatSxprDisk;
@@ -16,7 +16,7 @@ xenParseSxprChar;
 xenParseSxprSound;
 xenParseSxprString;
 
-# xen_xm.h
+# xenxs/xen_xm.h
 xenFormatXM;
 xenParseXM;