intertask_interface.c 30.8 KB
Newer Older
1 2
/*******************************************************************************

3 4
 Eurecom OpenAirInterface
 Copyright(c) 1999 - 2012 Eurecom
5

6 7 8
 This program is free software; you can redistribute it and/or modify it
 under the terms and conditions of the GNU General Public License,
 version 2, as published by the Free Software Foundation.
9

10 11 12 13
 This program is distributed in the hope it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 more details.
14

15 16 17
 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18

19 20
 The full GNU General Public License is included in this distribution in
 the file called "COPYING".
21

22 23 24 25 26 27
 Contact Information
 Openair Admin: openair_admin@eurecom.fr
 Openair Tech : openair_tech@eurecom.fr
 Forums       : http://forums.eurecom.fr/openairinterface
 Address      : EURECOM, Campus SophiaTech, 450 Route des Chappes
 06410 Biot FRANCE
28

29
 *******************************************************************************/
30

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

#include "assertions.h"

42 43 44
#include <sys/epoll.h>
#include <sys/eventfd.h>
#include "liblfds611.h"
45

46 47
#include "intertask_interface.h"
#include "intertask_interface_dump.h"
48

49 50 51 52
#ifdef RTAI
# include <rtai_shm.h>
#endif

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

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

86
#ifndef EFD_SEMAPHORE
87 88 89
# define KERNEL_VERSION_PRE_2_6_30 1
#endif

90 91 92 93 94
#ifdef RTAI
# define ITTI_MEM_PAGE_SIZE (1024)
# define ITTI_MEM_SIZE      (16 * 1024 * 1024)
#endif

95
typedef enum task_state_s {
96
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
97 98 99
} task_state_t;

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

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

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

111 112
    /* State of the thread */
    volatile task_state_t task_state;
113 114 115 116

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

117
    /* The thread fd */
118 119 120 121 122
    int task_event_fd;

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

123
#if defined(KERNEL_VERSION_PRE_2_6_30)
124
    eventfd_t sem_counter;
125 126
#endif

127 128 129 130 131 132
    /* 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;
133 134

    int epoll_nb_events;
135 136 137 138 139 140 141

#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;
142
#endif
143 144 145 146 147
} thread_desc_t;

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

150
typedef struct itti_desc_s {
151
    thread_desc_t *threads;
152
    task_desc_t   *tasks;
153

154
    /* Current message number. Incremented every call to send_msg_to_task */
155
    message_number_t message_number __attribute__((aligned(8)));
156 157

    thread_id_t thread_max;
158
    task_id_t task_max;
159 160
    MessagesIds messages_id_max;

161 162
    pthread_t thread_handling_signals;

163
    const task_info_t *tasks_info;
164 165
    const message_info_t *messages_info;

166
    itti_lte_time_t lte_time;
167 168 169 170 171

    int running;
#ifdef RTAI
    pthread_t rt_relay_thread;
#endif
172 173 174 175 176 177

#if defined(OAI_EMU) || defined(RTAI)
    uint64_t vcd_poll_msg;
    uint64_t vcd_receive_msg;
    uint64_t vcd_send_msg;
#endif
178 179 180
} itti_desc_t;

static itti_desc_t itti_desc;
181

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
void *itti_malloc(task_id_t task_id, ssize_t size)
{
    void *ptr = NULL;

#ifdef RTAI
//     ptr = rt_malloc(size);
    ptr = malloc(size);
#else
    ptr = malloc(size);
#endif

    DevCheck(ptr != NULL, ptr, size, task_id);

    return ptr;
}

void itti_free(task_id_t task_id, void *ptr)
{
    DevAssert(ptr != NULL);
#ifdef RTAI
    free(ptr);
#else
    free(ptr);
#endif
}

208
static inline message_number_t itti_increment_message_number(void) {
209 210 211 212
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
213
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
214 215
}

216
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
217 218 219 220 221
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

222
const char *itti_get_message_name(MessagesIds message_id) {
223 224 225 226 227
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

228
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
229
{
230
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
Cedric Roux committed
231

232
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
233 234
}

235
static task_id_t itti_get_current_task_id(void)
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
{
    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;
}

253 254 255 256 257 258
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

259
int itti_send_broadcast_message(MessageDef *message_p) {
260
    task_id_t destination_task_id;
261
    task_id_t origin_task_id;
262
    thread_id_t origin_thread_id;
263
    uint32_t thread_id;
264
    int ret = 0;
265
    int result;
266

267
    DevAssert(message_p != NULL);
268

269 270
    origin_task_id = message_p->ittiMsgHeader.originTaskId;
    origin_thread_id = TASK_GET_THREAD_ID(origin_task_id);
271

272 273
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
274 275
        MessageDef *new_message_p;

276 277 278 279
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
280
        /* Skip task that broadcast the message */
281
        if (thread_id != origin_thread_id) {
282
            /* Skip tasks which are not running */
283
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
284
                new_message_p = itti_malloc (origin_task_id, sizeof(MessageDef));
285
                DevAssert(message_p != NULL);
286 287

                memcpy (new_message_p, message_p, sizeof(MessageDef));
288
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
Cedric Roux's avatar
Cedric Roux committed
289
                DevCheck(result >= 0, message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
290
            }
291 292
        }
    }
293
    free (message_p);
294 295 296 297

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
298 299
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
300 301
    MessageDef *temp = NULL;

302
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
303

304 305 306 307
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, size);
#endif

308 309 310 311 312 313
    if (origin_task_id == TASK_UNKNOWN)
    {
        /* Try to identify real origin task ID */
        origin_task_id = itti_get_current_task_id();
    }

314
    temp = itti_malloc (origin_task_id, sizeof(MessageHeader) + size);
315
    DevAssert(temp != NULL);
316

Cedric Roux's avatar
Cedric Roux committed
317 318 319
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
320

321 322 323 324
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, 0);
#endif

325 326 327
    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
328 329 330 331 332
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);
}

333
int itti_send_msg_to_task(task_id_t destination_task_id, instance_t instance, MessageDef *message)
Cedric Roux's avatar
Cedric Roux committed
334
{
335
    thread_id_t destination_thread_id;
336
    thread_id_t origin_task_id;
337
    message_list_t *new;
338 339 340
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
341

winckel's avatar
winckel committed
342
#if defined(OAI_EMU) || defined(RTAI)
343 344
    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
345 346
#endif

347
    DevAssert(message != NULL);
348
    DevCheck(destination_task_id < itti_desc.task_max, destination_task_id, itti_desc.task_max, 0);
349

350 351
    destination_thread_id = TASK_GET_THREAD_ID(destination_task_id);
    message->ittiMsgHeader.destinationTaskId = destination_task_id;
Cedric Roux's avatar
Cedric Roux committed
352 353 354 355
    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;
356 357
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

358 359
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

360
    priority = itti_get_message_priority (message_id);
361

362 363
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
364

365
    itti_dump_queue_message (origin_task_id, message_number, message, itti_desc.messages_info[message_id].name,
366 367 368
                             sizeof(MessageHeader) + message->ittiMsgHeader.ittiMsgSize);

    if (destination_task_id != TASK_UNKNOWN)
369
    {
370
#if defined(OAI_EMU) || defined(RTAI)
winckel's avatar
winckel committed
371 372 373
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_IN);
#endif

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
        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);
389

390
            /* Allocate new list element */
391
            new = (message_list_t *) itti_malloc (origin_task_id, sizeof(struct message_list_s));
392
            DevAssert(new != NULL);
393

394 395 396 397
            /* Fill in members */
            new->msg = message;
            new->message_number = message_number;
            new->message_priority = priority;
398

399 400
            /* Enqueue message in destination task queue */
            lfds611_queue_enqueue(itti_desc.tasks[destination_task_id].message_queue, new);
401

402
#if defined(OAI_EMU) || defined(RTAI)
403
            vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
winckel's avatar
winckel committed
404 405
#endif

406
#ifdef RTAI
407 408 409 410 411 412
            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
413 414
#endif
            {
415 416 417 418
                /* 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;
419
                    eventfd_t sem_counter = 1;
420

421 422 423 424
                    /* 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);
                }
425
            }
426

427 428 429 430 431 432 433 434
            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));
        }
435
    }
436

437
#if defined(OAI_EMU) || defined(RTAI)
438 439
    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)));
440 441
#endif

442 443 444
    return 0;
}

445 446
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
447
    thread_id_t thread_id;
448 449
    struct epoll_event event;

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

453 454
    thread_id = TASK_GET_THREAD_ID(task_id);
    itti_desc.threads[thread_id].nb_events++;
455 456

    /* Reallocate the events */
457 458 459
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
460

461
    event.events  = EPOLLIN | EPOLLERR;
462 463 464
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
465
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_ADD, fd,
466 467 468 469 470 471 472
        &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);
    }
473 474

    ITTI_DEBUG("Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
475 476 477 478
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
479 480
    thread_id_t thread_id;

481
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
482 483
    DevCheck(fd >= 0, fd, 0, 0);

484
    thread_id = TASK_GET_THREAD_ID(task_id);
485
    /* Add the event fd to the list of monitored events */
486
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
487 488 489 490 491 492 493
    {
        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);
    }

494 495 496 497
    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));
498 499 500 501
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
502 503
    thread_id_t thread_id;

504
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
505

506 507
    thread_id = TASK_GET_THREAD_ID(task_id);
    *events = itti_desc.threads[thread_id].events;
508

509
    return itti_desc.threads[thread_id].epoll_nb_events;
510 511
}

512 513
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
514
    thread_id_t thread_id;
515 516
    int epoll_ret = 0;
    int epoll_timeout = 0;
517
    int i;
518

519
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
520 521
    DevAssert(received_msg != NULL);

522
    thread_id = TASK_GET_THREAD_ID(task_id);
523 524 525 526 527 528 529 530 531 532 533 534 535
    *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;
    }

536
    do {
537 538 539
        epoll_ret = epoll_wait(itti_desc.threads[thread_id].epoll_fd,
                               itti_desc.threads[thread_id].events,
                               itti_desc.threads[thread_id].nb_events,
540 541
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
542 543 544

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
545
                   itti_get_task_name(task_id), strerror(errno));
546 547 548 549 550 551 552
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

553
    itti_desc.threads[thread_id].epoll_nb_events = epoll_ret;
554

555
    for (i = 0; i < epoll_ret; i++) {
556
        /* Check if there is an event for ITTI for the event fd */
557 558
        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))
559
        {
560
            struct message_list_s *message = NULL;
561 562
            eventfd_t sem_counter;
            ssize_t   read_ret;
563 564

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

568 569
#if defined(KERNEL_VERSION_PRE_2_6_30)
            /* Store the value of the semaphore counter */
570
            itti_desc.threads[task_id].sem_counter = sem_counter - 1;
571 572
#endif

573
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
574
                /* No element in list -> this should not happen */
575
                DevParam(task_id, epoll_ret, 0);
576
            }
577
            DevAssert(message != NULL);
578
            *received_msg = message->msg;
579
            itti_free (ITTI_MSG_ORIGIN_ID(*received_msg), message);
580
            return;
581 582 583 584 585 586
        }
    }
}

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
587
#if defined(OAI_EMU) || defined(RTAI)
588 589
    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)));
590
#endif
591 592 593

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

597 598
        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
            /* No element in list -> this should not happen */
599
            DevParam(task_id, itti_desc.threads[task_id].sem_counter, 0);
600 601 602 603 604
        }
        DevAssert(message != NULL);
        *received_msg = message->msg;
        free (message);

605
        itti_desc.threads[task_id].sem_counter--;
606 607
    } else
#endif
608
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
609

winckel's avatar
winckel committed
610
#if defined(OAI_EMU) || defined(RTAI)
611 612
    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));
613
#endif
614 615
}

616 617
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);
618
    DevAssert(received_msg != NULL);
619 620 621

    *received_msg = NULL;

622
#if defined(OAI_EMU) || defined(RTAI)
623 624
    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));
625 626 627 628 629 630 631 632 633 634 635
#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);
        }
    }
636

637
    if ((itti_debug_poll) && (*received_msg == NULL)) {
638
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
639
    }
640 641

#if defined(OAI_EMU) || defined(RTAI)
642 643
    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)));
644
#endif
645 646
}

647
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
648
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
649
    int result;
650 651

    DevAssert(start_routine != NULL);
652
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
653 654
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
655

656
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
657

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

660
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
661
    DevCheck(result >= 0, task_id, thread_id, result);
662 663

    /* Wait till the thread is completely ready */
664
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
665
        ;
666 667 668
    return 0;
}

669 670 671 672 673 674 675 676 677 678 679
#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

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

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

686 687 688 689 690 691
    /* 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);

692 693 694 695 696 697 698 699 700
#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

701
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
702 703
}

704
void itti_exit_task(void) {
705 706 707 708 709 710 711 712 713
#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
714 715 716
    pthread_exit (NULL);
}

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

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

    pthread_exit (NULL);
726 727
}

728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
#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;
749
                    eventfd_t sem_counter = pending_messages;
750 751 752 753 754 755 756 757 758 759 760 761

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

762
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
763
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
764 765
    task_id_t task_id;
    thread_id_t thread_id;
766 767
    int ret;

768
    itti_desc.message_number = 1;
769

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

772
    CHECK_INIT_RETURN(signal_mask());
773

774
    /* Saves threads and messages max values */
775
    itti_desc.task_max = task_max;
776 777
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
778
    itti_desc.thread_handling_signals = -1;
779
    itti_desc.tasks_info = tasks_info;
780 781 782
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
783 784 785 786
    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));
787 788

    /* Initializing each queue and related stuff */
789
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
790
    {
791 792 793 794 795 796 797
        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) : "");

798
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
799 800 801

        ret = lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size);
        if (ret < 0)
802
        {
803
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", task_id);
804 805
            DevAssert(0 == 1);
        }
806 807 808 809 810 811
    }

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

813 814
        itti_desc.threads[thread_id].epoll_fd = epoll_create1(0);
        if (itti_desc.threads[thread_id].epoll_fd == -1) {
815 816 817 818 819
            ITTI_ERROR("Failed to create new epoll fd: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

820 821 822 823 824 825
# 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
826
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
827
# endif
828
        if (itti_desc.threads[thread_id].task_event_fd == -1)
829
        {
830 831 832 833 834
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

835
        itti_desc.threads[thread_id].nb_events = 1;
836

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

839 840
        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;
841 842

        /* Add the event fd to the list of monitored events */
843 844
        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)
845
        {
846
            ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed: %s\n", strerror(errno));
847 848 849
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
850 851

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

854 855 856
#ifdef RTAI
        itti_desc.threads[thread_id].real_time = FALSE;
        itti_desc.threads[thread_id].messages_pending = 0;
857
#endif
858
    }
859

860
    itti_desc.running = 1;
861 862 863
#ifdef RTAI
    /* Start RT relay thread */
    DevAssert(pthread_create (&itti_desc.rt_relay_thread, NULL, itti_rt_relay_thread, NULL) >= 0);
864 865

    rt_global_heap_open();
866
#endif
867

868 869 870 871 872 873
#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

874
    itti_dump_init (messages_definition_xml, dump_file_name);
875

876
    CHECK_INIT_RETURN(timer_init ());
877 878 879 880

    return 0;
}

881 882
void itti_wait_tasks_end(void) {
    int end = 0;
883 884
    int thread_id;
    task_id_t task_id;
885 886 887
    int ready_tasks;
    int result;
    int retries = 10;
888 889 890 891 892 893 894 895

    itti_desc.thread_handling_signals = pthread_self ();

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

896 897 898
    do {
        ready_tasks = 0;

899 900
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
901
            /* Skip tasks which are not running */
902 903 904 905 906
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
907

908
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
909

910
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
911 912 913

                if (result == 0) {
                    /* Thread has terminated */
914
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
915 916 917 918 919 920 921 922 923
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
924
        }
925 926
    } while ((ready_tasks > 0) && (retries--));

927
    itti_desc.running = 0;
928

929 930 931
    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
932
    }
933 934

    itti_dump_exit();
935 936 937
}

void itti_send_terminate_message(task_id_t task_id) {
938 939
    MessageDef *terminate_message_p;

940
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
941

942
    itti_send_broadcast_message (terminate_message_p);
943
}