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  * calls hooks if hookflags isn't 0
 183  * Returns the count of listener taht received the event.
 184  */
 185 static int push(struct afb_evt_event *evt, struct json_object *obj, int hookflags)
 186 {
 187         int result;
 188         struct afb_evt_watch *watch;
 189         struct afb_evt_listener *listener;
 190
 191         result = 0;
 192         pthread_mutex_lock(&evt->mutex);
 193         if (hookflags & afb_hook_flag_evt_push_before)
 194                 afb_hook_evt_push_before(evt->name, evt->id, obj);
 195         watch = evt->watchs;
 196         while(watch) {
 197                 listener = watch->listener;
 198                 assert(listener->itf->push != NULL);
 199                 if (watch->activity != 0) {
 200                         listener->itf->push(listener->closure, evt->name, evt->id, json_object_get(obj));
 201                         result++;
 202                 }
 203                 watch = watch->next_by_event;
 204         }
 205         if (hookflags & afb_hook_flag_evt_push_after)
 206                 afb_hook_evt_push_after(evt->name, evt->id, obj, result);
 207         pthread_mutex_unlock(&evt->mutex);
 208         json_object_put(obj);
 209         return result;
 210 }
 211
 212 /*
 213  * Pushes the event 'evt' with 'obj' to its listeners
 214  * 'obj' is released (like json_object_put)
 215  * Returns the count of listener taht received the event.
 216  */
 217 static int evt_push(struct afb_evt_event *evt, struct json_object *obj)
 218 {
 219         return push(evt, obj, evt->hookflags);
 220 }
 221
 222 /*
 223  * Returns the name associated to the event 'evt'.
 224  */
 225 static const char *evt_name(struct afb_evt_event *evt)
 226 {
 227         const char *name = strchr(evt->name, '/');
 228         name = name ? name + 1 : evt->name;
 229         if (evt->hookflags & afb_hook_flag_evt_name)
 230                 afb_hook_evt_name(evt->name, evt->id);
 231         return name;
 232 }
 233
 234 /*
 235  * remove the 'watch'
 236  */
 237 static void remove_watch(struct afb_evt_watch *watch)
 238 {
 239         struct afb_evt_watch **prv;
 240         struct afb_evt_event *evt;
 241         struct afb_evt_listener *listener;
 242
 243         /* notify listener if needed */
 244         evt = watch->event;
 245         listener = watch->listener;
 246         if (watch->activity != 0 && listener->itf->remove != NULL)
 247                 listener->itf->remove(listener->closure, evt->name, evt->id);
 248
 249         /* unlink the watch for its event */
 250         prv = &evt->watchs;
 251         while(*prv != watch)
 252                 prv = &(*prv)->next_by_event;
 253         *prv = watch->next_by_event;
 254
 255         /* unlink the watch for its listener */
 256         prv = &listener->watchs;
 257         while(*prv != watch)
 258                 prv = &(*prv)->next_by_listener;
 259         *prv = watch->next_by_listener;
 260
 261         /* recycle memory */
 262         free(watch);
 263 }
 264
 265 /*
 266  * Destroys the event 'evt'
 267  */
 268 static void evt_destroy(struct afb_evt_event *evt)
 269 {
 270         int found;
 271         struct afb_evt_event **prv;
 272         struct afb_evt_listener *listener;
 273
 274         if (evt != NULL) {
 275                 /* unlinks the event if valid! */
 276                 pthread_mutex_lock(&events_mutex);
 277                 found = 0;
 278                 prv = &events;
 279                 while (*prv && !(found = (*prv == evt)))
 280                         prv = &(*prv)->next;
 281                 if (found)
 282                         *prv = evt->next;
 283                 pthread_mutex_unlock(&events_mutex);
 284
 285                 /* destroys the event */
 286                 if (found) {
 287                         /* removes all watchers */
 288                         while(evt->watchs != NULL) {
 289                                 listener = evt->watchs->listener;
 290                                 pthread_mutex_lock(&listener->mutex);
 291                                 pthread_mutex_lock(&evt->mutex);
 292                                 remove_watch(evt->watchs);
 293                                 pthread_mutex_unlock(&evt->mutex);
 294                                 pthread_mutex_unlock(&listener->mutex);
 295                         }
 296
 297                         /* hook */
 298                         if (evt->hookflags & afb_hook_flag_evt_drop)
 299                                 afb_hook_evt_drop(evt->name, evt->id);
 300
 301                         /* free */
 302                         pthread_mutex_destroy(&evt->mutex);
 303                         free(evt);
 304                 }
 305         }
 306 }
 307
 308 /*
 309  * Creates an event of 'name' and returns it.
 310  * Returns an event with closure==NULL in case of error.
 311  */
 312 struct afb_event afb_evt_create_event(const char *name)
 313 {
 314         size_t len;
 315         struct afb_evt_event *evt, *oevt;
 316
 317         /* allocates the event */
 318         len = strlen(name);
 319         evt = malloc(len + sizeof * evt);
 320         if (evt == NULL)
 321                 goto error;
 322
 323         /* allocates the id */
 324         pthread_mutex_lock(&events_mutex);
 325         do {
 326                 if (++event_id_counter < 0) {
 327                         event_id_wrapped = 1;
 328                         event_id_counter = 1024; /* heuristic: small numbers are not destroyed */
 329                 }
 330                 if (!event_id_wrapped)
 331                         break;
 332                 oevt = events;
 333                 while(oevt != NULL && oevt->id != event_id_counter)
 334                         oevt = oevt->next;
 335         } while (oevt != NULL);
 336
 337         /* initialize the event */
 338         memcpy(evt->name, name, len + 1);
 339         evt->next = events;
 340         evt->watchs = NULL;
 341         evt->id = event_id_counter;
 342         pthread_mutex_init(&evt->mutex, NULL);
 343         events = evt;
 344         evt->hookflags = afb_hook_flags_evt(evt->name);
 345         if (evt->hookflags & afb_hook_flag_evt_create)
 346                 afb_hook_evt_create(evt->name, evt->id);
 347         pthread_mutex_unlock(&events_mutex);
 348
 349         /* returns the event */
 350         return (struct afb_event){ .itf = &afb_evt_event_itf, .closure = evt };
 351 error:
 352         return (struct afb_event){ .itf = NULL, .closure = NULL };
 353 }
 354
 355 /*
 356  * Returns the name of the 'event'
 357  */
 358 const char *afb_evt_event_name(struct afb_event event)
 359 {
 360         return (event.itf != &afb_evt_event_itf) ? NULL : ((struct afb_evt_event *)event.closure)->name;
 361 }
 362
 363 /*
 364  * Returns the id of the 'event'
 365  */
 366 int afb_evt_event_id(struct afb_event event)
 367 {
 368         return (event.itf != &afb_evt_event_itf) ? 0 : ((struct afb_evt_event *)event.closure)->id;
 369 }
 370
 371 /*
 372  * Returns an instance of the listener defined by the 'send' callback
 373  * and the 'closure'.
 374  * Returns NULL in case of memory depletion.
 375  */
 376 struct afb_evt_listener *afb_evt_listener_create(const struct afb_evt_itf *itf, void *closure)
 377 {
 378         struct afb_evt_listener *listener;
 379
 380         /* search if an instance already exists */
 381         pthread_mutex_lock(&listeners_mutex);
 382         listener = listeners;
 383         while (listener != NULL) {
 384                 if (listener->itf == itf && listener->closure == closure) {
 385                         listener = afb_evt_listener_addref(listener);
 386                         goto found;
 387                 }
 388                 listener = listener->next;
 389         }
 390
 391         /* allocates */
 392         listener = calloc(1, sizeof *listener);
 393         if (listener != NULL) {
 394                 /* init */
 395                 listener->itf = itf;
 396                 listener->closure = closure;
 397                 listener->watchs = NULL;
 398                 listener->refcount = 1;
 399                 pthread_mutex_init(&listener->mutex, NULL);
 400                 listener->next = listeners;
 401                 listeners = listener;
 402         }
 403  found:
 404         pthread_mutex_unlock(&listeners_mutex);
 405         return listener;
 406 }
 407
 408 /*
 409  * Increases the reference count of 'listener' and returns it
 410  */
 411 struct afb_evt_listener *afb_evt_listener_addref(struct afb_evt_listener *listener)
 412 {
 413         __atomic_add_fetch(&listener->refcount, 1, __ATOMIC_RELAXED);
 414         return listener;
 415 }
 416
 417 /*
 418  * Decreases the reference count of the 'listener' and destroys it
 419  * when no more used.
 420  */
 421 void afb_evt_listener_unref(struct afb_evt_listener *listener)
 422 {
 423         struct afb_evt_listener **prv;
 424         struct afb_evt_event *evt;
 425
 426         if (!__atomic_sub_fetch(&listener->refcount, 1, __ATOMIC_RELAXED)) {
 427
 428                 /* unlink the listener */
 429                 pthread_mutex_lock(&listeners_mutex);
 430                 prv = &listeners;
 431                 while (*prv != listener)
 432                         prv = &(*prv)->next;
 433                 *prv = listener->next;
 434                 pthread_mutex_unlock(&listeners_mutex);
 435
 436                 /* remove the watchers */
 437                 pthread_mutex_lock(&listener->mutex);
 438                 while (listener->watchs != NULL) {
 439                         evt = listener->watchs->event;
 440                         pthread_mutex_lock(&evt->mutex);
 441                         remove_watch(listener->watchs);
 442                         pthread_mutex_unlock(&evt->mutex);
 443                 }
 444                 pthread_mutex_unlock(&listener->mutex);
 445
 446                 /* free the listener */
 447                 pthread_mutex_destroy(&listener->mutex);
 448                 free(listener);
 449         }
 450 }
 451
 452 /*
 453  * Makes the 'listener' watching 'event'
 454  * Returns 0 in case of success or else -1.
 455  */
 456 int afb_evt_add_watch(struct afb_evt_listener *listener, struct afb_event event)
 457 {
 458         struct afb_evt_watch *watch;
 459         struct afb_evt_event *evt;
 460
 461         /* check parameter */
 462         if (event.itf != &afb_evt_event_itf || listener->itf->push == NULL) {
 463                 errno = EINVAL;
 464                 return -1;
 465         }
 466
 467         /* search the existing watch for the listener */
 468         evt = event.closure;
 469         pthread_mutex_lock(&listener->mutex);
 470         watch = listener->watchs;
 471         while(watch != NULL) {
 472                 if (watch->event == evt)
 473                         goto found;
 474                 watch = watch->next_by_listener;
 475         }
 476
 477         /* not found, allocate a new */
 478         watch = malloc(sizeof *watch);
 479         if (watch == NULL) {
 480                 pthread_mutex_unlock(&listener->mutex);
 481                 errno = ENOMEM;
 482                 return -1;
 483         }
 484
 485         /* initialise and link */
 486         watch->event = evt;
 487         watch->activity = 0;
 488         watch->listener = listener;
 489         watch->next_by_listener = listener->watchs;
 490         listener->watchs = watch;
 491         pthread_mutex_lock(&evt->mutex);
 492         watch->next_by_event = evt->watchs;
 493         evt->watchs = watch;
 494         pthread_mutex_unlock(&evt->mutex);
 495
 496 found:
 497         if (watch->activity == 0 && listener->itf->add != NULL)
 498                 listener->itf->add(listener->closure, evt->name, evt->id);
 499         watch->activity++;
 500         pthread_mutex_unlock(&listener->mutex);
 501
 502         return 0;
 503 }
 504
 505 /*
 506  * Avoids the 'listener' to watch 'event'
 507  * Returns 0 in case of success or else -1.
 508  */
 509 int afb_evt_remove_watch(struct afb_evt_listener *listener, struct afb_event event)
 510 {
 511         struct afb_evt_watch *watch;
 512         struct afb_evt_event *evt;
 513
 514         /* check parameter */
 515         if (event.itf != &afb_evt_event_itf) {
 516                 errno = EINVAL;
 517                 return -1;
 518         }
 519
 520         /* search the existing watch */
 521         evt = event.closure;
 522         pthread_mutex_lock(&listener->mutex);
 523         watch = listener->watchs;
 524         while(watch != NULL) {
 525                 if (watch->event == evt) {
 526                         if (watch->activity != 0) {
 527                                 watch->activity--;
 528                                 if (watch->activity == 0 && listener->itf->remove != NULL)
 529                                         listener->itf->remove(listener->closure, evt->name, evt->id);
 530                         }
 531                         pthread_mutex_unlock(&listener->mutex);
 532                         return 0;
 533                 }
 534                 watch = watch->next_by_listener;
 535         }
 536         pthread_mutex_unlock(&listener->mutex);
 537         errno = ENOENT;
 538         return -1;
 539 }
 540
 541 /*
 542  * update the hooks for events
 543  */
 544 void afb_evt_update_hooks()
 545 {
 546         struct afb_evt_event *evt;
 547
 548         pthread_mutex_lock(&events_mutex);
 549         for (evt = events ; evt ; evt = evt->next)
 550                 evt->hookflags = afb_hook_flags_evt(evt->name);
 551         pthread_mutex_unlock(&events_mutex);
 552 }
 553
 554 int afb_evt_push(struct afb_event event, struct json_object *object)
 555 {
 556         if (event.itf == &afb_evt_event_itf)
 557                 return evt_push((struct afb_evt_event *)event.closure, object);
 558         json_object_put(object);
 559         return 0;
 560 }
 561
 562 int afb_evt_unhooked_push(struct afb_event event, struct json_object *object)
 563 {
 564         if (event.itf == &afb_evt_event_itf)
 565                 return push((struct afb_evt_event *)event.closure, object, 0);
 566         json_object_put(object);
 567         return 0;
 568 }
 569