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>

2 files changed, 110 insertions, 252 deletions

diff --git a/rpc/rpc-lib/src/rpc-lib-messages.h b/rpc/rpc-lib/src/rpc-lib-messages.h
index 39258a161e3..31e0d8ea267 100644
--- a/rpc/rpc-lib/src/rpc-lib-messages.h
+++ b/rpc/rpc-lib/src/rpc-lib-messages.h
@@ -13,68 +13,31 @@
 
 #include "glfs-message-id.h"
 
-/* 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.
+/* To add new message IDs, append new identifiers at the end of the list.
+ *
+ * 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.
+ *
+ * The component name must match one of the entries defined in
+ * glfs-message-id.h.
  */
 
-#define GLFS_RPC_LIB_BASE        GLFS_MSGID_COMP_RPC_LIB
-#define GLFS_NUM_MESSAGES        13
-#define GLFS_RPC_LIB_MSGID_END   (GLFS_RPC_LIB_BASE + GLFS_NUM_MESSAGES + 1)
-
-/* Messages with message IDs */
-
-#define glfs_msg_start_x GLFS_RPC_LIB_BASE, "Invalid: Start of messages"
-
-/*------------*/
-/* First slot is allocated for common transport msg ids */
-
-#define TRANS_MSG_ADDR_FAMILY_NOT_SPECIFIED          (GLFS_RPC_LIB_BASE + 1)
-
-#define TRANS_MSG_UNKNOWN_ADDR_FAMILY                (GLFS_RPC_LIB_BASE + 2)
-
-#define TRANS_MSG_REMOTE_HOST_ERROR                  (GLFS_RPC_LIB_BASE + 3)
-
-#define TRANS_MSG_DNS_RESOL_FAILED                   (GLFS_RPC_LIB_BASE + 4)
-
-#define TRANS_MSG_LISTEN_PATH_ERROR                  (GLFS_RPC_LIB_BASE + 5)
-
-#define TRANS_MSG_CONNECT_PATH_ERROR                 (GLFS_RPC_LIB_BASE + 6)
-
-#define TRANS_MSG_GET_ADDR_INFO_FAILED               (GLFS_RPC_LIB_BASE + 7)
-
-#define TRANS_MSG_PORT_BIND_FAILED                   (GLFS_RPC_LIB_BASE + 8)
-
-#define TRANS_MSG_INET_ERROR                         (GLFS_RPC_LIB_BASE + 9)
-
-#define TRANS_MSG_GET_NAME_INFO_FAILED               (GLFS_RPC_LIB_BASE + 10)
-
-#define TRANS_MSG_TRANSPORT_ERROR                    (GLFS_RPC_LIB_BASE + 11)
-
-#define TRANS_MSG_TIMEOUT_EXCEEDED                   (GLFS_RPC_LIB_BASE + 12)
-
-#define TRANS_MSG_SOCKET_BIND_ERROR                  (GLFS_RPC_LIB_BASE + 13)
-
-/*------------*/
-
-#define glfs_msg_end_x GLFS_RPC_LIB_MSGID_END, "Invalid: End of messages"
+GLFS_MSGID(RPC_LIB,
+        TRANS_MSG_ADDR_FAMILY_NOT_SPECIFIED,
+        TRANS_MSG_UNKNOWN_ADDR_FAMILY,
+        TRANS_MSG_REMOTE_HOST_ERROR,
+        TRANS_MSG_DNS_RESOL_FAILED,
+        TRANS_MSG_LISTEN_PATH_ERROR,
+        TRANS_MSG_CONNECT_PATH_ERROR,
+        TRANS_MSG_GET_ADDR_INFO_FAILED,
+        TRANS_MSG_PORT_BIND_FAILED,
+        TRANS_MSG_INET_ERROR,
+        TRANS_MSG_GET_NAME_INFO_FAILED,
+        TRANS_MSG_TRANSPORT_ERROR,
+        TRANS_MSG_TIMEOUT_EXCEEDED,
+        TRANS_MSG_SOCKET_BIND_ERROR
+);
 
 #endif /* !_RPC_LIB_MESSAGES_H_ */
 
diff --git a/rpc/rpc-transport/rdma/src/rpc-trans-rdma-messages.h b/rpc/rpc-transport/rdma/src/rpc-trans-rdma-messages.h
index 616b0a20f61..97979970e73 100644
--- a/rpc/rpc-transport/rdma/src/rpc-trans-rdma-messages.h
+++ b/rpc/rpc-transport/rdma/src/rpc-trans-rdma-messages.h
@@ -13,200 +13,95 @@
 
 #include "glfs-message-id.h"
 
-/* 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_RDMA
- *       - 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.
+/* To add new message IDs, append new identifiers at the end of the list.
+ *
+ * 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.
+ *
+ * The component name must match one of the entries defined in
+ * glfs-message-id.h.
  */
 
-#define GLFS_RPC_TRANS_RDMA_BASE        GLFS_MSGID_COMP_RPC_TRANS_RDMA
-#define GLFS_NUM_MESSAGES_RDMA          77
-#define GLFS_RPC_TRANS_RDMA_MSGID_END   (GLFS_RPC_TRANS_RDMA_BASE + GLFS_NUM_MESSAGES_RDMA + 1)
-
-/* Messages with message IDs */
-
-#define glfs_msg_start_rdma GLFS_RPC_TRANS_RDMA_BASE, "Invalid: Start of messages"
-
-/* This slot/segment is allocated for RDMA message IDs
- * The allocation starts from BASE.
-
-*/
-
-#define RDMA_MSG_PORT_BIND_FAILED                   (GLFS_RPC_TRANS_RDMA_BASE + 1)
-
-#define RDMA_MSG_POST_CREATION_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 2)
-
-#define RDMA_MSG_DEREGISTER_ARENA_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 3)
-
-#define RDMA_MSG_MR_ALOC_FAILED                     (GLFS_RPC_TRANS_RDMA_BASE + 4)
-
-#define RDMA_MSG_PREREG_BUFFER_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 5)
-
-#define RDMA_MSG_CQ_CREATION_FAILED                 (GLFS_RPC_TRANS_RDMA_BASE + 6)
-
-#define RDMA_MSG_REQ_NOTIFY_CQ_REVQ_FAILED          (GLFS_RPC_TRANS_RDMA_BASE + 7)
-
-#define RDMA_MSG_QUERY_DEVICE_FAILED                (GLFS_RPC_TRANS_RDMA_BASE + 8)
-
-#define RDMA_MSG_REQ_NOTIFY_CQ_SENDQ_FAILED         (GLFS_RPC_TRANS_RDMA_BASE + 9)
-
-#define RDMA_MSG_SEND_COMP_CHAN_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 10)
-
-#define RDMA_MSG_RECV_COMP_CHAN_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 11)
-
-#define RDMA_MSG_ALOC_PROT_DOM_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 12)
-
-#define RDMA_MSG_CRE_SRQ_FAILED                     (GLFS_RPC_TRANS_RDMA_BASE + 13)
-
-#define RDMA_MSG_ALOC_POST_FAILED                   (GLFS_RPC_TRANS_RDMA_BASE + 14)
-
-#define RDMA_MSG_SEND_COMP_THREAD_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 15)
-
-#define RDMA_MSG_RECV_COMP_THREAD_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 16)
-
-#define RDMA_MSG_ASYNC_EVENT_THEAD_FAILED           (GLFS_RPC_TRANS_RDMA_BASE + 17)
-
-#define RDMA_MSG_GET_DEVICE_NAME_FAILED             (GLFS_RPC_TRANS_RDMA_BASE + 18)
-
-#define RDMA_MSG_GET_IB_DEVICE_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 19)
-
-#define RDMA_MSG_CREAT_INC_TRANS_FAILED             (GLFS_RPC_TRANS_RDMA_BASE + 20)
-
-#define RDMA_MSG_CREAT_QP_FAILED                    (GLFS_RPC_TRANS_RDMA_BASE + 21)
-
-#define RDMA_MSG_ACCEPT_FAILED                      (GLFS_RPC_TRANS_RDMA_BASE + 22)
-
-#define RDMA_MSG_CONNECT_FAILED                     (GLFS_RPC_TRANS_RDMA_BASE + 23)
-
-#define RDMA_MSG_ROUTE_RESOLVE_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 24)
-
-#define RDMA_MSG_GET_DEVICE_FAILED                  (GLFS_RPC_TRANS_RDMA_BASE + 25)
-
-#define RDMA_MSG_PEER_DISCONNECTED                  (GLFS_RPC_TRANS_RDMA_BASE + 26)
-
-#define RDMA_MSG_ENCODE_ERROR                       (GLFS_RPC_TRANS_RDMA_BASE + 27)
-
-#define RDMA_MSG_POST_SEND_FAILED                   (GLFS_RPC_TRANS_RDMA_BASE + 28)
-
-#define RDMA_MSG_READ_CHUNK_VECTOR_FAILED           (GLFS_RPC_TRANS_RDMA_BASE + 29)
-
-#define RDMA_MSG_WRITE_CHUNK_VECTOR_FAILED          (GLFS_RPC_TRANS_RDMA_BASE + 30)
-
-#define RDMA_MSG_WRITE_REPLY_CHUNCK_CONFLICT        (GLFS_RPC_TRANS_RDMA_BASE + 31)
-
-#define RDMA_MSG_CHUNK_COUNT_GREAT_MAX_SEGMENTS     (GLFS_RPC_TRANS_RDMA_BASE + 32)
-
-#define RDMA_MSG_CREATE_READ_CHUNK_FAILED           (GLFS_RPC_TRANS_RDMA_BASE + 33)
-
-#define RDMA_MSG_CREATE_WRITE_REPLAY_FAILED         (GLFS_RPC_TRANS_RDMA_BASE + 34)
-
-#define RDMA_MSG_SEND_SIZE_GREAT_INLINE_THRESHOLD   (GLFS_RPC_TRANS_RDMA_BASE + 35)
-
-#define RDMA_MSG_REG_ACCESS_LOCAL_WRITE_FAILED      (GLFS_RPC_TRANS_RDMA_BASE + 36)
-
-#define RDMA_MSG_WRITE_PEER_FAILED                  (GLFS_RPC_TRANS_RDMA_BASE + 37)
-
-#define RDMA_MSG_SEND_REPLY_FAILED                  (GLFS_RPC_TRANS_RDMA_BASE + 38)
-
-#define RDMA_MSG_INVALID_CHUNK_TYPE                 (GLFS_RPC_TRANS_RDMA_BASE + 39)
-
-#define RDMA_MSG_PROC_IOQ_ENTRY_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 40)
-
-#define RDMA_MSG_NEW_IOQ_ENTRY_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 41)
-
-#define RDMA_MSG_RPC_REPLY_CREATE_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 42)
-
-#define RDMA_MSG_GET_READ_CHUNK_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 43)
-
-#define RDMA_MSG_GET_WRITE_CHUNK_FAILED             (GLFS_RPC_TRANS_RDMA_BASE + 44)
-
-#define RDMA_MSG_REPLY_INFO_ALLOC_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 45)
-
-#define RDMA_MSG_RDMA_ERROR_RECEIVED                (GLFS_RPC_TRANS_RDMA_BASE + 46)
-
-#define RDMA_MSG_GET_REQ_INFO_RPC_FAILED            (GLFS_RPC_TRANS_RDMA_BASE + 47)
-
-#define RDMA_MSG_POLL_IN_NOTIFY_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 48)
-
-#define RDMA_MSG_HEADER_DECODE_FAILED               (GLFS_RPC_TRANS_RDMA_BASE + 49)
-
-#define RDMA_MSG_EVENT_SRQ_LIMIT_REACHED            (GLFS_RPC_TRANS_RDMA_BASE + 50)
-
-#define RDMA_MSG_UNRECG_MQ_VALUE                    (GLFS_RPC_TRANS_RDMA_BASE + 51)
-
-#define RDMA_MSG_BUFFER_ERROR                       (GLFS_RPC_TRANS_RDMA_BASE + 52)
-
-#define RDMA_MSG_OPTION_SET_FAILED                  (GLFS_RPC_TRANS_RDMA_BASE + 53)
-
-#define RDMA_MSG_LISTEN_FAILED                      (GLFS_RPC_TRANS_RDMA_BASE + 54)
-
-#define RDMA_MSG_INIT_IB_DEVICE_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 55)
-
-#define RDMA_MSG_WRITE_CLIENT_ERROR                 (GLFS_RPC_TRANS_RDMA_BASE + 56)
-
-#define RDMA_MSG_CHUNKLIST_ERROR                    (GLFS_RPC_TRANS_RDMA_BASE + 57)
-
-#define RDMA_MSG_INVALID_ENTRY                      (GLFS_RPC_TRANS_RDMA_BASE + 58)
-
-#define RDMA_MSG_READ_CLIENT_ERROR                  (GLFS_RPC_TRANS_RDMA_BASE + 59)
-
-#define RDMA_MSG_RPC_ST_ERROR                       (GLFS_RPC_TRANS_RDMA_BASE + 60)
-
-#define RDMA_MSG_PEER_READ_FAILED                   (GLFS_RPC_TRANS_RDMA_BASE + 61)
-
-#define RDMA_MSG_POST_MISSING                       (GLFS_RPC_TRANS_RDMA_BASE + 62)
-
-#define RDMA_MSG_PEER_REQ_FAILED                    (GLFS_RPC_TRANS_RDMA_BASE + 63)
-
-#define RDMA_MSG_PEER_REP_FAILED                    (GLFS_RPC_TRANS_RDMA_BASE + 64)
-
-#define RDMA_MSG_EVENT_ERROR                        (GLFS_RPC_TRANS_RDMA_BASE + 65)
-
-#define RDMA_MSG_IBV_GET_CQ_FAILED                  (GLFS_RPC_TRANS_RDMA_BASE + 66)
-
-#define RDMA_MSG_IBV_REQ_NOTIFY_CQ_FAILED           (GLFS_RPC_TRANS_RDMA_BASE + 67)
-
-#define RDMA_MSG_RECV_ERROR                         (GLFS_RPC_TRANS_RDMA_BASE + 68)
-
-#define RDMA_MSG_IBV_POLL_CQ_ERROR                  (GLFS_RPC_TRANS_RDMA_BASE + 69)
-
-#define RDMA_MSG_RDMA_HANDLE_FAILED                 (GLFS_RPC_TRANS_RDMA_BASE + 70)
-
-#define RDMA_MSG_CM_EVENT_FAILED                    (GLFS_RPC_TRANS_RDMA_BASE + 71)
-
-#define RDMA_MSG_CLIENT_BIND_FAILED                 (GLFS_RPC_TRANS_RDMA_BASE + 72)
-
-#define RDMA_MSG_RDMA_RESOLVE_ADDR_FAILED           (GLFS_RPC_TRANS_RDMA_BASE + 73)
-
-#define RDMA_MSG_NW_ADDR_UNKNOWN                    (GLFS_RPC_TRANS_RDMA_BASE + 74)
-
-#define RDMA_MSG_RDMA_BIND_ADDR_FAILED              (GLFS_RPC_TRANS_RDMA_BASE + 75)
-
-#define RDMA_MSG_SEND_CLIENT_ERROR                  (GLFS_RPC_TRANS_RDMA_BASE + 76)
-
-#define RDMA_MSG_UNRECG_MTU_VALUE                   (GLFS_RPC_TRANS_RDMA_BASE + 77)
-
-
-
-/*------------*/
-
-#define glfs_msg_end_rdma GLFS_RPC_TRANS_RDMA_MSGID_END, "Invalid: End of messages"
+GLFS_MSGID(RPC_TRANS_RDMA,
+        RDMA_MSG_PORT_BIND_FAILED,
+        RDMA_MSG_POST_CREATION_FAILED,
+        RDMA_MSG_DEREGISTER_ARENA_FAILED,
+        RDMA_MSG_MR_ALOC_FAILED,
+        RDMA_MSG_PREREG_BUFFER_FAILED,
+        RDMA_MSG_CQ_CREATION_FAILED,
+        RDMA_MSG_REQ_NOTIFY_CQ_REVQ_FAILED,
+        RDMA_MSG_QUERY_DEVICE_FAILED,
+        RDMA_MSG_REQ_NOTIFY_CQ_SENDQ_FAILED,
+        RDMA_MSG_SEND_COMP_CHAN_FAILED,
+        RDMA_MSG_RECV_COMP_CHAN_FAILED,
+        RDMA_MSG_ALOC_PROT_DOM_FAILED,
+        RDMA_MSG_CRE_SRQ_FAILED,
+        RDMA_MSG_ALOC_POST_FAILED,
+        RDMA_MSG_SEND_COMP_THREAD_FAILED,
+        RDMA_MSG_RECV_COMP_THREAD_FAILED,
+        RDMA_MSG_ASYNC_EVENT_THEAD_FAILED,
+        RDMA_MSG_GET_DEVICE_NAME_FAILED,
+        RDMA_MSG_GET_IB_DEVICE_FAILED,
+        RDMA_MSG_CREAT_INC_TRANS_FAILED,
+        RDMA_MSG_CREAT_QP_FAILED,
+        RDMA_MSG_ACCEPT_FAILED,
+        RDMA_MSG_CONNECT_FAILED,
+        RDMA_MSG_ROUTE_RESOLVE_FAILED,
+        RDMA_MSG_GET_DEVICE_FAILED,
+        RDMA_MSG_PEER_DISCONNECTED,
+        RDMA_MSG_ENCODE_ERROR,
+        RDMA_MSG_POST_SEND_FAILED,
+        RDMA_MSG_READ_CHUNK_VECTOR_FAILED,
+        RDMA_MSG_WRITE_CHUNK_VECTOR_FAILED,
+        RDMA_MSG_WRITE_REPLY_CHUNCK_CONFLICT,
+        RDMA_MSG_CHUNK_COUNT_GREAT_MAX_SEGMENTS,
+        RDMA_MSG_CREATE_READ_CHUNK_FAILED,
+        RDMA_MSG_CREATE_WRITE_REPLAY_FAILED,
+        RDMA_MSG_SEND_SIZE_GREAT_INLINE_THRESHOLD,
+        RDMA_MSG_REG_ACCESS_LOCAL_WRITE_FAILED,
+        RDMA_MSG_WRITE_PEER_FAILED,
+        RDMA_MSG_SEND_REPLY_FAILED,
+        RDMA_MSG_INVALID_CHUNK_TYPE,
+        RDMA_MSG_PROC_IOQ_ENTRY_FAILED,
+        RDMA_MSG_NEW_IOQ_ENTRY_FAILED,
+        RDMA_MSG_RPC_REPLY_CREATE_FAILED,
+        RDMA_MSG_GET_READ_CHUNK_FAILED,
+        RDMA_MSG_GET_WRITE_CHUNK_FAILED,
+        RDMA_MSG_REPLY_INFO_ALLOC_FAILED,
+        RDMA_MSG_RDMA_ERROR_RECEIVED,
+        RDMA_MSG_GET_REQ_INFO_RPC_FAILED,
+        RDMA_MSG_POLL_IN_NOTIFY_FAILED,
+        RDMA_MSG_HEADER_DECODE_FAILED,
+        RDMA_MSG_EVENT_SRQ_LIMIT_REACHED,
+        RDMA_MSG_UNRECG_MQ_VALUE,
+        RDMA_MSG_BUFFER_ERROR,
+        RDMA_MSG_OPTION_SET_FAILED,
+        RDMA_MSG_LISTEN_FAILED,
+        RDMA_MSG_INIT_IB_DEVICE_FAILED,
+        RDMA_MSG_WRITE_CLIENT_ERROR,
+        RDMA_MSG_CHUNKLIST_ERROR,
+        RDMA_MSG_INVALID_ENTRY,
+        RDMA_MSG_READ_CLIENT_ERROR,
+        RDMA_MSG_RPC_ST_ERROR,
+        RDMA_MSG_PEER_READ_FAILED,
+        RDMA_MSG_POST_MISSING,
+        RDMA_MSG_PEER_REQ_FAILED,
+        RDMA_MSG_PEER_REP_FAILED,
+        RDMA_MSG_EVENT_ERROR,
+        RDMA_MSG_IBV_GET_CQ_FAILED,
+        RDMA_MSG_IBV_REQ_NOTIFY_CQ_FAILED,
+        RDMA_MSG_RECV_ERROR,
+        RDMA_MSG_IBV_POLL_CQ_ERROR,
+        RDMA_MSG_RDMA_HANDLE_FAILED,
+        RDMA_MSG_CM_EVENT_FAILED,
+        RDMA_MSG_CLIENT_BIND_FAILED,
+        RDMA_MSG_RDMA_RESOLVE_ADDR_FAILED,
+        RDMA_MSG_NW_ADDR_UNKNOWN,
+        RDMA_MSG_RDMA_BIND_ADDR_FAILED,
+        RDMA_MSG_SEND_CLIENT_ERROR,
+        RDMA_MSG_UNRECG_MTU_VALUE
+);
 
 #endif /* !_RPC_TRANS_RDMA_MESSAGES_H_ */