ifc_tcpip_internal.h

Go to the documentation of this file.

/**
 * \file ifc_tcpip_internal.h
 * \brief TRAP TCP/IP interfaces private structures
 * \author Tomas Cejka <cejkat@cesnet.cz>
 * \date 2014
 */
/*
 * Copyright (C) 2013 CESNET
 *
 * LICENSE TERMS
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of the Company nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * ALTERNATIVELY, provided that this notice is retained in full, this
 * product may be distributed under the terms of the GNU General Public
 * License (GPL) version 2 or later, in which case the provisions
 * of the GPL apply INSTEAD OF those given above.
 *
 * This software is provided ``as is'', and any express or implied
 * warranties, including, but not limited to, the implied warranties of
 * merchantability and fitness for a particular purpose are disclaimed.
 * In no event shall the company or contributors be liable for any
 * direct, indirect, incidental, special, exemplary, or consequential
 * damages (including, but not limited to, procurement of substitute
 * goods or services; loss of use, data, or profits; or business
 * interruption) however caused and on any theory of liability, whether
 * in contract, strict liability, or tort (including negligence or
 * otherwise) arising in any way out of the use of this software, even
 * if advised of the possibility of such damage.
 *
 */

#include "ifc_socket_common.h"

/** \addtogroup trap_ifc
 * @{
 */

/** \addtogroup tcpip_ifc
 * @{
 */

 /**
 * \defgroup tcpip_sender TCPIP output IFC
 * @{
 */

/**
 * \brief Structure for TCP/IP IFC client information.
 */
typedef struct client_s {
   int sd;                                 /**< Client socket descriptor */
   int pfds_index;                         /**< Client pfds struct array index. */
   void *sending_pointer;                  /**< Pointer to data in client's assigned buffer */

   uint64_t timer_total;                   /**< Total time spent sending (microseconds) since client connection */
   uint64_t timeouts;                      /**< Number of messages dropped (since connection) due to client blocking active buffer */

   uint32_t timer_last;                    /**< Time spent on last send call [microseconds] */
   uint32_t pending_bytes;                 /**< The size of data that must be sent */
   uint32_t id;                            /**< Client identification - PID for unix socket, port number for TCP socket */
   uint32_t assigned_buffer;               /**< Index of assigned buffer in array of buffers */
} client_t;

/**
 * \brief Structure for TCP/IP IFC private information.
 */
typedef struct tcpip_sender_private_s {
   trap_ctx_priv_t *ctx;                   /**< Libtrap context */

   enum tcpip_ifc_sockettype socket_type;  /**< Socket type (TCPIP / UNIX) */

   int term_pipe[2];                       /**< File descriptor pair for select() termination */
   int server_sd;                          /**< Server socket descriptor */

   char *server_port;                      /**< TCPIP port number / UNIX socket path */
   char is_terminated;                     /**< Termination flag */
   char initialized;                       /**< Initialization flag */

   uint64_t autoflush_timestamp;           /**< Time when the last buffer was finished - used for autoflush */
   uint64_t clients_bit_arr;               /**< Bit array of currently connected clients - lowest bit = index 0, highest bit = index 63 */

   uint32_t ifc_idx;                       /**< Index of interface in 'out_ifc_list' array */
   uint32_t connected_clients;             /**< Number of currently connected clients */
   uint32_t clients_arr_size;              /**< Maximum number of clients */
   uint32_t buffer_count;                  /**< Number of buffers used */
   uint32_t buffer_size;                   /**< Buffer size [bytes] */
   uint32_t active_buffer;                 /**< Index of active buffer in 'buffers' array */

   buffer_t *buffers;                      /**< Array of buffer structures */
   client_t *clients;                      /**< Array of client structures */

   struct pollfd *clients_pfds;            /**< Array of clients pfds for poll */

   pthread_t accept_thr;                   /**< Pthread structure containing info about accept thread */
   pthread_t send_thr;                     /**< Pthread structure containing info about sending thread */

   pthread_mutex_t mtx_no_data;            /**< Mutex for cond_no_data */
   pthread_cond_t cond_no_data;            /**< Condition struct used when waiting for new data */
   pthread_cond_t cond_full_buffer;        /**< Condition struct used when waiting for free buffer */
} tcpip_sender_private_t;

/**
 * @}
 */

/**
 * \defgroup tcpip_receiver TCPIP input IFC
 * @{
 */
typedef struct tcpip_receiver_private_s {
   trap_ctx_priv_t *ctx;                   /**< Libtrap context */
   char *dest_addr;
   char *dest_port;
   char connected;
   char is_terminated;
   int sd;
   enum tcpip_ifc_sockettype socket_type;
   void *data_pointer;                     /**< Pointer to next free byte, if NULL, we ended in header */
   uint32_t data_wait_size;                /**< Missing data to accept in the next function call */
   void *ext_buffer;                       /**< Pointer to buffer that was passed by higher layer - this is the place we write */
   uint32_t ext_buffer_size;               /**< size of content of the extbuffer */
   trap_buffer_header_t int_mess_header;   /**< Internal message header - used for message_buffer payload size \note message_buffer size is sizeof(tcpip_tdu_header_t) + payload size */
   uint32_t ifc_idx;
} tcpip_receiver_private_t;

/**
 * @}
 */

/**
 * @}
 */

/**
 * @}
 */