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
78 struct sfw_test_instance;
80 /* services below SRPC_FRAMEWORK_SERVICE_MAX_ID are framework
81 * services, e.g. create/modify session.
83 #define SRPC_SERVICE_DEBUG 0
84 #define SRPC_SERVICE_MAKE_SESSION 1
85 #define SRPC_SERVICE_REMOVE_SESSION 2
86 #define SRPC_SERVICE_BATCH 3
87 #define SRPC_SERVICE_TEST 4
88 #define SRPC_SERVICE_QUERY_STAT 5
89 #define SRPC_SERVICE_JOIN 6
90 #define SRPC_FRAMEWORK_SERVICE_MAX_ID 10
91 /* other services start from SRPC_FRAMEWORK_SERVICE_MAX_ID+1 */
92 #define SRPC_SERVICE_BRW 11
93 #define SRPC_SERVICE_PING 12
94 #define SRPC_SERVICE_MAX_ID 12
96 #define SRPC_REQUEST_PORTAL 50
97 /* a lazy portal for framework RPC requests */
98 #define SRPC_FRAMEWORK_REQUEST_PORTAL 51
99 /* all reply/bulk RDMAs go to this portal */
100 #define SRPC_RDMA_PORTAL 52
102 static inline srpc_msg_type_t
103 srpc_service2request (int service)
108 case SRPC_SERVICE_DEBUG:
109 return SRPC_MSG_DEBUG_REQST;
111 case SRPC_SERVICE_MAKE_SESSION:
112 return SRPC_MSG_MKSN_REQST;
114 case SRPC_SERVICE_REMOVE_SESSION:
115 return SRPC_MSG_RMSN_REQST;
117 case SRPC_SERVICE_BATCH:
118 return SRPC_MSG_BATCH_REQST;
120 case SRPC_SERVICE_TEST:
121 return SRPC_MSG_TEST_REQST;
123 case SRPC_SERVICE_QUERY_STAT:
124 return SRPC_MSG_STAT_REQST;
126 case SRPC_SERVICE_BRW:
127 return SRPC_MSG_BRW_REQST;
129 case SRPC_SERVICE_PING:
130 return SRPC_MSG_PING_REQST;
132 case SRPC_SERVICE_JOIN:
133 return SRPC_MSG_JOIN_REQST;
137 static inline srpc_msg_type_t
138 srpc_service2reply (int service)
140 return srpc_service2request(service) + 1;
144 SRPC_BULK_REQ_RCVD = 1, /* passive bulk request(PUT sink/GET source) received */
145 SRPC_BULK_PUT_SENT = 2, /* active bulk PUT sent (source) */
146 SRPC_BULK_GET_RPLD = 3, /* active bulk GET replied (sink) */
147 SRPC_REPLY_RCVD = 4, /* incoming reply received */
148 SRPC_REPLY_SENT = 5, /* outgoing reply sent */
149 SRPC_REQUEST_RCVD = 6, /* incoming request received */
150 SRPC_REQUEST_SENT = 7, /* outgoing request sent */
155 srpc_event_type_t ev_type; /* what's up */
156 lnet_event_kind_t ev_lnet; /* LNet event type */
157 int ev_fired; /* LNet event fired? */
158 int ev_status; /* LNet event status */
159 void *ev_data; /* owning server/client RPC */
163 int bk_len; /* len of bulk data */
164 lnet_handle_md_t bk_mdh;
165 int bk_sink; /* sink/source */
166 int bk_niov; /* # iov in bk_iovs */
168 lnet_kiov_t bk_iovs[0];
170 cfs_page_t **bk_pages;
171 lnet_md_iovec_t bk_iovs[0];
173 } srpc_bulk_t; /* bulk descriptor */
175 /* message buffer descriptor */
177 cfs_list_t buf_list; /* chain on srpc_service::*_msgq */
179 lnet_handle_md_t buf_mdh;
181 lnet_process_id_t buf_peer;
185 typedef int (*swi_action_t) (struct swi_workitem *);
187 typedef struct swi_workitem {
188 struct cfs_wi_sched *swi_sched;
189 cfs_workitem_t swi_workitem;
190 swi_action_t swi_action;
194 /* server-side state of a RPC */
195 typedef struct srpc_server_rpc {
196 cfs_list_t srpc_list; /* chain on srpc_service::*_rpcq */
197 struct srpc_service *srpc_service;
198 swi_workitem_t srpc_wi;
199 srpc_event_t srpc_ev; /* bulk/reply event */
200 lnet_nid_t srpc_self;
201 lnet_process_id_t srpc_peer;
202 srpc_msg_t srpc_replymsg;
203 lnet_handle_md_t srpc_replymdh;
204 srpc_buffer_t *srpc_reqstbuf;
205 srpc_bulk_t *srpc_bulk;
207 unsigned int srpc_aborted; /* being given up */
209 void (*srpc_done)(struct srpc_server_rpc *);
212 /* client-side state of a RPC */
213 typedef struct srpc_client_rpc {
214 cfs_list_t crpc_list; /* chain on user's lists */
215 cfs_spinlock_t crpc_lock; /* serialize */
217 cfs_atomic_t crpc_refcount;
218 int crpc_timeout; /* # seconds to wait for reply */
219 stt_timer_t crpc_timer;
220 swi_workitem_t crpc_wi;
221 lnet_process_id_t crpc_dest;
223 void (*crpc_done)(struct srpc_client_rpc *);
224 void (*crpc_fini)(struct srpc_client_rpc *);
225 int crpc_status; /* completion status */
226 void *crpc_priv; /* caller data */
229 unsigned int crpc_aborted:1; /* being given up */
230 unsigned int crpc_closed:1; /* completed */
233 srpc_event_t crpc_bulkev; /* bulk event */
234 srpc_event_t crpc_reqstev; /* request event */
235 srpc_event_t crpc_replyev; /* reply event */
237 /* bulk, request(reqst), and reply exchanged on wire */
238 srpc_msg_t crpc_reqstmsg;
239 srpc_msg_t crpc_replymsg;
240 lnet_handle_md_t crpc_reqstmdh;
241 lnet_handle_md_t crpc_replymdh;
242 srpc_bulk_t crpc_bulk;
245 #define srpc_client_rpc_size(rpc) \
246 offsetof(srpc_client_rpc_t, crpc_bulk.bk_iovs[(rpc)->crpc_bulk.bk_niov])
248 #define srpc_client_rpc_addref(rpc) \
250 CDEBUG(D_NET, "RPC[%p] -> %s (%d)++\n", \
251 (rpc), libcfs_id2str((rpc)->crpc_dest), \
252 cfs_atomic_read(&(rpc)->crpc_refcount)); \
253 LASSERT(cfs_atomic_read(&(rpc)->crpc_refcount) > 0); \
254 cfs_atomic_inc(&(rpc)->crpc_refcount); \
257 #define srpc_client_rpc_decref(rpc) \
259 CDEBUG(D_NET, "RPC[%p] -> %s (%d)--\n", \
260 (rpc), libcfs_id2str((rpc)->crpc_dest), \
261 cfs_atomic_read(&(rpc)->crpc_refcount)); \
262 LASSERT(cfs_atomic_read(&(rpc)->crpc_refcount) > 0); \
263 if (cfs_atomic_dec_and_test(&(rpc)->crpc_refcount)) \
264 srpc_destroy_client_rpc(rpc); \
267 #define srpc_event_pending(rpc) ((rpc)->crpc_bulkev.ev_fired == 0 || \
268 (rpc)->crpc_reqstev.ev_fired == 0 || \
269 (rpc)->crpc_replyev.ev_fired == 0)
271 typedef struct srpc_service {
272 int sv_id; /* service id */
273 const char *sv_name; /* human readable name */
274 int sv_nprune; /* # posted RPC to be pruned */
275 int sv_concur; /* max # concurrent RPCs */
277 cfs_spinlock_t sv_lock;
279 srpc_event_t sv_ev; /* LNet event */
280 int sv_nposted_msg; /* # posted message buffers */
281 cfs_list_t sv_free_rpcq; /* free RPC descriptors */
282 cfs_list_t sv_active_rpcq; /* in-flight RPCs */
283 cfs_list_t sv_posted_msgq; /* posted message buffers */
284 cfs_list_t sv_blocked_msgq; /* blocked for RPC descriptor */
286 /* Service callbacks:
287 * - sv_handler: process incoming RPC request
288 * - sv_bulk_ready: notify bulk data
290 int (*sv_handler) (srpc_server_rpc_t *);
291 int (*sv_bulk_ready) (srpc_server_rpc_t *, int);
294 #define SFW_POST_BUFFERS 256
295 #define SFW_SERVICE_CONCURRENCY (SFW_POST_BUFFERS/2)
298 cfs_list_t sn_list; /* chain on fw_zombie_sessions */
299 lst_sid_t sn_id; /* unique identifier */
300 unsigned int sn_timeout; /* # seconds' inactivity to expire */
302 stt_timer_t sn_timer;
303 cfs_list_t sn_batches; /* list of batches */
304 char sn_name[LST_NAME_SIZE];
305 cfs_atomic_t sn_refcount;
306 cfs_atomic_t sn_brw_errors;
307 cfs_atomic_t sn_ping_errors;
308 cfs_time_t sn_started;
311 #define sfw_sid_equal(sid0, sid1) ((sid0).ses_nid == (sid1).ses_nid && \
312 (sid0).ses_stamp == (sid1).ses_stamp)
315 cfs_list_t bat_list; /* chain on sn_batches */
316 lst_bid_t bat_id; /* batch id */
317 int bat_error; /* error code of batch */
318 sfw_session_t *bat_session; /* batch's session */
319 cfs_atomic_t bat_nactive; /* # of active tests */
320 cfs_list_t bat_tests; /* test instances */
324 int (*tso_init)(struct sfw_test_instance *tsi); /* intialize test client */
325 void (*tso_fini)(struct sfw_test_instance *tsi); /* finalize test client */
326 int (*tso_prep_rpc)(struct sfw_test_unit *tsu,
327 lnet_process_id_t dest,
328 srpc_client_rpc_t **rpc); /* prep a tests rpc */
329 void (*tso_done_rpc)(struct sfw_test_unit *tsu,
330 srpc_client_rpc_t *rpc); /* done a test rpc */
331 } sfw_test_client_ops_t;
333 typedef struct sfw_test_instance {
334 cfs_list_t tsi_list; /* chain on batch */
335 int tsi_service; /* test type */
336 sfw_batch_t *tsi_batch; /* batch */
337 sfw_test_client_ops_t *tsi_ops; /* test client operations */
339 /* public parameter for all test units */
340 int tsi_is_client:1; /* is test client */
341 int tsi_stoptsu_onerr:1; /* stop tsu on error */
342 int tsi_concur; /* concurrency */
343 int tsi_loop; /* loop count */
345 /* status of test instance */
346 cfs_spinlock_t tsi_lock; /* serialize */
347 int tsi_stopping:1; /* test is stopping */
348 cfs_atomic_t tsi_nactive; /* # of active test unit */
349 cfs_list_t tsi_units; /* test units */
350 cfs_list_t tsi_free_rpcs; /* free rpcs */
351 cfs_list_t tsi_active_rpcs; /* active rpcs */
354 test_bulk_req_t bulk; /* bulk parameter */
355 test_ping_req_t ping; /* ping parameter */
357 } sfw_test_instance_t;
359 /* XXX: trailing (CFS_PAGE_SIZE % sizeof(lnet_process_id_t)) bytes at
360 * the end of pages are not used */
361 #define SFW_MAX_CONCUR LST_MAX_CONCUR
362 #define SFW_ID_PER_PAGE (CFS_PAGE_SIZE / sizeof(lnet_process_id_packed_t))
363 #define SFW_MAX_NDESTS (LNET_MAX_IOV * SFW_ID_PER_PAGE)
364 #define sfw_id_pages(n) (((n) + SFW_ID_PER_PAGE - 1) / SFW_ID_PER_PAGE)
366 typedef struct sfw_test_unit {
367 cfs_list_t tsu_list; /* chain on lst_test_instance */
368 lnet_process_id_t tsu_dest; /* id of dest node */
369 int tsu_loop; /* loop count of the test */
370 sfw_test_instance_t *tsu_instance; /* pointer to test instance */
371 void *tsu_private; /* private data */
372 swi_workitem_t tsu_worker; /* workitem of the test unit */
376 cfs_list_t tsc_list; /* chain on fw_tests */
377 srpc_service_t *tsc_srv_service; /* test service */
378 sfw_test_client_ops_t *tsc_cli_ops; /* ops of test client */
382 sfw_create_rpc(lnet_process_id_t peer, int service, int nbulkiov, int bulklen,
383 void (*done) (srpc_client_rpc_t *), void *priv);
384 int sfw_create_test_rpc(sfw_test_unit_t *tsu, lnet_process_id_t peer,
385 int nblk, int blklen, srpc_client_rpc_t **rpc);
386 void sfw_abort_rpc(srpc_client_rpc_t *rpc);
387 void sfw_post_rpc(srpc_client_rpc_t *rpc);
388 void sfw_client_rpc_done(srpc_client_rpc_t *rpc);
389 void sfw_unpack_message(srpc_msg_t *msg);
390 void sfw_free_pages(srpc_server_rpc_t *rpc);
391 void sfw_add_bulk_page(srpc_bulk_t *bk, cfs_page_t *pg, int i);
392 int sfw_alloc_pages(srpc_server_rpc_t *rpc, int npages, int sink);
393 int sfw_make_session (srpc_mksn_reqst_t *request, srpc_mksn_reply_t *reply);
396 srpc_create_client_rpc(lnet_process_id_t peer, int service,
397 int nbulkiov, int bulklen,
398 void (*rpc_done)(srpc_client_rpc_t *),
399 void (*rpc_fini)(srpc_client_rpc_t *), void *priv);
400 void srpc_post_rpc(srpc_client_rpc_t *rpc);
401 void srpc_abort_rpc(srpc_client_rpc_t *rpc, int why);
402 void srpc_free_bulk(srpc_bulk_t *bk);
403 srpc_bulk_t *srpc_alloc_bulk(int npages, int sink);
404 int srpc_send_rpc(swi_workitem_t *wi);
405 int srpc_send_reply(srpc_server_rpc_t *rpc);
406 int srpc_add_service(srpc_service_t *sv);
407 int srpc_remove_service(srpc_service_t *sv);
408 void srpc_shutdown_service(srpc_service_t *sv);
409 void srpc_abort_service(srpc_service_t *sv);
410 int srpc_finish_service(srpc_service_t *sv);
411 int srpc_service_add_buffers(srpc_service_t *sv, int nbuffer);
412 void srpc_service_remove_buffers(srpc_service_t *sv, int nbuffer);
413 void srpc_get_counters(srpc_counters_t *cnt);
414 void srpc_set_counters(const srpc_counters_t *cnt);
416 extern struct cfs_wi_sched *lst_sched_serial;
417 extern struct cfs_wi_sched *lst_sched_test;
420 swi_wi_action(cfs_workitem_t *wi)
422 swi_workitem_t *swi = container_of(wi, swi_workitem_t, swi_workitem);
424 return swi->swi_action(swi);
428 swi_init_workitem(swi_workitem_t *swi, void *data,
429 swi_action_t action, struct cfs_wi_sched *sched)
431 swi->swi_sched = sched;
432 swi->swi_action = action;
433 swi->swi_state = SWI_STATE_NEWBORN;
434 cfs_wi_init(&swi->swi_workitem, data, swi_wi_action);
438 swi_schedule_workitem(swi_workitem_t *wi)
440 cfs_wi_schedule(wi->swi_sched, &wi->swi_workitem);
444 swi_kill_workitem(swi_workitem_t *swi)
446 cfs_wi_exit(swi->swi_sched, &swi->swi_workitem);
451 swi_check_events(void)
453 return cfs_wi_check_events();
457 int sfw_startup(void);
458 int srpc_startup(void);
459 void sfw_shutdown(void);
460 void srpc_shutdown(void);
463 srpc_destroy_client_rpc (srpc_client_rpc_t *rpc)
465 LASSERT (rpc != NULL);
466 LASSERT (!srpc_event_pending(rpc));
467 LASSERT (cfs_atomic_read(&rpc->crpc_refcount) == 0);
469 LASSERT (rpc->crpc_bulk.bk_pages == NULL);
472 if (rpc->crpc_fini == NULL) {
473 LIBCFS_FREE(rpc, srpc_client_rpc_size(rpc));
475 (*rpc->crpc_fini) (rpc);
482 srpc_init_client_rpc (srpc_client_rpc_t *rpc, lnet_process_id_t peer,
483 int service, int nbulkiov, int bulklen,
484 void (*rpc_done)(srpc_client_rpc_t *),
485 void (*rpc_fini)(srpc_client_rpc_t *), void *priv)
487 LASSERT (nbulkiov <= LNET_MAX_IOV);
489 memset(rpc, 0, offsetof(srpc_client_rpc_t,
490 crpc_bulk.bk_iovs[nbulkiov]));
492 CFS_INIT_LIST_HEAD(&rpc->crpc_list);
493 swi_init_workitem(&rpc->crpc_wi, rpc, srpc_send_rpc, lst_sched_test);
494 cfs_spin_lock_init(&rpc->crpc_lock);
495 cfs_atomic_set(&rpc->crpc_refcount, 1); /* 1 ref for caller */
497 rpc->crpc_dest = peer;
498 rpc->crpc_priv = priv;
499 rpc->crpc_service = service;
500 rpc->crpc_bulk.bk_len = bulklen;
501 rpc->crpc_bulk.bk_niov = nbulkiov;
502 rpc->crpc_done = rpc_done;
503 rpc->crpc_fini = rpc_fini;
504 LNetInvalidateHandle(&rpc->crpc_reqstmdh);
505 LNetInvalidateHandle(&rpc->crpc_replymdh);
506 LNetInvalidateHandle(&rpc->crpc_bulk.bk_mdh);
508 /* no event is expected at this point */
509 rpc->crpc_bulkev.ev_fired =
510 rpc->crpc_reqstev.ev_fired =
511 rpc->crpc_replyev.ev_fired = 1;
513 rpc->crpc_reqstmsg.msg_magic = SRPC_MSG_MAGIC;
514 rpc->crpc_reqstmsg.msg_version = SRPC_MSG_VERSION;
515 rpc->crpc_reqstmsg.msg_type = srpc_service2request(service);
519 static inline const char *
520 swi_state2str (int state)
522 #define STATE2STR(x) case x: return #x
526 STATE2STR(SWI_STATE_NEWBORN);
527 STATE2STR(SWI_STATE_REPLY_SUBMITTED);
528 STATE2STR(SWI_STATE_REPLY_SENT);
529 STATE2STR(SWI_STATE_REQUEST_SUBMITTED);
530 STATE2STR(SWI_STATE_REQUEST_SENT);
531 STATE2STR(SWI_STATE_REPLY_RECEIVED);
532 STATE2STR(SWI_STATE_BULK_STARTED);
533 STATE2STR(SWI_STATE_DONE);
538 #define UNUSED(x) ( (void)(x) )
542 int stt_poll_interval(void);
543 int sfw_session_removed(void);
545 int stt_check_events(void);
546 int srpc_check_event(int timeout);
548 int lnet_selftest_init(void);
549 void lnet_selftest_fini(void);
550 int selftest_wait_events(void);
554 #define selftest_wait_events() cfs_pause(cfs_time_seconds(1))
558 #define lst_wait_until(cond, lock, fmt, ...) \
562 CDEBUG(IS_PO2(++__I) ? D_WARNING : D_NET, \
563 fmt, ## __VA_ARGS__); \
564 cfs_spin_unlock(&(lock)); \
566 selftest_wait_events(); \
568 cfs_spin_lock(&(lock)); \
573 srpc_wait_service_shutdown (srpc_service_t *sv)
577 cfs_spin_lock(&sv->sv_lock);
578 LASSERT (sv->sv_shuttingdown);
579 cfs_spin_unlock(&sv->sv_lock);
581 while (srpc_finish_service(sv) == 0) {
583 CDEBUG (((i & -i) == i) ? D_WARNING : D_NET,
584 "Waiting for %s service to shutdown...\n",
586 selftest_wait_events();
590 #endif /* __SELFTEST_SELFTEST_H__ */