diff options
Diffstat (limited to 'xlators/performance/md-cache/src/md-cache-messages.h')
| -rw-r--r-- | xlators/performance/md-cache/src/md-cache-messages.h | 94 | 
1 files changed, 13 insertions, 81 deletions
diff --git a/xlators/performance/md-cache/src/md-cache-messages.h b/xlators/performance/md-cache/src/md-cache-messages.h index 4aea7cd0a9d..7aa6fc27824 100644 --- a/xlators/performance/md-cache/src/md-cache-messages.h +++ b/xlators/performance/md-cache/src/md-cache-messages.h @@ -12,90 +12,22 @@  #include "glfs-message-id.h" -/*! \file md-cache-messages.h - *  \brief MD_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_MD_CACHE_BASE                   GLFS_MSGID_COMP_MD_CACHE -#define GLFS_MD_CACHE_NUM_MESSAGES           5 -#define GLFS_MSGID_END  (GLFS_MD_CACHE_BASE + GLFS_MD_CACHE_NUM_MESSAGES + 1) - -/* Messages with message IDs */ -#define glfs_msg_start_x GLFS_MD_CACHE_BASE, "Invalid: Start of messages" - - - - -/*! - * @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 MD_CACHE_MSG_NO_MEMORY        (GLFS_MD_CACHE_BASE + 1) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define MD_CACHE_MSG_DISCARD_UPDATE    (GLFS_MD_CACHE_BASE + 2) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define MD_CACHE_MSG_CACHE_UPDATE      (GLFS_MD_CACHE_BASE + 3) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define MD_CACHE_MSG_IPC_UPCALL_FAILED  (GLFS_MD_CACHE_BASE + 4) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define MD_CACHE_MSG_NO_XATTR_CACHE     (GLFS_MD_CACHE_BASE + 5) - -/*------------*/ -#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" - +GLFS_MSGID(MD_CACHE, +        MD_CACHE_MSG_NO_MEMORY, +        MD_CACHE_MSG_DISCARD_UPDATE, +        MD_CACHE_MSG_CACHE_UPDATE, +        MD_CACHE_MSG_IPC_UPCALL_FAILED, +        MD_CACHE_MSG_NO_XATTR_CACHE +);  #endif /* _MD_CACHE_MESSAGES_H_ */  | 
