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         list_add(&srv_req->rq_list, &peer->cli_obd->obd_req_list);
  64         wake_up(&peer->cli_obd->obd_req_waitq);
  65         return 0;
  66 }
  67
  68 int ptlrpc_connect_client(int dev, char *uuid, int req_portal, int rep_portal,
  69                           req_pack_t req_pack, rep_unpack_t rep_unpack,
  70                           struct ptlrpc_client *cl)
  71 {
  72         int err;
  73
  74         memset(cl, 0, sizeof(*cl));
  75         spin_lock_init(&cl->cli_lock);
  76         cl->cli_xid = 1;
  77         cl->cli_obd = NULL;
  78         cl->cli_request_portal = req_portal;
  79         cl->cli_reply_portal = rep_portal;
  80         cl->cli_rep_unpack = rep_unpack;
  81         cl->cli_req_pack = req_pack;
  82
  83         /* non networked client */
  84         if (dev >= 0 && dev < MAX_OBD_DEVICES) {
  85                 struct obd_device *obd = &obd_dev[dev];
  86
  87                 if ((!obd->obd_flags & OBD_ATTACHED) ||
  88                     (!obd->obd_flags & OBD_SET_UP)) {
  89                         CERROR("target device %d not att or setup\n", dev);
  90                         return -EINVAL;
  91                 }
  92                 if (strcmp(obd->obd_type->typ_name, "ost") &&
  93                     strcmp(obd->obd_type->typ_name, "mds")) {
  94                         return -EINVAL;
  95                 }
  96
  97                 cl->cli_obd = &obd_dev[dev];
  98                 return 0;
  99         }
 100
 101         /* networked */
 102         err = kportal_uuid_to_peer(uuid, &cl->cli_server);
 103         if (err != 0) {
 104                 CERROR("cannot find peer %s!", uuid);
 105         }
 106
 107         return err;
 108 }
 109
 110 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct lustre_peer *peer)
 111 {
 112         struct ptlrpc_bulk_desc *bulk;
 113
 114         OBD_ALLOC(bulk, sizeof(*bulk));
 115         if (bulk != NULL) {
 116                 memset(bulk, 0, sizeof(*bulk));
 117                 memcpy(&bulk->b_peer, peer, sizeof(*peer));
 118                 init_waitqueue_head(&bulk->b_waitq);
 119         }
 120
 121         return bulk;
 122 }
 123
 124 struct ptlrpc_request *ptlrpc_prep_req(struct ptlrpc_client *cl,
 125                                        int opcode, int namelen, char *name,
 126                                        int tgtlen, char *tgt)
 127 {
 128         struct ptlrpc_request *request;
 129         int rc;
 130         ENTRY;
 131
 132         OBD_ALLOC(request, sizeof(*request));
 133         if (!request) {
 134                 CERROR("request allocation out of memory\n");
 135                 return NULL;
 136         }
 137
 138         memset(request, 0, sizeof(*request));
 139
 140         spin_lock(&cl->cli_lock);
 141         request->rq_xid = cl->cli_xid++;
 142         spin_unlock(&cl->cli_lock);
 143
 144         rc = cl->cli_req_pack(name, namelen, tgt, tgtlen,
 145                           &request->rq_reqhdr, &request->rq_req,
 146                           &request->rq_reqlen, &request->rq_reqbuf);
 147         if (rc) {
 148                 CERROR("cannot pack request %d\n", rc);
 149                 return NULL;
 150         }
 151         request->rq_reqhdr->opc = opcode;
 152         request->rq_reqhdr->xid = request->rq_xid;
 153
 154         EXIT;
 155         return request;
 156 }
 157
 158 void ptlrpc_free_req(struct ptlrpc_request *request)
 159 {
 160         if (request == NULL)
 161                 return;
 162
 163         if (request->rq_repbuf != NULL)
 164                 OBD_FREE(request->rq_repbuf, request->rq_replen);
 165         OBD_FREE(request, sizeof(*request));
 166 }
 167
 168 static int ptlrpc_check_reply(struct ptlrpc_request *req)
 169 {
 170         if (req->rq_repbuf != NULL) {
 171                 req->rq_flags = PTL_RPC_REPLY;
 172                 EXIT;
 173                 return 1;
 174         }
 175
 176         if (sigismember(&(current->pending.signal), SIGKILL) ||
 177             sigismember(&(current->pending.signal), SIGINT)) {
 178                 req->rq_flags = PTL_RPC_INTR;
 179                 EXIT;
 180                 return 1;
 181         }
 182
 183         return 0;
 184 }
 185
 186 int ptlrpc_check_status(struct ptlrpc_request *req, int err)
 187 {
 188         ENTRY;
 189
 190         if (err != 0) {
 191                 CERROR("err is %d\n", err);
 192                 EXIT;
 193                 return err;
 194         }
 195
 196         if (req == NULL) {
 197                 CERROR("req == NULL\n");
 198                 EXIT;
 199                 return -ENOMEM;
 200         }
 201
 202         if (req->rq_rephdr == NULL) {
 203                 CERROR("req->rq_rephdr == NULL\n");
 204                 EXIT;
 205                 return -ENOMEM;
 206         }
 207
 208         if (req->rq_rephdr->status != 0) {
 209                 CERROR("req->rq_rephdr->status is %d\n",
 210                        req->rq_rephdr->status);
 211                 EXIT;
 212                 /* XXX: translate this error from net to host */
 213                 return req->rq_rephdr->status;
 214         }
 215
 216         EXIT;
 217         return 0;
 218 }
 219
 220 /* Abort this request and cleanup any resources associated with it. */
 221 int ptlrpc_abort(struct ptlrpc_request *request)
 222 {
 223         /* First remove the MD for the reply; in theory, this means
 224          * that we can tear down the buffer safely. */
 225         PtlMEUnlink(request->rq_reply_me_h);
 226         PtlMDUnlink(request->rq_reply_md_h);
 227         OBD_FREE(request->rq_repbuf, request->rq_replen);
 228         request->rq_repbuf = NULL;
 229         request->rq_replen = 0;
 230
 231         return 0;
 232 }
 233
 234 int ptlrpc_queue_wait(struct ptlrpc_client *cl, struct ptlrpc_request *req)
 235
 236 {
 237         int rc;
 238         ENTRY;
 239
 240         init_waitqueue_head(&req->rq_wait_for_rep);
 241
 242         if (cl->cli_obd) {
 243                 /* Local delivery */
 244                 ENTRY;
 245                 rc = ptlrpc_enqueue(cl, req);
 246         } else {
 247                 /* Remote delivery via portals. */
 248                 req->rq_req_portal = cl->cli_request_portal;
 249                 req->rq_reply_portal = cl->cli_reply_portal;
 250                 rc = ptl_send_rpc(req, &cl->cli_server);
 251         }
 252         if (rc) {
 253                 CERROR("error %d, opcode %d\n", rc, req->rq_reqhdr->opc);
 254                 return -rc;
 255         }
 256
 257         CDEBUG(D_OTHER, "-- sleeping\n");
 258         wait_event_interruptible(req->rq_wait_for_rep, ptlrpc_check_reply(req));
 259         CDEBUG(D_OTHER, "-- done\n");
 260
 261         if (req->rq_flags == PTL_RPC_INTR) {
 262                 /* Clean up the dangling reply buffers */
 263                 ptlrpc_abort(req);
 264                 EXIT;
 265                 return -EINTR;
 266         }
 267
 268         if (req->rq_flags != PTL_RPC_REPLY) {
 269                 CERROR("Unknown reason for wakeup\n");
 270                 BUG();
 271                 EXIT;
 272                 return -EINTR;
 273         }
 274
 275         rc = cl->cli_rep_unpack(req->rq_repbuf, req->rq_replen,
 276                                 &req->rq_rephdr, &req->rq_rep);
 277         if (rc) {
 278                 CERROR("unpack_rep failed: %d\n", rc);
 279                 return rc;
 280         }
 281         CDEBUG(D_NET, "got rep %d\n", req->rq_rephdr->xid);
 282
 283         if ( req->rq_rephdr->status == 0 )
 284                 CDEBUG(D_NET, "--> buf %p len %d status %d\n", req->rq_repbuf,
 285                        req->rq_replen, req->rq_rephdr->status);
 286
 287         EXIT;
 288         return 0;
 289 }