Whamcloud - gitweb
LU-16509 lnet: memcpy false positive in brw_test
[fs/lustre-release.git] / lnet / selftest / brw_test.c
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, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lnet/selftest/brw_test.c
32  *
33  * Author: Isaac Huang <isaac@clusterfs.com>
34  */
35
36 #include "selftest.h"
37
38 static int brw_srv_workitems = SFW_TEST_WI_MAX;
39 module_param(brw_srv_workitems, int, 0644);
40 MODULE_PARM_DESC(brw_srv_workitems, "# BRW server workitems");
41
42 static int brw_inject_errors;
43 module_param(brw_inject_errors, int, 0644);
44 MODULE_PARM_DESC(brw_inject_errors, "# data errors to inject randomly, zero by default");
45
46 #define BRW_POISON      0xbeefbeefbeefbeefULL
47 #define BRW_MAGIC       0xeeb0eeb1eeb2eeb3ULL
48 #define BRW_MSIZE       sizeof(__u64)
49
50 static void
51 brw_client_fini(struct sfw_test_instance *tsi)
52 {
53         struct srpc_bulk *bulk;
54         struct sfw_test_unit *tsu;
55
56         LASSERT(tsi->tsi_is_client);
57
58         list_for_each_entry(tsu, &tsi->tsi_units, tsu_list) {
59                 bulk = tsu->tsu_private;
60                 if (bulk == NULL)
61                         continue;
62
63                 srpc_free_bulk(bulk);
64                 tsu->tsu_private = NULL;
65         }
66 }
67
68 static int
69 brw_client_init(struct sfw_test_instance *tsi)
70 {
71         struct sfw_session *sn = tsi->tsi_batch->bat_session;
72         int               flags;
73         int               off;
74         int               npg;
75         int               len;
76         int               opc;
77         struct srpc_bulk *bulk;
78         struct sfw_test_unit *tsu;
79
80         LASSERT(sn != NULL);
81         LASSERT(tsi->tsi_is_client);
82
83         if ((sn->sn_features & LST_FEAT_BULK_LEN) == 0) {
84                 struct test_bulk_req *breq = &tsi->tsi_u.bulk_v0;
85
86                 opc   = breq->blk_opc;
87                 flags = breq->blk_flags;
88                 npg   = breq->blk_npg;
89                 /* NB: this is not going to work for variable page size,
90                  * but we have to keep it for compatibility */
91                 len   = npg * PAGE_SIZE;
92                 off   = 0;
93
94         } else {
95                 struct test_bulk_req_v1 *breq = &tsi->tsi_u.bulk_v1;
96
97                 /* I should never get this step if it's unknown feature
98                  * because make_session will reject unknown feature */
99                 LASSERT((sn->sn_features & ~LST_FEATS_MASK) == 0);
100
101                 opc   = breq->blk_opc;
102                 flags = breq->blk_flags;
103                 len   = breq->blk_len;
104                 off   = breq->blk_offset & ~PAGE_MASK;
105                 npg   = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
106         }
107
108         if (off % BRW_MSIZE != 0)
109                 return -EINVAL;
110
111         if (npg > LNET_MAX_IOV || npg <= 0)
112                 return -EINVAL;
113
114         if (opc != LST_BRW_READ && opc != LST_BRW_WRITE)
115                 return -EINVAL;
116
117         if (flags != LST_BRW_CHECK_NONE &&
118             flags != LST_BRW_CHECK_FULL && flags != LST_BRW_CHECK_SIMPLE)
119                 return -EINVAL;
120
121         list_for_each_entry(tsu, &tsi->tsi_units, tsu_list) {
122                 bulk = srpc_alloc_bulk(lnet_cpt_of_nid(tsu->tsu_dest.nid, NULL),
123                                        off, npg, len, opc == LST_BRW_READ);
124                 if (bulk == NULL) {
125                         brw_client_fini(tsi);
126                         return -ENOMEM;
127                 }
128
129                 tsu->tsu_private = bulk;
130         }
131
132         return 0;
133 }
134
135 #define BRW_POISON      0xbeefbeefbeefbeefULL
136 #define BRW_MAGIC       0xeeb0eeb1eeb2eeb3ULL
137 #define BRW_MSIZE       sizeof(__u64)
138
139 static int brw_inject_one_error(void)
140 {
141         struct timespec64 ts;
142
143         if (brw_inject_errors <= 0) return 0;
144
145         ktime_get_ts64(&ts);
146
147         if (((ts.tv_nsec / NSEC_PER_USEC) & 1) == 0)
148                 return 0;
149
150         return brw_inject_errors--;
151 }
152
153 static void
154 brw_fill_page(struct page *pg, int off, int len, int pattern, __u64 magic)
155 {
156         char *addr = page_address(pg) + off;
157         int   i;
158
159         LASSERT(addr != NULL);
160         LASSERT(off % BRW_MSIZE == 0 && len % BRW_MSIZE == 0);
161
162         if (pattern == LST_BRW_CHECK_NONE)
163                 return;
164
165         if (magic == BRW_MAGIC)
166                 magic += brw_inject_one_error();
167
168         if (pattern == LST_BRW_CHECK_SIMPLE) {
169                 memcpy(addr, &magic, BRW_MSIZE);
170                 if (len > BRW_MSIZE) {
171                         addr += len - BRW_MSIZE;
172                         memcpy(addr, &magic, BRW_MSIZE);
173                 }
174                 return;
175         }
176
177         if (pattern == LST_BRW_CHECK_FULL) {
178                 for (i = 0; i < len; i += BRW_MSIZE)
179                         memcpy(addr + i, &magic, BRW_MSIZE);
180                 return;
181         }
182         LBUG();
183 }
184
185 static int
186 brw_check_page(struct page *pg, int off, int len, int pattern, __u64 magic)
187 {
188         char  *addr = page_address(pg) + off;
189         __u64  data = 0; /* make compiler happy */
190         int    i;
191
192         LASSERT(addr != NULL);
193         LASSERT(off % BRW_MSIZE == 0 && len % BRW_MSIZE == 0);
194
195         if (pattern == LST_BRW_CHECK_NONE)
196                 return 0;
197
198         if (pattern == LST_BRW_CHECK_SIMPLE) {
199                 data = *((__u64 *) addr);
200                 if (data != magic)
201                         goto bad_data;
202
203                 if (len > BRW_MSIZE) {
204                         addr += len - BRW_MSIZE;
205                         data = *((__u64 *) addr);
206                         if (data != magic)
207                                 goto bad_data;
208                 }
209                 return 0;
210         }
211
212         if (pattern == LST_BRW_CHECK_FULL) {
213                 for (i = 0; i < len; i += BRW_MSIZE) {
214                         data = *(__u64 *)(addr + i);
215                         if (data != magic)
216                                 goto bad_data;
217                 }
218                 return 0;
219         }
220
221         LBUG();
222
223 bad_data:
224         CERROR ("Bad data in page %p: %#llx, %#llx expected\n",
225                 pg, data, magic);
226         return 1;
227 }
228
229 static void
230 brw_fill_bulk(struct srpc_bulk *bk, int pattern, __u64 magic)
231 {
232         int          i;
233         struct page *pg;
234
235         for (i = 0; i < bk->bk_niov; i++) {
236                 int     off;
237                 int     len;
238
239                 pg = bk->bk_iovs[i].bv_page;
240                 off = bk->bk_iovs[i].bv_offset;
241                 len = bk->bk_iovs[i].bv_len;
242                 brw_fill_page(pg, off, len, pattern, magic);
243         }
244 }
245
246 static int
247 brw_check_bulk(struct srpc_bulk *bk, int pattern, __u64 magic)
248 {
249         int          i;
250         struct page *pg;
251
252         for (i = 0; i < bk->bk_niov; i++) {
253                 int     off;
254                 int     len;
255
256                 pg = bk->bk_iovs[i].bv_page;
257                 off = bk->bk_iovs[i].bv_offset;
258                 len = bk->bk_iovs[i].bv_len;
259                 if (brw_check_page(pg, off, len, pattern, magic) != 0) {
260                         CERROR("Bulk page %p (%d/%d) is corrupted!\n",
261                                pg, i, bk->bk_niov);
262                         return 1;
263                 }
264         }
265
266         return 0;
267 }
268
269 static int
270 brw_client_prep_rpc(struct sfw_test_unit *tsu, struct lnet_process_id dest,
271                     struct srpc_client_rpc **rpcpp)
272 {
273         struct srpc_bulk *bulk = tsu->tsu_private;
274         struct sfw_test_instance *tsi = tsu->tsu_instance;
275         struct sfw_session *sn = tsi->tsi_batch->bat_session;
276         struct srpc_client_rpc *rpc;
277         struct srpc_brw_reqst *req;
278         int flags;
279         int npg;
280         int len;
281         int opc;
282         int rc;
283
284         LASSERT(sn != NULL);
285         LASSERT(bulk != NULL);
286
287         if ((sn->sn_features & LST_FEAT_BULK_LEN) == 0) {
288                 struct test_bulk_req *breq = &tsi->tsi_u.bulk_v0;
289
290                 opc   = breq->blk_opc;
291                 flags = breq->blk_flags;
292                 npg   = breq->blk_npg;
293                 len   = npg * PAGE_SIZE;
294
295         } else {
296                 struct test_bulk_req_v1 *breq = &tsi->tsi_u.bulk_v1;
297                 int off;
298
299                 /* I should never get this step if it's unknown feature
300                  * because make_session will reject unknown feature */
301                 LASSERT((sn->sn_features & ~LST_FEATS_MASK) == 0);
302
303                 opc   = breq->blk_opc;
304                 flags = breq->blk_flags;
305                 len   = breq->blk_len;
306                 off   = breq->blk_offset;
307                 npg   = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
308         }
309
310         rc = sfw_create_test_rpc(tsu, dest, sn->sn_features, npg, len, &rpc);
311         if (rc != 0)
312                 return rc;
313
314         unsafe_memcpy(&rpc->crpc_bulk, bulk,
315                       offsetof(struct srpc_bulk, bk_iovs[npg]),
316                       FLEXIBLE_OBJECT);
317         if (opc == LST_BRW_WRITE)
318                 brw_fill_bulk(&rpc->crpc_bulk, flags, BRW_MAGIC);
319         else
320                 brw_fill_bulk(&rpc->crpc_bulk, flags, BRW_POISON);
321
322         req = &rpc->crpc_reqstmsg.msg_body.brw_reqst;
323         req->brw_flags = flags;
324         req->brw_rw    = opc;
325         req->brw_len   = len;
326
327         *rpcpp = rpc;
328         return 0;
329 }
330
331 static void
332 brw_client_done_rpc(struct sfw_test_unit *tsu, struct srpc_client_rpc *rpc)
333 {
334         __u64 magic = BRW_MAGIC;
335         struct sfw_test_instance *tsi = tsu->tsu_instance;
336         struct sfw_session *sn = tsi->tsi_batch->bat_session;
337         struct srpc_msg *msg = &rpc->crpc_replymsg;
338         struct srpc_brw_reply *reply = &msg->msg_body.brw_reply;
339         struct srpc_brw_reqst *reqst = &rpc->crpc_reqstmsg.msg_body.brw_reqst;
340
341         LASSERT(sn != NULL);
342
343         if (rpc->crpc_status != 0) {
344                 CERROR("BRW RPC to %s failed with %d\n",
345                        libcfs_id2str(rpc->crpc_dest), rpc->crpc_status);
346                 if (!tsi->tsi_stopping) /* rpc could have been aborted */
347                         atomic_inc(&sn->sn_brw_errors);
348                 return;
349         }
350
351         if (msg->msg_magic != SRPC_MSG_MAGIC) {
352                 __swab64s(&magic);
353                 __swab32s(&reply->brw_status);
354         }
355
356         CDEBUG(reply->brw_status ? D_WARNING : D_NET,
357                "BRW RPC to %s finished with brw_status: %d\n",
358                libcfs_id2str(rpc->crpc_dest), reply->brw_status);
359
360         if (reply->brw_status != 0) {
361                 atomic_inc(&sn->sn_brw_errors);
362                 rpc->crpc_status = -(int)reply->brw_status;
363                 return;
364         }
365
366         if (reqst->brw_rw == LST_BRW_WRITE)
367                 return;
368
369         if (brw_check_bulk(&rpc->crpc_bulk, reqst->brw_flags, magic) != 0) {
370                 CERROR("Bulk data from %s is corrupted!\n",
371                        libcfs_id2str(rpc->crpc_dest));
372                 atomic_inc(&sn->sn_brw_errors);
373                 rpc->crpc_status = -EBADMSG;
374         }
375 }
376
377 static void
378 brw_server_rpc_done(struct srpc_server_rpc *rpc)
379 {
380         struct srpc_bulk *blk = rpc->srpc_bulk;
381
382         if (blk == NULL)
383                 return;
384
385         if (rpc->srpc_status != 0)
386                 CERROR("Bulk transfer %s %s has failed: %d\n",
387                        blk->bk_sink ? "from" : "to",
388                        libcfs_id2str(rpc->srpc_peer), rpc->srpc_status);
389         else
390                 CDEBUG(D_NET, "Transferred %d pages bulk data %s %s\n",
391                        blk->bk_niov, blk->bk_sink ? "from" : "to",
392                        libcfs_id2str(rpc->srpc_peer));
393
394         sfw_free_pages(rpc);
395 }
396
397 static int
398 brw_bulk_ready(struct srpc_server_rpc *rpc, int status)
399 {
400         __u64 magic = BRW_MAGIC;
401         struct srpc_brw_reply *reply = &rpc->srpc_replymsg.msg_body.brw_reply;
402         struct srpc_brw_reqst *reqst;
403         struct srpc_msg *reqstmsg;
404
405         LASSERT (rpc->srpc_bulk != NULL);
406         LASSERT (rpc->srpc_reqstbuf != NULL);
407
408         reqstmsg = &rpc->srpc_reqstbuf->buf_msg;
409         reqst = &reqstmsg->msg_body.brw_reqst;
410
411         if (status != 0) {
412                 CERROR ("BRW bulk %s failed for RPC from %s: %d\n",
413                         reqst->brw_rw == LST_BRW_READ ? "READ" : "WRITE",
414                         libcfs_id2str(rpc->srpc_peer), status);
415                 return -EIO;
416         }
417
418         if (reqst->brw_rw == LST_BRW_READ)
419                 return 0;
420
421         if (reqstmsg->msg_magic != SRPC_MSG_MAGIC)
422                 __swab64s(&magic);
423
424         if (brw_check_bulk(rpc->srpc_bulk, reqst->brw_flags, magic) != 0) {
425                 CERROR ("Bulk data from %s is corrupted!\n",
426                         libcfs_id2str(rpc->srpc_peer));
427                 reply->brw_status = EBADMSG;
428         }
429
430         return 0;
431 }
432
433 static int
434 brw_server_handle(struct srpc_server_rpc *rpc)
435 {
436         struct srpc_service *sv = rpc->srpc_scd->scd_svc;
437         struct srpc_msg *replymsg = &rpc->srpc_replymsg;
438         struct srpc_msg *reqstmsg = &rpc->srpc_reqstbuf->buf_msg;
439         struct srpc_brw_reply *reply = &replymsg->msg_body.brw_reply;
440         struct srpc_brw_reqst *reqst = &reqstmsg->msg_body.brw_reqst;
441         int npg;
442         int rc;
443
444         LASSERT (sv->sv_id == SRPC_SERVICE_BRW);
445
446         if (reqstmsg->msg_magic != SRPC_MSG_MAGIC) {
447                 LASSERT (reqstmsg->msg_magic == __swab32(SRPC_MSG_MAGIC));
448
449                 __swab32s(&reqst->brw_rw);
450                 __swab32s(&reqst->brw_len);
451                 __swab32s(&reqst->brw_flags);
452                 __swab64s(&reqst->brw_rpyid);
453                 __swab64s(&reqst->brw_bulkid);
454         }
455         LASSERT (reqstmsg->msg_type == (__u32)srpc_service2request(sv->sv_id));
456
457         reply->brw_status = 0;
458         rpc->srpc_done = brw_server_rpc_done;
459
460         if ((reqst->brw_rw != LST_BRW_READ && reqst->brw_rw != LST_BRW_WRITE) ||
461             (reqst->brw_flags != LST_BRW_CHECK_NONE &&
462              reqst->brw_flags != LST_BRW_CHECK_FULL &&
463              reqst->brw_flags != LST_BRW_CHECK_SIMPLE)) {
464                 reply->brw_status = EINVAL;
465                 return 0;
466         }
467
468         if ((reqstmsg->msg_ses_feats & ~LST_FEATS_MASK) != 0) {
469                 replymsg->msg_ses_feats = LST_FEATS_MASK;
470                 reply->brw_status = EPROTO;
471                 return 0;
472         }
473
474         if ((reqstmsg->msg_ses_feats & LST_FEAT_BULK_LEN) == 0) {
475                 /* compat with old version */
476                 if ((reqst->brw_len & ~PAGE_MASK) != 0) {
477                         reply->brw_status = EINVAL;
478                         return 0;
479                 }
480                 npg = reqst->brw_len >> PAGE_SHIFT;
481
482         } else {
483                 npg = (reqst->brw_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
484         }
485
486         replymsg->msg_ses_feats = reqstmsg->msg_ses_feats;
487
488         if (reqst->brw_len == 0 || npg > LNET_MAX_IOV) {
489                 reply->brw_status = EINVAL;
490                 return 0;
491         }
492
493         rc = sfw_alloc_pages(rpc, rpc->srpc_scd->scd_cpt, npg,
494                              reqst->brw_len,
495                              reqst->brw_rw == LST_BRW_WRITE);
496         if (rc != 0)
497                 return rc;
498
499         if (reqst->brw_rw == LST_BRW_READ)
500                 brw_fill_bulk(rpc->srpc_bulk, reqst->brw_flags, BRW_MAGIC);
501         else
502                 brw_fill_bulk(rpc->srpc_bulk, reqst->brw_flags, BRW_POISON);
503
504         return 0;
505 }
506
507 struct sfw_test_client_ops brw_test_client;
508
509 void brw_init_test_client(void)
510 {
511         brw_test_client.tso_init       = brw_client_init;
512         brw_test_client.tso_fini       = brw_client_fini;
513         brw_test_client.tso_prep_rpc   = brw_client_prep_rpc;
514         brw_test_client.tso_done_rpc   = brw_client_done_rpc;
515 };
516
517 struct srpc_service brw_test_service;
518
519 void brw_init_test_service(void)
520 {
521         brw_test_service.sv_id         = SRPC_SERVICE_BRW;
522         brw_test_service.sv_name       = "brw_test";
523         brw_test_service.sv_handler    = brw_server_handle;
524         brw_test_service.sv_bulk_ready = brw_bulk_ready;
525         brw_test_service.sv_wi_total   = brw_srv_workitems;
526 }