intertask_interface.c 30.5 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 43
#ifdef RTAI
# include <rtai_fifos.h>
#endif

44 45 46
#include "queue.h"
#include "assertions.h"

47 48 49 50 51 52
#if defined(ENABLE_EVENT_FD)
# include <sys/epoll.h>
# include <sys/eventfd.h>
# include "liblfds611.h"
#endif

53 54
#include "intertask_interface.h"
#include "intertask_interface_dump.h"
55

56 57 58 59
#if defined(OAI_EMU) || defined(RTAI)
# include "vcd_signal_dumper.h"
#endif

60 61 62
/* Includes "intertask_interface_init.h" to check prototype coherence, but
 * disable threads and messages information generation.
 */
63 64 65 66
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

67
#include "signals.h"
68 69
#include "timer.h"

70 71
const int itti_debug = 0;
const int itti_debug_poll = 0;
72

73 74 75 76 77 78 79 80
/* Don't flush if using RTAI */
#ifdef RTAI
# define ITTI_DEBUG(x, args...) do { if (itti_debug) rt_printk("[ITTI][D]"x, ##args); } \
    while(0)
# define ITTI_ERROR(x, args...) do { rt_printk("[ITTI][E]"x, ##args); } \
    while(0)
#else
# define ITTI_DEBUG(x, args...) do { if (itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); fflush (stdout); } \
81
    while(0)
82
# define ITTI_ERROR(x, args...) do { fprintf(stdout, "[ITTI][E]"x, ##args); fflush (stdout); } \
83
    while(0)
84
#endif
85 86 87 88 89

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

typedef enum task_state_s {
90
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
91 92 93
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
94
typedef struct message_list_s {
95
#if !defined(ENABLE_EVENT_FD)
96
    STAILQ_ENTRY(message_list_s) next_element;
97
#endif
98

99
    MessageDef *msg; ///< Pointer to the message
100

101 102
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
103
} message_list_t;
104

105 106 107
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
108

109 110 111 112
    /* State of the thread */
    volatile task_state_t task_state;
} thread_desc_t;

113 114
typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
115
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
Cedric Roux committed
116
    STAILQ_HEAD(message_queue_head, message_list_s) message_queue;
117 118

    /* Number of messages in the queue */
119
    volatile uint32_t message_in_queue;
120
    /* Mutex for the message queue */
121
    pthread_mutex_t message_queue_mutex;
122
    /* Conditional var for message queue and task synchro */
123
    pthread_cond_t message_queue_cond_var;
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
#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;
142 143

    int epoll_nb_events;
144
#endif
145 146
} task_desc_t;

147
typedef struct itti_desc_s {
148
    thread_desc_t *threads;
149
    task_desc_t *tasks;
150

151
    /* Current message number. Incremented every call to send_msg_to_task */
152
    message_number_t message_number __attribute__((aligned(8)));
153 154

    thread_id_t thread_max;
155
    task_id_t task_max;
156 157
    MessagesIds messages_id_max;

158 159
    pthread_t thread_handling_signals;

160
    const task_info_t *tasks_info;
161 162
    const message_info_t *messages_info;

163 164 165 166
    itti_lte_time_t lte_time;
} itti_desc_t;

static itti_desc_t itti_desc;
167

168
static inline message_number_t itti_increment_message_number(void) {
169 170 171 172
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
173
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
174 175
}

176
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
177 178 179 180 181
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

182
const char *itti_get_message_name(MessagesIds message_id) {
183 184 185 186 187
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

188
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
189
{
190
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
Cedric Roux committed
191

192
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
193 194
}

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
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;
}

213 214 215 216 217 218
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

219
int itti_send_broadcast_message(MessageDef *message_p) {
220
    task_id_t destination_task_id;
221
    thread_id_t origin_thread_id;
222
    uint32_t thread_id;
223
    int ret = 0;
224
    int result;
225

226
    DevAssert(message_p != NULL);
227

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

230 231
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
232 233
        MessageDef *new_message_p;

234 235 236 237
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
238
        /* Skip task that broadcast the message */
239
        if (thread_id != origin_thread_id) {
240
            /* Skip tasks which are not running */
241
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
242
                new_message_p = malloc (sizeof(MessageDef));
243
                DevAssert(message_p != NULL);
244 245

                memcpy (new_message_p, message_p, sizeof(MessageDef));
246
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
Cedric Roux's avatar
Cedric Roux committed
247
                DevCheck(result >= 0, message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
248
            }
249 250
        }
    }
251
    free (message_p);
252 253 254 255

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
256 257
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
258 259
    MessageDef *temp = NULL;

260
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
261

262 263 264 265 266 267
    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
268
    temp = calloc (1, sizeof(MessageHeader) + size);
269
    DevAssert(temp != NULL);
270

Cedric Roux's avatar
Cedric Roux committed
271 272 273
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
274 275 276 277

    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
278 279 280 281 282 283 284
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)
{
285
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
286
    thread_id_t origin_task_id;
287
    message_list_t *new;
288 289 290
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
291

292
    DevAssert(message != NULL);
293
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
294

Cedric Roux's avatar
Cedric Roux committed
295 296 297 298 299
    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;
300 301
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

302 303 304 305 306 307 308
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_SEND_MSG,
                                            task_id);
#endif

309
    priority = itti_get_message_priority (message_id);
310

311 312
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
313

314
#ifdef RTAI
315 316 317 318
    if ((pthread_self() == itti_desc.threads[TASK_GET_THREAD_ID(origin_task_id)].task_thread) ||
        (task_id == TASK_UNKNOWN) ||
        ((TASK_GET_PARENT_TASK_ID(origin_task_id) != TASK_UNKNOWN) &&
        (pthread_self() == itti_desc.threads[TASK_GET_PARENT_TASK_ID(origin_task_id)].task_thread)))
319 320 321 322 323 324 325 326 327 328 329
#endif
        itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
                                 sizeof(MessageHeader) + message->ittiMsgHeader.ittiMsgSize);

    ITTI_DEBUG("Message %s, number %lu with priority %d successfully sent from %s to queue (%u:%s)\n",
               itti_desc.messages_info[message_id].name,
               message_number,
               priority,
               itti_get_task_name(origin_task_id),
               task_id,
               itti_get_task_name(task_id));
330

331 332 333 334 335
    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);
336

337 338 339
#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);
340

341 342 343 344
        /* 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
345

346
        /* Allocate new list element */
347
        new = (message_list_t *) malloc (sizeof(struct message_list_s));
348
        DevAssert(new != NULL);
349

350 351 352 353
        /* Fill in members */
        new->msg = message;
        new->message_number = message_number;
        new->message_priority = priority;
354

355
#if defined(ENABLE_EVENT_FD)
356 357 358 359 360 361 362 363 364 365 366 367 368
# ifdef RTAI
        if ((pthread_self() != itti_desc.threads[TASK_GET_THREAD_ID(origin_task_id)].task_thread) &&
            (TASK_GET_PARENT_TASK_ID(origin_task_id) != TASK_UNKNOWN))
        {
            /* This is the RT task, -> enqueue in the parent thread */
            lfds611_queue_enqueue(itti_desc.tasks[TASK_GET_PARENT_TASK_ID(origin_task_id)].message_queue, new);

            /* Signal from RT thread */
//             rtf_sem_post(56);
        } else
# endif
        /* No need to use a event fd for subtasks */
        if (TASK_GET_PARENT_TASK_ID(task_id) == TASK_UNKNOWN)
369
        {
370
            ssize_t  write_ret;
371
            uint64_t sem_counter = 1;
372

373
            lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
374

375
            /* Call to write for an event fd must be of 8 bytes */
376
            write_ret = write(itti_desc.tasks[task_id].task_event_fd, &sem_counter, sizeof(sem_counter));
377 378 379
            DevCheck(write_ret == sizeof(sem_counter), write_ret, sem_counter, task_id);
        } else {
            lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
380
        }
381
#else
382 383 384 385
        if (STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
            STAILQ_INSERT_HEAD (&itti_desc.tasks[task_id].message_queue, new, next_element);
        }
        else {
386 387 388 389
//         struct message_list_s *insert_after = NULL;
//         struct message_list_s *temp;
// 
//         /* This method is inefficient... */
390
//         STAILQ_FOREACH(temp, &itti_desc.tasks[task_id].message_queue, next_element) {
391 392 393 394 395 396 397 398 399 400 401 402 403
//             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) {
404
        STAILQ_INSERT_TAIL (&itti_desc.tasks[task_id].message_queue, new, next_element);
405
//         } else {
406
//             STAILQ_INSERT_AFTER(&itti_desc.tasks[task_id].message_queue, insert_after, new,
407 408
//                                 next_element);
//         }
409
        }
410

411 412 413 414 415 416 417 418
        /* 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);
419
#endif
420
    }
421

422 423 424 425 426
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_SEND_MSG_END,
                                            task_id);
#endif

427 428 429
    return 0;
}

430
#if defined(ENABLE_EVENT_FD)
431 432 433 434
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;

435
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
436 437
    DevCheck(fd >= 0, fd, 0, 0);

438
    itti_desc.tasks[task_id].nb_events++;
439 440

    /* Reallocate the events */
441 442 443
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
444

445
    event.events  = EPOLLIN | EPOLLERR;
446 447 448
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
449
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD, fd,
450 451 452 453 454 455 456
        &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);
    }
457 458

    ITTI_DEBUG("Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
459 460 461 462
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
463
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
464 465 466
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
467
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
468 469 470 471 472 473 474
    {
        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);
    }

475 476 477 478
    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));
479 480 481 482
}

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

485
    *events = itti_desc.tasks[task_id].events;
486

487
    return itti_desc.tasks[task_id].epoll_nb_events;
488 489
}

490 491 492 493
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;
494
    int i;
495

496
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
    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;
    }

512
    do {
513 514 515
        epoll_ret = epoll_wait(itti_desc.tasks[task_id].epoll_fd,
                               itti_desc.tasks[task_id].events,
                               itti_desc.tasks[task_id].nb_events,
516 517
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
518 519 520

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
521
                   itti_get_task_name(task_id), strerror(errno));
522 523 524 525 526 527 528
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

529
    itti_desc.tasks[task_id].epoll_nb_events = epoll_ret;
530

531
    for (i = 0; i < epoll_ret; i++) {
532
        /* Check if there is an event for ITTI for the event fd */
533 534
        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))
535
        {
536 537
            struct message_list_s *message;
            uint64_t sem_counter;
538
            ssize_t  read_ret;
539 540

            /* Read will always return 1 */
541 542
            read_ret = read (itti_desc.tasks[task_id].task_event_fd, &sem_counter, sizeof(sem_counter));
            DevCheck(read_ret == sizeof(sem_counter), read_ret, sizeof(sem_counter), 0);
543

544
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
545
                /* No element in list -> this should not happen */
546
                DevParam(task_id, epoll_ret, 0);
547 548
            }
            *received_msg = message->msg;
549
            free (message);
550
            return;
551 552 553 554 555 556 557
        }
    }
}
#endif

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
558 559 560 561
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_RECV_MSG,
                                            task_id);
#endif
562 563 564
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
#else
565
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
566 567 568
    DevAssert(received_msg != NULL);

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

571 572
    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));
573
        // Wait while list == 0
574 575 576 577
        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));
578 579
    }

580
    if (!STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
581
        message_list_t *temp = STAILQ_FIRST (&itti_desc.tasks[task_id].message_queue);
582 583 584 585 586

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

        /* Remove message from queue */
587
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[task_id].message_queue, next_element);
588
        free (temp);
589
        itti_desc.tasks[task_id].message_in_queue--;
590 591
    }
    // Release the mutex
592
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
593
#endif
594 595 596 597
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_RECV_MSG_END,
                                            task_id);
#endif
598 599
}

600 601
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);
602
    DevAssert(received_msg != NULL);
603 604 605

    *received_msg = NULL;

606 607 608 609 610
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_POLL_MSG,
                                            task_id);
#endif

611
#if defined(ENABLE_EVENT_FD)
612 613 614 615 616 617 618 619 620
    {
        struct message_list_s *message;

        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 1)
        {
            *received_msg = message->msg;
            free (message);
        }
    }
621
#else
622
    if (itti_desc.tasks[task_id].message_in_queue != 0) {
623
        message_list_t *temp;
624 625

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

628
        STAILQ_FOREACH (temp, &itti_desc.tasks[task_id].message_queue, next_element)
629
        {
630 631 632 633 634 635 636 637 638
            /* 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
639 640
                       "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);
641
            break;
642 643 644
        }

        // Release the mutex
645
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
646
    }
647
#endif
648

649
    if ((itti_debug_poll) && (*received_msg == NULL)) {
650
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
651
    }
652 653 654 655 656

#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_POLL_MSG_END,
                                            task_id);
#endif
657 658
}

659
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
660
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
661
    int result;
662 663

    DevAssert(start_routine != NULL);
664
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
665 666
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
667

668
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
669

670 671
    ITTI_DEBUG("Create thread for task %s\n", itti_get_task_name(task_id));

672
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
673
    DevCheck(result >= 0, task_id, thread_id, result);
674 675

    /* Wait till the thread is completely ready */
676
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
677
        ;
678 679 680
    return 0;
}

681 682
void itti_mark_task_ready(task_id_t task_id)
{
683 684
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

685 686
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

687 688 689 690 691 692 693 694 695
#ifdef RTAI
    /* Assign low priority to created threads */
    {
        struct sched_param sched_param;
        sched_param.sched_priority = sched_get_priority_min(SCHED_FIFO) + 1;
        sched_setscheduler(0, SCHED_FIFO, &sched_param);
    }
#endif

696 697 698
    /* Register the thread in itti dump */
    itti_dump_thread_use_ring_buffer();

699 700 701 702
#if defined(ENABLE_EVENT_FD)
    /* Mark the thread as using LFDS queue */
    lfds611_queue_use(itti_desc.tasks[task_id].message_queue);
#else
703
    // Lock the mutex to get exclusive access to the list
704
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
705 706
#endif

707
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
708

709
#if !defined(ENABLE_EVENT_FD)
710
    // Release the mutex
711
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
712
#endif
713 714
}

715 716 717 718
void itti_exit_task(void) {
    pthread_exit (NULL);
}

719
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
720
    // Sends Terminate signals to all tasks.
721 722 723 724 725 726 727
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
728 729
}

730
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
731
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
732 733
    task_id_t task_id;
    thread_id_t thread_id;
734 735
    int ret;

736
    itti_desc.message_number = 1;
737

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

740
#if !defined(RTAI)
741 742 743
    /* SR: disable signals module for RTAI (need to harmonize management
     * between softmodem and oaisim).
     */
744
    CHECK_INIT_RETURN(signal_init());
745
#endif
746

747
    /* Saves threads and messages max values */
748
    itti_desc.task_max = task_max;
749 750
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
751
    itti_desc.thread_handling_signals = -1;
752
    itti_desc.tasks_info = tasks_info;
753 754 755
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
756 757 758 759
    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));
760 761

    /* Initializing each queue and related stuff */
762
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
763
    {
764 765 766 767 768 769 770
        ITTI_DEBUG("Initializing %stask %s%s%s\n",
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ? "sub-" : "",
                   itti_desc.tasks_info[task_id].name,
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ? " with parent " : "",
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ?
                   itti_get_task_name(itti_desc.tasks_info[task_id].parent_task) : "");

771
#if defined(ENABLE_EVENT_FD)
772
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
773 774 775

        ret = lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size);
        if (ret < 0)
776
        {
777
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", task_id);
778 779 780
            DevAssert(0 == 1);
        }

781 782 783 784 785 786 787
# ifdef RTAI
        if (task_id == TASK_L2L1)
        {
            ret = rtf_sem_init(56, 0);
        }
# endif

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

795
        itti_desc.tasks[task_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
796 797
        if (itti_desc.tasks[task_id].task_event_fd == -1)
        {
798 799 800 801 802
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

803
        itti_desc.tasks[task_id].nb_events = 1;
804

805
        itti_desc.tasks[task_id].events = calloc(1, sizeof(struct epoll_event));
806

807
        itti_desc.tasks[task_id].events->events  = EPOLLIN | EPOLLERR;
808
        itti_desc.tasks[task_id].events->data.fd = itti_desc.tasks[task_id].task_event_fd;
809 810

        /* Add the event fd to the list of monitored events */
811 812
        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)
813
        {
814
            ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed: %s\n", strerror(errno));
815 816 817
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
818 819 820

        ITTI_DEBUG("Successfully subscribed fd %d for task %s\n",
                   itti_desc.tasks[task_id].task_event_fd, itti_get_task_name(task_id));
821
#else
822 823
        STAILQ_INIT (&itti_desc.tasks[task_id].message_queue);
        itti_desc.tasks[task_id].message_in_queue = 0;
824

825
        // Initialize mutexes
826
        pthread_mutex_init (&itti_desc.tasks[task_id].message_queue_mutex, NULL);
827

828
        // Initialize Cond vars
829
        pthread_cond_init (&itti_desc.tasks[task_id].message_queue_cond_var, NULL);
830
#endif
831
    }
832

833
    /* Initializing each thread */
834
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++)
835
    {
836
        itti_desc.threads[thread_id].task_state = TASK_STATE_NOT_CONFIGURED;
837
    }
838

839
    itti_dump_init (messages_definition_xml, dump_file_name);
840

841 842 843
#ifndef RTAI
     CHECK_INIT_RETURN(timer_init ());
#endif
844 845 846 847

    return 0;
}

848 849
void itti_wait_tasks_end(void) {
    int end = 0;
850 851
    int thread_id;
    task_id_t task_id;
852 853 854
    int ready_tasks;
    int result;
    int retries = 10;
855 856 857 858 859 860 861 862

    itti_desc.thread_handling_signals = pthread_self ();

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

863 864 865
    do {
        ready_tasks = 0;

866 867
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
868
            /* Skip tasks which are not running */
869 870 871 872 873
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
874

875
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
876

877
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
878 879 880

                if (result == 0) {
                    /* Thread has terminated */
881
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
882 883 884 885 886 887 888 889 890
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
891
        }
892 893 894 895 896
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
897
    }
898 899

    itti_dump_exit();
900 901 902
}

void itti_send_terminate_message(task_id_t task_id) {
903 904
    MessageDef *terminate_message_p;

905
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
906

907
    itti_send_broadcast_message (terminate_message_p);
908
}