intertask_interface.c 24.3 KB
Newer Older
Cedric Roux's avatar
 
Cedric Roux committed
1
2
/*******************************************************************************

3
4
 Eurecom OpenAirInterface
 Copyright(c) 1999 - 2012 Eurecom
Cedric Roux's avatar
 
Cedric Roux committed
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.
Cedric Roux's avatar
 
Cedric Roux committed
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.
Cedric Roux's avatar
 
Cedric Roux committed
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.
Cedric Roux's avatar
 
Cedric Roux committed
18

19
20
 The full GNU General Public License is included in this distribution in
 the file called "COPYING".
Cedric Roux's avatar
 
Cedric Roux committed
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
Cedric Roux's avatar
 
Cedric Roux committed
28

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

31
#define _GNU_SOURCE
Cedric Roux's avatar
 
Cedric Roux committed
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>
Cedric Roux's avatar
 
Cedric Roux committed
39
40
41
42

#include "queue.h"
#include "assertions.h"

43
44
45
46
47
48
#if defined(ENABLE_EVENT_FD)
# include <sys/epoll.h>
# include <sys/eventfd.h>
# include "liblfds611.h"
#endif

Cedric Roux's avatar
 
Cedric Roux committed
49
50
#include "intertask_interface.h"
#include "intertask_interface_dump.h"
51
52
53
54

/* Includes "intertask_interface_init.h" to check prototype coherence, but
 * disable threads and messages information generation.
 */
Cedric Roux's avatar
 
Cedric Roux committed
55
56
57
58
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

59
#include "signals.h"
Cedric Roux's avatar
 
Cedric Roux committed
60
61
#include "timer.h"

62
int itti_debug = 0;
Cedric Roux's avatar
 
Cedric Roux committed
63
64
65
66
67
68
69
70
71
72

#define ITTI_DEBUG(x, args...) do { if (itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); } \
    while(0)
#define ITTI_ERROR(x, args...) do { fprintf(stdout, "[ITTI][E]"x, ##args); } \
    while(0)

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

typedef enum task_state_s {
73
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
Cedric Roux's avatar
 
Cedric Roux committed
74
75
76
77
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
struct message_list_s {
78
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
79
    STAILQ_ENTRY(message_list_s) next_element;
80
#endif
Cedric Roux's avatar
 
Cedric Roux committed
81

82
    MessageDef *msg; ///< Pointer to the message
Cedric Roux's avatar
 
Cedric Roux committed
83

84
85
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
Cedric Roux's avatar
 
Cedric Roux committed
86
87
88
89
};

typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
90
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
Cedric Roux committed
91
    STAILQ_HEAD(message_queue_head, message_list_s) message_queue;
Cedric Roux's avatar
 
Cedric Roux committed
92
93

    /* Number of messages in the queue */
94
    volatile uint32_t message_in_queue;
Cedric Roux's avatar
 
Cedric Roux committed
95
    /* Mutex for the message queue */
96
    pthread_mutex_t message_queue_mutex;
Cedric Roux's avatar
 
Cedric Roux committed
97
    /* Conditional var for message queue and task synchro */
98
    pthread_cond_t message_queue_cond_var;
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
#else
    struct lfds611_queue_state *message_queue;

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

    /* The task fd */
    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;
117
118

    int epoll_nb_events;
119
120
121
122
#endif
    /* pthread associated with the task */
    pthread_t task_thread;
    /* State of the task */
Cedric Roux's avatar
 
Cedric Roux committed
123
124
125
126
127
128
    volatile task_state_t task_state;
} task_desc_t;

struct itti_desc_s {
    task_desc_t *tasks;
    /* Current message number. Incremented every call to send_msg_to_task */
129
    message_number_t message_number __attribute__((aligned(8)));
Cedric Roux's avatar
 
Cedric Roux committed
130
131
132
133

    thread_id_t thread_max;
    MessagesIds messages_id_max;

134
135
    pthread_t thread_handling_signals;

Cedric Roux's avatar
 
Cedric Roux committed
136
137
138
139
140
141
    const char * const *threads_name;
    const message_info_t *messages_info;
};

static struct itti_desc_s itti_desc;

142
static inline message_number_t itti_increment_message_number(void) {
Cedric Roux's avatar
 
Cedric Roux committed
143
144
145
146
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
147
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
Cedric Roux's avatar
 
Cedric Roux committed
148
149
}

150
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
151
152
153
154
155
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

156
const char *itti_get_message_name(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
157
158
159
160
161
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

162
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
163
164
165
166
167
168
169
170
{
    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);

    return (itti_desc.threads_name[thread_id]);
}

171
172
int itti_send_broadcast_message(MessageDef *message_p) {
    thread_id_t origin_thread_id;
Cedric Roux's avatar
 
Cedric Roux committed
173
174
    uint32_t i;
    int ret = 0;
175
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
176

177
    DevAssert(message_p != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
178

179
    origin_thread_id = TASK_GET_THREAD_ID(message_p->header.originTaskId);
Cedric Roux's avatar
 
Cedric Roux committed
180

181
182
183
184
185
186
187
188
    for (i = THREAD_FIRST; i < itti_desc.thread_max; i++) {
        MessageDef *new_message_p;

        /* Skip task that broadcast the message */
        if (i != origin_thread_id) {
            /* Skip tasks which are not running */
            if (itti_desc.tasks[i].task_state == TASK_STATE_READY) {
                new_message_p = malloc (sizeof(MessageDef));
189
                DevAssert(message_p != NULL);
190
191
192

                memcpy (new_message_p, message_p, sizeof(MessageDef));
                result = itti_send_msg_to_task (TASK_SHIFT_THREAD_ID(i), INSTANCE_DEFAULT, new_message_p);
193
                DevCheck(result >= 0, message_p->header.messageId, i, 0);
194
            }
Cedric Roux's avatar
 
Cedric Roux committed
195
196
        }
    }
197
    free (message_p);
Cedric Roux's avatar
 
Cedric Roux committed
198
199
200
201

    return ret;
}

202
inline MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
203
204
    MessageDef *temp = NULL;

205
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
206

207
    temp = calloc (1, MESSAGE_SIZE(message_id));
208
    DevAssert(temp != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
209
210
211
212
213
214
215
216

    temp->header.messageId = message_id;
    temp->header.originTaskId = origin_task_id;
    temp->header.size = itti_desc.messages_info[message_id].size;

    return temp;
}

217
218
219
220
221
222
int itti_send_msg_to_task(task_id_t task_id, instance_t instance, MessageDef *message) {
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
    struct message_list_s *new;
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
Cedric Roux's avatar
 
Cedric Roux committed
223

224
225
    DevAssert(message != NULL);
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
226
227
228
229
230
231

    message->header.destinationTaskId = task_id;
    message->header.instance = instance;
    message_id = message->header.messageId;
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

232
    priority = itti_get_message_priority (message_id);
Cedric Roux's avatar
 
Cedric Roux committed
233
234

    /* We cannot send a message if the task is not running */
235
236
    DevCheck(itti_desc.tasks[thread_id].task_state == TASK_STATE_READY, itti_desc.tasks[thread_id].task_state,
             TASK_STATE_READY, thread_id);
Cedric Roux's avatar
 
Cedric Roux committed
237

238
239
240
241
#if !defined(ENABLE_EVENT_FD)
    /* Lock the mutex to get exclusive access to the list */
    pthread_mutex_lock (&itti_desc.tasks[thread_id].message_queue_mutex);

Cedric Roux's avatar
 
Cedric Roux committed
242
    /* Check the number of messages in the queue */
243
244
    DevCheck((itti_desc.tasks[thread_id].message_in_queue * sizeof(MessageDef)) < ITTI_QUEUE_SIZE_PER_TASK,
             (itti_desc.tasks[thread_id].message_in_queue * sizeof(MessageDef)), ITTI_QUEUE_SIZE_PER_TASK,
245
246
              itti_desc.tasks[thread_id].message_in_queue);
#endif
Cedric Roux's avatar
 
Cedric Roux committed
247
248

    /* Allocate new list element */
249
250
    new = (struct message_list_s *) malloc (sizeof(struct message_list_s));
    DevAssert(new != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
251
252

    /* Increment the global message number */
253
    message_number = itti_increment_message_number ();
Cedric Roux's avatar
 
Cedric Roux committed
254
255

    /* Fill in members */
256
257
    new->msg = message;
    new->message_number = message_number;
Cedric Roux's avatar
 
Cedric Roux committed
258
259
    new->message_priority = priority;

260
261
    itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
                             MESSAGE_SIZE(message_id));
Cedric Roux's avatar
 
Cedric Roux committed
262

263
264
#if defined(ENABLE_EVENT_FD)
    {
Cedric Roux's avatar
Cedric Roux committed
265
        uint64_t sem_counter = 1;
266
267

        /* Call to write for an event fd must be of 8 bytes */
Cedric Roux's avatar
Cedric Roux committed
268
        write(itti_desc.tasks[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));
269
270
271
272

        lfds611_queue_enqueue(itti_desc.tasks[thread_id].message_queue, new);
    }
#else
273
274
275
276
    if (STAILQ_EMPTY (&itti_desc.tasks[thread_id].message_queue)) {
        STAILQ_INSERT_HEAD (&itti_desc.tasks[thread_id].message_queue, new, next_element);
    }
    else {
Cedric Roux's avatar
 
Cedric Roux committed
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
//         struct message_list_s *insert_after = NULL;
//         struct message_list_s *temp;
// 
//         /* This method is inefficient... */
//         STAILQ_FOREACH(temp, &itti_desc.tasks[thread_id].message_queue, next_element) {
//             struct message_list_s *next;
//             next = STAILQ_NEXT(temp, next_element);
//             /* Increment message priority to create a sort of
//              * priority based scheduler */
// //             if (temp->message_priority < TASK_PRIORITY_MAX) {
// //                 temp->message_priority++;
// //             }
//             if (next && next->message_priority < priority) {
//                 insert_after = temp;
//                 break;
//             }
//         }
//         if (insert_after == NULL) {
295
        STAILQ_INSERT_TAIL (&itti_desc.tasks[thread_id].message_queue, new, next_element);
Cedric Roux's avatar
 
Cedric Roux committed
296
297
298
299
300
301
302
303
304
305
//         } else {
//             STAILQ_INSERT_AFTER(&itti_desc.tasks[thread_id].message_queue, insert_after, new,
//                                 next_element);
//         }
    }

    /* Update the number of messages in the queue */
    itti_desc.tasks[thread_id].message_in_queue++;
    if (itti_desc.tasks[thread_id].message_in_queue == 1) {
        /* Emit a signal to wake up target task thread */
306
        pthread_cond_signal (&itti_desc.tasks[thread_id].message_queue_cond_var);
Cedric Roux's avatar
 
Cedric Roux committed
307
308
    }
    /* Release the mutex */
309
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
310
311
#endif

312
313
314
    ITTI_DEBUG(
            "Message %s, number %lu with priority %d successfully sent to queue (%u:%s)\n",
            itti_desc.messages_info[message_id].name, message_number, priority, thread_id, itti_desc.threads_name[thread_id]);
Cedric Roux's avatar
 
Cedric Roux committed
315
316
317
    return 0;
}

318
#if defined(ENABLE_EVENT_FD)
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;
    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);
    DevCheck(fd >= 0, fd, 0, 0);

    itti_desc.tasks[thread_id].nb_events++;

    /* Reallocate the events */
    itti_desc.tasks[thread_id].events = realloc(
        itti_desc.tasks[thread_id].events,
        itti_desc.tasks[thread_id].nb_events * sizeof(struct epoll_event));

    event.events  = EPOLLIN;
    event.data.fd = fd;

    /* Add the event fd to the list of monitored events */
    if (epoll_ctl(itti_desc.tasks[thread_id].epoll_fd, EPOLL_CTL_ADD, fd,
        &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);
    }
}

void itti_unsubscribe_event_fd(task_id_t task_id, int fd)
{
    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);
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
    if (epoll_ctl(itti_desc.tasks[thread_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
    {
        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);
    }

    itti_desc.tasks[thread_id].nb_events--;
    itti_desc.tasks[thread_id].events = realloc(
        itti_desc.tasks[thread_id].events,
        itti_desc.tasks[thread_id].nb_events * sizeof(struct epoll_event));
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
    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);

    *events = itti_desc.tasks[thread_id].events;

    return itti_desc.tasks[thread_id].epoll_nb_events;
}

381
382
383
384
static inline void itti_receive_msg_internal_event_fd(task_id_t task_id, uint8_t polling, MessageDef **received_msg)
{
    int epoll_ret = 0;
    int epoll_timeout = 0;
385
    int i;
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419

    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);
    DevAssert(received_msg != NULL);

    *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;
    }

    epoll_ret = epoll_wait(itti_desc.tasks[thread_id].epoll_fd,
                           itti_desc.tasks[thread_id].events,
                           itti_desc.tasks[thread_id].nb_events,
                           epoll_timeout);

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

420
    itti_desc.tasks[thread_id].epoll_nb_events = epoll_ret;
421

422
423
424
425
    for (i = 0; i < epoll_ret; i++) {
        /* Check if there is an event for the ITTI for the event fd */
        if ((itti_desc.tasks[thread_id].events[i].events & EPOLLIN) &&
            (itti_desc.tasks[thread_id].events[i].data.fd == itti_desc.tasks[thread_id].task_event_fd))
426
        {
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
            struct message_list_s *message;
            uint64_t sem_counter;

            /* Read will always return 1 */
            read(itti_desc.tasks[thread_id].task_event_fd, &sem_counter, sizeof(sem_counter));

            if (lfds611_queue_dequeue(itti_desc.tasks[thread_id].message_queue,
                (void **)&message) == 0)
            {
                /* No element in list -> this should not happen */
                DevMessage("No element in message queue...");
            }
            *received_msg = message->msg;
            free(message);
            return;
442
443
444
445
446
447
448
449
450
451
        }
    }
}
#endif

void itti_receive_msg(task_id_t task_id, MessageDef **received_msg)
{
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 0, received_msg);
#else
Cedric Roux's avatar
 
Cedric Roux committed
452
453
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

454
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
455
456
457
    DevAssert(received_msg != NULL);

    // Lock the mutex to get exclusive access to the list
458
    pthread_mutex_lock (&itti_desc.tasks[thread_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
459
460

    if (itti_desc.tasks[thread_id].message_in_queue == 0) {
461
        ITTI_DEBUG("Message in queue[(%u:%s)] == 0, waiting\n", thread_id, itti_desc.threads_name[thread_id]);
Cedric Roux's avatar
 
Cedric Roux committed
462
        // Wait while list == 0
463
464
        pthread_cond_wait (&itti_desc.tasks[thread_id].message_queue_cond_var,
                           &itti_desc.tasks[thread_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
465
466
467
468
        ITTI_DEBUG("Receiver queue[(%u:%s)] got new message notification for task %x\n",
                   thread_id, itti_desc.threads_name[thread_id], task_id);
    }

469
470
    if (!STAILQ_EMPTY (&itti_desc.tasks[thread_id].message_queue)) {
        struct message_list_s *temp = STAILQ_FIRST (&itti_desc.tasks[thread_id].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
471
472
473
474
475

        /* Update received_msg reference */
        *received_msg = temp->msg;

        /* Remove message from queue */
476
477
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[thread_id].message_queue, next_element);
        free (temp);
Cedric Roux's avatar
 
Cedric Roux committed
478
479
480
        itti_desc.tasks[thread_id].message_in_queue--;
    }
    // Release the mutex
481
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
482
#endif
Cedric Roux's avatar
 
Cedric Roux committed
483
484
}

485
void itti_poll_msg(task_id_t task_id, instance_t instance, MessageDef **received_msg) {
Cedric Roux's avatar
 
Cedric Roux committed
486
487
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

488
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
489
    DevAssert(received_msg != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
490
491
492

    *received_msg = NULL;

493
494
495
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 1, received_msg);
#else
496
    if (itti_desc.tasks[thread_id].message_in_queue != 0) {
Cedric Roux's avatar
 
Cedric Roux committed
497
498
499
500
501
        struct message_list_s *temp;

        // Lock the mutex to get exclusive access to the list
        pthread_mutex_lock (&itti_desc.tasks[thread_id].message_queue_mutex);

502
        STAILQ_FOREACH (temp, &itti_desc.tasks[thread_id].message_queue, next_element)
Cedric Roux's avatar
 
Cedric Roux committed
503
504
        {
            if ((temp->msg->header.destinationTaskId == task_id)
505
                    && ((instance == INSTANCE_ALL) || (temp->msg->header.instance == instance))) {
Cedric Roux's avatar
 
Cedric Roux committed
506
507
508
509
                /* Update received_msg reference */
                *received_msg = temp->msg;

                /* Remove message from queue */
510
                STAILQ_REMOVE (&itti_desc.tasks[thread_id].message_queue, temp, message_list_s, next_element);
Cedric Roux's avatar
 
Cedric Roux committed
511
512
513
                free (temp);
                itti_desc.tasks[thread_id].message_in_queue--;

514
515
516
                ITTI_DEBUG(
                        "Receiver queue[(%u:%s)] got new message %s, number %lu for task %x\n",
                        thread_id, itti_desc.threads_name[thread_id], itti_desc.messages_info[temp->msg->header.messageId].name, temp->message_number, task_id);
Cedric Roux's avatar
 
Cedric Roux committed
517
518
519
520
521
522
523
                break;
            }
        }

        // Release the mutex
        pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
    }
524
#endif
Cedric Roux's avatar
 
Cedric Roux committed
525

526
    if (*received_msg == NULL) {
Cedric Roux's avatar
 
Cedric Roux committed
527
528
529
530
        ITTI_DEBUG("No message in queue[(%u:%s)] for task %x\n", thread_id, itti_desc.threads_name[thread_id], task_id);
    }
}

531
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
Cedric Roux's avatar
 
Cedric Roux committed
532
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
533
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
534
535

    DevAssert(start_routine != NULL);
536
537
538
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
    DevCheck(itti_desc.tasks[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.tasks[thread_id].task_state);
Cedric Roux's avatar
 
Cedric Roux committed
539
540
541

    itti_desc.tasks[thread_id].task_state = TASK_STATE_STARTING;

542
543
    result = pthread_create (&itti_desc.tasks[thread_id].task_thread, NULL, start_routine, args_p);
    DevCheck(result>= 0, task_id, thread_id, result);
Cedric Roux's avatar
 
Cedric Roux committed
544
545

    /* Wait till the thread is completely ready */
546
547
    while (itti_desc.tasks[thread_id].task_state != TASK_STATE_READY)
        ;
Cedric Roux's avatar
 
Cedric Roux committed
548
549
550
    return 0;
}

551
void itti_mark_task_ready(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
552
553
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

554
555
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

556
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
557
    // Lock the mutex to get exclusive access to the list
558
    pthread_mutex_lock (&itti_desc.tasks[thread_id].message_queue_mutex);
559
560
#endif

Cedric Roux's avatar
 
Cedric Roux committed
561
    itti_desc.tasks[thread_id].task_state = TASK_STATE_READY;
562

563
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
564
    // Release the mutex
565
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
566
#endif
567
568
}

569
570
571
572
void itti_exit_task(void) {
    pthread_exit (NULL);
}

573
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
574
    // Sends Terminate signals to all tasks.
575
576
577
578
579
580
581
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
Cedric Roux's avatar
 
Cedric Roux committed
582
583
}

584
int itti_init(thread_id_t thread_max, MessagesIds messages_id_max, const char * const *threads_name,
585
              const message_info_t *messages_info, const char * const messages_definition_xml, const char * const dump_file_name) {
Cedric Roux's avatar
 
Cedric Roux committed
586
    int i;
587
    itti_desc.message_number = 1;
Cedric Roux's avatar
 
Cedric Roux committed
588

589
    ITTI_DEBUG("Init: %d threads, %d messages\n", thread_max, messages_id_max);
590

591
592
    CHECK_INIT_RETURN(signal_init());

Cedric Roux's avatar
 
Cedric Roux committed
593
594
595
    /* Saves threads and messages max values */
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
596
    itti_desc.thread_handling_signals = -1;
Cedric Roux's avatar
 
Cedric Roux committed
597
598
599
600
    itti_desc.threads_name = threads_name;
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
601
    itti_desc.tasks = calloc (itti_desc.thread_max, sizeof(task_desc_t));
Cedric Roux's avatar
 
Cedric Roux committed
602
603

    /* Initializing each queue and related stuff */
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
    for (i = THREAD_FIRST; i < itti_desc.thread_max; i++)
    {
#if defined(ENABLE_EVENT_FD)
        ITTI_DEBUG("Creating queue of message of size %u\n",
           ITTI_QUEUE_SIZE_PER_TASK / (sizeof(MessageDef) + sizeof(struct message_list_s)));
        if (lfds611_queue_new(&itti_desc.tasks[i].message_queue,
            ITTI_QUEUE_SIZE_PER_TASK / (sizeof(MessageDef) + sizeof(struct message_list_s))) < 0)
        {
            ITTI_ERROR("lfds611_queue_new failed for task %u\n", i);
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].epoll_fd = epoll_create1(0);
        if (itti_desc.tasks[i].epoll_fd == -1) {
            ITTI_ERROR("Failed to create new epoll fd: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].task_event_fd = eventfd(0, EFD_SEMAPHORE);
        if (itti_desc.tasks[i].task_event_fd == -1) {
            ITTI_ERROR("eventfd failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }

        itti_desc.tasks[i].nb_events = 1;

        itti_desc.tasks[i].events = malloc(sizeof(struct epoll_event));

        itti_desc.tasks[i].events->events  = EPOLLIN;
        itti_desc.tasks[i].events->data.fd = itti_desc.tasks[i].task_event_fd;

        /* Add the event fd to the list of monitored events */
        if (epoll_ctl(itti_desc.tasks[i].epoll_fd, EPOLL_CTL_ADD,
            itti_desc.tasks[i].task_event_fd, itti_desc.tasks[i].events) != 0)
        {
            ITTI_ERROR("epoll_ctl failed: %s\n", strerror(errno));
            /* Always assert on this condition */
            DevAssert(0 == 1);
        }
#else
646
        STAILQ_INIT (&itti_desc.tasks[i].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
647
        itti_desc.tasks[i].message_in_queue = 0;
648

Cedric Roux's avatar
 
Cedric Roux committed
649
        // Initialize mutexes
650
        pthread_mutex_init (&itti_desc.tasks[i].message_queue_mutex, NULL);
651

Cedric Roux's avatar
 
Cedric Roux committed
652
        // Initialize Cond vars
653
        pthread_cond_init (&itti_desc.tasks[i].message_queue_cond_var, NULL);
654
655
#endif

Cedric Roux's avatar
 
Cedric Roux committed
656
657
        itti_desc.tasks[i].task_state = TASK_STATE_NOT_CONFIGURED;
    }
658
    itti_dump_init (messages_definition_xml, dump_file_name);
Cedric Roux's avatar
 
Cedric Roux committed
659

660
    CHECK_INIT_RETURN(timer_init ());
Cedric Roux's avatar
 
Cedric Roux committed
661
662
663
664

    return 0;
}

665
666
667
void itti_wait_tasks_end(void) {
    int end = 0;
    int i;
668
669
670
    int ready_tasks;
    int result;
    int retries = 10;
671
672
673
674
675
676
677
678

    itti_desc.thread_handling_signals = pthread_self ();

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

679
680
681
682
683
684
    do {
        ready_tasks = 0;

        for (i = THREAD_FIRST; i < itti_desc.thread_max; i++) {
            /* Skip tasks which are not running */
            if (itti_desc.tasks[i].task_state == TASK_STATE_READY) {
685

686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
                result = pthread_tryjoin_np (itti_desc.tasks[i].task_thread, NULL);

                ITTI_DEBUG("Thread %s join status %d\n", itti_desc.threads_name[i], result);

                if (result == 0) {
                    /* Thread has terminated */
                    itti_desc.tasks[i].task_state = TASK_STATE_ENDED;
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
702
        }
703
704
705
706
707
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
708
    }
709
710

    itti_dump_exit();
711
712
713
}

void itti_send_terminate_message(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
714
715
    MessageDef *terminate_message_p;

716
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
Cedric Roux's avatar
 
Cedric Roux committed
717

718
    itti_send_broadcast_message (terminate_message_p);
Cedric Roux's avatar
 
Cedric Roux committed
719
}