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.sun.com/software/products/lustre/docs/GPLv2.pdf
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
28 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
29 * Use is subject to license terms.
32 * This file is part of Lustre, http://www.lustre.org/
33 * Lustre is a trademark of Sun Microsystems, Inc.
35 * lnet/selftest/selftest.h
37 * Author: Isaac Huang <isaac@clusterfs.com>
39 #ifndef __SELFTEST_SELFTEST_H__
40 #define __SELFTEST_SELFTEST_H__
46 /* XXX workaround XXX */
47 #ifdef HAVE_SYS_TYPES_H
48 #include <sys/types.h>
52 #include <libcfs/libcfs.h>
53 #include <lnet/lnet.h>
54 #include <lnet/lib-lnet.h>
55 #include <lnet/lib-types.h>
56 #include <lnet/lnetst.h>
61 #ifndef MADE_WITHOUT_COMPROMISE
62 #define MADE_WITHOUT_COMPROMISE
66 #define SWI_STATE_NEWBORN 0
67 #define SWI_STATE_REPLY_SUBMITTED 1
68 #define SWI_STATE_REPLY_SENT 2
69 #define SWI_STATE_REQUEST_SUBMITTED 3
70 #define SWI_STATE_REQUEST_SENT 4
71 #define SWI_STATE_REPLY_RECEIVED 5
72 #define SWI_STATE_BULK_STARTED 6
73 #define SWI_STATE_DONE 10
77 struct srpc_service_cd;
79 struct sfw_test_instance;
81 /* services below SRPC_FRAMEWORK_SERVICE_MAX_ID are framework
82 * services, e.g. create/modify session.
84 #define SRPC_SERVICE_DEBUG 0
85 #define SRPC_SERVICE_MAKE_SESSION 1
86 #define SRPC_SERVICE_REMOVE_SESSION 2
87 #define SRPC_SERVICE_BATCH 3
88 #define SRPC_SERVICE_TEST 4
89 #define SRPC_SERVICE_QUERY_STAT 5
90 #define SRPC_SERVICE_JOIN 6
91 #define SRPC_FRAMEWORK_SERVICE_MAX_ID 10
92 /* other services start from SRPC_FRAMEWORK_SERVICE_MAX_ID+1 */
93 #define SRPC_SERVICE_BRW 11
94 #define SRPC_SERVICE_PING 12
95 #define SRPC_SERVICE_MAX_ID 12
97 #define SRPC_REQUEST_PORTAL 50
98 /* a lazy portal for framework RPC requests */
99 #define SRPC_FRAMEWORK_REQUEST_PORTAL 51
100 /* all reply/bulk RDMAs go to this portal */
101 #define SRPC_RDMA_PORTAL 52
103 static inline srpc_msg_type_t
104 srpc_service2request (int service)
109 case SRPC_SERVICE_DEBUG:
110 return SRPC_MSG_DEBUG_REQST;
112 case SRPC_SERVICE_MAKE_SESSION:
113 return SRPC_MSG_MKSN_REQST;
115 case SRPC_SERVICE_REMOVE_SESSION:
116 return SRPC_MSG_RMSN_REQST;
118 case SRPC_SERVICE_BATCH:
119 return SRPC_MSG_BATCH_REQST;
121 case SRPC_SERVICE_TEST:
122 return SRPC_MSG_TEST_REQST;
124 case SRPC_SERVICE_QUERY_STAT:
125 return SRPC_MSG_STAT_REQST;
127 case SRPC_SERVICE_BRW:
128 return SRPC_MSG_BRW_REQST;
130 case SRPC_SERVICE_PING:
131 return SRPC_MSG_PING_REQST;
133 case SRPC_SERVICE_JOIN:
134 return SRPC_MSG_JOIN_REQST;
138 static inline srpc_msg_type_t
139 srpc_service2reply (int service)
141 return srpc_service2request(service) + 1;
145 SRPC_BULK_REQ_RCVD = 1, /* passive bulk request(PUT sink/GET source) received */
146 SRPC_BULK_PUT_SENT = 2, /* active bulk PUT sent (source) */
147 SRPC_BULK_GET_RPLD = 3, /* active bulk GET replied (sink) */
148 SRPC_REPLY_RCVD = 4, /* incoming reply received */
149 SRPC_REPLY_SENT = 5, /* outgoing reply sent */
150 SRPC_REQUEST_RCVD = 6, /* incoming request received */
151 SRPC_REQUEST_SENT = 7, /* outgoing request sent */
156 srpc_event_type_t ev_type; /* what's up */
157 lnet_event_kind_t ev_lnet; /* LNet event type */
158 int ev_fired; /* LNet event fired? */
159 int ev_status; /* LNet event status */
160 void *ev_data; /* owning server/client RPC */
164 int bk_len; /* len of bulk data */
165 lnet_handle_md_t bk_mdh;
166 int bk_sink; /* sink/source */
167 int bk_niov; /* # iov in bk_iovs */
169 lnet_kiov_t bk_iovs[0];
171 cfs_page_t **bk_pages;
172 lnet_md_iovec_t bk_iovs[0];
174 } srpc_bulk_t; /* bulk descriptor */
176 /* message buffer descriptor */
177 typedef struct srpc_buffer {
178 cfs_list_t buf_list; /* chain on srpc_service::*_msgq */
180 lnet_handle_md_t buf_mdh;
182 lnet_process_id_t buf_peer;
186 typedef int (*swi_action_t) (struct swi_workitem *);
188 typedef struct swi_workitem {
189 struct cfs_wi_sched *swi_sched;
190 cfs_workitem_t swi_workitem;
191 swi_action_t swi_action;
195 /* server-side state of a RPC */
196 typedef struct srpc_server_rpc {
197 /* chain on srpc_service::*_rpcq */
198 cfs_list_t srpc_list;
199 struct srpc_service_cd *srpc_scd;
200 swi_workitem_t srpc_wi;
201 srpc_event_t srpc_ev; /* bulk/reply event */
202 lnet_nid_t srpc_self;
203 lnet_process_id_t srpc_peer;
204 srpc_msg_t srpc_replymsg;
205 lnet_handle_md_t srpc_replymdh;
206 srpc_buffer_t *srpc_reqstbuf;
207 srpc_bulk_t *srpc_bulk;
209 unsigned int srpc_aborted; /* being given up */
211 void (*srpc_done)(struct srpc_server_rpc *);
214 /* client-side state of a RPC */
215 typedef struct srpc_client_rpc {
216 cfs_list_t crpc_list; /* chain on user's lists */
217 cfs_spinlock_t crpc_lock; /* serialize */
219 cfs_atomic_t crpc_refcount;
220 int crpc_timeout; /* # seconds to wait for reply */
221 stt_timer_t crpc_timer;
222 swi_workitem_t crpc_wi;
223 lnet_process_id_t crpc_dest;
225 void (*crpc_done)(struct srpc_client_rpc *);
226 void (*crpc_fini)(struct srpc_client_rpc *);
227 int crpc_status; /* completion status */
228 void *crpc_priv; /* caller data */
231 unsigned int crpc_aborted:1; /* being given up */
232 unsigned int crpc_closed:1; /* completed */
235 srpc_event_t crpc_bulkev; /* bulk event */
236 srpc_event_t crpc_reqstev; /* request event */
237 srpc_event_t crpc_replyev; /* reply event */
239 /* bulk, request(reqst), and reply exchanged on wire */
240 srpc_msg_t crpc_reqstmsg;
241 srpc_msg_t crpc_replymsg;
242 lnet_handle_md_t crpc_reqstmdh;
243 lnet_handle_md_t crpc_replymdh;
244 srpc_bulk_t crpc_bulk;
247 #define srpc_client_rpc_size(rpc) \
248 offsetof(srpc_client_rpc_t, crpc_bulk.bk_iovs[(rpc)->crpc_bulk.bk_niov])
250 #define srpc_client_rpc_addref(rpc) \
252 CDEBUG(D_NET, "RPC[%p] -> %s (%d)++\n", \
253 (rpc), libcfs_id2str((rpc)->crpc_dest), \
254 cfs_atomic_read(&(rpc)->crpc_refcount)); \
255 LASSERT(cfs_atomic_read(&(rpc)->crpc_refcount) > 0); \
256 cfs_atomic_inc(&(rpc)->crpc_refcount); \
259 #define srpc_client_rpc_decref(rpc) \
261 CDEBUG(D_NET, "RPC[%p] -> %s (%d)--\n", \
262 (rpc), libcfs_id2str((rpc)->crpc_dest), \
263 cfs_atomic_read(&(rpc)->crpc_refcount)); \
264 LASSERT(cfs_atomic_read(&(rpc)->crpc_refcount) > 0); \
265 if (cfs_atomic_dec_and_test(&(rpc)->crpc_refcount)) \
266 srpc_destroy_client_rpc(rpc); \
269 #define srpc_event_pending(rpc) ((rpc)->crpc_bulkev.ev_fired == 0 || \
270 (rpc)->crpc_reqstev.ev_fired == 0 || \
271 (rpc)->crpc_replyev.ev_fired == 0)
273 /* CPU partition data of srpc service */
274 struct srpc_service_cd {
276 cfs_spinlock_t scd_lock;
277 /** backref to service */
278 struct srpc_service *scd_svc;
281 /** free RPC descriptors */
282 cfs_list_t scd_rpc_free;
283 /** in-flight RPCs */
284 cfs_list_t scd_rpc_active;
285 /** workitem for posting buffer */
286 swi_workitem_t scd_buf_wi;
289 /** error code for scd_buf_wi */
291 /** timestamp for scd_buf_err */
292 unsigned long scd_buf_err_stamp;
293 /** total # request buffers */
295 /** # posted request buffers */
297 /** in progress of buffer posting */
299 /** allocate more buffers if scd_buf_nposted < scd_buf_low */
301 /** increase/decrease some buffers */
303 /** posted message buffers */
304 cfs_list_t scd_buf_posted;
305 /** blocked for RPC descriptor */
306 cfs_list_t scd_buf_blocked;
309 /* number of server workitems (mini-thread) for testing service */
310 #define SFW_TEST_WI_MIN 256
311 #define SFW_TEST_WI_MAX 2048
312 /* extra buffers for tolerating buggy peers, or unbalanced number
313 * of peers between partitions */
314 #define SFW_TEST_WI_EXTRA 64
316 /* number of server workitems (mini-thread) for framework service */
317 #define SFW_FRWK_WI_MIN 16
318 #define SFW_FRWK_WI_MAX 256
320 typedef struct srpc_service {
321 int sv_id; /* service id */
322 const char *sv_name; /* human readable name */
323 int sv_wi_total; /* total server workitems */
326 /* percpt data for srpc_service */
327 struct srpc_service_cd **sv_cpt_data;
328 /* Service callbacks:
329 * - sv_handler: process incoming RPC request
330 * - sv_bulk_ready: notify bulk data
332 int (*sv_handler) (srpc_server_rpc_t *);
333 int (*sv_bulk_ready) (srpc_server_rpc_t *, int);
337 cfs_list_t sn_list; /* chain on fw_zombie_sessions */
338 lst_sid_t sn_id; /* unique identifier */
339 unsigned int sn_timeout; /* # seconds' inactivity to expire */
341 stt_timer_t sn_timer;
342 cfs_list_t sn_batches; /* list of batches */
343 char sn_name[LST_NAME_SIZE];
344 cfs_atomic_t sn_refcount;
345 cfs_atomic_t sn_brw_errors;
346 cfs_atomic_t sn_ping_errors;
347 cfs_time_t sn_started;
350 #define sfw_sid_equal(sid0, sid1) ((sid0).ses_nid == (sid1).ses_nid && \
351 (sid0).ses_stamp == (sid1).ses_stamp)
354 cfs_list_t bat_list; /* chain on sn_batches */
355 lst_bid_t bat_id; /* batch id */
356 int bat_error; /* error code of batch */
357 sfw_session_t *bat_session; /* batch's session */
358 cfs_atomic_t bat_nactive; /* # of active tests */
359 cfs_list_t bat_tests; /* test instances */
363 int (*tso_init)(struct sfw_test_instance *tsi); /* intialize test client */
364 void (*tso_fini)(struct sfw_test_instance *tsi); /* finalize test client */
365 int (*tso_prep_rpc)(struct sfw_test_unit *tsu,
366 lnet_process_id_t dest,
367 srpc_client_rpc_t **rpc); /* prep a tests rpc */
368 void (*tso_done_rpc)(struct sfw_test_unit *tsu,
369 srpc_client_rpc_t *rpc); /* done a test rpc */
370 } sfw_test_client_ops_t;
372 typedef struct sfw_test_instance {
373 cfs_list_t tsi_list; /* chain on batch */
374 int tsi_service; /* test type */
375 sfw_batch_t *tsi_batch; /* batch */
376 sfw_test_client_ops_t *tsi_ops; /* test client operations */
378 /* public parameter for all test units */
379 int tsi_is_client:1; /* is test client */
380 int tsi_stoptsu_onerr:1; /* stop tsu on error */
381 int tsi_concur; /* concurrency */
382 int tsi_loop; /* loop count */
384 /* status of test instance */
385 cfs_spinlock_t tsi_lock; /* serialize */
386 int tsi_stopping:1; /* test is stopping */
387 cfs_atomic_t tsi_nactive; /* # of active test unit */
388 cfs_list_t tsi_units; /* test units */
389 cfs_list_t tsi_free_rpcs; /* free rpcs */
390 cfs_list_t tsi_active_rpcs; /* active rpcs */
393 test_bulk_req_t bulk; /* bulk parameter */
394 test_ping_req_t ping; /* ping parameter */
396 } sfw_test_instance_t;
398 /* XXX: trailing (CFS_PAGE_SIZE % sizeof(lnet_process_id_t)) bytes at
399 * the end of pages are not used */
400 #define SFW_MAX_CONCUR LST_MAX_CONCUR
401 #define SFW_ID_PER_PAGE (CFS_PAGE_SIZE / sizeof(lnet_process_id_packed_t))
402 #define SFW_MAX_NDESTS (LNET_MAX_IOV * SFW_ID_PER_PAGE)
403 #define sfw_id_pages(n) (((n) + SFW_ID_PER_PAGE - 1) / SFW_ID_PER_PAGE)
405 typedef struct sfw_test_unit {
406 cfs_list_t tsu_list; /* chain on lst_test_instance */
407 lnet_process_id_t tsu_dest; /* id of dest node */
408 int tsu_loop; /* loop count of the test */
409 sfw_test_instance_t *tsu_instance; /* pointer to test instance */
410 void *tsu_private; /* private data */
411 swi_workitem_t tsu_worker; /* workitem of the test unit */
414 typedef struct sfw_test_case {
415 cfs_list_t tsc_list; /* chain on fw_tests */
416 srpc_service_t *tsc_srv_service; /* test service */
417 sfw_test_client_ops_t *tsc_cli_ops; /* ops of test client */
421 sfw_create_rpc(lnet_process_id_t peer, int service, int nbulkiov, int bulklen,
422 void (*done) (srpc_client_rpc_t *), void *priv);
423 int sfw_create_test_rpc(sfw_test_unit_t *tsu, lnet_process_id_t peer,
424 int nblk, int blklen, srpc_client_rpc_t **rpc);
425 void sfw_abort_rpc(srpc_client_rpc_t *rpc);
426 void sfw_post_rpc(srpc_client_rpc_t *rpc);
427 void sfw_client_rpc_done(srpc_client_rpc_t *rpc);
428 void sfw_unpack_message(srpc_msg_t *msg);
429 void sfw_free_pages(srpc_server_rpc_t *rpc);
430 void sfw_add_bulk_page(srpc_bulk_t *bk, cfs_page_t *pg, int i);
431 int sfw_alloc_pages(srpc_server_rpc_t *rpc, int cpt, int npages, int sink);
432 int sfw_make_session (srpc_mksn_reqst_t *request, srpc_mksn_reply_t *reply);
435 srpc_create_client_rpc(lnet_process_id_t peer, int service,
436 int nbulkiov, int bulklen,
437 void (*rpc_done)(srpc_client_rpc_t *),
438 void (*rpc_fini)(srpc_client_rpc_t *), void *priv);
439 void srpc_post_rpc(srpc_client_rpc_t *rpc);
440 void srpc_abort_rpc(srpc_client_rpc_t *rpc, int why);
441 void srpc_free_bulk(srpc_bulk_t *bk);
442 srpc_bulk_t *srpc_alloc_bulk(int cpt, int npages, int sink);
443 int srpc_send_rpc(swi_workitem_t *wi);
444 int srpc_send_reply(srpc_server_rpc_t *rpc);
445 int srpc_add_service(srpc_service_t *sv);
446 int srpc_remove_service(srpc_service_t *sv);
447 void srpc_shutdown_service(srpc_service_t *sv);
448 void srpc_abort_service(srpc_service_t *sv);
449 int srpc_finish_service(srpc_service_t *sv);
450 int srpc_service_add_buffers(srpc_service_t *sv, int nbuffer);
451 void srpc_service_remove_buffers(srpc_service_t *sv, int nbuffer);
452 void srpc_get_counters(srpc_counters_t *cnt);
453 void srpc_set_counters(const srpc_counters_t *cnt);
455 extern struct cfs_wi_sched *lst_sched_serial;
456 extern struct cfs_wi_sched **lst_sched_test;
459 srpc_serv_is_framework(struct srpc_service *svc)
461 return svc->sv_id < SRPC_FRAMEWORK_SERVICE_MAX_ID;
465 swi_wi_action(cfs_workitem_t *wi)
467 swi_workitem_t *swi = container_of(wi, swi_workitem_t, swi_workitem);
469 return swi->swi_action(swi);
473 swi_init_workitem(swi_workitem_t *swi, void *data,
474 swi_action_t action, struct cfs_wi_sched *sched)
476 swi->swi_sched = sched;
477 swi->swi_action = action;
478 swi->swi_state = SWI_STATE_NEWBORN;
479 cfs_wi_init(&swi->swi_workitem, data, swi_wi_action);
483 swi_schedule_workitem(swi_workitem_t *wi)
485 cfs_wi_schedule(wi->swi_sched, &wi->swi_workitem);
489 swi_exit_workitem(swi_workitem_t *swi)
491 cfs_wi_exit(swi->swi_sched, &swi->swi_workitem);
495 swi_deschedule_workitem(swi_workitem_t *swi)
497 return cfs_wi_deschedule(swi->swi_sched, &swi->swi_workitem);
502 swi_check_events(void)
504 return cfs_wi_check_events();
508 int sfw_startup(void);
509 int srpc_startup(void);
510 void sfw_shutdown(void);
511 void srpc_shutdown(void);
514 srpc_destroy_client_rpc (srpc_client_rpc_t *rpc)
516 LASSERT (rpc != NULL);
517 LASSERT (!srpc_event_pending(rpc));
518 LASSERT (cfs_atomic_read(&rpc->crpc_refcount) == 0);
520 LASSERT (rpc->crpc_bulk.bk_pages == NULL);
523 if (rpc->crpc_fini == NULL) {
524 LIBCFS_FREE(rpc, srpc_client_rpc_size(rpc));
526 (*rpc->crpc_fini) (rpc);
533 srpc_init_client_rpc (srpc_client_rpc_t *rpc, lnet_process_id_t peer,
534 int service, int nbulkiov, int bulklen,
535 void (*rpc_done)(srpc_client_rpc_t *),
536 void (*rpc_fini)(srpc_client_rpc_t *), void *priv)
538 LASSERT (nbulkiov <= LNET_MAX_IOV);
540 memset(rpc, 0, offsetof(srpc_client_rpc_t,
541 crpc_bulk.bk_iovs[nbulkiov]));
543 CFS_INIT_LIST_HEAD(&rpc->crpc_list);
544 swi_init_workitem(&rpc->crpc_wi, rpc, srpc_send_rpc,
545 lst_sched_test[lnet_cpt_of_nid(peer.nid)]);
546 cfs_spin_lock_init(&rpc->crpc_lock);
547 cfs_atomic_set(&rpc->crpc_refcount, 1); /* 1 ref for caller */
549 rpc->crpc_dest = peer;
550 rpc->crpc_priv = priv;
551 rpc->crpc_service = service;
552 rpc->crpc_bulk.bk_len = bulklen;
553 rpc->crpc_bulk.bk_niov = nbulkiov;
554 rpc->crpc_done = rpc_done;
555 rpc->crpc_fini = rpc_fini;
556 LNetInvalidateHandle(&rpc->crpc_reqstmdh);
557 LNetInvalidateHandle(&rpc->crpc_replymdh);
558 LNetInvalidateHandle(&rpc->crpc_bulk.bk_mdh);
560 /* no event is expected at this point */
561 rpc->crpc_bulkev.ev_fired =
562 rpc->crpc_reqstev.ev_fired =
563 rpc->crpc_replyev.ev_fired = 1;
565 rpc->crpc_reqstmsg.msg_magic = SRPC_MSG_MAGIC;
566 rpc->crpc_reqstmsg.msg_version = SRPC_MSG_VERSION;
567 rpc->crpc_reqstmsg.msg_type = srpc_service2request(service);
571 static inline const char *
572 swi_state2str (int state)
574 #define STATE2STR(x) case x: return #x
578 STATE2STR(SWI_STATE_NEWBORN);
579 STATE2STR(SWI_STATE_REPLY_SUBMITTED);
580 STATE2STR(SWI_STATE_REPLY_SENT);
581 STATE2STR(SWI_STATE_REQUEST_SUBMITTED);
582 STATE2STR(SWI_STATE_REQUEST_SENT);
583 STATE2STR(SWI_STATE_REPLY_RECEIVED);
584 STATE2STR(SWI_STATE_BULK_STARTED);
585 STATE2STR(SWI_STATE_DONE);
590 #define UNUSED(x) ( (void)(x) )
594 int stt_poll_interval(void);
595 int sfw_session_removed(void);
597 int stt_check_events(void);
598 int srpc_check_event(int timeout);
600 int lnet_selftest_init(void);
601 void lnet_selftest_fini(void);
602 int selftest_wait_events(void);
606 #define selftest_wait_events() cfs_pause(cfs_time_seconds(1) / 10)
610 #define lst_wait_until(cond, lock, fmt, ...) \
614 CDEBUG(IS_PO2(++__I) ? D_WARNING : D_NET, \
615 fmt, ## __VA_ARGS__); \
616 cfs_spin_unlock(&(lock)); \
618 selftest_wait_events(); \
620 cfs_spin_lock(&(lock)); \
625 srpc_wait_service_shutdown(srpc_service_t *sv)
629 LASSERT(sv->sv_shuttingdown);
631 while (srpc_finish_service(sv) == 0) {
633 CDEBUG (((i & -i) == i) ? D_WARNING : D_NET,
634 "Waiting for %s service to shutdown...\n",
636 selftest_wait_events();
640 #endif /* __SELFTEST_SELFTEST_H__ */