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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2013, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lnet/selftest/console.h
  33  *
  34  * kernel structure for LST console
  35  *
  36  * Author: Liang Zhen <liangzhen@clusterfs.com>
  37  */
  38
  39 #ifndef __LST_CONSOLE_H__
  40 #define __LST_CONSOLE_H__
  41
  42 #include <linux/uaccess.h>
  43
  44 #include <libcfs/libcfs.h>
  45 #include <lnet/lib-types.h>
  46 #include <uapi/linux/lnet/lnetst.h>
  47 #include "selftest.h"
  48 #include "conrpc.h"
  49
  50 /* node descriptor */
  51 struct lstcon_node {
  52         struct lnet_process_id    nd_id;        /* id of the node */
  53         int                  nd_ref;         /* reference count */
  54         int                  nd_state;       /* state of the node */
  55         int                  nd_timeout;     /* session timeout */
  56         ktime_t                 nd_stamp;       /* last RPC reply timestamp */
  57         struct lstcon_rpc       nd_ping;        /* ping rpc */
  58 };
  59
  60 /* node link descriptor */
  61 struct lstcon_ndlink {
  62         struct list_head        ndl_link;       /* chain on list */
  63         struct list_head        ndl_hlink;      /* chain on hash */
  64         struct lstcon_node      *ndl_node;      /* pointer to node */
  65 };
  66
  67 /* (alias of nodes) group descriptor */
  68 struct lstcon_group {
  69         struct list_head        grp_link;       /* chain on global group list */
  70         int                     grp_ref;        /* reference count */
  71         int                     grp_userland;   /* has userland nodes */
  72         int                     grp_nnode;      /* # of nodes */
  73         char                    grp_name[LST_NAME_SIZE];        /* group name */
  74
  75         struct list_head        grp_trans_list; /* transaction list */
  76         struct list_head        grp_ndl_list;   /* nodes list */
  77         struct list_head        grp_ndl_hash[0];/* hash table for nodes */
  78 };
  79
  80 #define LST_BATCH_IDLE          0xB0            /* idle batch */
  81 #define LST_BATCH_RUNNING       0xB1            /* running batch */
  82
  83 struct lstcon_tsb_hdr {
  84         struct lst_bid          tsb_id;         /* batch ID */
  85         int                     tsb_index;      /* test index */
  86 };
  87
  88 /* (tests ) batch descriptor */
  89 struct lstcon_batch {
  90         /* test_batch header */
  91         struct lstcon_tsb_hdr   bat_hdr;
  92         /* chain on session's batches list */
  93         struct list_head        bat_link;
  94         /* # of test */
  95         int                     bat_ntest;
  96         /* state of the batch */
  97         int                     bat_state;
  98         /* parameter for run|stop, timeout for run, force for stop */
  99         int                     bat_arg;
 100         /* name of batch */
 101         char                    bat_name[LST_NAME_SIZE];
 102
 103         /* list head of tests (lstcon_test_t) */
 104         struct list_head        bat_test_list;
 105         /* list head of transaction */
 106         struct list_head        bat_trans_list;
 107         /* list head of client nodes (struct lstcon_node) */
 108         struct list_head        bat_cli_list;
 109         /* hash table of client nodes */
 110         struct list_head        *bat_cli_hash;
 111         /* list head of server nodes */
 112         struct list_head        bat_srv_list;
 113         /* hash table of server nodes */
 114         struct list_head        *bat_srv_hash;
 115 };
 116
 117 /* a single test descriptor */
 118 struct lstcon_test {
 119         /* test batch header */
 120         struct lstcon_tsb_hdr   tes_hdr;
 121         /* chain on batch's tests list */
 122         struct list_head        tes_link;
 123         /* pointer to batch */
 124         struct lstcon_batch     *tes_batch;
 125
 126         int                   tes_type;       /* type of the test, i.e: bulk, ping */
 127         int                   tes_stop_onerr; /* stop on error */
 128         int                   tes_oneside;    /* one-sided test */
 129         int                   tes_concur;     /* concurrency */
 130         int                   tes_loop;       /* loop count */
 131         int                   tes_dist;       /* nodes distribution of target group */
 132         int                   tes_span;       /* nodes span of target group */
 133         int                   tes_cliidx;     /* client index, used for RPC creating */
 134
 135         struct list_head        tes_trans_list; /* transaction list */
 136         struct lstcon_group     *tes_src_grp;   /* group run the test */
 137         struct lstcon_group     *tes_dst_grp;   /* target group */
 138
 139         int                   tes_paramlen;   /* test parameter length */
 140         char                  tes_param[0];   /* test parameter */
 141 };
 142
 143 #define LST_GLOBAL_HASHSIZE     503             /* global nodes hash table size */
 144 #define LST_NODE_HASHSIZE       239             /* node hash table (for batch or group) */
 145
 146 #define LST_SESSION_NONE        0x0             /* no session */
 147 #define LST_SESSION_ACTIVE      0x1             /* working session */
 148
 149 #define LST_CONSOLE_TIMEOUT     300             /* default console timeout */
 150
 151 struct lstcon_session {
 152         struct mutex            ses_mutex;      /* only 1 thread in session */
 153         struct lst_sid          ses_id;         /* global session id */
 154         int                     ses_key;        /* local session key */
 155         int                     ses_state;      /* state of session */
 156         int                     ses_timeout;    /* timeout in seconds */
 157         time64_t                ses_laststamp;  /* last operation stamp (seconds) */
 158         /** tests features of the session */
 159         unsigned                ses_features;
 160         /** features are synced with remote test nodes */
 161         unsigned                ses_feats_updated:1;
 162         /** force creating */
 163         unsigned                ses_force:1;
 164         /** session is shutting down */
 165         unsigned                ses_shutdown:1;
 166         /** console is timedout */
 167         unsigned                ses_expired:1;
 168         __u64                   ses_id_cookie;  /* batch id cookie */
 169         char                    ses_name[LST_NAME_SIZE];  /* session name */
 170         struct lstcon_rpc_trans *ses_ping;      /* session pinger */
 171         struct stt_timer        ses_ping_timer; /* timer for pinger */
 172         struct lstcon_trans_stat ses_trans_stat;/* transaction stats */
 173
 174         struct list_head        ses_trans_list; /* global list of transaction */
 175         struct list_head        ses_grp_list;   /* global list of groups */
 176         struct list_head        ses_bat_list;   /* global list of batches */
 177         struct list_head        ses_ndl_list;   /* global list of nodes */
 178         struct list_head        *ses_ndl_hash;  /* hash table of nodes */
 179
 180         spinlock_t              ses_rpc_lock;   /* serialize */
 181         atomic_t                ses_rpc_counter;/* # of initialized RPCs */
 182         struct list_head        ses_rpc_freelist;/* idle console rpc */
 183 }; /* session descriptor */
 184
 185 extern struct lstcon_session console_session;
 186
 187 static inline struct lstcon_trans_stat *
 188 lstcon_trans_stat(void)
 189 {
 190         return &console_session.ses_trans_stat;
 191 }
 192
 193 static inline struct list_head *
 194 lstcon_id2hash(struct lnet_process_id id, struct list_head *hash)
 195 {
 196         unsigned int idx = LNET_NIDADDR(id.nid) % LST_NODE_HASHSIZE;
 197
 198         return &hash[idx];
 199 }
 200
 201 extern int lstcon_session_match(struct lst_sid sid);
 202 extern int lstcon_session_new(char *name, int key, unsigned version,
 203                               int timeout, int flags, struct lst_sid __user *sid_up);
 204 extern int lstcon_session_info(struct lst_sid __user *sid_up, int __user *key,
 205                                unsigned __user *verp,
 206                                struct lstcon_ndlist_ent __user *entp,
 207                                char __user *name_up, int len);
 208 extern int lstcon_session_end(void);
 209 extern int lstcon_session_debug(int timeout,
 210                                 struct list_head __user *result_up);
 211 extern int lstcon_session_feats_check(unsigned feats);
 212 extern int lstcon_batch_debug(int timeout, char *name,
 213                               int client, struct list_head __user *result_up);
 214 extern int lstcon_group_debug(int timeout, char *name,
 215                               struct list_head __user *result_up);
 216 extern int lstcon_nodes_debug(int timeout, int nnd,
 217                               struct lnet_process_id __user *nds_up,
 218                               struct list_head __user *result_up);
 219 extern int lstcon_group_add(char *name);
 220 extern int lstcon_group_del(char *name);
 221 extern int lstcon_group_clean(char *name, int args);
 222 extern int lstcon_group_refresh(char *name, struct list_head __user *result_up);
 223 extern int lstcon_nodes_add(char *name, int nnd,
 224                             struct lnet_process_id __user *nds_up,
 225                             unsigned *featp,
 226                             struct list_head __user *result_up);
 227 extern int lstcon_nodes_remove(char *name, int nnd,
 228                                struct lnet_process_id __user *nds_up,
 229                                struct list_head __user *result_up);
 230 extern int lstcon_group_info(char *name, struct lstcon_ndlist_ent __user *gent_up,
 231                              int *index_p, int *ndent_p,
 232                              struct lstcon_node_ent __user *ndents_up);
 233 extern int lstcon_group_list(int idx, int len, char __user *name_up);
 234 extern int lstcon_batch_add(char *name);
 235 extern int lstcon_batch_run(char *name, int timeout,
 236                             struct list_head __user *result_up);
 237 extern int lstcon_batch_stop(char *name, int force,
 238                              struct list_head __user *result_up);
 239 extern int lstcon_test_batch_query(char *name, int testidx,
 240                                    int client, int timeout,
 241                                    struct list_head __user *result_up);
 242 extern int lstcon_batch_del(char *name);
 243 extern int lstcon_batch_list(int idx, int namelen, char __user *name_up);
 244 extern int lstcon_batch_info(char *name,
 245                              struct lstcon_test_batch_ent __user *ent_up,
 246                              int server, int testidx, int *index_p,
 247                              int *ndent_p,
 248                              struct lstcon_node_ent __user *dents_up);
 249 extern int lstcon_group_stat(char *grp_name, int timeout,
 250                              struct list_head __user *result_up);
 251 extern int lstcon_nodes_stat(int count, struct lnet_process_id __user *ids_up,
 252                              int timeout, struct list_head __user *result_up);
 253 extern int lstcon_test_add(char *batch_name, int type, int loop,
 254                            int concur, int dist, int span,
 255                            char *src_name, char *dst_name,
 256                            void *param, int paramlen, int *retp,
 257                            struct list_head __user *result_up);
 258
 259 int lstcon_ioctl_entry(struct notifier_block *nb,
 260                        unsigned long cmd, void *vdata);
 261 int lstcon_console_init(void);
 262 int lstcon_console_fini(void);
 263
 264 #endif