intertask_interface.c 25 KB
Newer Older
Cedric Roux's avatar
 
Cedric Roux committed
1 2
/*******************************************************************************

3 4
 Eurecom OpenAirInterface
 Copyright(c) 1999 - 2012 Eurecom
Cedric Roux's avatar
 
Cedric Roux committed
5

6 7 8
 This program is free software; you can redistribute it and/or modify it
 under the terms and conditions of the GNU General Public License,
 version 2, as published by the Free Software Foundation.
Cedric Roux's avatar
 
Cedric Roux committed
9

10 11 12 13
 This program is distributed in the hope it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 more details.
Cedric Roux's avatar
 
Cedric Roux committed
14

15 16 17
 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
Cedric Roux's avatar
 
Cedric Roux committed
18

19 20
 The full GNU General Public License is included in this distribution in
 the file called "COPYING".
Cedric Roux's avatar
 
Cedric Roux committed
21

22 23 24 25 26 27
 Contact Information
 Openair Admin: openair_admin@eurecom.fr
 Openair Tech : openair_tech@eurecom.fr
 Forums       : http://forums.eurecom.fr/openairinterface
 Address      : EURECOM, Campus SophiaTech, 450 Route des Chappes
 06410 Biot FRANCE
Cedric Roux's avatar
 
Cedric Roux committed
28

29
 *******************************************************************************/
Cedric Roux's avatar
 
Cedric Roux committed
30

31
#define _GNU_SOURCE
Cedric Roux's avatar
 
Cedric Roux committed
32 33 34 35 36 37
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
38
#include <signal.h>
Cedric Roux's avatar
 
Cedric Roux committed
39 40 41 42

#include "queue.h"
#include "assertions.h"

43 44 45 46 47 48
#if defined(ENABLE_EVENT_FD)
# include <sys/epoll.h>
# include <sys/eventfd.h>
# include "liblfds611.h"
#endif

Cedric Roux's avatar
 
Cedric Roux committed
49 50
#include "intertask_interface.h"
#include "intertask_interface_dump.h"
51 52 53 54

/* Includes "intertask_interface_init.h" to check prototype coherence, but
 * disable threads and messages information generation.
 */
Cedric Roux's avatar
 
Cedric Roux committed
55 56 57 58
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

59
#include "signals.h"
Cedric Roux's avatar
 
Cedric Roux committed
60 61
#include "timer.h"

62
int itti_debug = 0;
Cedric Roux's avatar
 
Cedric Roux committed
63

64
#define ITTI_DEBUG(x, args...) do { if (itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); fflush (stdout); } \
Cedric Roux's avatar
 
Cedric Roux committed
65
    while(0)
66
#define ITTI_ERROR(x, args...) do { fprintf(stdout, "[ITTI][E]"x, ##args); fflush (stdout); } \
Cedric Roux's avatar
 
Cedric Roux committed
67 68 69 70 71 72
    while(0)

/* Global message size */
#define MESSAGE_SIZE(mESSAGEiD) (sizeof(MessageHeader) + itti_desc.messages_info[mESSAGEiD].size)

typedef enum task_state_s {
73
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
Cedric Roux's avatar
 
Cedric Roux committed
74 75 76
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
77
typedef struct message_list_s {
78
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
79
    STAILQ_ENTRY(message_list_s) next_element;
80
#endif
Cedric Roux's avatar
 
Cedric Roux committed
81

82
    MessageDef *msg; ///< Pointer to the message
Cedric Roux's avatar
 
Cedric Roux committed
83

84 85
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
86
} message_list_t;
Cedric Roux's avatar
 
Cedric Roux committed
87

88 89 90 91 92 93 94
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
    /* State of the thread */
    volatile task_state_t task_state;
} thread_desc_t;

Cedric Roux's avatar
 
Cedric Roux committed
95 96
typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
97
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
Cedric Roux committed
98
    STAILQ_HEAD(message_queue_head, message_list_s) message_queue;
Cedric Roux's avatar
 
Cedric Roux committed
99 100

    /* Number of messages in the queue */
101
    volatile uint32_t message_in_queue;
Cedric Roux's avatar
 
Cedric Roux committed
102
    /* Mutex for the message queue */
103
    pthread_mutex_t message_queue_mutex;
Cedric Roux's avatar
 
Cedric Roux committed
104
    /* Conditional var for message queue and task synchro */
105
    pthread_cond_t message_queue_cond_var;
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
#else
    struct lfds611_queue_state *message_queue;

    /* This fd is used internally by ITTI. */
    int epoll_fd;

    /* The task fd */
    int task_event_fd;

    /* Number of events to monitor */
    uint16_t nb_events;

    /* Array of events monitored by the task.
     * By default only one fd is monitored (the one used to received messages
     * from other tasks).
     * More events can be suscribed later by the task itself.
     */
    struct epoll_event *events;
124 125

    int epoll_nb_events;
126
#endif
Cedric Roux's avatar
 
Cedric Roux committed
127 128
} task_desc_t;

129
typedef struct itti_desc_s {
130
    thread_desc_t *threads;
Cedric Roux's avatar
 
Cedric Roux committed
131
    task_desc_t *tasks;
132

Cedric Roux's avatar
 
Cedric Roux committed
133
    /* Current message number. Incremented every call to send_msg_to_task */
134
    message_number_t message_number __attribute__((aligned(8)));
Cedric Roux's avatar
 
Cedric Roux committed
135 136

    thread_id_t thread_max;
137
    task_id_t task_max;
Cedric Roux's avatar
 
Cedric Roux committed
138 139
    MessagesIds messages_id_max;

140 141
    pthread_t thread_handling_signals;

142
    const task_info_t *tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
143 144
    const message_info_t *messages_info;

145 146 147 148
    itti_lte_time_t lte_time;
} itti_desc_t;

static itti_desc_t itti_desc;
Cedric Roux's avatar
 
Cedric Roux committed
149

150
static inline message_number_t itti_increment_message_number(void) {
Cedric Roux's avatar
 
Cedric Roux committed
151 152 153 154
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
155
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
Cedric Roux's avatar
 
Cedric Roux committed
156 157
}

158
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
159 160 161 162 163
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

    return (itti_desc.messages_info[message_id].priority);
}

164
const char *itti_get_message_name(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
165 166 167 168 169
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

    return (itti_desc.messages_info[message_id].name);
}

170
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
171
{
172
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
Cedric Roux committed
173

174
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
175 176
}

177 178 179 180 181 182
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

183
int itti_send_broadcast_message(MessageDef *message_p) {
184
    task_id_t destination_task_id;
185
    thread_id_t origin_thread_id;
186
    uint32_t thread_id;
Cedric Roux's avatar
 
Cedric Roux committed
187
    int ret = 0;
188
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
189

190
    DevAssert(message_p != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
191

Cedric Roux's avatar
Cedric Roux committed
192
    origin_thread_id = TASK_GET_THREAD_ID(message_p->ittiMsgHeader.originTaskId);
Cedric Roux's avatar
 
Cedric Roux committed
193

194 195
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
196 197
        MessageDef *new_message_p;

198 199 200 201
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
202
        /* Skip task that broadcast the message */
203
        if (thread_id != origin_thread_id) {
204
            /* Skip tasks which are not running */
205
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
206
                new_message_p = malloc (sizeof(MessageDef));
207
                DevAssert(message_p != NULL);
208 209

                memcpy (new_message_p, message_p, sizeof(MessageDef));
210
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
Cedric Roux's avatar
Cedric Roux committed
211
                DevCheck(result >= 0, message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
212
            }
Cedric Roux's avatar
 
Cedric Roux committed
213 214
        }
    }
215
    free (message_p);
Cedric Roux's avatar
 
Cedric Roux committed
216 217 218 219

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
220 221
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
Cedric Roux's avatar
 
Cedric Roux committed
222 223
    MessageDef *temp = NULL;

224
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
225

Cedric Roux's avatar
Cedric Roux committed
226
    temp = calloc (1, sizeof(MessageHeader) + size);
227
    DevAssert(temp != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
228

Cedric Roux's avatar
Cedric Roux committed
229 230 231
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
Cedric Roux's avatar
 
Cedric Roux committed
232 233 234 235

    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
236 237 238 239 240 241 242
inline MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id)
{
    return itti_alloc_new_message_sized(origin_task_id, message_id, itti_desc.messages_info[message_id].size);
}

int itti_send_msg_to_task(task_id_t task_id, instance_t instance, MessageDef *message)
{
243
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
244
    message_list_t *new;
245 246 247
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
Cedric Roux's avatar
 
Cedric Roux committed
248

249
    DevAssert(message != NULL);
250
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
251

Cedric Roux's avatar
Cedric Roux committed
252 253 254 255 256
    message->ittiMsgHeader.destinationTaskId = task_id;
    message->ittiMsgHeader.instance = instance;
    message->ittiMsgHeader.lte_time.frame = itti_desc.lte_time.frame;
    message->ittiMsgHeader.lte_time.slot = itti_desc.lte_time.slot;
    message_id = message->ittiMsgHeader.messageId;
Cedric Roux's avatar
 
Cedric Roux committed
257 258
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

259
    priority = itti_get_message_priority (message_id);
Cedric Roux's avatar
 
Cedric Roux committed
260

261 262
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
Cedric Roux's avatar
 
Cedric Roux committed
263

264
    itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
Cedric Roux's avatar
Cedric Roux committed
265
                             sizeof(MessageHeader) + message->ittiMsgHeader.ittiMsgSize);
266

267 268 269 270 271
    if (task_id != TASK_UNKNOWN)
    {
        /* We cannot send a message if the task is not running */
        DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_READY, itti_desc.threads[thread_id].task_state,
                 TASK_STATE_READY, thread_id);
Cedric Roux's avatar
 
Cedric Roux committed
272

273 274 275
#if !defined(ENABLE_EVENT_FD)
        /* Lock the mutex to get exclusive access to the list */
        pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
276

277 278 279 280
        /* Check the number of messages in the queue */
        DevCheck(itti_desc.tasks[task_id].message_in_queue < itti_desc.tasks_info[task_id].queue_size,
                 task_id, itti_desc.tasks[task_id].message_in_queue, itti_desc.tasks_info[task_id].queue_size);
#endif
Cedric Roux's avatar
 
Cedric Roux committed
281

282
        /* Allocate new list element */
283
        new = (message_list_t *) malloc (sizeof(struct message_list_s));
284
        DevAssert(new != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
285

286 287 288 289
        /* Fill in members */
        new->msg = message;
        new->message_number = message_number;
        new->message_priority = priority;
Cedric Roux's avatar
 
Cedric Roux committed
290

291
#if defined(ENABLE_EVENT_FD)
292 293
        {
            uint64_t sem_counter = 1;
294

295
            lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
296

297 298 299
            /* Call to write for an event fd must be of 8 bytes */
            write(itti_desc.tasks[task_id].task_event_fd, &sem_counter, sizeof(sem_counter));
        }
300
#else
301 302 303 304
        if (STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
            STAILQ_INSERT_HEAD (&itti_desc.tasks[task_id].message_queue, new, next_element);
        }
        else {
Cedric Roux's avatar
 
Cedric Roux committed
305 306 307 308
//         struct message_list_s *insert_after = NULL;
//         struct message_list_s *temp;
// 
//         /* This method is inefficient... */
309
//         STAILQ_FOREACH(temp, &itti_desc.tasks[task_id].message_queue, next_element) {
Cedric Roux's avatar
 
Cedric Roux committed
310 311 312 313 314 315 316 317 318 319 320 321 322
//             struct message_list_s *next;
//             next = STAILQ_NEXT(temp, next_element);
//             /* Increment message priority to create a sort of
//              * priority based scheduler */
// //             if (temp->message_priority < TASK_PRIORITY_MAX) {
// //                 temp->message_priority++;
// //             }
//             if (next && next->message_priority < priority) {
//                 insert_after = temp;
//                 break;
//             }
//         }
//         if (insert_after == NULL) {
323
        STAILQ_INSERT_TAIL (&itti_desc.tasks[task_id].message_queue, new, next_element);
Cedric Roux's avatar
 
Cedric Roux committed
324
//         } else {
325
//             STAILQ_INSERT_AFTER(&itti_desc.tasks[task_id].message_queue, insert_after, new,
Cedric Roux's avatar
 
Cedric Roux committed
326 327
//                                 next_element);
//         }
328
        }
Cedric Roux's avatar
 
Cedric Roux committed
329

330 331 332 333 334 335 336 337
        /* Update the number of messages in the queue */
        itti_desc.tasks[task_id].message_in_queue++;
        if (itti_desc.tasks[task_id].message_in_queue == 1) {
            /* Emit a signal to wake up target task thread */
            pthread_cond_signal (&itti_desc.tasks[task_id].message_queue_cond_var);
        }
        /* Release the mutex */
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
338
#endif
339
    }
340

341 342
    ITTI_DEBUG(
            "Message %s, number %lu with priority %d successfully sent to queue (%u:%s)\n",
343
            itti_desc.messages_info[message_id].name, message_number, priority, task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
344 345 346
    return 0;
}

347
#if defined(ENABLE_EVENT_FD)
348 349 350 351
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;

352
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
353 354
    DevCheck(fd >= 0, fd, 0, 0);

355
    itti_desc.tasks[task_id].nb_events++;
356 357

    /* Reallocate the events */
358 359 360
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
361 362 363 364 365

    event.events  = EPOLLIN;
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
366
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD, fd,
367 368 369 370 371 372 373 374 375 376 377
        &event) != 0)
    {
        ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed for task %s, fd %d: %s\n",
                   itti_get_task_name(task_id), fd, strerror(errno));
        /* Always assert on this condition */
        DevAssert(0 == 1);
    }
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
378
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
379 380 381
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
382
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
383 384 385 386 387 388 389
    {
        ITTI_ERROR("epoll_ctl (EPOLL_CTL_DEL) failed for task %s and fd %d: %s\n",
                   itti_get_task_name(task_id), fd, strerror(errno));
        /* Always assert on this condition */
        DevAssert(0 == 1);
    }

390 391 392 393
    itti_desc.tasks[task_id].nb_events--;
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
394 395 396 397
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
398
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
399

400
    *events = itti_desc.tasks[task_id].events;
401

402
    return itti_desc.tasks[task_id].epoll_nb_events;
403 404
}

405 406 407 408
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
    int epoll_ret = 0;
    int epoll_timeout = 0;
409
    int i;
410

411
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
    DevAssert(received_msg != NULL);

    *received_msg = NULL;

    if (polling) {
        /* In polling mode we set the timeout to 0 causing epoll_wait to return
         * immediately.
         */
        epoll_timeout = 0;
    } else {
        /* timeout = -1 causes the epoll_wait to wait indefinetely.
         */
        epoll_timeout = -1;
    }

427
    do {
428 429 430
        epoll_ret = epoll_wait(itti_desc.tasks[task_id].epoll_fd,
                               itti_desc.tasks[task_id].events,
                               itti_desc.tasks[task_id].nb_events,
431 432
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
433 434 435

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
436
                   itti_get_task_name(task_id), strerror(errno));
437 438 439 440 441 442 443
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

444
    itti_desc.tasks[task_id].epoll_nb_events = epoll_ret;
445

446
    for (i = 0; i < epoll_ret; i++) {
447
        /* Check if there is an event for ITTI for the event fd */
448 449
        if ((itti_desc.tasks[task_id].events[i].events & EPOLLIN) &&
            (itti_desc.tasks[task_id].events[i].data.fd == itti_desc.tasks[task_id].task_event_fd))
450
        {
451 452 453 454
            struct message_list_s *message;
            uint64_t sem_counter;

            /* Read will always return 1 */
455
            read (itti_desc.tasks[task_id].task_event_fd, &sem_counter, sizeof(sem_counter));
456

457
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
458
                /* No element in list -> this should not happen */
459
                DevParam(task_id, epoll_ret, 0);
460 461
            }
            *received_msg = message->msg;
462
            free (message);
463
            return;
464 465 466 467 468 469 470 471 472 473
        }
    }
}
#endif

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
#else
474
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
475 476 477
    DevAssert(received_msg != NULL);

    // Lock the mutex to get exclusive access to the list
478
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
479

480 481
    if (itti_desc.tasks[task_id].message_in_queue == 0) {
        ITTI_DEBUG("Message in queue[(%u:%s)] == 0, waiting\n", task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
482
        // Wait while list == 0
483 484 485 486
        pthread_cond_wait (&itti_desc.tasks[task_id].message_queue_cond_var,
                           &itti_desc.tasks[task_id].message_queue_mutex);
        ITTI_DEBUG("Receiver queue[(%u:%s)] got new message notification\n",
                   task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
487 488
    }

489
    if (!STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
490
        message_list_t *temp = STAILQ_FIRST (&itti_desc.tasks[task_id].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
491 492 493 494 495

        /* Update received_msg reference */
        *received_msg = temp->msg;

        /* Remove message from queue */
496
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[task_id].message_queue, next_element);
497
        free (temp);
498
        itti_desc.tasks[task_id].message_in_queue--;
Cedric Roux's avatar
 
Cedric Roux committed
499 500
    }
    // Release the mutex
501
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
502
#endif
Cedric Roux's avatar
 
Cedric Roux committed
503 504
}

505 506
void itti_poll_msg(task_id_t task_id, MessageDef **received_msg) {
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
507
    DevAssert(received_msg != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
508 509 510

    *received_msg = NULL;

511 512 513
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 1, received_msg);
#else
514
    if (itti_desc.tasks[task_id].message_in_queue != 0) {
515
        message_list_t *temp;
Cedric Roux's avatar
 
Cedric Roux committed
516 517

        // Lock the mutex to get exclusive access to the list
518
        pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
519

520
        STAILQ_FOREACH (temp, &itti_desc.tasks[task_id].message_queue, next_element)
Cedric Roux's avatar
 
Cedric Roux committed
521
        {
522 523 524 525 526 527 528 529 530
            /* Update received_msg reference */
            *received_msg = temp->msg;

            /* Remove message from queue */
            STAILQ_REMOVE (&itti_desc.tasks[task_id].message_queue, temp, message_list_s, next_element);
            free (temp);
            itti_desc.tasks[task_id].message_in_queue--;

            ITTI_DEBUG(
Cedric Roux's avatar
Cedric Roux committed
531 532
                       "Receiver queue[(%u:%s)] got new message %s, number %lu\n",
                       task_id, itti_get_task_name(task_id), itti_desc.messages_info[temp->msg->ittiMsgHeader.messageId].name, temp->message_number);
533
            break;
Cedric Roux's avatar
 
Cedric Roux committed
534 535 536
        }

        // Release the mutex
537
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
538
    }
539
#endif
Cedric Roux's avatar
 
Cedric Roux committed
540

541
    if (*received_msg == NULL) {
542
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
543 544 545
    }
}

546
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
Cedric Roux's avatar
 
Cedric Roux committed
547
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
548
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
549 550

    DevAssert(start_routine != NULL);
551
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
552 553
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
Cedric Roux's avatar
 
Cedric Roux committed
554

555
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
Cedric Roux's avatar
 
Cedric Roux committed
556

557
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
558
    DevCheck(result>= 0, task_id, thread_id, result);
Cedric Roux's avatar
 
Cedric Roux committed
559 560

    /* Wait till the thread is completely ready */
561
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
562
        ;
Cedric Roux's avatar
 
Cedric Roux committed
563 564 565
    return 0;
}

566
void itti_mark_task_ready(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
567 568
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

569 570
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

571
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
572
    // Lock the mutex to get exclusive access to the list
573
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
574 575
#endif

576
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
577

578
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
579
    // Release the mutex
580
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
581
#endif
582 583
}

584 585 586 587
void itti_exit_task(void) {
    pthread_exit (NULL);
}

588
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
589
    // Sends Terminate signals to all tasks.
590 591 592 593 594 595 596
    itti_send_terminate_message (task_id);

    if (itti_desc.thread_handling_signals >= 0) {
        pthread_kill (itti_desc.thread_handling_signals, SIGUSR1);
    }

    pthread_exit (NULL);
Cedric Roux's avatar
 
Cedric Roux committed
597 598
}

599
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
600
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
Cedric Roux's avatar
 
Cedric Roux committed
601
    int i;
602
    itti_desc.message_number = 1;
Cedric Roux's avatar
 
Cedric Roux committed
603

604
    ITTI_DEBUG("Init: %d tasks, %d threads, %d messages\n", task_max, thread_max, messages_id_max);
605

606 607
    CHECK_INIT_RETURN(signal_init());

Cedric Roux's avatar
 
Cedric Roux committed
608
    /* Saves threads and messages max values */
609
    itti_desc.task_max = task_max;
Cedric Roux's avatar
 
Cedric Roux committed
610 611
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
612
    itti_desc.thread_handling_signals = -1;
613
    itti_desc.tasks_info = tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
614 615 616
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
617 618 619 620
    itti_desc.tasks = calloc (itti_desc.task_max, sizeof(task_desc_t));

    /* Allocates memory for threads info */
    itti_desc.threads = calloc (itti_desc.thread_max, sizeof(thread_desc_t));
Cedric Roux's avatar
 
Cedric Roux committed
621 622

    /* Initializing each queue and related stuff */
623
    for (i = TASK_FIRST; i < itti_desc.task_max; i++)
624 625
    {
#if defined(ENABLE_EVENT_FD)
626 627
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[i].queue_size);
        if (lfds611_queue_new(&itti_desc.tasks[i].message_queue, itti_desc.tasks_info[i].queue_size) < 0)
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
        {
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", i);
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].epoll_fd = epoll_create1(0);
        if (itti_desc.tasks[i].epoll_fd == -1) {
            ITTI_ERROR("Failed to create new epoll fd: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].task_event_fd = eventfd(0, EFD_SEMAPHORE);
        if (itti_desc.tasks[i].task_event_fd == -1) {
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].nb_events = 1;

        itti_desc.tasks[i].events = malloc(sizeof(struct epoll_event));

        itti_desc.tasks[i].events->events  = EPOLLIN;
        itti_desc.tasks[i].events->data.fd = itti_desc.tasks[i].task_event_fd;

        /* Add the event fd to the list of monitored events */
        if (epoll_ctl(itti_desc.tasks[i].epoll_fd, EPOLL_CTL_ADD,
            itti_desc.tasks[i].task_event_fd, itti_desc.tasks[i].events) != 0)
        {
            ITTI_ERROR("epoll_ctl failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
#else
663
        STAILQ_INIT (&itti_desc.tasks[i].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
664
        itti_desc.tasks[i].message_in_queue = 0;
665

Cedric Roux's avatar
 
Cedric Roux committed
666
        // Initialize mutexes
667
        pthread_mutex_init (&itti_desc.tasks[i].message_queue_mutex, NULL);
668

Cedric Roux's avatar
 
Cedric Roux committed
669
        // Initialize Cond vars
670
        pthread_cond_init (&itti_desc.tasks[i].message_queue_cond_var, NULL);
671
#endif
672
    }
673

674 675 676 677
    /* Initializing each thread */
    for (i = THREAD_FIRST; i < itti_desc.thread_max; i++)
    {
        itti_desc.threads[i].task_state = TASK_STATE_NOT_CONFIGURED;
Cedric Roux's avatar
 
Cedric Roux committed
678
    }
679

680
    itti_dump_init (messages_definition_xml, dump_file_name);
Cedric Roux's avatar
 
Cedric Roux committed
681

682
    CHECK_INIT_RETURN(timer_init ());
Cedric Roux's avatar
 
Cedric Roux committed
683 684 685 686

    return 0;
}

687 688
void itti_wait_tasks_end(void) {
    int end = 0;
689 690
    int thread_id;
    task_id_t task_id;
691 692 693
    int ready_tasks;
    int result;
    int retries = 10;
694 695 696 697 698 699 700 701

    itti_desc.thread_handling_signals = pthread_self ();

    /* Handle signals here */
    while (end == 0) {
        signal_handle (&end);
    }

702 703 704
    do {
        ready_tasks = 0;

705 706
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
707
            /* Skip tasks which are not running */
708 709 710 711 712
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
713

714
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
715

716
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
717 718 719

                if (result == 0) {
                    /* Thread has terminated */
720
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
721 722 723 724 725 726 727 728 729
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
730
        }
731 732 733 734 735
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
736
    }
737 738

    itti_dump_exit();
739 740 741
}

void itti_send_terminate_message(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
742 743
    MessageDef *terminate_message_p;

744
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
Cedric Roux's avatar
 
Cedric Roux committed
745

746
    itti_send_broadcast_message (terminate_message_p);
Cedric Roux's avatar
 
Cedric Roux committed
747
}