Whamcloud - gitweb
LU-9859 libcfs: always range-check libcfs_debug_mb setting.
[fs/lustre-release.git] / 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 <uapi/linux/lnet/lnetst.h>
45 #include "rpc.h"
46 #include "selftest.h"
47
48 /* Console rpc and rpc transaction */
49 #define LST_TRANS_TIMEOUT       30
50 #define LST_TRANS_MIN_TIMEOUT   3
51
52 #define LST_VALIDATE_TIMEOUT(t) \
53         clamp_t(int, 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         s64                      crp_stamp_ns;   /* replied time stamp */
75 };
76
77 struct lstcon_rpc_trans {
78         /* link chain on owner list */
79         struct list_head        tas_olink;
80         /* link chain on global list */
81         struct list_head        tas_link;
82         /* operation code of transaction */
83         int                     tas_opc;
84         /* features mask is uptodate */
85         unsigned                tas_feats_updated;
86         /* test features mask */
87         unsigned                tas_features;
88         wait_queue_head_t       tas_waitq;      /* wait queue head */
89         atomic_t                tas_remaining;  /* # of un-scheduled rpcs */
90         struct list_head        tas_rpcs_list;  /* queued requests */
91 };
92
93 #define LST_TRANS_PRIVATE       0x1000
94
95 #define LST_TRANS_SESNEW        (LST_TRANS_PRIVATE | 0x01)
96 #define LST_TRANS_SESEND        (LST_TRANS_PRIVATE | 0x02)
97 #define LST_TRANS_SESQRY        0x03
98 #define LST_TRANS_SESPING       0x04
99
100 #define LST_TRANS_TSBCLIADD     (LST_TRANS_PRIVATE | 0x11)
101 #define LST_TRANS_TSBSRVADD     (LST_TRANS_PRIVATE | 0x12)
102 #define LST_TRANS_TSBRUN        (LST_TRANS_PRIVATE | 0x13)
103 #define LST_TRANS_TSBSTOP       (LST_TRANS_PRIVATE | 0x14)
104 #define LST_TRANS_TSBCLIQRY     0x15
105 #define LST_TRANS_TSBSRVQRY     0x16
106
107 #define LST_TRANS_STATQRY       0x21
108
109 typedef int (*lstcon_rpc_cond_func_t)(int, struct lstcon_node *, void *);
110 typedef int (*lstcon_rpc_readent_func_t)(int, struct srpc_msg *,
111                                          struct lstcon_rpc_ent __user *);
112
113 int  lstcon_sesrpc_prep(struct lstcon_node *nd, int transop,
114                         unsigned int version, struct lstcon_rpc **crpc);
115 int  lstcon_dbgrpc_prep(struct lstcon_node *nd,
116                         unsigned int version, struct lstcon_rpc **crpc);
117 int  lstcon_batrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
118                         struct lstcon_tsb_hdr *tsb, struct lstcon_rpc **crpc);
119 int  lstcon_testrpc_prep(struct lstcon_node *nd, int transop, unsigned version,
120                          struct lstcon_test *test, struct lstcon_rpc **crpc);
121 int  lstcon_statrpc_prep(struct lstcon_node *nd, unsigned version,
122                          struct lstcon_rpc **crpc);
123 void lstcon_rpc_put(struct lstcon_rpc *crpc);
124 int  lstcon_rpc_trans_prep(struct list_head *translist,
125                            int transop, struct lstcon_rpc_trans **transpp);
126 int  lstcon_rpc_trans_ndlist(struct list_head *ndlist,
127                              struct list_head *translist, int transop,
128                              void *arg, lstcon_rpc_cond_func_t condition,
129                              struct lstcon_rpc_trans **transpp);
130 void lstcon_rpc_trans_stat(struct lstcon_rpc_trans *trans,
131                            struct lstcon_trans_stat *stat);
132 int  lstcon_rpc_trans_interpreter(struct lstcon_rpc_trans *trans,
133                                   struct list_head __user *head_up,
134                                   lstcon_rpc_readent_func_t readent);
135 void lstcon_rpc_trans_abort(struct lstcon_rpc_trans *trans, int error);
136 void lstcon_rpc_trans_destroy(struct lstcon_rpc_trans *trans);
137 void lstcon_rpc_trans_addreq(struct lstcon_rpc_trans *trans,
138                              struct lstcon_rpc *req);
139 int  lstcon_rpc_trans_postwait(struct lstcon_rpc_trans *trans, int timeout);
140 int  lstcon_rpc_pinger_start(void);
141 void lstcon_rpc_pinger_stop(void);
142 void lstcon_rpc_cleanup_wait(void);
143 int  lstcon_rpc_module_init(void);
144 void lstcon_rpc_module_fini(void);
145
146
147 #endif