git.meshlink.io Git - meshlink/blob - test/blackbox/common/mesh_event_handler.c

   1 /*
   2     mesh_event_handler.c -- handling of mesh events API
   3     Copyright (C) 2018  Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <netinet/in.h>
  23 #include <arpa/inet.h>
  24 #include <sys/types.h>
  25 #include <net/if.h>
  26 #include <sys/ioctl.h>
  27 #include <sys/socket.h>
  28 #include <stdbool.h>
  29 #include <errno.h>
  30 #include <assert.h>
  31 #include <fcntl.h>
  32 #include <time.h>
  33 #include <pthread.h>
  34 #include "../../../src/meshlink_queue.h"
  35 #include "../../utils.h"
  36 #include "mesh_event_handler.h"
  37
  38 #define SERVER_LISTEN_PORT "9000" /* Port number that is binded with mesh event server socket */
  39 #define UDP_BUFF_MAX 2000
  40
  41 const char *event_status[] = {
  42         [NODE_STARTED]                          = "Node Started",
  43         [NODE_JOINED]                           = "Node Joined",
  44         [ERR_NETWORK]                           = "Network Error",
  45         [CHANNEL_OPENED]                        = "Channel Opened",
  46         [CHANNEL_DATA_RECIEVED]                         = "Channel Data Received",
  47         [SIG_ABORT]                             = "SIG_ABORT Received",
  48         [MESH_EVENT_COMPLETED]                          = "MESH_EVENT_COMPLETED Received"
  49 };
  50
  51 // TODO: Implement mesh event handling with reentrancy .
  52 static struct sockaddr_in server_addr;
  53 static int client_fd = -1;
  54 static int server_fd = -1;
  55 static pthread_t event_receive_thread, event_handle_thread;
  56 static meshlink_queue_t event_queue;
  57 static bool event_receive_thread_running, event_handle_thread_running;
  58 static struct cond_flag sync_event = {.mutex  = PTHREAD_MUTEX_INITIALIZER, .cond = PTHREAD_COND_INITIALIZER};
  59
  60 static void set_cond_flag(struct cond_flag *s, bool flag) {
  61         pthread_mutex_lock(&s->mutex);
  62         s->flag = flag;
  63         pthread_cond_broadcast(&s->cond);
  64         pthread_mutex_unlock(&s->mutex);
  65 }
  66
  67 static bool wait_cond_flag(struct cond_flag *s, int seconds) {
  68         struct timespec timeout;
  69         clock_gettime(CLOCK_REALTIME, &timeout);
  70         timeout.tv_sec += seconds;
  71
  72         pthread_mutex_lock(&s->mutex);
  73
  74         while(!s->flag)
  75                 if(!pthread_cond_timedwait(&s->cond, &s->mutex, &timeout) || errno != EINTR) {
  76                         break;
  77                 }
  78
  79         pthread_mutex_unlock(&s->mutex);
  80
  81         return s->flag;
  82 }
  83
  84 // event_receive_handler running in a separate thread queues all the events received from the UDP port
  85 static void *event_receive_handler(void *arg) {
  86         size_t recv_ret;
  87         char udp_buff[UDP_BUFF_MAX];
  88         struct sockaddr client;
  89         socklen_t soc_len;
  90
  91         while(event_receive_thread_running) {
  92                 recv_ret = recvfrom(server_fd, udp_buff, sizeof(udp_buff), 0, &client, &soc_len);
  93                 assert(recv_ret >= sizeof(mesh_event_payload_t));
  94
  95                 // Push received mesh event data into the event_queue
  96                 mesh_event_payload_t *data = malloc(sizeof(mesh_event_payload_t));
  97                 assert(data);
  98                 memcpy(data, udp_buff, sizeof(mesh_event_payload_t));
  99
 100                 // Also receive if there is any payload
 101                 if(data->payload_length) {
 102                         void *payload_data = malloc(data->payload_length);
 103                         assert(payload_data);
 104                         memcpy(payload_data, udp_buff + (int)sizeof(mesh_event_payload_t), data->payload_length);
 105                         data->payload = payload_data;
 106                 } else {
 107                         data->payload = NULL;
 108                 }
 109
 110                 // Push the event into the event queue
 111                 assert(meshlink_queue_push(&event_queue, data));
 112         }
 113
 114         return NULL;
 115 }
 116
 117 // `event_handler' runs in a separate thread which invokes the event handle callback with
 118 // event packet as argument returns from the thread when the callback returns `true' or timeout
 119 static void *event_handler(void *argv) {
 120         bool callback_return = false;
 121         void *data;
 122         mesh_event_payload_t mesh_event_rec_packet;
 123         mesh_event_callback_t callback = (mesh_event_callback_t)argv;
 124
 125         while(event_handle_thread_running) {
 126
 127                 // Pops the event if found in the event queue
 128                 while((data = meshlink_queue_pop(&event_queue)) != NULL) {
 129                         memcpy(&mesh_event_rec_packet, data, sizeof(mesh_event_payload_t));
 130                         free(data);
 131
 132                         // Invokes the callback with the popped event packet
 133                         callback_return = callback(mesh_event_rec_packet);
 134
 135                         if(mesh_event_rec_packet.payload_length) {
 136                                 free(mesh_event_rec_packet.payload);
 137                         }
 138
 139                         // Return or Close the event handle thread if callback returns true
 140                         if(callback_return) {
 141                                 set_cond_flag(&sync_event, true);
 142                                 event_handle_thread_running = false;
 143                                 break;
 144                         }
 145                 }
 146         }
 147
 148         return NULL;
 149 }
 150
 151 char *mesh_event_sock_create(const char *if_name) {
 152         struct sockaddr_in server = {0};
 153         char *ip;
 154         struct ifreq req_if = {0};
 155         struct sockaddr_in *resp_if_addr;
 156
 157         assert(if_name);
 158         assert(!event_receive_thread_running);
 159
 160         server_fd = socket(AF_INET, SOCK_DGRAM, 0);
 161         assert(server_fd >= 0);
 162
 163         int reuse = 1;
 164         assert(setsockopt(server_fd, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse)) != -1);
 165
 166         req_if.ifr_addr.sa_family = AF_INET;
 167         strncpy(req_if.ifr_name, if_name, IFNAMSIZ - 1);
 168         assert(ioctl(server_fd, SIOCGIFADDR, &req_if) != -1);
 169         resp_if_addr = (struct sockaddr_in *) & (req_if.ifr_addr);
 170
 171         server.sin_family = AF_INET;
 172         server.sin_addr   = resp_if_addr->sin_addr;
 173         server.sin_port   = htons(atoi(SERVER_LISTEN_PORT));
 174         assert(bind(server_fd, (struct sockaddr *) &server, sizeof(struct sockaddr)) != -1);
 175
 176         assert(ip = malloc(30));
 177         strncpy(ip, inet_ntoa(resp_if_addr->sin_addr), 20);
 178         strcat(ip, ":");
 179         strcat(ip, SERVER_LISTEN_PORT);
 180
 181         meshlink_queue_init(&event_queue);
 182         event_receive_thread_running = true;
 183         assert(!pthread_create(&event_receive_thread, NULL, event_receive_handler, NULL));
 184
 185         return ip;
 186 }
 187
 188 void mesh_event_sock_connect(const char *import) {
 189         assert(import);
 190
 191         char *ip = strdup(import);
 192         assert(ip);
 193         char *port = strchr(ip, ':');
 194         assert(port);
 195         *port = '\0';
 196         port++;
 197
 198         memset(&server_addr, 0, sizeof(server_addr));
 199         server_addr.sin_family      = AF_INET;
 200         server_addr.sin_addr.s_addr = inet_addr(ip);
 201         server_addr.sin_port        = htons(atoi(port));
 202         client_fd = socket(AF_INET, SOCK_DGRAM, 0);
 203         free(ip);
 204         assert(client_fd >= 0);
 205 }
 206
 207 bool mesh_event_sock_send(int client_id, mesh_event_t event, const void *payload, size_t payload_length) {
 208         if(client_fd < 0) {
 209                 fprintf(stderr, "mesh_event_sock_send called without calling mesh_event_sock_connect\n");
 210                 return false;
 211         }
 212
 213         if(client_id < 0 || event < 0 || event >= MAX_EVENT || (payload == NULL && payload_length)) {
 214                 fprintf(stderr, "Invalid parameters\n");
 215                 return false;
 216         }
 217
 218         ssize_t send_size = sizeof(mesh_event_payload_t) + payload_length;
 219         char *send_packet = malloc(send_size);
 220         assert(send_packet);
 221         mesh_event_payload_t mesh_event_send_packet;
 222
 223         mesh_event_send_packet.client_id   = client_id;
 224         mesh_event_send_packet.mesh_event  = event;
 225         mesh_event_send_packet.payload_length = payload_length;
 226         mesh_event_send_packet.payload = NULL;
 227         memcpy(send_packet, &mesh_event_send_packet, sizeof(mesh_event_send_packet));
 228
 229         if(payload_length) {
 230                 memcpy(send_packet + sizeof(mesh_event_send_packet), payload, payload_length);
 231         }
 232
 233         ssize_t send_ret = sendto(client_fd, send_packet, send_size, 0, (const struct sockaddr *) &server_addr, sizeof(server_addr));
 234         free(send_packet);
 235
 236         if(send_ret < 0) {
 237                 perror("sendto status");
 238                 return false;
 239         } else {
 240                 return true;
 241         }
 242 }
 243
 244 bool wait_for_event(mesh_event_callback_t callback, int seconds) {
 245         if(callback == NULL || seconds == 0) {
 246                 fprintf(stderr, "Invalid parameters\n");
 247                 return false;
 248         }
 249
 250         if(event_handle_thread_running) {
 251                 fprintf(stderr, "Event handle thread is already running\n");
 252                 return false;
 253         } else {
 254                 event_handle_thread_running = true;
 255         }
 256
 257         set_cond_flag(&sync_event, false);
 258         assert(!pthread_create(&event_handle_thread, NULL, event_handler, (void *)callback));
 259         bool wait_ret = wait_cond_flag(&sync_event, seconds);
 260         event_handle_thread_running = false;
 261         pthread_cancel(event_handle_thread);
 262
 263         return wait_ret;
 264 }
 265
 266 void mesh_events_flush(void) {
 267         mesh_event_payload_t *data;
 268
 269         while((data = meshlink_queue_pop(&event_queue)) != NULL) {
 270                 if(data->payload_length) {
 271                         free(data->payload);
 272                 }
 273
 274                 free(data);
 275         }
 276 }
 277
 278 void mesh_event_destroy(void) {
 279         mesh_events_flush();
 280         event_receive_thread_running = false;
 281         pthread_cancel(event_receive_thread);
 282 }