rte_ipsec_sa.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Intel Corporation
 */

#ifndef _RTE_IPSEC_SA_H_
#define _RTE_IPSEC_SA_H_

#include <rte_common.h>
#include <rte_cryptodev.h>
#include <rte_security.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_ipsec_sa;

struct rte_ipsec_sa_prm {

    uint64_t userdata; 
    uint64_t flags;  
    struct rte_security_ipsec_xform ipsec_xform;
    struct rte_crypto_sym_xform *crypto_xform;
    union {
        struct {
            uint8_t hdr_len;     
            uint8_t hdr_l3_off;  
            uint8_t next_proto;  
            const void *hdr;     
        } tun; 
        struct {
            uint8_t proto;  
        } trs; 
    };
};

#define RTE_IPSEC_SAFLAG_SQN_ATOM   (1ULL << 0)

enum {
    RTE_SATP_LOG2_IPV,
    RTE_SATP_LOG2_PROTO,
    RTE_SATP_LOG2_DIR,
    RTE_SATP_LOG2_MODE,
    RTE_SATP_LOG2_SQN = RTE_SATP_LOG2_MODE + 2,
    RTE_SATP_LOG2_ESN,
    RTE_SATP_LOG2_ECN,
    RTE_SATP_LOG2_DSCP,
    RTE_SATP_LOG2_NUM
};

#define RTE_IPSEC_SATP_IPV_MASK     (1ULL << RTE_SATP_LOG2_IPV)
#define RTE_IPSEC_SATP_IPV4     (0ULL << RTE_SATP_LOG2_IPV)
#define RTE_IPSEC_SATP_IPV6     (1ULL << RTE_SATP_LOG2_IPV)

#define RTE_IPSEC_SATP_PROTO_MASK   (1ULL << RTE_SATP_LOG2_PROTO)
#define RTE_IPSEC_SATP_PROTO_AH     (0ULL << RTE_SATP_LOG2_PROTO)
#define RTE_IPSEC_SATP_PROTO_ESP    (1ULL << RTE_SATP_LOG2_PROTO)

#define RTE_IPSEC_SATP_DIR_MASK     (1ULL << RTE_SATP_LOG2_DIR)
#define RTE_IPSEC_SATP_DIR_IB       (0ULL << RTE_SATP_LOG2_DIR)
#define RTE_IPSEC_SATP_DIR_OB       (1ULL << RTE_SATP_LOG2_DIR)

#define RTE_IPSEC_SATP_MODE_MASK    (3ULL << RTE_SATP_LOG2_MODE)
#define RTE_IPSEC_SATP_MODE_TRANS   (0ULL << RTE_SATP_LOG2_MODE)
#define RTE_IPSEC_SATP_MODE_TUNLV4  (1ULL << RTE_SATP_LOG2_MODE)
#define RTE_IPSEC_SATP_MODE_TUNLV6  (2ULL << RTE_SATP_LOG2_MODE)

#define RTE_IPSEC_SATP_SQN_MASK     (1ULL << RTE_SATP_LOG2_SQN)
#define RTE_IPSEC_SATP_SQN_RAW      (0ULL << RTE_SATP_LOG2_SQN)
#define RTE_IPSEC_SATP_SQN_ATOM     (1ULL << RTE_SATP_LOG2_SQN)

#define RTE_IPSEC_SATP_ESN_MASK     (1ULL << RTE_SATP_LOG2_ESN)
#define RTE_IPSEC_SATP_ESN_DISABLE  (0ULL << RTE_SATP_LOG2_ESN)
#define RTE_IPSEC_SATP_ESN_ENABLE   (1ULL << RTE_SATP_LOG2_ESN)

#define RTE_IPSEC_SATP_ECN_MASK     (1ULL << RTE_SATP_LOG2_ECN)
#define RTE_IPSEC_SATP_ECN_DISABLE  (0ULL << RTE_SATP_LOG2_ECN)
#define RTE_IPSEC_SATP_ECN_ENABLE   (1ULL << RTE_SATP_LOG2_ECN)

#define RTE_IPSEC_SATP_DSCP_MASK    (1ULL << RTE_SATP_LOG2_DSCP)
#define RTE_IPSEC_SATP_DSCP_DISABLE (0ULL << RTE_SATP_LOG2_DSCP)
#define RTE_IPSEC_SATP_DSCP_ENABLE  (1ULL << RTE_SATP_LOG2_DSCP)

__rte_experimental
uint64_t
rte_ipsec_sa_type(const struct rte_ipsec_sa *sa);

__rte_experimental
int
rte_ipsec_sa_size(const struct rte_ipsec_sa_prm *prm);

__rte_experimental
int
rte_ipsec_sa_init(struct rte_ipsec_sa *sa, const struct rte_ipsec_sa_prm *prm,
    uint32_t size);

__rte_experimental
void
rte_ipsec_sa_fini(struct rte_ipsec_sa *sa);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_IPSEC_SA_H_ */