src/afb-evt.c

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  * Author José Bollo <jose.bollo@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *   http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #define _GNU_SOURCE
  20
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <assert.h>
  24 #include <errno.h>
  25 #include <pthread.h>
  26
  27 #include <json-c/json.h>
  28 #include <afb/afb-event-itf.h>
  29
  30 #include "afb-evt.h"
  31 #include "afb-hook.h"
  32 #include "verbose.h"
  33
  34 struct afb_evt_watch;
  35
  36 /*
  37  * Structure for event listeners
  38  */
  39 struct afb_evt_listener {
  40
  41         /* chaining listeners */
  42         struct afb_evt_listener *next;
  43
  44         /* interface for callbacks */
  45         const struct afb_evt_itf *itf;
  46
  47         /* closure for the callback */
  48         void *closure;
  49
  50         /* head of the list of events listened */
  51         struct afb_evt_watch *watchs;
  52
  53         /* mutex of the listener */
  54         pthread_mutex_t mutex;
  55
  56         /* count of reference to the listener */
  57         int refcount;
  58 };
  59
  60 /*
  61  * Structure for describing events
  62  */
  63 struct afb_evt_event {
  64
  65         /* next event */
  66         struct afb_evt_event *next;
  67
  68         /* head of the list of listeners watching the event */
  69         struct afb_evt_watch *watchs;
  70
  71         /* id of the event */
  72         int id;
  73
  74         /* hooking */
  75         int hookflags;
  76
  77         /* mutex of the event */
  78         pthread_mutex_t mutex;
  79
  80         /* name of the event */
  81         char name[1];
  82 };
  83
  84 /*
  85  * Structure for associating events and listeners
  86  */
  87 struct afb_evt_watch {
  88
  89         /* the event */
  90         struct afb_evt_event *event;
  91
  92         /* link to the next listener for the same event */
  93         struct afb_evt_watch *next_by_event;
  94
  95         /* the listener */
  96         struct afb_evt_listener *listener;
  97
  98         /* link to the next event for the same listener */
  99         struct afb_evt_watch *next_by_listener;
 100
 101         /* activity */
 102         unsigned activity;
 103 };
 104
 105 /* declare functions */
 106 static int evt_broadcast(struct afb_evt_event *evt, struct json_object *obj);
 107 static int evt_push(struct afb_evt_event *evt, struct json_object *obj);
 108 static void evt_destroy(struct afb_evt_event *evt);
 109 static const char *evt_name(struct afb_evt_event *evt);
 110
 111 /* the interface for events */
 112 static struct afb_event_itf afb_evt_event_itf = {
 113         .broadcast = (void*)evt_broadcast,
 114         .push = (void*)evt_push,
 115         .drop = (void*)evt_destroy,
 116         .name = (void*)evt_name
 117 };
 118
 119 /* head of the list of listeners */
 120 static pthread_mutex_t listeners_mutex = PTHREAD_MUTEX_INITIALIZER;
 121 static struct afb_evt_listener *listeners = NULL;
 122
 123 /* handling id of events */
 124 static pthread_mutex_t events_mutex = PTHREAD_MUTEX_INITIALIZER;
 125 static struct afb_evt_event *events = NULL;
 126 static int event_id_counter = 0;
 127 static int event_id_wrapped = 0;
 128
 129 /*
 130  * Broadcasts the 'event' of 'id' with its 'obj'
 131  * 'obj' is released (like json_object_put)
 132  * calls hooks if hookflags isn't 0
 133  * Returns the count of listener having receive the event.
 134  */
 135 static int broadcast(const char *event, struct json_object *obj, int id, int hookflags)
 136 {
 137         int result;
 138         struct afb_evt_listener *listener;
 139
 140         if (hookflags & afb_hook_flag_evt_broadcast_before)
 141                 afb_hook_evt_broadcast_before(event, id, obj);
 142         result = 0;
 143         pthread_mutex_lock(&listeners_mutex);
 144         listener = listeners;
 145         while(listener) {
 146                 if (listener->itf->broadcast != NULL) {
 147                         listener->itf->broadcast(listener->closure, event, id, json_object_get(obj));
 148                         result++;
 149                 }
 150                 listener = listener->next;
 151         }
 152         pthread_mutex_unlock(&listeners_mutex);
 153         if (hookflags & afb_hook_flag_evt_broadcast_after)
 154                 afb_hook_evt_broadcast_after(event, id, obj, result);
 155         json_object_put(obj);
 156         return result;
 157 }
 158
 159 /*
 160  * Broadcasts the event 'evt' with its 'object'
 161  * 'object' is released (like json_object_put)
 162  * Returns the count of listener that received the event.
 163  */
 164 static int evt_broadcast(struct afb_evt_event *evt, struct json_object *object)
 165 {
 166         return broadcast(evt->name, object, evt->id, evt->hookflags);
 167 }
 168
 169 /*
 170  * Broadcasts the 'event' with its 'object'
 171  * 'object' is released (like json_object_put)
 172  * Returns the count of listener having receive the event.
 173  */
 174 int afb_evt_broadcast(const char *event, struct json_object *object)
 175 {
 176         return broadcast(event, object, 0, -1);
 177 }
 178
 179 /*
 180  * Pushes the event 'evt' with 'obj' to its listeners
 181  * 'obj' is released (like json_object_put)
 182  * Returns the count of listener taht received the event.
 183  */
 184 static int evt_push(struct afb_evt_event *evt, struct json_object *obj)
 185 {
 186         int result;
 187         struct afb_evt_watch *watch;
 188         struct afb_evt_listener *listener;
 189
 190         result = 0;
 191         pthread_mutex_lock(&evt->mutex);
 192         if (evt->hookflags & afb_hook_flag_evt_push_before)
 193                 afb_hook_evt_push_before(evt->name, evt->id, obj);
 194         watch = evt->watchs;
 195         while(watch) {
 196                 listener = watch->listener;
 197                 assert(listener->itf->push != NULL);
 198                 if (watch->activity != 0) {
 199                         listener->itf->push(listener->closure, evt->name, evt->id, json_object_get(obj));
 200                         result++;
 201                 }
 202                 watch = watch->next_by_event;
 203         }
 204         if (evt->hookflags & afb_hook_flag_evt_push_after)
 205                 afb_hook_evt_push_after(evt->name, evt->id, obj, result);
 206         pthread_mutex_unlock(&evt->mutex);
 207         json_object_put(obj);
 208         return result;
 209 }
 210
 211 /*
 212  * Returns the name associated to the event 'evt'.
 213  */
 214 static const char *evt_name(struct afb_evt_event *evt)
 215 {
 216         if (evt->hookflags & afb_hook_flag_evt_name)
 217                 afb_hook_evt_name(evt->name, evt->id);
 218         return evt->name;
 219 }
 220
 221 /*
 222  * remove the 'watch'
 223  */
 224 static void remove_watch(struct afb_evt_watch *watch)
 225 {
 226         struct afb_evt_watch **prv;
 227         struct afb_evt_event *evt;
 228         struct afb_evt_listener *listener;
 229
 230         /* notify listener if needed */
 231         evt = watch->event;
 232         listener = watch->listener;
 233         if (watch->activity != 0 && listener->itf->remove != NULL)
 234                 listener->itf->remove(listener->closure, evt->name, evt->id);
 235
 236         /* unlink the watch for its event */
 237         prv = &evt->watchs;
 238         while(*prv != watch)
 239                 prv = &(*prv)->next_by_event;
 240         *prv = watch->next_by_event;
 241
 242         /* unlink the watch for its listener */
 243         prv = &listener->watchs;
 244         while(*prv != watch)
 245                 prv = &(*prv)->next_by_listener;
 246         *prv = watch->next_by_listener;
 247
 248         /* recycle memory */
 249         free(watch);
 250 }
 251
 252 /*
 253  * Destroys the event 'evt'
 254  */
 255 static void evt_destroy(struct afb_evt_event *evt)
 256 {
 257         int found;
 258         struct afb_evt_event **prv;
 259         struct afb_evt_listener *listener;
 260
 261         if (evt != NULL) {
 262                 /* unlinks the event if valid! */
 263                 pthread_mutex_lock(&events_mutex);
 264                 found = 0;
 265                 prv = &events;
 266                 while (*prv && !(found = (*prv == evt)))
 267                         prv = &(*prv)->next;
 268                 if (found)
 269                         *prv = evt->next;
 270                 pthread_mutex_unlock(&events_mutex);
 271
 272                 /* destroys the event */
 273                 if (found) {
 274                         /* removes all watchers */
 275                         while(evt->watchs != NULL) {
 276                                 listener = evt->watchs->listener;
 277                                 pthread_mutex_lock(&listener->mutex);
 278                                 pthread_mutex_lock(&evt->mutex);
 279                                 remove_watch(evt->watchs);
 280                                 pthread_mutex_unlock(&evt->mutex);
 281                                 pthread_mutex_unlock(&listener->mutex);
 282                         }
 283
 284                         /* hook */
 285                         if (evt->hookflags & afb_hook_flag_evt_drop)
 286                                 afb_hook_evt_drop(evt->name, evt->id);
 287
 288                         /* free */
 289                         pthread_mutex_destroy(&evt->mutex);
 290                         free(evt);
 291                 }
 292         }
 293 }
 294
 295 /*
 296  * Creates an event of 'name' and returns it.
 297  * Returns an event with closure==NULL in case of error.
 298  */
 299 struct afb_event afb_evt_create_event(const char *name)
 300 {
 301         size_t len;
 302         struct afb_evt_event *evt;
 303
 304         /* allocates the event */
 305         len = strlen(name);
 306         evt = malloc(len + sizeof * evt);
 307         if (evt == NULL)
 308                 goto error;
 309
 310         /* initialize the event */
 311         evt->watchs = NULL;
 312         memcpy(evt->name, name, len + 1);
 313
 314         /* allocates the id */
 315         pthread_mutex_lock(&events_mutex);
 316         do {
 317                 if (++event_id_counter < 0) {
 318                         event_id_wrapped = 1;
 319                         event_id_counter = 1024; /* heuristic: small numbers are not destroyed */
 320                 }
 321                 if (!event_id_wrapped)
 322                         break;
 323                 evt = events;
 324                 while(evt != NULL && evt->id != event_id_counter)
 325                         evt = evt->next;
 326         } while (evt != NULL);
 327
 328         /* initialize the event */
 329         memcpy(evt->name, name, len + 1);
 330         evt->next = events;
 331         evt->watchs = NULL;
 332         evt->id = event_id_counter;
 333         pthread_mutex_init(&evt->mutex, NULL);
 334         events = evt;
 335         evt->hookflags = afb_hook_flags_evt(evt->name);
 336         if (evt->hookflags & afb_hook_flag_evt_create)
 337                 afb_hook_evt_create(evt->name, evt->id);
 338         pthread_mutex_unlock(&events_mutex);
 339
 340         /* returns the event */
 341         return (struct afb_event){ .itf = &afb_evt_event_itf, .closure = evt };
 342 error:
 343         return (struct afb_event){ .itf = NULL, .closure = NULL };
 344 }
 345
 346 /*
 347  * Returns the name of the 'event'
 348  */
 349 const char *afb_evt_event_name(struct afb_event event)
 350 {
 351         return (event.itf != &afb_evt_event_itf) ? NULL : ((struct afb_evt_event *)event.closure)->name;
 352 }
 353
 354 /*
 355  * Returns the id of the 'event'
 356  */
 357 int afb_evt_event_id(struct afb_event event)
 358 {
 359         return (event.itf != &afb_evt_event_itf) ? 0 : ((struct afb_evt_event *)event.closure)->id;
 360 }
 361
 362 /*
 363  * Returns an instance of the listener defined by the 'send' callback
 364  * and the 'closure'.
 365  * Returns NULL in case of memory depletion.
 366  */
 367 struct afb_evt_listener *afb_evt_listener_create(const struct afb_evt_itf *itf, void *closure)
 368 {
 369         struct afb_evt_listener *listener;
 370
 371         /* search if an instance already exists */
 372         pthread_mutex_lock(&listeners_mutex);
 373         listener = listeners;
 374         while (listener != NULL) {
 375                 if (listener->itf == itf && listener->closure == closure) {
 376                         listener = afb_evt_listener_addref(listener);
 377                         goto found;
 378                 }
 379                 listener = listener->next;
 380         }
 381
 382         /* allocates */
 383         listener = calloc(1, sizeof *listener);
 384         if (listener != NULL) {
 385                 /* init */
 386                 listener->itf = itf;
 387                 listener->closure = closure;
 388                 listener->watchs = NULL;
 389                 listener->refcount = 1;
 390                 pthread_mutex_init(&listener->mutex, NULL);
 391                 listener->next = listeners;
 392                 listeners = listener;
 393         }
 394  found:
 395         pthread_mutex_unlock(&listeners_mutex);
 396         return listener;
 397 }
 398
 399 /*
 400  * Increases the reference count of 'listener' and returns it
 401  */
 402 struct afb_evt_listener *afb_evt_listener_addref(struct afb_evt_listener *listener)
 403 {
 404         __atomic_add_fetch(&listener->refcount, 1, __ATOMIC_RELAXED);
 405         return listener;
 406 }
 407
 408 /*
 409  * Decreases the reference count of the 'listener' and destroys it
 410  * when no more used.
 411  */
 412 void afb_evt_listener_unref(struct afb_evt_listener *listener)
 413 {
 414         struct afb_evt_listener **prv;
 415         struct afb_evt_event *evt;
 416
 417         if (!__atomic_sub_fetch(&listener->refcount, 1, __ATOMIC_RELAXED)) {
 418
 419                 /* unlink the listener */
 420                 pthread_mutex_lock(&listeners_mutex);
 421                 prv = &listeners;
 422                 while (*prv != listener)
 423                         prv = &(*prv)->next;
 424                 *prv = listener->next;
 425                 pthread_mutex_unlock(&listeners_mutex);
 426
 427                 /* remove the watchers */
 428                 pthread_mutex_lock(&listener->mutex);
 429                 while (listener->watchs != NULL) {
 430                         evt = listener->watchs->event;
 431                         pthread_mutex_lock(&evt->mutex);
 432                         remove_watch(listener->watchs);
 433                         pthread_mutex_unlock(&evt->mutex);
 434                 }
 435                 pthread_mutex_unlock(&listener->mutex);
 436
 437                 /* free the listener */
 438                 pthread_mutex_destroy(&listener->mutex);
 439                 free(listener);
 440         }
 441 }
 442
 443 /*
 444  * Makes the 'listener' watching 'event'
 445  * Returns 0 in case of success or else -1.
 446  */
 447 int afb_evt_add_watch(struct afb_evt_listener *listener, struct afb_event event)
 448 {
 449         struct afb_evt_watch *watch;
 450         struct afb_evt_event *evt;
 451
 452         /* check parameter */
 453         if (event.itf != &afb_evt_event_itf || listener->itf->push == NULL) {
 454                 errno = EINVAL;
 455                 return -1;
 456         }
 457
 458         /* search the existing watch for the listener */
 459         evt = event.closure;
 460         pthread_mutex_lock(&listener->mutex);
 461         watch = listener->watchs;
 462         while(watch != NULL) {
 463                 if (watch->event == evt)
 464                         goto found;
 465                 watch = watch->next_by_listener;
 466         }
 467
 468         /* not found, allocate a new */
 469         watch = malloc(sizeof *watch);
 470         if (watch == NULL) {
 471                 pthread_mutex_unlock(&listener->mutex);
 472                 errno = ENOMEM;
 473                 return -1;
 474         }
 475
 476         /* initialise and link */
 477         watch->event = evt;
 478         watch->activity = 0;
 479         watch->listener = listener;
 480         watch->next_by_listener = listener->watchs;
 481         listener->watchs = watch;
 482         pthread_mutex_lock(&evt->mutex);
 483         watch->next_by_event = evt->watchs;
 484         evt->watchs = watch;
 485         pthread_mutex_unlock(&evt->mutex);
 486
 487 found:
 488         if (watch->activity == 0 && listener->itf->add != NULL)
 489                 listener->itf->add(listener->closure, evt->name, evt->id);
 490         watch->activity++;
 491         pthread_mutex_unlock(&listener->mutex);
 492
 493         return 0;
 494 }
 495
 496 /*
 497  * Avoids the 'listener' to watch 'event'
 498  * Returns 0 in case of success or else -1.
 499  */
 500 int afb_evt_remove_watch(struct afb_evt_listener *listener, struct afb_event event)
 501 {
 502         struct afb_evt_watch *watch;
 503         struct afb_evt_event *evt;
 504
 505         /* check parameter */
 506         if (event.itf != &afb_evt_event_itf) {
 507                 errno = EINVAL;
 508                 return -1;
 509         }
 510
 511         /* search the existing watch */
 512         evt = event.closure;
 513         pthread_mutex_lock(&listener->mutex);
 514         watch = listener->watchs;
 515         while(watch != NULL) {
 516                 if (watch->event == evt) {
 517                         if (watch->activity != 0) {
 518                                 watch->activity--;
 519                                 if (watch->activity == 0 && listener->itf->remove != NULL)
 520                                         listener->itf->remove(listener->closure, evt->name, evt->id);
 521                         }
 522                         pthread_mutex_unlock(&listener->mutex);
 523                         return 0;
 524                 }
 525                 watch = watch->next_by_listener;
 526         }
 527         pthread_mutex_unlock(&listener->mutex);
 528         errno = ENOENT;
 529         return -1;
 530 }
 531
 532 /*
 533  * update the hooks for events
 534  */
 535 void afb_evt_update_hooks()
 536 {
 537         struct afb_evt_event *evt;
 538
 539         pthread_mutex_lock(&events_mutex);
 540         for (evt = events ; evt ; evt = evt->next)
 541                 evt->hookflags = afb_hook_flags_evt(evt->name);
 542         pthread_mutex_unlock(&events_mutex);
 543 }
 544