afb-proto-ws: Add message for unexpected event
[src/app-framework-binder.git] / src / afb-evt.c
index 960d413..1c8798f 100644 (file)
@@ -30,6 +30,8 @@
 #include "afb-evt.h"
 #include "afb-hook.h"
 #include "verbose.h"
+#include "jobs.h"
+#include "uuid.h"
 
 struct afb_evt_watch;
 
@@ -54,7 +56,7 @@ struct afb_evt_listener {
        pthread_rwlock_t rwlock;
 
        /* count of reference to the listener */
-       int refcount;
+       uint16_t refcount;
 };
 
 /*
@@ -80,10 +82,13 @@ struct afb_evtid {
 #endif
 
        /* refcount */
-       int refcount;
+       uint16_t refcount;
 
        /* id of the event */
-       int id;
+       uint16_t id;
+
+       /* has client? */
+       int has_client;
 
        /* fullname of the event */
        char fullname[];
@@ -110,6 +115,36 @@ struct afb_evt_watch {
        unsigned activity;
 };
 
+/*
+ * structure for job of broadcasting events
+ */
+struct job_broadcast
+{
+       /** object atached to the event */
+       struct json_object *object;
+
+       /** the uuid of the event */
+       uuid_binary_t  uuid;
+
+       /** remaining hop */
+       uint8_t hop;
+
+       /** name of the event to broadcast */
+       char event[];
+};
+
+/*
+ * structure for job of broadcasting or pushing events
+ */
+struct job_evtid
+{
+       /** the event to broadcast */
+       struct afb_evtid *evtid;
+
+       /** object atached to the event */
+       struct json_object *object;
+};
+
 /* the interface for events */
 static struct afb_event_x2_itf afb_evt_event_x2_itf = {
        .broadcast = (void*)afb_evt_evtid_broadcast,
@@ -130,6 +165,10 @@ static struct afb_event_x2_itf afb_evt_hooked_event_x2_itf = {
 };
 #endif
 
+/* job groups for events push/broadcast */
+#define BROADCAST_JOB_GROUP  (&afb_evt_event_x2_itf)
+#define PUSH_JOB_GROUP       (&afb_evt_event_x2_itf)
+
 /* head of the list of listeners */
 static pthread_rwlock_t listeners_rwlock = PTHREAD_RWLOCK_INITIALIZER;
 static struct afb_evt_listener *listeners = NULL;
@@ -137,61 +176,171 @@ static struct afb_evt_listener *listeners = NULL;
 /* handling id of events */
 static pthread_rwlock_t events_rwlock = PTHREAD_RWLOCK_INITIALIZER;
 static struct afb_evtid *evtids = NULL;
-static int event_id_counter = 0;
-static int event_id_wrapped = 0;
+static uint16_t event_genid = 0;
+static uint16_t event_count = 0;
+
+/* head of uniqueness of events */
+#if !defined(EVENT_BROADCAST_HOP_MAX)
+#  define EVENT_BROADCAST_HOP_MAX  10
+#endif
+#if !defined(EVENT_BROADCAST_MEMORY_COUNT)
+#  define EVENT_BROADCAST_MEMORY_COUNT  8
+#endif
+
+#if EVENT_BROADCAST_MEMORY_COUNT
+static struct {
+       pthread_mutex_t mutex;
+       uint8_t base;
+       uint8_t count;
+       uuid_binary_t uuids[EVENT_BROADCAST_MEMORY_COUNT];
+} uniqueness = {
+       .mutex = PTHREAD_MUTEX_INITIALIZER,
+       .base = 0,
+       .count = 0
+};
+#endif
 
 /*
- * Broadcasts the 'event' of 'id' with its 'obj'
- * 'obj' is released (like json_object_put)
- * Returns the count of listener having receive the event.
+ * Create structure for job of broadcasting string 'event' with 'object'
+ * Returns the created structure or NULL if out of memory
  */
-static int broadcast(const char *event, struct json_object *obj, int id)
+static struct job_broadcast *make_job_broadcast(const char *event, struct json_object *object, const uuid_binary_t uuid, uint8_t hop)
 {
-       int result;
-       struct afb_evt_listener *listener;
+       size_t sz = 1 + strlen(event);
+       struct job_broadcast *jb = malloc(sz + sizeof *jb);
+       if (jb) {
+               jb->object = object;
+               memcpy(jb->uuid, uuid, sizeof jb->uuid);
+               jb->hop = hop;
+               memcpy(jb->event, event, sz);
+       }
+       return jb;
+}
 
-       result = 0;
+/*
+ * Destroy structure 'jb' for job of broadcasting string events
+ */
+static void destroy_job_broadcast(struct job_broadcast *jb)
+{
+       json_object_put(jb->object);
+       free(jb);
+}
+
+/*
+ * Create structure for job of broadcasting or pushing 'evtid' with 'object'
+ * Returns the created structure or NULL if out of memory
+ */
+static struct job_evtid *make_job_evtid(struct afb_evtid *evtid, struct json_object *object)
+{
+       struct job_evtid *je = malloc(sizeof *je);
+       if (je) {
+               je->evtid = afb_evt_evtid_addref(evtid);
+               je->object = object;
+       }
+       return je;
+}
+
+/*
+ * Destroy structure for job of broadcasting or pushing evtid
+ */
+static void destroy_job_evtid(struct job_evtid *je)
+{
+       afb_evt_evtid_unref(je->evtid);
+       json_object_put(je->object);
+       free(je);
+}
+
+/*
+ * Broadcasts the 'event' of 'id' with its 'object'
+ */
+static void broadcast(struct job_broadcast *jb)
+{
+       struct afb_evt_listener *listener;
 
        pthread_rwlock_rdlock(&listeners_rwlock);
        listener = listeners;
        while(listener) {
-               if (listener->itf->broadcast != NULL) {
-                       listener->itf->broadcast(listener->closure, event, id, json_object_get(obj));
-                       result++;
-               }
+               if (listener->itf->broadcast != NULL)
+                       listener->itf->broadcast(listener->closure, jb->event, json_object_get(jb->object), jb->uuid, jb->hop);
                listener = listener->next;
        }
        pthread_rwlock_unlock(&listeners_rwlock);
-       json_object_put(obj);
-       return result;
 }
 
-#if WITH_AFB_HOOK
 /*
- * Broadcasts the 'event' of 'id' with its 'obj'
- * 'obj' is released (like json_object_put)
- * calls hooks if hookflags isn't 0
- * Returns the count of listener having receive the event.
+ * Jobs callback for broadcasting string asynchronously
  */
-static int hooked_broadcast(const char *event, struct json_object *obj, int id, int hookflags)
+static void broadcast_job(int signum, void *closure)
 {
-       int result;
-
-       json_object_get(obj);
+       struct job_broadcast *jb = closure;
 
-       if (hookflags & afb_hook_flag_evt_broadcast_before)
-               afb_hook_evt_broadcast_before(event, id, obj);
+       if (signum == 0)
+               broadcast(jb);
+       destroy_job_broadcast(jb);
+}
 
-       result = broadcast(event, obj, id);
+/*
+ * Broadcasts the string 'event' with its 'object'
+ */
+static int unhooked_broadcast(const char *event, struct json_object *object, const uuid_binary_t uuid, uint8_t hop)
+{
+       uuid_binary_t local_uuid;
+       struct job_broadcast *jb;
+       int rc;
+#if EVENT_BROADCAST_MEMORY_COUNT
+       int iter, count;
+#endif
 
-       if (hookflags & afb_hook_flag_evt_broadcast_after)
-               afb_hook_evt_broadcast_after(event, id, obj, result);
+       /* check if lately sent */
+       if (!uuid) {
+               uuid_new_binary(local_uuid);
+               uuid = local_uuid;
+               hop = EVENT_BROADCAST_HOP_MAX;
+#if EVENT_BROADCAST_MEMORY_COUNT
+               pthread_mutex_lock(&uniqueness.mutex);
+       } else {
+               pthread_mutex_lock(&uniqueness.mutex);
+               iter = (int)uniqueness.base;
+               count = (int)uniqueness.count;
+               while (count) {
+                       if (0 == memcmp(uuid, uniqueness.uuids[iter], sizeof(uuid_binary_t))) {
+                               pthread_mutex_unlock(&uniqueness.mutex);
+                               return 0;
+                       }
+                       if (++iter == EVENT_BROADCAST_MEMORY_COUNT)
+                               iter = 0;
+                       count--;
+               }
+       }
+       iter = (int)uniqueness.base;
+       if (uniqueness.count < EVENT_BROADCAST_MEMORY_COUNT)
+               iter += (int)(uniqueness.count++);
+       else if (++uniqueness.base == EVENT_BROADCAST_MEMORY_COUNT)
+               uniqueness.base = 0;
+       memcpy(uniqueness.uuids[iter], uuid, sizeof(uuid_binary_t));
+       pthread_mutex_unlock(&uniqueness.mutex);
+#else
+       }
+#endif
 
-       json_object_put(obj);
+       /* create the structure for the job */
+       jb = make_job_broadcast(event, object, uuid, hop);
+       if (jb == NULL) {
+               ERROR("Cant't create broadcast string job item for %s(%s)",
+                       event, json_object_to_json_string(object));
+               json_object_put(object);
+               return -1;
+       }
 
-       return result;
+       /* queue the job */
+       rc = jobs_queue(BROADCAST_JOB_GROUP, 0, broadcast_job, jb);
+       if (rc) {
+               ERROR("cant't queue broadcast string job item for %s(%s)",
+                       event, json_object_to_json_string(object));
+               destroy_job_broadcast(jb);
+       }
+       return rc;
 }
-#endif
 
 /*
  * Broadcasts the event 'evtid' with its 'object'
@@ -200,7 +349,7 @@ static int hooked_broadcast(const char *event, struct json_object *obj, int id,
  */
 int afb_evt_evtid_broadcast(struct afb_evtid *evtid, struct json_object *object)
 {
-       return broadcast(evtid->fullname, object, evtid->id);
+       return unhooked_broadcast(evtid->fullname, object, NULL, 0);
 }
 
 #if WITH_AFB_HOOK
@@ -211,10 +360,42 @@ int afb_evt_evtid_broadcast(struct afb_evtid *evtid, struct json_object *object)
  */
 int afb_evt_evtid_hooked_broadcast(struct afb_evtid *evtid, struct json_object *object)
 {
-       return hooked_broadcast(evtid->fullname, object, evtid->id, evtid->hookflags);
+       int result;
+
+       json_object_get(object);
+
+       if (evtid->hookflags & afb_hook_flag_evt_broadcast_before)
+               afb_hook_evt_broadcast_before(evtid->fullname, evtid->id, object);
+
+       result = afb_evt_evtid_broadcast(evtid, object);
+
+       if (evtid->hookflags & afb_hook_flag_evt_broadcast_after)
+               afb_hook_evt_broadcast_after(evtid->fullname, evtid->id, object, result);
+
+       json_object_put(object);
+
+       return result;
 }
 #endif
 
+int afb_evt_rebroadcast(const char *event, struct json_object *object, const uuid_binary_t uuid, uint8_t hop)
+{
+       int result;
+
+#if WITH_AFB_HOOK
+       json_object_get(object);
+       afb_hook_evt_broadcast_before(event, 0, object);
+#endif
+
+       result = unhooked_broadcast(event, object, uuid, hop);
+
+#if WITH_AFB_HOOK
+       afb_hook_evt_broadcast_after(event, 0, object, result);
+       json_object_put(object);
+#endif
+       return result;
+}
+
 /*
  * Broadcasts the 'event' with its 'object'
  * 'object' is released (like json_object_put)
@@ -222,39 +403,76 @@ int afb_evt_evtid_hooked_broadcast(struct afb_evtid *evtid, struct json_object *
  */
 int afb_evt_broadcast(const char *event, struct json_object *object)
 {
-#if WITH_AFB_HOOK
-       return hooked_broadcast(event, object, 0, -1);
-#else
-       return broadcast(event, object, 0);
-#endif
+       return afb_evt_rebroadcast(event, object, NULL, 0);
 }
 
 /*
  * Pushes the event 'evtid' with 'obj' to its listeners
- * 'obj' is released (like json_object_put)
  * Returns the count of listener that received the event.
  */
-int afb_evt_evtid_push(struct afb_evtid *evtid, struct json_object *obj)
+static void push_evtid(struct afb_evtid *evtid, struct json_object *object)
 {
-       int result;
+       int has_client;
        struct afb_evt_watch *watch;
        struct afb_evt_listener *listener;
 
-       result = 0;
+       has_client = 0;
        pthread_rwlock_rdlock(&evtid->rwlock);
        watch = evtid->watchs;
        while(watch) {
                listener = watch->listener;
                assert(listener->itf->push != NULL);
                if (watch->activity != 0) {
-                       listener->itf->push(listener->closure, evtid->fullname, evtid->id, json_object_get(obj));
-                       result++;
+                       listener->itf->push(listener->closure, evtid->fullname, evtid->id, json_object_get(object));
+                       has_client = 1;
                }
                watch = watch->next_by_evtid;
        }
+       evtid->has_client = has_client;
        pthread_rwlock_unlock(&evtid->rwlock);
-       json_object_put(obj);
-       return result;
+}
+
+/*
+ * Jobs callback for pushing evtid asynchronously
+ */
+static void push_job_evtid(int signum, void *closure)
+{
+       struct job_evtid *je = closure;
+
+       if (signum == 0)
+               push_evtid(je->evtid, je->object);
+       destroy_job_evtid(je);
+}
+
+/*
+ * Pushes the event 'evtid' with 'obj' to its listeners
+ * 'obj' is released (like json_object_put)
+ * Returns 1 if at least one listener exists or 0 if no listener exists or
+ * -1 in case of error and the event can't be delivered
+ */
+int afb_evt_evtid_push(struct afb_evtid *evtid, struct json_object *object)
+{
+       struct job_evtid *je;
+       int rc;
+
+       je = make_job_evtid(evtid, object);
+       if (je == NULL) {
+               ERROR("Cant't create push evtid job item for %s(%s)",
+                       evtid->fullname, json_object_to_json_string(object));
+               json_object_put(object);
+               return -1;
+       }
+
+       rc = jobs_queue(PUSH_JOB_GROUP, 0, push_job_evtid, je);
+       if (rc == 0)
+               rc = evtid->has_client;
+       else {
+               ERROR("cant't queue push evtid job item for %s(%s)",
+                       evtid->fullname, json_object_to_json_string(object));
+               destroy_job_evtid(je);
+       }
+
+       return rc;
 }
 
 #if WITH_AFB_HOOK
@@ -327,6 +545,7 @@ struct afb_evtid *afb_evt_evtid_create(const char *fullname)
 {
        size_t len;
        struct afb_evtid *evtid, *oevt;
+       uint16_t id;
 
        /* allocates the event */
        len = strlen(fullname);
@@ -336,15 +555,20 @@ struct afb_evtid *afb_evt_evtid_create(const char *fullname)
 
        /* allocates the id */
        pthread_rwlock_wrlock(&events_rwlock);
+       if (event_count == UINT16_MAX) {
+               pthread_rwlock_unlock(&events_rwlock);
+               free(evtid);
+               ERROR("Can't create more events");
+               return NULL;
+       }
+       event_count++;
        do {
-               if (++event_id_counter < 0) {
-                       event_id_wrapped = 1;
-                       event_id_counter = 1024; /* heuristic: small numbers are not destroyed */
-               }
-               if (!event_id_wrapped)
-                       break;
+               /* TODO add a guard (counting number of event created) */
+               id = ++event_genid;
+               if (!id)
+                       id = event_genid = 1;
                oevt = evtids;
-               while(oevt != NULL && oevt->id != event_id_counter)
+               while(oevt != NULL && oevt->id != id)
                        oevt = oevt->next;
        } while (oevt != NULL);
 
@@ -353,7 +577,8 @@ struct afb_evtid *afb_evt_evtid_create(const char *fullname)
        evtid->next = evtids;
        evtid->refcount = 1;
        evtid->watchs = NULL;
-       evtid->id = event_id_counter;
+       evtid->id = id;
+       evtid->has_client = 0;
        pthread_rwlock_init(&evtid->rwlock, NULL);
        evtids = evtid;
 #if WITH_AFB_HOOK
@@ -430,8 +655,10 @@ void afb_evt_evtid_unref(struct afb_evtid *evtid)
                prv = &evtids;
                while (*prv && !(found = (*prv == evtid)))
                        prv = &(*prv)->next;
-               if (found)
+               if (found) {
                        *prv = evtid->next;
+                       event_count--;
+               }
                pthread_rwlock_unlock(&events_rwlock);
 
                /* destroys the event */
@@ -501,7 +728,7 @@ const char *afb_evt_evtid_hooked_name(struct afb_evtid *evtid)
 /*
  * Returns the id of the 'event'
  */
-int afb_evt_evtid_id(struct afb_evtid *evtid)
+uint16_t afb_evt_evtid_id(struct afb_evtid *evtid)
 {
        return evtid->id;
 }
@@ -633,6 +860,7 @@ found:
        if (watch->activity == 0 && listener->itf->add != NULL)
                listener->itf->add(listener->closure, evtid->fullname, evtid->id);
        watch->activity++;
+       evtid->has_client = 1;
        pthread_rwlock_unlock(&listener->rwlock);
 
        return 0;
@@ -666,6 +894,36 @@ int afb_evt_watch_sub_evtid(struct afb_evt_listener *listener, struct afb_evtid
        return -1;
 }
 
+/*
+ * Avoids the 'listener' to watch 'eventid'
+ * Returns 0 in case of success or else -1.
+ */
+int afb_evt_watch_sub_eventid(struct afb_evt_listener *listener, uint16_t eventid)
+{
+       struct afb_evt_watch *watch;
+       struct afb_evtid *evtid;
+
+       /* search the existing watch */
+       pthread_rwlock_wrlock(&listener->rwlock);
+       watch = listener->watchs;
+       while(watch != NULL) {
+               evtid = watch->evtid;
+               if (evtid->id == eventid) {
+                       if (watch->activity != 0) {
+                               watch->activity--;
+                               if (watch->activity == 0 && listener->itf->remove != NULL)
+                                       listener->itf->remove(listener->closure, evtid->fullname, evtid->id);
+                       }
+                       pthread_rwlock_unlock(&listener->rwlock);
+                       return 0;
+               }
+               watch = watch->next_by_listener;
+       }
+       pthread_rwlock_unlock(&listener->rwlock);
+       errno = ENOENT;
+       return -1;
+}
+
 #if WITH_AFB_HOOK
 /*
  * update the hooks for events
@@ -723,7 +981,7 @@ const char *afb_evt_event_x2_fullname(struct afb_event_x2 *eventid)
 /*
  * Returns the id of the 'eventid'
  */
-int afb_evt_event_x2_id(struct afb_event_x2 *eventid)
+uint16_t afb_evt_event_x2_id(struct afb_event_x2 *eventid)
 {
        struct afb_evtid *evtid = afb_evt_event_x2_to_evtid(eventid);
        return evtid ? evtid->id : 0;