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