intertask_interface.c 24.4 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
#define ITTI_DEBUG(x, args...) do { if (itti_debug) fprintf(stdout, "[ITTI][D]"x, ##args); fflush (stdout); } \
Cedric Roux's avatar
 
Cedric Roux committed
65
    while(0)
66
#define ITTI_ERROR(x, args...) do { fprintf(stdout, "[ITTI][E]"x, ##args); fflush (stdout); } \
Cedric Roux's avatar
 
Cedric Roux committed
67
68
69
70
71
72
    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
90
91
92
93
94
typedef struct thread_desc_s {
    /* pthread associated with the thread */
    pthread_t task_thread;
    /* State of the thread */
    volatile task_state_t task_state;
} thread_desc_t;

Cedric Roux's avatar
 
Cedric Roux committed
95
96
typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
97
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
Cedric Roux committed
98
    STAILQ_HEAD(message_queue_head, message_list_s) message_queue;
Cedric Roux's avatar
 
Cedric Roux committed
99
100

    /* Number of messages in the queue */
101
    volatile uint32_t message_in_queue;
Cedric Roux's avatar
 
Cedric Roux committed
102
    /* Mutex for the message queue */
103
    pthread_mutex_t message_queue_mutex;
Cedric Roux's avatar
 
Cedric Roux committed
104
    /* Conditional var for message queue and task synchro */
105
    pthread_cond_t message_queue_cond_var;
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
#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;
124
125

    int epoll_nb_events;
126
#endif
Cedric Roux's avatar
 
Cedric Roux committed
127
128
129
} task_desc_t;

struct itti_desc_s {
130
    thread_desc_t *threads;
Cedric Roux's avatar
 
Cedric Roux committed
131
    task_desc_t *tasks;
132

Cedric Roux's avatar
 
Cedric Roux committed
133
    /* Current message number. Incremented every call to send_msg_to_task */
134
    message_number_t message_number __attribute__((aligned(8)));
Cedric Roux's avatar
 
Cedric Roux committed
135
136

    thread_id_t thread_max;
137
    task_id_t task_max;
Cedric Roux's avatar
 
Cedric Roux committed
138
139
    MessagesIds messages_id_max;

140
141
    pthread_t thread_handling_signals;

142
    const task_info_t *tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
143
144
145
146
147
    const message_info_t *messages_info;
};

static struct itti_desc_s itti_desc;

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

156
static inline uint32_t itti_get_message_priority(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].priority);
}

162
const char *itti_get_message_name(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
163
164
165
166
167
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

168
const char *itti_get_task_name(task_id_t task_id)
Cedric Roux's avatar
Cedric Roux committed
169
{
170
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
Cedric Roux committed
171

172
    return (itti_desc.tasks_info[task_id].name);
Cedric Roux's avatar
Cedric Roux committed
173
174
}

175
int itti_send_broadcast_message(MessageDef *message_p) {
176
    task_id_t destination_task_id;
177
    thread_id_t origin_thread_id;
178
    uint32_t thread_id;
Cedric Roux's avatar
 
Cedric Roux committed
179
    int ret = 0;
180
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
181

182
    DevAssert(message_p != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
183

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

186
187
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
188
189
        MessageDef *new_message_p;

190
191
192
193
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
194
        /* Skip task that broadcast the message */
195
        if (thread_id != origin_thread_id) {
196
            /* Skip tasks which are not running */
197
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
198
                new_message_p = malloc (sizeof(MessageDef));
199
                DevAssert(message_p != NULL);
200
201

                memcpy (new_message_p, message_p, sizeof(MessageDef));
202
203
                result = itti_send_msg_to_task (destination_task_id, INSTANCE_DEFAULT, new_message_p);
                DevCheck(result >= 0, message_p->header.messageId, thread_id, destination_task_id);
204
            }
Cedric Roux's avatar
 
Cedric Roux committed
205
206
        }
    }
207
    free (message_p);
Cedric Roux's avatar
 
Cedric Roux committed
208
209
210
211

    return ret;
}

212
inline MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
213
214
    MessageDef *temp = NULL;

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

217
    temp = calloc (1, MESSAGE_SIZE(message_id));
218
    DevAssert(temp != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
219
220
221
222
223
224
225
226

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

    return temp;
}

227
228
229
230
231
232
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
233

234
    DevAssert(message != NULL);
235
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
236
237
238
239
240
241

    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);

242
    priority = itti_get_message_priority (message_id);
Cedric Roux's avatar
 
Cedric Roux committed
243
244

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

248
249
#if !defined(ENABLE_EVENT_FD)
    /* Lock the mutex to get exclusive access to the list */
250
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
251

Cedric Roux's avatar
 
Cedric Roux committed
252
    /* Check the number of messages in the queue */
253
254
255
    DevCheck((itti_desc.tasks[task_id].message_in_queue * sizeof(MessageDef)) < ITTI_QUEUE_SIZE_PER_TASK,
             (itti_desc.tasks[task_id].message_in_queue * sizeof(MessageDef)), ITTI_QUEUE_SIZE_PER_TASK,
              itti_desc.tasks[task_id].message_in_queue);
256
#endif
Cedric Roux's avatar
 
Cedric Roux committed
257
258

    /* Allocate new list element */
259
260
    new = (struct message_list_s *) malloc (sizeof(struct message_list_s));
    DevAssert(new != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
261
262

    /* Increment the global message number */
263
    message_number = itti_increment_message_number ();
Cedric Roux's avatar
 
Cedric Roux committed
264
265

    /* Fill in members */
266
267
    new->msg = message;
    new->message_number = message_number;
Cedric Roux's avatar
 
Cedric Roux committed
268
269
    new->message_priority = priority;

270
271
    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
272

273
274
#if defined(ENABLE_EVENT_FD)
    {
Cedric Roux's avatar
Cedric Roux committed
275
        uint64_t sem_counter = 1;
276

277
        lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
278

279
        /* Call to write for an event fd must be of 8 bytes */
280
        write(itti_desc.tasks[task_id].task_event_fd, &sem_counter, sizeof(sem_counter));
281
282
    }
#else
283
284
    if (STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
        STAILQ_INSERT_HEAD (&itti_desc.tasks[task_id].message_queue, new, next_element);
285
286
    }
    else {
Cedric Roux's avatar
 
Cedric Roux committed
287
288
289
290
//         struct message_list_s *insert_after = NULL;
//         struct message_list_s *temp;
// 
//         /* This method is inefficient... */
291
//         STAILQ_FOREACH(temp, &itti_desc.tasks[task_id].message_queue, next_element) {
Cedric Roux's avatar
 
Cedric Roux committed
292
293
294
295
296
297
298
299
300
301
302
303
304
//             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) {
305
        STAILQ_INSERT_TAIL (&itti_desc.tasks[task_id].message_queue, new, next_element);
Cedric Roux's avatar
 
Cedric Roux committed
306
//         } else {
307
//             STAILQ_INSERT_AFTER(&itti_desc.tasks[task_id].message_queue, insert_after, new,
Cedric Roux's avatar
 
Cedric Roux committed
308
309
310
311
312
//                                 next_element);
//         }
    }

    /* Update the number of messages in the queue */
313
314
    itti_desc.tasks[task_id].message_in_queue++;
    if (itti_desc.tasks[task_id].message_in_queue == 1) {
Cedric Roux's avatar
 
Cedric Roux committed
315
        /* Emit a signal to wake up target task thread */
316
        pthread_cond_signal (&itti_desc.tasks[task_id].message_queue_cond_var);
Cedric Roux's avatar
 
Cedric Roux committed
317
318
    }
    /* Release the mutex */
319
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
320
321
#endif

322
323
    ITTI_DEBUG(
            "Message %s, number %lu with priority %d successfully sent to queue (%u:%s)\n",
324
            itti_desc.messages_info[message_id].name, message_number, priority, task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
325
326
327
    return 0;
}

328
#if defined(ENABLE_EVENT_FD)
329
330
331
332
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;

333
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
334
335
    DevCheck(fd >= 0, fd, 0, 0);

336
    itti_desc.tasks[task_id].nb_events++;
337
338

    /* Reallocate the events */
339
340
341
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
342
343
344
345
346

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

    /* Add the event fd to the list of monitored events */
347
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD, fd,
348
349
350
351
352
353
354
355
356
357
358
        &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)
{
359
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
360
361
362
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
363
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
364
365
366
367
368
369
370
    {
        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);
    }

371
372
373
374
    itti_desc.tasks[task_id].nb_events--;
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
375
376
377
378
}

int itti_get_events(task_id_t task_id, struct epoll_event **events)
{
379
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
380

381
    *events = itti_desc.tasks[task_id].events;
382

383
    return itti_desc.tasks[task_id].epoll_nb_events;
384
385
}

386
387
388
389
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;
390
    int i;
391

392
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    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;
    }

408
    do {
409
410
411
        epoll_ret = epoll_wait(itti_desc.tasks[task_id].epoll_fd,
                               itti_desc.tasks[task_id].events,
                               itti_desc.tasks[task_id].nb_events,
412
413
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
414
415
416

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

425
    itti_desc.tasks[task_id].epoll_nb_events = epoll_ret;
426

427
    for (i = 0; i < epoll_ret; i++) {
428
        /* Check if there is an event for ITTI for the event fd */
429
430
        if ((itti_desc.tasks[task_id].events[i].events & EPOLLIN) &&
            (itti_desc.tasks[task_id].events[i].data.fd == itti_desc.tasks[task_id].task_event_fd))
431
        {
432
433
434
435
            struct message_list_s *message;
            uint64_t sem_counter;

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

438
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
439
                /* No element in list -> this should not happen */
440
                DevParam(task_id, epoll_ret, 0);
441
442
            }
            *received_msg = message->msg;
443
            free (message);
444
            return;
445
446
447
448
449
450
451
452
453
454
        }
    }
}
#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
455
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
456
457
458
    DevAssert(received_msg != NULL);

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

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

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

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

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

486
487
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);
488
    DevAssert(received_msg != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
489
490
491

    *received_msg = NULL;

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

        // Lock the mutex to get exclusive access to the list
499
        pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
500

501
        STAILQ_FOREACH (temp, &itti_desc.tasks[task_id].message_queue, next_element)
Cedric Roux's avatar
 
Cedric Roux committed
502
        {
503
504
505
506
507
508
509
510
511
512
513
514
            /* Update received_msg reference */
            *received_msg = temp->msg;

            /* Remove message from queue */
            STAILQ_REMOVE (&itti_desc.tasks[task_id].message_queue, temp, message_list_s, next_element);
            free (temp);
            itti_desc.tasks[task_id].message_in_queue--;

            ITTI_DEBUG(
                    "Receiver queue[(%u:%s)] got new message %s, number %lu\n",
                    task_id, itti_get_task_name(task_id), itti_desc.messages_info[temp->msg->header.messageId].name, temp->message_number);
            break;
Cedric Roux's avatar
 
Cedric Roux committed
515
516
517
        }

        // Release the mutex
518
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
519
    }
520
#endif
Cedric Roux's avatar
 
Cedric Roux committed
521

522
    if (*received_msg == NULL) {
523
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
524
525
526
    }
}

527
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
Cedric Roux's avatar
 
Cedric Roux committed
528
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
529
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
530
531

    DevAssert(start_routine != NULL);
532
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
533
534
    DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_NOT_CONFIGURED, task_id, thread_id,
             itti_desc.threads[thread_id].task_state);
Cedric Roux's avatar
 
Cedric Roux committed
535

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

538
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
539
    DevCheck(result>= 0, task_id, thread_id, result);
Cedric Roux's avatar
 
Cedric Roux committed
540
541

    /* Wait till the thread is completely ready */
542
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
543
        ;
Cedric Roux's avatar
 
Cedric Roux committed
544
545
546
    return 0;
}

547
void itti_mark_task_ready(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
548
549
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

550
551
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

552
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
553
    // Lock the mutex to get exclusive access to the list
554
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
555
556
#endif

557
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
558

559
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
560
    // Release the mutex
561
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
562
#endif
563
564
}

565
566
567
568
void itti_exit_task(void) {
    pthread_exit (NULL);
}

569
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
570
    // Sends Terminate signals to all tasks.
571
572
573
574
575
576
577
    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
578
579
}

580
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
581
              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
582
    int i;
583
    itti_desc.message_number = 1;
Cedric Roux's avatar
 
Cedric Roux committed
584

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

587
588
    CHECK_INIT_RETURN(signal_init());

Cedric Roux's avatar
 
Cedric Roux committed
589
    /* Saves threads and messages max values */
590
    itti_desc.task_max = task_max;
Cedric Roux's avatar
 
Cedric Roux committed
591
592
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
593
    itti_desc.thread_handling_signals = -1;
594
    itti_desc.tasks_info = tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
595
596
597
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
598
599
600
601
    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));
Cedric Roux's avatar
 
Cedric Roux committed
602
603

    /* Initializing each queue and related stuff */
604
    for (i = TASK_FIRST; i < itti_desc.task_max; i++)
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
    {
#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
#endif
655
    }
656

657
658
659
660
    /* Initializing each thread */
    for (i = THREAD_FIRST; i < itti_desc.thread_max; i++)
    {
        itti_desc.threads[i].task_state = TASK_STATE_NOT_CONFIGURED;
Cedric Roux's avatar
 
Cedric Roux committed
661
    }
662

663
    itti_dump_init (messages_definition_xml, dump_file_name);
Cedric Roux's avatar
 
Cedric Roux committed
664

665
    CHECK_INIT_RETURN(timer_init ());
Cedric Roux's avatar
 
Cedric Roux committed
666
667
668
669

    return 0;
}

670
671
void itti_wait_tasks_end(void) {
    int end = 0;
672
673
    int thread_id;
    task_id_t task_id;
674
675
676
    int ready_tasks;
    int result;
    int retries = 10;
677
678
679
680
681
682
683
684

    itti_desc.thread_handling_signals = pthread_self ();

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

685
686
687
    do {
        ready_tasks = 0;

688
689
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
690
            /* Skip tasks which are not running */
691
692
693
694
695
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
696

697
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
698

699
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
700
701
702

                if (result == 0) {
                    /* Thread has terminated */
703
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
704
705
706
707
708
709
710
711
712
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
713
        }
714
715
716
717
718
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
719
    }
720
721

    itti_dump_exit();
722
723
724
}

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

727
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
Cedric Roux's avatar
 
Cedric Roux committed
728

729
    itti_send_broadcast_message (terminate_message_p);
Cedric Roux's avatar
 
Cedric Roux committed
730
}