1 /*
2 * GPL HEADER START
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
19 *
20 * GPL HEADER END
21 */
22 /*
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
25 *
26 * Copyright (c) 2012, Intel Corporation.
27 */
28 /*
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
31 */
32
33 #ifndef __SELFTEST_RPC_H__
34 #define __SELFTEST_RPC_H__
35
36 #include <uapi/linux/lnet/lnetst.h>
37
38 /*
39 * LST wired structures
40 *
41 * XXX: *REPLY == *REQST + 1
42 */
43 enum srpc_msg_type {
44 SRPC_MSG_MKSN_REQST = 0,
45 SRPC_MSG_MKSN_REPLY = 1,
46 SRPC_MSG_RMSN_REQST = 2,
47 SRPC_MSG_RMSN_REPLY = 3,
48 SRPC_MSG_BATCH_REQST = 4,
49 SRPC_MSG_BATCH_REPLY = 5,
50 SRPC_MSG_STAT_REQST = 6,
51 SRPC_MSG_STAT_REPLY = 7,
52 SRPC_MSG_TEST_REQST = 8,
53 SRPC_MSG_TEST_REPLY = 9,
54 SRPC_MSG_DEBUG_REQST = 10,
55 SRPC_MSG_DEBUG_REPLY = 11,
56 SRPC_MSG_BRW_REQST = 12,
57 SRPC_MSG_BRW_REPLY = 13,
58 SRPC_MSG_PING_REQST = 14,
59 SRPC_MSG_PING_REPLY = 15,
60 SRPC_MSG_JOIN_REQST = 16,
61 SRPC_MSG_JOIN_REPLY = 17,
62 };
63
64 /* CAVEAT EMPTOR:
65 * All srpc_*_reqst_t's 1st field must be matchbits of reply buffer,
66 * and 2nd field matchbits of bulk buffer if any.
67 *
68 * All srpc_*_reply_t's 1st field must be a __u32 status, and 2nd field
69 * session id if needed.
70 */
71 struct srpc_generic_reqst {
72 __u64 rpyid; /* reply buffer matchbits */
73 __u64 bulkid; /* bulk buffer matchbits */
74 } WIRE_ATTR;
75
76 struct srpc_generic_reply {
77 __u32 status;
78 struct lst_sid sid;
79 } WIRE_ATTR;
80
81 /* FRAMEWORK RPCs */
82 struct srpc_mksn_reqst {
83 __u64 mksn_rpyid; /* reply buffer matchbits */
84 struct lst_sid mksn_sid; /* session id */
85 __u32 mksn_force; /* use brute force */
86 char mksn_name[LST_NAME_SIZE];
87 } WIRE_ATTR; /* make session request */
88
89 struct srpc_mksn_reply {
90 __u32 mksn_status; /* session status */
91 struct lst_sid mksn_sid; /* session id */
92 __u32 mksn_timeout; /* session timeout */
93 char mksn_name[LST_NAME_SIZE];
94 } WIRE_ATTR; /* make session reply */
95
96 struct srpc_rmsn_reqst {
97 __u64 rmsn_rpyid; /* reply buffer matchbits */
98 struct lst_sid rmsn_sid; /* session id */
99 } WIRE_ATTR; /* remove session request */
100
101 struct srpc_rmsn_reply {
102 __u32 rmsn_status;
103 struct lst_sid rmsn_sid; /* session id */
104 } WIRE_ATTR; /* remove session reply */
105
106 struct srpc_join_reqst {
107 __u64 join_rpyid; /* reply buffer matchbits */
108 struct lst_sid join_sid; /* session id to join */
109 char join_group[LST_NAME_SIZE]; /* group name */
110 } WIRE_ATTR;
111
112 struct srpc_join_reply {
113 __u32 join_status; /* returned status */
114 struct lst_sid join_sid; /* session id */
115 __u32 join_timeout; /* # seconds' inactivity to
116 * expire
117 */
118 char join_session[LST_NAME_SIZE]; /* session name */
119 } WIRE_ATTR;
120
121 struct srpc_debug_reqst {
122 __u64 dbg_rpyid; /* reply buffer matchbits */
123 struct lst_sid dbg_sid; /* session id */
124 __u32 dbg_flags; /* bitmap of debug */
125 } WIRE_ATTR;
126
127 struct srpc_debug_reply {
128 __u32 dbg_status; /* returned code */
129 struct lst_sid dbg_sid; /* session id */
130 __u32 dbg_timeout; /* session timeout */
131 __u32 dbg_nbatch; /* # of batches in the node */
132 char dbg_name[LST_NAME_SIZE]; /* session name */
133 } WIRE_ATTR;
134
135 #define SRPC_BATCH_OPC_RUN 1
136 #define SRPC_BATCH_OPC_STOP 2
137 #define SRPC_BATCH_OPC_QUERY 3
138
139 struct srpc_batch_reqst {
140 __u64 bar_rpyid; /* reply buffer matchbits */
141 struct lst_sid bar_sid; /* session id */
142 struct lst_bid bar_bid; /* batch id */
143 __u32 bar_opc; /* create/start/stop batch */
144 __u32 bar_testidx; /* index of test */
145 __u32 bar_arg; /* parameters */
146 } WIRE_ATTR;
147
148 struct srpc_batch_reply {
149 __u32 bar_status; /* status of request */
150 struct lst_sid bar_sid; /* session id */
151 __u32 bar_active; /* # of active tests in batch/test */
152 __u32 bar_time; /* remained time */
153 } WIRE_ATTR;
154
155 struct srpc_stat_reqst {
156 __u64 str_rpyid; /* reply buffer matchbits */
157 struct lst_sid str_sid; /* session id */
158 __u32 str_type; /* type of stat */
159 } WIRE_ATTR;
160
161 struct srpc_stat_reply {
162 __u32 str_status;
163 struct lst_sid str_sid;
164 struct sfw_counters str_fw;
165 struct srpc_counters str_rpc;
166 struct lnet_counters str_lnet;
167 } WIRE_ATTR;
168
169 struct test_bulk_req {
170 __u32 blk_opc; /* bulk operation code */
171 __u32 blk_npg; /* # of pages */
172 __u32 blk_flags; /* reserved flags */
173 } WIRE_ATTR;
174
175 struct test_bulk_req_v1 {
176 __u16 blk_opc; /* bulk operation code */
177 __u16 blk_flags; /* data check flags */
178 __u32 blk_len; /* data length */
179 __u32 blk_offset; /* offset */
180 } WIRE_ATTR;
181
182 struct test_ping_req {
183 __u32 png_size; /* size of ping message */
184 __u32 png_flags; /* reserved flags */
185 } WIRE_ATTR;
186
187 struct srpc_test_reqst {
188 __u64 tsr_rpyid; /* reply buffer matchbits */
189 __u64 tsr_bulkid; /* bulk buffer matchbits */
190 struct lst_sid tsr_sid; /* session id */
191 struct lst_bid tsr_bid; /* batch id */
192 __u32 tsr_service; /* test type: bulk|ping|... */
193 __u32 tsr_loop; /* test client loop count or
194 * # server buffers needed
195 */
196 __u32 tsr_concur; /* concurrency of test */
197 __u8 tsr_is_client; /* is test client or not */
198 __u8 tsr_stop_onerr; /* stop on error */
199 __u32 tsr_ndest; /* # of dest nodes */
200
201 union {
202 struct test_ping_req ping;
203 struct test_bulk_req bulk_v0;
204 struct test_bulk_req_v1 bulk_v1;
205 } tsr_u;
206 } WIRE_ATTR;
207
208 struct srpc_test_reply {
209 __u32 tsr_status; /* returned code */
210 struct lst_sid tsr_sid;
211 } WIRE_ATTR;
212
213 /* TEST RPCs */
214 struct srpc_ping_reqst {
215 __u64 pnr_rpyid;
216 __u32 pnr_magic;
217 __u32 pnr_seq;
218 __u64 pnr_time_sec;
219 __u64 pnr_time_usec;
220 } WIRE_ATTR;
221
222 struct srpc_ping_reply {
223 __u32 pnr_status;
224 __u32 pnr_magic;
225 __u32 pnr_seq;
226 } WIRE_ATTR;
227
228 struct srpc_brw_reqst {
229 __u64 brw_rpyid; /* reply buffer matchbits */
230 __u64 brw_bulkid; /* bulk buffer matchbits */
231 __u32 brw_rw; /* read or write */
232 __u32 brw_len; /* bulk data len */
233 __u32 brw_flags; /* bulk data patterns */
234 } WIRE_ATTR; /* bulk r/w request */
235
236 struct srpc_brw_reply {
237 __u32 brw_status;
238 } WIRE_ATTR; /* bulk r/w reply */
239
240 #define SRPC_MSG_MAGIC 0xeeb0f00d
241 #define SRPC_MSG_VERSION 1
242
243 struct srpc_msg {
244 __u32 msg_magic; /* magic number */
245 __u32 msg_version; /* message version number */
246 __u32 msg_type; /* type of message body: srpc_msg_type */
247 __u32 msg_reserved0;
248 __u32 msg_reserved1;
249 __u32 msg_ses_feats; /* test session features */
250 union {
251 struct srpc_generic_reqst reqst;
252 struct srpc_generic_reply reply;
253
254 struct srpc_mksn_reqst mksn_reqst;
255 struct srpc_mksn_reply mksn_reply;
256 struct srpc_rmsn_reqst rmsn_reqst;
257 struct srpc_rmsn_reply rmsn_reply;
258 struct srpc_debug_reqst dbg_reqst;
259 struct srpc_debug_reply dbg_reply;
260 struct srpc_batch_reqst bat_reqst;
261 struct srpc_batch_reply bat_reply;
262 struct srpc_stat_reqst stat_reqst;
263 struct srpc_stat_reply stat_reply;
264 struct srpc_test_reqst tes_reqst;
265 struct srpc_test_reply tes_reply;
266 struct srpc_join_reqst join_reqst;
267 struct srpc_join_reply join_reply;
268
269 struct srpc_ping_reqst ping_reqst;
270 struct srpc_ping_reply ping_reply;
271 struct srpc_brw_reqst brw_reqst;
272 struct srpc_brw_reply brw_reply;
273 } msg_body;
274 } WIRE_ATTR;
275
276 static inline void
srpc_unpack_msg_hdr(struct srpc_msg * msg)277 srpc_unpack_msg_hdr(struct srpc_msg *msg)
278 {
279 if (msg->msg_magic == SRPC_MSG_MAGIC)
280 return; /* no flipping needed */
281
282 /*
283 * We do not swap the magic number here as it is needed to
284 * determine whether the body needs to be swapped.
285 */
286 /* __swab32s(&msg->msg_magic); */
287 __swab32s(&msg->msg_type);
288 __swab32s(&msg->msg_version);
289 __swab32s(&msg->msg_ses_feats);
290 __swab32s(&msg->msg_reserved0);
291 __swab32s(&msg->msg_reserved1);
292 }
293
294 #endif /* __SELFTEST_RPC_H__ */
295