lan_util.h

Go to the documentation of this file.

/**************************************************************************
 *
 *  $Id: lan_util.h 1.9 2018/02/28 16:55:31 martin REL_M $
 *
 *  Copyright (c) Meinberg Funkuhren, Bad Pyrmont, Germany
 *
 *  Description:
 *    Definitions and prototypes for lan_util.c.
 *
 * -----------------------------------------------------------------------
 *  $Log: lan_util.h $
 *  Revision 1.9  2018/02/28 16:55:31  martin
 *  Updated function prototypes.
 *  Revision 1.8  2017/10/05 08:20:40  daniel
 *  Introduced check_port_status() function
 *  Revision 1.7  2017/07/05 14:10:58  martin
 *  Some definitions used with IPv6 added by hannes.
 *  Removed definitions of old MBG_LU_... return codes.
 *  Standard MBG_RETURN_CODES are now used instead.
 *  Updated function prototypes.
 *  Revision 1.6  2014/09/24 08:32:58  martin
 *  Fixed a POSIX header file dependency.
 *  Revision 1.5  2013/10/02 07:20:36  martin
 *  Updated function prototypes.
 *  Revision 1.4  2013/02/19 15:15:53  martin
 *  Added some inline functions.
 *  Redefined return codes as named enum.
 *  Updated function prototypes.
 *  Revision 1.3  2012/10/02 18:24:29  martin
 *  Added some macros to simpliy conversion to string.
 *  Revision 1.2  2012/03/09 08:51:44  martin
 *  Updated function prototypes.
 *  Revision 1.1  2011/03/04 10:01:32  martin
 *  Initial revision.
 *
 **************************************************************************/

#ifndef _LAN_UTIL_H
#define _LAN_UTIL_H


/* Other headers to be included */

#include <mbg_tgt.h>
#include <gpsdefs.h>   // for some Meinberg data structures

#include <stdlib.h>

#if defined( MBG_TGT_POSIX )
  #include <sys/types.h>
  #include <sys/socket.h>
  #include <net/if.h>
  #include <ifaddrs.h>  // *must* be included *after* net/if.h
#else
  // A dummy declaration to prevent from warnings due to usage
  // of this type with function prototypes.
  struct ifreq
  {
    int dummy;
  };
#endif


#if defined( IFHWADDRLEN )  // usually defined in net/if.h
  #if ( IFHWADDRLEN != 6 )
    #error Warning: IFHWADDRLEN is not 6!
  #endif
#endif



#ifdef _LAN_UTIL
 #define _ext
 #define _DO_INIT
#else
 #define _ext extern
#endif


/* Start of header body */

#if defined( _USE_PACK )
  #pragma pack( 1 )      // set byte alignment
  #define _USING_BYTE_ALIGNMENT
#endif

#ifdef __cplusplus
extern "C" {
#endif


#if !defined( MAC_SEP_CHAR )
  #define MAC_SEP_CHAR      ':'   // character used to separate octets of a MAC ID
#endif

#if !defined( MAC_SEP_CHAR_ALT )
  #define MAC_SEP_CHAR_ALT  '-'   // alternate character
#endif


#define MAX_IP4_BITS  ( 8 * (int) sizeof( IP4_ADDR ) )

#define IP4_MSB_MASK  ( 1UL << ( MAX_IP4_BITS - 1 ) )

#define MIN_IP4_CIDR_NETMASK_BITS  0
#define MAX_IP4_CIDR_NETMASK_BITS  MAX_IP4_BITS


#define IP6_MSB_MASK ( 1UL << ( 8 - 1 ) )

#define MIN_IP6_CIDR_NETMASK_BITS  0
#define MAX_IP6_CIDR_NETMASK_BITS  IP6_ADDR_BITS



static __mbg_inline
IP4_ADDR ip4_net_mask_from_cidr( int netmask_bits )
{
  return (IP4_ADDR) ~( ( 1UL << ( MAX_IP4_BITS - netmask_bits ) ) - 1 );

}  // ip4_net_mask_from_cidr



static __mbg_inline
IP4_ADDR ip4_broad_addr_from_addr( const IP4_ADDR *p_addr, const IP4_ADDR *p_mask )
{
  return *p_addr | ~(*p_mask);

}  // ip4_broad_addr_from_addr



static __mbg_inline
IP4_ADDR ip4_net_part_from_addr( const IP4_ADDR *p_addr, const IP4_ADDR *p_mask )
{
  return *p_addr & *p_mask;

}  // ip4_net_part_from_addr



static __mbg_inline
int ip4_net_part_matches( const IP4_ADDR *p_addr1, const IP4_ADDR *p_addr2,
                           const IP4_ADDR *p_mask )
{
  return ip4_net_part_from_addr( p_addr1, p_mask )
      == ip4_net_part_from_addr( p_addr2, p_mask );

}  // ip4_net_part_matches



#define _ip4_addr_to_str( _s, _a ) \
  snprint_ip4_addr( _s, sizeof( _s ), _a, NULL )

#define _mac_addr_to_str( _s, _a ) \
  snprint_mac_addr( _s, sizeof( _s ), _a )



/* ----- function prototypes begin ----- */

/* This section was generated automatically */
/* by MAKEHDR, do not remove the comments. */

 int get_ip4_net_mask_bits( const IP4_ADDR *p_mask ) ;

 size_t snprint_ip4_addr( char *s, size_t max_len, const IP4_ADDR *p_addr, const char *info ) ;

 size_t snprint_ip4_cidr_addr( char *s, size_t max_len, const IP4_ADDR *p_addr, const IP4_ADDR *p_mask, const char *info ) ;

 int str_to_ip4_addr( IP4_ADDR *p_addr, const char *s ) ;

 int cidr_str_to_ip4_addr_and_net_mask( IP4_ADDR *p_addr, IP4_ADDR *p_mask, const char *cidr_str ) ;

 int get_ip6_net_mask_bits( const IP6_ADDR *p_mask ) ;

 size_t snprint_ip6_addr( char *s, size_t max_len, const IP6_ADDR *p_addr, const char *info ) ;

 size_t snprint_ip6_cidr_addr( char *s, size_t max_len, const IP6_ADDR *p_addr, const IP6_ADDR *p_mask, const char *info ) ;

 size_t snprint_ip6_cidr_mask_addr( char *s, size_t max_len, const IP6_ADDR *p_addr, const int cidr_mask_bits, const char* info ) ;

 int str_to_ip6_addr( IP6_ADDR *p_addr, const char *s ) ;

 int cidr_str_to_ip6_addr_and_net_mask( IP6_ADDR *p_addr, IP6_ADDR *p_mask, const char *cidr_str ) ;

 int cidr_str_to_ip6_addr_and_cidr_bits( IP6_ADDR *p_addr, int *p_cidr, const char *cidr_str ) ;

 void ip6_net_mask_from_cidr( IP6_ADDR *p_mask, int netmask_bits ) ;

 void ip6_net_part_from_addr( IP6_ADDR *p_net_part, const IP6_ADDR *p_addr, const IP6_ADDR *p_mask ) ;

 size_t snprint_octets( char *s, size_t max_len, const uint8_t *octets, int num_octets, char sep, const char *info ) ;

 size_t snprint_ptp_clock_id( char *s, size_t max_len, const PTP_CLOCK_ID *p ) ;

 size_t snprint_mac_addr( char *s, size_t max_len, const MBG_MAC_ADDR *p_mac_addr ) ;

 int str_to_octets( uint8_t *octets, int num_octets, const char *s ) ;

 bool octets_are_all_zero( const uint8_t *octets, int num_octets ) ;

 bool mac_addr_is_all_zero( const MBG_MAC_ADDR *p_addr ) ;

 int do_siocg_ioctl( const char *if_name, int ioctl_code, struct ifreq *p_ifreq ) ;

 int get_port_intf_idx( const char *if_name, int *p_intf_idx ) ;

 int get_port_mac_addr( const char *if_name, MBG_MAC_ADDR *p_mac_addr ) ;

 int check_port_link( const char *if_name ) ;

 int check_port_status( const char *if_name, int *p_speed, int *p_duplex ) ;

 int get_port_ip4_addr( const char *if_name, IP4_ADDR *p_addr ) ;

 int get_port_ip4_netmask( const char *if_name, IP4_ADDR *p_addr ) ;

 int get_port_ip4_broad_addr( const char *if_name, IP4_ADDR *p_addr ) ;

 int get_ip4_gateway( IP4_ADDR *p_addr ) ;

 int get_port_ip4_addr_str( const char *if_name, char *p_addr_buf, int buf_size ) ;

 int get_port_ip4_netmask_str( const char *if_name, char *p_addr_buf, int buf_size ) ;

 int get_port_ip4_broad_addr_str( const char *if_name, char *p_addr_buf, int buf_size ) ;

 int get_port_ip4_settings( const char *if_name, IP4_SETTINGS *p ) ;


/* ----- function prototypes end ----- */

#ifdef __cplusplus
}
#endif


#if defined( _USING_BYTE_ALIGNMENT )
  #pragma pack()      // set default alignment
  #undef _USING_BYTE_ALIGNMENT
#endif

/* End of header body */


#undef _ext
#undef _DO_INIT

#endif  /* _LAN_UTIL_H */