intertask_interface.c 37.5 KB
Newer Older
1
/*******************************************************************************
ghaddab's avatar
ghaddab committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
    OpenAirInterface 
    Copyright(c) 1999 - 2014 Eurecom

    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.


    OpenAirInterface is distributed in the hope that 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.

    You should have received a copy of the GNU General Public License
    along with OpenAirInterface.The full GNU General Public License is 
   included in this distribution in the file called "COPYING". If not, 
   see <http://www.gnu.org/licenses/>.

  Contact Information
  OpenAirInterface Admin: openair_admin@eurecom.fr
  OpenAirInterface Tech : openair_tech@eurecom.fr
  OpenAirInterface Dev  : openair4g-devel@eurecom.fr
  
ghaddab's avatar
ghaddab committed
26
  Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
27

28
 *******************************************************************************/
29

30
#define _GNU_SOURCE
31 32 33 34 35 36
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
37
#include <signal.h>
38

39 40
#include <sys/epoll.h>
#include <sys/eventfd.h>
41

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

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

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

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

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

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

67 68 69 70 71 72 73 74
#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

75 76 77 78 79 80 81 82 83 84
/* 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;
85

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    int epoll_nb_events;
146 147 148 149 150 151 152

#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;
153
#endif
154 155 156 157 158
} thread_desc_t;

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

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

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

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

172 173
    pthread_t thread_handling_signals;

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

177
    itti_lte_time_t lte_time;
178 179

    int running;
180 181 182 183

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

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

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

static itti_desc_t itti_desc;
198

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

203 204 205 206 207 208
#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);

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

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

    return ptr;
}

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

#if defined(OAI_EMU) || defined(RTAI)
227 228 229
    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);
230
#else
231
    free (ptr);
232
#endif
233 234

    return (result);
235 236
}

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

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

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

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

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

257
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
258
{
259 260 261 262 263 264 265 266
    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
267

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

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

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
#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

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

382 383 384
    return temp;
}

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

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

winckel's avatar
winckel committed
399
#if defined(OAI_EMU) || defined(RTAI)
400 401
    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
402 403
#endif

404
    AssertFatal (message != NULL, "Message is NULL!\n");
405
    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);
406

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

415 416
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

417
    priority = itti_get_message_priority (message_id);
418

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

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

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

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

433 434
        if (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_ENDED)
        {
435
            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",
436 437 438 439 440 441 442 443 444 445
                       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 */
446
            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",
447
                         message_id, destination_thread_id, itti_desc.threads[destination_thread_id].task_state);
448

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

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

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

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

464
#ifdef RTAI
465 466 467 468 469 470
            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
471 472
#endif
            {
473 474 475 476
                /* 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;
477
                    eventfd_t sem_counter = 1;
478

479 480
                    /* 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
481 482
                    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));
483
                }
484
            }
485

486
            ITTI_DEBUG(ITTI_DEBUG_SEND, " Message %s, number %lu with priority %d successfully sent from %s to queue (%u:%s)\n",
487 488 489 490 491 492 493
                       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
494 495
    } else {
        /* This is a debug message to TASK_UNKNOWN, we can release safely release it */
496 497
        int result = itti_free(origin_task_id, message);
        AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
498
    }
499

500
#if defined(OAI_EMU) || defined(RTAI)
501 502
    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)));
503 504
#endif

505 506 507
    return 0;
}

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

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

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

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

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

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

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

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

543 544
    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);
545

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

555 556 557 558
    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));
559 560 561 562
}

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

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

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

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

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

580 581
    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");
582

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

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

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

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

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

614
    for (i = 0; i < epoll_ret; i++) {
615
        /* Check if there is an event for ITTI for the event fd */
616 617
        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))
618
        {
619
            struct message_list_s *message = NULL;
620 621 622
            eventfd_t   sem_counter;
            ssize_t     read_ret;
            int         result;
623 624

            /* Read will always return 1 */
625
            read_ret = read (itti_desc.threads[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
626
            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));
627

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

633
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
634
                /* No element in list -> this should not happen */
635
                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);
636
            }
637
            AssertFatal(message != NULL, "Message from message queue is NULL!\n");
638
            *received_msg = message->msg;
639 640 641
            result = itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
            AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);

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

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
651
#if defined(OAI_EMU) || defined(RTAI)
652 653
    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)));
654
#endif
655 656 657

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

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

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

winckel's avatar
winckel committed
674
#if defined(OAI_EMU) || defined(RTAI)
675 676
    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));
677
#endif
678 679
}

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

    *received_msg = NULL;

685
#if defined(OAI_EMU) || defined(RTAI)
686 687
    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));
688 689 690 691 692 693 694
#endif

    {
        struct message_list_s *message;

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

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

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

#if defined(OAI_EMU) || defined(RTAI)
708 709
    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)));
710
#endif
711 712
}

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

717 718 719
    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",
720
                 task_id, thread_id, itti_desc.threads[thread_id].task_state);
721

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

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

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

729 730
    itti_desc.created_tasks ++;

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

735 736 737
    return 0;
}

738 739 740 741 742 743 744 745 746 747 748
#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

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

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

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

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

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

766 767 768 769 770 771
    /* 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);

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

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

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

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

792
void itti_exit_task(void) {
793 794 795 796 797 798 799 800 801
#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
802 803 804
    pthread_exit (NULL);
}

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

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

    pthread_exit (NULL);
814 815
}

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

    while (itti_desc.running)
    {
824 825 826 827 828
        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
829 830 831 832 833 834 835 836 837 838 839 840

        /* 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;
841
                    eventfd_t sem_counter = pending_messages;
842 843 844 845 846 847 848

                    /* 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);
                }
            }
        }
849 850 851 852

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

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

864
    itti_desc.message_number = 1;
865

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

868
    CHECK_INIT_RETURN(signal_mask());
869

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

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

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

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

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

    /* 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;
907

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

914 915 916 917 918 919
# 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
920
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
921
# endif
922
        if (itti_desc.threads[thread_id].task_event_fd == -1)
923
        {
924
            /* Always assert on this condition */
925
            AssertFatal (0, " eventfd failed: %s!\n", strerror(errno));
926 927
        }

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

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

932 933
        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;
934 935

        /* Add the event fd to the list of monitored events */
936 937
        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)
938 939
        {
            /* Always assert on this condition */
940
            AssertFatal (0, " epoll_ctl (EPOLL_CTL_ADD) failed: %s!\n", strerror(errno));
941
        }
942

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

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

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

    rt_global_heap_open();
961
#endif
962

963
#if defined(OAI_EMU) || defined(RTAI)
964
    itti_desc.memory_pools_handle = memory_pools_create (5);
965 966
    memory_pools_add_pool (itti_desc.memory_pools_handle, 1000 + ITTI_QUEUE_MAX_ELEMENTS,       50);
    memory_pools_add_pool (itti_desc.memory_pools_handle, 1000 + (2 * ITTI_QUEUE_MAX_ELEMENTS), 100);
967
    memory_pools_add_pool (itti_desc.memory_pools_handle, 10000,                                1000);
968 969
    memory_pools_add_pool (itti_desc.memory_pools_handle,  400,                                 20050);
    memory_pools_add_pool (itti_desc.memory_pools_handle,  100,                                 30050);
970 971 972 973

    {
        char *statistics = memory_pools_statistics (itti_desc.memory_pools_handle);

974
        ITTI_DEBUG(ITTI_DEBUG_MP_STATISTICS, " Memory pools statistics:\n%s", statistics);