LXR linux/drivers/crypto/chelsio/chtls/chtls.h

   1/*
   2 * Copyright (c) 2018 Chelsio Communications, Inc.
   3 *
   4 * This program is free software; you can redistribute it and/or modify
   5 * it under the terms of the GNU General Public License version 2 as
   6 * published by the Free Software Foundation.
   7 */
   8
   9#ifndef __CHTLS_H__
  10#define __CHTLS_H__
  11
  12#include <crypto/aes.h>
  13#include <crypto/algapi.h>
  14#include <crypto/hash.h>
  15#include <crypto/sha.h>
  16#include <crypto/authenc.h>
  17#include <crypto/ctr.h>
  18#include <crypto/gf128mul.h>
  19#include <crypto/internal/aead.h>
  20#include <crypto/null.h>
  21#include <crypto/internal/skcipher.h>
  22#include <crypto/aead.h>
  23#include <crypto/scatterwalk.h>
  24#include <crypto/internal/hash.h>
  25#include <linux/tls.h>
  26#include <net/tls.h>
  27
  28#include "t4fw_api.h"
  29#include "t4_msg.h"
  30#include "cxgb4.h"
  31#include "cxgb4_uld.h"
  32#include "l2t.h"
  33#include "chcr_algo.h"
  34#include "chcr_core.h"
  35#include "chcr_crypto.h"
  36
  37#define MAX_IVS_PAGE                    256
  38#define TLS_KEY_CONTEXT_SZ              64
  39#define CIPHER_BLOCK_SIZE               16
  40#define GCM_TAG_SIZE                    16
  41#define KEY_ON_MEM_SZ                   16
  42#define AEAD_EXPLICIT_DATA_SIZE         8
  43#define TLS_HEADER_LENGTH               5
  44#define SCMD_CIPH_MODE_AES_GCM          2
  45/* Any MFS size should work and come from openssl */
  46#define TLS_MFS                         16384
  47
  48#define RSS_HDR sizeof(struct rss_header)
  49#define TLS_WR_CPL_LEN \
  50        (sizeof(struct fw_tlstx_data_wr) + sizeof(struct cpl_tx_tls_sfo))
  51
  52enum {
  53        CHTLS_KEY_CONTEXT_DSGL,
  54        CHTLS_KEY_CONTEXT_IMM,
  55        CHTLS_KEY_CONTEXT_DDR,
  56};
  57
  58enum {
  59        CHTLS_LISTEN_START,
  60        CHTLS_LISTEN_STOP,
  61};
  62
  63/* Flags for return value of CPL message handlers */
  64enum {
  65        CPL_RET_BUF_DONE =    1,   /* buffer processing done */
  66        CPL_RET_BAD_MSG =     2,   /* bad CPL message */
  67        CPL_RET_UNKNOWN_TID = 4    /* unexpected unknown TID */
  68};
  69
  70#define LISTEN_INFO_HASH_SIZE 32
  71#define RSPQ_HASH_BITS 5
  72struct listen_info {
  73        struct listen_info *next;  /* Link to next entry */
  74        struct sock *sk;           /* The listening socket */
  75        unsigned int stid;         /* The server TID */
  76};
  77
  78enum {
  79        T4_LISTEN_START_PENDING,
  80        T4_LISTEN_STARTED
  81};
  82
  83enum csk_flags {
  84        CSK_CALLBACKS_CHKD,     /* socket callbacks have been sanitized */
  85        CSK_ABORT_REQ_RCVD,     /* received one ABORT_REQ_RSS message */
  86        CSK_TX_MORE_DATA,       /* sending ULP data; don't set SHOVE bit */
  87        CSK_TX_WAIT_IDLE,       /* suspend Tx until in-flight data is ACKed */
  88        CSK_ABORT_SHUTDOWN,     /* shouldn't send more abort requests */
  89        CSK_ABORT_RPL_PENDING,  /* expecting an abort reply */
  90        CSK_CLOSE_CON_REQUESTED,/* we've sent a close_conn_req */
  91        CSK_TX_DATA_SENT,       /* sent a TX_DATA WR on this connection */
  92        CSK_TX_FAILOVER,        /* Tx traffic failing over */
  93        CSK_UPDATE_RCV_WND,     /* Need to update rcv window */
  94        CSK_RST_ABORTED,        /* outgoing RST was aborted */
  95        CSK_TLS_HANDSHK,        /* TLS Handshake */
  96        CSK_CONN_INLINE,        /* Connection on HW */
  97};
  98
  99struct listen_ctx {
 100        struct sock *lsk;
 101        struct chtls_dev *cdev;
 102        struct sk_buff_head synq;
 103        u32 state;
 104};
 105
 106struct key_map {
 107        unsigned long *addr;
 108        unsigned int start;
 109        unsigned int available;
 110        unsigned int size;
 111        spinlock_t lock; /* lock for key id request from map */
 112} __packed;
 113
 114struct tls_scmd {
 115        u32 seqno_numivs;
 116        u32 ivgen_hdrlen;
 117};
 118
 119struct chtls_dev {
 120        struct tls_device tlsdev;
 121        struct list_head list;
 122        struct cxgb4_lld_info *lldi;
 123        struct pci_dev *pdev;
 124        struct listen_info *listen_hash_tab[LISTEN_INFO_HASH_SIZE];
 125        spinlock_t listen_lock; /* lock for listen list */
 126        struct net_device **ports;
 127        struct tid_info *tids;
 128        unsigned int pfvf;
 129        const unsigned short *mtus;
 130
 131        struct idr hwtid_idr;
 132        struct idr stid_idr;
 133
 134        spinlock_t idr_lock ____cacheline_aligned_in_smp;
 135
 136        struct net_device *egr_dev[NCHAN * 2];
 137        struct sk_buff *rspq_skb_cache[1 << RSPQ_HASH_BITS];
 138        struct sk_buff *askb;
 139
 140        struct sk_buff_head deferq;
 141        struct work_struct deferq_task;
 142
 143        struct list_head list_node;
 144        struct list_head rcu_node;
 145        struct list_head na_node;
 146        unsigned int send_page_order;
 147        int max_host_sndbuf;
 148        struct key_map kmap;
 149};
 150
 151struct chtls_hws {
 152        struct sk_buff_head sk_recv_queue;
 153        u8 txqid;
 154        u8 ofld;
 155        u16 type;
 156        u16 rstate;
 157        u16 keyrpl;
 158        u16 pldlen;
 159        u16 rcvpld;
 160        u16 compute;
 161        u16 expansion;
 162        u16 keylen;
 163        u16 pdus;
 164        u16 adjustlen;
 165        u16 ivsize;
 166        u16 txleft;
 167        u32 mfs;
 168        s32 txkey;
 169        s32 rxkey;
 170        u32 fcplenmax;
 171        u32 copied_seq;
 172        u64 tx_seq_no;
 173        struct tls_scmd scmd;
 174        struct tls12_crypto_info_aes_gcm_128 crypto_info;
 175};
 176
 177struct chtls_sock {
 178        struct sock *sk;
 179        struct chtls_dev *cdev;
 180        struct l2t_entry *l2t_entry;    /* pointer to the L2T entry */
 181        struct net_device *egress_dev;  /* TX_CHAN for act open retry */
 182
 183        struct sk_buff_head txq;
 184        struct sk_buff *wr_skb_head;
 185        struct sk_buff *wr_skb_tail;
 186        struct sk_buff *ctrl_skb_cache;
 187        struct sk_buff *txdata_skb_cache; /* abort path messages */
 188        struct kref kref;
 189        unsigned long flags;
 190        u32 opt2;
 191        u32 wr_credits;
 192        u32 wr_unacked;
 193        u32 wr_max_credits;
 194        u32 wr_nondata;
 195        u32 hwtid;               /* TCP Control Block ID */
 196        u32 txq_idx;
 197        u32 rss_qid;
 198        u32 tid;
 199        u32 idr;
 200        u32 mss;
 201        u32 ulp_mode;
 202        u32 tx_chan;
 203        u32 rx_chan;
 204        u32 sndbuf;
 205        u32 txplen_max;
 206        u32 mtu_idx;           /* MTU table index */
 207        u32 smac_idx;
 208        u8 port_id;
 209        u8 tos;
 210        u16 resv2;
 211        u32 delack_mode;
 212        u32 delack_seq;
 213
 214        void *passive_reap_next;        /* placeholder for passive */
 215        struct chtls_hws tlshws;
 216        struct synq {
 217                struct sk_buff *next;
 218                struct sk_buff *prev;
 219        } synq;
 220        struct listen_ctx *listen_ctx;
 221};
 222
 223struct tls_hdr {
 224        u8  type;
 225        u16 version;
 226        u16 length;
 227} __packed;
 228
 229struct tlsrx_cmp_hdr {
 230        u8  type;
 231        u16 version;
 232        u16 length;
 233
 234        u64 tls_seq;
 235        u16 reserved1;
 236        u8  res_to_mac_error;
 237} __packed;
 238
 239/* res_to_mac_error fields */
 240#define TLSRX_HDR_PKT_INT_ERROR_S   4
 241#define TLSRX_HDR_PKT_INT_ERROR_M   0x1
 242#define TLSRX_HDR_PKT_INT_ERROR_V(x) \
 243        ((x) << TLSRX_HDR_PKT_INT_ERROR_S)
 244#define TLSRX_HDR_PKT_INT_ERROR_G(x) \
 245        (((x) >> TLSRX_HDR_PKT_INT_ERROR_S) & TLSRX_HDR_PKT_INT_ERROR_M)
 246#define TLSRX_HDR_PKT_INT_ERROR_F   TLSRX_HDR_PKT_INT_ERROR_V(1U)
 247
 248#define TLSRX_HDR_PKT_SPP_ERROR_S        3
 249#define TLSRX_HDR_PKT_SPP_ERROR_M        0x1
 250#define TLSRX_HDR_PKT_SPP_ERROR_V(x)     ((x) << TLSRX_HDR_PKT_SPP_ERROR)
 251#define TLSRX_HDR_PKT_SPP_ERROR_G(x)     \
 252        (((x) >> TLSRX_HDR_PKT_SPP_ERROR_S) & TLSRX_HDR_PKT_SPP_ERROR_M)
 253#define TLSRX_HDR_PKT_SPP_ERROR_F        TLSRX_HDR_PKT_SPP_ERROR_V(1U)
 254
 255#define TLSRX_HDR_PKT_CCDX_ERROR_S       2
 256#define TLSRX_HDR_PKT_CCDX_ERROR_M       0x1
 257#define TLSRX_HDR_PKT_CCDX_ERROR_V(x)    ((x) << TLSRX_HDR_PKT_CCDX_ERROR_S)
 258#define TLSRX_HDR_PKT_CCDX_ERROR_G(x)    \
 259        (((x) >> TLSRX_HDR_PKT_CCDX_ERROR_S) & TLSRX_HDR_PKT_CCDX_ERROR_M)
 260#define TLSRX_HDR_PKT_CCDX_ERROR_F       TLSRX_HDR_PKT_CCDX_ERROR_V(1U)
 261
 262#define TLSRX_HDR_PKT_PAD_ERROR_S        1
 263#define TLSRX_HDR_PKT_PAD_ERROR_M        0x1
 264#define TLSRX_HDR_PKT_PAD_ERROR_V(x)     ((x) << TLSRX_HDR_PKT_PAD_ERROR_S)
 265#define TLSRX_HDR_PKT_PAD_ERROR_G(x)     \
 266        (((x) >> TLSRX_HDR_PKT_PAD_ERROR_S) & TLSRX_HDR_PKT_PAD_ERROR_M)
 267#define TLSRX_HDR_PKT_PAD_ERROR_F        TLSRX_HDR_PKT_PAD_ERROR_V(1U)
 268
 269#define TLSRX_HDR_PKT_MAC_ERROR_S        0
 270#define TLSRX_HDR_PKT_MAC_ERROR_M        0x1
 271#define TLSRX_HDR_PKT_MAC_ERROR_V(x)     ((x) << TLSRX_HDR_PKT_MAC_ERROR)
 272#define TLSRX_HDR_PKT_MAC_ERROR_G(x)     \
 273        (((x) >> S_TLSRX_HDR_PKT_MAC_ERROR_S) & TLSRX_HDR_PKT_MAC_ERROR_M)
 274#define TLSRX_HDR_PKT_MAC_ERROR_F        TLSRX_HDR_PKT_MAC_ERROR_V(1U)
 275
 276#define TLSRX_HDR_PKT_ERROR_M           0x1F
 277#define CONTENT_TYPE_ERROR              0x7F
 278
 279struct ulp_mem_rw {
 280        __be32 cmd;
 281        __be32 len16;             /* command length */
 282        __be32 dlen;              /* data length in 32-byte units */
 283        __be32 lock_addr;
 284};
 285
 286struct tls_key_wr {
 287        __be32 op_to_compl;
 288        __be32 flowid_len16;
 289        __be32 ftid;
 290        u8   reneg_to_write_rx;
 291        u8   protocol;
 292        __be16 mfs;
 293};
 294
 295struct tls_key_req {
 296        struct tls_key_wr wr;
 297        struct ulp_mem_rw req;
 298        struct ulptx_idata sc_imm;
 299};
 300
 301/*
 302 * This lives in skb->cb and is used to chain WRs in a linked list.
 303 */
 304struct wr_skb_cb {
 305        struct l2t_skb_cb l2t;          /* reserve space for l2t CB */
 306        struct sk_buff *next_wr;        /* next write request */
 307};
 308
 309/* Per-skb backlog handler.  Run when a socket's backlog is processed. */
 310struct blog_skb_cb {
 311        void (*backlog_rcv)(struct sock *sk, struct sk_buff *skb);
 312        struct chtls_dev *cdev;
 313};
 314
 315/*
 316 * Similar to tcp_skb_cb but with ULP elements added to support TLS,
 317 * etc.
 318 */
 319struct ulp_skb_cb {
 320        struct wr_skb_cb wr;            /* reserve space for write request */
 321        u16 flags;                      /* TCP-like flags */
 322        u8 psh;
 323        u8 ulp_mode;                    /* ULP mode/submode of sk_buff */
 324        u32 seq;                        /* TCP sequence number */
 325        union { /* ULP-specific fields */
 326                struct {
 327                        u8  type;
 328                        u8  ofld;
 329                        u8  iv;
 330                } tls;
 331        } ulp;
 332};
 333
 334#define ULP_SKB_CB(skb) ((struct ulp_skb_cb *)&((skb)->cb[0]))
 335#define BLOG_SKB_CB(skb) ((struct blog_skb_cb *)(skb)->cb)
 336
 337/*
 338 * Flags for ulp_skb_cb.flags.
 339 */
 340enum {
 341        ULPCB_FLAG_NEED_HDR  = 1 << 0,  /* packet needs a TX_DATA_WR header */
 342        ULPCB_FLAG_NO_APPEND = 1 << 1,  /* don't grow this skb */
 343        ULPCB_FLAG_BARRIER   = 1 << 2,  /* set TX_WAIT_IDLE after sending */
 344        ULPCB_FLAG_HOLD      = 1 << 3,  /* skb not ready for Tx yet */
 345        ULPCB_FLAG_COMPL     = 1 << 4,  /* request WR completion */
 346        ULPCB_FLAG_URG       = 1 << 5,  /* urgent data */
 347        ULPCB_FLAG_TLS_HDR   = 1 << 6,  /* payload with tls hdr */
 348        ULPCB_FLAG_NO_HDR    = 1 << 7,  /* not a ofld wr */
 349};
 350
 351/* The ULP mode/submode of an skbuff */
 352#define skb_ulp_mode(skb)  (ULP_SKB_CB(skb)->ulp_mode)
 353#define TCP_PAGE(sk)   (sk->sk_frag.page)
 354#define TCP_OFF(sk)    (sk->sk_frag.offset)
 355
 356static inline struct chtls_dev *to_chtls_dev(struct tls_device *tlsdev)
 357{
 358        return container_of(tlsdev, struct chtls_dev, tlsdev);
 359}
 360
 361static inline void csk_set_flag(struct chtls_sock *csk,
 362                                enum csk_flags flag)
 363{
 364        __set_bit(flag, &csk->flags);
 365}
 366
 367static inline void csk_reset_flag(struct chtls_sock *csk,
 368                                  enum csk_flags flag)
 369{
 370        __clear_bit(flag, &csk->flags);
 371}
 372
 373static inline bool csk_conn_inline(const struct chtls_sock *csk)
 374{
 375        return test_bit(CSK_CONN_INLINE, &csk->flags);
 376}
 377
 378static inline int csk_flag(const struct sock *sk, enum csk_flags flag)
 379{
 380        struct chtls_sock *csk = rcu_dereference_sk_user_data(sk);
 381
 382        if (!csk_conn_inline(csk))
 383                return 0;
 384        return test_bit(flag, &csk->flags);
 385}
 386
 387static inline int csk_flag_nochk(const struct chtls_sock *csk,
 388                                 enum csk_flags flag)
 389{
 390        return test_bit(flag, &csk->flags);
 391}
 392
 393static inline void *cplhdr(struct sk_buff *skb)
 394{
 395        return skb->data;
 396}
 397
 398static inline int is_neg_adv(unsigned int status)
 399{
 400        return status == CPL_ERR_RTX_NEG_ADVICE ||
 401               status == CPL_ERR_KEEPALV_NEG_ADVICE ||
 402               status == CPL_ERR_PERSIST_NEG_ADVICE;
 403}
 404
 405static inline void process_cpl_msg(void (*fn)(struct sock *, struct sk_buff *),
 406                                   struct sock *sk,
 407                                   struct sk_buff *skb)
 408{
 409        skb_reset_mac_header(skb);
 410        skb_reset_network_header(skb);
 411        skb_reset_transport_header(skb);
 412
 413        bh_lock_sock(sk);
 414        if (unlikely(sock_owned_by_user(sk))) {
 415                BLOG_SKB_CB(skb)->backlog_rcv = fn;
 416                __sk_add_backlog(sk, skb);
 417        } else {
 418                fn(sk, skb);
 419        }
 420        bh_unlock_sock(sk);
 421}
 422
 423static inline void chtls_sock_free(struct kref *ref)
 424{
 425        struct chtls_sock *csk = container_of(ref, struct chtls_sock,
 426                                              kref);
 427        kfree(csk);
 428}
 429
 430static inline void __chtls_sock_put(const char *fn, struct chtls_sock *csk)
 431{
 432        kref_put(&csk->kref, chtls_sock_free);
 433}
 434
 435static inline void __chtls_sock_get(const char *fn,
 436                                    struct chtls_sock *csk)
 437{
 438        kref_get(&csk->kref);
 439}
 440
 441static inline void send_or_defer(struct sock *sk, struct tcp_sock *tp,
 442                                 struct sk_buff *skb, int through_l2t)
 443{
 444        struct chtls_sock *csk = rcu_dereference_sk_user_data(sk);
 445
 446        if (through_l2t) {
 447                /* send through L2T */
 448                cxgb4_l2t_send(csk->egress_dev, skb, csk->l2t_entry);
 449        } else {
 450                /* send directly */
 451                cxgb4_ofld_send(csk->egress_dev, skb);
 452        }
 453}
 454
 455typedef int (*chtls_handler_func)(struct chtls_dev *, struct sk_buff *);
 456extern chtls_handler_func chtls_handlers[NUM_CPL_CMDS];
 457void chtls_install_cpl_ops(struct sock *sk);
 458int chtls_init_kmap(struct chtls_dev *cdev, struct cxgb4_lld_info *lldi);
 459void chtls_listen_stop(struct chtls_dev *cdev, struct sock *sk);
 460int chtls_listen_start(struct chtls_dev *cdev, struct sock *sk);
 461void chtls_close(struct sock *sk, long timeout);
 462int chtls_disconnect(struct sock *sk, int flags);
 463void chtls_shutdown(struct sock *sk, int how);
 464void chtls_destroy_sock(struct sock *sk);
 465int chtls_sendmsg(struct sock *sk, struct msghdr *msg, size_t size);
 466int chtls_recvmsg(struct sock *sk, struct msghdr *msg,
 467                  size_t len, int nonblock, int flags, int *addr_len);
 468int chtls_sendpage(struct sock *sk, struct page *page,
 469                   int offset, size_t size, int flags);
 470int send_tx_flowc_wr(struct sock *sk, int compl,
 471                     u32 snd_nxt, u32 rcv_nxt);
 472void chtls_tcp_push(struct sock *sk, int flags);
 473int chtls_push_frames(struct chtls_sock *csk, int comp);
 474int chtls_set_tcb_tflag(struct sock *sk, unsigned int bit_pos, int val);
 475int chtls_setkey(struct chtls_sock *csk, u32 keylen, u32 mode);
 476void skb_entail(struct sock *sk, struct sk_buff *skb, int flags);
 477unsigned int keyid_to_addr(int start_addr, int keyid);
 478void free_tls_keyid(struct sock *sk);
 479#endif
 480