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

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

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

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

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

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

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

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

31
#define _GNU_SOURCE
32 33 34 35 36 37
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
38
#include <signal.h>
39 40 41 42 43 44 45 46 47 48 49

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

#include "intertask_interface.h"
#include "intertask_interface_dump.h"
/* Includes "intertask_interface_init.h" to check prototype coherence, but disable threads and messages information generation */
#define CHECK_PROTOTYPE_ONLY
#include "intertask_interface_init.h"
#undef CHECK_PROTOTYPE_ONLY

50
#include "signals.h"
51 52 53 54 55 56 57 58 59 60 61 62 63
#include "timer.h"

int itti_debug = 1;

#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 {
64
    TASK_STATE_NOT_CONFIGURED, TASK_STATE_STARTING, TASK_STATE_READY, TASK_STATE_ENDED, TASK_STATE_MAX,
65 66 67 68 69 70
} task_state_t;

/* This list acts as a FIFO of messages received by tasks (RRC, NAS, ...) */
struct message_list_s {
    STAILQ_ENTRY(message_list_s) next_element;

71
    MessageDef *msg; ///< Pointer to the message
72

73 74
    message_number_t message_number; ///< Unique message number
    uint32_t message_priority; ///< Message priority
75 76 77 78
};

typedef struct task_desc_s {
    /* Queue of messages belonging to the task */
79 80
    STAILQ_HEAD(message_queue_head, message_list_s)
    message_queue;
81 82

    /* Number of messages in the queue */
83
    volatile uint32_t message_in_queue;
84
    /* Mutex for the message queue */
85
    pthread_mutex_t message_queue_mutex;
86
    /* Conditional var for message queue and task synchro */
87 88
    pthread_cond_t message_queue_cond_var;
    pthread_t task_thread;
89 90 91 92 93 94
    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 */
95
    message_number_t message_number __attribute__((aligned(8)));
96 97 98 99

    thread_id_t thread_max;
    MessagesIds messages_id_max;

100 101
    pthread_t thread_handling_signals;

102 103 104 105 106 107
    const char * const *threads_name;
    const message_info_t *messages_info;
};

static struct itti_desc_s itti_desc;

108
static inline message_number_t itti_increment_message_number(void) {
109 110 111 112
    /* Atomic operation supported by GCC: returns the current message number
     * and then increment it by 1.
     * This can be done without mutex.
     */
113
    return __sync_fetch_and_add (&itti_desc.message_number, 1);
114 115
}

116
static inline uint32_t itti_get_message_priority(MessagesIds message_id) {
117 118 119 120 121
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

122
char *itti_get_message_name(MessagesIds message_id) {
123 124 125 126 127
    DevCheck(message_id < itti_desc.messages_id_max, message_id, itti_desc.messages_id_max, 0);

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

128 129
int itti_send_broadcast_message(MessageDef *message_p) {
    thread_id_t origin_thread_id;
130 131
    uint32_t i;
    int ret = 0;
132
    int result;
133

134 135 136 137
    if (message_p == NULL) {
        ITTI_ERROR("Message to broadcast is NULL (%s:%d)\n", __FILE__, __LINE__);
        return -1;
    }
138

139
    origin_thread_id = TASK_GET_THREAD_ID(message_p->header.originTaskId);
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    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));

                if (new_message_p == NULL) {
                    ITTI_ERROR("Failed to allocate memory (%s:%d)\n", __FILE__, __LINE__);
                    return -1;
                }
                memcpy (new_message_p, message_p, sizeof(MessageDef));
                result = itti_send_msg_to_task (TASK_SHIFT_THREAD_ID(i), INSTANCE_DEFAULT, new_message_p);
                if (result < 0) {
                    ITTI_ERROR("Failed to send broadcast message (%s) to queue (%u:%s)\n",
                               itti_desc.messages_info[message_p->header.messageId].name, i, itti_desc.threads_name[i]);
                    ret = result;
                    free (new_message_p);
                }
162
            }
163 164
        }
    }
165
    free (message_p);
166 167 168 169

    return ret;
}

170
inline MessageDef *itti_alloc_new_message(task_id_t origin_task_id, MessagesIds message_id) {
171 172
    MessageDef *temp = NULL;

173 174
    if (message_id >= itti_desc.messages_id_max) {
        ITTI_ERROR("Invalid message id %d (%s:%d)\n", message_id, __FILE__, __LINE__);
175 176 177
        return NULL;
    }

178
    temp = calloc (1, MESSAGE_SIZE(message_id));
179 180

    if (temp == NULL) {
181
        ITTI_ERROR("Cannot allocate memory for new message (%s:%d)\n", __FILE__, __LINE__);
182 183 184 185 186 187 188 189 190 191
        return NULL;
    }

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

    return temp;
}

192 193 194 195 196 197
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;
198

199
    if (thread_id >= itti_desc.thread_max) {
200 201 202 203 204 205 206 207 208 209 210
        return -1;
    }

    message->header.destinationTaskId = task_id;
    message->header.instance = instance;
    message_id = message->header.messageId;

    DevAssert(message != NULL);
    DevCheck(thread_id < itti_desc.thread_max, thread_id, 0, 0);
    DevCheck(message_id < itti_desc.messages_id_max, itti_desc.messages_id_max, message_id, 0);

211
    priority = itti_get_message_priority (message_id);
212 213

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

    /* We cannot send a message if the task is not running */
217 218
    DevCheck(itti_desc.tasks[thread_id].task_state == TASK_STATE_READY, itti_desc.tasks[thread_id].task_state,
             TASK_STATE_READY, thread_id);
219 220

    /* Check the number of messages in the queue */
221 222
    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,
223 224 225
             itti_desc.tasks[thread_id].message_in_queue);

    /* Allocate new list element */
226 227
    if ((new = (struct message_list_s *) malloc (sizeof(struct message_list_s))) == NULL) {
        ITTI_ERROR("Cannot allocate memory for new message (%s:%d)\n", __FILE__, __LINE__);
228 229 230 231
        return -1;
    }

    /* Increment the global message number */
232
    message_number = itti_increment_message_number ();
233 234

    /* Fill in members */
235 236
    new->msg = message;
    new->message_number = message_number;
237 238
    new->message_priority = priority;

239 240
    itti_dump_queue_message (message_number, message, itti_desc.messages_info[message_id].name,
                             MESSAGE_SIZE(message_id));
241

242 243 244 245
    if (STAILQ_EMPTY (&itti_desc.tasks[thread_id].message_queue)) {
        STAILQ_INSERT_HEAD (&itti_desc.tasks[thread_id].message_queue, new, next_element);
    }
    else {
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
//         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) {
264
        STAILQ_INSERT_TAIL (&itti_desc.tasks[thread_id].message_queue, new, next_element);
265 266 267 268 269 270 271 272 273 274
//         } 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 */
275
        pthread_cond_signal (&itti_desc.tasks[thread_id].message_queue_cond_var);
276 277
    }
    /* Release the mutex */
278 279 280 281
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
    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]);
282 283 284
    return 0;
}

285
void itti_receive_msg(task_id_t task_id, MessageDef **received_msg) {
286 287 288 289 290 291
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

    DevCheck(thread_id < itti_desc.thread_max, thread_id, 0, 0);
    DevAssert(received_msg != NULL);

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

    if (itti_desc.tasks[thread_id].message_in_queue == 0) {
295
        ITTI_DEBUG("Message in queue[(%u:%s)] == 0, waiting\n", thread_id, itti_desc.threads_name[thread_id]);
296
        // Wait while list == 0
297 298
        pthread_cond_wait (&itti_desc.tasks[thread_id].message_queue_cond_var,
                           &itti_desc.tasks[thread_id].message_queue_mutex);
299 300 301 302
        ITTI_DEBUG("Receiver queue[(%u:%s)] got new message notification for task %x\n",
                   thread_id, itti_desc.threads_name[thread_id], task_id);
    }

303 304
    if (!STAILQ_EMPTY (&itti_desc.tasks[thread_id].message_queue)) {
        struct message_list_s *temp = STAILQ_FIRST (&itti_desc.tasks[thread_id].message_queue);
305 306 307 308 309

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

        /* Remove message from queue */
310 311
        STAILQ_REMOVE_HEAD (&itti_desc.tasks[thread_id].message_queue, next_element);
        free (temp);
312 313 314
        itti_desc.tasks[thread_id].message_in_queue--;
    }
    // Release the mutex
315
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
316 317
}

318
void itti_poll_msg(task_id_t task_id, instance_t instance, MessageDef **received_msg) {
319 320
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

321 322
    DevCheck(thread_id < itti_desc.thread_max, thread_id, 0, 0);
    DevAssert(received_msg != NULL);
323 324 325

    *received_msg = NULL;

326
    if (itti_desc.tasks[thread_id].message_in_queue != 0) {
327 328 329 330 331
        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);

332
        STAILQ_FOREACH (temp, &itti_desc.tasks[thread_id].message_queue, next_element)
333 334
        {
            if ((temp->msg->header.destinationTaskId == task_id)
335
                    && ((instance == INSTANCE_ALL) || (temp->msg->header.instance == instance))) {
336 337 338 339
                /* Update received_msg reference */
                *received_msg = temp->msg;

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

344 345 346
                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);
347 348 349 350 351 352 353 354
                break;
            }
        }

        // Release the mutex
        pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
    }

355
    if (*received_msg == NULL) {
356 357 358 359
        ITTI_DEBUG("No message in queue[(%u:%s)] for task %x\n", thread_id, itti_desc.threads_name[thread_id], task_id);
    }
}

360
int itti_create_task(task_id_t task_id, void *(*start_routine)(void *), void *args_p) {
361 362 363 364 365 366 367
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

    DevAssert(start_routine != NULL);
    DevCheck(thread_id < itti_desc.thread_max, thread_id, 0, 0);

    if (itti_desc.tasks[thread_id].task_state != TASK_STATE_NOT_CONFIGURED) {
        ITTI_ERROR("You are attempting to start an already configured thread"
368 369
        " for %s thread\n",
                   itti_desc.threads_name[thread_id]);
370 371 372 373 374
        return -1;
    }

    itti_desc.tasks[thread_id].task_state = TASK_STATE_STARTING;

375 376 377
    if (pthread_create (&itti_desc.tasks[thread_id].task_thread, NULL, start_routine, args_p) < 0) {
        ITTI_ERROR("Failed to initialize %s thread: %s:%d\n",
                   itti_desc.threads_name[thread_id], strerror(errno), errno);
378 379 380 381
        return -1;
    }

    /* Wait till the thread is completely ready */
382 383
    while (itti_desc.tasks[thread_id].task_state != TASK_STATE_READY)
        ;
384 385 386
    return 0;
}

387
void itti_mark_task_ready(task_id_t task_id) {
388 389 390 391
    thread_id_t thread_id = TASK_GET_THREAD_ID(task_id);

    DevCheck(thread_id < itti_desc.thread_max, thread_id, 0, 0);
    // Lock the mutex to get exclusive access to the list
392
    pthread_mutex_lock (&itti_desc.tasks[thread_id].message_queue_mutex);
393 394
    itti_desc.tasks[thread_id].task_state = TASK_STATE_READY;
    // Release the mutex
395 396 397
    pthread_mutex_unlock (&itti_desc.tasks[thread_id].message_queue_mutex);
}

398 399 400 401
void itti_exit_task(void) {
    pthread_exit (NULL);
}

402 403 404 405 406 407 408 409 410
void itti_terminate_tasks(task_id_t task_id) {
    // Sends Terminate signals to all tasks.
    itti_send_terminate_message (task_id);

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

    pthread_exit (NULL);
411 412
}

413 414
int itti_init(thread_id_t thread_max, MessagesIds messages_id_max, const char * const *threads_name,
              const message_info_t *messages_info, const char * const messages_definition_xml) {
415 416 417
    int i;
    itti_desc.message_number = 0;

418 419
    CHECK_INIT_RETURN(signal_init());

420 421 422
    /* Saves threads and messages max values */
    itti_desc.thread_max = thread_max;
    itti_desc.messages_id_max = messages_id_max;
423
    itti_desc.thread_handling_signals = -1;
424 425 426 427
    itti_desc.threads_name = threads_name;
    itti_desc.messages_info = messages_info;

    /* Allocates memory for tasks info */
428
    itti_desc.tasks = calloc (itti_desc.thread_max, sizeof(task_desc_t));
429 430 431

    /* Initializing each queue and related stuff */
    for (i = THREAD_FIRST; i < itti_desc.thread_max; i++) {
432
        STAILQ_INIT (&itti_desc.tasks[i].message_queue);
433 434
        itti_desc.tasks[i].message_in_queue = 0;
        // Initialize mutexes
435
        pthread_mutex_init (&itti_desc.tasks[i].message_queue_mutex, NULL);
436
        // Initialize Cond vars
437
        pthread_cond_init (&itti_desc.tasks[i].message_queue_cond_var, NULL);
438 439
        itti_desc.tasks[i].task_state = TASK_STATE_NOT_CONFIGURED;
    }
440
    itti_dump_init (messages_definition_xml);
441

442
    CHECK_INIT_RETURN(timer_init ());
443 444 445 446

    return 0;
}

447 448 449
void itti_wait_tasks_end(void) {
    int end = 0;
    int i;
450 451 452
    int ready_tasks;
    int result;
    int retries = 10;
453 454 455 456 457 458 459 460

    itti_desc.thread_handling_signals = pthread_self ();

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

461 462 463 464 465 466
    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) {
467

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
                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);
484
        }
485 486 487 488 489
    } while ((ready_tasks > 0) && (retries--));

    if (ready_tasks > 0) {
        ITTI_DEBUG("Some threads are still running, force exit\n");
        exit (0);
490 491 492 493
    }
}

void itti_send_terminate_message(task_id_t task_id) {
494 495
    MessageDef *terminate_message_p;

496
    terminate_message_p = itti_alloc_new_message (task_id, TERMINATE_MESSAGE);
497

498
    itti_send_broadcast_message (terminate_message_p);
499
}