Upcall: Process each of the upcall events separately

As suggested during the code-review of Bug1200262, have modified
GF_CBK_UPCALL to be exlusively GF_CBK_CACHE_INVALIDATION.
Thus, for any new upcall event, a new CBK procedure will be added.

Also made changes to store upcall data separately based on the
upcall event type received.

BUG: 1217711
Change-Id: I0f5e53d6f5ece16aecb514a0a426dca40fa1c755
Signed-off-by: Soumya Koduri <skoduri@redhat.com>
Reviewed-on: http://review.gluster.org/10049
Reviewed-by: Kaleb KEITHLEY <kkeithle@redhat.com>
Reviewed-on: http://review.gluster.org/10562
Tested-by: NetBSD Build System
Tested-by: Gluster Build System <jenkins@build.gluster.com>

5 files changed, 96 insertions, 35 deletions

diff --git a/api/src/gfapi-messages.h b/api/src/gfapi-messages.h
index d7cfd8371e6..2c59af24113 100644
--- a/api/src/gfapi-messages.h
+++ b/api/src/gfapi-messages.h
@@ -96,6 +96,7 @@
 #define API_MSG_VOLFILE_INFO                    (GLFS_GFAPI_BASE + 43)
 #define API_MSG_VOLFILE_CONNECTING              (GLFS_GFAPI_BASE + 44)
 #define API_MSG_NEW_GRAPH                       (GLFS_GFAPI_BASE + 45)
+#define API_MSG_ALLOC_FAILED                    (GLFS_GFAPI_BASE + 46)
 /*------------*/
 #define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages"
 
diff --git a/api/src/glfs-fops.c b/api/src/glfs-fops.c
index ba95e021ee2..0e32ec2ee78 100644
--- a/api/src/glfs-fops.c
+++ b/api/src/glfs-fops.c
@@ -14,6 +14,7 @@
 #include "glfs-mem-types.h"
 #include "syncop.h"
 #include "glfs.h"
+#include "gfapi-messages.h"
 #include "compat-errno.h"
 #include <limits.h>
 #include "glusterfs3.h"
@@ -26,6 +27,48 @@
 
 #define READDIRBUF_SIZE (sizeof(struct dirent) + GF_NAME_MAX + 1)
 
+/*
+ * This routine is called when an upcall event of type
+ * 'GF_UPCALL_CACHE_INVALIDATION' is received.
+ * It makes a copy of the contents of the upcall cache-invalidation
+ * data received into an entry which is stored in the upcall list
+ * maintained by gfapi.
+ */
+int
+glfs_get_upcall_cache_invalidation (struct gf_upcall *to_up_data,
+                                    struct gf_upcall *from_up_data)
+{
+
+        struct gf_upcall_cache_invalidation *ca_data = NULL;
+        struct gf_upcall_cache_invalidation *f_ca_data = NULL;
+        int                                 ret      = -1;
+
+        GF_VALIDATE_OR_GOTO (THIS->name, to_up_data, out);
+        GF_VALIDATE_OR_GOTO (THIS->name, from_up_data, out);
+
+        f_ca_data = from_up_data->data;
+        GF_VALIDATE_OR_GOTO (THIS->name, f_ca_data, out);
+
+        ca_data = GF_CALLOC (1, sizeof(*ca_data),
+                            glfs_mt_upcall_entry_t);
+
+        if (!ca_data) {
+                gf_msg (THIS->name, GF_LOG_ERROR, errno,
+                        API_MSG_ALLOC_FAILED,
+                        "Upcall entry allocation failed.");
+                goto out;
+        }
+
+        to_up_data->data = ca_data;
+
+        ca_data->flags = f_ca_data->flags;
+        ca_data->expire_time_attr = f_ca_data->expire_time_attr;
+
+        ret = 0;
+out:
+        return ret;
+}
+
 int
 glfs_loc_link (loc_t *loc, struct iatt *iatt)
 {
@@ -3492,7 +3535,6 @@ void
 priv_glfs_process_upcall_event (struct glfs *fs, void *data)
 {
         int                ret             = -1;
-        inode_t            *inode          = NULL;
         uuid_t             gfid;
         upcall_entry       *u_list         = NULL;
         glusterfs_ctx_t    *ctx            = NULL;
@@ -3522,12 +3564,12 @@ priv_glfs_process_upcall_event (struct glfs *fs, void *data)
         }
         pthread_mutex_unlock (&fs->mutex);
 
+
         upcall_data = (struct gf_upcall *)data;
 
-        gf_log (THIS->name, GF_LOG_DEBUG, "Upcall gfapi gfid = %s"
+        gf_log (THIS->name, GF_LOG_TRACE, "Upcall gfapi gfid = %s"
                 "ret = %d", (char *)(upcall_data->gfid), ret);
 
-        memcpy(gfid, (char *)(upcall_data->gfid), 16);
         u_list = GF_CALLOC (1, sizeof(*u_list),
                             glfs_mt_upcall_entry_t);
 
@@ -3539,10 +3581,24 @@ priv_glfs_process_upcall_event (struct glfs *fs, void *data)
 
         INIT_LIST_HEAD (&u_list->upcall_list);
 
-        gf_uuid_copy (u_list->gfid, gfid);
-        u_list->event_type = upcall_data->event_type;
-        u_list->flags = (uint32_t)(upcall_data->flags);
-        u_list->expire_time_attr = upcall_data->expire_time_attr;
+        gf_uuid_copy (u_list->upcall_data.gfid, upcall_data->gfid);
+        u_list->upcall_data.event_type = upcall_data->event_type;
+
+        switch (upcall_data->event_type) {
+        case GF_UPCALL_CACHE_INVALIDATION:
+                ret = glfs_get_upcall_cache_invalidation (&u_list->upcall_data,
+                                                          upcall_data);
+                break;
+        default:
+                goto out;
+        }
+
+        if (ret) {
+                gf_msg (THIS->name, GF_LOG_ERROR, errno,
+                        API_MSG_INVALID_ENTRY,
+                        "Upcall entry validation failed.");
+                goto out;
+        }
 
         pthread_mutex_lock (&fs->upcall_list_mutex);
         {
@@ -3556,7 +3612,11 @@ priv_glfs_process_upcall_event (struct glfs *fs, void *data)
                 fs->pin_refcnt--;
         }
         pthread_mutex_unlock (&fs->mutex);
+
+        ret = 0;
 out:
+        if (ret && u_list)
+                GF_FREE(u_list);
         return;
 }
 
diff --git a/api/src/glfs-handleops.c b/api/src/glfs-handleops.c
index fd14b4cf70c..e22b541b4ac 100644
--- a/api/src/glfs-handleops.c
+++ b/api/src/glfs-handleops.c
@@ -1692,15 +1692,17 @@ GFAPI_SYMVER_PUBLIC_DEFAULT(glfs_h_rename, 3.4.2);
 int
 pub_glfs_h_poll_upcall (struct glfs *fs, struct callback_arg *up_arg)
 {
-        struct glfs_object  *object   = NULL;
-        uuid_t              gfid;
-        upcall_entry        *u_list   = NULL;
-        upcall_entry        *tmp      = NULL;
-        xlator_t            *subvol   = NULL;
-        int                 found     = 0;
-        int                 reason    = 0;
-        glusterfs_ctx_t     *ctx      = NULL;
-        int                 ret       = -1;
+        struct glfs_object                  *object         = NULL;
+        uuid_t                              gfid;
+        upcall_entry                        *u_list         = NULL;
+        upcall_entry                        *tmp            = NULL;
+        xlator_t                            *subvol         = NULL;
+        int                                 found           = 0;
+        int                                 reason          = 0;
+        glusterfs_ctx_t                     *ctx            = NULL;
+        int                                 ret             = -1;
+        struct gf_upcall                    *upcall_data    = NULL;
+        struct gf_upcall_cache_invalidation *ca_data        = NULL;
 
         if (!fs || !up_arg) {
                 errno = EINVAL;
@@ -1740,7 +1742,7 @@ pub_glfs_h_poll_upcall (struct glfs *fs, struct callback_arg *up_arg)
                 list_for_each_entry_safe (u_list, tmp,
                                           &fs->upcall_list,
                                           upcall_list) {
-                        gf_uuid_copy (gfid, u_list->gfid);
+                        gf_uuid_copy (gfid, u_list->upcall_data.gfid);
                         found = 1;
                         break;
                 }
@@ -1758,12 +1760,19 @@ pub_glfs_h_poll_upcall (struct glfs *fs, struct callback_arg *up_arg)
                         goto out;
                 }
 
-                switch (u_list->event_type) {
-                case CACHE_INVALIDATION:
+                upcall_data = &u_list->upcall_data;
+
+                switch (upcall_data->event_type) {
+                case GF_UPCALL_CACHE_INVALIDATION:
                         /* XXX: Need to revisit this to support
                          * GFAPI_INODE_UPDATE if required.
                          */
+                        ca_data = upcall_data->data;
+                        GF_VALIDATE_OR_GOTO ("glfs_h_poll_upcall",
+                                             ca_data, out);
                         reason = GFAPI_INODE_INVALIDATE;
+                        up_arg->flags = ca_data->flags;
+                        up_arg->expire_time_attr = ca_data->expire_time_attr;
                         break;
                 default:
                         break;
@@ -1771,10 +1780,9 @@ pub_glfs_h_poll_upcall (struct glfs *fs, struct callback_arg *up_arg)
 
                 up_arg->object = object;
                 up_arg->reason = reason;
-                up_arg->flags = u_list->flags;
-                up_arg->expire_time_attr = u_list->expire_time_attr;
 
                 list_del_init (&u_list->upcall_list);
+                GF_FREE (u_list->upcall_data.data);
                 GF_FREE (u_list);
         }
 
diff --git a/api/src/glfs-internal.h b/api/src/glfs-internal.h
index faa53dd3225..20fbb5c3201 100644
--- a/api/src/glfs-internal.h
+++ b/api/src/glfs-internal.h
@@ -13,6 +13,7 @@
 #define _GLFS_INTERNAL_H
 
 #include "xlator.h"
+#include "glusterfs.h"
 
 #define GLFS_SYMLINK_MAX_FOLLOW 2048
 
@@ -108,22 +109,9 @@
 
 struct glfs;
 
-/* This enum should be in sync with
- * 'upcall_event_type' declared in
- * 'xlators/features/upcall/src/upcall.h'
- */
-enum upcall_event_type_t {
-        EVENT_NULL,
-        CACHE_INVALIDATION,
-};
-typedef enum upcall_event_type_t upcall_event_type;
-
 struct _upcall_entry_t {
         struct list_head  upcall_list;
-        uuid_t            gfid;
-        upcall_event_type event_type;
-        uint32_t          flags;
-        uint32_t          expire_time_attr;
+        struct gf_upcall  upcall_data;
 };
 typedef struct _upcall_entry_t upcall_entry;
 
@@ -345,5 +333,7 @@ struct glfs *glfs_new_from_ctx (glusterfs_ctx_t *ctx)
 void glfs_free_from_ctx (struct glfs *fs)
          GFAPI_PRIVATE(glfs_free_from_ctx, 3.7.0);
 
+int glfs_get_upcall_cache_invalidation (struct gf_upcall *to_up_data,
+                                        struct gf_upcall *from_up_data);
 
 #endif /* !_GLFS_INTERNAL_H */
diff --git a/api/src/glfs.c b/api/src/glfs.c
index 12ca751e34d..23377f651d1 100644
--- a/api/src/glfs.c
+++ b/api/src/glfs.c
@@ -709,6 +709,8 @@ priv_glfs_free_from_ctx (struct glfs *fs)
                                   &fs->upcall_list,
                                   upcall_list) {
                 list_del_init (&u_list->upcall_list);
+                GF_FREE (u_list->upcall_data.data);
+                GF_FREE (u_list);
         }
         (void) pthread_mutex_destroy (&fs->upcall_list_mutex);