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.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/conrpc.h
  33  *
  34  * Console rpc
  35  *
  36  * Author: Liang Zhen <liang@whamcloud.com>
  37  */
  38
  39 #ifndef __LST_CONRPC_H__
  40 #define __LST_CONRPC_H__
  41
  42 #include <libcfs/libcfs.h>
  43 #include <lnet/lib-types.h>
  44 #include "rpc.h"
  45 #include "selftest.h"
  46
  47 /* Console rpc and rpc transaction */
  48 #define LST_TRANS_TIMEOUT       30
  49 #define LST_TRANS_MIN_TIMEOUT   3
  50
  51 #define LST_VALIDATE_TIMEOUT(t) \
  52         clamp_t(int, t, LST_TRANS_MIN_TIMEOUT, LST_TRANS_TIMEOUT)
  53
  54 #define LST_PING_INTERVAL       8
  55
  56 struct lstcon_rpc_trans;
  57 struct lstcon_tsb_hdr;
  58 struct lstcon_test;
  59 struct lstcon_node;
  60
  61 struct lstcon_rpc {
  62         struct list_head         crp_link;      /* chain on rpc transaction */
  63         struct srpc_client_rpc  *crp_rpc;       /* client rpc */
  64         struct lstcon_node      *crp_node;      /* destination node */
  65         struct lstcon_rpc_trans *crp_trans;     /* conrpc transaction */
  66
  67         unsigned int             crp_posted:1;   /* rpc is posted */
  68         unsigned int             crp_finished:1; /* rpc is finished */
  69         unsigned int             crp_unpacked:1; /* reply is unpacked */
  70         /** RPC is embedded in other structure and can't free it */
  71         unsigned int             crp_embedded:1;
  72         int                      crp_status;     /* console rpc errors */
  73         s64                      crp_stamp_ns;   /* replied time stamp */
  74 };
  75
  76 struct lstcon_rpc_trans {
  77         /* link chain on owner list */
  78         struct list_head        tas_olink;
  79         /* link chain on global list */
  80         struct list_head        tas_link;
  81         /* operation code of transaction */
  82         int                     tas_opc;
  83         /* features mask is uptodate */
  84         unsigned                tas_feats_updated;
  85         /* test features mask */
  86         unsigned                tas_features;
  87         wait_queue_head_t       tas_waitq;      /* wait queue head */
  88         atomic_t                tas_remaining;  /* # of un-scheduled rpcs */
  89         struct list_head        tas_rpcs_list;  /* queued requests */
  90 };
  91
  92 #define LST_TRANS_PRIVATE       0x1000
  93
  94 #define LST_TRANS_SESNEW        (LST_TRANS_PRIVATE | 0x01)
  95 #define LST_TRANS_SESEND        (LST_TRANS_PRIVATE | 0x02)
  96 #define LST_TRANS_SESQRY        0x03
  97 #define LST_TRANS_SESPING       0x04
  98
  99 #define LST_TRANS_TSBCLIADD     (LST_TRANS_PRIVATE | 0x11)
 100 #define LST_TRANS_TSBSRVADD     (LST_TRANS_PRIVATE | 0x12)
 101 #define LST_TRANS_TSBRUN        (LST_TRANS_PRIVATE | 0x13)
 102 #define LST_TRANS_TSBSTOP       (LST_TRANS_PRIVATE | 0x14)
 103 #define LST_TRANS_TSBCLIQRY     0x15
 104 #define LST_TRANS_TSBSRVQRY     0x16
 105
 106 #define LST_TRANS_STATQRY       0x21
 107
 108 typedef int (*lstcon_rpc_cond_func_t)(int, struct lstcon_node *, void *);
 109 typedef int (*lstcon_rpc_readent_func_t)(int, struct srpc_msg *,
 110                                          struct lstcon_rpc_ent __user *);
 111
 112 int  lstcon_sesrpc_prep(struct lstcon_node *nd, int transop,
 113                         unsigned int version, struct lstcon_rpc **crpc);
 114 int  lstcon_dbgrpc_prep(struct lstcon_node *nd,
 115                         unsigned int version, struct lstcon_rpc **crpc);
 116 int  lstcon_batrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
 117                         struct lstcon_tsb_hdr *tsb, struct lstcon_rpc **crpc);
 118 int  lstcon_testrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
 119                          struct lstcon_test *test, struct lstcon_rpc **crpc);
 120 int  lstcon_statrpc_prep(struct lstcon_node *nd, unsigned version,
 121                          struct lstcon_rpc **crpc);
 122 void lstcon_rpc_put(struct lstcon_rpc *crpc);
 123 int  lstcon_rpc_trans_prep(struct list_head *translist,
 124                            int transop, struct lstcon_rpc_trans **transpp);
 125 int  lstcon_rpc_trans_ndlist(struct list_head *ndlist,
 126                              struct list_head *translist, int transop,
 127                              void *arg, lstcon_rpc_cond_func_t condition,
 128                              struct lstcon_rpc_trans **transpp);
 129 void lstcon_rpc_trans_stat(struct lstcon_rpc_trans *trans,
 130                            struct lstcon_trans_stat *stat);
 131 int  lstcon_rpc_trans_interpreter(struct lstcon_rpc_trans *trans,
 132                                   struct list_head __user *head_up,
 133                                   lstcon_rpc_readent_func_t readent);
 134 void lstcon_rpc_trans_abort(struct lstcon_rpc_trans *trans, int error);
 135 void lstcon_rpc_trans_destroy(struct lstcon_rpc_trans *trans);
 136 void lstcon_rpc_trans_addreq(struct lstcon_rpc_trans *trans,
 137                              struct lstcon_rpc *req);
 138 int  lstcon_rpc_trans_postwait(struct lstcon_rpc_trans *trans, int timeout);
 139 int  lstcon_rpc_pinger_start(void);
 140 void lstcon_rpc_pinger_stop(void);
 141 void lstcon_rpc_cleanup_wait(void);
 142 int  lstcon_rpc_module_init(void);
 143 void lstcon_rpc_module_fini(void);
 144
 145
 146 #endif