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