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