From 415e0bcc80b350fc75f325b490560f44ba419b20 Mon Sep 17 00:00:00 2001 From: Xavier Hernandez 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 --- .../symlink-cache/src/symlink-cache-messages.h | 86 ++++------------------ 1 file changed, 13 insertions(+), 73 deletions(-) (limited to 'xlators/performance/symlink-cache/src/symlink-cache-messages.h') diff --git a/xlators/performance/symlink-cache/src/symlink-cache-messages.h b/xlators/performance/symlink-cache/src/symlink-cache-messages.h index 89ea118d6b3..46685b7695d 100644 --- a/xlators/performance/symlink-cache/src/symlink-cache-messages.h +++ b/xlators/performance/symlink-cache/src/symlink-cache-messages.h @@ -12,82 +12,22 @@ #include "glfs-message-id.h" -/*! \file symlink_cache-messages.h - * \brief SYMLINK_CACHE 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_SYMLINK_CACHE_BASE GLFS_MSGID_COMP_SYMLINK_CACHE -#define GLFS_SYMLINK_CACHE_NUM_MESSAGES 5 -#define GLFS_MSGID_END (GLFS_SYMLINK_CACHE_BASE +\ - GLFS_SYMLINK_CACHE_NUM_MESSAGES + 1) - -/* Messages with message IDs */ -#define glfs_msg_start_x GLFS_SYMLINK_CACHE_BASE, "Invalid: Start of messages" - -#define SYMLINK_CACHE_MSG_XLATOR_CHILD_MISCONFIGURED\ - (GLFS_SYMLINK_CACHE_BASE + 1) - -/*! - * @messageid - * @diagnosis - * @recommendedaction None - * - */ - -#define SYMLINK_CACHE_MSG_VOL_MISCONFIGURED (GLFS_SYMLINK_CACHE_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. * + * The component name must match one of the entries defined in + * glfs-message-id.h. */ -#define SYMLINK_CACHE_MSG_NO_MEMORY (GLFS_SYMLINK_CACHE_BASE + 3) - -/*! - * @messageid - * @diagnosis - * @recommendedaction None - * - */ - -#define SYMLINK_CACHE_MSG_DICT_GET_FAILED (GLFS_SYMLINK_CACHE_BASE + 4) - -/*! - * @messageid - * @diagnosis - * @recommendedaction None - * - */ - -#define SYMLINK_CACHE_MSG_DICT_SET_FAILED (GLFS_SYMLINK_CACHE_BASE + 5) - -/*------------*/ -#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" - +GLFS_MSGID(SYMLINK_CACHE, + SYMLINK_CACHE_MSG_XLATOR_CHILD_MISCONFIGURED, + SYMLINK_CACHE_MSG_VOL_MISCONFIGURED, + SYMLINK_CACHE_MSG_NO_MEMORY, + SYMLINK_CACHE_MSG_DICT_GET_FAILED, + SYMLINK_CACHE_MSG_DICT_SET_FAILED +); #endif /* _SYMLINK_CACHE_MESSAGES_H_ */ -- cgit