protocol/client: structure logging

convert gf_msg() to gf_smsg()

Updates: #657

Change-Id: I76a09cfd283bb4ec5c4358536da66547aaf0de31
Signed-off-by: yatip <ypadia@redhat.com>

6 files changed, 83 insertions, 71 deletions

diff --git a/xlators/protocol/client/src/client-callback.c b/xlators/protocol/client/src/client-callback.c
index a5cc3d5cd35..d83d9c14899 100644
--- a/xlators/protocol/client/src/client-callback.c
+++ b/xlators/protocol/client/src/client-callback.c
@@ -16,24 +16,21 @@
 static int
 client_cbk_null(struct rpc_clnt *rpc, void *mydata, void *data)
 {
-    gf_msg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR,
-           "this function should not be called");
+    gf_smsg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR, NULL);
     return 0;
 }
 
 static int
 client_cbk_fetchspec(struct rpc_clnt *rpc, void *mydata, void *data)
 {
-    gf_msg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR,
-           "this function should not be called");
+    gf_smsg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR, NULL);
     return 0;
 }
 
 static int
 client_cbk_ino_flush(struct rpc_clnt *rpc, void *mydata, void *data)
 {
-    gf_msg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR,
-           "this function should not be called");
+    gf_smsg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_FUNCTION_CALL_ERROR, NULL);
     return 0;
 }
 
@@ -61,8 +58,8 @@ client_cbk_recall_lease(struct rpc_clnt *rpc, void *mydata, void *data)
                          (xdrproc_t)xdr_gfs3_recall_lease_req);
 
     if (ret < 0) {
-        gf_msg(THIS->name, GF_LOG_WARNING, -ret, PC_MSG_RECALL_LEASE_FAIL,
-               "XDR decode of recall lease failed.");
+        gf_smsg(THIS->name, GF_LOG_WARNING, -ret, PC_MSG_RECALL_LEASE_FAIL,
+                NULL);
         goto out;
     }
 
@@ -113,8 +110,8 @@ client_cbk_cache_invalidation(struct rpc_clnt *rpc, void *mydata, void *data)
                          (xdrproc_t)xdr_gfs3_cbk_cache_invalidation_req);
 
     if (ret < 0) {
-        gf_msg(THIS->name, GF_LOG_WARNING, -ret, PC_MSG_CACHE_INVALIDATION_FAIL,
-               "XDR decode of cache_invalidation failed.");
+        gf_smsg(THIS->name, GF_LOG_WARNING, -ret,
+                PC_MSG_CACHE_INVALIDATION_FAIL, NULL);
         goto out;
     }
 
@@ -205,8 +202,8 @@ client_cbk_inodelk_contention(struct rpc_clnt *rpc, void *mydata, void *data)
                          (xdrproc_t)xdr_gfs4_inodelk_contention_req);
 
     if (ret < 0) {
-        gf_msg(THIS->name, GF_LOG_WARNING, -ret, PC_MSG_INODELK_CONTENTION_FAIL,
-               "XDR decode of inodelk contention failed.");
+        gf_smsg(THIS->name, GF_LOG_WARNING, -ret,
+                PC_MSG_INODELK_CONTENTION_FAIL, NULL);
         goto out;
     }
 
@@ -256,8 +253,8 @@ client_cbk_entrylk_contention(struct rpc_clnt *rpc, void *mydata, void *data)
                          (xdrproc_t)xdr_gfs4_entrylk_contention_req);
 
     if (ret < 0) {
-        gf_msg(THIS->name, GF_LOG_WARNING, -ret, PC_MSG_ENTRYLK_CONTENTION_FAIL,
-               "XDR decode of entrylk contention failed.");
+        gf_smsg(THIS->name, GF_LOG_WARNING, -ret,
+                PC_MSG_ENTRYLK_CONTENTION_FAIL, NULL);
         goto out;
     }
 
diff --git a/xlators/protocol/client/src/client-common.c b/xlators/protocol/client/src/client-common.c
index 64db98d661b..db56b2dbd93 100644
--- a/xlators/protocol/client/src/client-common.c
+++ b/xlators/protocol/client/src/client-common.c
@@ -714,8 +714,8 @@ client_pre_lk(xlator_t *this, gfs3_lk_req *req, int32_t cmd,
     ret = client_cmd_to_gf_cmd(cmd, &gf_cmd);
     if (ret) {
         op_errno = EINVAL;
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         goto out;
     }
 
@@ -827,8 +827,8 @@ client_pre_inodelk(xlator_t *this, gfs3_inodelk_req *req, loc_t *loc, int cmd,
     else if (cmd == F_SETLKW || cmd == F_SETLKW64)
         gf_cmd = GF_LK_SETLKW;
     else {
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         op_errno = EINVAL;
         goto out;
     }
@@ -877,8 +877,8 @@ client_pre_finodelk(xlator_t *this, gfs3_finodelk_req *req, fd_t *fd, int cmd,
     else if (cmd == F_SETLKW || cmd == F_SETLKW64)
         gf_cmd = GF_LK_SETLKW;
     else {
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         goto out;
     }
 
@@ -2895,8 +2895,8 @@ client_pre_lk_v2(xlator_t *this, gfx_lk_req *req, int32_t cmd,
     ret = client_cmd_to_gf_cmd(cmd, &gf_cmd);
     if (ret) {
         op_errno = EINVAL;
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         goto out;
     }
 
@@ -3005,8 +3005,8 @@ client_pre_inodelk_v2(xlator_t *this, gfx_inodelk_req *req, loc_t *loc, int cmd,
     else if (cmd == F_SETLKW || cmd == F_SETLKW64)
         gf_cmd = GF_LK_SETLKW;
     else {
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         op_errno = EINVAL;
         goto out;
     }
@@ -3055,8 +3055,8 @@ client_pre_finodelk_v2(xlator_t *this, gfx_finodelk_req *req, fd_t *fd, int cmd,
     else if (cmd == F_SETLKW || cmd == F_SETLKW64)
         gf_cmd = GF_LK_SETLKW;
     else {
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_INVALID_ENTRY,
-               "Unknown cmd (%d)!", gf_cmd);
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_UNKNOWN_CMD,
+                "gf_cmd=%d", gf_cmd, NULL);
         goto out;
     }
 
diff --git a/xlators/protocol/client/src/client-helpers.c b/xlators/protocol/client/src/client-helpers.c
index e49647faa6f..189dfddd021 100644
--- a/xlators/protocol/client/src/client-helpers.c
+++ b/xlators/protocol/client/src/client-helpers.c
@@ -91,23 +91,23 @@ this_fd_set_ctx(fd_t *file, xlator_t *this, loc_t *loc, clnt_fd_ctx_t *ctx)
     ret = fd_ctx_get(file, this, &oldaddr);
     if (ret >= 0) {
         if (loc)
-            gf_msg(this->name, GF_LOG_INFO, 0, PC_MSG_FD_DUPLICATE_TRY,
-                   "%s (%s): trying duplicate remote fd set. ", loc->path,
-                   uuid_utoa(loc->inode->gfid));
+            gf_smsg(this->name, GF_LOG_INFO, 0, PC_MSG_FD_DUPLICATE_TRY,
+                    "path=%s", loc->path, "gfid=%s",
+                    uuid_utoa(loc->inode->gfid), NULL);
         else
-            gf_msg(this->name, GF_LOG_INFO, 0, PC_MSG_FD_DUPLICATE_TRY,
-                   "%p: trying duplicate remote fd set. ", file);
+            gf_smsg(this->name, GF_LOG_INFO, 0, PC_MSG_FD_DUPLICATE_TRY,
+                    "file=%p", file, NULL);
     }
 
     ret = fd_ctx_set(file, this, (uint64_t)(unsigned long)ctx);
     if (ret < 0) {
         if (loc)
-            gf_msg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_SET_FAIL,
-                   "%s (%s): failed to set remote fd", loc->path,
-                   uuid_utoa(loc->inode->gfid));
+            gf_smsg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_SET_FAIL,
+                    "path=%s", loc->path, "gfid=%s",
+                    uuid_utoa(loc->inode->gfid), NULL);
         else
-            gf_msg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_SET_FAIL,
-                   "%p: failed to set remote fd", file);
+            gf_smsg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_SET_FAIL,
+                    "file=%p", file, NULL);
     }
 out:
     return;
@@ -213,9 +213,8 @@ unserialize_rsp_direntp(xlator_t *this, fd_t *fd, struct gfs3_readdirp_rsp *rsp,
             ret = dict_unserialize(trav->dict.dict_val, trav->dict.dict_len,
                                    &entry->dict);
             if (ret < 0) {
-                gf_msg(THIS->name, GF_LOG_WARNING, EINVAL,
-                       PC_MSG_DICT_UNSERIALIZE_FAIL,
-                       "failed to unserialize xattr dict");
+                gf_smsg(THIS->name, GF_LOG_WARNING, EINVAL,
+                        PC_MSG_DICT_UNSERIALIZE_FAIL, "xattr", NULL);
                 goto out;
             }
         }
@@ -538,7 +537,7 @@ clnt_unserialize_rsp_locklist(xlator_t *this, struct gfs3_getactivelk_rsp *rsp,
     while (trav) {
         temp = GF_CALLOC(1, sizeof(*lmi), gf_common_mt_lock_mig);
         if (temp == NULL) {
-            gf_msg(this->name, GF_LOG_ERROR, 0, 0, "No memory");
+            gf_smsg(this->name, GF_LOG_ERROR, 0, PC_MSG_NO_MEM, NULL);
             goto out;
         }
 
@@ -578,7 +577,7 @@ clnt_unserialize_rsp_locklist_v2(xlator_t *this,
     while (trav) {
         temp = GF_CALLOC(1, sizeof(*lmi), gf_common_mt_lock_mig);
         if (temp == NULL) {
-            gf_msg(this->name, GF_LOG_ERROR, 0, 0, "No memory");
+            gf_smsg(this->name, GF_LOG_ERROR, 0, PC_MSG_NO_MEM, NULL);
             goto out;
         }
 
@@ -662,8 +661,8 @@ serialize_req_locklist(lock_migration_info_t *locklist,
                 break;
 
             default:
-                gf_msg(THIS->name, GF_LOG_ERROR, 0, 0,
-                       "Unknown lock type: %" PRId32 "!", tmp->flock.l_type);
+                gf_smsg(THIS->name, GF_LOG_ERROR, 0, PC_MSG_UNKNOWN_LOCK_TYPE,
+                        "type=%" PRId32, tmp->flock.l_type, NULL);
                 break;
         }
 
@@ -673,8 +672,8 @@ serialize_req_locklist(lock_migration_info_t *locklist,
 
         trav->client_uid = gf_strdup(tmp->client_uid);
         if (!trav->client_uid) {
-            gf_msg(THIS->name, GF_LOG_ERROR, 0, 0,
-                   "client_uid could not be allocated");
+            gf_smsg(THIS->name, GF_LOG_ERROR, 0, PC_MSG_CLIENT_UID_ALLOC_FAILED,
+                    NULL);
             ret = -1;
             goto out;
         }
@@ -725,8 +724,8 @@ serialize_req_locklist_v2(lock_migration_info_t *locklist,
                 break;
 
             default:
-                gf_msg(THIS->name, GF_LOG_ERROR, 0, 0,
-                       "Unknown lock type: %" PRId32 "!", tmp->flock.l_type);
+                gf_smsg(THIS->name, GF_LOG_ERROR, 0, PC_MSG_UNKNOWN_LOCK_TYPE,
+                        "type=%" PRId32, tmp->flock.l_type, NULL);
                 break;
         }
 
@@ -736,8 +735,8 @@ serialize_req_locklist_v2(lock_migration_info_t *locklist,
 
         trav->client_uid = gf_strdup(tmp->client_uid);
         if (!trav->client_uid) {
-            gf_msg(THIS->name, GF_LOG_ERROR, 0, 0,
-                   "client_uid could not be allocated");
+            gf_smsg(THIS->name, GF_LOG_ERROR, 0, PC_MSG_CLIENT_UID_ALLOC_FAILED,
+                    NULL);
             ret = -1;
             goto out;
         }
diff --git a/xlators/protocol/client/src/client-lk.c b/xlators/protocol/client/src/client-lk.c
index c1fb055fc0e..795839734c5 100644
--- a/xlators/protocol/client/src/client-lk.c
+++ b/xlators/protocol/client/src/client-lk.c
@@ -24,14 +24,12 @@ __dump_client_lock(client_posix_lock_t *lock)
 
     this = THIS;
 
-    gf_msg(this->name, GF_LOG_INFO, 0, PC_MSG_CLIENT_LOCK_INFO,
-           "{fd=%p}"
-           "{%s lk-owner:%s %" PRId64 " - %" PRId64
-           "}"
-           "{start=%" PRId64 " end=%" PRId64 "}",
-           lock->fd, lock->fl_type == F_WRLCK ? "Write-Lock" : "Read-Lock",
-           lkowner_utoa(&lock->owner), lock->user_flock.l_start,
-           lock->user_flock.l_len, lock->fl_start, lock->fl_end);
+    gf_smsg(
+        this->name, GF_LOG_INFO, 0, PC_MSG_CLIENT_LOCK_INFO, "fd=%p", lock->fd,
+        "fl_type=%s", lock->fl_type == F_WRLCK ? "Write-Lock" : "Read-Lock",
+        "lk-owner=%s", lkowner_utoa(&lock->owner), "l_start=%" PRId64,
+        lock->user_flock.l_start, "l_len=%" PRId64, lock->user_flock.l_len,
+        "start=%" PRId64, lock->fl_start, "end=%" PRId64, lock->fl_end, NULL);
 }
 
 static int
@@ -203,9 +201,7 @@ subtract_locks(client_posix_lock_t *big, client_posix_lock_t *small)
         memcpy(v.locks[1], small, sizeof(client_posix_lock_t));
     } else {
         /* LOG-TODO : decide what more info is required here*/
-        gf_msg("client-protocol", GF_LOG_CRITICAL, 0, PC_MSG_LOCK_ERROR,
-               "Unexpected case in subtract_locks. Please send "
-               "a bug report to gluster-devel@gluster.org");
+        gf_smsg("client-protocol", GF_LOG_CRITICAL, 0, PC_MSG_LOCK_ERROR, NULL);
     }
 
     return v;
@@ -343,8 +339,8 @@ delete_granted_locks_owner(fd_t *fd, gf_lkowner_t *owner)
     if (!fdctx) {
         pthread_spin_unlock(&conf->fd_lock);
 
-        gf_msg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_FD_CTX_INVALID,
-               "fdctx not valid");
+        gf_smsg(this->name, GF_LOG_WARNING, EINVAL, PC_MSG_FD_CTX_INVALID,
+                NULL);
         ret = -1;
         goto out;
     }
@@ -461,8 +457,7 @@ client_add_lock_for_recovery(fd_t *fd, struct gf_flock *flock,
     if (!fdctx) {
         pthread_spin_unlock(&conf->fd_lock);
 
-        gf_msg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_GET_FAIL,
-               "failed to get fd context. sending EBADFD");
+        gf_smsg(this->name, GF_LOG_WARNING, 0, PC_MSG_FD_GET_FAIL, NULL);
         ret = -EBADFD;
         goto out;
     }
@@ -498,8 +493,8 @@ client_dump_locks(char *name, inode_t *inode, dict_t *dict)
 
     ret = dict_set_dynstr(new_dict, CLIENT_DUMP_LOCKS, dict_string);
     if (ret) {
-        gf_msg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_DICT_SET_FAILED,
-               "could not set dict with %s", CLIENT_DUMP_LOCKS);
+        gf_smsg(THIS->name, GF_LOG_WARNING, 0, PC_MSG_DICT_SET_FAIL, "lock=%s",
+                CLIENT_DUMP_LOCKS, NULL);
         goto out;
     }
 
diff --git a/xlators/protocol/client/src/client-messages.h b/xlators/protocol/client/src/client-messages.h
index 2c8049f93d9..25a851d80b9 100644
--- a/xlators/protocol/client/src/client-messages.h
+++ b/xlators/protocol/client/src/client-messages.h
@@ -60,7 +60,8 @@ GLFS_MSGID(
     PC_MSG_NOREMOTE_HOST, PC_MSG_REMOTE_SUBVOL_NOT_GIVEN,
     PC_MSG_FATAL_CLIENT_PROTOCOL, PC_MSG_VOL_DANGLING,
     PC_MSG_CREATE_MEM_POOL_FAILED, PC_MSG_PVT_XLATOR_NULL, PC_MSG_XLATOR_NULL,
-    PC_MSG_LEASE_FOP_FAILED);
+    PC_MSG_LEASE_FOP_FAILED, PC_MSG_DICT_SET_FAIL, PC_MSG_NO_MEM,
+    PC_MSG_UNKNOWN_LOCK_TYPE, PC_MSG_CLIENT_UID_ALLOC_FAILED);
 
 #define PC_MSG_REMOTE_OP_FAILED_STR "remote operation failed."
 #define PC_MSG_XDR_DECODING_FAILED_STR "XDR decoding failed"
@@ -148,4 +149,26 @@ GLFS_MSGID(
 #define PC_MSG_XLATOR_NULL_STR "xlator is NULL"
 #define PC_MSG_PVT_XLATOR_NULL_STR "private structure of the xlator is NULL"
 #define PC_MSG_LEASE_FOP_FAILED_STR "Lease fop failed"
+#define PC_MSG_LOCK_ERROR_STR                                                  \
+    "Unexpected case in subtract_locks. Please send a bug report to "          \
+    "gluster-devel@gluster.org"
+#define PC_MSG_FD_CTX_INVALID_STR "fdctx not valid"
+#define PC_MSG_FD_GET_FAIL_STR "failed to get fd context. sending EBADFD"
+#define PC_MSG_DICT_SET_FAIL_STR "could not set dict"
+#define PC_MSG_CLIENT_LOCK_INFO_STR "client lock info"
+#define PC_MSG_BAD_FD_STR "remote_fd is -1. EBADFD"
+#define PC_MSG_FUNCTION_CALL_ERROR_STR "this function should not be called"
+#define PC_MSG_RECALL_LEASE_FAIL_STR "XDR decode of recall lease failed"
+#define PC_MSG_CACHE_INVALIDATION_FAIL_STR                                     \
+    "XDR decode of cache_invalidation failed"
+#define PC_MSG_INODELK_CONTENTION_FAIL_STR                                     \
+    "XDR decode of inodelk contention failed"
+#define PC_MSG_ENTRYLK_CONTENTION_FAIL_STR                                     \
+    "XDR decode of entrylk contention failed"
+#define PC_MSG_FD_DUPLICATE_TRY_STR "trying duplicate remote fd set"
+#define PC_MSG_FD_SET_FAIL_STR "failed to set remote-fd"
+#define PC_MSG_NO_MEM_STR "No memory"
+#define PC_MSG_UNKNOWN_LOCK_TYPE_STR "Unknown lock type"
+#define PC_MSG_CLIENT_UID_ALLOC_FAILED_STR "client-uid could not be allocated"
+
 #endif /* !_PC_MESSAGES_H__ */
diff --git a/xlators/protocol/client/src/client.h b/xlators/protocol/client/src/client.h
index 3b47d1207bc..ab799c41755 100644
--- a/xlators/protocol/client/src/client.h
+++ b/xlators/protocol/client/src/client.h
@@ -63,10 +63,8 @@ typedef enum {
             goto label;                                                        \
         }                                                                      \
         if (remote_fd == -1) {                                                 \
-            gf_msg(xl->name, GF_LOG_WARNING, EBADFD, PC_MSG_BAD_FD,            \
-                   " (%s) "                                                    \
-                   "remote_fd is -1. EBADFD",                                  \
-                   uuid_utoa(fd->inode->gfid));                                \
+            gf_smsg(xl->name, GF_LOG_WARNING, EBADFD, PC_MSG_BAD_FD,           \
+                    "gfid=%s", uuid_utoa(fd->inode->gfid), NULL);              \
             op_errno = EBADFD;                                                 \
             goto label;                                                        \
         }                                                                      \