intertask_interface.c 36.7 KB
Newer Older
Cedric Roux's avatar
 
Cedric Roux committed
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
Cedric Roux's avatar
 
Cedric Roux committed
27

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

30
#define _GNU_SOURCE
Cedric Roux's avatar
 
Cedric Roux committed
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>
Cedric Roux's avatar
 
Cedric Roux committed
38

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

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

gauthier's avatar
gauthier committed
46 47 48 49
#if !defined(TRUE)
#define TRUE 1
#endif

50 51 52 53 54 55
#include "liblfds611.h"

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

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

61 62 63
/* Includes "intertask_interface_init.h" to check prototype coherence, but
 * disable threads and messages information generation.
 */
Cedric Roux's avatar
 
Cedric Roux committed
64 65 66 67
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

68
#include "signals.h"
Cedric Roux's avatar
 
Cedric Roux committed
69 70
#include "timer.h"

71 72 73 74 75 76 77 78
#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

79 80 81 82 83 84 85 86 87 88
/* 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;
Cedric Roux's avatar
 
Cedric Roux committed
89

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

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

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

Cedric Roux's avatar
 
Cedric Roux committed
106
typedef enum task_state_s {
107
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
Cedric Roux's avatar
 
Cedric Roux committed
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
Cedric Roux's avatar
 
Cedric Roux committed
113

114 115
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
116
} message_list_t;
Cedric Roux's avatar
 
Cedric Roux committed
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

135 136 137 138 139 140
    /* 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;
141 142

    int epoll_nb_events;
143

knopp's avatar
 
knopp committed
144
//#ifdef RTAI
145 146 147 148 149
    /* 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;
knopp's avatar
 
knopp committed
150
//#endif
151 152 153 154 155
} thread_desc_t;

typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
    struct lfds611_queue_state *message_queue;
Cedric Roux's avatar
 
Cedric Roux committed
156 157
} task_desc_t;

158
typedef struct itti_desc_s {
159
    thread_desc_t *threads;
160
    task_desc_t   *tasks;
161

Cedric Roux's avatar
 
Cedric Roux committed
162
    /* Current message number. Incremented every call to send_msg_to_task */
163
    message_number_t message_number __attribute__((aligned(8)));
Cedric Roux's avatar
 
Cedric Roux committed
164 165

    thread_id_t thread_max;
166
    task_id_t task_max;
Cedric Roux's avatar
 
Cedric Roux committed
167 168
    MessagesIds messages_id_max;

169 170
    boolean_t thread_handling_signals;
    pthread_t thread_ref;
171

172
    const task_info_t *tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
173 174
    const message_info_t *messages_info;

175
    itti_lte_time_t lte_time;
176 177

    int running;
178 179 180 181

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

#if defined(OAI_EMU) || defined(RTAI)
187 188
    memory_pools_handle_t memory_pools_handle;

189 190 191 192
    uint64_t vcd_poll_msg;
    uint64_t vcd_receive_msg;
    uint64_t vcd_send_msg;
#endif
193 194 195
} itti_desc_t;

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

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

201 202 203 204 205 206
#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);

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

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

    return ptr;
}

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

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

    return (result);
233 234
}

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

243
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
244
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
Cedric Roux's avatar
 
Cedric Roux committed
245 246 247 248

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

249
const char *itti_get_message_name(MessagesIds message_id) {
250
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
Cedric Roux's avatar
 
Cedric Roux committed
251 252 253 254

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

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

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

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

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

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

314
int itti_send_broadcast_message(MessageDef *message_p) {
315
    task_id_t destination_task_id;
316
    task_id_t origin_task_id;
317
    thread_id_t origin_thread_id;
318
    uint32_t thread_id;
Cedric Roux's avatar
 
Cedric Roux committed
319
    int ret = 0;
320
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
321

322
    AssertFatal (message_p != NULL, "Trying to broadcast a NULL message!\n");
Cedric Roux's avatar
 
Cedric Roux committed
323

324 325
    origin_task_id = message_p->ittiMsgHeader.originTaskId;
    origin_thread_id = TASK_GET_THREAD_ID(origin_task_id);
Cedric Roux's avatar
 
Cedric Roux committed
326

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

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

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

    return ret;
}

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

359
    AssertFatal (message_id < itti_desc.messages_id_max, "Message id (%d) is out of range (%d)!\n", message_id, itti_desc.messages_id_max);
Cedric Roux's avatar
 
Cedric Roux committed
360

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

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

371
    temp = itti_malloc (origin_task_id, TASK_UNKNOWN, sizeof(MessageHeader) + size);
Cedric Roux's avatar
 
Cedric Roux committed
372

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

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

Cedric Roux's avatar
 
Cedric Roux committed
381 382 383
    return temp;
}

384
MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id)
Cedric Roux's avatar
Cedric Roux committed
385 386 387 388
{
    return itti_alloc_new_message_sized(origin_task_id, message_id, itti_desc.messages_info[message_id].size);
}

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

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

403
    AssertFatal (message != NULL, "Message is NULL!\n");
winckel's avatar
winckel committed
404
    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);
Cedric Roux's avatar
 
Cedric Roux committed
405

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

414 415
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

416
    priority = itti_get_message_priority (message_id);
Cedric Roux's avatar
 
Cedric Roux committed
417

418 419
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
Cedric Roux's avatar
 
Cedric Roux committed
420

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

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

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

432 433
        if (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_ENDED)
        {
434
            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",
435 436 437 438 439 440 441 442 443 444
                       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 */
gauthier's avatar
gauthier committed
445 446 447 448 449 450 451
            AssertFatal (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_READY,
                    "Task %s Cannot send message %s (%d) to thread %d, it is not in ready state (%d)!\n",
                    itti_get_task_name(origin_task_id),
                    itti_desc.messages_info[message_id].name,
                    message_id,
                    destination_thread_id,
                    itti_desc.threads[destination_thread_id].task_state);
Cedric Roux's avatar
 
Cedric Roux committed
452

453
            /* Allocate new list element */
454
            new = (message_list_t *) itti_malloc (origin_task_id, destination_task_id, sizeof(struct message_list_s));
Cedric Roux's avatar
 
Cedric Roux committed
455

456 457 458 459
            /* Fill in members */
            new->msg = message;
            new->message_number = message_number;
            new->message_priority = priority;
Cedric Roux's avatar
 
Cedric Roux committed
460

461 462
            /* Enqueue message in destination task queue */
            lfds611_queue_enqueue(itti_desc.tasks[destination_task_id].message_queue, new);
463

464
#if defined(OAI_EMU) || defined(RTAI)
465
            vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
winckel's avatar
winckel committed
466 467
#endif

468
#ifdef RTAI
469 470 471 472 473 474
            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
475 476
#endif
            {
477 478 479 480
                /* 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;
Cedric Roux's avatar
Cedric Roux committed
481
                    eventfd_t sem_counter = 1;
482

483 484
                    /* 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
485 486
                    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));
487
                }
488
            }
Cedric Roux's avatar
 
Cedric Roux committed
489

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

504
#if defined(OAI_EMU) || defined(RTAI)
505 506
    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)));
507 508
#endif

Cedric Roux's avatar
 
Cedric Roux committed
509 510 511
    return 0;
}

512 513
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
514
    thread_id_t thread_id;
515 516
    struct epoll_event event;

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

519 520
    thread_id = TASK_GET_THREAD_ID(task_id);
    itti_desc.threads[thread_id].nb_events++;
521 522

    /* Reallocate the events */
523 524 525
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
526

527
    event.events  = EPOLLIN | EPOLLERR;
Cedric Roux's avatar
Cedric Roux committed
528 529
    event.data.u64 = 0;
    event.data.fd  = fd;
530 531

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

540
    ITTI_DEBUG(ITTI_DEBUG_EVEN_FD, " Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
541 542 543 544
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
545 546
    thread_id_t thread_id;

547 548
    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);
549

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

559 560 561 562
    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));
563 564 565 566
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
567 568
    thread_id_t thread_id;

winckel's avatar
winckel committed
569
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)\n", task_id, itti_desc.task_max);
570

571 572
    thread_id = TASK_GET_THREAD_ID(task_id);
    *events = itti_desc.threads[thread_id].events;
573

574
    return itti_desc.threads[thread_id].epoll_nb_events;
575 576
}

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

584 585
    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");
586

587
    thread_id = TASK_GET_THREAD_ID(task_id);
588 589 590 591 592 593 594 595
    *received_msg = NULL;

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

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

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

616
    itti_desc.threads[thread_id].epoll_nb_events = epoll_ret;
617

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

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

632

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
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
Cedric Roux's avatar
 
Cedric Roux committed
657

winckel's avatar
winckel committed
658
#if defined(OAI_EMU) || defined(RTAI)
659 660
    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));
661
#endif
Cedric Roux's avatar
 
Cedric Roux committed
662 663
}

664
void itti_poll_msg(task_id_t task_id, MessageDef **received_msg) {
665
    AssertFatal (task_id < itti_desc.task_max, "Task id (%d) is out of range (%d)!\n", task_id, itti_desc.task_max);
Cedric Roux's avatar
 
Cedric Roux committed
666 667 668

    *received_msg = NULL;

669
#if defined(OAI_EMU) || defined(RTAI)
670 671
    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));
672 673 674 675 676 677 678
#endif

    {
        struct message_list_s *message;

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

681
            *received_msg = message->msg;
682 683
            result = itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
            AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
684 685
        }
    }
Cedric Roux's avatar
 
Cedric Roux committed
686

687 688
    if (*received_msg == NULL) {
        ITTI_DEBUG(ITTI_DEBUG_POLL, " No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
689
    }
690 691

#if defined(OAI_EMU) || defined(RTAI)
692 693
    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)));
694
#endif
Cedric Roux's avatar
 
Cedric Roux committed
695 696
}

697
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
Cedric Roux's avatar
 
Cedric Roux committed
698
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
699
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
700

701 702 703
    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",
winckel's avatar
winckel committed
704
                 task_id, thread_id, itti_desc.threads[thread_id].task_state);
Cedric Roux's avatar
 
Cedric Roux committed
705

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

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

710
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
711
    AssertFatal (result >= 0, "Thread creation for task %d, thread %d failed (%d)!\n", task_id, thread_id, result);
Cedric Roux's avatar
 
Cedric Roux committed
712

713 714
    itti_desc.created_tasks ++;

Cedric Roux's avatar
 
Cedric Roux committed
715
    /* Wait till the thread is completely ready */
716
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
717 718
        usleep (1000);

Cedric Roux's avatar
 
Cedric Roux committed
719 720 721
    return 0;
}

knopp's avatar
 
knopp committed
722
//#ifdef RTAI 
723 724 725 726 727 728 729 730
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;
}
knopp's avatar
 
knopp committed
731
//#endif
732

733 734 735 736
void itti_wait_ready(int wait_tasks)
{
    itti_desc.wait_tasks = wait_tasks;

gauthier's avatar
gauthier committed
737 738 739 740 741
    ITTI_DEBUG(ITTI_DEBUG_INIT,
            " wait for tasks: %s, created tasks %d, ready tasks %d\n",
            itti_desc.wait_tasks ? "yes" : "no",
            itti_desc.created_tasks,
            itti_desc.ready_tasks);
742

743
    AssertFatal (itti_desc.created_tasks == itti_desc.ready_tasks, "Number of created tasks (%d) does not match ready tasks (%d), wait task %d!\n",
winckel's avatar
winckel committed
744
                 itti_desc.created_tasks, itti_desc.ready_tasks, itti_desc.wait_tasks);
745 746
}

747 748
void itti_mark_task_ready(task_id_t task_id)
{
Cedric Roux's avatar
 
Cedric Roux committed
749 750
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

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

753 754 755 756 757 758
    /* 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);

759 760 761 762 763 764 765 766 767
#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

768
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
769 770 771 772 773 774 775
    itti_desc.ready_tasks ++;

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

776
    ITTI_DEBUG(ITTI_DEBUG_INIT, " task %s started\n", itti_get_task_name(task_id));
777 778
}

779
void itti_exit_task(void) {
780 781 782 783 784 785 786 787 788
#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
789 790 791
    pthread_exit (NULL);
}

792
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
793
    // Sends Terminate signals to all tasks.
794 795
    itti_send_terminate_message (task_id);

796 797
    if (itti_desc.thread_handling_signals) {
        pthread_kill (itti_desc.thread_ref, SIGUSR1);
798 799 800
    }

    pthread_exit (NULL);
Cedric Roux's avatar
 
Cedric Roux committed
801 802
}

803 804 805 806 807 808 809 810
#ifdef RTAI
static void *itti_rt_relay_thread(void *arg)
{
    thread_id_t thread_id;
    unsigned pending_messages;

    while (itti_desc.running)
    {
811 812 813 814 815
        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
816 817 818 819 820 821 822 823 824 825 826 827

        /* 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;
Cedric Roux's avatar
Cedric Roux committed
828
                    eventfd_t sem_counter = pending_messages;
829 830 831 832 833 834 835

                    /* 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);
                }
            }
        }
836 837 838 839

#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_RELAY_THREAD, VCD_FUNCTION_OUT);
#endif
840 841 842 843 844
    }
    return NULL;
}
#endif

845
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
846
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
847 848
    task_id_t task_id;
    thread_id_t thread_id;