The C and C++ Include Header Files

/usr/include/rdma/rdma_user_rxe.h


$ cat -n /usr/include/rdma/rdma_user_rxe.h

     1	/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
     2	/*
     3	 * Copyright (c) 2016 Mellanox Technologies Ltd. All rights reserved.
     4	 *
     5	 * This software is available to you under a choice of one of two
     6	 * licenses.  You may choose to be licensed under the terms of the GNU
     7	 * General Public License (GPL) Version 2, available from the file
     8	 * COPYING in the main directory of this source tree, or the
     9	 * OpenIB.org BSD license below:
    10	 *
    11	 *     Redistribution and use in source and binary forms, with or
    12	 *     without modification, are permitted provided that the following
    13	 *     conditions are met:
    14	 *
    15	 *	- Redistributions of source code must retain the above
    16	 *	  copyright notice, this list of conditions and the following
    17	 *	  disclaimer.
    18	 *
    19	 *	- Redistributions in binary form must reproduce the above
    20	 *	  copyright notice, this list of conditions and the following
    21	 *	  disclaimer in the documentation and/or other materials
    22	 *	  provided with the distribution.
    23	 *
    24	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    25	 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    26	 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    27	 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
    28	 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
    29	 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    30	 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    31	 * SOFTWARE.
    32	 */
    33	
    34	#ifndef RDMA_USER_RXE_H
    35	#define RDMA_USER_RXE_H
    36	
    37	#include <linux/types.h>
    38	#include <linux/socket.h>
    39	#include <linux/in.h>
    40	#include <linux/in6.h>
    41	
    42	enum {
    43		RXE_NETWORK_TYPE_IPV4 = 1,
    44		RXE_NETWORK_TYPE_IPV6 = 2,
    45	};
    46	
    47	union rxe_gid {
    48		__u8	raw[16];
    49		struct {
    50			__be64	subnet_prefix;
    51			__be64	interface_id;
    52		} global;
    53	};
    54	
    55	struct rxe_global_route {
    56		union rxe_gid	dgid;
    57		__u32		flow_label;
    58		__u8		sgid_index;
    59		__u8		hop_limit;
    60		__u8		traffic_class;
    61	};
    62	
    63	struct rxe_av {
    64		__u8			port_num;
    65		/* From RXE_NETWORK_TYPE_* */
    66		__u8			network_type;
    67		__u8			dmac[6];
    68		struct rxe_global_route	grh;
    69		union {
    70			struct sockaddr_in	_sockaddr_in;
    71			struct sockaddr_in6	_sockaddr_in6;
    72		} sgid_addr, dgid_addr;
    73	};
    74	
    75	struct rxe_send_wr {
    76		__aligned_u64		wr_id;
    77		__u32			reserved;
    78		__u32			opcode;
    79		__u32			send_flags;
    80		union {
    81			__be32		imm_data;
    82			__u32		invalidate_rkey;
    83		} ex;
    84		union {
    85			struct {
    86				__aligned_u64 remote_addr;
    87				__u32	length;
    88				__u32	rkey;
    89				__u8	type;
    90				__u8	level;
    91			} flush;
    92			struct {
    93				__aligned_u64 remote_addr;
    94				__u32	rkey;
    95				__u32	reserved;
    96			} rdma;
    97			struct {
    98				__aligned_u64 remote_addr;
    99				__aligned_u64 compare_add;
   100				__aligned_u64 swap;
   101				__u32	rkey;
   102				__u32	reserved;
   103			} atomic;
   104			struct {
   105				__u32	remote_qpn;
   106				__u32	remote_qkey;
   107				__u16	pkey_index;
   108				__u16	reserved;
   109				__u32	ah_num;
   110				__u32	pad[4];
   111				struct rxe_av av;
   112			} ud;
   113			struct {
   114				__aligned_u64	addr;
   115				__aligned_u64	length;
   116				__u32		mr_lkey;
   117				__u32		mw_rkey;
   118				__u32		rkey;
   119				__u32		access;
   120			} mw;
   121			/* reg is only used by the kernel and is not part of the uapi */
   122		} wr;
   123	};
   124	
   125	struct rxe_sge {
   126		__aligned_u64 addr;
   127		__u32	length;
   128		__u32	lkey;
   129	};
   130	
   131	struct mminfo {
   132		__aligned_u64		offset;
   133		__u32			size;
   134		__u32			pad;
   135	};
   136	
   137	struct rxe_dma_info {
   138		__u32			length;
   139		__u32			resid;
   140		__u32			cur_sge;
   141		__u32			num_sge;
   142		__u32			sge_offset;
   143		__u32			reserved;
   144		union {
   145			__DECLARE_FLEX_ARRAY(__u8, inline_data);
   146			__DECLARE_FLEX_ARRAY(__u8, atomic_wr);
   147			__DECLARE_FLEX_ARRAY(struct rxe_sge, sge);
   148		};
   149	};
   150	
   151	struct rxe_send_wqe {
   152		struct rxe_send_wr	wr;
   153		__u32			status;
   154		__u32			state;
   155		__aligned_u64		iova;
   156		__u32			mask;
   157		__u32			first_psn;
   158		__u32			last_psn;
   159		__u32			ack_length;
   160		__u32			ssn;
   161		__u32			has_rd_atomic;
   162		struct rxe_dma_info	dma;
   163	};
   164	
   165	struct rxe_recv_wqe {
   166		__aligned_u64		wr_id;
   167		__u32			reserved;
   168		__u32			padding;
   169		struct rxe_dma_info	dma;
   170	};
   171	
   172	struct rxe_create_ah_resp {
   173		__u32 ah_num;
   174		__u32 reserved;
   175	};
   176	
   177	struct rxe_create_cq_resp {
   178		struct mminfo mi;
   179	};
   180	
   181	struct rxe_resize_cq_resp {
   182		struct mminfo mi;
   183	};
   184	
   185	struct rxe_create_qp_resp {
   186		struct mminfo rq_mi;
   187		struct mminfo sq_mi;
   188	};
   189	
   190	struct rxe_create_srq_resp {
   191		struct mminfo mi;
   192		__u32 srq_num;
   193		__u32 reserved;
   194	};
   195	
   196	struct rxe_modify_srq_cmd {
   197		__aligned_u64 mmap_info_addr;
   198	};
   199	
   200	/* This data structure is stored at the base of work and
   201	 * completion queues shared between user space and kernel space.
   202	 * It contains the producer and consumer indices. Is also
   203	 * contains a copy of the queue size parameters for user space
   204	 * to use but the kernel must use the parameters in the
   205	 * rxe_queue struct. For performance reasons arrange to have
   206	 * producer and consumer indices in separate cache lines
   207	 * the kernel should always mask the indices to avoid accessing
   208	 * memory outside of the data area
   209	 */
   210	struct rxe_queue_buf {
   211		__u32			log2_elem_size;
   212		__u32			index_mask;
   213		__u32			pad_1[30];
   214		__u32			producer_index;
   215		__u32			pad_2[31];
   216		__u32			consumer_index;
   217		__u32			pad_3[31];
   218		__u8			data[];
   219	};
   220	
   221	#endif /* RDMA_USER_RXE_H */