From f630fb742a603083a6adc610296458bcd2e57062 Mon Sep 17 00:00:00 2001 From: Pranith Kumar K Date: Thu, 14 Jul 2016 11:17:40 +0530 Subject: features/index: Move gf_log -> gf_msg Change-Id: I88e5d69a24309bf9d3cb855950c9a5349bdd3d66 BUG: 1356504 Signed-off-by: Pranith Kumar K Reviewed-on: http://review.gluster.org/14924 Smoke: Gluster Build System Reviewed-by: Krutika Dhananjay Tested-by: Krutika Dhananjay NetBSD-regression: NetBSD Build System CentOS-regression: Gluster Build System Reviewed-by: Zhou Zhengping Tested-by: Zhou Zhengping --- xlators/features/index/src/Makefile.am | 2 +- xlators/features/index/src/index-messages.h | 121 +++++++++++++++++++++ xlators/features/index/src/index.c | 159 +++++++++++++++++----------- 3 files changed, 217 insertions(+), 65 deletions(-) create mode 100644 xlators/features/index/src/index-messages.h (limited to 'xlators/features') diff --git a/xlators/features/index/src/Makefile.am b/xlators/features/index/src/Makefile.am index 2f94a8c6273..1e88f119833 100644 --- a/xlators/features/index/src/Makefile.am +++ b/xlators/features/index/src/Makefile.am @@ -6,7 +6,7 @@ index_la_LDFLAGS = -module $(GF_XLATOR_DEFAULT_LDFLAGS) index_la_SOURCES = index.c index_la_LIBADD = $(top_builddir)/libglusterfs/src/libglusterfs.la -noinst_HEADERS = index.h index-mem-types.h +noinst_HEADERS = index.h index-mem-types.h index-messages.h AM_CPPFLAGS = $(GF_CPPFLAGS) \ -I$(top_srcdir)/libglusterfs/src -I$(top_srcdir)/rpc/xdr/src \ diff --git a/xlators/features/index/src/index-messages.h b/xlators/features/index/src/index-messages.h new file mode 100644 index 00000000000..91f17555d62 --- /dev/null +++ b/xlators/features/index/src/index-messages.h @@ -0,0 +1,121 @@ +/* + Copyright (c) 2016 Red Hat, Inc. + This file is part of GlusterFS. + + This file is licensed to you under your choice of the GNU Lesser + General Public License, version 3 or any later version (LGPLv3 or + later), or the GNU General Public License, version 2 (GPLv2), in all + cases as published by the Free Software Foundation. + */ + +#ifndef _INDEX_MESSAGES_H_ +#define _INDEX_MESSAGES_H_ + +#include "glfs-message-id.h" + +/*! \file index-messages.h + * \brief INDEX 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_COMP_BASE_INDEX GLFS_MSGID_COMP_INDEX +#define GLFS_NUM_MESSAGES 10 +#define GLFS_MSGID_END (GLFS_COMP_BASE_INDEX + GLFS_NUM_MESSAGES + 1) + +#define glfs_msg_start_x GLFS_COMP_BASE_INDEX, "Invalid: Start of messages" + +/*! + * @messageid 138001 + * @diagnosis Index directory creation failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_INDEX_DIR_CREATE_FAILED (GLFS_COMP_BASE_INDEX + 1) + +/*! + * @messageid 138002 + * @diagnosis Index directory readdir failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_INDEX_READDIR_FAILED (GLFS_COMP_BASE_INDEX + 2) + +/*! + * @messageid 138003 + * @diagnosis Index addition failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_INDEX_ADD_FAILED (GLFS_COMP_BASE_INDEX + 3) + +/*! + * @messageid 138004 + * @diagnosis Index deletion failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_INDEX_DEL_FAILED (GLFS_COMP_BASE_INDEX + 4) + +/*! + * @messageid 138005 + * @diagnosis Setting option in dictionary failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_DICT_SET_FAILED (GLFS_COMP_BASE_INDEX + 5) + +/*! + * @messageid 138006 + * @diagnosis Setting/Getting inode data failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_INODE_CTX_GET_SET_FAILED (GLFS_COMP_BASE_INDEX + 6) + +/*! + * @messageid 138007 + * @diagnosis Invalid argments lead to the failure. + * @recommendedaction Brick log should give more context where it failed. + */ +#define INDEX_MSG_INVALID_ARGS (GLFS_COMP_BASE_INDEX + 7) + +/*! + * @messageid 138008 + * @diagnosis Operations on an opened file/directory failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_FD_OP_FAILED (GLFS_COMP_BASE_INDEX + 8) + +/*! + * @messageid 138009 + * @diagnosis Worker thread creation for index xlator failed. + * @recommendedaction Brick log should give the reason why it failed. + */ +#define INDEX_MSG_WORKER_THREAD_CREATE_FAILED (GLFS_COMP_BASE_INDEX + 9) + +/*! + * @messageid 138010 + * @diagnosis Index xlator needs to have single subvolume and at least one + * parent subvolume, otherwise this message will come. + * @recommendedaction Please check brick log file to find which of the above + * two conditions failed. + */ +#define INDEX_MSG_INVALID_GRAPH (GLFS_COMP_BASE_INDEX + 10) + +#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" +#endif /* !_INDEX_MESSAGES_H_ */ diff --git a/xlators/features/index/src/index.c b/xlators/features/index/src/index.c index 7b8713c89ef..f25697ebebd 100644 --- a/xlators/features/index/src/index.c +++ b/xlators/features/index/src/index.c @@ -13,6 +13,7 @@ #include "syscall.h" #include "syncop.h" #include "common-utils.h" +#include "index-messages.h" #include #define XATTROP_SUBDIR "xattrop" @@ -271,13 +272,14 @@ index_dir_create (xlator_t *this, const char *subdir) ret = 0; out: if (ret == -1) { - gf_log (this->name, GF_LOG_ERROR, "%s/%s: Failed to " - "create (%s)", priv->index_basepath, subdir, - strerror (errno)); + gf_msg (this->name, GF_LOG_ERROR, errno, + INDEX_MSG_INDEX_DIR_CREATE_FAILED, "%s/%s: Failed to " + "create", priv->index_basepath, subdir); } else if (ret == -2) { - gf_log (this->name, GF_LOG_ERROR, "%s/%s: Failed to create, " - "path exists, not a directory ", priv->index_basepath, - subdir); + gf_msg (this->name, GF_LOG_ERROR, ENOTDIR, + INDEX_MSG_INDEX_DIR_CREATE_FAILED, "%s/%s: Failed to " + "create, path exists, not a directory ", + priv->index_basepath, subdir); } return ret; } @@ -452,7 +454,8 @@ index_fill_readdir (fd_t *fd, index_fd_ctx_t *fctx, DIR *dir, off_t off, seekdir (dir, off); #ifndef GF_LINUX_HOST_OS if ((u_long)telldir(dir) != off && off != fctx->dir_eof) { - gf_log (THIS->name, GF_LOG_ERROR, + gf_msg (THIS->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INDEX_READDIR_FAILED, "seekdir(0x%llx) failed on dir=%p: " "Invalid argument (offset reused from " "another DIR * structure?)", off, dir); @@ -467,9 +470,9 @@ index_fill_readdir (fd_t *fd, index_fd_ctx_t *fctx, DIR *dir, off_t off, in_case = (u_long)telldir (dir); if (in_case == -1) { - gf_log (THIS->name, GF_LOG_ERROR, - "telldir failed on dir=%p: %s", - dir, strerror (errno)); + gf_msg (THIS->name, GF_LOG_ERROR, errno, + INDEX_MSG_INDEX_READDIR_FAILED, + "telldir failed on dir=%p", dir); goto out; } @@ -479,9 +482,9 @@ index_fill_readdir (fd_t *fd, index_fd_ctx_t *fctx, DIR *dir, off_t off, if (!entry) { if (errno == EBADF) { - gf_log (THIS->name, GF_LOG_WARNING, - "readdir failed on dir=%p: %s", - dir, strerror (errno)); + gf_msg (THIS->name, GF_LOG_WARNING, errno, + INDEX_MSG_INDEX_READDIR_FAILED, + "readdir failed on dir=%p", dir); goto out; } break; @@ -508,7 +511,8 @@ index_fill_readdir (fd_t *fd, index_fd_ctx_t *fctx, DIR *dir, off_t off, #ifndef GF_LINUX_HOST_OS if ((u_long)telldir(dir) != in_case && in_case != fctx->dir_eof) { - gf_log (THIS->name, GF_LOG_ERROR, + gf_msg (THIS->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INDEX_READDIR_FAILED, "seekdir(0x%llx) failed on dir=%p: " "Invalid argument (offset reused from " "another DIR * structure?)", @@ -524,9 +528,10 @@ index_fill_readdir (fd_t *fd, index_fd_ctx_t *fctx, DIR *dir, off_t off, this_entry = gf_dirent_for_name (entry->d_name); if (!this_entry) { - gf_log (THIS->name, GF_LOG_ERROR, - "could not create gf_dirent for entry %s: (%s)", - entry->d_name, strerror (errno)); + gf_msg (THIS->name, GF_LOG_ERROR, errno, + INDEX_MSG_INDEX_READDIR_FAILED, + "could not create gf_dirent for entry %s", + entry->d_name); goto out; } /* @@ -590,8 +595,9 @@ index_link_to_base (xlator_t *this, char *base, size_t base_len, fd = sys_creat (base, 0); if ((fd < 0) && (errno != EEXIST)) { op_errno = errno; - gf_log (this->name, GF_LOG_ERROR, "%s: Not able to " - "create index (%s)", fpath, strerror (op_errno)); + gf_msg (this->name, GF_LOG_ERROR, op_errno, + INDEX_MSG_INDEX_ADD_FAILED, "%s: Not able to " + "create index", fpath); goto out; } @@ -601,8 +607,9 @@ index_link_to_base (xlator_t *this, char *base, size_t base_len, ret = sys_link (base, fpath); if (ret && (errno != EEXIST)) { op_errno = errno; - gf_log (this->name, GF_LOG_ERROR, "%s: Not able to " - "add to index (%s)", fpath, strerror (errno)); + gf_msg (this->name, GF_LOG_ERROR, errno, + INDEX_MSG_INDEX_ADD_FAILED, "%s: Not able to " + "add to index", fpath); goto out; } out: @@ -661,8 +668,9 @@ index_del (xlator_t *this, uuid_t gfid, const char *subdir, int type) ret = sys_unlink (gfid_path); if (ret && (errno != ENOENT)) { - gf_log (this->name, GF_LOG_ERROR, "%s: failed to delete" - " from index (%s)", gfid_path, strerror (errno)); + gf_msg (this->name, GF_LOG_ERROR, errno, + INDEX_MSG_INDEX_DEL_FAILED, "%s: failed to delete" + " from index", gfid_path); ret = -errno; goto out; } @@ -789,9 +797,11 @@ index_entry_create (xlator_t *this, inode_t *inode, char *filename) ret = index_inode_ctx_get (inode, this, &ctx); if (ret) { - gf_log (this->name, GF_LOG_ERROR, "Not able to get inode ctx " - "for %s", uuid_utoa (inode->gfid)); - op_errno = ENOMEM; + op_errno = EINVAL; + gf_msg (this->name, GF_LOG_ERROR, op_errno, + INDEX_MSG_INODE_CTX_GET_SET_FAILED, + "Not able to get inode ctx for %s", + uuid_utoa (inode->gfid)); goto out; } @@ -849,9 +859,10 @@ index_entry_delete (xlator_t *this, uuid_t pgfid, char *filename) ret = sys_unlink (entry_path); if (ret && (errno != ENOENT)) { op_errno = errno; - gf_log (this->name, GF_LOG_ERROR, - "%s: failed to delete from index/entry-changes (%s)", - entry_path, strerror (op_errno)); + gf_msg (this->name, GF_LOG_ERROR, op_errno, + INDEX_MSG_INDEX_DEL_FAILED, + "%s: failed to delete from index/entry-changes", + entry_path); } out: @@ -890,7 +901,8 @@ _index_action (xlator_t *this, inode_t *inode, int *zfilled) ret = index_inode_ctx_get (inode, this, &ctx); if (ret) { - gf_log (this->name, GF_LOG_ERROR, "Not able to get" + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INODE_CTX_GET_SET_FAILED, "Not able to get" " inode context for %s.", uuid_utoa (inode->gfid)); goto out; } @@ -1417,8 +1429,9 @@ index_getxattr_wrapper (call_frame_t *frame, xlator_t *this, priv->internal_vgfid[vgfid_type], sizeof (priv->internal_vgfid[vgfid_type])); if (ret) { - ret = -ENOMEM; - gf_log (this->name, GF_LOG_ERROR, "xattrop index " + ret = -EINVAL; + gf_msg (this->name, GF_LOG_ERROR, -ret, + INDEX_MSG_DICT_SET_FAILED, "xattrop index " "gfid set failed"); goto done; } @@ -1431,8 +1444,9 @@ index_getxattr_wrapper (call_frame_t *frame, xlator_t *this, ret = dict_set_uint64 (xattr, (char *)name, count); if (ret) { - ret = -ENOMEM; - gf_log (this->name, GF_LOG_ERROR, "xattrop index " + ret = -EINVAL; + gf_msg (this->name, GF_LOG_ERROR, -ret, + INDEX_MSG_DICT_SET_FAILED, "xattrop index " "count set failed"); goto done; } @@ -1441,8 +1455,9 @@ index_getxattr_wrapper (call_frame_t *frame, xlator_t *this, ret = dict_set_uint64 (xattr, (char *)name, count); if (ret) { - ret = -ENOMEM; - gf_log (this->name, GF_LOG_ERROR, "dirty index " + ret = -EINVAL; + gf_msg (this->name, GF_LOG_ERROR, -ret, + INDEX_MSG_DICT_SET_FAILED, "dirty index " "count set failed"); goto done; } @@ -1473,13 +1488,15 @@ index_save_pargfid_for_entry_changes (xlator_t *this, loc_t *loc, char *path) ret = index_inode_ctx_get (loc->inode, this, &ctx); if (ret) { - gf_log (this->name, GF_LOG_ERROR, "Unable to get inode " - "context for %s", path); + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INODE_CTX_GET_SET_FAILED, + "Unable to get inode context for %s", path); return -EINVAL; } ret = gf_uuid_parse (loc->name, ctx->virtual_pargfid); if (ret) { - gf_log (this->name, GF_LOG_ERROR, "Unable to store " + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INODE_CTX_GET_SET_FAILED, "Unable to store " "virtual gfid in inode context for %s", path); return -EINVAL; } @@ -1546,14 +1563,14 @@ index_lookup_wrapper (call_frame_t *frame, xlator_t *this, } ret = sys_lstat (path, &lstatbuf); if (ret) { - gf_log (this->name, GF_LOG_DEBUG, "Stat failed on %s dir " - "(%s)", path, strerror (errno)); + gf_msg_debug (this->name, errno, "Stat failed on %s dir ", + path); op_errno = errno; goto done; } else if (!S_ISDIR (lstatbuf.st_mode) && is_dir) { - gf_log (this->name, GF_LOG_DEBUG, "Stat failed on %s dir, " + op_errno = ENOTDIR; + gf_msg_debug (this->name, op_errno, "Stat failed on %s dir, " "not a directory", path); - op_errno = ENOENT; goto done; } xattr = dict_new (); @@ -1653,17 +1670,18 @@ index_readdir_wrapper (call_frame_t *frame, xlator_t *this, ret = index_fd_ctx_get (fd, this, &fctx); if (ret < 0) { - gf_log (this->name, GF_LOG_WARNING, - "pfd is NULL, fd=%p", fd); op_errno = -ret; + gf_msg (this->name, GF_LOG_WARNING, op_errno, + INDEX_MSG_FD_OP_FAILED, "pfd is NULL, fd=%p", fd); goto done; } dir = fctx->dir; if (!dir) { - gf_log (this->name, GF_LOG_WARNING, - "dir is NULL for fd=%p", fd); op_errno = EINVAL; + gf_msg (this->name, GF_LOG_WARNING, op_errno, + INDEX_MSG_INDEX_READDIR_FAILED, + "dir is NULL for fd=%p", fd); goto done; } @@ -1702,9 +1720,10 @@ deletion_handler (const char *fpath, const struct stat *sb, int typeflag, break; default: type = ia_type_from_st_mode (sb->st_mode); - gf_log (THIS->name, GF_LOG_WARNING, "%s neither a regular file " - "nor a directory - type:%s", fpath, - gf_inode_type_to_str (type)); + gf_msg (THIS->name, GF_LOG_WARNING, EINVAL, + INDEX_MSG_INVALID_ARGS, + "%s neither a regular file nor a directory - type:%s", + fpath, gf_inode_type_to_str (type)); break; } return 0; @@ -1961,12 +1980,14 @@ index_fill_link_count (xlator_t *this, dict_t *xdata) if (count == 0) { ret = dict_set_int8 (xdata, "link-count", 0); if (ret < 0) - gf_log (this->name, GF_LOG_ERROR, + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_DICT_SET_FAILED, "Unable to set link-count"); } else { ret = dict_set_int8 (xdata, "link-count", 1); if (ret < 0) - gf_log (this->name, GF_LOG_ERROR, + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_DICT_SET_FAILED, "Unable to set link-count"); } @@ -2261,13 +2282,15 @@ init (xlator_t *this) char *pendinglist = NULL; if (!this->children || this->children->next) { - gf_log (this->name, GF_LOG_ERROR, + gf_msg (this->name, GF_LOG_ERROR, EINVAL, + INDEX_MSG_INVALID_GRAPH, "'index' not configured with exactly one child"); goto out; } if (!this->parents) { - gf_log (this->name, GF_LOG_WARNING, + gf_msg (this->name, GF_LOG_WARNING, EINVAL, + INDEX_MSG_INVALID_GRAPH, "dangling volume. check volfile "); } @@ -2277,29 +2300,33 @@ init (xlator_t *this) LOCK_INIT (&priv->lock); if ((ret = pthread_cond_init(&priv->cond, NULL)) != 0) { - gf_log (this->name, GF_LOG_ERROR, - "pthread_cond_init failed (%d)", ret); + gf_msg (this->name, GF_LOG_ERROR, ret, + INDEX_MSG_INVALID_ARGS, + "pthread_cond_init failed"); goto out; } cond_inited = _gf_true; if ((ret = pthread_mutex_init(&priv->mutex, NULL)) != 0) { - gf_log (this->name, GF_LOG_ERROR, - "pthread_mutex_init failed (%d)", ret); + gf_msg (this->name, GF_LOG_ERROR, ret, + INDEX_MSG_INVALID_ARGS, + "pthread_mutex_init failed"); goto out; } mutex_inited = _gf_true; if ((ret = pthread_attr_init (&w_attr)) != 0) { - gf_log (this->name, GF_LOG_ERROR, - "pthread_attr_init failed (%d)", ret); + gf_msg (this->name, GF_LOG_ERROR, ret, + INDEX_MSG_INVALID_ARGS, + "pthread_attr_init failed"); goto out; } attr_inited = _gf_true; ret = pthread_attr_setstacksize (&w_attr, INDEX_THREAD_STACK_SIZE); if (ret == EINVAL) { - gf_log (this->name, GF_LOG_WARNING, + gf_msg (this->name, GF_LOG_WARNING, ret, + INDEX_MSG_INVALID_ARGS, "Using default thread stack size"); } @@ -2329,6 +2356,7 @@ init (xlator_t *this) if (priv->pending_watchlist) priv->complete_watchlist = dict_copy_with_ref (priv->pending_watchlist, priv->complete_watchlist); + gf_uuid_generate (priv->index); for (i = 0; i < XATTROP_TYPE_END; i++) gf_uuid_generate (priv->internal_vgfid[i]); @@ -2363,8 +2391,9 @@ init (xlator_t *this) ret = gf_thread_create (&thread, &w_attr, index_worker, this); if (ret) { - gf_log (this->name, GF_LOG_WARNING, "Failed to create " - "worker thread, aborting"); + gf_msg (this->name, GF_LOG_WARNING, ret, + INDEX_MSG_WORKER_THREAD_CREATE_FAILED, + "Failed to create worker thread, aborting"); goto out; } @@ -2442,7 +2471,9 @@ index_releasedir (xlator_t *this, fd_t *fd) if (fctx->dir) { ret = sys_closedir (fctx->dir); if (ret) - gf_log (this->name, GF_LOG_ERROR, "closedir error: %s", strerror (errno)); + gf_msg (this->name, GF_LOG_ERROR, errno, + INDEX_MSG_FD_OP_FAILED, + "closedir error"); } GF_FREE (fctx); -- cgit