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

44 45
#include "assertions.h"

46 47 48
#include <sys/epoll.h>
#include <sys/eventfd.h>
#include "liblfds611.h"
49

50 51
#include "intertask_interface.h"
#include "intertask_interface_dump.h"
52

53 54 55 56
#if defined(OAI_EMU) || defined(RTAI)
# 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
const int itti_debug = 0;
const int itti_debug_poll = 0;
69

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

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

typedef enum task_state_s {
87
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
88 89 90
} task_state_t;

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

94 95
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
96
} message_list_t;
97

98 99 100
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
101

102 103
    /* State of the thread */
    volatile task_state_t task_state;
104 105 106 107

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

108
    /* The thread fd */
109 110 111 112 113 114 115 116 117 118 119
    int task_event_fd;

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

    /* Array of events monitored by the task.
     * By default only one fd is monitored (the one used to received messages
     * from other tasks).
     * More events can be suscribed later by the task itself.
     */
    struct epoll_event *events;
120 121

    int epoll_nb_events;
122 123 124 125 126 127 128

#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;
129
#endif
130 131 132 133 134
} thread_desc_t;

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

137
typedef struct itti_desc_s {
138
    thread_desc_t *threads;
139
    task_desc_t *tasks;
140

141
    /* Current message number. Incremented every call to send_msg_to_task */
142
    message_number_t message_number __attribute__((aligned(8)));
143 144

    thread_id_t thread_max;
145
    task_id_t task_max;
146 147
    MessagesIds messages_id_max;

148 149
    pthread_t thread_handling_signals;

150
    const task_info_t *tasks_info;
151 152
    const message_info_t *messages_info;

153
    itti_lte_time_t lte_time;
154 155 156 157 158

    int running;
#ifdef RTAI
    pthread_t rt_relay_thread;
#endif
159 160 161 162 163 164

#if defined(OAI_EMU) || defined(RTAI)
    uint64_t vcd_poll_msg;
    uint64_t vcd_receive_msg;
    uint64_t vcd_send_msg;
#endif
165 166 167
} itti_desc_t;

static itti_desc_t itti_desc;
168

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

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

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

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

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

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

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

196
static task_id_t itti_get_current_task_id(void)
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
{
    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;
}

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

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

227
    DevAssert(message_p != NULL);
228

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

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

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

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

    return ret;
}

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

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

263 264 265 266
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, size);
#endif

267 268 269 270 271 272
    if (origin_task_id == TASK_UNKNOWN)
    {
        /* Try to identify real origin task ID */
        origin_task_id = itti_get_current_task_id();
    }

273
    temp = malloc (sizeof(MessageHeader) + size);
274
    DevAssert(temp != NULL);
275

Cedric Roux's avatar
Cedric Roux committed
276 277 278
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
279

280 281 282 283
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, 0);
#endif

284 285 286
    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
287 288 289 290 291
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);
}

292
int itti_send_msg_to_task(task_id_t destination_task_id, instance_t instance, MessageDef *message)
Cedric Roux's avatar
Cedric Roux committed
293
{
294
    thread_id_t destination_thread_id;
295
    thread_id_t origin_task_id;
296
    message_list_t *new;
297 298 299
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
300

winckel's avatar
winckel committed
301
#if defined(OAI_EMU) || defined(RTAI)
302 303
    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
304 305
#endif

306
    DevAssert(message != NULL);
307
    DevCheck(destination_task_id < itti_desc.task_max, destination_task_id, itti_desc.task_max, 0);
308

309 310
    destination_thread_id = TASK_GET_THREAD_ID(destination_task_id);
    message->ittiMsgHeader.destinationTaskId = destination_task_id;
Cedric Roux's avatar
Cedric Roux committed
311 312 313 314
    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;
315 316
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

317 318
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

319
    priority = itti_get_message_priority (message_id);
320

321 322
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
323

324 325 326
/*
 *
 #ifdef RTAI
327 328 329 330
    if ((pthread_self() == itti_desc.threads[TASK_GET_THREAD_ID(origin_task_id)].task_thread) ||
        (task_id == TASK_UNKNOWN) ||
        ((TASK_GET_PARENT_TASK_ID(origin_task_id) != TASK_UNKNOWN) &&
        (pthread_self() == itti_desc.threads[TASK_GET_PARENT_TASK_ID(origin_task_id)].task_thread)))
331
#endif
332 333 334 335 336
*/
    itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
                             sizeof(MessageHeader) + message->ittiMsgHeader.ittiMsgSize);

    if (destination_task_id != TASK_UNKNOWN)
337
    {
338
#if defined(OAI_EMU) || defined(RTAI)
winckel's avatar
winckel committed
339 340 341
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_IN);
#endif

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
        if (itti_desc.threads[destination_thread_id].task_state == TASK_STATE_ENDED)
        {
            ITTI_DEBUG("Message %s, number %lu with priority %d can not be sent from %s to queue (%u:%s), ended destination task!\n",
                       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 */
            DevCheck(itti_desc.threads[destination_thread_id].task_state == TASK_STATE_READY, destination_thread_id,
                     itti_desc.threads[destination_thread_id].task_state, message_id);
357

358 359 360
            /* Allocate new list element */
            new = (message_list_t *) malloc (sizeof(struct message_list_s));
            DevAssert(new != NULL);
361

362 363 364 365
            /* Fill in members */
            new->msg = message;
            new->message_number = message_number;
            new->message_priority = priority;
366

367 368
            /* Enqueue message in destination task queue */
            lfds611_queue_enqueue(itti_desc.tasks[destination_task_id].message_queue, new);
369

370
#if defined(OAI_EMU) || defined(RTAI)
371
            vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
winckel's avatar
winckel committed
372 373
#endif

374
#ifdef RTAI
375 376 377 378 379 380
            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
381 382
#endif
            {
383 384 385 386 387
                /* 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;
                    uint64_t sem_counter = 1;
388

389 390 391 392
                    /* 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));
                    DevCheck(write_ret == sizeof(sem_counter), write_ret, sem_counter, destination_thread_id);
                }
393
            }
394

395 396 397 398 399 400 401 402
            ITTI_DEBUG("Message %s, number %lu with priority %d successfully sent from %s to queue (%u:%s)\n",
                       itti_desc.messages_info[message_id].name,
                       message_number,
                       priority,
                       itti_get_task_name(origin_task_id),
                       destination_task_id,
                       itti_get_task_name(destination_task_id));
        }
403
    }
404

405
#if defined(OAI_EMU) || defined(RTAI)
406 407
    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)));
408 409
#endif

410 411 412
    return 0;
}

413 414
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
415
    thread_id_t thread_id;
416 417
    struct epoll_event event;

418
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
419 420
    DevCheck(fd >= 0, fd, 0, 0);

421 422
    thread_id = TASK_GET_THREAD_ID(task_id);
    itti_desc.threads[thread_id].nb_events++;
423 424

    /* Reallocate the events */
425 426 427
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
428

429
    event.events  = EPOLLIN | EPOLLERR;
430 431 432
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
433
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_ADD, fd,
434 435 436 437 438 439 440
        &event) != 0)
    {
        ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed for task %s, fd %d: %s\n",
                   itti_get_task_name(task_id), fd, strerror(errno));
        /* Always assert on this condition */
        DevAssert(0 == 1);
    }
441 442

    ITTI_DEBUG("Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
443 444 445 446
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
447 448
    thread_id_t thread_id;

449
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
450 451
    DevCheck(fd >= 0, fd, 0, 0);

452
    thread_id = TASK_GET_THREAD_ID(task_id);
453
    /* Add the event fd to the list of monitored events */
454
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
455 456 457 458 459 460 461
    {
        ITTI_ERROR("epoll_ctl (EPOLL_CTL_DEL) failed for task %s and fd %d: %s\n",
                   itti_get_task_name(task_id), fd, strerror(errno));
        /* Always assert on this condition */
        DevAssert(0 == 1);
    }

462 463 464 465
    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));
466 467 468 469
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
470 471
    thread_id_t thread_id;

472
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
473

474 475
    thread_id = TASK_GET_THREAD_ID(task_id);
    *events = itti_desc.threads[thread_id].events;
476

477
    return itti_desc.threads[thread_id].epoll_nb_events;
478 479
}

480 481
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
482
    thread_id_t thread_id;
483 484
    int epoll_ret = 0;
    int epoll_timeout = 0;
485
    int i;
486

487
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
488 489
    DevAssert(received_msg != NULL);

490
    thread_id = TASK_GET_THREAD_ID(task_id);
491 492 493 494 495 496 497 498 499 500 501 502 503
    *received_msg = NULL;

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

504
    do {
505 506 507
        epoll_ret = epoll_wait(itti_desc.threads[thread_id].epoll_fd,
                               itti_desc.threads[thread_id].events,
                               itti_desc.threads[thread_id].nb_events,
508 509
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
510 511 512

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
513
                   itti_get_task_name(task_id), strerror(errno));
514 515 516 517 518 519 520
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

521
    itti_desc.threads[thread_id].epoll_nb_events = epoll_ret;
522

523
    for (i = 0; i < epoll_ret; i++) {
524
        /* Check if there is an event for ITTI for the event fd */
525 526
        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))
527
        {
528 529
            struct message_list_s *message;
            uint64_t sem_counter;
530
            ssize_t  read_ret;
531 532

            /* Read will always return 1 */
533
            read_ret = read (itti_desc.threads[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
534
            DevCheck(read_ret == sizeof(sem_counter), read_ret, sizeof(sem_counter), 0);
535

536
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
537
                /* No element in list -> this should not happen */
538
                DevParam(task_id, epoll_ret, 0);
539 540
            }
            *received_msg = message->msg;
541
            free (message);
542
            return;
543 544 545 546 547 548
        }
    }
}

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
549
#if defined(OAI_EMU) || defined(RTAI)
550 551
    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)));
552
#endif
553
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
554

winckel's avatar
winckel committed
555
#if defined(OAI_EMU) || defined(RTAI)
556 557
    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));
558
#endif
559 560
}

561 562
void itti_poll_msg(task_id_t task_id, MessageDef **received_msg) {
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
563
    DevAssert(received_msg != NULL);
564 565 566

    *received_msg = NULL;

567
#if defined(OAI_EMU) || defined(RTAI)
568 569
    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));
570 571 572 573 574 575 576 577 578 579 580
#endif

    {
        struct message_list_s *message;

        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 1)
        {
            *received_msg = message->msg;
            free (message);
        }
    }
581

582
    if ((itti_debug_poll) && (*received_msg == NULL)) {
583
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
584
    }
585 586

#if defined(OAI_EMU) || defined(RTAI)
587 588
    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)));
589
#endif
590 591
}

592
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
593
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
594
    int result;
595 596

    DevAssert(start_routine != NULL);
597
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
598 599
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
600

601
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
602

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

605
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
606
    DevCheck(result >= 0, task_id, thread_id, result);
607 608

    /* Wait till the thread is completely ready */
609
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
610
        ;
611 612 613
    return 0;
}

614 615 616 617 618 619 620 621 622 623 624
#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

625 626
void itti_mark_task_ready(task_id_t task_id)
{
627 628
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

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

631 632 633 634 635 636 637 638 639
#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

640 641 642
    /* Register the thread in itti dump */
    itti_dump_thread_use_ring_buffer();

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

646
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
647 648
}

649
void itti_exit_task(void) {
650 651 652 653 654 655 656 657 658
#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
659 660 661
    pthread_exit (NULL);
}

662
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
663
    // Sends Terminate signals to all tasks.
664 665 666 667 668 669 670
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
671 672
}

673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
#ifdef RTAI
static void *itti_rt_relay_thread(void *arg)
{
    thread_id_t thread_id;
    unsigned pending_messages;

    while (itti_desc.running)
    {
        usleep (100);

        /* 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;
                    uint64_t sem_counter = pending_messages;

                    /* 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);
                }
            }
        }
    }
    return NULL;
}
#endif

707
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
708
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
709 710
    task_id_t task_id;
    thread_id_t thread_id;
711 712
    int ret;

713
    itti_desc.message_number = 1;
714

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

717
    CHECK_INIT_RETURN(signal_mask());
718

719
    /* Saves threads and messages max values */
720
    itti_desc.task_max = task_max;
721 722
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
723
    itti_desc.thread_handling_signals = -1;
724
    itti_desc.tasks_info = tasks_info;
725 726 727
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
728 729 730 731
    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));
732 733

    /* Initializing each queue and related stuff */
734
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
735
    {
736 737 738 739 740 741 742
        ITTI_DEBUG("Initializing %stask %s%s%s\n",
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ? "sub-" : "",
                   itti_desc.tasks_info[task_id].name,
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ? " with parent " : "",
                   itti_desc.tasks_info[task_id].parent_task != TASK_UNKNOWN ?
                   itti_get_task_name(itti_desc.tasks_info[task_id].parent_task) : "");

743
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
744 745 746

        ret = lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size);
        if (ret < 0)
747
        {
748
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", task_id);
749 750 751
            DevAssert(0 == 1);
        }

752 753 754 755 756 757
# ifdef RTAI
        if (task_id == TASK_L2L1)
        {
            ret = rtf_sem_init(56, 0);
        }
# endif
758 759 760 761 762 763
    }

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

765 766
        itti_desc.threads[thread_id].epoll_fd = epoll_create1(0);
        if (itti_desc.threads[thread_id].epoll_fd == -1) {
767 768 769 770 771
            ITTI_ERROR("Failed to create new epoll fd: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

772 773
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
        if (itti_desc.threads[thread_id].task_event_fd == -1)
774
        {
775 776 777 778 779
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

780
        itti_desc.threads[thread_id].nb_events = 1;
781

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

784 785
        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;
786 787

        /* Add the event fd to the list of monitored events */
788 789
        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)
790
        {
791
            ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed: %s\n", strerror(errno));
792 793 794
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
795 796

        ITTI_DEBUG("Successfully subscribed fd %d for task %s\n",
797
                   itti_desc.threads[thread_id].task_event_fd, itti_get_task_name(task_id));
798

799 800 801
#ifdef RTAI
        itti_desc.threads[thread_id].real_time = FALSE;
        itti_desc.threads[thread_id].messages_pending = 0;
802
#endif
803
    }
804

805
    itti_desc.running = 1;
806 807 808 809
#ifdef RTAI
    /* Start RT relay thread */
    DevAssert(pthread_create (&itti_desc.rt_relay_thread, NULL, itti_rt_relay_thread, NULL) >= 0);
#endif
810

811 812 813 814 815 816
#if defined(OAI_EMU) || defined(RTAI)
    itti_desc.vcd_poll_msg = 0;
    itti_desc.vcd_receive_msg = 0;
    itti_desc.vcd_send_msg = 0;
#endif

817
    itti_dump_init (messages_definition_xml, dump_file_name);
818

819
    CHECK_INIT_RETURN(timer_init ());
820 821 822 823

    return 0;
}

824 825
void itti_wait_tasks_end(void) {
    int end = 0;
826 827
    int thread_id;
    task_id_t task_id;
828 829 830
    int ready_tasks;
    int result;
    int retries = 10;
831 832 833 834 835 836 837 838

    itti_desc.thread_handling_signals = pthread_self ();

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

839 840 841
    do {
        ready_tasks = 0;

842 843
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
844
            /* Skip tasks which are not running */
845 846 847 848 849
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
850

851
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
852

853
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
854 855 856

                if (result == 0) {
                    /* Thread has terminated */
857
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
858 859 860 861 862 863 864 865 866
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
867
        }
868 869
    } while ((ready_tasks > 0) && (retries--));

870
    itti_desc.running = 0;
871

872 873 874
    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
875
    }
876 877

    itti_dump_exit();
878 879 880
}

void itti_send_terminate_message(task_id_t task_id) {
881 882
    MessageDef *terminate_message_p;

883
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
884

885
    itti_send_broadcast_message (terminate_message_p);
886
}