4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lnet/selftest/selftest.h
34 * Author: Isaac Huang <isaac@clusterfs.com>
36 #ifndef __SELFTEST_SELFTEST_H__
37 #define __SELFTEST_SELFTEST_H__
41 #include "../../include/linux/libcfs/libcfs.h"
42 #include "../../include/linux/lnet/lnet.h"
43 #include "../../include/linux/lnet/lib-lnet.h"
44 #include "../../include/linux/lnet/lib-types.h"
45 #include "../../include/linux/lnet/lnetst.h"
50 #ifndef MADE_WITHOUT_COMPROMISE
51 #define MADE_WITHOUT_COMPROMISE
54 #define SWI_STATE_NEWBORN 0
55 #define SWI_STATE_REPLY_SUBMITTED 1
56 #define SWI_STATE_REPLY_SENT 2
57 #define SWI_STATE_REQUEST_SUBMITTED 3
58 #define SWI_STATE_REQUEST_SENT 4
59 #define SWI_STATE_REPLY_RECEIVED 5
60 #define SWI_STATE_BULK_STARTED 6
61 #define SWI_STATE_DONE 10
65 struct srpc_service_cd;
67 struct sfw_test_instance;
69 /* services below SRPC_FRAMEWORK_SERVICE_MAX_ID are framework
70 * services, e.g. create/modify session.
72 #define SRPC_SERVICE_DEBUG 0
73 #define SRPC_SERVICE_MAKE_SESSION 1
74 #define SRPC_SERVICE_REMOVE_SESSION 2
75 #define SRPC_SERVICE_BATCH 3
76 #define SRPC_SERVICE_TEST 4
77 #define SRPC_SERVICE_QUERY_STAT 5
78 #define SRPC_SERVICE_JOIN 6
79 #define SRPC_FRAMEWORK_SERVICE_MAX_ID 10
80 /* other services start from SRPC_FRAMEWORK_SERVICE_MAX_ID+1 */
81 #define SRPC_SERVICE_BRW 11
82 #define SRPC_SERVICE_PING 12
83 #define SRPC_SERVICE_MAX_ID 12
85 #define SRPC_REQUEST_PORTAL 50
86 /* a lazy portal for framework RPC requests */
87 #define SRPC_FRAMEWORK_REQUEST_PORTAL 51
88 /* all reply/bulk RDMAs go to this portal */
89 #define SRPC_RDMA_PORTAL 52
91 static inline enum srpc_msg_type
92 srpc_service2request(int service)
97 case SRPC_SERVICE_DEBUG:
98 return SRPC_MSG_DEBUG_REQST;
100 case SRPC_SERVICE_MAKE_SESSION:
101 return SRPC_MSG_MKSN_REQST;
103 case SRPC_SERVICE_REMOVE_SESSION:
104 return SRPC_MSG_RMSN_REQST;
106 case SRPC_SERVICE_BATCH:
107 return SRPC_MSG_BATCH_REQST;
109 case SRPC_SERVICE_TEST:
110 return SRPC_MSG_TEST_REQST;
112 case SRPC_SERVICE_QUERY_STAT:
113 return SRPC_MSG_STAT_REQST;
115 case SRPC_SERVICE_BRW:
116 return SRPC_MSG_BRW_REQST;
118 case SRPC_SERVICE_PING:
119 return SRPC_MSG_PING_REQST;
121 case SRPC_SERVICE_JOIN:
122 return SRPC_MSG_JOIN_REQST;
126 static inline enum srpc_msg_type
127 srpc_service2reply(int service)
129 return srpc_service2request(service) + 1;
132 enum srpc_event_type {
133 SRPC_BULK_REQ_RCVD = 1, /* passive bulk request(PUT sink/GET source)
136 SRPC_BULK_PUT_SENT = 2, /* active bulk PUT sent (source) */
137 SRPC_BULK_GET_RPLD = 3, /* active bulk GET replied (sink) */
138 SRPC_REPLY_RCVD = 4, /* incoming reply received */
139 SRPC_REPLY_SENT = 5, /* outgoing reply sent */
140 SRPC_REQUEST_RCVD = 6, /* incoming request received */
141 SRPC_REQUEST_SENT = 7, /* outgoing request sent */
146 enum srpc_event_type ev_type; /* what's up */
147 enum lnet_event_kind ev_lnet; /* LNet event type */
148 int ev_fired; /* LNet event fired? */
149 int ev_status; /* LNet event status */
150 void *ev_data; /* owning server/client RPC */
153 /* bulk descriptor */
155 int bk_len; /* len of bulk data */
156 struct lnet_handle_md bk_mdh;
157 int bk_sink; /* sink/source */
158 int bk_niov; /* # iov in bk_iovs */
159 struct bio_vec bk_iovs[0];
162 /* message buffer descriptor */
164 struct list_head buf_list; /* chain on srpc_service::*_msgq */
165 struct srpc_msg buf_msg;
166 struct lnet_handle_md buf_mdh;
168 struct lnet_process_id buf_peer;
172 typedef int (*swi_action_t) (struct swi_workitem *);
174 struct swi_workitem {
175 struct cfs_wi_sched *swi_sched;
176 struct cfs_workitem swi_workitem;
177 swi_action_t swi_action;
181 /* server-side state of a RPC */
182 struct srpc_server_rpc {
183 /* chain on srpc_service::*_rpcq */
184 struct list_head srpc_list;
185 struct srpc_service_cd *srpc_scd;
186 struct swi_workitem srpc_wi;
187 struct srpc_event srpc_ev; /* bulk/reply event */
188 lnet_nid_t srpc_self;
189 struct lnet_process_id srpc_peer;
190 struct srpc_msg srpc_replymsg;
191 struct lnet_handle_md srpc_replymdh;
192 struct srpc_buffer *srpc_reqstbuf;
193 struct srpc_bulk *srpc_bulk;
195 unsigned int srpc_aborted; /* being given up */
197 void (*srpc_done)(struct srpc_server_rpc *);
200 /* client-side state of a RPC */
201 struct srpc_client_rpc {
202 struct list_head crpc_list; /* chain on user's lists */
203 spinlock_t crpc_lock; /* serialize */
205 atomic_t crpc_refcount;
206 int crpc_timeout; /* # seconds to wait for reply */
207 struct stt_timer crpc_timer;
208 struct swi_workitem crpc_wi;
209 struct lnet_process_id crpc_dest;
211 void (*crpc_done)(struct srpc_client_rpc *);
212 void (*crpc_fini)(struct srpc_client_rpc *);
213 int crpc_status; /* completion status */
214 void *crpc_priv; /* caller data */
217 unsigned int crpc_aborted:1; /* being given up */
218 unsigned int crpc_closed:1; /* completed */
221 struct srpc_event crpc_bulkev; /* bulk event */
222 struct srpc_event crpc_reqstev; /* request event */
223 struct srpc_event crpc_replyev; /* reply event */
225 /* bulk, request(reqst), and reply exchanged on wire */
226 struct srpc_msg crpc_reqstmsg;
227 struct srpc_msg crpc_replymsg;
228 struct lnet_handle_md crpc_reqstmdh;
229 struct lnet_handle_md crpc_replymdh;
230 struct srpc_bulk crpc_bulk;
233 #define srpc_client_rpc_size(rpc) \
234 offsetof(struct srpc_client_rpc, crpc_bulk.bk_iovs[(rpc)->crpc_bulk.bk_niov])
236 #define srpc_client_rpc_addref(rpc) \
238 CDEBUG(D_NET, "RPC[%p] -> %s (%d)++\n", \
239 (rpc), libcfs_id2str((rpc)->crpc_dest), \
240 atomic_read(&(rpc)->crpc_refcount)); \
241 LASSERT(atomic_read(&(rpc)->crpc_refcount) > 0); \
242 atomic_inc(&(rpc)->crpc_refcount); \
245 #define srpc_client_rpc_decref(rpc) \
247 CDEBUG(D_NET, "RPC[%p] -> %s (%d)--\n", \
248 (rpc), libcfs_id2str((rpc)->crpc_dest), \
249 atomic_read(&(rpc)->crpc_refcount)); \
250 LASSERT(atomic_read(&(rpc)->crpc_refcount) > 0); \
251 if (atomic_dec_and_test(&(rpc)->crpc_refcount)) \
252 srpc_destroy_client_rpc(rpc); \
255 #define srpc_event_pending(rpc) (!(rpc)->crpc_bulkev.ev_fired || \
256 !(rpc)->crpc_reqstev.ev_fired || \
257 !(rpc)->crpc_replyev.ev_fired)
259 /* CPU partition data of srpc service */
260 struct srpc_service_cd {
263 /** backref to service */
264 struct srpc_service *scd_svc;
266 struct srpc_event scd_ev;
267 /** free RPC descriptors */
268 struct list_head scd_rpc_free;
269 /** in-flight RPCs */
270 struct list_head scd_rpc_active;
271 /** workitem for posting buffer */
272 struct swi_workitem scd_buf_wi;
275 /** error code for scd_buf_wi */
277 /** timestamp for scd_buf_err */
278 time64_t scd_buf_err_stamp;
279 /** total # request buffers */
281 /** # posted request buffers */
283 /** in progress of buffer posting */
285 /** allocate more buffers if scd_buf_nposted < scd_buf_low */
287 /** increase/decrease some buffers */
289 /** posted message buffers */
290 struct list_head scd_buf_posted;
291 /** blocked for RPC descriptor */
292 struct list_head scd_buf_blocked;
295 /* number of server workitems (mini-thread) for testing service */
296 #define SFW_TEST_WI_MIN 256
297 #define SFW_TEST_WI_MAX 2048
298 /* extra buffers for tolerating buggy peers, or unbalanced number
299 * of peers between partitions
301 #define SFW_TEST_WI_EXTRA 64
303 /* number of server workitems (mini-thread) for framework service */
304 #define SFW_FRWK_WI_MIN 16
305 #define SFW_FRWK_WI_MAX 256
307 struct srpc_service {
308 int sv_id; /* service id */
309 const char *sv_name; /* human readable name */
310 int sv_wi_total; /* total server workitems */
313 /* percpt data for srpc_service */
314 struct srpc_service_cd **sv_cpt_data;
315 /* Service callbacks:
316 * - sv_handler: process incoming RPC request
317 * - sv_bulk_ready: notify bulk data
319 int (*sv_handler)(struct srpc_server_rpc *);
320 int (*sv_bulk_ready)(struct srpc_server_rpc *, int);
324 struct list_head sn_list; /* chain on fw_zombie_sessions */
325 struct lst_sid sn_id; /* unique identifier */
326 unsigned int sn_timeout; /* # seconds' inactivity to expire */
328 unsigned int sn_features;
329 struct stt_timer sn_timer;
330 struct list_head sn_batches; /* list of batches */
331 char sn_name[LST_NAME_SIZE];
332 atomic_t sn_refcount;
333 atomic_t sn_brw_errors;
334 atomic_t sn_ping_errors;
335 unsigned long sn_started;
338 #define sfw_sid_equal(sid0, sid1) ((sid0).ses_nid == (sid1).ses_nid && \
339 (sid0).ses_stamp == (sid1).ses_stamp)
342 struct list_head bat_list; /* chain on sn_batches */
343 struct lst_bid bat_id; /* batch id */
344 int bat_error; /* error code of batch */
345 struct sfw_session *bat_session; /* batch's session */
346 atomic_t bat_nactive; /* # of active tests */
347 struct list_head bat_tests; /* test instances */
350 struct sfw_test_client_ops {
351 int (*tso_init)(struct sfw_test_instance *tsi); /* initialize test
354 void (*tso_fini)(struct sfw_test_instance *tsi); /* finalize test
357 int (*tso_prep_rpc)(struct sfw_test_unit *tsu,
358 struct lnet_process_id dest,
359 struct srpc_client_rpc **rpc); /* prep a tests rpc */
360 void (*tso_done_rpc)(struct sfw_test_unit *tsu,
361 struct srpc_client_rpc *rpc); /* done a test rpc */
364 struct sfw_test_instance {
365 struct list_head tsi_list; /* chain on batch */
366 int tsi_service; /* test type */
367 struct sfw_batch *tsi_batch; /* batch */
368 struct sfw_test_client_ops *tsi_ops; /* test client operation
371 /* public parameter for all test units */
372 unsigned int tsi_is_client:1; /* is test client */
373 unsigned int tsi_stoptsu_onerr:1; /* stop tsu on error */
374 int tsi_concur; /* concurrency */
375 int tsi_loop; /* loop count */
377 /* status of test instance */
378 spinlock_t tsi_lock; /* serialize */
379 unsigned int tsi_stopping:1; /* test is stopping */
380 atomic_t tsi_nactive; /* # of active test
383 struct list_head tsi_units; /* test units */
384 struct list_head tsi_free_rpcs; /* free rpcs */
385 struct list_head tsi_active_rpcs; /* active rpcs */
388 struct test_ping_req ping; /* ping parameter */
389 struct test_bulk_req bulk_v0; /* bulk parameter */
390 struct test_bulk_req_v1 bulk_v1; /* bulk v1 parameter */
395 * XXX: trailing (PAGE_SIZE % sizeof(struct lnet_process_id)) bytes at the end
396 * of pages are not used
398 #define SFW_MAX_CONCUR LST_MAX_CONCUR
399 #define SFW_ID_PER_PAGE (PAGE_SIZE / sizeof(struct lnet_process_id_packed))
400 #define SFW_MAX_NDESTS (LNET_MAX_IOV * SFW_ID_PER_PAGE)
401 #define sfw_id_pages(n) (((n) + SFW_ID_PER_PAGE - 1) / SFW_ID_PER_PAGE)
403 struct sfw_test_unit {
404 struct list_head tsu_list; /* chain on lst_test_instance */
405 struct lnet_process_id tsu_dest; /* id of dest node */
406 int tsu_loop; /* loop count of the test */
407 struct sfw_test_instance *tsu_instance; /* pointer to test instance */
408 void *tsu_private; /* private data */
409 struct swi_workitem tsu_worker; /* workitem of the test unit */
412 struct sfw_test_case {
413 struct list_head tsc_list; /* chain on fw_tests */
414 struct srpc_service *tsc_srv_service; /* test service */
415 struct sfw_test_client_ops *tsc_cli_ops; /* ops of test client */
418 struct srpc_client_rpc *
419 sfw_create_rpc(struct lnet_process_id peer, int service,
420 unsigned int features, int nbulkiov, int bulklen,
421 void (*done)(struct srpc_client_rpc *), void *priv);
422 int sfw_create_test_rpc(struct sfw_test_unit *tsu,
423 struct lnet_process_id peer, unsigned int features,
424 int nblk, int blklen, struct srpc_client_rpc **rpc);
425 void sfw_abort_rpc(struct srpc_client_rpc *rpc);
426 void sfw_post_rpc(struct srpc_client_rpc *rpc);
427 void sfw_client_rpc_done(struct srpc_client_rpc *rpc);
428 void sfw_unpack_message(struct srpc_msg *msg);
429 void sfw_free_pages(struct srpc_server_rpc *rpc);
430 void sfw_add_bulk_page(struct srpc_bulk *bk, struct page *pg, int i);
431 int sfw_alloc_pages(struct srpc_server_rpc *rpc, int cpt, int npages, int len,
433 int sfw_make_session(struct srpc_mksn_reqst *request,
434 struct srpc_mksn_reply *reply);
436 struct srpc_client_rpc *
437 srpc_create_client_rpc(struct lnet_process_id peer, int service,
438 int nbulkiov, int bulklen,
439 void (*rpc_done)(struct srpc_client_rpc *),
440 void (*rpc_fini)(struct srpc_client_rpc *), void *priv);
441 void srpc_post_rpc(struct srpc_client_rpc *rpc);
442 void srpc_abort_rpc(struct srpc_client_rpc *rpc, int why);
443 void srpc_free_bulk(struct srpc_bulk *bk);
444 struct srpc_bulk *srpc_alloc_bulk(int cpt, unsigned int off,
445 unsigned int bulk_npg, unsigned int bulk_len,
447 int srpc_send_rpc(struct swi_workitem *wi);
448 int srpc_send_reply(struct srpc_server_rpc *rpc);
449 int srpc_add_service(struct srpc_service *sv);
450 int srpc_remove_service(struct srpc_service *sv);
451 void srpc_shutdown_service(struct srpc_service *sv);
452 void srpc_abort_service(struct srpc_service *sv);
453 int srpc_finish_service(struct srpc_service *sv);
454 int srpc_service_add_buffers(struct srpc_service *sv, int nbuffer);
455 void srpc_service_remove_buffers(struct srpc_service *sv, int nbuffer);
456 void srpc_get_counters(struct srpc_counters *cnt);
457 void srpc_set_counters(const struct srpc_counters *cnt);
459 extern struct cfs_wi_sched *lst_sched_serial;
460 extern struct cfs_wi_sched **lst_sched_test;
463 srpc_serv_is_framework(struct srpc_service *svc)
465 return svc->sv_id < SRPC_FRAMEWORK_SERVICE_MAX_ID;
469 swi_wi_action(struct cfs_workitem *wi)
471 struct swi_workitem *swi;
473 swi = container_of(wi, struct swi_workitem, swi_workitem);
475 return swi->swi_action(swi);
479 swi_init_workitem(struct swi_workitem *swi, void *data,
480 swi_action_t action, struct cfs_wi_sched *sched)
482 swi->swi_sched = sched;
483 swi->swi_action = action;
484 swi->swi_state = SWI_STATE_NEWBORN;
485 cfs_wi_init(&swi->swi_workitem, data, swi_wi_action);
489 swi_schedule_workitem(struct swi_workitem *wi)
491 cfs_wi_schedule(wi->swi_sched, &wi->swi_workitem);
495 swi_exit_workitem(struct swi_workitem *swi)
497 cfs_wi_exit(swi->swi_sched, &swi->swi_workitem);
501 swi_deschedule_workitem(struct swi_workitem *swi)
503 return cfs_wi_deschedule(swi->swi_sched, &swi->swi_workitem);
506 int sfw_startup(void);
507 int srpc_startup(void);
508 void sfw_shutdown(void);
509 void srpc_shutdown(void);
512 srpc_destroy_client_rpc(struct srpc_client_rpc *rpc)
515 LASSERT(!srpc_event_pending(rpc));
516 LASSERT(!atomic_read(&rpc->crpc_refcount));
519 LIBCFS_FREE(rpc, srpc_client_rpc_size(rpc));
521 (*rpc->crpc_fini)(rpc);
525 srpc_init_client_rpc(struct srpc_client_rpc *rpc, struct lnet_process_id peer,
526 int service, int nbulkiov, int bulklen,
527 void (*rpc_done)(struct srpc_client_rpc *),
528 void (*rpc_fini)(struct srpc_client_rpc *), void *priv)
530 LASSERT(nbulkiov <= LNET_MAX_IOV);
532 memset(rpc, 0, offsetof(struct srpc_client_rpc,
533 crpc_bulk.bk_iovs[nbulkiov]));
535 INIT_LIST_HEAD(&rpc->crpc_list);
536 swi_init_workitem(&rpc->crpc_wi, rpc, srpc_send_rpc,
537 lst_sched_test[lnet_cpt_of_nid(peer.nid)]);
538 spin_lock_init(&rpc->crpc_lock);
539 atomic_set(&rpc->crpc_refcount, 1); /* 1 ref for caller */
541 rpc->crpc_dest = peer;
542 rpc->crpc_priv = priv;
543 rpc->crpc_service = service;
544 rpc->crpc_bulk.bk_len = bulklen;
545 rpc->crpc_bulk.bk_niov = nbulkiov;
546 rpc->crpc_done = rpc_done;
547 rpc->crpc_fini = rpc_fini;
548 LNetInvalidateMDHandle(&rpc->crpc_reqstmdh);
549 LNetInvalidateMDHandle(&rpc->crpc_replymdh);
550 LNetInvalidateMDHandle(&rpc->crpc_bulk.bk_mdh);
552 /* no event is expected at this point */
553 rpc->crpc_bulkev.ev_fired = 1;
554 rpc->crpc_reqstev.ev_fired = 1;
555 rpc->crpc_replyev.ev_fired = 1;
557 rpc->crpc_reqstmsg.msg_magic = SRPC_MSG_MAGIC;
558 rpc->crpc_reqstmsg.msg_version = SRPC_MSG_VERSION;
559 rpc->crpc_reqstmsg.msg_type = srpc_service2request(service);
562 static inline const char *
563 swi_state2str(int state)
565 #define STATE2STR(x) case x: return #x
569 STATE2STR(SWI_STATE_NEWBORN);
570 STATE2STR(SWI_STATE_REPLY_SUBMITTED);
571 STATE2STR(SWI_STATE_REPLY_SENT);
572 STATE2STR(SWI_STATE_REQUEST_SUBMITTED);
573 STATE2STR(SWI_STATE_REQUEST_SENT);
574 STATE2STR(SWI_STATE_REPLY_RECEIVED);
575 STATE2STR(SWI_STATE_BULK_STARTED);
576 STATE2STR(SWI_STATE_DONE);
581 #define selftest_wait_events() \
583 set_current_state(TASK_UNINTERRUPTIBLE); \
584 schedule_timeout(cfs_time_seconds(1) / 10); \
587 #define lst_wait_until(cond, lock, fmt, ...) \
591 CDEBUG(is_power_of_2(++__I) ? D_WARNING : D_NET, \
592 fmt, ## __VA_ARGS__); \
593 spin_unlock(&(lock)); \
595 selftest_wait_events(); \
597 spin_lock(&(lock)); \
602 srpc_wait_service_shutdown(struct srpc_service *sv)
606 LASSERT(sv->sv_shuttingdown);
608 while (!srpc_finish_service(sv)) {
610 CDEBUG(((i & -i) == i) ? D_WARNING : D_NET,
611 "Waiting for %s service to shutdown...\n",
613 selftest_wait_events();
617 extern struct sfw_test_client_ops brw_test_client;
618 void brw_init_test_client(void);
620 extern struct srpc_service brw_test_service;
621 void brw_init_test_service(void);
623 extern struct sfw_test_client_ops ping_test_client;
624 void ping_init_test_client(void);
626 extern struct srpc_service ping_test_service;
627 void ping_init_test_service(void);
629 #endif /* __SELFTEST_SELFTEST_H__ */