intertask_interface.c 30.6 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

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

86 87 88 89
#if !defined(EFD_SEMAPHORE)
# define KERNEL_VERSION_PRE_2_6_30 1
#endif

90
typedef enum task_state_s {
91
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
92 93 94
} task_state_t;

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

98 99
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
100
} message_list_t;
101

102 103 104
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
105

106 107
    /* State of the thread */
    volatile task_state_t task_state;
108 109 110 111

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

112
    /* The thread fd */
113 114 115 116 117
    int task_event_fd;

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

118 119 120 121
#if defined(KERNEL_VERSION_PRE_2_6_30)
    uint64_t sem_counter;
#endif

122 123 124 125 126 127
    /* 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;
128 129

    int epoll_nb_events;
130 131 132 133 134 135 136

#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;
137
#endif
138 139 140 141 142
} thread_desc_t;

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

145
typedef struct itti_desc_s {
146
    thread_desc_t *threads;
147
    task_desc_t   *tasks;
148

149
    /* Current message number. Incremented every call to send_msg_to_task */
150
    message_number_t message_number __attribute__((aligned(8)));
151 152

    thread_id_t thread_max;
153
    task_id_t task_max;
154 155
    MessagesIds messages_id_max;

156 157
    pthread_t thread_handling_signals;

158
    const task_info_t *tasks_info;
159 160
    const message_info_t *messages_info;

161
    itti_lte_time_t lte_time;
162 163 164 165 166

    int running;
#ifdef RTAI
    pthread_t rt_relay_thread;
#endif
167 168 169 170 171 172

#if defined(OAI_EMU) || defined(RTAI)
    uint64_t vcd_poll_msg;
    uint64_t vcd_receive_msg;
    uint64_t vcd_send_msg;
#endif
173 174 175
} itti_desc_t;

static itti_desc_t itti_desc;
176

177
static inline message_number_t itti_increment_message_number(void) {
178 179 180 181
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
182
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
183 184
}

185
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
186 187 188 189 190
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

191
const char *itti_get_message_name(MessagesIds message_id) {
192 193 194 195 196
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

197
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
198
{
199
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
Cedric Roux committed
200

201
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
202 203
}

204
static task_id_t itti_get_current_task_id(void)
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
{
    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;
}

222 223 224 225 226 227
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

228
int itti_send_broadcast_message(MessageDef *message_p) {
229
    task_id_t destination_task_id;
230
    thread_id_t origin_thread_id;
231
    uint32_t thread_id;
232
    int ret = 0;
233
    int result;
234

235
    DevAssert(message_p != NULL);
236

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

239 240
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
241 242
        MessageDef *new_message_p;

243 244 245 246
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
247
        /* Skip task that broadcast the message */
248
        if (thread_id != origin_thread_id) {
249
            /* Skip tasks which are not running */
250
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
251
                new_message_p = malloc (sizeof(MessageDef));
252
                DevAssert(message_p != NULL);
253 254

                memcpy (new_message_p, message_p, sizeof(MessageDef));
255
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
Cedric Roux's avatar
Cedric Roux committed
256
                DevCheck(result >= 0, message_p->ittiMsgHeader.messageId, thread_id, destination_task_id);
257
            }
258 259
        }
    }
260
    free (message_p);
261 262 263 264

    return ret;
}

Cedric Roux's avatar
Cedric Roux committed
265 266
inline MessageDef *itti_alloc_new_message_sized(task_id_t origin_task_id, MessagesIds message_id, MessageHeaderSize size)
{
267 268
    MessageDef *temp = NULL;

269
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
270

271 272 273 274
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, size);
#endif

275 276 277 278 279 280
    if (origin_task_id == TASK_UNKNOWN)
    {
        /* Try to identify real origin task ID */
        origin_task_id = itti_get_current_task_id();
    }

281
    temp = malloc (sizeof(MessageHeader) + size);
282
    DevAssert(temp != NULL);
283

Cedric Roux's avatar
Cedric Roux committed
284 285 286
    temp->ittiMsgHeader.messageId = message_id;
    temp->ittiMsgHeader.originTaskId = origin_task_id;
    temp->ittiMsgHeader.ittiMsgSize = size;
287

288 289 290 291
#if defined(OAI_EMU) || defined(RTAI)
    vcd_signal_dumper_dump_variable_by_name(VCD_SIGNAL_DUMPER_VARIABLE_ITTI_ALLOC_MSG, 0);
#endif

292 293 294
    return temp;
}

Cedric Roux's avatar
Cedric Roux committed
295 296 297 298 299
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);
}

300
int itti_send_msg_to_task(task_id_t destination_task_id, instance_t instance, MessageDef *message)
Cedric Roux's avatar
Cedric Roux committed
301
{
302
    thread_id_t destination_thread_id;
303
    thread_id_t origin_task_id;
304
    message_list_t *new;
305 306 307
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
308

winckel's avatar
winckel committed
309
#if defined(OAI_EMU) || defined(RTAI)
310 311
    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
312 313
#endif

314
    DevAssert(message != NULL);
315
    DevCheck(destination_task_id < itti_desc.task_max, destination_task_id, itti_desc.task_max, 0);
316

317 318
    destination_thread_id = TASK_GET_THREAD_ID(destination_task_id);
    message->ittiMsgHeader.destinationTaskId = destination_task_id;
Cedric Roux's avatar
Cedric Roux committed
319 320 321 322
    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;
323 324
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

325 326
    origin_task_id = ITTI_MSG_ORIGIN_ID(message);

327
    priority = itti_get_message_priority (message_id);
328

329 330
    /* Increment the global message number */
    message_number = itti_increment_message_number ();
331

332 333 334
/*
 *
 #ifdef RTAI
335 336 337 338
    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)))
339
#endif
340 341 342 343 344
*/
    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)
345
    {
346
#if defined(OAI_EMU) || defined(RTAI)
winckel's avatar
winckel committed
347 348 349
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_IN);
#endif

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
        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);
365

366 367 368
            /* Allocate new list element */
            new = (message_list_t *) malloc (sizeof(struct message_list_s));
            DevAssert(new != NULL);
369

370 371 372 373
            /* Fill in members */
            new->msg = message;
            new->message_number = message_number;
            new->message_priority = priority;
374

375 376
            /* Enqueue message in destination task queue */
            lfds611_queue_enqueue(itti_desc.tasks[destination_task_id].message_queue, new);
377

378
#if defined(OAI_EMU) || defined(RTAI)
379
            vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
winckel's avatar
winckel committed
380 381
#endif

382
#ifdef RTAI
383 384 385 386 387 388
            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
389 390
#endif
            {
391 392 393 394 395
                /* 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;
396

397 398 399 400
                    /* 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);
                }
401
            }
402

403 404 405 406 407 408 409 410
            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));
        }
411
    }
412

413
#if defined(OAI_EMU) || defined(RTAI)
414 415
    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)));
416 417
#endif

418 419 420
    return 0;
}

421 422
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
423
    thread_id_t thread_id;
424 425
    struct epoll_event event;

426
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
427 428
    DevCheck(fd >= 0, fd, 0, 0);

429 430
    thread_id = TASK_GET_THREAD_ID(task_id);
    itti_desc.threads[thread_id].nb_events++;
431 432

    /* Reallocate the events */
433 434 435
    itti_desc.threads[thread_id].events = realloc(
        itti_desc.threads[thread_id].events,
        itti_desc.threads[thread_id].nb_events * sizeof(struct epoll_event));
436

437
    event.events  = EPOLLIN | EPOLLERR;
438 439 440
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
441
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_ADD, fd,
442 443 444 445 446 447 448
        &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);
    }
449 450

    ITTI_DEBUG("Successfully subscribed fd %d for task %s\n", fd, itti_get_task_name(task_id));
451 452 453 454
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
455 456
    thread_id_t thread_id;

457
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
458 459
    DevCheck(fd >= 0, fd, 0, 0);

460
    thread_id = TASK_GET_THREAD_ID(task_id);
461
    /* Add the event fd to the list of monitored events */
462
    if (epoll_ctl(itti_desc.threads[thread_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
463 464 465 466 467 468 469
    {
        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);
    }

470 471 472 473
    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));
474 475 476 477
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
478 479
    thread_id_t thread_id;

480
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
481

482 483
    thread_id = TASK_GET_THREAD_ID(task_id);
    *events = itti_desc.threads[thread_id].events;
484

485
    return itti_desc.threads[thread_id].epoll_nb_events;
486 487
}

488 489
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
490
    thread_id_t thread_id;
491 492
    int epoll_ret = 0;
    int epoll_timeout = 0;
493
    int i;
494

495
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
496 497
    DevAssert(received_msg != NULL);

498
    thread_id = TASK_GET_THREAD_ID(task_id);
499 500 501 502 503 504 505 506 507 508 509 510 511
    *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;
    }

512
    do {
513 514 515
        epoll_ret = epoll_wait(itti_desc.threads[thread_id].epoll_fd,
                               itti_desc.threads[thread_id].events,
                               itti_desc.threads[thread_id].nb_events,
516 517
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
518 519 520

    if (epoll_ret < 0) {
        ITTI_ERROR("epoll_wait failed for task %s: %s\n",
521
                   itti_get_task_name(task_id), strerror(errno));
522 523 524 525 526 527 528
        DevAssert(0 == 1);
    }
    if (epoll_ret == 0 && polling) {
        /* No data to read -> return */
        return;
    }

529
    itti_desc.threads[thread_id].epoll_nb_events = epoll_ret;
530

531
    for (i = 0; i < epoll_ret; i++) {
532
        /* Check if there is an event for ITTI for the event fd */
533 534
        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))
535
        {
536
            struct message_list_s *message = NULL;
537
            uint64_t sem_counter;
538
            ssize_t  read_ret;
539 540

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

544 545 546 547 548
#if defined(KERNEL_VERSION_PRE_2_6_30)
            /* Store the value of the semaphore counter */
            itti_desc.tasks[task_id].sem_counter = sem_counter - 1;
#endif

549
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
550
                /* No element in list -> this should not happen */
551
                DevParam(task_id, epoll_ret, 0);
552
            }
553
            DevAssert(message != NULL);
554
            *received_msg = message->msg;
555
            free (message);
556
            return;
557 558 559 560 561 562
        }
    }
}

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
563
#if defined(OAI_EMU) || defined(RTAI)
564 565
    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)));
566
#endif
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581

#if defined(KERNEL_VERSION_PRE_2_6_30)
    /* Store the value of the semaphore counter */
    if (itti_desc.tasks[task_id].sem_counter > 0) {
        if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
            /* No element in list -> this should not happen */
            DevParam(task_id, itti_desc.tasks[task_id].sem_counter, 0);
        }
        DevAssert(message != NULL);
        *received_msg = message->msg;
        free (message);

        itti_desc.tasks[task_id].sem_counter--;
    } else
#endif
582
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
583

winckel's avatar
winckel committed
584
#if defined(OAI_EMU) || defined(RTAI)
585 586
    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));
587
#endif
588 589
}

590 591
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);
592
    DevAssert(received_msg != NULL);
593 594 595

    *received_msg = NULL;

596
#if defined(OAI_EMU) || defined(RTAI)
597 598
    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));
599 600 601 602 603 604 605 606 607 608 609
#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);
        }
    }
610

611
    if ((itti_debug_poll) && (*received_msg == NULL)) {
612
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
613
    }
614 615

#if defined(OAI_EMU) || defined(RTAI)
616 617
    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)));
618
#endif
619 620
}

621
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
622
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
623
    int result;
624 625

    DevAssert(start_routine != NULL);
626
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
627 628
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
629

630
    itti_desc.threads[thread_id].task_state = TASK_STATE_STARTING;
631

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

634
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
635
    DevCheck(result >= 0, task_id, thread_id, result);
636 637

    /* Wait till the thread is completely ready */
638
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
639
        ;
640 641 642
    return 0;
}

643 644 645 646 647 648 649 650 651 652 653
#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

654 655
void itti_mark_task_ready(task_id_t task_id)
{
656 657
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

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

660 661 662 663 664 665 666 667 668
#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

669 670 671
    /* Register the thread in itti dump */
    itti_dump_thread_use_ring_buffer();

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

675
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
676 677
}

678
void itti_exit_task(void) {
679 680 681 682 683 684 685 686 687
#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
688 689 690
    pthread_exit (NULL);
}

691
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
692
    // Sends Terminate signals to all tasks.
693 694 695 696 697 698 699
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
700 701
}

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
#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

736
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
737
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
738 739
    task_id_t task_id;
    thread_id_t thread_id;
740 741
    int ret;

742
    itti_desc.message_number = 1;
743

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

746
    CHECK_INIT_RETURN(signal_mask());
747

748
    /* Saves threads and messages max values */
749
    itti_desc.task_max = task_max;
750 751
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
752
    itti_desc.thread_handling_signals = -1;
753
    itti_desc.tasks_info = tasks_info;
754 755 756
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
757 758 759 760
    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));
761 762

    /* Initializing each queue and related stuff */
763
    for (task_id = TASK_FIRST; task_id < itti_desc.task_max; task_id++)
764
    {
765 766 767 768 769 770 771
        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) : "");

772
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[task_id].queue_size);
773 774 775

        ret = lfds611_queue_new(&itti_desc.tasks[task_id].message_queue, itti_desc.tasks_info[task_id].queue_size);
        if (ret < 0)
776
        {
777
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", task_id);
778 779 780
            DevAssert(0 == 1);
        }

781 782 783 784 785 786
# ifdef RTAI
        if (task_id == TASK_L2L1)
        {
            ret = rtf_sem_init(56, 0);
        }
# endif
787 788 789 790 791 792
    }

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

794 795
        itti_desc.threads[thread_id].epoll_fd = epoll_create1(0);
        if (itti_desc.threads[thread_id].epoll_fd == -1) {
796 797 798 799 800
            ITTI_ERROR("Failed to create new epoll fd: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

801 802 803 804 805 806
# 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
807
        itti_desc.threads[thread_id].task_event_fd = eventfd(0, EFD_SEMAPHORE);
808
# endif
809
        if (itti_desc.threads[thread_id].task_event_fd == -1)
810
        {
811 812 813 814 815
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

816
        itti_desc.threads[thread_id].nb_events = 1;
817

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

820 821
        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;
822 823

        /* Add the event fd to the list of monitored events */
824 825
        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)
826
        {
827
            ITTI_ERROR("epoll_ctl (EPOLL_CTL_ADD) failed: %s\n", strerror(errno));
828 829 830
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
831 832

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

835 836 837
#ifdef RTAI
        itti_desc.threads[thread_id].real_time = FALSE;
        itti_desc.threads[thread_id].messages_pending = 0;
838
#endif
839
    }
840

841
    itti_desc.running = 1;
842 843 844 845
#ifdef RTAI
    /* Start RT relay thread */
    DevAssert(pthread_create (&itti_desc.rt_relay_thread, NULL, itti_rt_relay_thread, NULL) >= 0);
#endif
846

847 848 849 850 851 852
#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

853
    itti_dump_init (messages_definition_xml, dump_file_name);
854

855
    CHECK_INIT_RETURN(timer_init ());
856 857 858 859

    return 0;
}

860 861
void itti_wait_tasks_end(void) {
    int end = 0;
862 863
    int thread_id;
    task_id_t task_id;
864 865 866
    int ready_tasks;
    int result;
    int retries = 10;
867 868 869 870 871 872 873 874

    itti_desc.thread_handling_signals = pthread_self ();

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

875 876 877
    do {
        ready_tasks = 0;

878 879
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
880
            /* Skip tasks which are not running */
881 882 883 884 885
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
886

887
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
888

889
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
890 891 892

                if (result == 0) {
                    /* Thread has terminated */
893
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
894 895 896 897 898 899 900 901 902
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
903
        }
904 905
    } while ((ready_tasks > 0) && (retries--));

906
    itti_desc.running = 0;
907

908 909 910
    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
911
    }
912 913

    itti_dump_exit();
914 915 916
}

void itti_send_terminate_message(task_id_t task_id) {
917 918
    MessageDef *terminate_message_p;

919
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
920

921
    itti_send_broadcast_message (terminate_message_p);
922
}