ip.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2014-2018 Linaro Limited
 */
 
#ifndef ODPH_IP_H_
#define ODPH_IP_H_
 
#include <odp_api.h>
#include <odp/helper/chksum.h>
 
#include <string.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ODPH_IPV4             4  
#define ODPH_IPV4HDR_LEN     20  
#define ODPH_IPV4HDR_IHL_MIN  5  
#define ODPH_IPV4ADDR_LEN     4  
#define ODPH_IP_TOS_MAX_DSCP   63    
#define ODPH_IP_TOS_DSCP_MASK  0xFC  
#define ODPH_IP_TOS_DSCP_SHIFT 2     
#define ODPH_IP_TOS_MAX_ECN    3     
#define ODPH_IP_TOS_ECN_MASK   0x03  
#define ODPH_IP_TOS_ECN_SHIFT  0     
#define ODPH_IP_ECN_NOT_ECT  0  
#define ODPH_IP_ECN_ECT1     1  
#define ODPH_IP_ECN_ECT0     2  
#define ODPH_IP_ECN_CE       3  
#define ODPH_IPV4HDR_VER(ver_ihl) (((ver_ihl) & 0xf0) >> 4)
 
#define ODPH_IPV4HDR_IHL(ver_ihl) ((ver_ihl) & 0x0f)
 
#define ODPH_IPV4HDR_DSCP(tos) (((tos) & 0xfc) >> 2)
 
#define ODPH_IPV4HDR_FLAGS_DONT_FRAG(frag_offset)  ((frag_offset) & 0x4000)
 
#define ODPH_IPV4HDR_FLAGS_MORE_FRAGS(frag_offset)  ((frag_offset) & 0x2000)
 
#define ODPH_IPV4HDR_FRAG_OFFSET(frag_offset) ((frag_offset) & 0x1fff)
 
#define ODPH_IPV4HDR_IS_FRAGMENT(frag_offset) ((frag_offset) & 0x3fff)
 
#define ODPH_IPV4HDR_CSUM_OFFSET    10
 
typedef struct ODP_PACKED {
    uint8_t    ver_ihl;     
    uint8_t    tos;         
    odp_u16be_t tot_len;    
    odp_u16be_t id;         
    odp_u16be_t frag_offset;
    uint8_t    ttl;         
    uint8_t    proto;       
    odp_u16sum_t chksum;    
    odp_u32be_t src_addr;   
    odp_u32be_t dst_addr;   
} odph_ipv4hdr_t;
 
ODP_STATIC_ASSERT(sizeof(odph_ipv4hdr_t) == ODPH_IPV4HDR_LEN,
          "ODPH_IPV4HDR_T__SIZE_ERROR");
static inline int odph_ipv4_csum(odp_packet_t pkt,
                 uint32_t offset,
                 odph_ipv4hdr_t *ip,
                 odp_u16sum_t *chksum)
{
    uint32_t nleft = (uint32_t)(ODPH_IPV4HDR_IHL(ip->ver_ihl) * 4);
    const int max_ip_header_len = 15 * 4;
    uint16_t buf[max_ip_header_len];
    int res;
 
    if (odp_unlikely(nleft < sizeof(*ip)))
        return -1;
    ip->chksum = 0;
    memcpy(buf, ip, sizeof(*ip));
    res = odp_packet_copy_to_mem(pkt, offset + (uint32_t)sizeof(*ip),
                     nleft - (uint32_t)sizeof(*ip),
                     buf + sizeof(*ip) / 2);
    if (odp_unlikely(res < 0))
        return res;
 
    *chksum = (odp_u16sum_t)~odp_chksum_ones_comp16(buf, nleft);
 
    return 0;
}
 
static inline int odph_ipv4_csum_valid(odp_packet_t pkt)
{
    uint32_t offset;
    int res;
    odph_ipv4hdr_t ip;
    odp_u16sum_t chksum, cur_chksum;
 
    offset = odp_packet_l3_offset(pkt);
    if (offset == ODP_PACKET_OFFSET_INVALID)
        return 0;
 
    res = odp_packet_copy_to_mem(pkt, offset, sizeof(odph_ipv4hdr_t), &ip);
    if (odp_unlikely(res < 0))
        return 0;
 
    chksum = ip.chksum;
 
    res = odph_ipv4_csum(pkt, offset, &ip, &cur_chksum);
    if (odp_unlikely(res < 0))
        return 0;
 
    return (cur_chksum == chksum) ? 1 : 0;
}
 
static inline int odph_ipv4_csum_update(odp_packet_t pkt)
{
    uint32_t offset;
    odph_ipv4hdr_t ip;
    odp_u16sum_t chksum;
    int res;
 
    offset = odp_packet_l3_offset(pkt);
    if (offset == ODP_PACKET_OFFSET_INVALID)
        return -1;
 
    res = odp_packet_copy_to_mem(pkt, offset, sizeof(ip), &ip);
    if (odp_unlikely(res < 0))
        return res;
 
    res = odph_ipv4_csum(pkt, offset, &ip, &chksum);
    if (odp_unlikely(res < 0))
        return res;
 
    return odp_packet_copy_from_mem(pkt,
                    offset + ODPH_IPV4HDR_CSUM_OFFSET,
                    2, &chksum);
}
 
#define ODPH_IPV6 6
 
#define ODPH_IPV6HDR_LEN 40
 
#define ODPH_IPV6ADDR_LEN 16
 
#define ODPH_IPV6HDR_VERSION_MASK     0xF0000000 
#define ODPH_IPV6HDR_VERSION_SHIFT    28         
#define ODPH_IPV6HDR_TC_MASK          0x0FF00000 
#define ODPH_IPV6HDR_TC_SHIFT         20         
#define ODPH_IPV6HDR_FLOW_LABEL_MASK  0x000FFFFF 
#define ODPH_IPV6HDR_FLOW_LABEL_SHIFT 0          
#define ODPH_IPV6HDR_DSCP(ver_tc_flow) \
    (uint8_t)((((ver_tc_flow) & 0x0fc00000) >> 22) & 0xff)
 
typedef struct ODP_PACKED {
    odp_u32be_t ver_tc_flow; 
    odp_u16be_t payload_len; 
    uint8_t    next_hdr;     
    uint8_t    hop_limit;    
    uint8_t    src_addr[16]; 
    uint8_t    dst_addr[16]; 
} odph_ipv6hdr_t;
 
ODP_STATIC_ASSERT(sizeof(odph_ipv6hdr_t) == ODPH_IPV6HDR_LEN,
          "ODPH_IPV6HDR_T__SIZE_ERROR");
typedef struct ODP_PACKED {
    uint8_t    next_hdr;     
    uint8_t    ext_len;      
    uint8_t    filler[6];    
} odph_ipv6hdr_ext_t;
 
/*
 * IP protocol values (IPv4:'proto' or IPv6:'next_hdr')
 */
#define ODPH_IPPROTO_HOPOPTS 0x00 
#define ODPH_IPPROTO_ICMPV4  0x01 
#define ODPH_IPPROTO_IGMP    0x02 
#define ODPH_IPPROTO_TCP     0x06 
#define ODPH_IPPROTO_UDP     0x11 
#define ODPH_IPPROTO_ROUTE   0x2B 
#define ODPH_IPPROTO_FRAG    0x2C 
#define ODPH_IPPROTO_AH      0x33 
#define ODPH_IPPROTO_ESP     0x32 
#define ODPH_IPPROTO_ICMPV6  0x3A 
#define ODPH_IPPROTO_SCTP    0x84 
#define ODPH_IPPROTO_INVALID 0xFF 
int odph_ipv4_addr_parse(uint32_t *ip_addr, const char *str);
 
#ifdef __cplusplus
}
#endif
 
#endif