]>
Commit | Line | Data |
---|---|---|
c3a57ed7 TT |
1 | /* |
2 | * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved. | |
3 | * | |
4 | * This software is available to you under a choice of one of two | |
5 | * licenses. You may choose to be licensed under the terms of the GNU | |
6 | * General Public License (GPL) Version 2, available from the file | |
7 | * COPYING in the main directory of this source tree, or the BSD-type | |
8 | * license below: | |
9 | * | |
10 | * Redistribution and use in source and binary forms, with or without | |
11 | * modification, are permitted provided that the following conditions | |
12 | * are met: | |
13 | * | |
14 | * Redistributions of source code must retain the above copyright | |
15 | * notice, this list of conditions and the following disclaimer. | |
16 | * | |
17 | * Redistributions in binary form must reproduce the above | |
18 | * copyright notice, this list of conditions and the following | |
19 | * disclaimer in the documentation and/or other materials provided | |
20 | * with the distribution. | |
21 | * | |
22 | * Neither the name of the Network Appliance, Inc. nor the names of | |
23 | * its contributors may be used to endorse or promote products | |
24 | * derived from this software without specific prior written | |
25 | * permission. | |
26 | * | |
27 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
28 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
29 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
30 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
31 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
32 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
33 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
34 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
35 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
36 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
37 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
38 | */ | |
39 | ||
40 | #ifndef _LINUX_SUNRPC_RPC_RDMA_H | |
41 | #define _LINUX_SUNRPC_RPC_RDMA_H | |
42 | ||
a600ffcb | 43 | #include <linux/types.h> |
ff06bd19 | 44 | #include <linux/bitops.h> |
a600ffcb | 45 | |
284f4902 CL |
46 | #define RPCRDMA_VERSION 1 |
47 | #define rpcrdma_version cpu_to_be32(RPCRDMA_VERSION) | |
48 | ||
87cfb9a0 CL |
49 | enum { |
50 | RPCRDMA_V1_DEF_INLINE_SIZE = 1024, | |
51 | }; | |
52 | ||
c3a57ed7 | 53 | struct rpcrdma_segment { |
2d8a9726 AV |
54 | __be32 rs_handle; /* Registered memory handle */ |
55 | __be32 rs_length; /* Length of the chunk in bytes */ | |
56 | __be64 rs_offset; /* Chunk virtual address or offset */ | |
c3a57ed7 TT |
57 | }; |
58 | ||
59 | /* | |
60 | * read chunk(s), encoded as a linked list. | |
61 | */ | |
62 | struct rpcrdma_read_chunk { | |
2d8a9726 AV |
63 | __be32 rc_discrim; /* 1 indicates presence */ |
64 | __be32 rc_position; /* Position in XDR stream */ | |
c3a57ed7 TT |
65 | struct rpcrdma_segment rc_target; |
66 | }; | |
67 | ||
68 | /* | |
69 | * write chunk, and reply chunk. | |
70 | */ | |
71 | struct rpcrdma_write_chunk { | |
72 | struct rpcrdma_segment wc_target; | |
73 | }; | |
74 | ||
75 | /* | |
76 | * write chunk(s), encoded as a counted array. | |
77 | */ | |
78 | struct rpcrdma_write_array { | |
2d8a9726 AV |
79 | __be32 wc_discrim; /* 1 indicates presence */ |
80 | __be32 wc_nchunks; /* Array count */ | |
c3a57ed7 TT |
81 | struct rpcrdma_write_chunk wc_array[0]; |
82 | }; | |
83 | ||
84 | struct rpcrdma_msg { | |
2d8a9726 AV |
85 | __be32 rm_xid; /* Mirrors the RPC header xid */ |
86 | __be32 rm_vers; /* Version of this protocol */ | |
87 | __be32 rm_credit; /* Buffers requested/granted */ | |
88 | __be32 rm_type; /* Type of message (enum rpcrdma_proc) */ | |
c3a57ed7 TT |
89 | union { |
90 | ||
91 | struct { /* no chunks */ | |
2d8a9726 | 92 | __be32 rm_empty[3]; /* 3 empty chunk lists */ |
c3a57ed7 TT |
93 | } rm_nochunks; |
94 | ||
95 | struct { /* no chunks and padded */ | |
2d8a9726 AV |
96 | __be32 rm_align; /* Padding alignment */ |
97 | __be32 rm_thresh; /* Padding threshold */ | |
98 | __be32 rm_pempty[3]; /* 3 empty chunk lists */ | |
c3a57ed7 TT |
99 | } rm_padded; |
100 | ||
59aa1f9a CL |
101 | struct { |
102 | __be32 rm_err; | |
103 | __be32 rm_vers_low; | |
104 | __be32 rm_vers_high; | |
105 | } rm_error; | |
106 | ||
2d8a9726 | 107 | __be32 rm_chunks[0]; /* read, write and reply chunks */ |
c3a57ed7 TT |
108 | |
109 | } rm_body; | |
110 | }; | |
111 | ||
f2846481 CL |
112 | /* |
113 | * Smallest RPC/RDMA header: rm_xid through rm_type, then rm_nochunks | |
114 | */ | |
115 | #define RPCRDMA_HDRLEN_MIN (sizeof(__be32) * 7) | |
d8647f2d | 116 | #define RPCRDMA_HDRLEN_ERR (sizeof(__be32) * 5) |
c3a57ed7 TT |
117 | |
118 | enum rpcrdma_errcode { | |
119 | ERR_VERS = 1, | |
120 | ERR_CHUNK = 2 | |
121 | }; | |
122 | ||
c3a57ed7 TT |
123 | enum rpcrdma_proc { |
124 | RDMA_MSG = 0, /* An RPC call or reply msg */ | |
125 | RDMA_NOMSG = 1, /* An RPC call or reply msg - separate body */ | |
126 | RDMA_MSGP = 2, /* An RPC call or reply msg with padding */ | |
127 | RDMA_DONE = 3, /* Client signals reply completion */ | |
128 | RDMA_ERROR = 4 /* An RPC RDMA encoding error */ | |
129 | }; | |
130 | ||
284f4902 CL |
131 | #define rdma_msg cpu_to_be32(RDMA_MSG) |
132 | #define rdma_nomsg cpu_to_be32(RDMA_NOMSG) | |
133 | #define rdma_msgp cpu_to_be32(RDMA_MSGP) | |
134 | #define rdma_done cpu_to_be32(RDMA_DONE) | |
135 | #define rdma_error cpu_to_be32(RDMA_ERROR) | |
136 | ||
ff06bd19 CL |
137 | /* |
138 | * Private extension to RPC-over-RDMA Version One. | |
139 | * Message passed during RDMA-CM connection set-up. | |
140 | * | |
141 | * Add new fields at the end, and don't permute existing | |
142 | * fields. | |
143 | */ | |
144 | struct rpcrdma_connect_private { | |
145 | __be32 cp_magic; | |
146 | u8 cp_version; | |
147 | u8 cp_flags; | |
148 | u8 cp_send_size; | |
149 | u8 cp_recv_size; | |
150 | } __packed; | |
151 | ||
152 | #define rpcrdma_cmp_magic __cpu_to_be32(0xf6ab0e18) | |
153 | ||
154 | enum { | |
155 | RPCRDMA_CMP_VERSION = 1, | |
156 | RPCRDMA_CMP_F_SND_W_INV_OK = BIT(0), | |
157 | }; | |
158 | ||
159 | static inline u8 | |
160 | rpcrdma_encode_buffer_size(unsigned int size) | |
161 | { | |
162 | return (size >> 10) - 1; | |
163 | } | |
164 | ||
165 | static inline unsigned int | |
166 | rpcrdma_decode_buffer_size(u8 val) | |
167 | { | |
168 | return ((unsigned int)val + 1) << 10; | |
169 | } | |
170 | ||
c3a57ed7 | 171 | #endif /* _LINUX_SUNRPC_RPC_RDMA_H */ |