Fix many mistakes & inconsistencies in header file layout

This introduces a syntax-check script that validates header files use a
common layout:

  /*
   ...copyright header...
   */
  <one blank line>
  #ifndef SYMBOL
  # define SYMBOL
  ....content....
  #endif /* SYMBOL */

For any file ending priv.h, before the #ifndef, we will require a
guard to prevent bogus imports:

  #ifndef SYMBOL_ALLOW
  # error ....
  #endif /* SYMBOL_ALLOW */
  <one blank line>

The many mistakes this script identifies are then fixed.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

build-aux/header-ifdef.pl

@@ -0,0 +1,149 @@
+#!/usr/bin/perl
+#
+# Validate that header files follow a standard layout:
+#
+# /*
+#  ...copyright header...
+#  */
+# <one blank line>
+# #ifndef SYMBOL
+# # define SYMBOL
+# ....content....
+# #endif /* SYMBOL */
+#
+# For any file ending priv.h, before the #ifndef
+# We will have a further section
+#
+# #ifndef SYMBOL_ALLOW
+# # error ....
+# #endif /* SYMBOL_ALLOW */
+# <one blank line>
+
+use strict;
+use warnings;
+
+my $STATE_COPYRIGHT_COMMENT = 0;
+my $STATE_COPYRIGHT_BLANK = 1;
+my $STATE_PRIV_START = 2;
+my $STATE_PRIV_ERROR = 3;
+my $STATE_PRIV_END = 4;
+my $STATE_PRIV_BLANK = 5;
+my $STATE_GUARD_START = 6;
+my $STATE_GUARD_DEFINE = 7;
+my $STATE_GUARD_END = 8;
+my $STATE_EOF = 9;
+
+my $file = " ";
+my $ret = 0;
+my $ifdef = "";
+my $ifdefpriv = "";
+
+my $state = $STATE_EOF;
+my $mistake = 0;
+
+sub mistake {
+    my $msg = shift;
+    warn $msg;
+    $mistake = 1;
+    $ret = 1;
+}
+
+while (<>) {
+    if (not $file eq $ARGV) {
+        if ($state == $STATE_COPYRIGHT_COMMENT) {
+            &mistake("$file: missing copyright comment");
+        } elsif ($state == $STATE_COPYRIGHT_BLANK) {
+            &mistake("$file: missing blank line after copyright header");
+        } elsif ($state == $STATE_PRIV_START) {
+            &mistake("$file: missing '#ifndef $ifdefpriv'");
+        } elsif ($state == $STATE_PRIV_ERROR) {
+            &mistake("$file: missing '# error ...priv allow...'");
+        } elsif ($state == $STATE_PRIV_END) {
+            &mistake("$file: missing '#endif /* $ifdefpriv */'");
+        } elsif ($state == $STATE_PRIV_BLANK) {
+            &mistake("$file: missing blank line after priv header check");
+        } elsif ($state == $STATE_GUARD_START) {
+            &mistake("$file: missing '#ifndef $ifdef'");
+        } elsif ($state == $STATE_GUARD_DEFINE) {
+            &mistake("$file: missing '# define $ifdef'");
+        } elsif ($state == $STATE_GUARD_END) {
+            &mistake("$file: missing '#endif /* $ifdef */'");
+        }
+
+        $file = $ARGV;
+        $state = $STATE_COPYRIGHT_COMMENT;
+        $mistake = 0;
+    }
+
+    if ($mistake ||
+        $ARGV eq "config-post.h" ||
+        $ARGV =~ /vbox_(CAPI|XPCOM)/) {
+        $state = $STATE_EOF;
+        next;
+    }
+
+    if ($state == $STATE_COPYRIGHT_COMMENT) {
+        if (m,\*/,) {
+            $state = $STATE_COPYRIGHT_BLANK;
+        }
+    } elsif ($state == $STATE_COPYRIGHT_BLANK) {
+        if (! /^$/) {
+            &mistake("$file: missing blank line after copyright header");
+        }
+        if ($ARGV =~ /priv\.h$/) {
+            $state = $STATE_PRIV_START;
+        } else {
+            $state = $STATE_GUARD_START;
+        }
+    } elsif ($state == $STATE_PRIV_START) {
+        if (/^$/) {
+            &mistake("$file: too many blank lines after coyright header");
+        } elsif (/#ifndef\s(.*ALLOW.*)/) {
+            $ifdefpriv = $1;
+            $state = $STATE_PRIV_ERROR;
+        } else {
+            &mistake("$file: missing '#ifndef SYMBOL_ALLOW'");
+        }
+    } elsif ($state == $STATE_PRIV_ERROR) {
+        if (/# error ".*"$/) {
+            $state = $STATE_PRIV_END;
+        } else {
+            &mistake("$file: missing '#error ...priv allow...'");
+        }
+    } elsif ($state == $STATE_PRIV_END) {
+        if (m,#endif /\* $ifdefpriv \*/,) {
+            $state = $STATE_PRIV_BLANK;
+        } else {
+            &mistake("$file: missing '#endif /* $ifdefpriv */'");
+        }
+    } elsif ($state == $STATE_PRIV_BLANK) {
+        if (! /^$/) {
+            &mistake("$file: missing blank line after priv guard");
+        }
+        $state = $STATE_GUARD_START;
+    } elsif ($state == $STATE_GUARD_START) {
+        if (/^$/) {
+            &mistake("$file: too many blank lines after coyright header");
+        } elsif (/#ifndef\s(.*)$/) {
+            $ifdef = $1;
+            $state = $STATE_GUARD_DEFINE;
+        } else {
+            &mistake("$file: missing '#ifndef SYMBOL'");
+        }
+    } elsif ($state == $STATE_GUARD_DEFINE) {
+        if (/# define $ifdef$/) {
+            $state = $STATE_GUARD_END;
+        } else {
+            &mistake("$file: missing '# define $ifdef'");
+        }
+    } elsif ($state == $STATE_GUARD_END) {
+        if (m,#endif /\* $ifdef \*/$,) {
+            $state = $STATE_EOF;
+        }
+    } elsif ($state == $STATE_EOF) {
+        die "$file: unexpected content after '#endif /* $ifdef */'";
+    } else {
+        die "$file: unexpected state $state";
+    }
+}
+exit $ret;

cfg.mk

@@ -1122,7 +1122,8 @@ _autogen_error:
 
 ifneq ($(_gl-Makefile),)
 syntax-check: spacing-check test-wrap-argv \
-	prohibit-duplicate-header mock-noinline group-qemu-caps
+	prohibit-duplicate-header mock-noinline group-qemu-caps \
+        header-ifdef
 endif
 
 # Don't include duplicate header in the source (either *.c or *.h)
@@ -1139,6 +1140,10 @@ mock-noinline:
 	$(AM_V_GEN)files=`$(VC_LIST) | grep '\.[ch]$$'`; \
 	$(PERL) $(top_srcdir)/build-aux/mock-noinline.pl $$files
 
+header-ifdef:
+	$(AM_V_GEN)files=`$(VC_LIST) | grep '\.[h]$$'`; \
+	$(PERL) $(top_srcdir)/build-aux/header-ifdef.pl $$files
+
 test-wrap-argv:
 	$(AM_V_GEN)files=`$(VC_LIST) | grep -E '\.(ldargs|args)'`; \
 	$(PERL) $(top_srcdir)/tests/test-wrap-argv.pl --check $$files

src/bhyve/bhyve_capabilities.h

@@ -55,4 +55,4 @@ typedef enum {
 int virBhyveProbeGrubCaps(virBhyveGrubCapsFlags *caps);
 int virBhyveProbeCaps(unsigned int *caps);
 
-#endif
+#endif /* _BHYVE_CAPABILITIES */

src/bhyve/bhyve_parse_command.h

@@ -25,4 +25,4 @@ virDomainDefPtr bhyveParseCommandLineString(const char* nativeConfig,
                                             unsigned caps,
                                             virDomainXMLOptionPtr xmlopt);
 
-#endif /* __BHYVE_PARSE_COMMAND_H__*/
+#endif /* __BHYVE_PARSE_COMMAND_H__ */

src/conf/domain_event.h

@@ -20,11 +20,10 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "internal.h"
-
 #ifndef __DOMAIN_EVENT_H__
 # define __DOMAIN_EVENT_H__
 
+# include "internal.h"
 # include "object_event.h"
 # include "domain_conf.h"
 
@@ -325,4 +324,4 @@ virDomainQemuMonitorEventNew(int id,
                              const char *details)
     ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
 
-#endif
+#endif /* __DOMAIN_EVENT_H__ */

src/conf/domain_nwfilter.h

@@ -18,6 +18,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef DOMAIN_NWFILTER_H
 # define DOMAIN_NWFILTER_H
 

src/conf/netdev_vlan_conf.h

@@ -27,4 +27,4 @@
 int virNetDevVlanParse(xmlNodePtr node, xmlXPathContextPtr ctxt, virNetDevVlanPtr def);
 int virNetDevVlanFormat(const virNetDevVlan *def, virBufferPtr buf);
 
-#endif /* __VIR_NETDEV_VPORT_PROFILE_CONF_H__ */
+#endif /* __VIR_NETDEV_VLAN_CONF_H__ */

src/conf/network_event.h

@@ -19,13 +19,13 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "internal.h"
-#include "object_event.h"
-#include "object_event_private.h"
-
 #ifndef __NETWORK_EVENT_H__
 # define __NETWORK_EVENT_H__
 
+# include "internal.h"
+# include "object_event.h"
+# include "object_event_private.h"
+
 int
 virNetworkEventStateRegisterID(virConnectPtr conn,
                                virObjectEventStatePtr state,
@@ -56,4 +56,4 @@ virNetworkEventLifecycleNew(const char *name,
                             int type,
                             int detail);
 
-#endif
+#endif /* __NETWORK_EVENT_H__ */

src/conf/node_device_event.h

@@ -20,13 +20,13 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "internal.h"
-#include "object_event.h"
-#include "object_event_private.h"
-
 #ifndef __NODE_DEVICE_EVENT_H__
 # define __NODE_DEVICE_EVENT_H__
 
+# include "internal.h"
+# include "object_event.h"
+# include "object_event_private.h"
+
 int
 virNodeDeviceEventStateRegisterID(virConnectPtr conn,
                                   virObjectEventStatePtr state,
@@ -59,4 +59,4 @@ virNodeDeviceEventLifecycleNew(const char *name,
 virObjectEventPtr
 virNodeDeviceEventUpdateNew(const char *name);
 
-#endif
+#endif /* __NODE_DEVICE_EVENT_H__ */

src/conf/nwfilter_conf.h

@@ -21,6 +21,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef NWFILTER_CONF_H
 # define NWFILTER_CONF_H
 

src/conf/nwfilter_params.h

@@ -18,6 +18,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef NWFILTER_PARAMS_H
 # define NWFILTER_PARAMS_H
 

src/conf/object_event.h

@@ -20,13 +20,13 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "internal.h"
-
-#include "virobject.h"
-
 #ifndef __OBJECT_EVENT_H__
 # define __OBJECT_EVENT_H__
 
+# include "internal.h"
+
+# include "virobject.h"
+
 /**
  * Dispatching domain events that come in while
  * in a call / response rpc
@@ -89,4 +89,4 @@ virObjectEventStateSetRemote(virConnectPtr conn,
                              int remoteID)
     ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
 
-#endif
+#endif /* __OBJECT_EVENT_H__ */

src/conf/object_event_private.h

@@ -20,11 +20,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "datatypes.h"
-
 #ifndef __OBJECT_EVENT_PRIVATE_H__
 # define __OBJECT_EVENT_PRIVATE_H__
 
+# include "datatypes.h"
+
 struct _virObjectMeta {
     int id;
     char *name;
@@ -106,4 +106,4 @@ virObjectEventNew(virClassPtr klass,
     ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(5)
     ATTRIBUTE_NONNULL(7);
 
-#endif
+#endif /* __OBJECT_EVENT_PRIVATE_H__ */

src/conf/secret_conf.h

@@ -52,5 +52,4 @@ char *virSecretDefFormat(const virSecretDef *def);
                 (VIR_CONNECT_LIST_SECRETS_FILTERS_EPHEMERAL  | \
                  VIR_CONNECT_LIST_SECRETS_FILTERS_PRIVATE)
 
-
+#endif /* __VIR_SECRET_CONF_H__ */
-#endif

src/conf/secret_event.h

@@ -20,13 +20,13 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include "internal.h"
-#include "object_event.h"
-#include "object_event_private.h"
-
 #ifndef __SECRET_EVENT_H__
 # define __SECRET_EVENT_H__
 
+# include "internal.h"
+# include "object_event.h"
+# include "object_event_private.h"
+
 int
 virSecretEventStateRegisterID(virConnectPtr conn,
                               virObjectEventStatePtr state,
@@ -62,4 +62,4 @@ virSecretEventValueChangedNew(const unsigned char *uuid,
                               int usage_type,
                               const char *usage_id);
 
-#endif
+#endif /* __SECRET_EVENT_H__ */

src/conf/storage_event.h

@@ -20,13 +20,13 @@
  * <http://www.gnu.org/licenses/>.
 */
 
-#include "internal.h"
-#include "object_event.h"
-#include "object_event_private.h"
-
 #ifndef __STORAGE_EVENT_H__
 # define __STORAGE_EVENT_H__
 
+# include "internal.h"
+# include "object_event.h"
+# include "object_event_private.h"
+
 int
 virStoragePoolEventStateRegisterID(virConnectPtr conn,
                                    virObjectEventStatePtr state,
@@ -61,4 +61,4 @@ virObjectEventPtr
 virStoragePoolEventRefreshNew(const char *name,
                               const unsigned char *uuid);
 
-#endif
+#endif /* __STORAGE_EVENT_H__ */

src/conf/virchrdev.h

@@ -18,6 +18,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_CHRDEV_H__
 # define __VIR_CHRDEV_H__
 
@@ -32,4 +33,5 @@ void virChrdevFree(virChrdevsPtr devs);
 
 int virChrdevOpen(virChrdevsPtr devs, virDomainChrSourceDefPtr source,
                   virStreamPtr st, bool force);
-#endif /*__VIR_CHRDEV_H__*/
+
+#endif /* __VIR_CHRDEV_H__ */

src/conf/virnwfilterbindingdef.h

@@ -18,6 +18,7 @@
  * <http://www.gnu.org/licenses/>.
  *
  */
+
 #ifndef VIR_NWFILTER_BINDING_DEF_H
 # define VIR_NWFILTER_BINDING_DEF_H
 

src/conf/virnwfilterbindingobj.h

@@ -18,6 +18,7 @@
  * <http://www.gnu.org/licenses/>.
  *
  */
+
 #ifndef VIR_NWFILTER_BINDING_OBJ_H
 # define VIR_NWFILTER_BINDING_OBJ_H
 

src/conf/virnwfilterobj.h

@@ -16,6 +16,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef VIRNWFILTEROBJ_H
 # define VIRNWFILTEROBJ_H
 

src/conf/virsavecookie.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_SAVE_COOKIE_H__
 # define __VIR_SAVE_COOKIE_H__
 
@@ -59,4 +60,4 @@ char *
 virSaveCookieFormat(virObjectPtr obj,
                     virSaveCookieCallbacksPtr saveCookie);
 
-#endif /*__VIR_SAVE_COOKIE_H__ */
+#endif /* __VIR_SAVE_COOKIE_H__ */

src/datatypes.h

@@ -777,4 +777,4 @@ int virAdmConnectCloseCallbackDataRegister(virAdmConnectCloseCallbackDataPtr cbd
 int virAdmConnectCloseCallbackDataUnregister(virAdmConnectCloseCallbackDataPtr cbdata,
                                              virAdmConnectCloseFunc cb);
 
-#endif /* __VIR_DATATYPES_H__ */
+#endif /* __VIR_DATATYPES_H_ */

src/interface/interface_driver.h

@@ -18,7 +18,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __VIR_INTERFACE__DRIVER_H
 # define __VIR_INTERFACE__DRIVER_H
 

src/internal.h

@@ -513,4 +513,4 @@ enum {
 #  define ENODATA EIO
 # endif
 
-#endif                          /* __VIR_INTERNAL_H__ */
+#endif /* __VIR_INTERNAL_H__ */

src/libvirt_internal.h

@@ -298,4 +298,4 @@ int virStreamInData(virStreamPtr stream,
                     int *data,
                     long long *length);
 
-#endif
+#endif /* __LIBVIRT_H_ */

src/libxl/libxl_migration.h

@@ -98,4 +98,4 @@ libxlDomainMigrationSrcConfirm(libxlDriverPrivatePtr driver,
                                unsigned int flags,
                                int cancelled);
 
-#endif /* LIBXL_DRIVER_H */
+#endif /* LIBXL_MIGRATION_H */

src/locking/lock_daemon_config.h

@@ -43,4 +43,4 @@ int virLockDaemonConfigLoadFile(virLockDaemonConfigPtr data,
                                 const char *filename,
                                 bool allow_missing);
 
-#endif /* __LIBVIRTD_CONFIG_H__ */
+#endif /* __VIR_LOCK_DAEMON_CONFIG_H__ */

src/logging/log_daemon_config.h

@@ -46,4 +46,4 @@ int virLogDaemonConfigLoadFile(virLogDaemonConfigPtr data,
                                const char *filename,
                                bool allow_missing);
 
-#endif /* __LIBVIRTD_CONFIG_H__ */
+#endif /* __VIR_LOG_DAEMON_CONFIG_H__ */

src/logging/log_handler.h

@@ -77,4 +77,4 @@ int virLogHandlerDomainAppendLogFile(virLogHandlerPtr handler,
 
 virJSONValuePtr virLogHandlerPreExecRestart(virLogHandlerPtr handler);
 
-#endif /** __VIR_LOG_HANDLER_H__ */
+#endif /* __VIR_LOG_HANDLER_H__ */

src/logging/log_manager.h

@@ -18,7 +18,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __VIR_LOG_MANAGER_H__
 # define __VIR_LOG_MANAGER_H__
 

src/lxc/lxc_domain.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __LXC_DOMAIN_H__
 # define __LXC_DOMAIN_H__
 

src/network/bridge_driver.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __VIR_NETWORK__DRIVER_H
 # define __VIR_NETWORK__DRIVER_H
 

src/node_device/node_device_udev.h

@@ -18,8 +18,13 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-#include <libudev.h>
+#ifndef __NODE_DEVICE_UDEV_H__
+# define __NODE_DEVICE_UDEV_H__
 
-#define SYSFS_DATA_SIZE 4096
+# include <libudev.h>
-#define DMI_DEVPATH "/sys/devices/virtual/dmi/id"
+
-#define DMI_DEVPATH_FALLBACK "/sys/class/dmi/id"
+# define SYSFS_DATA_SIZE 4096
+# define DMI_DEVPATH "/sys/devices/virtual/dmi/id"
+# define DMI_DEVPATH_FALLBACK "/sys/class/dmi/id"
+
+#endif /* __NODE_DEVICE_UDEV_H__ */

src/nwfilter/nwfilter_ebiptables_driver.h

@@ -18,6 +18,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef VIR_NWFILTER_EBTABLES_DRIVER_H__
 # define VIR_NWFILTER_EBTABLES_DRIVER_H__
 
@@ -31,4 +32,4 @@ extern virNWFilterTechDriver ebiptables_driver;
 
 # define IPTABLES_MAX_COMMENT_LENGTH  256
 
-#endif
+#endif /* VIR_NWFILTER_EBTABLES_DRIVER_H__ */

src/nwfilter/nwfilter_gentech_driver.h

@@ -19,6 +19,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __NWFILTER_GENTECH_DRIVER_H
 # define __NWFILTER_GENTECH_DRIVER_H
 
@@ -55,4 +56,4 @@ virHashTablePtr virNWFilterCreateVarHashmap(const char *macaddr,
 int virNWFilterBuildAll(virNWFilterDriverStatePtr driver,
                         bool newFilters);
 
-#endif
+#endif /* __NWFILTER_GENTECH_DRIVER_H */

src/openvz/openvz_driver.h

@@ -20,7 +20,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef OPENVZ_DRIVER_H
 # define OPENVZ_DRIVER_H
 
@@ -38,4 +37,4 @@
 
 int openvzRegister(void);
 
-#endif
+#endif /* OPENVZ_DRIVER_H */

src/openvz/openvz_util.h

@@ -19,11 +19,10 @@
  *
  */
 
-
 #ifndef OPENVZ_UTIL_H
 # define OPENVZ_UTIL_H
 
 long openvzKBPerPages(void);
 char *openvzVEGetStringParam(virDomainPtr dom, const char *param);
 
-#endif
+#endif /* OPENVZ_UTIL_H */

src/qemu/qemu_agent.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __QEMU_AGENT_H__
 # define __QEMU_AGENT_H__
 

src/qemu/qemu_alias.h

@@ -97,4 +97,4 @@ const char *qemuDomainGetManagedPRAlias(void);
 
 char *qemuDomainGetUnmanagedPRAlias(const char *parentalias);
 
-#endif /* __QEMU_ALIAS_H__*/
+#endif /* __QEMU_ALIAS_H__ */

src/qemu/qemu_capabilities.h

@@ -636,4 +636,4 @@ bool virQEMUCapsCPUFilterFeatures(const char *name,
 virSEVCapabilityPtr
 virQEMUCapsGetSEVCapabilities(virQEMUCapsPtr qemuCaps);
 
-#endif /* __QEMU_CAPABILITIES_H__*/
+#endif /* __QEMU_CAPABILITIES_H__ */

src/qemu/qemu_capspriv.h

@@ -21,7 +21,7 @@
 
 #ifndef __QEMU_CAPSPRIV_H_ALLOW__
 # error "qemu_capspriv.h may only be included by qemu_capabilities.c or test suites"
-#endif
+#endif /* __QEMU_CAPSPRIV_H_ALLOW__ */
 
 #ifndef __QEMU_CAPSPRIV_H__
 # define __QEMU_CAPSPRIV_H__
@@ -98,4 +98,5 @@ virQEMUCapsSetMicrocodeVersion(virQEMUCapsPtr qemuCaps,
 
 void
 virQEMUCapsStripMachineAliases(virQEMUCapsPtr qemuCaps);
-#endif
+
+#endif /* __QEMU_CAPSPRIV_H__ */

src/qemu/qemu_command.h

@@ -227,4 +227,4 @@ qemuBuildTPMOpenBackendFDs(const char *tpmdev,
     ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
     ATTRIBUTE_NONNULL(4);
 
-#endif /* __QEMU_COMMAND_H__*/
+#endif /* __QEMU_COMMAND_H__ */

src/qemu/qemu_domain_address.h

@@ -20,6 +20,7 @@
  */
 
 #ifndef __QEMU_DOMAIN_ADDRESS_H__
+# define __QEMU_DOMAIN_ADDRESS_H__
 
 # include "domain_addr.h"
 # include "domain_conf.h"
@@ -65,6 +66,4 @@ int qemuDomainEnsureVirtioAddress(bool *releaseAddr,
                                   virDomainDeviceDefPtr dev,
                                   const char *devicename);
 
-# define __QEMU_DOMAIN_ADDRESS_H__
-
 #endif /* __QEMU_DOMAIN_ADDRESS_H__ */

src/qemu/qemu_extdevice.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __QEMU_EXTDEVICE_H__
 # define __QEMU_EXTDEVICE_H__
 

src/qemu/qemu_hotplug.c

@@ -23,6 +23,7 @@
 #include <config.h>
 
 #include "qemu_hotplug.h"
+#define __QEMU_HOTPLUGPRIV_H_ALLOW__
 #include "qemu_hotplugpriv.h"
 #include "qemu_alias.h"
 #include "qemu_capabilities.h"

src/qemu/qemu_hotplugpriv.h

@@ -19,6 +19,10 @@
  *
  */
 
+#ifndef __QEMU_HOTPLUGPRIV_H_ALLOW__
+# error "qemu_hotplugpriv.h may only be included by qemu_hotplug.c or test suites"
+#endif /* __QEMU_HOTPLUGPRIV_H_ALLOW__ */
+
 #ifndef __QEMU_HOTPLUGPRIV_H__
 # define __QEMU_HOTPLUGPRIV_H__
 

src/qemu/qemu_migration_params.c

@@ -30,6 +30,7 @@
 #include "qemu_hotplug.h"
 #include "qemu_migration.h"
 #include "qemu_migration_params.h"
+#define __QEMU_MIGRATION_PARAMSPRIV_H_ALLOW__
 #include "qemu_migration_paramspriv.h"
 #include "qemu_monitor.h"
 

src/qemu/qemu_migration_paramspriv.h

@@ -19,6 +19,10 @@
  *
  */
 
+#ifndef __QEMU_MIGRATION_PARAMSPRIV_H_ALLOW__
+# error "qemu_migration_paramspriv.h may only be included by qemu_migration_params.c or test suites"
+#endif /* __QEMU_MIGRATION_PARAMSPRIV_H_ALLOW__ */
+
 #ifndef __QEMU_MIGRATION_PARAMSPRIV_H__
 # define __QEMU_MIGRATION_PARAMSPRIV_H__
 

src/qemu/qemu_monitor.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef QEMU_MONITOR_H
 # define QEMU_MONITOR_H
 

src/qemu/qemu_monitor_json.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef QEMU_MONITOR_JSON_H
 # define QEMU_MONITOR_JSON_H
 

src/qemu/qemu_monitor_priv.h

@@ -18,7 +18,7 @@
 
 #ifndef __QEMU_MONITOR_PRIV_H_ALLOW__
 # error "qemu_monitor_priv.h may only be included by qemu_monitor.c or test suites"
-#endif
+#endif /* __QEMU_MONITOR_PRIV_H_ALLOW__ */
 
 #ifndef __QEMU_MONITOR_PRIV_H__
 # define __QEMU_MONITOR_PRIV_H__
@@ -28,4 +28,4 @@
 void
 qemuMonitorResetCommandID(qemuMonitorPtr mon);
 
-#endif
+#endif /* __QEMU_MONITOR_PRIV_H__ */

src/qemu/qemu_monitor_text.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef QEMU_MONITOR_TEXT_H
 # define QEMU_MONITOR_TEXT_H
 

src/qemu/qemu_parse_command.h

@@ -57,4 +57,4 @@ qemuParseKeywords(const char *str,
                   int *retnkeywords,
                   int allowEmptyValue);
 
-#endif /* __QEMU_PARSE_COMMAND_H__*/
+#endif /* __QEMU_PARSE_COMMAND_H__ */

src/qemu/qemu_process.c

@@ -35,6 +35,7 @@
 #include <sys/utsname.h>
 
 #include "qemu_process.h"
+#define __QEMU_PROCESS_PRIV_H_ALLOW__
 #include "qemu_processpriv.h"
 #include "qemu_alias.h"
 #include "qemu_block.h"

src/qemu/qemu_processpriv.h

@@ -19,6 +19,10 @@
  *
  */
 
+#ifndef __QEMU_PROCESS_PRIV_H_ALLOW__
+# error "qemu_process_priv.h may only be included by qemu_process.c or test suites"
+#endif /* __QEMU_PROCESS_PRIV_H_ALLOW__ */
+
 #ifndef __QEMU_PROCESSPRIV_H__
 # define __QEMU_PROCESSPRIV_H__
 

src/qemu/qemu_tpm.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __QEMU_TPM_H__
 # define __QEMU_TPM_H__
 

src/remote/remote_daemon.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __REMOTE_DAEMON_H__
 # define __REMOTE_DAEMON_H__
 

src/remote/remote_daemon_stream.h

@@ -18,7 +18,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef __REMOTE_DAEMON_STREAM_H__
 # define __REMOTE_DAEMON_STREAM_H__
 

src/rpc/virnetlibsshsession.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_NET_LIBSSH_SESSION_H__
 # define __VIR_NET_LIBSSH_SESSION_H__
 
@@ -72,4 +73,4 @@ ssize_t virNetLibsshChannelWrite(virNetLibsshSessionPtr sess,
 
 bool virNetLibsshSessionHasCachedData(virNetLibsshSessionPtr sess);
 
-#endif /* ___VIR_NET_LIBSSH_SESSION_H_ */
+#endif /* __VIR_NET_LIBSSH_SESSION_H__ */

src/rpc/virnetserverservice.h

@@ -88,4 +88,4 @@ void virNetServerServiceToggle(virNetServerServicePtr svc,
 
 void virNetServerServiceClose(virNetServerServicePtr svc);
 
-#endif
+#endif /* __VIR_NET_SERVER_SERVICE_H__ */

src/rpc/virnetsshsession.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_NET_SSH_SESSION_H__
 # define __VIR_NET_SSH_SESSION_H__
 
@@ -84,4 +85,4 @@ ssize_t virNetSSHChannelWrite(virNetSSHSessionPtr sess,
 
 bool virNetSSHSessionHasCachedData(virNetSSHSessionPtr sess);
 
-#endif /* ___VIR_NET_SSH_SESSION_H_ */
+#endif /* __VIR_NET_SSH_SESSION_H__ */

src/rpc/virnettlscontext.h

@@ -100,4 +100,4 @@ int virNetTLSSessionGetKeySize(virNetTLSSessionPtr sess);
 
 const char *virNetTLSSessionGetX509DName(virNetTLSSessionPtr sess);
 
-#endif
+#endif /* __VIR_NET_TLS_CONTEXT_H__ */

src/security/security_apparmor.h

@@ -15,6 +15,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_SECURITY_APPARMOR_H__
 # define __VIR_SECURITY_APPARMOR_H__
 

src/security/security_dac.h

@@ -18,11 +18,11 @@
  * POSIX DAC security driver
  */
 
-#include "security_driver.h"
-
 #ifndef __VIR_SECURITY_DAC
 # define __VIR_SECURITY_DAC
 
+# include "security_driver.h"
+
 extern virSecurityDriver virSecurityDriverDAC;
 
 int virSecurityDACSetUserAndGroup(virSecurityManagerPtr mgr,

src/security/security_driver.h

@@ -15,6 +15,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_SECURITY_H__
 # define __VIR_SECURITY_H__
 

src/security/security_selinux.h

@@ -15,6 +15,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_SECURITY_SELINUX_H__
 # define __VIR_SECURITY_SELINUX_H__
 

src/security/security_stack.h

@@ -18,11 +18,11 @@
  * Stacked security driver
  */
 
-#include "security_driver.h"
-
 #ifndef __VIR_SECURITY_STACK
 # define __VIR_SECURITY_STACK
 
+# include "security_driver.h"
+
 extern virSecurityDriver virSecurityDriverStack;
 
 

src/storage/storage_backend_iscsi_direct.h

@@ -1,3 +1,19 @@
+/*
+ * 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
+ * <http://www.gnu.org/licenses/>.
+ */
+
 #ifndef __VIR_STORAGE_BACKEND_ISCSI_H__
 # define __VIR_STORAGE_BACKEND_ISCSI_H__
 

src/storage/storage_backend_sheepdog.c

@@ -25,6 +25,7 @@
 
 #include "virerror.h"
 #include "storage_backend_sheepdog.h"
+#define __VIR_STORAGE_BACKEND_SHEEPDOG_PRIV_ALLOW_H__
 #include "storage_backend_sheepdog_priv.h"
 #include "storage_conf.h"
 #include "vircommand.h"

src/storage/storage_backend_sheepdog_priv.h

@@ -16,6 +16,10 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+#ifndef __VIR_STORAGE_BACKEND_SHEEPDOG_PRIV_ALLOW_H__
+# error "storage_backend_sheepdog_priv.h may only be included by storage_backend_sheepdog.c or test suites"
+#endif /* __VIR_STORAGE_BACKEND_SHEEPDOG_PRIV_ALLOW_H__ */
+
 #ifndef __VIR_STORAGE_BACKEND_SHEEPDOG_PRIV_H__
 # define __VIR_STORAGE_BACKEND_SHEEPDOG_PRIV_H__
 

src/uml/uml_driver.h

@@ -19,7 +19,6 @@
  * <http://www.gnu.org/licenses/>.
  */
 
-
 #ifndef UML_DRIVER_H
 # define UML_DRIVER_H
 

src/util/viralloc.h

@@ -20,7 +20,6 @@
  *
  */
 
-
 #ifndef __VIR_MEMORY_H_
 # define __VIR_MEMORY_H_
 

src/util/viratomic.h

@@ -451,4 +451,4 @@ virAtomicIntXor(volatile unsigned int *atomic,
 
 # endif
 
-#endif /* __VIR_ATOMIC_H */
+#endif /* __VIR_ATOMIC_H__ */

src/util/viraudit.h

@@ -19,7 +19,6 @@
  *
  */
 
-
 #ifndef __LIBVIRT_AUDIT_H__
 # define __LIBVIRT_AUDIT_H__
 

src/util/virbitmap.h

@@ -156,4 +156,4 @@ void virBitmapShrink(virBitmapPtr map, size_t b);
 
 VIR_DEFINE_AUTOPTR_FUNC(virBitmap, virBitmapFree)
 
-#endif
+#endif /* __BITMAP_H__ */

src/util/vircgrouppriv.h

@@ -21,7 +21,7 @@
 
 #ifndef __VIR_CGROUP_ALLOW_INCLUDE_PRIV_H__
 # error "vircgrouppriv.h may only be included by vircgroup.c or its test suite"
-#endif
+#endif /* __VIR_CGROUP_ALLOW_INCLUDE_PRIV_H__ */
 
 #ifndef __VIR_CGROUP_PRIV_H__
 # define __VIR_CGROUP_PRIV_H__

src/util/vircommandpriv.h

@@ -21,7 +21,7 @@
 
 #ifndef __VIR_COMMAND_PRIV_H_ALLOW__
 # error "vircommandpriv.h may only be included by vircommand.c or test suites"
-#endif
+#endif /* __VIR_COMMAND_PRIV_H_ALLOW__ */
 
 #ifndef __VIR_COMMAND_PRIV_H__
 # define __VIR_COMMAND_PRIV_H__

src/util/virdbus.c

@@ -21,6 +21,7 @@
 
 #include <config.h>
 
+#define __VIR_DBUS_PRIV_H_ALLOW__
 #include "virdbuspriv.h"
 #include "viralloc.h"
 #include "virerror.h"

src/util/virdbuspriv.h

@@ -19,6 +19,10 @@
  *
  */
 
+#ifndef __VIR_DBUS_PRIV_H_ALLOW__
+# error "virdbuspriv.h may only be included by virdbus.c or test suites"
+#endif /* __VIR_DBUS_PRIV_H_ALLOW__ */
+
 #ifndef __VIR_DBUS_PRIV_H__
 # define __VIR_DBUS_PRIV_H__
 

src/util/virebtables.h

@@ -38,4 +38,4 @@ int              ebtablesRemoveForwardAllowIn    (ebtablesContext *ctx,
 
 int              ebtablesAddForwardPolicyReject(ebtablesContext *ctx);
 
-#endif /* __QEMUD_ebtabLES_H__ */
+#endif /* __QEMUD_EBTABLES_H__ */

src/util/virerror.h

@@ -208,4 +208,4 @@ void virErrorRestore(virErrorPtr *savederr);
 
 VIR_DEFINE_AUTOPTR_FUNC(virError, virFreeError)
 
-#endif
+#endif /* __VIRT_ERROR_H_ */

src/util/vireventpoll.h

@@ -127,4 +127,4 @@ int virEventPollToNativeEvents(int events);
 int virEventPollInterrupt(void);
 
 
-#endif /* __VIRTD_EVENT_H__ */
+#endif /* __VIR_EVENT_POLL_H__ */

src/util/virfcp.h

@@ -29,4 +29,4 @@ virFCReadRportValue(const char *rport,
                     const char *entry,
                     char **result);
 
-#endif
+#endif /* __VIR_FCP_H__ */

src/util/virfdstream.h

@@ -19,7 +19,6 @@
  *
  */
 
-
 #ifndef __VIR_FDSTREAM_H_
 # define __VIR_FDSTREAM_H_
 

src/util/virfile.h

@@ -22,7 +22,6 @@
  *
  */
 
-
 #ifndef __VIR_FILE_H_
 # define __VIR_FILE_H_
 
@@ -383,4 +382,4 @@ int virFileInData(int fd,
 
 VIR_DEFINE_AUTOPTR_FUNC(virFileWrapperFd, virFileWrapperFdFree)
 
-#endif /* __VIR_FILE_H */
+#endif /* __VIR_FILE_H_ */

src/util/virfirewallpriv.h

@@ -20,7 +20,7 @@
 
 #ifndef __VIR_FIREWALL_PRIV_H_ALLOW__
 # error "virfirewallpriv.h may only be included by virfirewall.c or test suites"
-#endif
+#endif /* __VIR_FIREWALL_PRIV_H_ALLOW__ */
 
 #ifndef __VIR_FIREWALL_PRIV_H__
 # define __VIR_FIREWALL_PRIV_H__

src/util/virgettext.h

@@ -17,6 +17,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_GETTEXT_H__
 # define __VIR_GETTEXT_H__
 

src/util/virhash.h

@@ -199,4 +199,4 @@ void virHashValueFree(void *value, const void *name);
 
 VIR_DEFINE_AUTOPTR_FUNC(virHashTable, virHashFree)
 
-#endif                          /* ! __VIR_HASH_H__ */
+#endif /* __VIR_HASH_H__ */

src/util/virhostcpu.c

@@ -40,6 +40,7 @@
 
 #include "c-ctype.h"
 #include "viralloc.h"
+#define __VIR_HOSTCPU_PRIV_H_ALLOW__
 #include "virhostcpupriv.h"
 #include "physmem.h"
 #include "virerror.h"

src/util/virhostcpu.h

@@ -66,4 +66,4 @@ int virHostCPUGetOnline(unsigned int cpu, bool *online);
 
 unsigned int virHostCPUGetMicrocodeVersion(void);
 
-#endif /* __VIR_HOSTCPU_H__*/
+#endif /* __VIR_HOSTCPU_H__ */

src/util/virhostcpupriv.h

@@ -19,6 +19,10 @@
  *
  */
 
+#ifndef __VIR_HOSTCPU_PRIV_H_ALLOW__
+# error "virhostcpupriv.h may only be included by virhostcpu.c or test suites"
+#endif /* __VIR_HOSTCPU_PRIV_H_ALLOW__ */
+
 #ifndef __VIR_HOSTCPU_PRIV_H__
 # define __VIR_HOSTCPU_PRIV_H__
 

src/util/virhostmem.h

@@ -55,4 +55,4 @@ int virHostMemAllocPages(unsigned int npages,
                          unsigned int cellCount,
                          bool add);
 
-#endif /* __VIR_HOSTMEM_H__*/
+#endif /* __VIR_HOSTMEM_H__ */

src/util/virinitctl.h

@@ -35,4 +35,4 @@ typedef enum {
 
 int virInitctlSetRunLevel(virInitctlRunLevel level);
 
-#endif
+#endif /* __VIR_INITCTL_H__ */

src/util/viriscsi.h

@@ -68,4 +68,5 @@ virISCSINodeUpdate(const char *portal,
                    const char *value)
     ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
     ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;
-#endif
+
+#endif /* __VIR_ISCSI_H__ */

src/util/virjson.h

@@ -20,7 +20,6 @@
  *
  */
 
-
 #ifndef __VIR_JSON_H_
 # define __VIR_JSON_H_
 

src/util/virkeycode.h

@@ -30,4 +30,4 @@ int virKeycodeValueTranslate(virKeycodeSet from_codeset,
                         virKeycodeSet to_offset,
                         int key_value);
 
-#endif
+#endif /* __VIR_UTIL_VIRTKEYCODE_H__ */

src/util/virlease.h

@@ -41,4 +41,5 @@ int virLeaseNew(virJSONValuePtr *lease_ret,
                 const char *hostname,
                 const char *iaid,
                 const char *server_duid);
-#endif /* __VIR_LEASE_H */
+
+#endif /* __VIR_LEASE_H_ */

src/util/virlog.h

@@ -239,4 +239,4 @@ int virLogParseOutputs(const char *src,
 int virLogParseFilters(const char *src,
                        virLogFilterPtr **filters) ATTRIBUTE_NONNULL(1);
 
-#endif
+#endif /* __VIRTLOG_H_ */

src/util/virmacmap.h

@@ -46,4 +46,5 @@ int virMacMapWriteFile(virMacMapPtr mgr,
 
 int virMacMapDumpStr(virMacMapPtr mgr,
                      char **str);
-#endif /* __VIR_MACMAPPING_H__ */
+
+#endif /* __VIR_MACMAP_H__ */

src/util/virnetdevvlan.h

@@ -15,6 +15,7 @@
  * License along with this library.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
+
 #ifndef __VIR_NETDEV_VLAN_H__
 # define __VIR_NETDEV_VLAN_H__