forked from Qortal/Brooklyn
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
421 lines
11 KiB
421 lines
11 KiB
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */ |
|
/* |
|
* Copyright (c) 2008, 2018 Oracle and/or its affiliates. All rights reserved. |
|
* |
|
* This software is available to you under a choice of one of two |
|
* licenses. You may choose to be licensed under the terms of the GNU |
|
* General Public License (GPL) Version 2, available from the file |
|
* COPYING in the main directory of this source tree, or the |
|
* OpenIB.org BSD license below: |
|
* |
|
* Redistribution and use in source and binary forms, with or |
|
* without modification, are permitted provided that the following |
|
* conditions are met: |
|
* |
|
* - Redistributions of source code must retain the above |
|
* copyright notice, this list of conditions and the following |
|
* disclaimer. |
|
* |
|
* - Redistributions in binary form must reproduce the above |
|
* copyright notice, this list of conditions and the following |
|
* disclaimer in the documentation and/or other materials |
|
* provided with the distribution. |
|
* |
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS |
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
* SOFTWARE. |
|
* |
|
*/ |
|
|
|
#ifndef _LINUX_RDS_H |
|
#define _LINUX_RDS_H |
|
|
|
#include <linux/types.h> |
|
#include <linux/socket.h> /* For __kernel_sockaddr_storage. */ |
|
#include <linux/in6.h> /* For struct in6_addr. */ |
|
|
|
#define RDS_IB_ABI_VERSION 0x301 |
|
|
|
#define SOL_RDS 276 |
|
|
|
/* |
|
* setsockopt/getsockopt for SOL_RDS |
|
*/ |
|
#define RDS_CANCEL_SENT_TO 1 |
|
#define RDS_GET_MR 2 |
|
#define RDS_FREE_MR 3 |
|
/* deprecated: RDS_BARRIER 4 */ |
|
#define RDS_RECVERR 5 |
|
#define RDS_CONG_MONITOR 6 |
|
#define RDS_GET_MR_FOR_DEST 7 |
|
#define SO_RDS_TRANSPORT 8 |
|
|
|
/* Socket option to tap receive path latency |
|
* SO_RDS: SO_RDS_MSG_RXPATH_LATENCY |
|
* Format used struct rds_rx_trace_so |
|
*/ |
|
#define SO_RDS_MSG_RXPATH_LATENCY 10 |
|
|
|
|
|
/* supported values for SO_RDS_TRANSPORT */ |
|
#define RDS_TRANS_IB 0 |
|
#define RDS_TRANS_GAP 1 |
|
#define RDS_TRANS_TCP 2 |
|
#define RDS_TRANS_COUNT 3 |
|
#define RDS_TRANS_NONE (~0) |
|
/* don't use RDS_TRANS_IWARP - it is deprecated */ |
|
#define RDS_TRANS_IWARP RDS_TRANS_GAP |
|
|
|
/* IOCTLS commands for SOL_RDS */ |
|
#define SIOCRDSSETTOS (SIOCPROTOPRIVATE) |
|
#define SIOCRDSGETTOS (SIOCPROTOPRIVATE + 1) |
|
|
|
typedef __u8 rds_tos_t; |
|
|
|
/* |
|
* Control message types for SOL_RDS. |
|
* |
|
* CMSG_RDMA_ARGS (sendmsg) |
|
* Request a RDMA transfer to/from the specified |
|
* memory ranges. |
|
* The cmsg_data is a struct rds_rdma_args. |
|
* RDS_CMSG_RDMA_DEST (recvmsg, sendmsg) |
|
* Kernel informs application about intended |
|
* source/destination of a RDMA transfer |
|
* RDS_CMSG_RDMA_MAP (sendmsg) |
|
* Application asks kernel to map the given |
|
* memory range into a IB MR, and send the |
|
* R_Key along in an RDS extension header. |
|
* The cmsg_data is a struct rds_get_mr_args, |
|
* the same as for the GET_MR setsockopt. |
|
* RDS_CMSG_RDMA_STATUS (recvmsg) |
|
* Returns the status of a completed RDMA operation. |
|
* RDS_CMSG_RXPATH_LATENCY(recvmsg) |
|
* Returns rds message latencies in various stages of receive |
|
* path in nS. Its set per socket using SO_RDS_MSG_RXPATH_LATENCY |
|
* socket option. Legitimate points are defined in |
|
* enum rds_message_rxpath_latency. More points can be added in |
|
* future. CSMG format is struct rds_cmsg_rx_trace. |
|
*/ |
|
#define RDS_CMSG_RDMA_ARGS 1 |
|
#define RDS_CMSG_RDMA_DEST 2 |
|
#define RDS_CMSG_RDMA_MAP 3 |
|
#define RDS_CMSG_RDMA_STATUS 4 |
|
#define RDS_CMSG_CONG_UPDATE 5 |
|
#define RDS_CMSG_ATOMIC_FADD 6 |
|
#define RDS_CMSG_ATOMIC_CSWP 7 |
|
#define RDS_CMSG_MASKED_ATOMIC_FADD 8 |
|
#define RDS_CMSG_MASKED_ATOMIC_CSWP 9 |
|
#define RDS_CMSG_RXPATH_LATENCY 11 |
|
#define RDS_CMSG_ZCOPY_COOKIE 12 |
|
#define RDS_CMSG_ZCOPY_COMPLETION 13 |
|
|
|
#define RDS_INFO_FIRST 10000 |
|
#define RDS_INFO_COUNTERS 10000 |
|
#define RDS_INFO_CONNECTIONS 10001 |
|
/* 10002 aka RDS_INFO_FLOWS is deprecated */ |
|
#define RDS_INFO_SEND_MESSAGES 10003 |
|
#define RDS_INFO_RETRANS_MESSAGES 10004 |
|
#define RDS_INFO_RECV_MESSAGES 10005 |
|
#define RDS_INFO_SOCKETS 10006 |
|
#define RDS_INFO_TCP_SOCKETS 10007 |
|
#define RDS_INFO_IB_CONNECTIONS 10008 |
|
#define RDS_INFO_CONNECTION_STATS 10009 |
|
#define RDS_INFO_IWARP_CONNECTIONS 10010 |
|
|
|
/* PF_RDS6 options */ |
|
#define RDS6_INFO_CONNECTIONS 10011 |
|
#define RDS6_INFO_SEND_MESSAGES 10012 |
|
#define RDS6_INFO_RETRANS_MESSAGES 10013 |
|
#define RDS6_INFO_RECV_MESSAGES 10014 |
|
#define RDS6_INFO_SOCKETS 10015 |
|
#define RDS6_INFO_TCP_SOCKETS 10016 |
|
#define RDS6_INFO_IB_CONNECTIONS 10017 |
|
|
|
#define RDS_INFO_LAST 10017 |
|
|
|
struct rds_info_counter { |
|
__u8 name[32]; |
|
__u64 value; |
|
} __attribute__((packed)); |
|
|
|
#define RDS_INFO_CONNECTION_FLAG_SENDING 0x01 |
|
#define RDS_INFO_CONNECTION_FLAG_CONNECTING 0x02 |
|
#define RDS_INFO_CONNECTION_FLAG_CONNECTED 0x04 |
|
|
|
#define TRANSNAMSIZ 16 |
|
|
|
struct rds_info_connection { |
|
__u64 next_tx_seq; |
|
__u64 next_rx_seq; |
|
__be32 laddr; |
|
__be32 faddr; |
|
__u8 transport[TRANSNAMSIZ]; /* null term ascii */ |
|
__u8 flags; |
|
__u8 tos; |
|
} __attribute__((packed)); |
|
|
|
struct rds6_info_connection { |
|
__u64 next_tx_seq; |
|
__u64 next_rx_seq; |
|
struct in6_addr laddr; |
|
struct in6_addr faddr; |
|
__u8 transport[TRANSNAMSIZ]; /* null term ascii */ |
|
__u8 flags; |
|
} __attribute__((packed)); |
|
|
|
#define RDS_INFO_MESSAGE_FLAG_ACK 0x01 |
|
#define RDS_INFO_MESSAGE_FLAG_FAST_ACK 0x02 |
|
|
|
struct rds_info_message { |
|
__u64 seq; |
|
__u32 len; |
|
__be32 laddr; |
|
__be32 faddr; |
|
__be16 lport; |
|
__be16 fport; |
|
__u8 flags; |
|
__u8 tos; |
|
} __attribute__((packed)); |
|
|
|
struct rds6_info_message { |
|
__u64 seq; |
|
__u32 len; |
|
struct in6_addr laddr; |
|
struct in6_addr faddr; |
|
__be16 lport; |
|
__be16 fport; |
|
__u8 flags; |
|
__u8 tos; |
|
} __attribute__((packed)); |
|
|
|
struct rds_info_socket { |
|
__u32 sndbuf; |
|
__be32 bound_addr; |
|
__be32 connected_addr; |
|
__be16 bound_port; |
|
__be16 connected_port; |
|
__u32 rcvbuf; |
|
__u64 inum; |
|
} __attribute__((packed)); |
|
|
|
struct rds6_info_socket { |
|
__u32 sndbuf; |
|
struct in6_addr bound_addr; |
|
struct in6_addr connected_addr; |
|
__be16 bound_port; |
|
__be16 connected_port; |
|
__u32 rcvbuf; |
|
__u64 inum; |
|
} __attribute__((packed)); |
|
|
|
struct rds_info_tcp_socket { |
|
__be32 local_addr; |
|
__be16 local_port; |
|
__be32 peer_addr; |
|
__be16 peer_port; |
|
__u64 hdr_rem; |
|
__u64 data_rem; |
|
__u32 last_sent_nxt; |
|
__u32 last_expected_una; |
|
__u32 last_seen_una; |
|
__u8 tos; |
|
} __attribute__((packed)); |
|
|
|
struct rds6_info_tcp_socket { |
|
struct in6_addr local_addr; |
|
__be16 local_port; |
|
struct in6_addr peer_addr; |
|
__be16 peer_port; |
|
__u64 hdr_rem; |
|
__u64 data_rem; |
|
__u32 last_sent_nxt; |
|
__u32 last_expected_una; |
|
__u32 last_seen_una; |
|
} __attribute__((packed)); |
|
|
|
#define RDS_IB_GID_LEN 16 |
|
struct rds_info_rdma_connection { |
|
__be32 src_addr; |
|
__be32 dst_addr; |
|
__u8 src_gid[RDS_IB_GID_LEN]; |
|
__u8 dst_gid[RDS_IB_GID_LEN]; |
|
|
|
__u32 max_send_wr; |
|
__u32 max_recv_wr; |
|
__u32 max_send_sge; |
|
__u32 rdma_mr_max; |
|
__u32 rdma_mr_size; |
|
__u8 tos; |
|
__u8 sl; |
|
__u32 cache_allocs; |
|
}; |
|
|
|
struct rds6_info_rdma_connection { |
|
struct in6_addr src_addr; |
|
struct in6_addr dst_addr; |
|
__u8 src_gid[RDS_IB_GID_LEN]; |
|
__u8 dst_gid[RDS_IB_GID_LEN]; |
|
|
|
__u32 max_send_wr; |
|
__u32 max_recv_wr; |
|
__u32 max_send_sge; |
|
__u32 rdma_mr_max; |
|
__u32 rdma_mr_size; |
|
__u8 tos; |
|
__u8 sl; |
|
__u32 cache_allocs; |
|
}; |
|
|
|
/* RDS message Receive Path Latency points */ |
|
enum rds_message_rxpath_latency { |
|
RDS_MSG_RX_HDR_TO_DGRAM_START = 0, |
|
RDS_MSG_RX_DGRAM_REASSEMBLE, |
|
RDS_MSG_RX_DGRAM_DELIVERED, |
|
RDS_MSG_RX_DGRAM_TRACE_MAX |
|
}; |
|
|
|
struct rds_rx_trace_so { |
|
__u8 rx_traces; |
|
__u8 rx_trace_pos[RDS_MSG_RX_DGRAM_TRACE_MAX]; |
|
}; |
|
|
|
struct rds_cmsg_rx_trace { |
|
__u8 rx_traces; |
|
__u8 rx_trace_pos[RDS_MSG_RX_DGRAM_TRACE_MAX]; |
|
__u64 rx_trace[RDS_MSG_RX_DGRAM_TRACE_MAX]; |
|
}; |
|
|
|
/* |
|
* Congestion monitoring. |
|
* Congestion control in RDS happens at the host connection |
|
* level by exchanging a bitmap marking congested ports. |
|
* By default, a process sleeping in poll() is always woken |
|
* up when the congestion map is updated. |
|
* With explicit monitoring, an application can have more |
|
* fine-grained control. |
|
* The application installs a 64bit mask value in the socket, |
|
* where each bit corresponds to a group of ports. |
|
* When a congestion update arrives, RDS checks the set of |
|
* ports that are now uncongested against the list bit mask |
|
* installed in the socket, and if they overlap, we queue a |
|
* cong_notification on the socket. |
|
* |
|
* To install the congestion monitor bitmask, use RDS_CONG_MONITOR |
|
* with the 64bit mask. |
|
* Congestion updates are received via RDS_CMSG_CONG_UPDATE |
|
* control messages. |
|
* |
|
* The correspondence between bits and ports is |
|
* 1 << (portnum % 64) |
|
*/ |
|
#define RDS_CONG_MONITOR_SIZE 64 |
|
#define RDS_CONG_MONITOR_BIT(port) (((unsigned int) port) % RDS_CONG_MONITOR_SIZE) |
|
#define RDS_CONG_MONITOR_MASK(port) (1ULL << RDS_CONG_MONITOR_BIT(port)) |
|
|
|
/* |
|
* RDMA related types |
|
*/ |
|
|
|
/* |
|
* This encapsulates a remote memory location. |
|
* In the current implementation, it contains the R_Key |
|
* of the remote memory region, and the offset into it |
|
* (so that the application does not have to worry about |
|
* alignment). |
|
*/ |
|
typedef __u64 rds_rdma_cookie_t; |
|
|
|
struct rds_iovec { |
|
__u64 addr; |
|
__u64 bytes; |
|
}; |
|
|
|
struct rds_get_mr_args { |
|
struct rds_iovec vec; |
|
__u64 cookie_addr; |
|
__u64 flags; |
|
}; |
|
|
|
struct rds_get_mr_for_dest_args { |
|
struct __kernel_sockaddr_storage dest_addr; |
|
struct rds_iovec vec; |
|
__u64 cookie_addr; |
|
__u64 flags; |
|
}; |
|
|
|
struct rds_free_mr_args { |
|
rds_rdma_cookie_t cookie; |
|
__u64 flags; |
|
}; |
|
|
|
struct rds_rdma_args { |
|
rds_rdma_cookie_t cookie; |
|
struct rds_iovec remote_vec; |
|
__u64 local_vec_addr; |
|
__u64 nr_local; |
|
__u64 flags; |
|
__u64 user_token; |
|
}; |
|
|
|
struct rds_atomic_args { |
|
rds_rdma_cookie_t cookie; |
|
__u64 local_addr; |
|
__u64 remote_addr; |
|
union { |
|
struct { |
|
__u64 compare; |
|
__u64 swap; |
|
} cswp; |
|
struct { |
|
__u64 add; |
|
} fadd; |
|
struct { |
|
__u64 compare; |
|
__u64 swap; |
|
__u64 compare_mask; |
|
__u64 swap_mask; |
|
} m_cswp; |
|
struct { |
|
__u64 add; |
|
__u64 nocarry_mask; |
|
} m_fadd; |
|
}; |
|
__u64 flags; |
|
__u64 user_token; |
|
}; |
|
|
|
struct rds_rdma_notify { |
|
__u64 user_token; |
|
__s32 status; |
|
}; |
|
|
|
#define RDS_RDMA_SUCCESS 0 |
|
#define RDS_RDMA_REMOTE_ERROR 1 |
|
#define RDS_RDMA_CANCELED 2 |
|
#define RDS_RDMA_DROPPED 3 |
|
#define RDS_RDMA_OTHER_ERROR 4 |
|
|
|
#define RDS_MAX_ZCOOKIES 8 |
|
struct rds_zcopy_cookies { |
|
__u32 num; |
|
__u32 cookies[RDS_MAX_ZCOOKIES]; |
|
}; |
|
|
|
/* |
|
* Common set of flags for all RDMA related structs |
|
*/ |
|
#define RDS_RDMA_READWRITE 0x0001 |
|
#define RDS_RDMA_FENCE 0x0002 /* use FENCE for immediate send */ |
|
#define RDS_RDMA_INVALIDATE 0x0004 /* invalidate R_Key after freeing MR */ |
|
#define RDS_RDMA_USE_ONCE 0x0008 /* free MR after use */ |
|
#define RDS_RDMA_DONTWAIT 0x0010 /* Don't wait in SET_BARRIER */ |
|
#define RDS_RDMA_NOTIFY_ME 0x0020 /* Notify when operation completes */ |
|
#define RDS_RDMA_SILENT 0x0040 /* Do not interrupt remote */ |
|
|
|
#endif /* IB_RDS_H */
|
|
|