Whamcloud - gitweb
62f7208d49d7aabe21856d39fa0e52dd8a7d52d3
[fs/lustre-release.git] / lnet / selftest / console.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) 2012, 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/console.h
37  *
38  * kernel structure for LST console
39  *
40  * Author: Liang Zhen <liangzhen@clusterfs.com>
41  */
42
43 #ifndef __LST_CONSOLE_H__
44 #define __LST_CONSOLE_H__
45
46 #ifdef __KERNEL__
47
48 #include <libcfs/libcfs.h>
49 #include <lnet/lnet.h>
50 #include <lnet/lib-types.h>
51 #include <lnet/lnetst.h>
52 #include "selftest.h"
53 #include "conrpc.h"
54
55 typedef struct lstcon_node {
56         lnet_process_id_t    nd_id;          /* id of the node */
57         int                  nd_ref;         /* reference count */
58         int                  nd_state;       /* state of the node */
59         int                  nd_timeout;     /* session timeout */
60         cfs_time_t           nd_stamp;       /* timestamp of last replied RPC */
61         struct lstcon_rpc    nd_ping;        /* ping rpc */
62 } lstcon_node_t;                                /*** node descriptor */
63
64 typedef struct {
65         cfs_list_t           ndl_link;       /* chain on list */
66         cfs_list_t           ndl_hlink;      /* chain on hash */
67         lstcon_node_t       *ndl_node;       /* pointer to node */
68 } lstcon_ndlink_t;                              /*** node link descriptor */
69
70 typedef struct {
71         cfs_list_t           grp_link;       /* chain on global group list */
72         int                  grp_ref;        /* reference count */
73         int                  grp_userland;   /* has userland nodes */
74         int                  grp_nnode;      /* # of nodes */
75         char                 grp_name[LST_NAME_SIZE]; /* group name */
76
77         cfs_list_t           grp_trans_list; /* transaction list */
78         cfs_list_t           grp_ndl_list;   /* nodes list */
79         cfs_list_t           grp_ndl_hash[0];/* hash table for nodes */
80 } lstcon_group_t;                    /*** (alias of nodes) group descriptor */
81
82 #define LST_BATCH_IDLE          0xB0            /* idle batch */
83 #define LST_BATCH_RUNNING       0xB1            /* running batch */
84
85 typedef struct lstcon_tsb_hdr {
86         lst_bid_t               tsb_id;         /* batch ID */
87         int                     tsb_index;      /* test index */
88 } lstcon_tsb_hdr_t;
89
90 typedef struct {
91         lstcon_tsb_hdr_t        bat_hdr;        /* test_batch header */
92         cfs_list_t              bat_link;       /* chain on session's batches list */
93         int                     bat_ntest;      /* # of test */
94         int                     bat_state;      /* state of the batch */
95         int                     bat_arg;        /* parameter for run|stop, timeout for run, force for stop */
96         char                    bat_name[LST_NAME_SIZE]; /* name of batch */
97
98         cfs_list_t              bat_test_list;  /* list head of tests (lstcon_test_t) */
99         cfs_list_t              bat_trans_list; /* list head of transaction */
100         cfs_list_t              bat_cli_list;   /* list head of client nodes (lstcon_node_t) */
101         cfs_list_t             *bat_cli_hash;   /* hash table of client nodes */ 
102         cfs_list_t              bat_srv_list;   /* list head of server nodes */
103         cfs_list_t             *bat_srv_hash;   /* hash table of server nodes */
104 } lstcon_batch_t;                             /*** (tests ) batch descritptor */
105
106 typedef struct lstcon_test {
107         lstcon_tsb_hdr_t      tes_hdr;        /* test batch header */
108         cfs_list_t            tes_link;       /* chain on batch's tests list */
109         lstcon_batch_t       *tes_batch;      /* pointer to batch */
110
111         int                   tes_type;       /* type of the test, i.e: bulk, ping */
112         int                   tes_stop_onerr; /* stop on error */
113         int                   tes_oneside;    /* one-sided test */
114         int                   tes_concur;     /* concurrency */
115         int                   tes_loop;       /* loop count */
116         int                   tes_dist;       /* nodes distribution of target group */
117         int                   tes_span;       /* nodes span of target group */
118         int                   tes_cliidx;     /* client index, used for RPC creating */
119
120         cfs_list_t  tes_trans_list; /* transaction list */
121         lstcon_group_t       *tes_src_grp;    /* group run the test */
122         lstcon_group_t       *tes_dst_grp;    /* target group */
123
124         int                   tes_paramlen;   /* test parameter length */
125         char                  tes_param[0];   /* test parameter */
126 } lstcon_test_t;                                /*** a single test descriptor */
127
128 #define LST_GLOBAL_HASHSIZE     503             /* global nodes hash table size */
129 #define LST_NODE_HASHSIZE       239             /* node hash table (for batch or group) */
130
131 #define LST_SESSION_NONE        0x0             /* no session */
132 #define LST_SESSION_ACTIVE      0x1             /* working session */
133
134 #define LST_CONSOLE_TIMEOUT     300             /* default console timeout */
135
136 typedef struct {
137         struct mutex            ses_mutex;      /* only 1 thread in session */
138         lst_sid_t               ses_id;         /* global session id */
139         int                     ses_key;        /* local session key */
140         int                     ses_state;      /* state of session */
141         int                     ses_timeout;    /* timeout in seconds */
142         time_t                  ses_laststamp;  /* last operation stamp (seconds) */
143         /** tests features of the session */
144         unsigned                ses_features;
145         /** features are synced with remote test nodes */
146         unsigned                ses_feats_updated:1;
147         /** force creating */
148         unsigned                ses_force:1;
149         /** session is shutting down */
150         unsigned                ses_shutdown:1;
151         /** console is timedout */
152         unsigned                ses_expired:1;
153         __u64                   ses_id_cookie;  /* batch id cookie */
154         char                    ses_name[LST_NAME_SIZE];  /* session name */
155         lstcon_rpc_trans_t     *ses_ping;       /* session pinger */
156         stt_timer_t             ses_ping_timer; /* timer for pinger */
157         lstcon_trans_stat_t     ses_trans_stat; /* transaction stats */
158
159         cfs_list_t              ses_trans_list; /* global list of transaction */
160         cfs_list_t              ses_grp_list;   /* global list of groups */
161         cfs_list_t              ses_bat_list;   /* global list of batches */
162         cfs_list_t              ses_ndl_list;   /* global list of nodes */
163         cfs_list_t             *ses_ndl_hash;   /* hash table of nodes */
164
165         spinlock_t          ses_rpc_lock;   /* serialize */
166         cfs_atomic_t            ses_rpc_counter;/* # of initialized RPCs */
167         cfs_list_t              ses_rpc_freelist; /* idle console rpc */
168 } lstcon_session_t;                             /*** session descriptor */
169
170 extern lstcon_session_t         console_session;
171
172 static inline lstcon_trans_stat_t *
173 lstcon_trans_stat(void)
174 {
175         return &console_session.ses_trans_stat;
176 }
177
178 static inline cfs_list_t *
179 lstcon_id2hash (lnet_process_id_t id, cfs_list_t *hash)
180 {
181         unsigned int idx = LNET_NIDADDR(id.nid) % LST_NODE_HASHSIZE;
182
183         return &hash[idx];
184 }
185
186 extern int lstcon_session_match(lst_sid_t sid);
187 extern int lstcon_session_new(char *name, int key, unsigned version,
188                               int timeout, int flags, lst_sid_t *sid_up);
189 extern int lstcon_session_info(lst_sid_t *sid_up, int *key, unsigned *verp,
190                                lstcon_ndlist_ent_t *entp, char *name_up, int len);
191 extern int lstcon_session_end(void);
192 extern int lstcon_session_debug(int timeout, cfs_list_t *result_up);
193 extern int lstcon_session_feats_check(unsigned feats);
194 extern int lstcon_batch_debug(int timeout, char *name,
195                               int client, cfs_list_t *result_up);
196 extern int lstcon_group_debug(int timeout, char *name,
197                               cfs_list_t *result_up);
198 extern int lstcon_nodes_debug(int timeout, int nnd, lnet_process_id_t *nds_up,
199                               cfs_list_t *result_up);
200 extern int lstcon_group_add(char *name);
201 extern int lstcon_group_del(char *name);
202 extern int lstcon_group_clean(char *name, int args);
203 extern int lstcon_group_refresh(char *name, cfs_list_t *result_up);
204 extern int lstcon_nodes_add(char *name, int nnd, lnet_process_id_t *nds_up,
205                             unsigned *featp, cfs_list_t *result_up);
206 extern int lstcon_nodes_remove(char *name, int nnd, lnet_process_id_t *nds_up,
207                                cfs_list_t *result_up);
208 extern int lstcon_group_info(char *name, lstcon_ndlist_ent_t *gent_up, 
209                              int *index_p, int *ndent_p, lstcon_node_ent_t *ndents_up);
210 extern int lstcon_group_list(int idx, int len, char *name_up);
211 extern int lstcon_batch_add(char *name);
212 extern int lstcon_batch_run(char *name, int timeout,
213                             cfs_list_t *result_up);
214 extern int lstcon_batch_stop(char *name, int force,
215                              cfs_list_t *result_up);
216 extern int lstcon_test_batch_query(char *name, int testidx,
217                                    int client, int timeout,
218                                    cfs_list_t *result_up);
219 extern int lstcon_batch_del(char *name);
220 extern int lstcon_batch_list(int idx, int namelen, char *name_up);
221 extern int lstcon_batch_info(char *name, lstcon_test_batch_ent_t *ent_up,
222                              int server, int testidx, int *index_p,
223                              int *ndent_p, lstcon_node_ent_t *dents_up);
224 extern int lstcon_group_stat(char *grp_name, int timeout,
225                              cfs_list_t *result_up);
226 extern int lstcon_nodes_stat(int count, lnet_process_id_t *ids_up,
227                              int timeout, cfs_list_t *result_up);
228 extern int lstcon_test_add(char *name, int type, int loop, int concur,
229                            int dist, int span, char *src_name, char * dst_name,
230                            void *param, int paramlen, int *retp,
231                            cfs_list_t *result_up);
232 #endif
233
234 #endif