hw/irdma/cm.h

0001 /* SPDX-License-Identifier: GPL-2.0 or Linux-OpenIB */
0002 /* Copyright (c) 2015 - 2021 Intel Corporation */
0003 #ifndef IRDMA_CM_H
0004 #define IRDMA_CM_H
0005
0006 #define IRDMA_MPA_REQUEST_ACCEPT    1
0007 #define IRDMA_MPA_REQUEST_REJECT    2
0008
0009 /* IETF MPA -- defines */
0010 #define IEFT_MPA_KEY_REQ    "MPA ID Req Frame"
0011 #define IEFT_MPA_KEY_REP    "MPA ID Rep Frame"
0012 #define IETF_MPA_KEY_SIZE   16
0013 #define IETF_MPA_VER        1
0014 #define IETF_MAX_PRIV_DATA_LEN  512
0015 #define IETF_MPA_FRAME_SIZE 20
0016 #define IETF_RTR_MSG_SIZE   4
0017 #define IETF_MPA_V2_FLAG    0x10
0018 #define SNDMARKER_SEQNMASK  0x000001ff
0019 #define IRDMA_MAX_IETF_SIZE 32
0020
0021 /* IETF RTR MSG Fields */
0022 #define IETF_PEER_TO_PEER   0x8000
0023 #define IETF_FLPDU_ZERO_LEN 0x4000
0024 #define IETF_RDMA0_WRITE    0x8000
0025 #define IETF_RDMA0_READ     0x4000
0026 #define IETF_NO_IRD_ORD     0x3fff
0027
0028 #define MAX_PORTS   65536
0029
0030 #define IRDMA_PASSIVE_STATE_INDICATED   0
0031 #define IRDMA_DO_NOT_SEND_RESET_EVENT   1
0032 #define IRDMA_SEND_RESET_EVENT      2
0033
0034 #define MAX_IRDMA_IFS   4
0035
0036 #define SET_ACK     1
0037 #define SET_SYN     2
0038 #define SET_FIN     4
0039 #define SET_RST     8
0040
0041 #define TCP_OPTIONS_PADDING 3
0042
0043 #define IRDMA_DEFAULT_RETRYS    64
0044 #define IRDMA_DEFAULT_RETRANS   8
0045 #define IRDMA_DEFAULT_TTL       0x40
0046 #define IRDMA_DEFAULT_RTT_VAR       6
0047 #define IRDMA_DEFAULT_SS_THRESH     0x3fffffff
0048 #define IRDMA_DEFAULT_REXMIT_THRESH 8
0049
0050 #define IRDMA_RETRY_TIMEOUT HZ
0051 #define IRDMA_SHORT_TIME    10
0052 #define IRDMA_LONG_TIME     (2 * HZ)
0053 #define IRDMA_MAX_TIMEOUT   ((unsigned long)(12 * HZ))
0054
0055 #define IRDMA_CM_HASHTABLE_SIZE     1024
0056 #define IRDMA_CM_TCP_TIMER_INTERVAL 3000
0057 #define IRDMA_CM_DEFAULT_MTU        1540
0058 #define IRDMA_CM_DEFAULT_FRAME_CNT  10
0059 #define IRDMA_CM_THREAD_STACK_SIZE  256
0060 #define IRDMA_CM_DEFAULT_RCV_WND    64240
0061 #define IRDMA_CM_DEFAULT_RCV_WND_SCALED 0x3FFFC
0062 #define IRDMA_CM_DEFAULT_RCV_WND_SCALE  2
0063 #define IRDMA_CM_DEFAULT_FREE_PKTS  10
0064 #define IRDMA_CM_FREE_PKT_LO_WATERMARK  2
0065 #define IRDMA_CM_DEFAULT_MSS        536
0066 #define IRDMA_CM_DEFAULT_MPA_VER    2
0067 #define IRDMA_CM_DEFAULT_SEQ        0x159bf75f
0068 #define IRDMA_CM_DEFAULT_LOCAL_ID   0x3b47
0069 #define IRDMA_CM_DEFAULT_SEQ2       0x18ed5740
0070 #define IRDMA_CM_DEFAULT_LOCAL_ID2  0xb807
0071 #define IRDMA_MAX_CM_BUF        (IRDMA_MAX_IETF_SIZE + IETF_MAX_PRIV_DATA_LEN)
0072
0073 enum ietf_mpa_flags {
0074     IETF_MPA_FLAGS_REJECT  = 0x20,
0075     IETF_MPA_FLAGS_CRC     = 0x40,
0076     IETF_MPA_FLAGS_MARKERS = 0x80,
0077 };
0078
0079 enum irdma_timer_type {
0080     IRDMA_TIMER_TYPE_SEND,
0081     IRDMA_TIMER_TYPE_CLOSE,
0082 };
0083
0084 enum option_nums {
0085     OPTION_NUM_EOL,
0086     OPTION_NUM_NONE,
0087     OPTION_NUM_MSS,
0088     OPTION_NUM_WINDOW_SCALE,
0089     OPTION_NUM_SACK_PERM,
0090     OPTION_NUM_SACK,
0091     OPTION_NUM_WRITE0 = 0xbc,
0092 };
0093
0094 /* cm node transition states */
0095 enum irdma_cm_node_state {
0096     IRDMA_CM_STATE_UNKNOWN,
0097     IRDMA_CM_STATE_INITED,
0098     IRDMA_CM_STATE_LISTENING,
0099     IRDMA_CM_STATE_SYN_RCVD,
0100     IRDMA_CM_STATE_SYN_SENT,
0101     IRDMA_CM_STATE_ONE_SIDE_ESTABLISHED,
0102     IRDMA_CM_STATE_ESTABLISHED,
0103     IRDMA_CM_STATE_ACCEPTING,
0104     IRDMA_CM_STATE_MPAREQ_SENT,
0105     IRDMA_CM_STATE_MPAREQ_RCVD,
0106     IRDMA_CM_STATE_MPAREJ_RCVD,
0107     IRDMA_CM_STATE_OFFLOADED,
0108     IRDMA_CM_STATE_FIN_WAIT1,
0109     IRDMA_CM_STATE_FIN_WAIT2,
0110     IRDMA_CM_STATE_CLOSE_WAIT,
0111     IRDMA_CM_STATE_TIME_WAIT,
0112     IRDMA_CM_STATE_LAST_ACK,
0113     IRDMA_CM_STATE_CLOSING,
0114     IRDMA_CM_STATE_LISTENER_DESTROYED,
0115     IRDMA_CM_STATE_CLOSED,
0116 };
0117
0118 enum mpa_frame_ver {
0119     IETF_MPA_V1 = 1,
0120     IETF_MPA_V2 = 2,
0121 };
0122
0123 enum mpa_frame_key {
0124     MPA_KEY_REQUEST,
0125     MPA_KEY_REPLY,
0126 };
0127
0128 enum send_rdma0 {
0129     SEND_RDMA_READ_ZERO  = 1,
0130     SEND_RDMA_WRITE_ZERO = 2,
0131 };
0132
0133 enum irdma_tcpip_pkt_type {
0134     IRDMA_PKT_TYPE_UNKNOWN,
0135     IRDMA_PKT_TYPE_SYN,
0136     IRDMA_PKT_TYPE_SYNACK,
0137     IRDMA_PKT_TYPE_ACK,
0138     IRDMA_PKT_TYPE_FIN,
0139     IRDMA_PKT_TYPE_RST,
0140 };
0141
0142 enum irdma_cm_listener_state {
0143     IRDMA_CM_LISTENER_PASSIVE_STATE = 1,
0144     IRDMA_CM_LISTENER_ACTIVE_STATE  = 2,
0145     IRDMA_CM_LISTENER_EITHER_STATE  = 3,
0146 };
0147
0148 /* CM event codes */
0149 enum irdma_cm_event_type {
0150     IRDMA_CM_EVENT_UNKNOWN,
0151     IRDMA_CM_EVENT_ESTABLISHED,
0152     IRDMA_CM_EVENT_MPA_REQ,
0153     IRDMA_CM_EVENT_MPA_CONNECT,
0154     IRDMA_CM_EVENT_MPA_ACCEPT,
0155     IRDMA_CM_EVENT_MPA_REJECT,
0156     IRDMA_CM_EVENT_MPA_ESTABLISHED,
0157     IRDMA_CM_EVENT_CONNECTED,
0158     IRDMA_CM_EVENT_RESET,
0159     IRDMA_CM_EVENT_ABORTED,
0160 };
0161
0162 struct ietf_mpa_v1 {
0163     u8 key[IETF_MPA_KEY_SIZE];
0164     u8 flags;
0165     u8 rev;
0166     __be16 priv_data_len;
0167     u8 priv_data[];
0168 };
0169
0170 struct ietf_rtr_msg {
0171     __be16 ctrl_ird;
0172     __be16 ctrl_ord;
0173 };
0174
0175 struct ietf_mpa_v2 {
0176     u8 key[IETF_MPA_KEY_SIZE];
0177     u8 flags;
0178     u8 rev;
0179     __be16 priv_data_len;
0180     struct ietf_rtr_msg rtr_msg;
0181     u8 priv_data[];
0182 };
0183
0184 struct option_base {
0185     u8 optionnum;
0186     u8 len;
0187 };
0188
0189 struct option_mss {
0190     u8 optionnum;
0191     u8 len;
0192     __be16 mss;
0193 };
0194
0195 struct option_windowscale {
0196     u8 optionnum;
0197     u8 len;
0198     u8 shiftcount;
0199 };
0200
0201 union all_known_options {
0202     char eol;
0203     struct option_base base;
0204     struct option_mss mss;
0205     struct option_windowscale windowscale;
0206 };
0207
0208 struct irdma_timer_entry {
0209     struct list_head list;
0210     unsigned long timetosend; /* jiffies */
0211     struct irdma_puda_buf *sqbuf;
0212     u32 type;
0213     u32 retrycount;
0214     u32 retranscount;
0215     u32 context;
0216     u32 send_retrans;
0217     int close_when_complete;
0218 };
0219
0220 /* CM context params */
0221 struct irdma_cm_tcp_context {
0222     u8 client;
0223     u32 loc_seq_num;
0224     u32 loc_ack_num;
0225     u32 rem_ack_num;
0226     u32 rcv_nxt;
0227     u32 loc_id;
0228     u32 rem_id;
0229     u32 snd_wnd;
0230     u32 max_snd_wnd;
0231     u32 rcv_wnd;
0232     u32 mss;
0233     u8 snd_wscale;
0234     u8 rcv_wscale;
0235 };
0236
0237 struct irdma_apbvt_entry {
0238     struct hlist_node hlist;
0239     u32 use_cnt;
0240     u16 port;
0241 };
0242
0243 struct irdma_cm_listener {
0244     struct list_head list;
0245     struct iw_cm_id *cm_id;
0246     struct irdma_cm_core *cm_core;
0247     struct irdma_device *iwdev;
0248     struct list_head child_listen_list;
0249     struct irdma_apbvt_entry *apbvt_entry;
0250     enum irdma_cm_listener_state listener_state;
0251     refcount_t refcnt;
0252     atomic_t pend_accepts_cnt;
0253     u32 loc_addr[4];
0254     u32 reused_node;
0255     int backlog;
0256     u16 loc_port;
0257     u16 vlan_id;
0258     u8 loc_mac[ETH_ALEN];
0259     u8 user_pri;
0260     u8 tos;
0261     bool qhash_set:1;
0262     bool ipv4:1;
0263 };
0264
0265 struct irdma_kmem_info {
0266     void *addr;
0267     u32 size;
0268 };
0269
0270 struct irdma_mpa_priv_info {
0271     const void *addr;
0272     u32 size;
0273 };
0274
0275 struct irdma_cm_node {
0276     struct irdma_qp *iwqp;
0277     struct irdma_device *iwdev;
0278     struct irdma_sc_dev *dev;
0279     struct irdma_cm_tcp_context tcp_cntxt;
0280     struct irdma_cm_core *cm_core;
0281     struct irdma_timer_entry *send_entry;
0282     struct irdma_timer_entry *close_entry;
0283     struct irdma_cm_listener *listener;
0284     struct list_head timer_entry;
0285     struct list_head reset_entry;
0286     struct list_head teardown_entry;
0287     struct irdma_apbvt_entry *apbvt_entry;
0288     struct rcu_head rcu_head;
0289     struct irdma_mpa_priv_info pdata;
0290     struct irdma_sc_ah *ah;
0291     union {
0292         struct ietf_mpa_v1 mpa_frame;
0293         struct ietf_mpa_v2 mpa_v2_frame;
0294     };
0295     struct irdma_kmem_info mpa_hdr;
0296     struct iw_cm_id *cm_id;
0297     struct hlist_node list;
0298     struct completion establish_comp;
0299     spinlock_t retrans_list_lock; /* protect CM node rexmit updates*/
0300     atomic_t passive_state;
0301     refcount_t refcnt;
0302     enum irdma_cm_node_state state;
0303     enum send_rdma0 send_rdma0_op;
0304     enum mpa_frame_ver mpa_frame_rev;
0305     u32 loc_addr[4], rem_addr[4];
0306     u16 loc_port, rem_port;
0307     int apbvt_set;
0308     int accept_pend;
0309     u16 vlan_id;
0310     u16 ird_size;
0311     u16 ord_size;
0312     u16 mpav2_ird_ord;
0313     u16 lsmm_size;
0314     u8 pdata_buf[IETF_MAX_PRIV_DATA_LEN];
0315     u8 loc_mac[ETH_ALEN];
0316     u8 rem_mac[ETH_ALEN];
0317     u8 user_pri;
0318     u8 tos;
0319     bool ack_rcvd:1;
0320     bool qhash_set:1;
0321     bool ipv4:1;
0322     bool snd_mark_en:1;
0323     bool rcv_mark_en:1;
0324     bool do_lpb:1;
0325     bool accelerated:1;
0326 };
0327
0328 /* Used by internal CM APIs to pass CM information*/
0329 struct irdma_cm_info {
0330     struct iw_cm_id *cm_id;
0331     u16 loc_port;
0332     u16 rem_port;
0333     u32 loc_addr[4];
0334     u32 rem_addr[4];
0335     u32 qh_qpid;
0336     u16 vlan_id;
0337     int backlog;
0338     u8 user_pri;
0339     u8 tos;
0340     bool ipv4;
0341 };
0342
0343 struct irdma_cm_event {
0344     enum irdma_cm_event_type type;
0345     struct irdma_cm_info cm_info;
0346     struct work_struct event_work;
0347     struct irdma_cm_node *cm_node;
0348 };
0349
0350 struct irdma_cm_core {
0351     struct irdma_device *iwdev;
0352     struct irdma_sc_dev *dev;
0353     struct list_head listen_list;
0354     DECLARE_HASHTABLE(cm_hash_tbl, 8);
0355     DECLARE_HASHTABLE(apbvt_hash_tbl, 8);
0356     struct timer_list tcp_timer;
0357     struct workqueue_struct *event_wq;
0358     spinlock_t ht_lock; /* protect CM node (active side) list */
0359     spinlock_t listen_list_lock; /* protect listener list */
0360     spinlock_t apbvt_lock; /*serialize apbvt add/del entries*/
0361     u64 stats_nodes_created;
0362     u64 stats_nodes_destroyed;
0363     u64 stats_listen_created;
0364     u64 stats_listen_destroyed;
0365     u64 stats_listen_nodes_created;
0366     u64 stats_listen_nodes_destroyed;
0367     u64 stats_lpbs;
0368     u64 stats_accepts;
0369     u64 stats_rejects;
0370     u64 stats_connect_errs;
0371     u64 stats_passive_errs;
0372     u64 stats_pkt_retrans;
0373     u64 stats_backlog_drops;
0374     struct irdma_puda_buf *(*form_cm_frame)(struct irdma_cm_node *cm_node,
0375                         struct irdma_kmem_info *options,
0376                         struct irdma_kmem_info *hdr,
0377                         struct irdma_mpa_priv_info *pdata,
0378                         u8 flags);
0379     int (*cm_create_ah)(struct irdma_cm_node *cm_node, bool wait);
0380     void (*cm_free_ah)(struct irdma_cm_node *cm_node);
0381 };
0382
0383 int irdma_schedule_cm_timer(struct irdma_cm_node *cm_node,
0384                 struct irdma_puda_buf *sqbuf,
0385                 enum irdma_timer_type type, int send_retrans,
0386                 int close_when_complete);
0387
0388 static inline u8 irdma_tos2dscp(u8 tos)
0389 {
0390 #define IRDMA_DSCP_VAL GENMASK(7, 2)
0391     return (u8)FIELD_GET(IRDMA_DSCP_VAL, tos);
0392 }
0393
0394 int irdma_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *conn_param);
0395 int irdma_reject(struct iw_cm_id *cm_id, const void *pdata, u8 pdata_len);
0396 int irdma_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *conn_param);
0397 int irdma_create_listen(struct iw_cm_id *cm_id, int backlog);
0398 int irdma_destroy_listen(struct iw_cm_id *cm_id);
0399 int irdma_add_arp(struct irdma_pci_f *rf, u32 *ip, bool ipv4, const u8 *mac);
0400 void irdma_cm_teardown_connections(struct irdma_device *iwdev, u32 *ipaddr,
0401                    struct irdma_cm_info *nfo,
0402                    bool disconnect_all);
0403 int irdma_cm_start(struct irdma_device *dev);
0404 int irdma_cm_stop(struct irdma_device *dev);
0405 bool irdma_ipv4_is_lpb(u32 loc_addr, u32 rem_addr);
0406 bool irdma_ipv6_is_lpb(u32 *loc_addr, u32 *rem_addr);
0407 int irdma_arp_table(struct irdma_pci_f *rf, u32 *ip_addr, bool ipv4,
0408             const u8 *mac_addr, u32 action);
0409 void irdma_if_notify(struct irdma_device *iwdev, struct net_device *netdev,
0410              u32 *ipaddr, bool ipv4, bool ifup);
0411 bool irdma_port_in_use(struct irdma_cm_core *cm_core, u16 port);
0412 void irdma_send_ack(struct irdma_cm_node *cm_node);
0413 void irdma_lpb_nop(struct irdma_sc_qp *qp);
0414 void irdma_rem_ref_cm_node(struct irdma_cm_node *cm_node);
0415 void irdma_add_conn_est_qh(struct irdma_cm_node *cm_node);
0416 #endif /* IRDMA_CM_H */