From 415e0bcc80b350fc75f325b490560f44ba419b20 Mon Sep 17 00:00:00 2001
From: Xavier Hernandez <jahernan@redhat.com>
Date: Tue, 12 Dec 2017 22:31:53 +0100
Subject: all: Simplify component message id's definition

This patch creates a new way of defining message id's that is easier
and less error prone because it doesn't require so many manual changes
each time a new component is defined or a new message created.

Change-Id: I71ba8af9ac068f5add7e74f316a2478bc991c67b
Signed-off-by: Xavier Hernandez <jahernan@redhat.com>
---
 .../read-ahead/src/read-ahead-messages.h           | 109 +++------------------
 1 file changed, 16 insertions(+), 93 deletions(-)

(limited to 'xlators/performance/read-ahead/src/read-ahead-messages.h')

diff --git a/xlators/performance/read-ahead/src/read-ahead-messages.h b/xlators/performance/read-ahead/src/read-ahead-messages.h
index e6eaab10777..b2e6a1bced7 100644
--- a/xlators/performance/read-ahead/src/read-ahead-messages.h
+++ b/xlators/performance/read-ahead/src/read-ahead-messages.h
@@ -12,100 +12,23 @@
 
 #include "glfs-message-id.h"
 
-/*! \file read-ahead-messages.h
- *  \brief READ_AHEAD log-message IDs and their descriptions
+/* To add new message IDs, append new identifiers at the end of the list.
  *
- */
-
-/* NOTE: Rules for message additions
- * 1) Each instance of a message is _better_ left with a unique message ID, even
- *    if the message format is the same. Reasoning is that, if the message
- *    format needs to change in one instance, the other instances are not
- *    impacted or the new change does not change the ID of the instance being
- *    modified.
- * 2) Addition of a message,
- *       - Should increment the GLFS_NUM_MESSAGES
- *       - Append to the list of messages defined, towards the end
- *       - Retain macro naming as glfs_msg_X (for redability across developers)
- * NOTE: Rules for message format modifications
- * 3) Check acorss the code if the message ID macro in question is reused
- *    anywhere. If reused then then the modifications should ensure correctness
- *    everywhere, or needs a new message ID as (1) above was not adhered to. If
- *    not used anywhere, proceed with the required modification.
- * NOTE: Rules for message deletion
- * 4) Check (3) and if used anywhere else, then cannot be deleted. If not used
- *    anywhere, then can be deleted, but will leave a hole by design, as
- *    addition rules specify modification to the end of the list and not filling
- *    holes.
- */
-
-#define GLFS_READ_AHEAD_BASE                   GLFS_MSGID_COMP_READ_AHEAD
-#define GLFS_READ_AHEAD_NUM_MESSAGES           6
-#define GLFS_MSGID_END  (GLFS_READ_AHEAD_BASE +\
-         GLFS_READ_AHEAD_NUM_MESSAGES + 1)
-
-/* Messages with message IDs */
-#define glfs_msg_start_x GLFS_READ_AHEAD_BASE, "Invalid: Start of messages"
-
-
-
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
- *
- */
-
-#define READ_AHEAD_MSG_XLATOR_CHILD_MISCONFIGURED   (GLFS_READ_AHEAD_BASE + 1)
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
- *
- */
-
-#define READ_AHEAD_MSG_VOL_MISCONFIGURED        (GLFS_READ_AHEAD_BASE + 2)
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
+ * Never remove a message ID. If it's not used anymore, you can rename it or
+ * leave it as it is, but not delete it. This is to prevent reutilization of
+ * IDs by other messages.
  *
- */
-
-#define READ_AHEAD_MSG_NO_MEMORY        (GLFS_READ_AHEAD_BASE + 3)
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
- *
- */
-
-#define READ_AHEAD_MSG_FD_CONTEXT_NOT_SET        (GLFS_READ_AHEAD_BASE + 4)
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
- *
- */
-
-#define READ_AHEAD_MSG_UNDESTROYED_FILE_FOUND   (GLFS_READ_AHEAD_BASE + 5)
-
-/*!
- * @messageid
- * @diagnosis
- * @recommendedaction  None
- *
- */
-
-#define READ_AHEAD_MSG_XLATOR_CONF_NULL         (GLFS_READ_AHEAD_BASE + 6)
-
-/*------------*/
-#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages"
-
+ * The component name must match one of the entries defined in
+ * glfs-message-id.h.
+ */
+
+GLFS_MSGID(READ_AHEAD,
+        READ_AHEAD_MSG_XLATOR_CHILD_MISCONFIGURED,
+        READ_AHEAD_MSG_VOL_MISCONFIGURED,
+        READ_AHEAD_MSG_NO_MEMORY,
+        READ_AHEAD_MSG_FD_CONTEXT_NOT_SET,
+        READ_AHEAD_MSG_UNDESTROYED_FILE_FOUND,
+        READ_AHEAD_MSG_XLATOR_CONF_NULL
+);
 
 #endif /* _READ_AHEAD_MESSAGES_H_ */
-- 
cgit