instr_api_common.h

Go to the documentation of this file.

#ifndef INSTR_API_COMMON_H
#define INSTR_API_COMMON_H

/** ***************************************************************************
 * @if INCLUDE_HEADER
 * @copyright
 *   (C) Copyright SYSGO AG.
 *   Klein-Winternheim, Germany
 *   All rights reserved.
 * @endif
 *
 * @file
 *
 * @purpose
 *   anisInstr: ANIS instrumentation interface of the PikeOS and POSIX API.
 *
 * @if INCLUDE_HEADER
 * @cfg_management
 *   $Id: include/instr_api_common.h 2019-07-11 13:36:07 +0200 2e5c3399a1cfd500e80c6c937ec893a1722d7b33 $
 *   $HeadURL$
 *   $Author$
 *   $Date$
 *   $Revision$
 * @endif
 *****************************************************************************/

/* ------------------------- FILE INCLUSION -------------------------------- */

#if !defined(_UINT8_T_DECLARED) || !defined(_UINT32_T_DECLARED)
/* instr_api_common.h is included only from anisFP.h
 * and instr.h from PikeOS or POSIX ANIS API.
 */
#error "uint8_t or uint32_t not declared!"
#endif

/**
 * @addtogroup anisInstr
 * @{
 */

/* ------------------------ TYPE DECLARATIONS ------------------------------ */

/**
 *  @brief
 *    Maximum number of Ethernet interfaces including localhost loopback
 */
/* @SYSGO_RQ IF_ANIS-3133 */
#define ANIS_ALL_INTF        (7+1)

/* @SYSGO_RQ IF_ANIS-1438 */

/**
 *  @brief
 *    ANIS interface specific instrumentation API structure.
 *
 *  @detailed
 *    This data structure is used to communicate network interface statistics
 *    to an application.
 */
/* @SYSGO_RQ IF_ANIS-1438 */
typedef struct anis_instr_intf_stat_s {
    /** Status of the interface configuration
     *
     *  @detailed
     *    Indication of the interface configuration status. If the interface is
     *    configured then 1 is stored in the variable. Otherwise 0.
     */
    uint32_t intf_enabled;

    /** The configured IP address of the interface.
     *
     *  @detailed
     *    The IP address is stored in the network byte order.
     */
    uint32_t intf_ip_address;

    /** The configured network mask of the interface.
     *
     *  @detailed
     *    The IP address is stored in the network byte order.
     */
    uint32_t intf_netmask;

    /** The MAC address of the interface.
     *
     *  @detailed
     *    The field is set to zero for local loopback interface.
     */
    uint8_t  intf_mac_address[6];

    /** @cond __PRIVATE */
    /** Explicit structure padding. */
    uint8_t  pad[2];
    /** @endcond */

    /** Current interface link status.
     *
     *  @detailed
     *    Indication of the interface link status from the underlying ethernet
     *    driver. The value 0 indicates link down, the value 1 link up.
     *    This member is set to 0 for the localhost loopback interface.
     */
    uint32_t intf_link_status;

    /** Current interface link speed.
     *
     *  @detailed
     *    Indication of the interface link speed from the underlying ethernet
     *    driver in megabits per second.
     *    This member is set to 0 for the localhost loopback interface.
     */
    uint32_t intf_link_speed;

    /** The number of FRAG_TIMEOUT class errors.
     *
     * @detailed
     *   It is incremented if the fragmentation timeout between reception of
     *   two consecutive fragments belonging to the same IP datagram is
     *   exceeded.
     */
    uint32_t instr_fragTimeout;

    /** The number of FRAG_SPACE class errors.
     *
     * @detailed
     *   It is incremented if the maximum number of concurrent fragmented IP
     *   datagrams supported is exceeded.
     */
    uint32_t instr_fragSpace;

    /** The number of FRAG_ERROR class errors.
     *
     * @detailed
     *   It is incremented if fragments are received out of order and either no
     *   previous fragment of the datagram was received or the previous
     *   received fragments were dropped due to other constraints
     *   (e.g. time out).
     */
    uint32_t instr_fragError;

    /** The number of FRAG_OFFSET class errors.
     *
     * @detailed
     *   It is incremented if fragments are received out of order and at least
     *   one previous fragment was received.
     */
    uint32_t instr_fragOffset;

    /** The number of SOCK_RECVBUF class errors.
     *
     * @detailed
     *   It is incremented if a IP datagram is received which would cause the
     *   destination socket to exceed its receive buffer size limit.
     */
    uint32_t instr_sockRecvBuf;

    /** The number of ICMP_TYPE class errors.
     *
     * @detailed
     *   It is incremented if an ICMP datagram is received with invalid or
     *   unsupported values in the ICMP "Type" or "Code" header fields.
     */
    uint32_t instr_icmpType;

    /** The number of ICMP_FRAG class errors.
     *
     * @detailed
     *   It is incremented if an ICMP datagram is received with
     *   the fragmentation bit set in the IP header.
     */
    uint32_t instr_icmpFrag;

    /** The number of ICMP_CHKSUM class errors.
     *
     * @detailed
     *   It is incremented if an ICMP datagram with invalid checksum is
     *   received.
     */
    uint32_t instr_icmpSum;

    /** The number of IGMP_TYPE class errors.
     *
     * @detailed
     *   It is incremented if an IGMP datagram is received with invalid or
     *   unsupported values in the IGMP "Type" header field.
     */
    uint32_t instr_igmpType;

    /** The number of IGMP_FRAG class errors.
     *
     * @detailed
     *   It is incremented if an IGMP datagram is received with
     *   the fragmentation bit set in the IP header.
     */
    uint32_t instr_igmpFrag;

    /** The number of IGMP_CHKSUM class errors.
     *
     * @detailed
     *   It is incremented if an IGMP datagram with invalid checksum is
     *   received.
     */
    uint32_t instr_igmpSum;

    /** The number of IP_CHKSUM class errors.
     *
     * @detailed
     *   It is incremented if an IP datagram with invalid checksum is
     *   received.
     */
    uint32_t instr_ipSum;

    /** The number of IP_HDR class errors.
     *
     * @detailed
     *   It is incremented if an IP datagram with invalid or unsupported values
     *   in the header (except those covered by IP_SIZE and IP_PROTO) is
     *   received.
     */
    uint32_t instr_ipHeaderConstant;

    /** The number of IP_SIZE class errors.
     *
     * @detailed
     *   It is incremented if an IP datagram with an invalid value in the
     *   "Total Length" header field is received.
     */
    uint32_t instr_ipSize;

    /** The number of IP_PROTO class errors.
     *
     * @detailed
     *   It is incremented if an IP datagram with invalid or unsupported value
     *   in the IP header "Protocol" field is received.
     */
    uint32_t instr_ipProtocol;

    /** The number of NO_SOCK class errors.
     *
     * @detailed
     *   It is incremented if a UDP datagram is received, but no socket is
     *   bound to the destination address.
     */
    uint32_t instr_noSocket;

    /** The number of BAD_IP class errors.
     *
     * @detailed
     *   It is incremented if an IP datagram is received, but the destination
     *   address does match neither the configured address nor the broadcast
     *   address. It is also incremented if the source address is a broadcast
     *   address, multicast address or a local loopback address.
     */
    uint32_t instr_badIP;

    /** The number of HOST_UNREACHABLE class errors
     *
     * @detailed
     *   It is incremented if the application tried to send data
     *   to a host, which is not reachable.
     */
    uint32_t instr_hostUnreach;

    /** The number of ARP_PROTO class errors
     *
     * @detailed

     *   It is incremented if the ANISFP stack receives ARP packet with
     *   unexpected content in the ARP header.
     *
     */
    uint32_t instr_arpProtocol;

    /** The number of TX_DROP class errors
     *
     * @detailed
     *   It is incremented if the ethernet driver reports an error in
     *   transmit (vm_write()) operation. This counter is
     *   not used if the txErrorFatal configuration property is true.
     *
     */
    uint32_t instr_txDrop;

} anis_instr_intf_stat_t;

/**
 *  @brief
 *    ANIS instrumentation API data structure.
 *
 *  @detailed
 *    This data structure is used to communicate network interface statistics
 *    to an application.
 */
/* @SYSGO_RQ IF_ANIS-3132 */
typedef struct anis_instr_stat_s {
    /** The number of SEND_NOSRC class errors.
     *
     * @detailed
     *   It is incremented if the application tried to send on an unbound
     *   socket.
     */
    uint32_t instr_sendNoSrc;

    /** The number of UDP_LENGTH class errors
     *
     * @detailed
     *   It is incremented if a UDP datagram is reassembled
     *   and some data left in the buffer for reassembly.
     */
    uint32_t instr_udpLength;


    /** The number of UDP_CHKSUM class errors
     *
     * @detailed
     *   It is incremented if a UDP datagram with invalid checksum is
     *   received. In the certified ANIS variant this is only checked for UDP
     *   datagrams that are fragmented at the IP level.
     */
    uint32_t instr_udpSum;

    /** The number of SOCKET_LIST class errors.
     *
     *  @detailed
     *    ANIS reserves internal memory to store association between multicast
     * packets and receiving sockets. If a packet is not delivered to a socket
     * because ANIS ran out of memory, this counter is incremented.
     *
     */
    uint32_t instr_socketList;

    /** Interface specific counters
     *
     * @detailed
     *   Field of \a anis_instr_intf_stat_t structures to access interface
     *   specific counters.
     */
    anis_instr_intf_stat_t intf[ANIS_ALL_INTF];

} anis_instr_stat_t;

/** @} */

#endif /* INSTR_API_COMMON_H */