intertask_interface.c 24.7 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
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
77
typedef 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
86
} message_list_t;
Cedric Roux's avatar
 
Cedric Roux committed
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
} task_desc_t;

129
typedef 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
    const message_info_t *messages_info;

145
146
147
148
    itti_lte_time_t lte_time;
} itti_desc_t;

static itti_desc_t itti_desc;
Cedric Roux's avatar
 
Cedric Roux committed
149

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

158
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
159
160
161
162
163
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

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

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

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

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

177
178
179
180
181
182
void itti_update_lte_time(uint32_t frame, uint8_t slot)
{
    itti_desc.lte_time.frame = frame;
    itti_desc.lte_time.slot = slot;
}

183
int itti_send_broadcast_message(MessageDef *message_p) {
184
    task_id_t destination_task_id;
185
    thread_id_t origin_thread_id;
186
    uint32_t thread_id;
Cedric Roux's avatar
 
Cedric Roux committed
187
    int ret = 0;
188
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
189

190
    DevAssert(message_p != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
191

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

194
195
    destination_task_id = TASK_FIRST;
    for (thread_id = THREAD_FIRST; thread_id < itti_desc.thread_max; thread_id++) {
196
197
        MessageDef *new_message_p;

198
199
200
201
        while (thread_id != TASK_GET_THREAD_ID(destination_task_id))
        {
            destination_task_id++;
        }
202
        /* Skip task that broadcast the message */
203
        if (thread_id != origin_thread_id) {
204
            /* Skip tasks which are not running */
205
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
206
                new_message_p = malloc (sizeof(MessageDef));
207
                DevAssert(message_p != NULL);
208
209

                memcpy (new_message_p, message_p, sizeof(MessageDef));
210
211
                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);
212
            }
Cedric Roux's avatar
 
Cedric Roux committed
213
214
        }
    }
215
    free (message_p);
Cedric Roux's avatar
 
Cedric Roux committed
216
217
218
219

    return ret;
}

220
inline MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id) {
Cedric Roux's avatar
 
Cedric Roux committed
221
222
    MessageDef *temp = NULL;

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

225
    temp = calloc (1, MESSAGE_SIZE(message_id));
226
    DevAssert(temp != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
227
228
229
230
231
232
233
234

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

    return temp;
}

235
236
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);
237
    message_list_t *new;
238
239
240
    uint32_t priority;
    message_number_t message_number;
    uint32_t message_id;
Cedric Roux's avatar
 
Cedric Roux committed
241

242
    DevAssert(message != NULL);
243
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
244
245
246

    message->header.destinationTaskId = task_id;
    message->header.instance = instance;
247
248
    message->header.lte_time.frame = itti_desc.lte_time.frame;
    message->header.lte_time.slot = itti_desc.lte_time.slot;
Cedric Roux's avatar
 
Cedric Roux committed
249
250
251
    message_id = message->header.messageId;
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

252
    priority = itti_get_message_priority (message_id);
Cedric Roux's avatar
 
Cedric Roux committed
253

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

257
258
    itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
                             MESSAGE_SIZE(message_id));
259

260
261
262
263
264
    if (task_id != TASK_UNKNOWN)
    {
        /* We cannot send a message if the task is not running */
        DevCheck(itti_desc.threads[thread_id].task_state == TASK_STATE_READY, itti_desc.threads[thread_id].task_state,
                 TASK_STATE_READY, thread_id);
Cedric Roux's avatar
 
Cedric Roux committed
265

266
267
268
#if !defined(ENABLE_EVENT_FD)
        /* Lock the mutex to get exclusive access to the list */
        pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
269

270
271
272
273
        /* Check the number of messages in the queue */
        DevCheck(itti_desc.tasks[task_id].message_in_queue < itti_desc.tasks_info[task_id].queue_size,
                 task_id, itti_desc.tasks[task_id].message_in_queue, itti_desc.tasks_info[task_id].queue_size);
#endif
Cedric Roux's avatar
 
Cedric Roux committed
274

275
        /* Allocate new list element */
276
        new = (message_list_t *) malloc (sizeof(struct message_list_s));
277
        DevAssert(new != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
278

279
280
281
282
        /* Fill in members */
        new->msg = message;
        new->message_number = message_number;
        new->message_priority = priority;
Cedric Roux's avatar
 
Cedric Roux committed
283

284
#if defined(ENABLE_EVENT_FD)
285
286
        {
            uint64_t sem_counter = 1;
287

288
            lfds611_queue_enqueue(itti_desc.tasks[task_id].message_queue, new);
289

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

323
324
325
326
327
328
329
330
        /* Update the number of messages in the queue */
        itti_desc.tasks[task_id].message_in_queue++;
        if (itti_desc.tasks[task_id].message_in_queue == 1) {
            /* Emit a signal to wake up target task thread */
            pthread_cond_signal (&itti_desc.tasks[task_id].message_queue_cond_var);
        }
        /* Release the mutex */
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
331
#endif
332
    }
333

334
335
    ITTI_DEBUG(
            "Message %s, number %lu with priority %d successfully sent to queue (%u:%s)\n",
336
            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
337
338
339
    return 0;
}

340
#if defined(ENABLE_EVENT_FD)
341
342
343
344
void itti_subscribe_event_fd(task_id_t task_id, int fd)
{
    struct epoll_event event;

345
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
346
347
    DevCheck(fd >= 0, fd, 0, 0);

348
    itti_desc.tasks[task_id].nb_events++;
349
350

    /* Reallocate the events */
351
352
353
    itti_desc.tasks[task_id].events = realloc(
        itti_desc.tasks[task_id].events,
        itti_desc.tasks[task_id].nb_events * sizeof(struct epoll_event));
354
355
356
357
358

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

    /* Add the event fd to the list of monitored events */
359
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_ADD, fd,
360
361
362
363
364
365
366
367
368
369
370
        &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)
{
371
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
372
373
374
    DevCheck(fd >= 0, fd, 0, 0);

    /* Add the event fd to the list of monitored events */
375
    if (epoll_ctl(itti_desc.tasks[task_id].epoll_fd, EPOLL_CTL_DEL, fd, NULL) != 0)
376
377
378
379
380
381
382
    {
        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);
    }

383
384
385
386
    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));
387
388
389
390
}

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

393
    *events = itti_desc.tasks[task_id].events;
394

395
    return itti_desc.tasks[task_id].epoll_nb_events;
396
397
}

398
399
400
401
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;
402
    int i;
403

404
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
    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;
    }

420
    do {
421
422
423
        epoll_ret = epoll_wait(itti_desc.tasks[task_id].epoll_fd,
                               itti_desc.tasks[task_id].events,
                               itti_desc.tasks[task_id].nb_events,
424
425
                               epoll_timeout);
    } while (epoll_ret < 0 && errno == EINTR);
426
427
428

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

437
    itti_desc.tasks[task_id].epoll_nb_events = epoll_ret;
438

439
    for (i = 0; i < epoll_ret; i++) {
440
        /* Check if there is an event for ITTI for the event fd */
441
442
        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))
443
        {
444
445
446
447
            struct message_list_s *message;
            uint64_t sem_counter;

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

450
            if (lfds611_queue_dequeue (itti_desc.tasks[task_id].message_queue, (void **) &message) == 0) {
451
                /* No element in list -> this should not happen */
452
                DevParam(task_id, epoll_ret, 0);
453
454
            }
            *received_msg = message->msg;
455
            free (message);
456
            return;
457
458
459
460
461
462
463
464
465
466
        }
    }
}
#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
467
    DevCheck(task_id < itti_desc.task_max, task_id, itti_desc.task_max, 0);
Cedric Roux's avatar
 
Cedric Roux committed
468
469
470
    DevAssert(received_msg != NULL);

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

473
474
    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
475
        // Wait while list == 0
476
477
478
479
        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
480
481
    }

482
    if (!STAILQ_EMPTY (&itti_desc.tasks[task_id].message_queue)) {
483
        message_list_t *temp = STAILQ_FIRST (&itti_desc.tasks[task_id].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
484
485
486
487
488

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

        /* Remove message from queue */
489
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[task_id].message_queue, next_element);
490
        free (temp);
491
        itti_desc.tasks[task_id].message_in_queue--;
Cedric Roux's avatar
 
Cedric Roux committed
492
493
    }
    // Release the mutex
494
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
495
#endif
Cedric Roux's avatar
 
Cedric Roux committed
496
497
}

498
499
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);
500
    DevAssert(received_msg != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
501
502
503

    *received_msg = NULL;

504
505
506
#if defined(ENABLE_EVENT_FD)
    itti_receive_msg_internal_event_fd(task_id, 1, received_msg);
#else
507
    if (itti_desc.tasks[task_id].message_in_queue != 0) {
508
        message_list_t *temp;
Cedric Roux's avatar
 
Cedric Roux committed
509
510

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

513
        STAILQ_FOREACH (temp, &itti_desc.tasks[task_id].message_queue, next_element)
Cedric Roux's avatar
 
Cedric Roux committed
514
        {
515
516
517
518
519
520
521
522
523
524
525
526
            /* 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
527
528
529
        }

        // Release the mutex
530
        pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
Cedric Roux's avatar
 
Cedric Roux committed
531
    }
532
#endif
Cedric Roux's avatar
 
Cedric Roux committed
533

534
    if (*received_msg == NULL) {
535
        ITTI_DEBUG("No message in queue[(%u:%s)]\n", task_id, itti_get_task_name(task_id));
Cedric Roux's avatar
 
Cedric Roux committed
536
537
538
    }
}

539
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
Cedric Roux's avatar
 
Cedric Roux committed
540
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);
541
    int result;
Cedric Roux's avatar
 
Cedric Roux committed
542
543

    DevAssert(start_routine != NULL);
544
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);
545
546
    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
547

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

550
    result = pthread_create (&itti_desc.threads[thread_id].task_thread, NULL, start_routine, args_p);
551
    DevCheck(result>= 0, task_id, thread_id, result);
Cedric Roux's avatar
 
Cedric Roux committed
552
553

    /* Wait till the thread is completely ready */
554
    while (itti_desc.threads[thread_id].task_state != TASK_STATE_READY)
555
        ;
Cedric Roux's avatar
 
Cedric Roux committed
556
557
558
    return 0;
}

559
void itti_mark_task_ready(task_id_t task_id) {
Cedric Roux's avatar
 
Cedric Roux committed
560
561
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

562
563
    DevCheck(thread_id < itti_desc.thread_max, thread_id, itti_desc.thread_max, 0);

564
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
565
    // Lock the mutex to get exclusive access to the list
566
    pthread_mutex_lock (&itti_desc.tasks[task_id].message_queue_mutex);
567
568
#endif

569
    itti_desc.threads[thread_id].task_state = TASK_STATE_READY;
570

571
#if !defined(ENABLE_EVENT_FD)
Cedric Roux's avatar
 
Cedric Roux committed
572
    // Release the mutex
573
    pthread_mutex_unlock (&itti_desc.tasks[task_id].message_queue_mutex);
574
#endif
575
576
}

577
578
579
580
void itti_exit_task(void) {
    pthread_exit (NULL);
}

581
void itti_terminate_tasks(task_id_t task_id) {
Cedric Roux's avatar
Cedric Roux committed
582
    // Sends Terminate signals to all tasks.
583
584
585
586
587
588
589
    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
590
591
}

592
int itti_init(task_id_t task_max, thread_id_t thread_max, MessagesIds messages_id_max, const task_info_t *tasks_info,
593
              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
594
    int i;
595
    itti_desc.message_number = 1;
Cedric Roux's avatar
 
Cedric Roux committed
596

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

599
600
    CHECK_INIT_RETURN(signal_init());

Cedric Roux's avatar
 
Cedric Roux committed
601
    /* Saves threads and messages max values */
602
    itti_desc.task_max = task_max;
Cedric Roux's avatar
 
Cedric Roux committed
603
604
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
605
    itti_desc.thread_handling_signals = -1;
606
    itti_desc.tasks_info = tasks_info;
Cedric Roux's avatar
 
Cedric Roux committed
607
608
609
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
610
611
612
613
    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
614
615

    /* Initializing each queue and related stuff */
616
    for (i = TASK_FIRST; i < itti_desc.task_max; i++)
617
618
    {
#if defined(ENABLE_EVENT_FD)
619
620
        ITTI_DEBUG("Creating queue of message of size %u\n", itti_desc.tasks_info[i].queue_size);
        if (lfds611_queue_new(&itti_desc.tasks[i].message_queue, itti_desc.tasks_info[i].queue_size) < 0)
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
646
647
648
649
650
651
652
653
654
655
        {
            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
656
        STAILQ_INIT (&itti_desc.tasks[i].message_queue);
Cedric Roux's avatar
 
Cedric Roux committed
657
        itti_desc.tasks[i].message_in_queue = 0;
658

Cedric Roux's avatar
 
Cedric Roux committed
659
        // Initialize mutexes
660
        pthread_mutex_init (&itti_desc.tasks[i].message_queue_mutex, NULL);
661

Cedric Roux's avatar
 
Cedric Roux committed
662
        // Initialize Cond vars
663
        pthread_cond_init (&itti_desc.tasks[i].message_queue_cond_var, NULL);
664
#endif
665
    }
666

667
668
669
670
    /* 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
671
    }
672

673
    itti_dump_init (messages_definition_xml, dump_file_name);
Cedric Roux's avatar
 
Cedric Roux committed
674

675
    CHECK_INIT_RETURN(timer_init ());
Cedric Roux's avatar
 
Cedric Roux committed
676
677
678
679

    return 0;
}

680
681
void itti_wait_tasks_end(void) {
    int end = 0;
682
683
    int thread_id;
    task_id_t task_id;
684
685
686
    int ready_tasks;
    int result;
    int retries = 10;
687
688
689
690
691
692
693
694

    itti_desc.thread_handling_signals = pthread_self ();

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

695
696
697
    do {
        ready_tasks = 0;

698
699
        task_id = TASK_FIRST;
        for (thread_id = THREAD_FIRST; thread_id < itti_desc.task_max; thread_id++) {
700
            /* Skip tasks which are not running */
701
702
703
704
705
            if (itti_desc.threads[thread_id].task_state == TASK_STATE_READY) {
                while (thread_id != TASK_GET_THREAD_ID(task_id))
                {
                    task_id++;
                }
706

707
                result = pthread_tryjoin_np (itti_desc.threads[thread_id].task_thread, NULL);
708

709
                ITTI_DEBUG("Thread %s join status %d\n", itti_get_task_name(task_id), result);
710
711
712

                if (result == 0) {
                    /* Thread has terminated */
713
                    itti_desc.threads[thread_id].task_state = TASK_STATE_ENDED;
714
715
716
717
718
719
720
721
722
                }
                else {
                    /* Thread is still running, count it */
                    ready_tasks++;
                }
            }
        }
        if (ready_tasks > 0) {
            usleep (100 * 1000);
723
        }
724
725
726
727
728
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
729
    }
730
731

    itti_dump_exit();
732
733
734
}

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

737
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
Cedric Roux's avatar
 
Cedric Roux committed
738

739
    itti_send_broadcast_message (terminate_message_p);
Cedric Roux's avatar
 
Cedric Roux committed
740
}