Whamcloud - gitweb
27ac86b512173f63690448aadb2498512048c102
[fs/lustre-release.git] / lnet / selftest / conrpc.h
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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * /lnet/selftest/conrpc.h
37  *
38  * Console rpc
39  *
40  * Author: Liang Zhen <liang@whamcloud.com>
41  */
42
43 #ifndef __LST_CONRPC_H__
44 #define __LST_CONRPC_H__
45
46 #ifdef __KERNEL__
47 #include <libcfs/libcfs.h>
48 #include <lnet/lnet.h>
49 #include <lnet/lib-types.h>
50 #include <lnet/lnetst.h>
51 #include "rpc.h"
52 #include "selftest.h"
53
54 /* Console rpc and rpc transaction */
55 #define LST_TRANS_TIMEOUT       30
56 #define LST_TRANS_MIN_TIMEOUT   3
57
58 #define LST_VALIDATE_TIMEOUT(t) MIN(MAX(t, LST_TRANS_MIN_TIMEOUT), LST_TRANS_TIMEOUT)
59
60 #define LST_PING_INTERVAL       8
61
62 struct lstcon_rpc_trans;
63 struct lstcon_tsb_hdr;
64 struct lstcon_test;
65 struct lstcon_node;
66
67 typedef struct lstcon_rpc {
68         cfs_list_t               crp_link;       /* chain on rpc transaction */
69         srpc_client_rpc_t       *crp_rpc;        /* client rpc */
70         struct lstcon_node      *crp_node;       /* destination node */
71         struct lstcon_rpc_trans *crp_trans;     /* conrpc transaction */
72
73         int                      crp_posted:1;   /* rpc is posted */
74         int                      crp_finished:1; /* rpc is finished */
75         int                      crp_unpacked:1; /* reply is unpacked */
76         /** RPC is embedded in other structure and can't free it */
77         int                      crp_embedded:1;
78         int                      crp_status;     /* console rpc errors */
79         cfs_time_t               crp_stamp;      /* replied time stamp */
80 } lstcon_rpc_t;
81
82 typedef struct lstcon_rpc_trans {
83         cfs_list_t            tas_olink;     /* link chain on owner list */
84         cfs_list_t            tas_link;      /* link chain on global list */
85         int                   tas_opc;       /* operation code of transaction */
86         /* features mask is uptodate */
87         unsigned              tas_feats_updated;
88         /* test features mask */
89         unsigned              tas_features;
90         cfs_waitq_t           tas_waitq;     /* wait queue head */
91         cfs_atomic_t          tas_remaining; /* # of un-scheduled rpcs */
92         cfs_list_t            tas_rpcs_list; /* queued requests */
93 } lstcon_rpc_trans_t;
94
95 #define LST_TRANS_PRIVATE       0x1000
96
97 #define LST_TRANS_SESNEW        (LST_TRANS_PRIVATE | 0x01)
98 #define LST_TRANS_SESEND        (LST_TRANS_PRIVATE | 0x02)
99 #define LST_TRANS_SESQRY        0x03
100 #define LST_TRANS_SESPING       0x04
101
102 #define LST_TRANS_TSBCLIADD     (LST_TRANS_PRIVATE | 0x11)
103 #define LST_TRANS_TSBSRVADD     (LST_TRANS_PRIVATE | 0x12)
104 #define LST_TRANS_TSBRUN        (LST_TRANS_PRIVATE | 0x13)
105 #define LST_TRANS_TSBSTOP       (LST_TRANS_PRIVATE | 0x14)
106 #define LST_TRANS_TSBCLIQRY     0x15
107 #define LST_TRANS_TSBSRVQRY     0x16
108
109 #define LST_TRANS_STATQRY       0x21
110
111 typedef int (* lstcon_rpc_cond_func_t)(int, struct lstcon_node *, void *);
112 typedef int (* lstcon_rpc_readent_func_t)(int, srpc_msg_t *, lstcon_rpc_ent_t *);
113
114 int  lstcon_sesrpc_prep(struct lstcon_node *nd, int transop,
115                         unsigned version, lstcon_rpc_t **crpc);
116 int  lstcon_dbgrpc_prep(struct lstcon_node *nd,
117                         unsigned version, lstcon_rpc_t **crpc);
118 int  lstcon_batrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
119                         struct lstcon_tsb_hdr *tsb, lstcon_rpc_t **crpc);
120 int  lstcon_testrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
121                          struct lstcon_test *test, lstcon_rpc_t **crpc);
122 int  lstcon_statrpc_prep(struct lstcon_node *nd, unsigned version,
123                          lstcon_rpc_t **crpc);
124 void lstcon_rpc_put(lstcon_rpc_t *crpc);
125 int  lstcon_rpc_trans_prep(cfs_list_t *translist,
126                            int transop, lstcon_rpc_trans_t **transpp);
127 int  lstcon_rpc_trans_ndlist(cfs_list_t *ndlist,
128                              cfs_list_t *translist, int transop,
129                              void *arg, lstcon_rpc_cond_func_t condition,
130                              lstcon_rpc_trans_t **transpp);
131 void lstcon_rpc_trans_stat(lstcon_rpc_trans_t *trans,
132                            lstcon_trans_stat_t *stat);
133 int  lstcon_rpc_trans_interpreter(lstcon_rpc_trans_t *trans,
134                                   cfs_list_t *head_up,
135                                   lstcon_rpc_readent_func_t readent);
136 void lstcon_rpc_trans_abort(lstcon_rpc_trans_t *trans, int error);
137 void lstcon_rpc_trans_destroy(lstcon_rpc_trans_t *trans);
138 void lstcon_rpc_trans_addreq(lstcon_rpc_trans_t *trans, lstcon_rpc_t *req);
139 int  lstcon_rpc_trans_postwait(lstcon_rpc_trans_t *trans, int timeout);
140 int  lstcon_rpc_pinger_start(void);
141 void lstcon_rpc_pinger_stop(void);
142 void lstcon_rpc_cleanup_wait(void);
143 int  lstcon_rpc_module_init(void);
144 void lstcon_rpc_module_fini(void);
145
146 #endif
147
148 #endif