adapter_api.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 ADAPTER_API_H__
#define ADAPTER_API_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "endpoint_manager.h"
#include "cdi_raw_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
 
typedef struct ControlInterfaceState* ControlInterfaceHandle;
 
typedef enum {
    kAdapterPacketStatusOk,           
    kAdapterPacketStatusFailed,       
    kAdapterPacketStatusNotConnected, 
} AdapterPacketAckStatus;
 
typedef struct {
    CdiSinglyLinkedListEntry list_entry; 
    CdiSgList sg_list; 
    bool payload_last_packet; 
    union {
        struct TxState {
            AdapterPacketAckStatus ack_status; 
        } tx_state;
    };
 
    union {
        struct SocketAdapterState {
            struct sockaddr_in address;
        } socket_adapter_state;
    };
} Packet;
 
typedef enum {
    kEndpointDirectionSend,    
    kEndpointDirectionReceive, 
    kEndpointDirectionBidirectional, 
} EndpointDirection;
 
typedef enum {
    kEndpointTypeData,    
    kEndpointTypeControl, 
} EndpointDataType;
 
typedef enum {
    kEndpointTransmitQueueEmpty,        
    kEndpointTransmitQueueIntermediate, 
    kEndpointTransmitQueueFull,         
    kEndpointTransmitQueueNa,           
} EndpointTransmitQueueLevel;
 
typedef enum {
    kEndpointMessageTypePacketSent, 
    kEndpointMessageTypePacketReceived 
} EndpointMessageType;
 
typedef void (*MessageFromEndpoint)(void* param_ptr, Packet* packet_ptr, EndpointMessageType message_type);
 
struct AdapterEndpointState {
    CdiListEntry list_entry;              
 
    CdiEndpointHandle cdi_endpoint_handle; 
 
    AdapterConnectionState* adapter_con_state_ptr; 
 
    MessageFromEndpoint msg_from_endpoint_func_ptr;
    void* msg_from_endpoint_param_ptr;    
 
    volatile CdiConnectionStatus connection_status_code;
 
    CdiQueueHandle tx_packet_queue_handle; 
    CdiSinglyLinkedList tx_packet_waiting_list; 
 
    volatile uint32_t tx_packets_in_process;
 
    CdiAdapterEndpointStats* endpoint_stats_ptr; 
 
    CdiSignalType start_signal;
    CdiSignalType shutdown_signal; 
 
    CdiProtocolHandle protocol_handle; 
 
    uint32_t tx_in_flight_ref_count;
 
    int maximum_payload_bytes;
 
    int maximum_tx_sgl_entries;
 
    int msg_prefix_size;
 
    void* type_specific_ptr; 
};
 
typedef struct AdapterEndpointState* AdapterEndpointHandle;
 
typedef struct {
    int reserve_packet_buffers;
} RxAdapterConnectionState;
 
typedef enum {
    kPollStart, 
    kPollRunning, 
    kPollStopping, 
    kPollStopped 
} PollState;
 
typedef struct {
    CdiConnectionHandle cdi_connection_handle; 
 
    CdiCoreConnectionCallback connection_cb_ptr; 
    CdiUserCbParameter connection_user_cb_param; 
} AdapterDataConnectionState;
 
typedef struct {
    AdapterEndpointHandle control_endpoint_handle; 
} AdapterControlConnectionState;
 
typedef struct {
    CdiListEntry list_entry; 
 
    CdiThreadID thread_id; 
 
    int shared_thread_id; 
 
    int thread_core_num;
 
    EndpointDataType data_type; 
 
    bool is_poll;
 
    bool only_transmit; 
 
    CdiSignalType connection_list_changed_signal; 
    CdiSignalType connection_list_processed_signal; 
 
    CdiCsID connection_list_lock;
 
    CdiList connection_list; 
 
    CdiSignalType start_signal;
} PollThreadState;
 
typedef struct {
    uint64_t top_time;          
    uint64_t busy_accumulator;  
    uint64_t idle_accumulator;  
    uint64_t start_time;        
} ThreadUtilizationState;
 
struct AdapterConnectionState {
    CdiListEntry list_entry;              
    CdiAdapterState* adapter_state_ptr;   
 
    volatile CdiConnectionStatus connection_status_code;
 
    CdiLogHandle log_handle;
 
    EndpointDirection direction;          
    RxAdapterConnectionState rx_state;    
 
    union {
        AdapterDataConnectionState data_state;
        AdapterControlConnectionState control_state;
    };
 
    PollState poll_state; 
 
    bool can_transmit; 
    bool can_receive; 
 
    ThreadUtilizationState load_state;
 
    int port_number; 
 
    CdiSignalType tx_poll_do_work_signal;
 
    PollThreadState* poll_thread_state_ptr; 
 
    CdiSignalType shutdown_signal; 
 
    bool tx_header_buffer_is_hugepages;
 
    uint64_t tx_header_buffer_allocated_size;
 
    void* tx_header_buffer_allocated_ptr;
 
    CdiPoolHandle tx_header_pool_handle;
 
    CdiPoolHandle tx_extra_header_pool_handle;
 
    ControlInterfaceHandle control_interface_handle; 
 
    CdiCsID endpoint_lock; 
 
    void* type_specific_ptr;       
};
 
typedef struct AdapterConnectionState* AdapterConnectionHandle;
 
struct AdapterVirtualFunctionPtrTable {
    CdiReturnStatus (*CreateConnection)(AdapterConnectionHandle handle, int port_number, const char* bind_ip_addr_str);
 
    CdiReturnStatus (*DestroyConnection)(AdapterConnectionHandle handle);
 
    CdiReturnStatus (*Open)(AdapterEndpointHandle handle, const char* remote_address_str, int port_number,
                            const char* bind_ip_addr_str);
 
    CdiReturnStatus (*Close)(AdapterEndpointHandle handle);
 
    CdiReturnStatus (*Poll)(AdapterEndpointHandle handle);
 
    EndpointTransmitQueueLevel (*GetTransmitQueueLevel)(AdapterEndpointHandle handle);
 
    CdiReturnStatus (*Send)(const AdapterEndpointHandle handle, const Packet* packet_ptr, bool flush_packets);
 
    CdiReturnStatus (*RxBuffersFree)(const AdapterEndpointHandle handle, const CdiSgList* sgl_ptr);
 
    CdiReturnStatus (*GetPort)(const AdapterEndpointHandle handle, int* ret_port_number_ptr);
 
    CdiReturnStatus (*Reset)(AdapterEndpointHandle handle);
 
    CdiReturnStatus (*Start)(AdapterEndpointHandle handle);
 
    CdiReturnStatus (*Shutdown)(CdiAdapterHandle adapter);
};
 
struct CdiAdapterState {
    CdiListEntry list_entry;
 
    uint32_t magic;
 
    CdiCsID adapter_lock;
 
    char adapter_ip_addr_str[MAX_IP_STRING_LENGTH];
 
    CdiAdapterData adapter_data;
 
    struct AdapterVirtualFunctionPtrTable* functions_ptr;
 
    CdiCsID connection_list_lock;
 
    CdiList connection_list;
 
    CdiList poll_thread_list;
 
    void* type_specific_ptr;
 
    bool tx_payload_buffer_is_hugepages;
 
    uint64_t tx_payload_buffer_size_bytes;
 
    uint64_t tx_payload_buffer_allocated_size;
 
    void* tx_payload_buffer_allocated_ptr;
 
    CdiPoolHandle probe_work_request_pool_handle;
};
 
typedef struct {
    CdiAdapterHandle cdi_adapter_handle; 
    CdiConnectionHandle cdi_connection_handle; 
    EndpointManagerHandle endpoint_manager_handle; 
 
    CdiCoreConnectionCallback connection_cb_ptr;
 
    CdiUserCbParameter connection_user_cb_param;
 
    CdiLogHandle log_handle;
 
    EndpointDirection direction;
 
    int port_number;
 
    const char* bind_ip_addr_str;
 
    int shared_thread_id;
 
    int thread_core_num;
 
    RxAdapterConnectionState rx_state;
 
    EndpointDataType data_type;
} CdiAdapterConnectionConfigData;
 
typedef struct {
    AdapterConnectionHandle connection_handle; 
    CdiEndpointHandle cdi_endpoint_handle; 
 
    MessageFromEndpoint msg_from_endpoint_func_ptr;
    void* msg_from_endpoint_param_ptr; 
 
    CdiAdapterEndpointStats* endpoint_stats_ptr;
 
    const char* remote_address_str;
 
    int port_number;
 
    const char* bind_address_str;
} CdiAdapterEndpointConfigData;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CdiReturnStatus EfaNetworkAdapterInitialize(CdiAdapterState* adapter_state_ptr, bool is_socket_based);
 
CdiReturnStatus SocketNetworkAdapterInitialize(CdiAdapterState* adapter_state_ptr);
 
CdiReturnStatus CdiAdapterCreateConnection(CdiAdapterConnectionConfigData* config_data_ptr,
                                           AdapterConnectionHandle* return_handle_ptr);
 
CdiReturnStatus CdiAdapterStopConnection(AdapterConnectionHandle handle);
 
CdiReturnStatus CdiAdapterDestroyConnection(AdapterConnectionHandle handle);
 
CdiReturnStatus CdiAdapterOpenEndpoint(CdiAdapterEndpointConfigData* config_data_ptr,
                                       AdapterEndpointHandle* return_handle_ptr);
 
CdiReturnStatus CdiAdapterStartEndpoint(AdapterEndpointHandle handle);
 
CdiReturnStatus CdiAdapterResetEndpoint(AdapterEndpointHandle handle);
 
CdiReturnStatus CdiAdapterCloseEndpoint(AdapterEndpointHandle handle);
 
CdiReturnStatus CdiAdapterPollEndpoint(AdapterEndpointHandle handle);
 
EndpointTransmitQueueLevel CdiAdapterGetTransmitQueueLevel(AdapterEndpointHandle handle);
 
CdiReturnStatus CdiAdapterEnqueueSendPacket(const AdapterEndpointHandle handle,
                                            const struct sockaddr_in* destination_address_ptr, Packet* packet_ptr);
 
CdiReturnStatus CdiAdapterEnqueueSendPackets(const AdapterEndpointHandle handle,
                                             const CdiSinglyLinkedList *packet_list_ptr);
 
CdiReturnStatus CdiAdapterFreeBuffer(const AdapterEndpointHandle handle, const CdiSgList* sgl_ptr);
 
CdiReturnStatus CdiAdapterGetPort(const AdapterEndpointHandle handle, int* port_number_ptr);
 
CdiReturnStatus CdiAdapterShutdown(CdiAdapterHandle adapter);
 
void CdiAdapterPollThreadFlushResources(AdapterEndpointHandle handle);
 
void CdiAdapterTxPacketComplete(AdapterEndpointHandle handle, const Packet* packet_ptr);
 
#endif // ADAPTER_API_H__