protocol.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_PROTOCOL_H__
#define CDI_PROTOCOL_H__
 
#include <assert.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "cdi_core_api.h"
#include "cdi_pool_api.h"
#include "payload.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
// --------------------------------------------------------------------
// All structures in the block below are byte packed (no byte padding).
// --------------------------------------------------------------------
#pragma pack(push, 1)
 
typedef struct CdiProtocolVersionNumber CdiProtocolVersionNumber;
 
struct CdiProtocolVersionNumber {
    uint8_t version_num;       
    uint8_t major_version_num; 
    uint8_t probe_version_num; 
};
 
#pragma pack(pop)
// --------------------------------------------------------------------
// End of byte packed structures (no byte padding).
// --------------------------------------------------------------------
 
typedef struct {
    int payload_data_offset; 
} CdiDecodedPacketDataOffsetInfo;
 
typedef struct {
    int total_payload_size;         
    uint64_t max_latency_microsecs; 
 
    CdiPtpTimestamp origination_ptp_timestamp;
    uint64_t payload_user_data; 
 
    int extra_data_size;        
    void* extra_data_ptr;       
 
    uint64_t tx_start_time_microseconds;
} CdiDecodedPacketNum0Info;
 
typedef struct {
    CdiPayloadType payload_type; 
    int packet_sequence_num;     
    int payload_num;             
    int encoded_header_size;     
 
    uint32_t packet_id;
 
    union {
        CdiDecodedPacketDataOffsetInfo data_offset_info; 
        CdiDecodedPacketNum0Info num0_info;  
    };
} CdiDecodedPacketHeader;
 
#define CDI_RAW_PACKET_HEADER_SIZE_V1   (34)
 
#define CDI_RAW_PACKET_HEADER_SIZE_V2   (47)
 
struct CdiRawPacketHeader {
    union {
        uint8_t header_v1[CDI_RAW_PACKET_HEADER_SIZE_V1]; 
        uint8_t header_v2[CDI_RAW_PACKET_HEADER_SIZE_V2]; 
    };
};
 
struct CdiRawExtraPacketHeader {
    union {
        uint8_t header_v1[CDI_RAW_PACKET_HEADER_SIZE_V1 + MAX_CDI_PACKET_EXTRA_DATA]; 
        uint8_t header_v2[CDI_RAW_PACKET_HEADER_SIZE_V2 + MAX_CDI_PACKET_EXTRA_DATA]; 
    };
};
 
typedef struct {
    int payload_num;         
    int packet_sequence_num; 
} CdiPacketRxReorderInfo;
 
typedef enum {
    kProbeCommandReset = 1, 
    kProbeCommandPing,      
    kProbeCommandConnected, 
    kProbeCommandAck,       
    kProbeCommandProtocolVersion, 
} ProbeCommand;
 
typedef struct {
    bool requires_ack; 
} CdiDecodedProbeCommand;
 
typedef struct {
    ProbeCommand ack_command;           
    uint16_t ack_control_packet_num;    
} CdiDecodedProbeAck;
 
typedef struct {
    CdiProtocolVersionNumber senders_version; 
 
    ProbeCommand command; 
    union {
        CdiDecodedProbeCommand command_packet;
        CdiDecodedProbeAck ack_packet;
    };
 
    const char* senders_ip_str;          
    const uint8_t* senders_gid_array;    
    const char* senders_stream_name_str; 
    int senders_stream_identifier; 
 
    uint16_t senders_control_dest_port;
 
    uint16_t control_packet_num;
} CdiDecodedProbeHeader;
 
#define CDI_RAW_PROBE_HEADER_SIZE_V1   (257)
 
#define CDI_RAW_PROBE_HEADER_SIZE_V2   (253)
 
typedef struct {
    uint16_t packet_sequence_num; 
    uint8_t efa_data[EFA_PROBE_PACKET_DATA_SIZE]; 
} EfaProbePacket;
 
struct CdiRawProbeHeader {
    union {
        uint8_t header_v1[CDI_RAW_PROBE_HEADER_SIZE_V1]; 
        uint8_t header_v2[CDI_RAW_PROBE_HEADER_SIZE_V2]; 
        EfaProbePacket efa_packet; 
    };
};
typedef struct CdiRawProbeHeader CdiRawProbeHeader;
 
typedef struct CdiConnectionState CdiConnectionState;
typedef struct TxPayloadState TxPayloadState;
 
struct CdiProtocol {
    CdiProtocolVersionNumber negotiated_version; 
    int payload_num_max; 
};
typedef struct CdiProtocol* CdiProtocolHandle;
 
typedef void (*VtblPayloadHeaderDecode)(const void* encoded_data_ptr, int encoded_data_size,
                                        CdiDecodedPacketHeader* dest_header_ptr);
typedef int (*VtblPayloadHeaderInit)(void* header_ptr, int header_buffer_size, const TxPayloadState* payload_state_ptr);
typedef void (*VtblPayloadPacketRxReorderInfo)(const CdiRawPacketHeader* header_ptr,
                                               CdiPacketRxReorderInfo* ret_info_ptr);
typedef CdiReturnStatus (*VtblProbeHeaderDecode)(const void* encoded_data_ptr, int encoded_data_size,
                                                 CdiDecodedProbeHeader* dest_header_ptr);
typedef int (*VtblProbeHeaderEncode)(const CdiDecodedProbeHeader* state_ptr, CdiRawProbeHeader* dest_header_ptr);
 
typedef struct {
    VtblPayloadHeaderDecode header_decode; 
    VtblPayloadHeaderInit header_init; 
    VtblPayloadPacketRxReorderInfo rx_reorder_info; 
    VtblProbeHeaderDecode probe_decode; 
    VtblProbeHeaderEncode probe_encode; 
} CdiProtocolVTableApi;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
typedef struct TxPayloadState TxPayloadState;
 
void ProtocolVersionSet(const CdiProtocolVersionNumber* remote_version_ptr, CdiProtocolHandle* ret_handle_ptr);
 
void ProtocolVersionSetLegacy(CdiProtocolHandle* ret_handle_ptr);
 
void ProtocolVersionDestroy(CdiProtocolHandle protocol_handle);
 
void ProtocolPayloadHeaderDecode(CdiProtocolHandle protocol_handle, void* encoded_data_ptr, int encoded_data_size,
                                 CdiDecodedPacketHeader* dest_header_ptr);
int ProtocolPayloadHeaderInit(CdiProtocolHandle protocol_handle, void* header_ptr, int header_buffer_size,
                              const TxPayloadState* payload_state_ptr);
 
void ProtocolPayloadPacketRxReorderInfo(CdiProtocolHandle protocol_handle, const CdiRawPacketHeader* header_ptr,
                                        CdiPacketRxReorderInfo* ret_info_ptr);
 
CdiReturnStatus ProtocolProbeHeaderDecode(const void* encoded_data_ptr, int encoded_data_size,
                                          CdiDecodedProbeHeader* dest_header_ptr);
 
int ProtocolProbeHeaderEncode(CdiProtocolHandle protocol_handle, CdiDecodedProbeHeader* src_header_ptr,
                              CdiRawProbeHeader* dest_header_ptr);
 
#endif  // CDI_PROTOCOL_H__