aboutsummaryrefslogtreecommitdiffstats
path: root/ctrl/facemgr/src/loop_libevent.c
blob: b619e02e6405bd5905d55897721311261b49b821 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/*
 * Copyright (c) 2021 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * \file loop_libevent.c
 * \brief Implementation of facemgr main loop using libevent
 */

#ifndef __linux__
#error "Only linux is supported"
#endif /* __linux__ */

#include <assert.h>
#include <event2/event.h>
#include <event2/thread.h>
#include <fcntl.h>  // fcntl
#ifdef WITH_THREAD
#include <pthread.h>
#endif /* WITH_THREAD */
#include <stdlib.h>
#include <sys/timerfd.h>
#include <unistd.h>  // fcntl

#include <hicn/facemgr/api.h>
#include <hicn/util/log.h>

#include <hicn/facemgr/loop.h>
#include <hicn/util/map.h>

/**
 * \brief Holds all callback parameters
 */
typedef struct {
  void *owner;
  fd_callback_t callback;
  void *data;
} cb_wrapper_args_t;

TYPEDEF_MAP_H(event_map, int, struct event *);
TYPEDEF_MAP(event_map, int, struct event *, int_cmp, int_snprintf,
            generic_snprintf);

/* Map that associates timer fds with their associated cb_wrapper_args_t */
TYPEDEF_MAP_H(timer_fd_map, int, cb_wrapper_args_t *);
TYPEDEF_MAP(timer_fd_map, int, cb_wrapper_args_t *, int_cmp, int_snprintf,
            generic_snprintf);

struct loop_s {
  struct event_base *event_base;
  event_map_t *event_map;
  timer_fd_map_t *timer_fd_map;
#ifdef WITH_THREAD
  pthread_t thread;
#endif /* WITH_THREAD */
};

/* Forward declarations */
int _loop_unregister_fd(loop_t *loop, int fd);
int _loop_unregister_timer(loop_t *loop, int fd);

loop_t *loop_create() {
  loop_t *loop = malloc(sizeof(loop_t));
  if (!loop) {
    ERROR("[loop_create] Failed to allocate memory");
    goto ERR_MALLOC;
  }

#ifdef WITH_THREAD
  evthread_use_pthreads();
#endif /* WITH_THREAD */

  loop->event_base = event_base_new();
  if (!loop) goto ERR_EVENT;

  loop->event_map = event_map_create();
  if (!loop->event_map) {
    ERROR("[loop_create] Failed to create event_map");
    goto ERR_EVENT_MAP;
  }

  loop->timer_fd_map = timer_fd_map_create();
  if (!loop->timer_fd_map) {
    ERROR("[loop_create] Failed to create timer_fd_map");
    goto ERR_TIMER_FD_MAP;
  }

  event_set_log_callback(NULL);

  return loop;

ERR_TIMER_FD_MAP:
  event_map_free(loop->event_map);
ERR_EVENT_MAP:
  event_base_free(loop->event_base);
ERR_EVENT:
  free(loop);
ERR_MALLOC:
  return NULL;
}

void loop_free(loop_t *loop) {
  /*
   * Release all timer cb_wrapper_args_t
   *
   * We need to stop all timers, this should release associated fd events at
   * the same time... for that reason, this code has to be called before
   * releasing events
   */

  int *timer_fd_map_array;
  int n = timer_fd_map_get_key_array(loop->timer_fd_map, &timer_fd_map_array);
  if (n < 0) {
    ERROR("[loop_free] Could not get event map array");
  } else {
    for (unsigned i = 0; i < n; i++) {
      int fd = timer_fd_map_array[i];
      if (_loop_unregister_timer(loop, fd) < 0) {
        ERROR("[loop_free] Could not unregister timer");
      }
    }
    free(timer_fd_map_array);
  }
  timer_fd_map_free(loop->timer_fd_map);

  /* Release all events */

  int *event_map_array;
  n = event_map_get_key_array(loop->event_map, &event_map_array);
  if (n < 0) {
    ERROR("[loop_free] Could not get event map array");
  } else {
    for (unsigned i = 0; i < n; i++) {
      int fd = event_map_array[i];
      if (_loop_unregister_fd(loop, fd) < 0) {
        ERROR("[loop_free] Could not unregister fd");
      }
    }
    free(event_map_array);
  }
  event_map_free(loop->event_map);

  event_base_free(loop->event_base);

  free(loop);
}

int loop_dispatch(loop_t *loop) {
#ifdef WITH_THREAD
  if (pthread_create(&loop->thread, NULL,
                     (void *(*)(void *))event_base_dispatch,
                     loop->event_base)) {
    fprintf(stderr, "Error creating thread\n");
    return -1;
  }
#else
  event_base_dispatch(loop->event_base);
#endif /* WITH_THREAD */
  return 0;
}

int loop_undispatch(loop_t *loop) {
#ifdef WITH_THREAD
  DEBUG("Waiting for loop to terminate...");
  if (pthread_join(loop->thread, NULL)) {
    ERROR("Error joining thread\n");
    return -1;
  }
  DEBUG("Loop terminated !");
#endif /* WITH_THREAD */
  return 0;
}

void loop_break(loop_t *loop) { event_base_loopbreak(loop->event_base); }

void cb_wrapper(evutil_socket_t fd, short what, void *arg) {
  cb_wrapper_args_t *cb_wrapper_args = arg;
  cb_wrapper_args->callback(cb_wrapper_args->owner, fd, cb_wrapper_args->data);
}

/**
 * \brief Registers a new file descriptor to the event loop
 * \param [in] fd - File descriptor to register
 * \param [in] callback_owner - Pointer to the owner of the callack (first
 *      parameter of callback function)
 * \param [in] callback - Callback function
 * \param [in] callback_data - User data to pass alongside callback invocation
 * \return 0 in case of success, -1 otherwise
 */
int _loop_register_fd(loop_t *loop, int fd, void *callback_owner,
                      fd_callback_t callback, void *callback_data) {
  /* This will be freed with the event */
  cb_wrapper_args_t *cb_wrapper_args = malloc(sizeof(cb_wrapper_args_t));
  *cb_wrapper_args = (cb_wrapper_args_t){
      .owner = callback_owner,
      .callback = callback,
      .data = callback_data,
  };

  evutil_make_socket_nonblocking(fd);
  struct event *event = event_new(loop->event_base, fd, EV_READ | EV_PERSIST,
                                  cb_wrapper, cb_wrapper_args);
  if (!event) {
    ERROR("[_loop_register_fd] event_new");
    goto ERR_EVENT_NEW;
  }

  if (event_add(event, NULL) < 0) {
    ERROR("[_loop_register_fd] event_add");
    goto ERR_EVENT_ADD;
  }

  if (event_map_add(loop->event_map, fd, event) < 0) {
    ERROR("[_loop_register_fd] event_map_add");
    goto ERR_EVENT_MAP;
  }

  return 0;

ERR_EVENT_MAP:
ERR_EVENT_ADD:
  event_free(event);
ERR_EVENT_NEW:
  return -1;
}

/**
 * \brief Unregisters a file descriptor from the event loop
 * \param [in] fd - File descriptor to unregister
 * \return 0 in case of success, -1 otherwise
 */
int _loop_unregister_fd(loop_t *loop, int fd) {
  struct event *event = NULL;

  if (event_map_remove(loop->event_map, fd, &event) < 0) {
    ERROR("[_loop_unregister_fd] Error removing event associated to fd");
    return -1;
  }

  assert(event);

  cb_wrapper_args_t *cb_wrapper_args = event_get_callback_arg(event);
  free(cb_wrapper_args);

  event_del(event);
  event_free(event);

  return 0;
}

int loop_timer_callback(loop_t *loop, int fd, void *data) {
  char buf[1024]; /* size is not important */
  cb_wrapper_args_t *cb_wrapper_args = data;
  while (read(fd, &buf, sizeof(buf)) > 0)
    ;

  int rc = cb_wrapper_args->callback(cb_wrapper_args->owner, fd,
                                     cb_wrapper_args->data);

  return rc;
}

int _loop_register_timer(loop_t *loop,
                         timer_callback_data_t *timer_callback_data) {
  int fd = timerfd_create(CLOCK_MONOTONIC, 0);
  if (fd == -1) {
    perror("timerfd_create");
    return -1;
  }

  if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0) {
    perror("fcntl");
    return -1;
  }

  struct itimerspec ts = {
      .it_interval =
          {
              .tv_sec = timer_callback_data->delay_ms / 1000,
              .tv_nsec = (timer_callback_data->delay_ms % 1000) * 1000000,
          },
      .it_value = {
          .tv_sec = timer_callback_data->delay_ms / 1000,
          .tv_nsec = (timer_callback_data->delay_ms % 1000) * 1000000,
      }};

  if (timerfd_settime(fd, 0, &ts, NULL) == -1) {
    perror("timerfd_settime");
    return -1;
  }

  /* This should be freed together with the timer release */
  cb_wrapper_args_t *cb_wrapper_args = malloc(sizeof(cb_wrapper_args_t));
  *cb_wrapper_args = (cb_wrapper_args_t){
      .owner = timer_callback_data->owner,
      .callback = timer_callback_data->callback,
      .data = timer_callback_data->data,
  };

  if (timer_fd_map_add(loop->timer_fd_map, fd, cb_wrapper_args) < 0) {
    ERROR("[_loop_register_timer] Could not add cb_wrapper to timer map");
    return -1;
  }

  if (_loop_register_fd(loop, fd, loop, (fd_callback_t)loop_timer_callback,
                        cb_wrapper_args) < 0) {
    ERROR("[_loop_register_timer] Error registering fd to event loop");
    return -1;
  }

  return fd;
}

int _loop_unregister_timer(loop_t *loop, int fd) {
  struct itimerspec ts = {.it_interval =
                              {
                                  .tv_sec = 0,
                                  .tv_nsec = 0,
                              },
                          .it_value = {
                              /* This value disables the timer */
                              .tv_sec = 0,
                              .tv_nsec = 0,
                          }};
  ts.it_value.tv_sec = 0;

  if (timerfd_settime(fd, 0, &ts, NULL) == -1) {
    perror("timerfd_settime");
    return -1;
  }

  cb_wrapper_args_t *cb_wrapper_args;
  if (timer_fd_map_remove(loop->timer_fd_map, fd, &cb_wrapper_args) < 0) {
    ERROR(
        "[_loop_unregister_timer] Could not remove cb_wrapper from timer map");
    return -1;
  }
  assert(cb_wrapper_args);
  free(cb_wrapper_args);

  if (_loop_unregister_fd(loop, fd) < 0) {
    ERROR("[_loop_unregister_timer] Error unregistering fd from event loop");
    return -1;
  }

  close(fd);

  return 0;
}

int loop_callback(loop_t *loop, facemgr_cb_type_t type, void *data) {
  switch (type) {
    case FACEMGR_CB_TYPE_REGISTER_FD: {
      fd_callback_data_t *fd_callback_data = (fd_callback_data_t *)data;
      if (_loop_register_fd(loop, fd_callback_data->fd, fd_callback_data->owner,
                            fd_callback_data->callback,
                            fd_callback_data->data) < 0) {
        ERROR("[loop_callback] Error registering fd to event loop");
        return -1;
      }
      break;
    }

    case FACEMGR_CB_TYPE_UNREGISTER_FD: {
      fd_callback_data_t *fd_callback_data = (fd_callback_data_t *)data;
      /* We need a map to associate fd and events */
      if (_loop_unregister_fd(loop, fd_callback_data->fd) < 0) {
        ERROR("[loop_callback] Error unregistering fd from event loop");
        return -1;
      }
      break;
    }

    case FACEMGR_CB_TYPE_REGISTER_TIMER: {
      timer_callback_data_t *timer_callback_data =
          (timer_callback_data_t *)data;

      int fd = _loop_register_timer(loop, timer_callback_data);
      if (fd < 0) {
        ERROR("[loop_callback] Error registering timer to event loop");
        return -1;
      }
      return fd;
    }

    case FACEMGR_CB_TYPE_UNREGISTER_TIMER: {
      int fd = *(int *)data;

      if (_loop_unregister_timer(loop, fd) < 0) {
        ERROR("[loop_callback] Error unregistering timer from event loop");
        return -1;
      }
      return 0;
    }
  }
  return 0;
}