Whamcloud - gitweb
- Added UUID description to network document
[fs/lustre-release.git] / lustre / ptlrpc / client.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (C) 2002 Cluster File Systems, Inc.
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
8  *   Lustre is free software; you can redistribute it and/or
9  *   modify it under the terms of version 2 of the GNU General Public
10  *   License as published by the Free Software Foundation.
11  *
12  *   Lustre is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *   GNU General Public License for more details.
16  *
17  *   You should have received a copy of the GNU General Public License
18  *   along with Lustre; if not, write to the Free Software
19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  */
22
23 #define EXPORT_SYMTAB
24
25 #include <linux/config.h>
26 #include <linux/module.h>
27 #include <linux/kernel.h>
28
29 #define DEBUG_SUBSYSTEM S_RPC
30
31 #include <linux/obd_support.h>
32 #include <linux/obd_class.h>
33 #include <linux/lustre_net.h>
34
35 int ptlrpc_enqueue(struct ptlrpc_client *peer, struct ptlrpc_request *req)
36 {
37         struct ptlrpc_request *srv_req;
38         
39         if (!peer->cli_obd) { 
40                 EXIT;
41                 return -1;
42         }
43
44         OBD_ALLOC(srv_req, sizeof(*srv_req));
45         if (!srv_req) { 
46                 EXIT;
47                 return -ENOMEM;
48         }
49
50         CDEBUG(0, "peer obd minor %d, incoming req %p, srv_req %p\n",
51                peer->cli_obd->obd_minor, req, srv_req);
52
53         memset(srv_req, 0, sizeof(*req)); 
54
55         /* move the request buffer */
56         srv_req->rq_reqbuf = req->rq_reqbuf;
57         srv_req->rq_reqlen = req->rq_reqlen;
58         srv_req->rq_obd = peer->cli_obd;
59
60         /* remember where it came from */
61         srv_req->rq_reply_handle = req;
62
63         spin_lock(&peer->cli_lock);
64         list_add(&srv_req->rq_list, &peer->cli_obd->obd_req_list); 
65         spin_unlock(&peer->cli_lock);
66         wake_up(&peer->cli_obd->obd_req_waitq);
67         return 0;
68 }
69
70 int ptlrpc_connect_client(int dev, char *uuid, int req_portal, int rep_portal, 
71                           req_pack_t req_pack, rep_unpack_t rep_unpack,
72                           struct ptlrpc_client *cl)
73 {
74         int err; 
75
76         memset(cl, 0, sizeof(*cl));
77         spin_lock_init(&cl->cli_lock);
78         cl->cli_xid = 1;
79         cl->cli_obd = NULL; 
80         cl->cli_request_portal = req_portal;
81         cl->cli_reply_portal = rep_portal;
82         cl->cli_rep_unpack = rep_unpack;
83         cl->cli_req_pack = req_pack;
84
85         /* non networked client */
86         if (dev >= 0 && dev < MAX_OBD_DEVICES) {
87                 struct obd_device *obd = &obd_dev[dev];
88                 
89                 if ((!obd->obd_flags & OBD_ATTACHED) ||
90                     (!obd->obd_flags & OBD_SET_UP)) { 
91                         CERROR("target device %d not att or setup\n", dev);
92                         return -EINVAL;
93                 }
94                 if (strcmp(obd->obd_type->typ_name, "ost") && 
95                     strcmp(obd->obd_type->typ_name, "mds")) { 
96                         return -EINVAL;
97                 }
98
99                 cl->cli_obd = &obd_dev[dev];
100                 return 0;
101         }
102
103         /* networked */
104         err = kportal_uuid_to_peer(uuid, &cl->cli_server);
105         if (err != 0)
106                 CERROR("cannot find peer %s!\n", uuid);
107
108         return err;
109 }
110
111 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct lustre_peer *peer)
112 {
113         struct ptlrpc_bulk_desc *bulk;
114
115         OBD_ALLOC(bulk, sizeof(*bulk));
116         if (bulk != NULL) {
117                 memset(bulk, 0, sizeof(*bulk));
118                 memcpy(&bulk->b_peer, peer, sizeof(*peer));
119                 init_waitqueue_head(&bulk->b_waitq);
120         }
121
122         return bulk;
123 }
124
125 struct ptlrpc_request *ptlrpc_prep_req(struct ptlrpc_client *cl, 
126                                        int opcode, int namelen, char *name,
127                                        int tgtlen, char *tgt)
128 {
129         struct ptlrpc_request *request;
130         int rc;
131         ENTRY; 
132
133         OBD_ALLOC(request, sizeof(*request));
134         if (!request) { 
135                 CERROR("request allocation out of memory\n");
136                 return NULL;
137         }
138
139         memset(request, 0, sizeof(*request));
140         //spin_lock_init(&request->rq_lock);
141
142         spin_lock(&cl->cli_lock);
143         request->rq_xid = cl->cli_xid++;
144         spin_unlock(&cl->cli_lock);
145
146         rc = cl->cli_req_pack(name, namelen, tgt, tgtlen,
147                           &request->rq_reqhdr, &request->rq_req,
148                           &request->rq_reqlen, &request->rq_reqbuf);
149         if (rc) { 
150                 CERROR("cannot pack request %d\n", rc); 
151                 return NULL;
152         }
153         request->rq_reqhdr->opc = opcode;
154         request->rq_reqhdr->xid = request->rq_xid;
155
156         EXIT;
157         return request;
158 }
159
160 void ptlrpc_free_req(struct ptlrpc_request *request)
161 {
162         if (request == NULL)
163                 return;
164
165         if (request->rq_repbuf != NULL)
166                 OBD_FREE(request->rq_repbuf, request->rq_replen);
167         OBD_FREE(request, sizeof(*request));
168 }
169
170 static int ptlrpc_check_reply(struct ptlrpc_request *req)
171 {
172         int rc = 0;
173
174         //spin_lock(&req->rq_lock);
175         if (req->rq_repbuf != NULL) {
176                 req->rq_flags = PTL_RPC_REPLY;
177                 EXIT;
178                 rc = 1;
179                 goto out;
180         }
181
182         if (sigismember(&(current->pending.signal), SIGKILL) ||
183             sigismember(&(current->pending.signal), SIGTERM) ||
184             sigismember(&(current->pending.signal), SIGSTOP) ||
185             sigismember(&(current->pending.signal), SIGINT)) { 
186                 req->rq_flags = PTL_RPC_INTR;
187                 EXIT;
188                 rc = 1; 
189                 goto out;
190         }
191
192  out:
193         //spin_unlock(&req->rq_lock);
194         return rc;
195 }
196
197 int ptlrpc_check_status(struct ptlrpc_request *req, int err)
198 {
199         ENTRY;
200
201         if (err != 0) {
202                 CERROR("err is %d\n", err);
203                 EXIT;
204                 return err;
205         }
206
207         if (req == NULL) {
208                 CERROR("req == NULL\n");
209                 EXIT;
210                 return -ENOMEM;
211         }
212
213         if (req->rq_rephdr == NULL) {
214                 CERROR("req->rq_rephdr == NULL\n");
215                 EXIT;
216                 return -ENOMEM;
217         }
218
219         if (req->rq_rephdr->status != 0) {
220                 CERROR("req->rq_rephdr->status is %d\n",
221                        req->rq_rephdr->status);
222                 EXIT;
223                 /* XXX: translate this error from net to host */
224                 return req->rq_rephdr->status;
225         }
226
227         EXIT;
228         return 0;
229 }
230
231 /* Abort this request and cleanup any resources associated with it. */
232 int ptlrpc_abort(struct ptlrpc_request *request)
233 {
234         /* First remove the ME for the reply; in theory, this means
235          * that we can tear down the buffer safely. */
236         //spin_lock(&request->rq_lock);
237         PtlMEUnlink(request->rq_reply_me_h);
238         OBD_FREE(request->rq_repbuf, request->rq_replen);
239         request->rq_repbuf = NULL;
240         request->rq_replen = 0;
241         //spin_unlock(&request->rq_lock);
242
243         return 0;
244 }
245
246
247 int ptlrpc_queue_wait(struct ptlrpc_client *cl, struct ptlrpc_request *req)
248                              
249 {
250         int rc = 0;
251         ENTRY;
252
253         init_waitqueue_head(&req->rq_wait_for_rep);
254
255         if (cl->cli_obd) {
256                 /* Local delivery */
257                 ENTRY;
258                 rc = ptlrpc_enqueue(cl, req); 
259         } else {
260                 /* Remote delivery via portals. */
261                 req->rq_req_portal = cl->cli_request_portal;
262                 req->rq_reply_portal = cl->cli_reply_portal;
263                 rc = ptl_send_rpc(req, &cl->cli_server);
264         }
265         if (rc) { 
266                 CERROR("error %d, opcode %d\n", rc, req->rq_reqhdr->opc);
267                 return -rc;
268         }
269
270         CDEBUG(D_OTHER, "-- sleeping\n");
271         wait_event_interruptible(req->rq_wait_for_rep, ptlrpc_check_reply(req));
272         CDEBUG(D_OTHER, "-- done\n");
273         //spin_lock(&req->rq_lock);
274         if (req->rq_flags == PTL_RPC_INTR) { 
275                 /* Clean up the dangling reply buffers */
276                 ptlrpc_abort(req);
277                 EXIT;
278                 rc = -EINTR;
279                 goto out;
280         }
281
282         if (req->rq_flags != PTL_RPC_REPLY) { 
283                 CERROR("Unknown reason for wakeup\n");
284                 /* XXX Phil - I end up here when I kill obdctl */
285                 ptlrpc_abort(req); 
286                 //BUG();
287                 EXIT;
288                 rc = -EINTR;
289                 goto out;
290         }
291
292         rc = cl->cli_rep_unpack(req->rq_repbuf, req->rq_replen,
293                                 &req->rq_rephdr, &req->rq_rep);
294         if (rc) {
295                 CERROR("unpack_rep failed: %d\n", rc);
296                 goto out;
297         }
298         CDEBUG(D_NET, "got rep %d\n", req->rq_rephdr->xid);
299
300         if ( req->rq_rephdr->status == 0 )
301                 CDEBUG(D_NET, "--> buf %p len %d status %d\n", req->rq_repbuf,
302                        req->rq_replen, req->rq_rephdr->status);
303
304         EXIT;
305  out:
306         //spin_unlock(&req->rq_lock);
307         return rc;
308 }