intertask_interface.c 37.4 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
#include <sys/epoll.h>
#include <sys/eventfd.h>
42

43 44 45 46
#ifdef RTAI
# include <rtai_shm.h>
#endif

47 48 49 50 51 52
#include "liblfds611.h"

#include "assertions.h"
#include "intertask_interface.h"
#include "intertask_interface_dump.h"

53
#if defined(OAI_EMU) || defined(RTAI)
54
# include "memory_pools.h"
55 56 57
# include "vcd_signal_dumper.h"
#endif

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

65
#include "signals.h"
66 67
#include "timer.h"

68 69 70 71 72 73 74 75
#ifdef RTAI
# include <rtai.h>
# include <rtai_fifos.h>
#    define FIFO_PRINTF_MAX_STRING_SIZE 1000
#    define FIFO_PRINTF_NO              62
#    define FIFO_PRINTF_SIZE            65536
#endif

76 77 78 79 80 81 82 83 84 85
/* ITTI DEBUG groups */
#define ITTI_DEBUG_POLL             (1<<0)
#define ITTI_DEBUG_SEND             (1<<1)
#define ITTI_DEBUG_EVEN_FD          (1<<2)
#define ITTI_DEBUG_INIT             (1<<3)
#define ITTI_DEBUG_EXIT             (1<<4)
#define ITTI_DEBUG_ISSUES           (1<<5)
#define ITTI_DEBUG_MP_STATISTICS    (1<<6)

const int itti_debug = ITTI_DEBUG_ISSUES | ITTI_DEBUG_MP_STATISTICS;
86

87 88
/* Don't flush if using RTAI */
#ifdef RTAI
89
# define ITTI_DEBUG(m, x, args...)  do { if ((m) & itti_debug) rt_log_debug (x, ##args); } while(0);
90
#else
91
# define ITTI_DEBUG(m, x, args...)  do { if ((m) & itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); fflush (stdout); } while(0);
92
#endif
93
#define ITTI_ERROR(x, args...) 	    do { fprintf(stdout, "[ITTI][E]"x, ##args); fflush (stdout); } while(0);
94 95 96 97

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

98
#ifndef EFD_SEMAPHORE
99 100 101
# define KERNEL_VERSION_PRE_2_6_30 1
#endif

102 103 104 105 106
#ifdef RTAI
# define ITTI_MEM_PAGE_SIZE (1024)
# define ITTI_MEM_SIZE      (16 * 1024 * 1024)
#endif

107
typedef enum task_state_s {
108
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
109 110 111
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
112
typedef struct message_list_s {
113
    MessageDef *msg; ///< Pointer to the message
114

115 116
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
117
} message_list_t;
118

119 120 121
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
122

123 124
    /* State of the thread */
    volatile task_state_t task_state;
125 126 127 128

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

129
    /* The thread fd */
130 131 132 133 134
    int task_event_fd;

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

135
#if defined(KERNEL_VERSION_PRE_2_6_30)
136
    eventfd_t sem_counter;
137 138
#endif

139 140 141 142 143 144
    /* 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;
145 146

    int epoll_nb_events;
147 148 149 150 151 152 153

#ifdef RTAI
    /* Flag to mark real time thread */
    unsigned real_time;

    /* Counter to indicate from RTAI threads that messages are pending for the thread */
    unsigned messages_pending;
154
#endif
155 156 157 158 159
} thread_desc_t;

typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
    struct lfds611_queue_state *message_queue;
160 161
} task_desc_t;

162
typedef struct itti_desc_s {
163
    thread_desc_t *threads;
164
    task_desc_t   *tasks;
165

166
    /* Current message number. Incremented every call to send_msg_to_task */
167
    message_number_t message_number __attribute__((aligned(8)));
168 169

    thread_id_t thread_max;
170
    task_id_t task_max;
171 172
    MessagesIds messages_id_max;

173 174
    pthread_t thread_handling_signals;

175
    const task_info_t *tasks_info;
176 177
    const message_info_t *messages_info;

178
    itti_lte_time_t lte_time;
179 180

    int running;
181 182 183 184

    volatile uint32_t created_tasks;
    volatile uint32_t ready_tasks;
    volatile int      wait_tasks;
185 186 187
#ifdef RTAI
    pthread_t rt_relay_thread;
#endif
188 189

#if defined(OAI_EMU) || defined(RTAI)
190 191
    memory_pools_handle_t memory_pools_handle;

192 193 194 195
    uint64_t vcd_poll_msg;
    uint64_t vcd_receive_msg;
    uint64_t vcd_send_msg;
#endif
196 197 198
} itti_desc_t;

static itti_desc_t itti_desc;
199

200
void *itti_malloc(task_id_t origin_task_id, task_id_t destination_task_id, ssize_t size)
201 202 203
{
    void *ptr = NULL;

204 205 206 207 208 209
#if defined(OAI_EMU) || defined(RTAI)
    ptr = memory_pools_allocate (itti_desc.memory_pools_handle, size, origin_task_id, destination_task_id);
    if (ptr == NULL)
    {
        char *statistics = memory_pools_statistics (itti_desc.memory_pools_handle);

210
        ITTI_ERROR (" Memory pools statistics:\n%s", statistics);
211 212
        free (statistics);
    }
winckel's avatar
winckel committed
213 214
#else
    ptr = malloc (size);
215
#endif
winckel's avatar
winckel committed
216

217
    AssertFatal (ptr != NULL, "Memory allocation of %d bytes failed (%d -> %d)!\n", (int) size, origin_task_id, destination_task_id);
218 219 220 221

    return ptr;
}

222
int itti_free(task_id_t task_id, void *ptr)
223
{
224 225
    int result = EXIT_SUCCESS;
    AssertFatal (ptr != NULL, "Trying to free a NULL pointer (%d)!\n", task_id);
226 227

#if defined(OAI_EMU) || defined(RTAI)
228 229 230
    result = memory_pools_free (itti_desc.memory_pools_handle, ptr, task_id);

    AssertError (result == EXIT_SUCCESS, {}, "Failed to free memory at %p (%d)!\n", ptr, task_id);
231
#else
232
    free (ptr);
233
#endif
234 235

    return (result);
236 237
}

238
static inline message_number_t itti_increment_message_number(void) {
239 240 241 242
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
243
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
244 245
}

246
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
247
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
248 249 250 251

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

252
const char *itti_get_message_name(MessagesIds message_id) {
253
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
254 255 256 257

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

258
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
259
{
260 261 262 263 264 265 266 267
    if (itti_desc.task_max > 0)
    {
        AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
    }
    else
    {
        return ("ITTI NOT INITIALIZED !!!");
    }
Cedric Roux's avatar
Cedric Roux committed
268

269
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
270 271
}

272
static task_id_t itti_get_current_task_id(void)
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
{
    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;
}

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
#ifdef RTAI
static void rt_log_debug(char *format, ...)
{
    task_id_t   task_id;
    va_list     args;
    char        log_buffer[FIFO_PRINTF_MAX_STRING_SIZE];
    int         len;

    task_id = itti_get_current_task_id ();
    len = snprintf(log_buffer, FIFO_PRINTF_MAX_STRING_SIZE-1, "[ITTI][D][%s]", itti_get_task_name(task_id));
    va_start(args, format);
    len += vsnprintf(&log_buffer[len], FIFO_PRINTF_MAX_STRING_SIZE-1-len, format, args);
    va_end (args);

    if (task_id != TASK_UNKNOWN)
        fwrite(log_buffer, len, 1, stdout);
    else
        rtf_put (FIFO_PRINTF_NO, log_buffer, len);
}
#endif

311 312 313 314 315 316
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

317
int itti_send_broadcast_message(MessageDef *message_p) {
318
    task_id_t destination_task_id;
319
    task_id_t origin_task_id;
320
    thread_id_t origin_thread_id;
321
    uint32_t thread_id;
322
    int ret = 0;
323
    int result;
324

325
    AssertFatal (message_p != NULL, "Trying to broadcast a NULL message!\n");
326

327 328
    origin_task_id = message_p->ittiMsgHeader.originTaskId;
    origin_thread_id = TASK_GET_THREAD_ID(origin_task_id);
329

330 331
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
332 333
        MessageDef *new_message_p;

334 335 336 337
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
338
        /* Skip task that broadcast the message */
339
        if (thread_id != origin_thread_id) {
340
            /* Skip tasks which are not running */
341
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
342
                new_message_p = itti_malloc (origin_task_id, destination_task_id, sizeof(MessageDef));
343
                AssertFatal (new_message_p != NULL, "New message allocation failed!\n");
344 345

                memcpy (new_message_p, message_p, sizeof(MessageDef));
346
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
347
                AssertFatal (result >= 0, "Failed to send message %d to thread %d (task %d)!\n", message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
348
            }
349 350
        }
    }
351 352
    result = itti_free (ITTI_MSG_ORIGIN_ID(message_p), message_p);
    AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
353 354 355 356

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
357 358
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
359 360
    MessageDef *temp = NULL;

361
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
362

363 364 365 366
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, size);
#endif

367 368 369 370 371 372
    if (origin_task_id == TASK_UNKNOWN)
    {
        /* Try to identify real origin task ID */
        origin_task_id = itti_get_current_task_id();
    }

373
    temp = itti_malloc (origin_task_id, TASK_UNKNOWN, sizeof(MessageHeader) + size);
374

Cedric Roux's avatar
Cedric Roux committed
375 376 377
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
378

379 380 381 382
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, 0);
#endif

383 384 385
    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
386 387 388 389 390
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);
}

391
int itti_send_msg_to_task(task_id_t destination_task_id, instance_t instance, MessageDef *message)
Cedric Roux's avatar
Cedric Roux committed
392
{
393
    thread_id_t destination_thread_id;
394
    thread_id_t origin_task_id;
395
    message_list_t *new;
396 397 398
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
399

winckel's avatar
winckel committed
400
#if defined(OAI_EMU) || defined(RTAI)
401 402
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_SEND_MSG,
                                            __sync_or_and_fetch (&itti_desc.vcd_send_msg, 1L << destination_task_id));
winckel's avatar
winckel committed
403 404
#endif

405
    AssertFatal (message != NULL, "Message is NULL!\n");
406
    AssertFatal (destination_task_id < itti_desc.task_max, "Destination task id (%d) is out of range (%d)\n", destination_task_id, itti_desc.task_max);
407

408 409
    destination_thread_id = TASK_GET_THREAD_ID(destination_task_id);
    message->ittiMsgHeader.destinationTaskId = destination_task_id;
Cedric Roux's avatar
Cedric Roux committed
410 411 412 413
    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;
414
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
415

416 417
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

418
    priority = itti_get_message_priority (message_id);
419

420 421
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
422

423
    itti_dump_queue_message (origin_task_id, message_number, message, itti_desc.messages_info[message_id].name,
424 425 426
                             sizeof(MessageHeader) + message->ittiMsgHeader.ittiMsgSize);

    if (destination_task_id != TASK_UNKNOWN)
427
    {
428
#if defined(OAI_EMU) || defined(RTAI)
winckel's avatar
winckel committed
429
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_IN);
430 431

        memory_pools_set_info (itti_desc.memory_pools_handle, message, 1, destination_task_id);
winckel's avatar
winckel committed
432 433
#endif

434 435
        if (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_ENDED)
        {
436
            ITTI_DEBUG(ITTI_DEBUG_ISSUES, " Message %s, number %lu with priority %d can not be sent from %s to queue (%u:%s), ended destination task!\n",
437 438 439 440 441 442 443 444 445 446
                       itti_desc.messages_info[message_id].name,
                       message_number,
                       priority,
                       itti_get_task_name(origin_task_id),
                       destination_task_id,
                       itti_get_task_name(destination_task_id));
        }
        else
        {
            /* We cannot send a message if the task is not running */
447
            AssertFatal (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_READY, "Cannot send message %d to thread %d, it is not in ready state (%d)!\n",
448
                         message_id, destination_thread_id, itti_desc.threads[destination_thread_id].task_state);
449

450
            /* Allocate new list element */
451
            new = (message_list_t *) itti_malloc (origin_task_id, destination_task_id, sizeof(struct message_list_s));
452

453 454 455 456
            /* Fill in members */
            new->msg = message;
            new->message_number = message_number;
            new->message_priority = priority;
457

458 459
            /* Enqueue message in destination task queue */
            lfds611_queue_enqueue(itti_desc.tasks[destination_task_id].message_queue, new);
460

461
#if defined(OAI_EMU) || defined(RTAI)
462
            vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
winckel's avatar
winckel committed
463 464
#endif

465
#ifdef RTAI
466 467 468 469 470 471
            if (itti_desc.threads[TASK_GET_THREAD_ID(origin_task_id)].real_time)
            {
                /* This is a RT task, increase destination task messages pending counter */
                __sync_fetch_and_add (&itti_desc.threads[destination_thread_id].messages_pending, 1);
            }
            else
472 473
#endif
            {
474 475 476 477
                /* Only use event fd for tasks, subtasks will pool the queue */
                if (TASK_GET_PARENT_TASK_ID(destination_task_id) == TASK_UNKNOWN)
                {
                    ssize_t write_ret;
478
                    eventfd_t sem_counter = 1;
479

480 481
                    /* Call to write for an event fd must be of 8 bytes */
                    write_ret = write (itti_desc.threads[destination_thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
winckel's avatar
winckel committed
482 483
                    AssertFatal (write_ret == sizeof(sem_counter), "Write to task message FD (%d) failed (%d/%d)\n",
                                 destination_thread_id, (int) write_ret, (int) sizeof(sem_counter));
484
                }
485
            }
486

487
            ITTI_DEBUG(ITTI_DEBUG_SEND, " Message %s, number %lu with priority %d successfully sent from %s to queue (%u:%s)\n",
488 489 490 491 492 493 494
                       itti_desc.messages_info[message_id].name,
                       message_number,
                       priority,
                       itti_get_task_name(origin_task_id),
                       destination_task_id,
                       itti_get_task_name(destination_task_id));
        }
Cedric Roux's avatar
Cedric Roux committed
495 496
    } else {
        /* This is a debug message to TASK_UNKNOWN, we can release safely release it */
497 498
        int result = itti_free(origin_task_id, message);
        AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
499
    }
500

501
#if defined(OAI_EMU) || defined(RTAI)
502 503
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_SEND_MSG,
                                            __sync_and_and_fetch (&itti_desc.vcd_send_msg, ~(1L << destination_task_id)));
504 505
#endif

506 507 508
    return 0;
}

509 510
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
511
    thread_id_t thread_id;
512 513
    struct epoll_event event;

514
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
515

516 517
    thread_id = TASK_GET_THREAD_ID(task_id);
    itti_desc.threads[thread_id].nb_events++;
518 519

    /* Reallocate the events */
520 521 522
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
523

524
    event.events  = EPOLLIN | EPOLLERR;
Cedric Roux's avatar
Cedric Roux committed
525 526
    event.data.u64 = 0;
    event.data.fd  = fd;
527 528

    /* Add the event fd to the list of monitored events */
529
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_ADD, fd,
530 531 532
        &event) != 0)
    {
        /* Always assert on this condition */
533
        AssertFatal (0, "epoll_ctl (EPOLL_CTL_ADD) failed for task %s, fd %d: %s!\n",
534
                     itti_get_task_name(task_id), fd, strerror(errno));
535
    }
536

537
    ITTI_DEBUG(ITTI_DEBUG_EVEN_FD, " Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
538 539 540 541
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
542 543
    thread_id_t thread_id;

544 545
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
    AssertFatal (fd >= 0, "File descriptor (%d) is invalid!\n", fd);
546

547
    thread_id = TASK_GET_THREAD_ID(task_id);
548
    /* Add the event fd to the list of monitored events */
549
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
550 551
    {
        /* Always assert on this condition */
552
        AssertFatal (0, "epoll_ctl (EPOLL_CTL_DEL) failed for task %s, fd %d: %s!\n",
553
                     itti_get_task_name(task_id), fd, strerror(errno));
554 555
    }

556 557 558 559
    itti_desc.threads[thread_id].nb_events--;
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
560 561 562 563
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
564 565
    thread_id_t thread_id;

566
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)\n", task_id, itti_desc.task_max);
567

568 569
    thread_id = TASK_GET_THREAD_ID(task_id);
    *events = itti_desc.threads[thread_id].events;
570

571
    return itti_desc.threads[thread_id].epoll_nb_events;
572 573
}

574 575
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
576
    thread_id_t thread_id;
577 578
    int epoll_ret = 0;
    int epoll_timeout = 0;
579
    int i;
580

581 582
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
    AssertFatal (received_msg != NULL, "Received message is NULL!\n");
583

584
    thread_id = TASK_GET_THREAD_ID(task_id);
585 586 587 588 589 590 591 592
    *received_msg = NULL;

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

598
    do {
599 600 601
        epoll_ret = epoll_wait(itti_desc.threads[thread_id].epoll_fd,
                               itti_desc.threads[thread_id].events,
                               itti_desc.threads[thread_id].nb_events,
602 603
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
604 605

    if (epoll_ret < 0) {
606
        AssertFatal (0, "epoll_wait failed for task %s: %s!\n", itti_get_task_name(task_id), strerror(errno));
607 608 609 610 611 612
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

613
    itti_desc.threads[thread_id].epoll_nb_events = epoll_ret;
614

615
    for (i = 0; i < epoll_ret; i++) {
616
        /* Check if there is an event for ITTI for the event fd */
617 618
        if ((itti_desc.threads[thread_id].events[i].events & EPOLLIN) &&
            (itti_desc.threads[thread_id].events[i].data.fd == itti_desc.threads[thread_id].task_event_fd))
619
        {
620
            struct message_list_s *message = NULL;
621 622 623
            eventfd_t   sem_counter;
            ssize_t     read_ret;
            int         result;
624 625

            /* Read will always return 1 */
626
            read_ret = read (itti_desc.threads[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
627
            AssertFatal (read_ret == sizeof(sem_counter), "Read from task message FD (%d) failed (%d/%d)!\n", thread_id, (int) read_ret, (int) sizeof(sem_counter));
628

629 630
#if defined(KERNEL_VERSION_PRE_2_6_30)
            /* Store the value of the semaphore counter */
631
            itti_desc.threads[task_id].sem_counter = sem_counter - 1;
632 633
#endif

634
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
635
                /* No element in list -> this should not happen */
636
                AssertFatal (0, "No message in queue for task %d while there are %d events and some for the messages queue!\n", task_id, epoll_ret);
637
            }
638
            AssertFatal(message != NULL, "Message from message queue is NULL!\n");
639
            *received_msg = message->msg;
640 641 642
            result = itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
            AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);

643 644
            /* Mark that the event has been processed */
            itti_desc.threads[thread_id].events[i].events &= ~EPOLLIN;
645
            return;
646 647 648 649 650 651
        }
    }
}

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
652
#if defined(OAI_EMU) || defined(RTAI)
653 654
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_RECV_MSG,
                                            __sync_and_and_fetch (&itti_desc.vcd_receive_msg, ~(1L << task_id)));
655
#endif
656 657 658

#if defined(KERNEL_VERSION_PRE_2_6_30)
    /* Store the value of the semaphore counter */
659 660 661
    if (itti_desc.threads[task_id].sem_counter > 0) {
        struct message_list_s *message = NULL;

662 663
        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
            /* No element in list -> this should not happen */
664
            DevParam(task_id, itti_desc.threads[task_id].sem_counter, 0);
665 666 667
        }
        DevAssert(message != NULL);
        *received_msg = message->msg;
668
        itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
669

670
        itti_desc.threads[task_id].sem_counter--;
671 672
    } else
#endif
673
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
674

winckel's avatar
winckel committed
675
#if defined(OAI_EMU) || defined(RTAI)
676 677
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_RECV_MSG,
                                            __sync_or_and_fetch (&itti_desc.vcd_receive_msg, 1L << task_id));
678
#endif
679 680
}

681
void itti_poll_msg(task_id_t task_id, MessageDef **received_msg) {
682
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
683 684 685

    *received_msg = NULL;

686
#if defined(OAI_EMU) || defined(RTAI)
687 688
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_POLL_MSG,
                                            __sync_or_and_fetch (&itti_desc.vcd_poll_msg, 1L << task_id));
689 690 691 692 693 694 695
#endif

    {
        struct message_list_s *message;

        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 1)
        {
696 697
            int result;

698
            *received_msg = message->msg;
699 700
            result = itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
            AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
701 702
        }
    }
703

704 705
    if (*received_msg == NULL) {
        ITTI_DEBUG(ITTI_DEBUG_POLL, " No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
706
    }
707 708

#if defined(OAI_EMU) || defined(RTAI)
709 710
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_POLL_MSG,
                                            __sync_and_and_fetch (&itti_desc.vcd_poll_msg, ~(1L << task_id)));
711
#endif
712 713
}

714
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
715
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
716
    int result;
717

718 719 720
    AssertFatal (start_routine != NULL, "Start routine is NULL!\n");
    AssertFatal (thread_id < itti_desc.thread_max, "Thread id (%d) is out of range (%d)!\n", thread_id, itti_desc.thread_max);
    AssertFatal (itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, "Task %d, thread %d state is not correct (%d)!\n",
721
                 task_id, thread_id, itti_desc.threads[thread_id].task_state);
722

723
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
724

725
    ITTI_DEBUG(ITTI_DEBUG_INIT, " Creating thread for task %s ...\n", itti_get_task_name(task_id));
726

727
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
728
    AssertFatal (result >= 0, "Thread creation for task %d, thread %d failed (%d)!\n", task_id, thread_id, result);
729

730 731
    itti_desc.created_tasks ++;

732
    /* Wait till the thread is completely ready */
733
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
734 735
        usleep (1000);

736 737 738
    return 0;
}

739 740 741 742 743 744 745 746 747 748 749
#ifdef RTAI
void itti_set_task_real_time(task_id_t task_id)
{
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

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

    itti_desc.threads[thread_id].real_time = TRUE;
}
#endif

750 751 752 753
void itti_wait_ready(int wait_tasks)
{
    itti_desc.wait_tasks = wait_tasks;

754
    ITTI_DEBUG(ITTI_DEBUG_INIT, " wait for tasks: %s, created tasks %d, ready tasks %d\n", itti_desc.wait_tasks ? "yes" : "no",
755 756
        itti_desc.created_tasks, itti_desc.ready_tasks);

757
    AssertFatal (itti_desc.created_tasks == itti_desc.ready_tasks, "Number of created tasks (%d) does not match ready tasks (%d), wait task %d!\n",
758
                 itti_desc.created_tasks, itti_desc.ready_tasks, itti_desc.wait_tasks);
759 760
}

761 762
void itti_mark_task_ready(task_id_t task_id)
{
763 764
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

765
    AssertFatal (thread_id < itti_desc.thread_max, "Thread id (%d) is out of range (%d)!\n", thread_id, itti_desc.thread_max);
766

767 768 769 770 771 772
    /* Register the thread in itti dump */
    itti_dump_thread_use_ring_buffer();

    /* Mark the thread as using LFDS queue */
    lfds611_queue_use(itti_desc.tasks[task_id].message_queue);

773 774 775 776 777 778 779 780 781
#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

782
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
783 784 785 786 787 788 789
    itti_desc.ready_tasks ++;

    while (itti_desc.wait_tasks != 0)
    {
        usleep (10000);
    }

790
    ITTI_DEBUG(ITTI_DEBUG_INIT, " task %s started\n", itti_get_task_name(task_id));
791 792
}

793
void itti_exit_task(void) {
794 795 796 797 798 799 800 801 802
#if defined(OAI_EMU) || defined(RTAI)
    task_id_t task_id = itti_get_current_task_id();

    if (task_id > TASK_UNKNOWN)
    {
        vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_RECV_MSG,
                                                __sync_and_and_fetch (&itti_desc.vcd_receive_msg, ~(1L << task_id)));
    }
#endif
803 804 805
    pthread_exit (NULL);
}

806
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
807
    // Sends Terminate signals to all tasks.
808 809 810 811 812 813 814
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
815 816
}

817 818 819 820 821 822 823 824
#ifdef RTAI
static void *itti_rt_relay_thread(void *arg)
{
    thread_id_t thread_id;
    unsigned pending_messages;

    while (itti_desc.running)
    {
825 826 827 828 829
        usleep (200); // Poll for messages a little more than 2 time by slot to get a small latency between RT and other tasks

#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_RELAY_THREAD, VCD_FUNCTION_IN);
#endif
830 831 832 833 834 835 836 837 838 839 840 841

        /* Checks for all non real time tasks if they have pending messages */
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++)
        {
            if ((itti_desc.threads[thread_id].task_state == TASK_STATE_READY)
                    && (itti_desc.threads[thread_id].real_time == FALSE))
            {
                pending_messages = __sync_fetch_and_and (&itti_desc.threads[thread_id].messages_pending, 0);

                if (pending_messages > 0)
                {
                    ssize_t write_ret;
842
                    eventfd_t sem_counter = pending_messages;
843 844 845 846 847 848 849

                    /* Call to write for an event fd must be of 8 bytes */
                    write_ret = write (itti_desc.threads[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
                    DevCheck(write_ret == sizeof(sem_counter), write_ret, sem_counter, thread_id);
                }
            }
        }
850 851 852 853

#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_RELAY_THREAD, VCD_FUNCTION_OUT);
#endif
854 855 856 857 858
    }
    return NULL;
}
#endif

859
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
860
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
861 862
    task_id_t task_id;
    thread_id_t thread_id;
863 864
    int ret;

865
    itti_desc.message_number = 1;
866

867
    ITTI_DEBUG(ITTI_DEBUG_INIT, " Init: %d tasks, %d threads, %d messages\n", task_max, thread_max, messages_id_max);
868

869
    CHECK_INIT_RETURN(signal_mask());
870

871
    /* Saves threads and messages max values */
872
    itti_desc.task_max = task_max;
873 874
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
875
    itti_desc.thread_handling_signals = -1;
876
    itti_desc.tasks_info = tasks_info;
877 878 879
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
880 881 882 883
    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));
884 885

    /* Initializing each queue and related stuff */
886
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
887
    {
888
        ITTI_DEBUG(ITTI_DEBUG_INIT, " Initializing %stask %s%s%s\n",
889 890 891 892 893 894
                   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) : "");

895
        ITTI_DEBUG(ITTI_DEBUG_INIT, " Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
896 897 898

        ret = lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size);
        if (ret < 0)
899
        {
900
            AssertFatal (0, "lfds611_queue_new failed for task %s!\n", itti_get_task_name(task_id));
901
        }
902 903 904 905 906 907
    }

    /* Initializing each thread */
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++)
    {
        itti_desc.threads[thread_id].task_state = TASK_STATE_NOT_CONFIGURED;
908

909 910
        itti_desc.threads[thread_id].epoll_fd = epoll_create1(0);
        if (itti_desc.threads[thread_id].epoll_fd == -1) {
911
            /* Always assert on this condition */
912
            AssertFatal (0, "Failed to create new epoll fd: %s!\n", strerror(errno));
913 914
        }

915 916 917 918 919 920
# if defined(KERNEL_VERSION_PRE_2_6_30)
        /* SR: for kernel versions < 2.6.30 EFD_SEMAPHORE is not defined.
         * A read operation on the event fd will return the 8 byte value.
         */
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, 0);
# else
921
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
922
# endif
923
        if (itti_desc.threads[thread_id].task_event_fd == -1)
924
        {
925
            /* Always assert on this condition */
926
            AssertFatal (0, " eventfd failed: %s!\n", strerror(errno));
927 928
        }

929
        itti_desc.threads[thread_id].nb_events = 1;
930

931
        itti_desc.threads[thread_id].events = calloc(1, sizeof(struct epoll_event));
932

933 934
        itti_desc.threads[thread_id].events->events  = EPOLLIN | EPOLLERR;
        itti_desc.threads[thread_id].events->data.fd = itti_desc.threads[thread_id].task_event_fd;
935 936

        /* Add the event fd to the list of monitored events */
937 938
        if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_ADD,
            itti_desc.threads[thread_id].task_event_fd, itti_desc.threads[thread_id].events) != 0)
939 940
        {
            /* Always assert on this condition */
941
            AssertFatal (0, " epoll_ctl (EPOLL_CTL_ADD) failed: %s!\n", strerror(errno));
942
        }
943

944
        ITTI_DEBUG(ITTI_DEBUG_EVEN_FD, " Successfully subscribed fd %d for thread %d\n",
945
                   itti_desc.threads[thread_id].task_event_fd, thread_id);
946

947 948 949
#ifdef RTAI
        itti_desc.threads[thread_id].real_time = FALSE;
        itti_desc.threads[thread_id].messages_pending = 0;
950
#endif
951
    }
952

953
    itti_desc.running = 1;
954 955 956
    itti_desc.wait_tasks = 0;
    itti_desc.created_tasks = 0;
    itti_desc.ready_tasks = 0;
957 958 959
#ifdef RTAI
    /* Start RT relay thread */
    DevAssert(pthread_create (&itti_desc.rt_relay_thread, NULL, itti_rt_relay_thread, NULL) >= 0);
960 961

    rt_global_heap_open();
962
#endif
963

964
#if defined(OAI_EMU) || defined(RTAI)