private.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_PRIVATE_H__
#define CDI_PRIVATE_H__
 
#include <stdbool.h>
 
// The configuration.h file must be included first since it can have defines which affect subsequent files.
#include "configuration.h"
 
#include "cdi_avm_api.h"
#include "cdi_logger_api.h"
#include "cdi_os_api.h"
#include "cdi_pool_api.h"
#include "cdi_queue_api.h"
#include "cloudwatch_sdk_metrics.h"
#include "fifo_api.h"
#include "list_api.h"
#include "payload.h"
#include "singly_linked_list_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef struct EndpointManagerGlobalState* EndpointManagerGlobalHandle;
 
typedef struct {
    bool sdk_initialized;                     
    CdiCsID adapter_handle_list_lock;         
    CdiList adapter_handle_list;              
    CdiLoggerHandle logger_handle;            
    CdiLogHandle global_log_handle;           
    CloudWatchSdkMetricsHandle cw_sdk_handle; 
    CloudWatchSdkMetricsHandle metrics_gathering_sdk_handle; 
    CdiSglEntry empty_sgl_entry;              
    CdiSignalType shutdown_signal;            
    CdiThreadID system_monitor_thread_id;     
 
    // NOTE: Add initialization to global_context variable's definition in internal.c for any new members added to this
    // structure.
} CdiGlobalContext;
 
extern CdiGlobalContext cdi_global_context;
 
typedef struct CdiAdapterState CdiAdapterState;
typedef struct AdapterConnectionState AdapterConnectionState;
typedef struct AdapterEndpointState AdapterEndpointState;
typedef struct AdapterEndpointState* AdapterEndpointHandle;
typedef struct CdiConnectionState CdiConnectionState;
typedef struct CdiEndpointState CdiEndpointState;
typedef struct EndpointManagerState EndpointManagerState;
typedef struct EndpointManagerState* EndpointManagerHandle;
typedef struct StatisticsState StatisticsState;
typedef struct StatisticsState* StatisticsHandle;
typedef struct CdiStatsCallbackState* CdiStatsCallbackHandle;
typedef struct ReceiveBufferState ReceiveBufferState;
typedef struct ReceiveBufferState* ReceiveBufferHandle;
 
typedef enum {
    kHandleTypeTx = 0x5a, 
    kHandleTypeRx = 0xa5, 
} ConnectionHandleType;
 
typedef struct {
    CdiListEntry list_entry; 
 
    CdiReturnStatus payload_status_code; 
 
    CdiCoreExtraData core_extra_data;    
 
    uint16_t extra_data_size;            
    uint8_t extra_data_array[MAX_CDI_PACKET_EXTRA_DATA]; 
 
    CdiSgList payload_sgl;               
 
    CdiUserCbParameter tx_payload_user_cb_param;
 
    CdiSgList tx_source_sgl;
 
    char* error_message_str;
 
    uint64_t tx_start_time_microseconds;
 
    uint64_t receive_buffer_send_time;
} AppPayloadCallbackData;
 
typedef struct TxPayloadState TxPayloadState;
struct TxPayloadState {
    CdiSgList source_sgl;                       
    uint64_t start_time;                        
    uint32_t max_latency_microsecs;             
    int group_size_bytes;
 
    AppPayloadCallbackData app_payload_cb_data; 
 
    CdiPayloadPacketState payload_packet_state; 
 
    int data_bytes_transferred;                 
    CdiSinglyLinkedList completed_packets_list; 
 
    CdiEndpointHandle cdi_endpoint_handle;  
};
 
typedef void (*CdiCallback)(const void* param_ptr);
 
typedef struct {
    char copy_dest_ip_addr_str[MAX_IP_STRING_LENGTH];
    CdiTxConfigData config_data;
    CdiCallback cb_ptr;                         
 
    CdiQueueHandle payload_queue_handle;        
 
    CdiPoolHandle payload_state_pool_handle;
 
    CdiPoolHandle payload_sgl_entry_pool_handle;
 
    CdiPoolHandle work_request_pool_handle;
 
    CdiPoolHandle packet_sgl_entry_pool_handle;
 
    CdiQueueHandle work_req_comp_queue_handle;
} TxConState;
 
typedef struct CdiMemoryState CdiMemoryState;
typedef struct SdkLogState* SdkLogHandle;
 
typedef struct {
    CdiPayloadType payload_type;              
    CdiMemoryState* payload_memory_state_ptr; 
 
    AppPayloadCallbackData app_payload_cb_data; 
 
    uint64_t start_time;            
    uint32_t max_latency_microsecs; 
} RxPayloadWorkRequestState;
 
typedef struct CdiReorderList CdiReorderList;
struct CdiReorderList {
    CdiReorderList* prev_ptr;  
    CdiReorderList* next_ptr;  
    uint16_t top_sequence_num; 
    uint16_t bot_sequence_num; 
    CdiSgList sglist;          
};
 
typedef enum {
    kPayloadIdle = 0,          
    kPayloadPacketZeroPending, 
    kPayloadInProgress,        
    kPayloadError,             
    kPayloadIgnore,            
    kPayloadComplete,          
} CdiPayloadState;
 
typedef struct {
    CdiListEntry list_entry;          
 
    CdiPayloadState payload_state;    
 
    RxPayloadWorkRequestState work_request_state; 
 
    int payload_num;                  
    int packet_count;                 
    int ignore_packet_count;          
 
    bool suspend_warnings;            
    int expected_payload_data_size;   
    int data_bytes_received;          
    CdiReorderList* reorder_list_ptr; 
    uint32_t last_total_packet_count; 
    uint8_t* linear_buffer_ptr;       
} RxPayloadState;
 
typedef struct {
    CdiRxConfigData config_data;
    CdiCallback cb_ptr;              
 
    CdiPoolHandle payload_memory_state_pool_handle; 
    CdiPoolHandle payload_sgl_entry_pool_handle; 
 
    CdiPoolHandle reorder_entries_pool_handle;
 
    CdiPoolHandle rx_payload_state_pool_handle;
 
    bool received_first_payload;
 
    CdiQueueHandle active_payload_complete_queue_handle;
 
    ReceiveBufferHandle receive_buffer_handle;
} RxConState;
 
typedef struct {
    CdiCsID payload_num_lock;                   
    uint16_t payload_num;                       
    uint32_t packet_id;                         
} TxEndpointState;
 
typedef struct {
    uint32_t total_packet_count;
 
    CdiQueueHandle free_buffer_queue_handle; 
 
    RxPayloadState* payload_state_array_ptr[CDI_MAX_RX_PAYLOAD_OUT_OF_ORDER_BUFFER];
    int rxreorder_current_index;
    int rxreorder_buffered_packet_count;
} RxEndpointState;
 
struct CdiEndpointState {
    uint32_t magic;
 
    CdiConnectionState* connection_state_ptr;
 
    AdapterEndpointState* adapter_endpoint_ptr;
 
    char remote_ip_str[MAX_IP_STRING_LENGTH];   
    struct sockaddr_in remote_sockaddr_in;  
 
    char stream_name_str[CDI_MAX_STREAM_NAME_STRING_LENGTH];
 
    union {
        TxEndpointState tx_state;
        RxEndpointState rx_state;
    };
 
    CdiTransferStats transfer_stats;
};
 
typedef enum {
    kCdiBackPressureNone, 
    kCdiBackPressureActive,
} CdiBackPressureState;
 
struct CdiConnectionState {
    CdiListEntry list_entry;
    uint32_t magic;
 
    CdiSignalType start_signal;
    CdiSignalType shutdown_signal; 
 
    EndpointManagerHandle endpoint_manager_handle;
 
    CdiEndpointState* default_tx_endpoint_ptr;
 
    CdiAdapterState* adapter_state_ptr;
 
    AdapterConnectionState* adapter_connection_ptr;
 
    CdiThreadID app_payload_message_thread_id;
 
    CdiQueueHandle app_payload_message_queue_handle;
 
    CdiPoolHandle linear_buffer_pool;
 
    ConnectionHandleType handle_type;
    union {
        TxConState tx_state;
        RxConState rx_state;
    };
 
    StatisticsState* stats_state_ptr;
 
    CdiStatsCallbackHandle stats_cb_handle;
 
    CdiConnectionProtocolType protocol_type;
 
    CdiThreadID payload_thread_id;             
 
    char saved_connection_name_str[CDI_MAX_CONNECTION_NAME_STRING_LENGTH]; 
 
    CdiLogHandle log_handle; 
 
    CdiPoolHandle error_message_pool; 
 
    CdiBackPressureState back_pressure_state; 
};
 
enum {
    kMagicAdapter    = 0xacd95f67,
    kMagicConnection = 0xf98b0b0d,
    kMagicEndpoint   = 0x725c4e3a,
    kMagicMemory     = 0xdcf693e4,
};
 
typedef struct {
    void* virtual_address;      
    uint64_t physical_address;  
    uint32_t byte_size;         
} MemoryLinearState;
 
struct CdiMemoryState {
    uint32_t magic;
 
    CdiConnectionHandle cdi_connection_handle; 
 
    CdiEndpointHandle cdi_endpoint_handle;
 
    CdiBufferType buffer_type;         
    MemoryLinearState linear_state;    
 
    CdiSgList endpoint_packet_buffer_sgl; 
};
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
#endif  // CDI_PRIVATE_H__