common_types_ip.h

// *****************************************************************************************
//
// File description:
//
// Author:  Joao Costa
// Purpose: Common declarations for IP (IP type is used by several modules)
//
// *****************************************************************************************
 
#ifndef OSAPI_COMMON_TYPES_IP_H_
#define OSAPI_COMMON_TYPES_IP_H_
 
// *****************************************************************************************
//
// Section: Import headers
//
// *****************************************************************************************
 
// System headers
#include <stdbool.h>
 
// OSAPI headers
#include "general/general_types.h"
#include "general/general_protocol.h"
 
// Include own headers
#include "common/types/common_types_if.h"
 
// *****************************************************************************************
//
// Section: Macros/Constant definitions
//
// *****************************************************************************************
 
#define osapi_is_ip_valid_selector( s )     ( s==osapi_protocol_ip || s==osapi_protocol_ipv4 || s==osapi_protocol_ipv6 ? true : false   )
#define osapi_is_ip_valid_family( f )       ( f==osapi_protocol_ipv4 || f==osapi_protocol_ipv6 ? true : false               )
#define osapi_is_ipv4_selection( s, f )     ( ( s==osapi_protocol_ip || s==osapi_protocol_ipv4 ) && f==osapi_protocol_ipv4  ? true : false  )
#define osapi_is_ipv6_selection( s, f )     ( ( s==osapi_protocol_ip || s==osapi_protocol_ipv6 ) && f==osapi_protocol_ipv6  ? true : false  )
 
#define osapi_is_ipv4_family( f )       ( f==osapi_protocol_ipv4  ? true : false )
#define osapi_is_ipv6_family( f )       ( f==osapi_protocol_ipv6  ? true : false )
 
// Macros for checking additional IP information
#define osapi_is_ip_address_broadcast( a )  ( (a & IFF_BROADCAST)   ? true : false )
#define osapi_is_ip_address_loopback ( a )  ( (a & IFF_LOOPBACK)    ? true : false )
#define osapi_is_ip_address_up( a )     ( (a & IFF_UP)          ? true : false )
#define osapi_is_ip_address_running( a )    ( (a & IFF_RUNNING)     ? true : false )
#define osapi_is_ip_address_multicast( a )  ( (a & IFF_MULTICAST)   ? true : false )
#define osapi_is_ip_address_promisc( a )    ( (a & IFF_PROMISC)     ? true : false )
#define osapi_is_ip_address_ptp( a )        ( (a & IFF_POINTOPOINT) ? true : false )
 
#define OSAPI_IP_TARGET_NONE        0
#define OSAPI_IP_TARGET_BROADCAST   1
#define OSAPI_IP_TARGET_POINT2POINT 2
 
// Size that it takes to create a string with an IP address
#define OSAPI_IPV4_ADDRESS_SIZE     4
#define OSAPI_IPV6_ADDRESS_SIZE     16
 
// *****************************************************************************************
//
// Section: Type definitions
//
// *****************************************************************************************
 
typedef int     t_address_type;
 
struct osapi_common_ipv4_address_S
{
  Byte          host        [ OSAPI_IPV4_ADDRESS_SIZE ];    
  Byte          mask        [ OSAPI_IPV4_ADDRESS_SIZE ];    
  Byte          broadcast   [ OSAPI_IPV4_ADDRESS_SIZE ];    
  Byte          p2p     [ OSAPI_IPV4_ADDRESS_SIZE ];    
};
 
union osapi_common_ipv4_address_U
{
  struct osapi_common_ipv4_address_S    field;                      
  Byte                  raw     [ OSAPI_IPV6_ADDRESS_SIZE ];    
};
 
union osapi_common_ip_address_U
{
  union osapi_common_ipv4_address_U ipv4;                       
  Byte                  ipv6        [ OSAPI_IPV6_ADDRESS_SIZE ];    
};
 
typedef union osapi_common_ip_address_U         t_ip_address;
 
struct osapi_common_ip_S
{
  char          interface_name  [ OSAPI_INTERFACE_MAX_NAME_SIZE ];  
  t_protocol        protocol;                       
  t_ip_address      address;                        
  t_address_type    type_target;                        
  //t_mac_address   mac;
};
 
typedef struct osapi_common_ip_S            t_ip;
 
 
 
#endif /* OSAPI_COMMON_TYPES_IP_H_ */