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 --- .../bit-rot/src/bitd/bit-rot-bitd-messages.h | 490 +++------------------ 1 file changed, 63 insertions(+), 427 deletions(-) (limited to 'xlators/features/bit-rot/src/bitd/bit-rot-bitd-messages.h') diff --git a/xlators/features/bit-rot/src/bitd/bit-rot-bitd-messages.h b/xlators/features/bit-rot/src/bitd/bit-rot-bitd-messages.h index c6b6a4afa05..89a67cc10b1 100644 --- a/xlators/features/bit-rot/src/bitd/bit-rot-bitd-messages.h +++ b/xlators/features/bit-rot/src/bitd/bit-rot-bitd-messages.h @@ -13,436 +13,72 @@ #include "glfs-message-id.h" -/* file bit-rot-bitd-messages.h - * brief BIT-ROT log-message IDs and their descriptions - */ - -/* 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_BITROT_BITD_BASE GLFS_MSGID_COMP_BITROT_BITD -#define GLFS_BITROT_BITD_NUM_MESSAGES 55 -#define GLFS_MSGID_END (GLFS_BITROT_BITD_BASE + \ - GLFS_BITROT_BITD_NUM_MESSAGES + 1) -/* Messaged with message IDs */ -#define glfs_msg_start_x GLFS_BITROT_BITD_BASE, "Invalid: Start of messages" -/*------------*/ - - -#define BRB_MSG_FD_CREATE_FAILED (GLFS_BITROT_BITD_BASE + 1) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ - -#define BRB_MSG_READV_FAILED (GLFS_BITROT_BITD_BASE + 2) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ - -#define BRB_MSG_BLOCK_READ_FAILED (GLFS_BITROT_BITD_BASE + 3) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CALC_CHECKSUM_FAILED (GLFS_BITROT_BITD_BASE + 4) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_NO_MEMORY (GLFS_BITROT_BITD_BASE + 5) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_GET_SIGN_FAILED (GLFS_BITROT_BITD_BASE + 6) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SET_SIGN_FAILED (GLFS_BITROT_BITD_BASE + 7) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_OP_FAILED (GLFS_BITROT_BITD_BASE + 8) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_READ_AND_SIGN_FAILED (GLFS_BITROT_BITD_BASE + 9) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SIGN_FAILED (GLFS_BITROT_BITD_BASE + 10) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_GET_SUBVOL_FAILED (GLFS_BITROT_BITD_BASE + 11) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SET_TIMER_FAILED (GLFS_BITROT_BITD_BASE + 12) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_GET_INFO_FAILED (GLFS_BITROT_BITD_BASE + 13) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_PATH_FAILED (GLFS_BITROT_BITD_BASE + 14) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_MARK_BAD_FILE (GLFS_BITROT_BITD_BASE + 15) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_TRIGGER_SIGN (GLFS_BITROT_BITD_BASE + 16) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_REGISTER_FAILED (GLFS_BITROT_BITD_BASE + 17) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CRAWLING_START (GLFS_BITROT_BITD_BASE + 18) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SPAWN_FAILED (GLFS_BITROT_BITD_BASE + 19) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_INVALID_SUBVOL_CHILD (GLFS_BITROT_BITD_BASE + 20) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SKIP_OBJECT (GLFS_BITROT_BITD_BASE + 21) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_NO_CHILD (GLFS_BITROT_BITD_BASE + 22) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CHECKSUM_MISMATCH (GLFS_BITROT_BITD_BASE + 23) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_MARK_CORRUPTED (GLFS_BITROT_BITD_BASE + 24) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CRAWLING_FINISH (GLFS_BITROT_BITD_BASE + 25) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CALC_ERROR (GLFS_BITROT_BITD_BASE + 26) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_LOOKUP_FAILED (GLFS_BITROT_BITD_BASE + 27) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_PARTIAL_VERSION_PRESENCE (GLFS_BITROT_BITD_BASE + 28) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_MEM_ACNT_FAILED (GLFS_BITROT_BITD_BASE + 29) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_TIMER_WHEEL_UNAVAILABLE (GLFS_BITROT_BITD_BASE + 30) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_BITROT_LOADED (GLFS_BITROT_BITD_BASE + 31) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCALE_DOWN_FAILED (GLFS_BITROT_BITD_BASE + 32) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCALE_UP_FAILED (GLFS_BITROT_BITD_BASE + 33) -/*! - * @messageid - * @diagnosis - * @recommendedaction +/* To add new message IDs, append new identifiers at the end of the list. * - */ -#define BRB_MSG_SCALE_DOWN_SCRUBBER (GLFS_BITROT_BITD_BASE + 34) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCALING_UP_SCRUBBER (GLFS_BITROT_BITD_BASE + 35) -/*! - * @messageid - * @diagnosis - * @recommendedaction - */ -#define BRB_MSG_UNKNOWN_THROTTLE (GLFS_BITROT_BITD_BASE + 36) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_RATE_LIMIT_INFO (GLFS_BITROT_BITD_BASE + 37) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCRUB_INFO (GLFS_BITROT_BITD_BASE + 38) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_CONNECTED_TO_BRICK (GLFS_BITROT_BITD_BASE + 39) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_BRICK_INFO (GLFS_BITROT_BITD_BASE + 40) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SUBVOL_CONNECT_FAILED (GLFS_BITROT_BITD_BASE + 41) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_INVALID_SUBVOL (GLFS_BITROT_BITD_BASE + 42) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_RESCHEDULE_SCRUBBER_FAILED (GLFS_BITROT_BITD_BASE + 43) -/*! - * @messageid - * @diagnosis - * @recommendedaction + * 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 BRB_MSG_SCRUB_START (GLFS_BITROT_BITD_BASE + 44) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCRUB_FINISH (GLFS_BITROT_BITD_BASE + 45) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCRUB_RUNNING (GLFS_BITROT_BITD_BASE + 46) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCRUB_RESCHEDULED (GLFS_BITROT_BITD_BASE + 47) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -#define BRB_MSG_SCRUB_TUNABLE (GLFS_BITROT_BITD_BASE + 48) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_SCRUB_THREAD_CLEANUP (GLFS_BITROT_BITD_BASE + 49) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_SCRUBBER_CLEANED (GLFS_BITROT_BITD_BASE + 50) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_GENERIC_SSM_INFO (GLFS_BITROT_BITD_BASE + 51) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_ZERO_TIMEOUT_BUG (GLFS_BITROT_BITD_BASE + 52) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_BAD_OBJ_READDIR_FAIL (GLFS_BITROT_BITD_BASE + 53) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_SSM_FAILED (GLFS_BITROT_BITD_BASE + 54) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ -#define BRB_MSG_SCRUB_WAIT_FAILED (GLFS_BITROT_BITD_BASE + 55) -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ -/*------------*/ +GLFS_MSGID(BITROT_BITD, + BRB_MSG_FD_CREATE_FAILED, + BRB_MSG_READV_FAILED, + BRB_MSG_BLOCK_READ_FAILED, + BRB_MSG_CALC_CHECKSUM_FAILED, + BRB_MSG_NO_MEMORY, + BRB_MSG_GET_SIGN_FAILED, + BRB_MSG_SET_SIGN_FAILED, + BRB_MSG_OP_FAILED, + BRB_MSG_READ_AND_SIGN_FAILED, + BRB_MSG_SIGN_FAILED, + BRB_MSG_GET_SUBVOL_FAILED, + BRB_MSG_SET_TIMER_FAILED, + BRB_MSG_GET_INFO_FAILED, + BRB_MSG_PATH_FAILED, + BRB_MSG_MARK_BAD_FILE, + BRB_MSG_TRIGGER_SIGN, + BRB_MSG_REGISTER_FAILED, + BRB_MSG_CRAWLING_START, + BRB_MSG_SPAWN_FAILED, + BRB_MSG_INVALID_SUBVOL_CHILD, + BRB_MSG_SKIP_OBJECT, + BRB_MSG_NO_CHILD, + BRB_MSG_CHECKSUM_MISMATCH, + BRB_MSG_MARK_CORRUPTED, + BRB_MSG_CRAWLING_FINISH, + BRB_MSG_CALC_ERROR, + BRB_MSG_LOOKUP_FAILED, + BRB_MSG_PARTIAL_VERSION_PRESENCE, + BRB_MSG_MEM_ACNT_FAILED, + BRB_MSG_TIMER_WHEEL_UNAVAILABLE, + BRB_MSG_BITROT_LOADED, + BRB_MSG_SCALE_DOWN_FAILED, + BRB_MSG_SCALE_UP_FAILED, + BRB_MSG_SCALE_DOWN_SCRUBBER, + BRB_MSG_SCALING_UP_SCRUBBER, + BRB_MSG_UNKNOWN_THROTTLE, + BRB_MSG_RATE_LIMIT_INFO, + BRB_MSG_SCRUB_INFO, + BRB_MSG_CONNECTED_TO_BRICK, + BRB_MSG_BRICK_INFO, + BRB_MSG_SUBVOL_CONNECT_FAILED, + BRB_MSG_INVALID_SUBVOL, + BRB_MSG_RESCHEDULE_SCRUBBER_FAILED, + BRB_MSG_SCRUB_START, + BRB_MSG_SCRUB_FINISH, + BRB_MSG_SCRUB_RUNNING, + BRB_MSG_SCRUB_RESCHEDULED, + BRB_MSG_SCRUB_TUNABLE, + BRB_MSG_SCRUB_THREAD_CLEANUP, + BRB_MSG_SCRUBBER_CLEANED, + BRB_MSG_GENERIC_SSM_INFO, + BRB_MSG_ZERO_TIMEOUT_BUG, + BRB_MSG_BAD_OBJ_READDIR_FAIL, + BRB_MSG_SSM_FAILED, + BRB_MSG_SCRUB_WAIT_FAILED +); -#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" #endif /* !_BITROT_BITD_MESSAGES_H_ */ -- cgit