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         sema_init(&cl->cli_rpc_sem, 32);
  85
  86         /* non networked client */
  87         if (dev >= 0 && dev < MAX_OBD_DEVICES) {
  88                 struct obd_device *obd = &obd_dev[dev];
  89
  90                 if ((!obd->obd_flags & OBD_ATTACHED) ||
  91                     (!obd->obd_flags & OBD_SET_UP)) {
  92                         CERROR("target device %d not att or setup\n", dev);
  93                         return -EINVAL;
  94                 }
  95                 if (strcmp(obd->obd_type->typ_name, "ost") &&
  96                     strcmp(obd->obd_type->typ_name, "mds")) {
  97                         return -EINVAL;
  98                 }
  99
 100                 cl->cli_obd = &obd_dev[dev];
 101                 return 0;
 102         }
 103
 104         /* networked */
 105         err = kportal_uuid_to_peer(uuid, &cl->cli_server);
 106         if (err != 0)
 107                 CERROR("cannot find peer %s!\n", uuid);
 108
 109         return err;
 110 }
 111
 112 struct ptlrpc_bulk_desc *ptlrpc_prep_bulk(struct lustre_peer *peer)
 113 {
 114         struct ptlrpc_bulk_desc *bulk;
 115
 116         OBD_ALLOC(bulk, sizeof(*bulk));
 117         if (bulk != NULL) {
 118                 memset(bulk, 0, sizeof(*bulk));
 119                 memcpy(&bulk->b_peer, peer, sizeof(*peer));
 120                 init_waitqueue_head(&bulk->b_waitq);
 121         }
 122
 123         return bulk;
 124 }
 125
 126 struct ptlrpc_request *ptlrpc_prep_req(struct ptlrpc_client *cl,
 127                                        int opcode, int namelen, char *name,
 128                                        int tgtlen, char *tgt)
 129 {
 130         struct ptlrpc_request *request;
 131         int rc;
 132         ENTRY;
 133
 134         OBD_ALLOC(request, sizeof(*request));
 135         if (!request) {
 136                 CERROR("request allocation out of memory\n");
 137                 return NULL;
 138         }
 139
 140         memset(request, 0, sizeof(*request));
 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         if (req->rq_repbuf != NULL) {
 175                 req->rq_flags = PTL_RPC_REPLY;
 176                 GOTO(out, rc = 1);
 177         }
 178
 179         if (sigismember(&(current->pending.signal), SIGKILL) ||
 180             sigismember(&(current->pending.signal), SIGTERM) ||
 181             sigismember(&(current->pending.signal), SIGINT)) {
 182                 req->rq_flags = PTL_RPC_INTR;
 183                 GOTO(out, rc = 1);
 184         }
 185
 186  out:
 187         return rc;
 188 }
 189
 190 int ptlrpc_check_status(struct ptlrpc_request *req, int err)
 191 {
 192         ENTRY;
 193
 194         if (err != 0) {
 195                 CERROR("err is %d\n", err);
 196                 EXIT;
 197                 return err;
 198         }
 199
 200         if (req == NULL) {
 201                 CERROR("req == NULL\n");
 202                 EXIT;
 203                 return -ENOMEM;
 204         }
 205
 206         if (req->rq_rephdr == NULL) {
 207                 CERROR("req->rq_rephdr == NULL\n");
 208                 EXIT;
 209                 return -ENOMEM;
 210         }
 211
 212         if (req->rq_rephdr->status != 0) {
 213                 CERROR("req->rq_rephdr->status is %d\n",
 214                        req->rq_rephdr->status);
 215                 EXIT;
 216                 /* XXX: translate this error from net to host */
 217                 return req->rq_rephdr->status;
 218         }
 219
 220         EXIT;
 221         return 0;
 222 }
 223
 224 /* Abort this request and cleanup any resources associated with it. */
 225 int ptlrpc_abort(struct ptlrpc_request *request)
 226 {
 227         /* First remove the ME for the reply; in theory, this means
 228          * that we can tear down the buffer safely. */
 229         PtlMEUnlink(request->rq_reply_me_h);
 230         OBD_FREE(request->rq_reply_md.start, request->rq_replen);
 231         request->rq_repbuf = NULL;
 232         request->rq_replen = 0;
 233
 234         return 0;
 235 }
 236
 237 int ptlrpc_queue_wait(struct ptlrpc_client *cl, struct ptlrpc_request *req)
 238 {
 239         int rc = 0;
 240         ENTRY;
 241
 242         init_waitqueue_head(&req->rq_wait_for_rep);
 243
 244         if (cl->cli_obd) {
 245                 /* Local delivery */
 246                 down(&cl->cli_rpc_sem);
 247                 rc = ptlrpc_enqueue(cl, req);
 248         } else {
 249                 /* Remote delivery via portals. */
 250                 req->rq_req_portal = cl->cli_request_portal;
 251                 req->rq_reply_portal = cl->cli_reply_portal;
 252                 rc = ptl_send_rpc(req, cl);
 253         }
 254         if (rc) {
 255                 CERROR("error %d, opcode %d\n", rc, req->rq_reqhdr->opc);
 256                 up(&cl->cli_rpc_sem);
 257                 RETURN(-rc);
 258         }
 259
 260         CDEBUG(D_OTHER, "-- sleeping\n");
 261         wait_event_interruptible(req->rq_wait_for_rep, ptlrpc_check_reply(req));
 262         CDEBUG(D_OTHER, "-- done\n");
 263         up(&cl->cli_rpc_sem);
 264         if (req->rq_flags == PTL_RPC_INTR) {
 265                 /* Clean up the dangling reply buffers */
 266                 ptlrpc_abort(req);
 267                 GOTO(out, rc = -EINTR);
 268         }
 269
 270         if (req->rq_flags != PTL_RPC_REPLY) {
 271                 CERROR("Unknown reason for wakeup\n");
 272                 /* XXX Phil - I end up here when I kill obdctl */
 273                 ptlrpc_abort(req);
 274                 GOTO(out, rc = -EINTR);
 275         }
 276
 277         rc = cl->cli_rep_unpack(req->rq_repbuf, req->rq_replen,
 278                                 &req->rq_rephdr, &req->rq_rep);
 279         if (rc) {
 280                 CERROR("unpack_rep failed: %d\n", rc);
 281                 GOTO(out, rc);
 282         }
 283         CDEBUG(D_NET, "got rep %d\n", req->rq_rephdr->xid);
 284
 285         if ( req->rq_rephdr->status == 0 )
 286                 CDEBUG(D_NET, "--> buf %p len %d status %d\n", req->rq_repbuf,
 287                        req->rq_replen, req->rq_rephdr->status);
 288
 289         EXIT;
 290  out:
 291         return rc;
 292 }