build: avoid ATTRIBUTE_UNUSED in headers

The compiler might optimize based on our declaration that something
is unused.  Putting that declaration in the header risks getting
out of sync with the actual implementation, so it belongs better
only in the .c files.  We were mostly compliant, and a new syntax
check will help us in the future.

* cfg.mk (sc_avoid_attribute_unused_in_header): New syntax check.
* src/nodeinfo.h (nodeGetCPUStats, nodeGetMemoryStats): Delete
attribute already present in .c file.
* src/qemu/qemu_domain.h (qemuDomainEventFlush): Likewise.
* src/util/virterror_internal.h (virReportErrorHelper): Parameters
are actually used by .c file.
* src/xenxs/xen_sxpr.h (xenFormatSxprDisk): Adjust prototype.
* src/xenxs/xen_sxpr.c (xenFormatSxprDisk): Delete unused argument.
(xenFormatSxpr): Adjust caller.
* src/xen/xend_internal.c (xenDaemonAttachDeviceFlags)
(xenDaemonUpdateDeviceFlags): Likewise.
Suggested by Daniel Veillard.

diff --git a/cfg.mk b/cfg.mk
index ffaca85a760edf572deb1ce914d13debf568fd3a..a35a6816250d09359b4090fb4700b6b3c90966ff 100644 (file)
--- a/cfg.mk
+++ b/cfg.mk
@@ -413,6 +413,14 @@ sc_prohibit_xmlGetProp:
        halt='use virXMLPropString, not xmlGetProp'                     \
          $(_sc_search_regexp)
 
+# ATTRIBUTE_UNUSED should only be applied in implementations, not
+# header declarations
+sc_avoid_attribute_unused_in_header:
+       @prohibit='^[^#]*ATTRIBUTE_UNUSED([^:]|$$)'                     \
+       in_vc_files='\.h$$'                                             \
+       halt='use ATTRIBUTE_UNUSED in .c rather than .h files'          \
+         $(_sc_search_regexp)
+
 # Many of the function names below came from this filter:
 # git grep -B2 '\<_('|grep -E '\.c- *[[:alpha:]_][[:alnum:]_]* ?\(.*[,;]$' \
 # |sed 's/.*\.c-  *//'|perl -pe 's/ ?\(.*//'|sort -u \

diff --git a/src/nodeinfo.h b/src/nodeinfo.h
index e5ac1e01e39d062deb147779bce365610099cac9..47661527ddf756c5c4765729ce7373203fa1f3ec 100644 (file)
--- a/src/nodeinfo.h
+++ b/src/nodeinfo.h
@@ -30,12 +30,12 @@
 int nodeGetInfo(virConnectPtr conn, virNodeInfoPtr nodeinfo);
 int nodeCapsInitNUMA(virCapsPtr caps);
 
-int nodeGetCPUStats(virConnectPtr conn ATTRIBUTE_UNUSED,
+int nodeGetCPUStats(virConnectPtr conn,
                     int cpuNum,
                     virNodeCPUStatsPtr params,
                     int *nparams,
                     unsigned int flags);
-int nodeGetMemoryStats(virConnectPtr conn ATTRIBUTE_UNUSED,
+int nodeGetMemoryStats(virConnectPtr conn,
                        int cellNum,
                        virNodeMemoryStatsPtr params,
                        int *nparams,

diff --git a/src/qemu/qemu_domain.h b/src/qemu/qemu_domain.h
index 6759c06ecacee0e425fcf4c74e08ae9de4e365f7..2ba600759cfd15b1ecf283b9667b3f256310906b 100644 (file)
--- a/src/qemu/qemu_domain.h
+++ b/src/qemu/qemu_domain.h
@@ -146,7 +146,7 @@ const char *qemuDomainAsyncJobPhaseToString(enum qemuDomainAsyncJob job,
 int qemuDomainAsyncJobPhaseFromString(enum qemuDomainAsyncJob job,
                                       const char *phase);
 
-void qemuDomainEventFlush(int timer ATTRIBUTE_UNUSED, void *opaque);
+void qemuDomainEventFlush(int timer, void *opaque);
 
 /* driver must be locked before calling */
 void qemuDomainEventQueue(struct qemud_driver *driver,

diff --git a/src/util/virterror_internal.h b/src/util/virterror_internal.h
index df4b1d21b680554f13b789865fb16b10e0762db4..d61ea0d85917db267b1fb8468044d0d8a0fec369 100644 (file)
--- a/src/util/virterror_internal.h
+++ b/src/util/virterror_internal.h
@@ -1,7 +1,7 @@
 /*
  * virterror.h: internal error handling
  *
- * Copyright (C) 2006-2009 Red Hat, Inc.
+ * Copyright (C) 2006-2009, 2011 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
@@ -56,9 +56,9 @@ void virRaiseErrorFull(const char *filename,
 
 const char *virErrorMsg(virErrorNumber error, const char *info);
 void virReportErrorHelper(int domcode, int errcode,
-                          const char *filename ATTRIBUTE_UNUSED,
-                          const char *funcname ATTRIBUTE_UNUSED,
-                          size_t linenr ATTRIBUTE_UNUSED,
+                          const char *filename,
+                          const char *funcname,
+                          size_t linenr,
                           const char *fmt, ...)
   ATTRIBUTE_FMT_PRINTF(6, 7);
 

diff --git a/src/xen/xend_internal.c b/src/xen/xend_internal.c
index e3f8750cc53bee377486883a97433a52821787dd..d0679b7543510442d1d15c6d5e0322c93b0ed598 100644 (file)
--- a/src/xen/xend_internal.c
+++ b/src/xen/xend_internal.c
@@ -2717,11 +2717,10 @@ xenDaemonAttachDeviceFlags(virDomainPtr domain, const char *xml,
 
     switch (dev->type) {
     case VIR_DOMAIN_DEVICE_DISK:
-        if (xenFormatSxprDisk(domain->conn,
-                              dev->data.disk,
-                               &buf,
-                               STREQ(def->os.type, "hvm") ? 1 : 0,
-                               priv->xendConfigVersion, 1) < 0)
+        if (xenFormatSxprDisk(dev->data.disk,
+                              &buf,
+                              STREQ(def->os.type, "hvm") ? 1 : 0,
+                              priv->xendConfigVersion, 1) < 0)
             goto cleanup;
 
         if (dev->data.disk->device != VIR_DOMAIN_DISK_DEVICE_CDROM) {
@@ -2887,8 +2886,7 @@ xenDaemonUpdateDeviceFlags(virDomainPtr domain, const char *xml,
 
     switch (dev->type) {
     case VIR_DOMAIN_DEVICE_DISK:
-        if (xenFormatSxprDisk(domain->conn,
-                              dev->data.disk,
+        if (xenFormatSxprDisk(dev->data.disk,
                               &buf,
                               STREQ(def->os.type, "hvm") ? 1 : 0,
                               priv->xendConfigVersion, 1) < 0)

diff --git a/src/xenxs/xen_sxpr.c b/src/xenxs/xen_sxpr.c
index bd770bc261a55426dddad7d9181c15c28705b9d4..4245a64527510fca72ebd57349dc7286a0b2b23b 100644 (file)
--- a/src/xenxs/xen_sxpr.c
+++ b/src/xenxs/xen_sxpr.c
@@ -1605,8 +1605,7 @@ xenFormatSxprChr(virDomainChrDefPtr def,
  * Returns 0 in case of success, -1 in case of error.
  */
 int
-xenFormatSxprDisk(virConnectPtr conn ATTRIBUTE_UNUSED,
-                  virDomainDiskDefPtr def,
+xenFormatSxprDisk(virDomainDiskDefPtr def,
                   virBufferPtr buf,
                   int hvm,
                   int xendConfigVersion,
@@ -2270,7 +2269,7 @@ xenFormatSxpr(virConnectPtr conn,
     }
 
     for (i = 0 ; i < def->ndisks ; i++)
-        if (xenFormatSxprDisk(conn, def->disks[i],
+        if (xenFormatSxprDisk(def->disks[i],
                               &buf, hvm, xendConfigVersion, 0) < 0)
             goto error;
 

diff --git a/src/xenxs/xen_sxpr.h b/src/xenxs/xen_sxpr.h
index b2f8790e94e8774b44df78d41dffcbe380d9c16f..a66c60ae30fbdb31b59dad5e5a69d8e603403200 100644 (file)
--- a/src/xenxs/xen_sxpr.h
+++ b/src/xenxs/xen_sxpr.h
@@ -46,8 +46,7 @@ int xenParseSxprSound(virDomainDefPtr def, const char *str);
 
 virDomainChrDefPtr xenParseSxprChar(const char *value, const char *tty);
 
-int xenFormatSxprDisk(virConnectPtr conn ATTRIBUTE_UNUSED,
-                      virDomainDiskDefPtr def, virBufferPtr buf, int hvm,
+int xenFormatSxprDisk(virDomainDiskDefPtr def, virBufferPtr buf, int hvm,
                       int xendConfigVersion, int isAttach);
 
 int xenFormatSxprNet(virConnectPtr conn,