intertask_interface.c 25.7 KB
Newer Older
1 2
/*******************************************************************************

3 4
 Eurecom OpenAirInterface
 Copyright(c) 1999 - 2012 Eurecom
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.
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.
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.
18

19 20
 The full GNU General Public License is included in this distribution in
 the file called "COPYING".
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
28

29
 *******************************************************************************/
30

31
#define _GNU_SOURCE
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>
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

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.
 */
55 56 57 58
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

59
#include "signals.h"
60 61
#include "timer.h"

62
int itti_debug = 0;
63

64
#define ITTI_DEBUG(x, args...) do { if (itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); fflush (stdout); } \
65
    while(0)
66
#define ITTI_ERROR(x, args...) do { fprintf(stdout, "[ITTI][E]"x, ##args); fflush (stdout); } \
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,
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)
79
    STAILQ_ENTRY(message_list_s) next_element;
80
#endif
81

82
    MessageDef *msg; ///< Pointer to the message
83

84 85
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
86
} message_list_t;
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;

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;
99 100

    /* Number of messages in the queue */
101
    volatile uint32_t message_in_queue;
102
    /* Mutex for the message queue */
103
    pthread_mutex_t message_queue_mutex;
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
127 128
} task_desc_t;

129
typedef struct itti_desc_s {
130
    thread_desc_t *threads;
131
    task_desc_t *tasks;
132

133
    /* Current message number. Incremented every call to send_msg_to_task */
134
    message_number_t message_number __attribute__((aligned(8)));
135 136

    thread_id_t thread_max;
137
    task_id_t task_max;
138 139
    MessagesIds messages_id_max;

140 141
    pthread_t thread_handling_signals;

142
    const task_info_t *tasks_info;
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;
149

150
static inline message_number_t itti_increment_message_number(void) {
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);
156 157
}

158
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
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) {
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 183 184 185 186 187 188 189 190 191 192 193 194
static task_id_t itti_get_current_task_id()
{
    task_id_t task_id;
    thread_id_t thread_id;
    pthread_t thread = pthread_self ();

    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
    {
        thread_id = TASK_GET_THREAD_ID(task_id);
        if (itti_desc.threads[thread_id].task_thread == thread)
        {
            return task_id;
        }
    }

    return TASK_UNKNOWN;
}

195 196 197 198 199 200
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

201
int itti_send_broadcast_message(MessageDef *message_p) {
202
    task_id_t destination_task_id;
203
    thread_id_t origin_thread_id;
204
    uint32_t thread_id;
205
    int ret = 0;
206
    int result;
207

208
    DevAssert(message_p != NULL);
209

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

212 213
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
214 215
        MessageDef *new_message_p;

216 217 218 219
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
220
        /* Skip task that broadcast the message */
221
        if (thread_id != origin_thread_id) {
222
            /* Skip tasks which are not running */
223
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
224
                new_message_p = malloc (sizeof(MessageDef));
225
                DevAssert(message_p != NULL);
226 227

                memcpy (new_message_p, message_p, sizeof(MessageDef));
228
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
Cedric Roux's avatar
Cedric Roux committed
229
                DevCheck(result >= 0, message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
230
            }
231 232
        }
    }
233
    free (message_p);
234 235 236 237

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
238 239
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
240 241
    MessageDef *temp = NULL;

242
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
243

244 245 246 247 248 249
    if (origin_task_id == TASK_UNKNOWN)
    {
        /* Try to identify real origin task ID */
        origin_task_id = itti_get_current_task_id();
    }

Cedric Roux's avatar
Cedric Roux committed
250
    temp = calloc (1, sizeof(MessageHeader) + size);
251
    DevAssert(temp != NULL);
252

Cedric Roux's avatar
Cedric Roux committed
253 254 255
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
256 257 258 259

    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
260 261 262 263 264 265 266
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)
{
267
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
268
    message_list_t *new;
269 270 271
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
272

273
    DevAssert(message != NULL);
274
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
275

Cedric Roux's avatar
Cedric Roux committed
276 277 278 279 280
    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;
281 282
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

283
    priority = itti_get_message_priority (message_id);
284

285 286
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
287

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

291 292 293 294 295
    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);
296

297 298 299
#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);
300

301 302 303 304
        /* 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
305

306
        /* Allocate new list element */
307
        new = (message_list_t *) malloc (sizeof(struct message_list_s));
308
        DevAssert(new != NULL);
309

310 311 312 313
        /* Fill in members */
        new->msg = message;
        new->message_number = message_number;
        new->message_priority = priority;
314

315
#if defined(ENABLE_EVENT_FD)
316 317
        {
            uint64_t sem_counter = 1;
318

319
            lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
320

321 322 323
            /* 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));
        }
324
#else
325 326 327 328
        if (STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
            STAILQ_INSERT_HEAD (&itti_desc.tasks[task_id].message_queue, new, next_element);
        }
        else {
329 330 331 332
//         struct message_list_s *insert_after = NULL;
//         struct message_list_s *temp;
// 
//         /* This method is inefficient... */
333
//         STAILQ_FOREACH(temp, &itti_desc.tasks[task_id].message_queue, next_element) {
334 335 336 337 338 339 340 341 342 343 344 345 346
//             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) {
347
        STAILQ_INSERT_TAIL (&itti_desc.tasks[task_id].message_queue, new, next_element);
348
//         } else {
349
//             STAILQ_INSERT_AFTER(&itti_desc.tasks[task_id].message_queue, insert_after, new,
350 351
//                                 next_element);
//         }
352
        }
353

354 355 356 357 358 359 360 361
        /* 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);
362
#endif
363
    }
364

365 366
    ITTI_DEBUG(
            "Message %s, number %lu with priority %d successfully sent to queue (%u:%s)\n",
367
            itti_desc.messages_info[message_id].name, message_number, priority, task_id, itti_get_task_name(task_id));
368 369 370
    return 0;
}

371
#if defined(ENABLE_EVENT_FD)
372 373 374 375
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;

376
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
377 378
    DevCheck(fd >= 0, fd, 0, 0);

379
    itti_desc.tasks[task_id].nb_events++;
380 381

    /* Reallocate the events */
382 383 384
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
385 386 387 388 389

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

    /* Add the event fd to the list of monitored events */
390
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD, fd,
391 392 393 394 395 396 397 398 399 400 401
        &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)
{
402
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
403 404 405
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
406
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
407 408 409 410 411 412 413
    {
        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);
    }

414 415 416 417
    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));
418 419 420 421
}

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

424
    *events = itti_desc.tasks[task_id].events;
425

426
    return itti_desc.tasks[task_id].epoll_nb_events;
427 428
}

429 430 431 432
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;
433
    int i;
434

435
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
    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;
    }

451
    do {
452 453 454
        epoll_ret = epoll_wait(itti_desc.tasks[task_id].epoll_fd,
                               itti_desc.tasks[task_id].events,
                               itti_desc.tasks[task_id].nb_events,
455 456
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
457 458 459

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
460
                   itti_get_task_name(task_id), strerror(errno));
461 462 463 464 465 466 467
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

468
    itti_desc.tasks[task_id].epoll_nb_events = epoll_ret;
469

470
    for (i = 0; i < epoll_ret; i++) {
471
        /* Check if there is an event for ITTI for the event fd */
472 473
        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))
474
        {
475 476 477 478
            struct message_list_s *message;
            uint64_t sem_counter;

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

481
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
482
                /* No element in list -> this should not happen */
483
                DevParam(task_id, epoll_ret, 0);
484 485
            }
            *received_msg = message->msg;
486
            free (message);
487
            return;
488 489 490 491 492 493 494 495 496 497
        }
    }
}
#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
498
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
499 500 501
    DevAssert(received_msg != NULL);

    // Lock the mutex to get exclusive access to the list
502
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
503

504 505
    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));
506
        // Wait while list == 0
507 508 509 510
        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));
511 512
    }

513
    if (!STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
514
        message_list_t *temp = STAILQ_FIRST (&itti_desc.tasks[task_id].message_queue);
515 516 517 518 519

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

        /* Remove message from queue */
520
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[task_id].message_queue, next_element);
521
        free (temp);
522
        itti_desc.tasks[task_id].message_in_queue--;
523 524
    }
    // Release the mutex
525
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
526
#endif
527 528
}

529 530
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);
531
    DevAssert(received_msg != NULL);
532 533 534

    *received_msg = NULL;

535 536 537
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 1, received_msg);
#else
538
    if (itti_desc.tasks[task_id].message_in_queue != 0) {
539
        message_list_t *temp;
540 541

        // Lock the mutex to get exclusive access to the list
542
        pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
543

544
        STAILQ_FOREACH (temp, &itti_desc.tasks[task_id].message_queue, next_element)
545
        {
546 547 548 549 550 551 552 553 554
            /* 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
555 556
                       "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);
557
            break;
558 559 560
        }

        // Release the mutex
561
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
562
    }
563
#endif
564

565
    if (*received_msg == NULL) {
566
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
567 568 569
    }
}

570
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
571
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
572
    int result;
573 574

    DevAssert(start_routine != NULL);
575
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
576 577
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
578

579
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
580

581
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
582
    DevCheck(result>= 0, task_id, thread_id, result);
583 584

    /* Wait till the thread is completely ready */
585
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
586
        ;
587 588 589
    return 0;
}

590
void itti_mark_task_ready(task_id_t task_id) {
591 592
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

593 594
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

595
#if !defined(ENABLE_EVENT_FD)
596
    // Lock the mutex to get exclusive access to the list
597
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
598 599
#endif

600
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
601

602
#if !defined(ENABLE_EVENT_FD)
603
    // Release the mutex
604
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
605
#endif
606 607
}

608 609 610 611
void itti_exit_task(void) {
    pthread_exit (NULL);
}

612
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
613
    // Sends Terminate signals to all tasks.
614 615 616 617 618 619 620
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
621 622
}

623
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
624
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
625 626
    task_id_t task_id;
    thread_id_t thread_id;
627
    itti_desc.message_number = 1;
628

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

631 632
    CHECK_INIT_RETURN(signal_init());

633
    /* Saves threads and messages max values */
634
    itti_desc.task_max = task_max;
635 636
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
637
    itti_desc.thread_handling_signals = -1;
638
    itti_desc.tasks_info = tasks_info;
639 640 641
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
642 643 644 645
    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));
646 647

    /* Initializing each queue and related stuff */
648
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
649 650
    {
#if defined(ENABLE_EVENT_FD)
651 652
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
        if (lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size) < 0)
653
        {
654
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", task_id);
655 656 657
            DevAssert(0 == 1);
        }

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

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

672
        itti_desc.tasks[task_id].nb_events = 1;
673

674
        itti_desc.tasks[task_id].events = malloc(sizeof(struct epoll_event));
675

676 677
        itti_desc.tasks[task_id].events->events  = EPOLLIN;
        itti_desc.tasks[task_id].events->data.fd = itti_desc.tasks[task_id].task_event_fd;
678 679

        /* Add the event fd to the list of monitored events */
680 681
        if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD,
            itti_desc.tasks[task_id].task_event_fd, itti_desc.tasks[task_id].events) != 0)
682 683 684 685 686 687
        {
            ITTI_ERROR("epoll_ctl failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
#else
688 689
        STAILQ_INIT (&itti_desc.tasks[task_id].message_queue);
        itti_desc.tasks[task_id].message_in_queue = 0;
690

691
        // Initialize mutexes
692
        pthread_mutex_init (&itti_desc.tasks[task_id].message_queue_mutex, NULL);
693

694
        // Initialize Cond vars
695
        pthread_cond_init (&itti_desc.tasks[task_id].message_queue_cond_var, NULL);
696
#endif
697
    }
698

699
    /* Initializing each thread */
700
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++)
701
    {
702
        itti_desc.threads[thread_id].task_state = TASK_STATE_NOT_CONFIGURED;
703
    }
704

705
    itti_dump_init (messages_definition_xml, dump_file_name);
706

707
    CHECK_INIT_RETURN(timer_init ());
708 709 710 711

    return 0;
}

712 713
void itti_wait_tasks_end(void) {
    int end = 0;
714 715
    int thread_id;
    task_id_t task_id;
716 717 718
    int ready_tasks;
    int result;
    int retries = 10;
719 720 721 722 723 724 725 726

    itti_desc.thread_handling_signals = pthread_self ();

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

727 728 729
    do {
        ready_tasks = 0;

730 731
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
732
            /* Skip tasks which are not running */
733 734 735 736 737
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
738

739
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
740

741
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
742 743 744

                if (result == 0) {
                    /* Thread has terminated */
745
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
746 747 748 749 750 751 752 753 754
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
755
        }
756 757 758 759 760
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
761
    }
762 763

    itti_dump_exit();
764 765 766
}

void itti_send_terminate_message(task_id_t task_id) {
767 768
    MessageDef *terminate_message_p;

769
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
770

771
    itti_send_broadcast_message (terminate_message_p);
772
}