diff options
Diffstat (limited to 'xlators/performance/io-threads/src/io-threads-messages.h')
| -rw-r--r-- | xlators/performance/io-threads/src/io-threads-messages.h | 96 | 
1 files changed, 13 insertions, 83 deletions
diff --git a/xlators/performance/io-threads/src/io-threads-messages.h b/xlators/performance/io-threads/src/io-threads-messages.h index ab1f672756b..0f3fe707a36 100644 --- a/xlators/performance/io-threads/src/io-threads-messages.h +++ b/xlators/performance/io-threads/src/io-threads-messages.h @@ -12,92 +12,22 @@  #include "glfs-message-id.h" -/*! \file io-threads-messages.h - *  \brief IO_THREADS 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_IO_THREADS_BASE                   GLFS_MSGID_COMP_IO_THREADS -#define GLFS_IO_THREADS_NUM_MESSAGES           5 -#define GLFS_MSGID_END (GLFS_IO_THREADS_BASE + \ -        GLFS_IO_THREADS_NUM_MESSAGES + 1) - -/* Messages with message IDs */ -#define glfs_msg_start_x GLFS_IO_THREADS_BASE, "Invalid: Start of messages" - - - - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define IO_THREADS_MSG_INIT_FAILED        (GLFS_IO_THREADS_BASE + 1) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define IO_THREADS_MSG_XLATOR_CHILD_MISCONFIGURED  (GLFS_IO_THREADS_BASE + 2) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define IO_THREADS_MSG_NO_MEMORY        (GLFS_IO_THREADS_BASE + 3) - -/*! - * @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 IO_THREADS_MSG_VOL_MISCONFIGURED        (GLFS_IO_THREADS_BASE + 4) - -/*! - * @messageid - * @diagnosis - * @recommendedaction  None - * - */ - -#define IO_THREADS_MSG_SIZE_NOT_SET        (GLFS_IO_THREADS_BASE + 5) - - -/*------------*/ -#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" - +GLFS_MSGID(IO_THREADS, +        IO_THREADS_MSG_INIT_FAILED, +        IO_THREADS_MSG_XLATOR_CHILD_MISCONFIGURED, +        IO_THREADS_MSG_NO_MEMORY, +        IO_THREADS_MSG_VOL_MISCONFIGURED, +        IO_THREADS_MSG_SIZE_NOT_SET +);  #endif /* _IO_THREADS_MESSAGES_H_ */  | 
