intertask_interface_dump.c 30.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/*******************************************************************************

  Eurecom OpenAirInterface
  Copyright(c) 1999 - 2013 Eurecom

  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.

  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.

  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.

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

  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

*******************************************************************************/

/** @brief Intertask Interface Signal Dumper
32
 * Allows users to connect their itti_analyzer to this process and dump
33 34 35 36 37 38 39 40 41 42 43 44
 * signals exchanged between tasks.
 * @author Sebastien Roux <sebastien.roux@eurecom.fr>
 */

#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <error.h>
45
#include <sched.h>
46 47 48 49 50 51 52

#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/select.h>
#include <sys/types.h>
#include <arpa/inet.h>

53 54
#include <sys/eventfd.h>

55
#include "assertions.h"
56
#include "liblfds611.h"
57 58 59 60

#include "intertask_interface.h"
#include "intertask_interface_dump.h"

61
#if defined(OAI_EMU) || defined(RTAI)
62 63 64
#include "vcd_signal_dumper.h"
#endif

65
#define SIGNAL_NAME_LENGTH  48
66

67
static const int itti_dump_debug = 0; // 0x8 | 0x4 | 0x2;
68

69
#ifdef RTAI
70
# define ITTI_DUMP_DEBUG(m, x, args...) do { if ((m) & itti_dump_debug) rt_printk("[ITTI_DUMP][D]"x, ##args); } \
71 72
    while(0)
#else
73
# define ITTI_DUMP_DEBUG(m, x, args...) do { if ((m) & itti_dump_debug) fprintf(stdout, "[ITTI_DUMP][D]"x, ##args); } \
74
    while(0)
75
#endif
76 77
#define ITTI_DUMP_ERROR(x, args...) do { fprintf(stdout, "[ITTI_DUMP][E]"x, ##args); } \
    while(0)
78

79 80 81 82
#ifndef EFD_SEMAPHORE
# define KERNEL_VERSION_PRE_2_6_30 1
#endif

Cedric Roux's avatar
Cedric Roux committed
83 84 85 86
/* Message sent is an intertask dump type */
#define ITTI_DUMP_MESSAGE_TYPE      0x1
#define ITTI_STATISTIC_MESSAGE_TYPE 0x2
#define ITTI_DUMP_XML_DEFINITION    0x3
87 88
/* This signal is not meant to be used by remote analyzer */
#define ITTI_DUMP_EXIT_SIGNAL       0x4
Cedric Roux's avatar
Cedric Roux committed
89

90
typedef struct itti_dump_queue_item_s {
91 92 93 94 95 96
    MessageDef *data;
    uint32_t    data_size;
    uint32_t    message_number;
    char        message_name[SIGNAL_NAME_LENGTH];
    uint32_t    message_type;
    uint32_t    message_size;
97
} itti_dump_queue_item_t;
98 99 100 101 102 103 104

typedef struct {
    int      sd;
    uint32_t last_message_number;
} itti_client_desc_t;

typedef struct itti_desc_s {
105 106 107
    /* Asynchronous thread that write to file/accept new clients */
    pthread_t      itti_acceptor_thread;
    pthread_attr_t attr;
108 109 110

    /* List of messages to dump.
     * NOTE: we limit the size of this queue to retain only the last exchanged
111
     * messages. The size can be increased by setting up the ITTI_QUEUE_MAX_ELEMENTS
112 113
     * in mme_default_values.h or by putting a custom in the configuration file.
     */
114 115
    struct lfds611_ringbuffer_state *itti_message_queue;

116 117
    int nb_connected;

118
#ifndef RTAI
119 120
    /* Event fd used to notify new messages (semaphore) */
    int event_fd;
121 122 123
#else
    unsigned long messages_in_queue __attribute__((aligned(8)));
#endif
124 125 126

    int itti_listen_socket;

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
    itti_client_desc_t itti_clients[ITTI_DUMP_MAX_CON];
} itti_desc_t;

typedef struct {
    /* The size of this structure */
    uint32_t message_size;
    uint32_t message_type;
} itti_socket_header_t;

typedef struct {
    itti_socket_header_t header;

    uint32_t message_number;
    char signal_name[SIGNAL_NAME_LENGTH];

    /* Message payload is added here, this struct is used as an header */
} itti_dump_message_t;

typedef struct {
    itti_socket_header_t header;
    
} itti_statistic_message_t;

150
static itti_desc_t itti_dump_queue;
151
static FILE *dump_file = NULL;
152
static int itti_dump_running = 1;
153

154
static volatile uint32_t pending_messages = 0;
155

156 157
/*------------------------------------------------------------------------------*/
static int itti_dump_send_message(int sd, itti_dump_queue_item_t *message)
158 159
{
    itti_dump_message_t *new_message;
160 161
    ssize_t bytes_sent = 0, total_sent = 0;
    uint8_t *data_ptr;
162 163

    /* Allocate memory for message header and payload */
164
    size_t size = sizeof(itti_dump_message_t) + message->data_size;
165

166 167
    AssertFatal (sd > 0, "Socket descriptor (%d) is invalid!\n", sd);
    AssertFatal (message != NULL, "Message is NULL!\n");
168 169

    new_message = calloc(1, size);
170
    AssertFatal (new_message != NULL, "New message allocation failed!\n");
171 172 173 174 175 176 177 178 179 180 181

    /* Preparing the header */
    new_message->header.message_size = size;
    new_message->header.message_type = ITTI_DUMP_MESSAGE_TYPE;

    new_message->message_number = message->message_number;
    /* Copy the name, but leaves last byte set to 0 in case name is too long */
    memcpy(new_message->signal_name, message->message_name, SIGNAL_NAME_LENGTH - 1);
    /* Appends message payload */
    memcpy(&new_message[1], message->data, message->data_size);

182 183 184 185 186
    data_ptr = (uint8_t *)&new_message[0];

    do {
        bytes_sent = send(sd, &data_ptr[total_sent], size - total_sent, 0);
        if (bytes_sent < 0) {
187
            ITTI_DUMP_ERROR("[%d] Failed to send %zu bytes to socket (%d:%s)\n",
188 189 190 191 192 193
                       sd, size, errno, strerror(errno));
            free(new_message);
            return -1;
        }
        total_sent += bytes_sent;
    } while (total_sent != size);
194 195

    free(new_message);
196
    return total_sent;
197 198
}

199
static int itti_dump_fwrite_message(itti_dump_queue_item_t *message)
200 201 202
{
    itti_socket_header_t header;

203
    if ((dump_file != NULL) && (message != NULL)) {
204 205 206 207 208 209 210 211

        header.message_size = message->message_size + sizeof(itti_dump_message_t);
        header.message_type = message->message_type;

        fwrite (&header, sizeof(itti_socket_header_t), 1, dump_file);
        fwrite (&message->message_number, sizeof(message->message_number), 1, dump_file);
        fwrite (message->message_name, sizeof(message->message_name), 1, dump_file);
        fwrite (message->data, message->data_size, 1, dump_file);
212 213 214
// #if !defined(RTAI)
        fflush (dump_file);
// #endif
215
        return (1);
216
    }
217
    return (0);
218 219
}

220 221 222
static int itti_dump_send_xml_definition(const int sd, const char *message_definition_xml,
                                         const uint32_t message_definition_xml_length)
{
223 224 225 226 227
    itti_socket_header_t *itti_dump_message;
    /* Allocate memory for message header and payload */
    size_t itti_dump_message_size;
    ssize_t bytes_sent = 0, total_sent = 0;
    uint8_t *data_ptr;
228

229 230
    AssertFatal (sd > 0, "Socket descriptor (%d) is invalid!\n", sd);
    AssertFatal (message_definition_xml != NULL, "Message definition XML is NULL!\n");
231

232 233 234 235
    itti_dump_message_size = sizeof(itti_socket_header_t) + message_definition_xml_length;

    itti_dump_message = calloc(1, itti_dump_message_size);

236
    ITTI_DUMP_DEBUG(0x2, "[%d] Sending XML definition message of size %zu to observer peer\n",
237 238 239 240 241 242 243 244 245 246 247 248 249
               sd, itti_dump_message_size);

    itti_dump_message->message_size = itti_dump_message_size;
    itti_dump_message->message_type = ITTI_DUMP_XML_DEFINITION;

    /* Copying message definition */
    memcpy(&itti_dump_message[1], message_definition_xml, message_definition_xml_length);

    data_ptr = (uint8_t *)&itti_dump_message[0];

    do {
        bytes_sent = send(sd, &data_ptr[total_sent], itti_dump_message_size - total_sent, 0);
        if (bytes_sent < 0) {
250
            ITTI_DUMP_ERROR("[%d] Failed to send %zu bytes to socket (%d:%s)\n",
251 252 253 254 255 256 257 258 259
                       sd, itti_dump_message_size, errno, strerror(errno));
            free(itti_dump_message);
            return -1;
        }
        total_sent += bytes_sent;
    } while (total_sent != itti_dump_message_size);

    free(itti_dump_message);

260 261 262
    return 0;
}

263 264 265 266 267 268
static void itti_dump_user_data_delete_function(void *user_data, void *user_state)
{
    if (user_data != NULL)
    {
        itti_dump_queue_item_t *item;
        task_id_t task_id;
269
        int result;
270 271 272 273 274

        item = (itti_dump_queue_item_t *)user_data;

        if (item->data != NULL)
        {
275

276
            task_id = ITTI_MSG_ORIGIN_ID(item->data);
277 278
            result = itti_free(task_id, item->data);
            AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
279 280 281 282 283
        }
        else
        {
            task_id = TASK_UNKNOWN;
        }
284 285
        result = itti_free(task_id, item);
        AssertFatal (result == EXIT_SUCCESS, "Failed to free memory (%d)!\n", result);
286 287 288
    }
}

289
static int itti_dump_enqueue_message(itti_dump_queue_item_t *new, uint32_t message_size,
290
                                     uint32_t message_type)
Cedric Roux's avatar
Cedric Roux committed
291
{
292
    struct lfds611_freelist_element *new_queue_element = NULL;
293
    int overwrite_flag;
294
    AssertFatal (new != NULL, "Message to queue is NULL!\n");
Cedric Roux's avatar
Cedric Roux committed
295

296
#if defined(OAI_EMU) || defined(RTAI)
297 298 299
    vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE, VCD_FUNCTION_IN);
#endif

300 301
    new->message_type = message_type;
    new->message_size = message_size;
Cedric Roux's avatar
Cedric Roux committed
302

303 304 305 306 307 308
    ITTI_DUMP_DEBUG (0x1, " itti_dump_enqueue_message: lfds611_ringbuffer_get_write_element\n");
    new_queue_element = lfds611_ringbuffer_get_write_element (itti_dump_queue.itti_message_queue, &new_queue_element, &overwrite_flag);

    if (overwrite_flag != 0)
    {
        void *old = NULL;
Cedric Roux's avatar
Cedric Roux committed
309

310 311 312 313
        lfds611_freelist_get_user_data_from_element(new_queue_element, &old);
        ITTI_DUMP_DEBUG (0x4, " overwrite_flag set, freeing old data %p %p\n", new_queue_element, old);
        itti_dump_user_data_delete_function (old, NULL);
    }
Cedric Roux's avatar
Cedric Roux committed
314

315 316
    lfds611_freelist_set_user_data_in_element(new_queue_element, (void *) new);
    lfds611_ringbuffer_put_write_element(itti_dump_queue.itti_message_queue, new_queue_element);
Cedric Roux's avatar
Cedric Roux committed
317

318 319
    if (overwrite_flag == 0)
    {
320
#ifdef RTAI
321
        __sync_fetch_and_add (&itti_dump_queue.messages_in_queue, 1);
322
#else
323 324 325
        {
            ssize_t   write_ret;
            eventfd_t sem_counter = 1;
326

327 328
            /* Call to write for an event fd must be of 8 bytes */
            write_ret = write(itti_dump_queue.event_fd, &sem_counter, sizeof(sem_counter));
329
            AssertFatal (write_ret == sizeof(sem_counter), "Write to dump event failed (%d/%d)!\n", (int) write_ret, (int) sizeof(sem_counter));
330
        }
331
#endif
332 333 334 335
        __sync_fetch_and_add (&pending_messages, 1);
    }

    ITTI_DUMP_DEBUG (0x2, " Added element to queue %p %p, pending %u, type %u\n", new_queue_element, new, pending_messages, message_type);
336

337
#if defined(OAI_EMU) || defined(RTAI)
338 339
    vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE, VCD_FUNCTION_OUT);
#endif
Cedric Roux's avatar
Cedric Roux committed
340 341 342 343

    return 0;
}

344
static void itti_dump_socket_exit(void)
345
{
346 347
#ifndef RTAI
    close(itti_dump_queue.event_fd);
348
#endif
349
    close(itti_dump_queue.itti_listen_socket);
350

351 352
    /* Leave the thread as we detected end signal */
    pthread_exit(NULL);
353 354
}

355
static int itti_dump_flush_ring_buffer(int flush_all)
356 357
{
    struct lfds611_freelist_element *element = NULL;
358 359 360
    void   *user_data;
    int     j;
    int     consumer;
361 362 363

#ifdef RTAI
    unsigned long number_of_messages;
364
#endif
365

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    /* Check if there is a least one consumer */
    consumer = 0;
    if (dump_file != NULL)
    {
        consumer = 1;
    }
    else
    {
        for (j = 0; j < ITTI_DUMP_MAX_CON; j++) {
            if (itti_dump_queue.itti_clients[j].sd > 0) {
                consumer = 1;
                break;
            }
        }
    }
381

382 383 384 385
    if (consumer > 0)
    {
#ifdef RTAI
        number_of_messages = itti_dump_queue.messages_in_queue;
386

387 388 389 390 391
        ITTI_DUMP_DEBUG(0x4, "%lu elements in queue\n", number_of_messages);

        if (number_of_messages == 0) {
            return (consumer);
        }
392

393
        __sync_sub_and_fetch(&itti_dump_queue.messages_in_queue, number_of_messages);
394 395
#endif

396 397 398
        do {
            /* Acquire the ring element */
            lfds611_ringbuffer_get_read_element(itti_dump_queue.itti_message_queue, &element);
399

400
            __sync_fetch_and_sub (&pending_messages, 1);
401

402 403 404 405 406 407 408 409
            if (element == NULL)
            {
                if (flush_all != 0)
                {
                    flush_all = 0;
                }
                else
                {
410
                    AssertFatal (0, "Dump event with no data!\n");
411 412 413 414 415 416
                }
            }
            else
            {
                /* Retrieve user part of the message */
                lfds611_freelist_get_user_data_from_element(element, &user_data);
417

418
                ITTI_DUMP_DEBUG (0x2, " removed element from queue %p %p, pending %u\n", element, user_data, pending_messages);
419

420 421 422 423 424
                if (((itti_dump_queue_item_t *)user_data)->message_type == ITTI_DUMP_EXIT_SIGNAL)
                {
                    lfds611_ringbuffer_put_read_element(itti_dump_queue.itti_message_queue, element);
                    itti_dump_socket_exit();
                }
425

426 427
                /* Write message to file */
                itti_dump_fwrite_message((itti_dump_queue_item_t *)user_data);
428

429 430 431 432 433 434 435
                /* Send message to remote analyzer */
                for (j = 0; j < ITTI_DUMP_MAX_CON; j++) {
                    if (itti_dump_queue.itti_clients[j].sd > 0) {
                        itti_dump_send_message(itti_dump_queue.itti_clients[j].sd,
                                                (itti_dump_queue_item_t *)user_data);
                    }
                }
436

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
                itti_dump_user_data_delete_function (user_data, NULL);
                lfds611_freelist_set_user_data_in_element(element, NULL);

                /* We have finished with this element, reinsert it in the ring buffer */
                lfds611_ringbuffer_put_read_element(itti_dump_queue.itti_message_queue, element);
            }
        } while(flush_all
    #ifdef RTAI
                && --number_of_messages
    #endif
                );
    }

    return (consumer);
}

static int itti_dump_handle_new_connection(int sd, const char *xml_definition, uint32_t xml_definition_length)
{
    if (itti_dump_queue.nb_connected < ITTI_DUMP_MAX_CON) {
        uint8_t i;

        for (i = 0; i < ITTI_DUMP_MAX_CON; i++) {
            /* Let's find a place to store the new client */
            if (itti_dump_queue.itti_clients[i].sd == -1) {
                break;
462 463 464
            }
        }

465 466
        ITTI_DUMP_DEBUG(0x2, " Found place to store new connection: %d\n", i);

467
        AssertFatal (i < ITTI_DUMP_MAX_CON, "No more connection available (%d/%d) for socked %d!\n", i, ITTI_DUMP_MAX_CON, sd);
468 469 470 471 472

        ITTI_DUMP_DEBUG(0x2, " Socket %d accepted\n", sd);

        /* Send the XML message definition */
        if (itti_dump_send_xml_definition(sd, xml_definition, xml_definition_length) < 0) {
473
            AssertError (0, {}, "Failed to send XML definition!\n");
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
            close (sd);
            return -1;
        }

        itti_dump_queue.itti_clients[i].sd = sd;
        itti_dump_queue.nb_connected++;
    } else {
        ITTI_DUMP_DEBUG(0x2, " Socket %d rejected\n", sd);
        /* We have reached max number of users connected...
         * Reject the connection.
         */
        close (sd);
        return -1;
    }

    return 0;
490 491
}

492 493 494 495 496 497 498
static void *itti_dump_socket(void *arg_p)
{
    uint32_t message_definition_xml_length;
    char *message_definition_xml;
    int rc;
    int itti_listen_socket, max_sd;
    int on = 1;
499
    fd_set read_set, working_set;
500 501
    struct sockaddr_in servaddr; /* socket address structure */

502 503 504 505 506
    struct timeval *timeout_p = NULL;
#ifdef RTAI
    struct timeval  timeout;
#endif

507
    ITTI_DUMP_DEBUG(0x2, " Creating TCP dump socket on port %u\n", ITTI_PORT);
508 509

    message_definition_xml = (char *)arg_p;
510
    AssertFatal (message_definition_xml != NULL, "Message definition XML is NULL!\n");
511 512 513 514

    message_definition_xml_length = strlen(message_definition_xml) + 1;

    if ((itti_listen_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0) {
515
        ITTI_DUMP_ERROR(" ocket creation failed (%d:%s)\n", errno, strerror(errno));
516 517 518 519 520 521 522
        pthread_exit(NULL);
    }

    /* Allow socket reuse */
    rc = setsockopt(itti_listen_socket, SOL_SOCKET, SO_REUSEADDR,
                    (char *)&on, sizeof(on));
    if (rc < 0) {
523
        ITTI_DUMP_ERROR(" setsockopt SO_REUSEADDR failed (%d:%s)\n", errno, strerror(errno));
524 525 526 527 528 529 530 531 532
        close(itti_listen_socket);
        pthread_exit(NULL);
    }

    /* Set socket to be non-blocking.
     * NOTE: sockets accepted will inherit this option.
     */
    rc = ioctl(itti_listen_socket, FIONBIO, (char *)&on);
    if (rc < 0) {
533
        ITTI_DUMP_ERROR(" ioctl FIONBIO (non-blocking) failed (%d:%s)\n", errno, strerror(errno));
534 535 536 537 538 539 540 541 542 543
        close(itti_listen_socket);
        pthread_exit(NULL);
    }

    memset(&servaddr, 0, sizeof(servaddr));
    servaddr.sin_family      = AF_INET;
    servaddr.sin_addr.s_addr = htonl(INADDR_ANY);
    servaddr.sin_port        = htons(ITTI_PORT);

    if (bind(itti_listen_socket, (struct sockaddr *) &servaddr,
544
             sizeof(servaddr)) < 0) {
545
        ITTI_DUMP_ERROR(" Bind failed (%d:%s)\n", errno, strerror(errno));
546 547
        pthread_exit(NULL);
    }
548
    if (listen(itti_listen_socket, 5) < 0) {
549
        ITTI_DUMP_ERROR(" Listen failed (%d:%s)\n", errno, strerror(errno));
550 551 552
        pthread_exit(NULL);
    }

553 554 555 556 557
    FD_ZERO(&read_set);

    /* Add the listener */
    FD_SET(itti_listen_socket, &read_set);

558
#ifndef RTAI
559 560 561 562 563
    /* Add the event fd */
    FD_SET(itti_dump_queue.event_fd, &read_set);

    /* Max of both sd */
    max_sd = itti_listen_socket > itti_dump_queue.event_fd ? itti_listen_socket : itti_dump_queue.event_fd;
564 565 566
#else
    max_sd = itti_listen_socket;
#endif
567 568

    itti_dump_queue.itti_listen_socket = itti_listen_socket;
569 570 571 572 573 574 575 576 577

    /* Loop waiting for incoming connects or for incoming data
     * on any of the connected sockets.
     */
    while (1) {
        int desc_ready;
        int client_socket = -1;
        int i;

578
        memcpy(&working_set, &read_set, sizeof(read_set));
579 580 581 582 583 584 585 586
#ifdef RTAI
        timeout.tv_sec  = 0;
        timeout.tv_usec = 100000;

        timeout_p = &timeout;
#else
        timeout_p = NULL;
#endif
587 588 589 590

        /* No timeout: select blocks till a new event has to be handled
         * on sd's.
         */
591
        rc = select(max_sd + 1, &working_set, NULL, NULL, timeout_p);
592 593

        if (rc < 0) {
594
            ITTI_DUMP_ERROR(" select failed (%d:%s)\n", errno, strerror(errno));
595
            pthread_exit(NULL);
596 597
        } else if (rc == 0) {
            /* Timeout */
598 599 600 601 602 603 604 605 606 607 608 609
            if (itti_dump_flush_ring_buffer(1) == 0)
            {
                if (itti_dump_running)
                {
                    ITTI_DUMP_DEBUG (0x4, " No messages consumers, waiting ...\n");
                    usleep(100 * 1000);
                }
                else
                {
                    itti_dump_socket_exit();
                }
            }
610 611 612
        }

        desc_ready = rc;
613 614 615 616
        for (i = 0; i <= max_sd && desc_ready > 0; i++)
        {
            if (FD_ISSET(i, &working_set))
            {
617
                desc_ready -= 1;
618

619
#ifndef RTAI
620 621
                if (i == itti_dump_queue.event_fd) {
                    /* Notification of new element to dump from other tasks */
622 623
                    eventfd_t sem_counter;
                    ssize_t   read_ret;
624

625
                    /* Read will always return 1 for kernel versions > 2.6.30 */
626 627
                    read_ret = read (itti_dump_queue.event_fd, &sem_counter, sizeof(sem_counter));
                    if (read_ret < 0) {
628
                        ITTI_DUMP_ERROR(" Failed read for semaphore: %s\n", strerror(errno));
629 630
                        pthread_exit(NULL);
                    }
631
                    AssertFatal (read_ret == sizeof(sem_counter), "Failed to read from dump event FD (%d/%d)!\n", (int) read_ret, (int) sizeof(sem_counter));
632
#if defined(KERNEL_VERSION_PRE_2_6_30)
633
                    if (itti_dump_flush_ring_buffer(1) == 0)
634
#else
635
                    if (itti_dump_flush_ring_buffer(0) == 0)
636
#endif
637 638 639 640 641 642 643 644 645 646 647 648
                    {
                        if (itti_dump_running)
                        {
                            ITTI_DUMP_DEBUG (0x4, " No messages consumers, waiting ...\n");
                            usleep(100 * 1000);
#ifndef RTAI
                            {
                                ssize_t   write_ret;

                                sem_counter = 1;
                                /* Call to write for an event fd must be of 8 bytes */
                                write_ret = write(itti_dump_queue.event_fd, &sem_counter, sizeof(sem_counter));
649
                                AssertFatal (write_ret == sizeof(sem_counter), "Failed to write to dump event FD (%d/%d)!\n", (int) write_ret, (int) sem_counter);
650 651 652 653 654 655 656 657 658 659 660 661
                            }
#endif
                        }
                        else
                        {
                            itti_dump_socket_exit();
                        }
                    }
                    else
                    {
                        ITTI_DUMP_DEBUG(0x1, " Write element to file\n");
                    }
662 663 664
                } else
#endif
                if (i == itti_listen_socket) {
665 666 667 668 669
                    do {
                        client_socket = accept(itti_listen_socket, NULL, NULL);
                        if (client_socket < 0) {
                            if (errno == EWOULDBLOCK || errno == EAGAIN) {
                                /* No more new connection */
670
                                ITTI_DUMP_DEBUG(0x2, " No more new connection\n");
671 672
                                continue;
                            } else {
673
                                ITTI_DUMP_ERROR(" accept failed (%d:%s)\n", errno, strerror(errno));
674 675 676 677
                                pthread_exit(NULL);
                            }
                        }
                        if (itti_dump_handle_new_connection(client_socket, message_definition_xml,
678 679
                            message_definition_xml_length) == 0)
                        {
680 681 682
                            /* The socket has been accepted.
                             * We have to update the set to include this new sd.
                             */
683
                            FD_SET(client_socket, &read_set);
684 685 686 687 688 689 690 691 692 693
                            if (client_socket > max_sd)
                                max_sd = client_socket;
                        }
                    } while(client_socket != -1);
                } else {
                    /* For now the MME itti dumper should not receive data
                     * other than connection oriented (CLOSE).
                     */
                    uint8_t j;

694
                    ITTI_DUMP_DEBUG(0x2, " Socket %d disconnected\n", i);
695 696 697 698 699

                    /* Close the socket and update info related to this connection */
                    close(i);

                    for (j = 0; j < ITTI_DUMP_MAX_CON; j++) {
700
                        if (itti_dump_queue.itti_clients[j].sd == i)
701 702 703 704 705 706
                            break;
                    }

                    /* In case we don't find the matching sd in list of known
                     * connections -> assert.
                     */
707
                    AssertFatal (j < ITTI_DUMP_MAX_CON, "Connection index not found (%d/%d) for socked %d!\n", j, ITTI_DUMP_MAX_CON, i);
708 709 710 711

                    /* Re-initialize the socket to -1 so we can accept new
                     * incoming connections.
                     */
712 713 714
                    itti_dump_queue.itti_clients[j].sd                  = -1;
                    itti_dump_queue.itti_clients[j].last_message_number = 0;
                    itti_dump_queue.nb_connected--;
715 716

                    /* Remove the socket from the FD set and update the max sd */
717
                    FD_CLR(i, &read_set);
718 719
                    if (i == max_sd)
                    {
720
                        if (itti_dump_queue.nb_connected == 0) {
721 722 723
                            /* No more new connection max_sd = itti_listen_socket */
                            max_sd = itti_listen_socket;
                        } else {
724
                            while (FD_ISSET(max_sd, &read_set) == 0) {
725 726 727 728 729 730 731 732 733 734 735
                                max_sd -= 1;
                            }
                        }
                    }
                }
            }
        }
    }
    return NULL;
}

736 737 738 739 740 741
/*------------------------------------------------------------------------------*/
int itti_dump_queue_message(task_id_t sender_task,
                            message_number_t message_number,
                            MessageDef *message_p,
                            const char *message_name,
                            const uint32_t message_size)
742
{
743 744 745 746
    if (itti_dump_running)
    {
        itti_dump_queue_item_t *new;
        size_t message_name_length;
747

748 749
        AssertFatal (message_name != NULL, "Message name is NULL!\n");
        AssertFatal (message_p != NULL, "Message is NULL!\n");
750

751 752 753
#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE_MALLOC, VCD_FUNCTION_IN);
#endif
754
        new = itti_malloc(sender_task, TASK_MAX, sizeof(itti_dump_queue_item_t));
755 756 757
#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE_MALLOC, VCD_FUNCTION_OUT);
#endif
758

759 760 761
#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE_MALLOC, VCD_FUNCTION_IN);
#endif
762
        new->data = itti_malloc(sender_task, TASK_MAX, message_size);
763 764 765
#if defined(OAI_EMU) || defined(RTAI)
        vcd_signal_dumper_dump_function_by_name(VCD_SIGNAL_DUMPER_FUNCTIONS_ITTI_DUMP_ENQUEUE_MESSAGE_MALLOC, VCD_FUNCTION_OUT);
#endif
766

767 768 769
        memcpy(new->data, message_p, message_size);
        new->data_size       = message_size;
        new->message_number  = message_number;
770

771
        message_name_length = strlen(message_name) + 1;
772
        AssertError (message_name_length <= SIGNAL_NAME_LENGTH, {}, "Message name too long (%d/%d)!\n", (int) message_name_length, SIGNAL_NAME_LENGTH);
773
        memcpy(new->message_name, message_name, message_name_length);
774

775
        itti_dump_enqueue_message(new, message_size, ITTI_DUMP_MESSAGE_TYPE);
776 777 778 779 780
    }

    return 0;
}

781 782 783 784 785 786
/* This function should be called by each thread that will use the ring buffer */
void itti_dump_thread_use_ring_buffer(void)
{
    lfds611_ringbuffer_use(itti_dump_queue.itti_message_queue);
}

787
int itti_dump_init(const char * const messages_definition_xml, const char * const dump_file_name)
788
{
789
    int i, ret;
790 791
    struct sched_param scheduler_param;

792
    scheduler_param.sched_priority = sched_get_priority_min(SCHED_FIFO) + 1;
793

794 795
    if (dump_file_name != NULL)
    {
winckel's avatar
winckel committed
796
        dump_file = fopen(dump_file_name, "wb");
797 798 799

        if (dump_file == NULL)
        {
800
            ITTI_DUMP_ERROR(" can not open dump file \"%s\" (%d:%s)\n", dump_file_name, errno, strerror(errno));
801 802 803
        }
        else
        {
804
            /* Output the XML to file */
winckel's avatar
winckel committed
805
            uint32_t message_size = strlen(messages_definition_xml) + 1;
806 807
            itti_socket_header_t header;

winckel's avatar
winckel committed
808
            header.message_size = sizeof(itti_socket_header_t) + message_size;
809 810 811 812
            header.message_type = ITTI_DUMP_XML_DEFINITION;

            fwrite (&header, sizeof(itti_socket_header_t), 1, dump_file);
            fwrite (messages_definition_xml, message_size, 1, dump_file);
813
            fflush (dump_file);
814 815 816
        }
    }

817
    memset(&itti_dump_queue, 0, sizeof(itti_desc_t));
818

819
    ITTI_DUMP_DEBUG(0x2, " Creating new ring buffer for itti dump of %u elements\n",
820 821 822 823 824 825 826 827
                    ITTI_QUEUE_MAX_ELEMENTS);

    if (lfds611_ringbuffer_new(&itti_dump_queue.itti_message_queue,
                               ITTI_QUEUE_MAX_ELEMENTS,
                               NULL,
                               NULL) != 1)
    {
        /* Always assert on this condition */
828
        AssertFatal (0, " Failed to create ring buffer!\n");
829 830
    }

831 832 833
#ifdef RTAI
    itti_dump_queue.messages_in_queue = 0;
#else
834 835 836
# if defined(KERNEL_VERSION_PRE_2_6_30)
    itti_dump_queue.event_fd = eventfd(0, 0);
# else
837
    itti_dump_queue.event_fd = eventfd(0, EFD_SEMAPHORE);
838
# endif
839
    if (itti_dump_queue.event_fd == -1) {
840
        /* Always assert on this condition */
841
        AssertFatal (0, "eventfd failed: %s!\n", strerror(errno));
842
    }
843
#endif
844 845

    itti_dump_queue.nb_connected = 0;
846 847

    for(i = 0; i < ITTI_DUMP_MAX_CON; i++) {
848 849 850 851 852 853 854
        itti_dump_queue.itti_clients[i].sd = -1;
        itti_dump_queue.itti_clients[i].last_message_number = 0;
    }

    /* initialized with default attributes */
    ret = pthread_attr_init(&itti_dump_queue.attr);
    if (ret < 0) {
855
        AssertFatal (0, "pthread_attr_init failed (%d:%s)!\n", errno, strerror(errno));
856
    }
857

858
    ret = pthread_attr_setschedpolicy(&itti_dump_queue.attr, SCHED_FIFO);
859
    if (ret < 0) {
860
        AssertFatal (0, "pthread_attr_setschedpolicy (SCHED_IDLE) failed (%d:%s)!\n", errno, strerror(errno));
861 862 863
    }
    ret = pthread_attr_setschedparam(&itti_dump_queue.attr, &scheduler_param);
    if (ret < 0) {
864
        AssertFatal (0, "pthread_attr_setschedparam failed (%d:%s)!\n", errno, strerror(errno));
865
    }
866 867 868 869

    ret = pthread_create(&itti_dump_queue.itti_acceptor_thread, &itti_dump_queue.attr,
                         &itti_dump_socket, (void *)messages_definition_xml);
    if (ret < 0) {
870
        AssertFatal (0, "pthread_create failed (%d:%s)!\n", errno, strerror(errno));
871
    }
872

873 874
    return 0;
}
875 876 877

void itti_dump_exit(void)
{
878
    void *arg;
winckel's avatar
winckel committed
879 880
    itti_dump_queue_item_t *new;

881 882
    new = itti_malloc(TASK_UNKNOWN, TASK_UNKNOWN, sizeof(itti_dump_queue_item_t));
    memset(new, 0, sizeof(itti_dump_queue_item_t));
883

884 885 886
    /* Set a flag to stop recording message */
    itti_dump_running = 0;

887
    /* Send the exit signal to other thread */
winckel's avatar
winckel committed
888
    itti_dump_enqueue_message(new, 0, ITTI_DUMP_EXIT_SIGNAL);
889

890
    ITTI_DUMP_DEBUG(0x2, " waiting for dumper thread to finish\n");
891 892 893 894

    /* wait for the thread to terminate */
    pthread_join(itti_dump_queue.itti_acceptor_thread, &arg);

895
    ITTI_DUMP_DEBUG(0x2, " dumper thread correctly exited\n");
896

897 898
    if (dump_file != NULL)
    {
899
        /* Synchronise file and then close it */
900
        fclose(dump_file);
901
        dump_file = NULL;
902 903
    }

904 905 906 907 908 909
    if (itti_dump_queue.itti_message_queue)
    {
        lfds611_ringbuffer_delete(itti_dump_queue.itti_message_queue,
                                  itti_dump_user_data_delete_function, NULL);
    }
}