lnet/lnet/lib-md.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * lib/lib-md.c
   5  * Memory Descriptor management routines
   6  *
   7  *  Copyright (c) 2001-2003 Cluster File Systems, Inc.
   8  *  Copyright (c) 2001-2002 Sandia National Laboratories
   9  *
  10  *   This file is part of Lustre, http://www.sf.net/projects/lustre/
  11  *
  12  *   Lustre is free software; you can redistribute it and/or
  13  *   modify it under the terms of version 2 of the GNU General Public
  14  *   License as published by the Free Software Foundation.
  15  *
  16  *   Lustre is distributed in the hope that it will be useful,
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *   GNU General Public License for more details.
  20  *
  21  *   You should have received a copy of the GNU General Public License
  22  *   along with Lustre; if not, write to the Free Software
  23  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  */
  25
  26 #ifndef __KERNEL__
  27 # include <stdio.h>
  28 #else
  29 # define DEBUG_SUBSYSTEM S_PORTALS
  30 # include <linux/kp30.h>
  31 #endif
  32
  33 #include <portals/lib-p30.h>
  34 #include <portals/arg-blocks.h>
  35
  36 /* must be called with state lock held */
  37 void lib_md_unlink(nal_cb_t * nal, lib_md_t * md)
  38 {
  39         if ((md->md_flags & PTL_MD_FLAG_ZOMBIE) == 0) {
  40                 /* first unlink attempt... */
  41                 lib_me_t *me = md->me;
  42
  43                 md->md_flags |= PTL_MD_FLAG_ZOMBIE;
  44
  45                 /* Disassociate from ME (if any), and unlink it if it was created
  46                  * with PTL_UNLINK */
  47                 if (me != NULL) {
  48                         me->md = NULL;
  49                         if (me->unlink == PTL_UNLINK)
  50                                 lib_me_unlink(nal, me);
  51                 }
  52
  53                 /* emsure all future handle lookups fail */
  54                 lib_invalidate_handle(nal, &md->md_lh);
  55         }
  56
  57         if (md->pending != 0) {
  58                 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
  59                 return;
  60         }
  61
  62         CDEBUG(D_NET, "Unlinking md %p\n", md);
  63
  64         if ((md->options & PTL_MD_KIOV) != 0) {
  65                 if (nal->cb_unmap_pages != NULL)
  66                         nal->cb_unmap_pages (nal, md->md_niov, md->md_iov.kiov,
  67                                              &md->md_addrkey);
  68         } else if (nal->cb_unmap != NULL) {
  69                 nal->cb_unmap (nal, md->md_niov, md->md_iov.iov,
  70                                &md->md_addrkey);
  71         }
  72
  73         if (md->eq != NULL) {
  74                 md->eq->eq_refcount--;
  75                 LASSERT (md->eq->eq_refcount >= 0);
  76         }
  77
  78         list_del (&md->md_list);
  79         lib_md_free(nal, md);
  80 }
  81
  82 /* must be called with state lock held */
  83 static int lib_md_build(nal_cb_t *nal, lib_md_t *new, void *private,
  84                         ptl_md_t *md, ptl_handle_eq_t *eqh, int unlink)
  85 {
  86         lib_eq_t     *eq = NULL;
  87         int           rc;
  88         int           i;
  89         int           niov;
  90
  91         /* NB we are passed an allocated, but uninitialised/active md.
  92          * if we return success, caller may lib_md_unlink() it.
  93          * otherwise caller may only lib_md_free() it.
  94          */
  95
  96         if (!PtlHandleIsEqual (*eqh, PTL_EQ_NONE)) {
  97                 eq = ptl_handle2eq(eqh, nal);
  98                 if (eq == NULL)
  99                         return PTL_EQ_INVALID;
 100         }
 101
 102         /* Must check this _before_ allocation.  Also, note that non-iov
 103          * MDs must set md_niov to 0. */
 104         LASSERT((md->options & (PTL_MD_IOVEC | PTL_MD_KIOV)) == 0 ||
 105                 md->length <= PTL_MD_MAX_IOV);
 106
 107         /* This implementation doesn't know how to create START events or
 108          * disable END events.  Best to LASSERT our caller is compliant so
 109          * we find out quickly...  */
 110         LASSERT (PtlHandleIsEqual (*eqh, PTL_EQ_NONE) ||
 111                  ((md->options & PTL_MD_EVENT_START_DISABLE) != 0 &&
 112                   (md->options & PTL_MD_EVENT_END_DISABLE) == 0));
 113
 114         if ((md->options & PTL_MD_MAX_SIZE) != 0 && /* max size used */
 115             (md->max_size < 0 || md->max_size > md->length)) // illegal max_size
 116                 return PTL_MD_INVALID;
 117
 118         new->me = NULL;
 119         new->start = md->start;
 120         new->offset = 0;
 121         new->max_size = md->max_size;
 122         new->options = md->options;
 123         new->user_ptr = md->user_ptr;
 124         new->eq = eq;
 125         new->threshold = md->threshold;
 126         new->pending = 0;
 127         new->md_flags = (unlink == PTL_UNLINK) ? PTL_MD_FLAG_AUTO_UNLINK : 0;
 128
 129         if ((md->options & PTL_MD_IOVEC) != 0) {
 130                 int total_length = 0;
 131
 132                 if ((md->options & PTL_MD_KIOV) != 0) /* Can't specify both */
 133                         return PTL_MD_INVALID;
 134
 135                 new->md_niov = niov = md->length;
 136
 137                 if (nal->cb_read (nal, private, new->md_iov.iov, md->start,
 138                                   niov * sizeof (new->md_iov.iov[0])))
 139                         return PTL_SEGV;
 140
 141                 for (i = 0; i < niov; i++) {
 142                         /* We take the base address on trust */
 143                         if (new->md_iov.iov[i].iov_len <= 0) /* invalid length */
 144                                 return PTL_VAL_FAILED;
 145
 146                         total_length += new->md_iov.iov[i].iov_len;
 147                 }
 148
 149                 new->length = total_length;
 150
 151                 if (nal->cb_map != NULL) {
 152                         rc = nal->cb_map (nal, niov, new->md_iov.iov,
 153                                           &new->md_addrkey);
 154                         if (rc != PTL_OK)
 155                                 return (rc);
 156                 }
 157         } else if ((md->options & PTL_MD_KIOV) != 0) {
 158 #ifndef __KERNEL__
 159                 return PTL_MD_INVALID;
 160 #else
 161                 int total_length = 0;
 162
 163                 /* Trap attempt to use paged I/O if unsupported early. */
 164                 if (nal->cb_send_pages == NULL ||
 165                     nal->cb_recv_pages == NULL)
 166                         return PTL_MD_INVALID;
 167
 168                 new->md_niov = niov = md->length;
 169
 170                 if (nal->cb_read (nal, private, new->md_iov.kiov, md->start,
 171                                   niov * sizeof (new->md_iov.kiov[0])))
 172                         return PTL_SEGV;
 173
 174                 for (i = 0; i < niov; i++) {
 175                         /* We take the page pointer on trust */
 176                         if (new->md_iov.kiov[i].kiov_offset +
 177                             new->md_iov.kiov[i].kiov_len > PAGE_SIZE )
 178                                 return PTL_VAL_FAILED; /* invalid length */
 179
 180                         total_length += new->md_iov.kiov[i].kiov_len;
 181                 }
 182
 183                 new->length = total_length;
 184
 185                 if (nal->cb_map_pages != NULL) {
 186                         rc = nal->cb_map_pages (nal, niov, new->md_iov.kiov,
 187                                                 &new->md_addrkey);
 188                         if (rc != PTL_OK)
 189                                 return (rc);
 190                 }
 191 #endif
 192         } else {   /* contiguous */
 193                 new->length = md->length;
 194                 new->md_niov = niov = 1;
 195                 new->md_iov.iov[0].iov_base = md->start;
 196                 new->md_iov.iov[0].iov_len = md->length;
 197
 198                 if (nal->cb_map != NULL) {
 199                         rc = nal->cb_map (nal, niov, new->md_iov.iov,
 200                                           &new->md_addrkey);
 201                         if (rc != PTL_OK)
 202                                 return (rc);
 203                 }
 204         }
 205
 206         if (eq != NULL)
 207                 eq->eq_refcount++;
 208
 209         /* It's good; let handle2md succeed and add to active mds */
 210         lib_initialise_handle (nal, &new->md_lh, PTL_COOKIE_TYPE_MD);
 211         list_add (&new->md_list, &nal->ni.ni_active_mds);
 212
 213         return PTL_OK;
 214 }
 215
 216 /* must be called with state lock held */
 217 void lib_md_deconstruct(nal_cb_t * nal, lib_md_t * md, ptl_md_t * new)
 218 {
 219         /* NB this doesn't copy out all the iov entries so when a
 220          * discontiguous MD is copied out, the target gets to know the
 221          * original iov pointer (in start) and the number of entries it had
 222          * and that's all.
 223          */
 224         new->start = md->start;
 225         new->length = ((md->options & (PTL_MD_IOVEC | PTL_MD_KIOV)) == 0) ?
 226                       md->length : md->md_niov;
 227         new->threshold = md->threshold;
 228         new->max_size = md->max_size;
 229         new->options = md->options;
 230         new->user_ptr = md->user_ptr;
 231         ptl_eq2handle(&new->eventq, md->eq);
 232 }
 233
 234 int do_PtlMDAttach(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 235 {
 236         /*
 237          * Incoming:
 238          *      ptl_handle_me_t current_in
 239          *      ptl_md_t md_in
 240          *      ptl_unlink_t unlink_in
 241          *
 242          * Outgoing:
 243          *      ptl_handle_md_t         * handle_out
 244          */
 245
 246         PtlMDAttach_in *args = v_args;
 247         PtlMDAttach_out *ret = v_ret;
 248         lib_me_t *me;
 249         lib_md_t *md;
 250         unsigned long flags;
 251
 252         if ((args->md_in.options & (PTL_MD_KIOV | PTL_MD_IOVEC)) != 0 &&
 253             args->md_in.length > PTL_MD_MAX_IOV) /* too many fragments */
 254                 return (ret->rc = PTL_IOV_INVALID);
 255
 256         md = lib_md_alloc(nal, &args->md_in);
 257         if (md == NULL)
 258                 return (ret->rc = PTL_NO_SPACE);
 259
 260         state_lock(nal, &flags);
 261
 262         me = ptl_handle2me(&args->me_in, nal);
 263         if (me == NULL) {
 264                 ret->rc = PTL_ME_INVALID;
 265         } else if (me->md != NULL) {
 266                 ret->rc = PTL_ME_IN_USE;
 267         } else {
 268                 ret->rc = lib_md_build(nal, md, private, &args->md_in,
 269                                        &args->eq_in, args->unlink_in);
 270
 271                 if (ret->rc == PTL_OK) {
 272                         me->md = md;
 273                         md->me = me;
 274
 275                         ptl_md2handle(&ret->handle_out, md);
 276
 277                         state_unlock (nal, &flags);
 278                         return (PTL_OK);
 279                 }
 280         }
 281
 282         lib_md_free (nal, md);
 283
 284         state_unlock (nal, &flags);
 285         return (ret->rc);
 286 }
 287
 288 int do_PtlMDBind(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 289 {
 290         /*
 291          * Incoming:
 292          *      ptl_handle_ni_t ni_in
 293          *      ptl_md_t md_in
 294          *
 295          * Outgoing:
 296          *      ptl_handle_md_t         * handle_out
 297          */
 298
 299         PtlMDBind_in *args = v_args;
 300         PtlMDBind_out *ret = v_ret;
 301         lib_md_t *md;
 302         unsigned long flags;
 303
 304         if ((args->md_in.options & (PTL_MD_KIOV | PTL_MD_IOVEC)) != 0 &&
 305             args->md_in.length > PTL_MD_MAX_IOV) /* too many fragments */
 306                 return (ret->rc = PTL_IOV_INVALID);
 307
 308         md = lib_md_alloc(nal, &args->md_in);
 309         if (md == NULL)
 310                 return (ret->rc = PTL_NO_SPACE);
 311
 312         state_lock(nal, &flags);
 313
 314         ret->rc = lib_md_build(nal, md, private, &args->md_in,
 315                                &args->eq_in, args->unlink_in);
 316
 317         if (ret->rc == PTL_OK) {
 318                 ptl_md2handle(&ret->handle_out, md);
 319
 320                 state_unlock(nal, &flags);
 321                 return (PTL_OK);
 322         }
 323
 324         lib_md_free (nal, md);
 325
 326         state_unlock(nal, &flags);
 327         return (ret->rc);
 328 }
 329
 330 int do_PtlMDUnlink(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 331 {
 332         PtlMDUnlink_in  *args = v_args;
 333         PtlMDUnlink_out *ret = v_ret;
 334         ptl_event_t      ev;
 335         lib_md_t        *md;
 336         unsigned long    flags;
 337
 338         state_lock(nal, &flags);
 339
 340         md = ptl_handle2md(&args->md_in, nal);
 341         if (md == NULL) {
 342                 state_unlock(nal, &flags);
 343                 return (ret->rc = PTL_MD_INVALID);
 344         }
 345
 346         /* If the MD is busy, lib_md_unlink just marks it for deletion, and
 347          * when the NAL is done, the completion event flags that the MD was
 348          * unlinked.  Otherwise, we enqueue an event now... */
 349
 350         if (md->eq != NULL &&
 351             md->pending == 0) {
 352                 memset(&ev, 0, sizeof(ev));
 353
 354                 ev.type = PTL_EVENT_UNLINK;
 355                 ev.ni_fail_type = PTL_OK;
 356                 ev.unlinked = 1;
 357                 lib_md_deconstruct(nal, md, &ev.mem_desc);
 358
 359                 lib_enq_event_locked(nal, private, md->eq, &ev);
 360         }
 361
 362         lib_md_deconstruct(nal, md, &ret->status_out);
 363         lib_md_unlink(nal, md);
 364         ret->rc = PTL_OK;
 365
 366         state_unlock(nal, &flags);
 367
 368         return (PTL_OK);
 369 }
 370
 371 int do_PtlMDUpdate_internal(nal_cb_t * nal, void *private, void *v_args,
 372                             void *v_ret)
 373 {
 374         /*
 375          * Incoming:
 376          *      ptl_handle_md_t md_in
 377          *      ptl_md_t                * old_inout
 378          *      ptl_md_t                * new_inout
 379          *      ptl_handle_eq_t testq_in
 380          *      ptl_seq_t               sequence_in
 381          *
 382          * Outgoing:
 383          *      ptl_md_t                * old_inout
 384          *      ptl_md_t                * new_inout
 385          */
 386         PtlMDUpdate_internal_in *args = v_args;
 387         PtlMDUpdate_internal_out *ret = v_ret;
 388         lib_md_t *md;
 389         lib_eq_t *test_eq = NULL;
 390         ptl_md_t *new = &args->new_inout;
 391         unsigned long flags;
 392
 393         state_lock(nal, &flags);
 394
 395         md = ptl_handle2md(&args->md_in, nal);
 396         if (md == NULL) {
 397                  ret->rc = PTL_MD_INVALID;
 398                  goto out;
 399         }
 400
 401         if (args->old_inout_valid)
 402                 lib_md_deconstruct(nal, md, &ret->old_inout);
 403
 404         if (!args->new_inout_valid) {
 405                 ret->rc = PTL_OK;
 406                 goto out;
 407         }
 408
 409         /* XXX fttb, the new MD must be the same "shape" wrt fragmentation,
 410          * since we simply overwrite the old lib-md */
 411         if ((((new->options ^ md->options) &
 412               (PTL_MD_IOVEC | PTL_MD_KIOV)) != 0) ||
 413             ((new->options & (PTL_MD_IOVEC | PTL_MD_KIOV)) != 0 &&
 414              new->length != md->md_niov)) {
 415                 ret->rc = PTL_IOV_INVALID;
 416                 goto out;
 417         }
 418
 419         if (!PtlHandleIsEqual (args->testq_in, PTL_EQ_NONE)) {
 420                 test_eq = ptl_handle2eq(&args->testq_in, nal);
 421                 if (test_eq == NULL) {
 422                         ret->rc = PTL_EQ_INVALID;
 423                         goto out;
 424                 }
 425         }
 426
 427         if (md->pending != 0) {
 428                         ret->rc = PTL_MD_NO_UPDATE;
 429                         goto out;
 430         }
 431
 432         if (test_eq == NULL ||
 433             test_eq->sequence == args->sequence_in) {
 434                 lib_me_t *me = md->me;
 435                 int       unlink = (md->md_flags & PTL_MD_FLAG_AUTO_UNLINK) ?
 436                                    PTL_UNLINK : PTL_RETAIN;
 437
 438                 // #warning this does not track eq refcounts properly
 439                 ret->rc = lib_md_build(nal, md, private,
 440                                        new, &new->eventq, unlink);
 441
 442                 md->me = me;
 443         } else {
 444                 ret->rc = PTL_MD_NO_UPDATE;
 445         }
 446
 447  out:
 448         state_unlock(nal, &flags);
 449         return (ret->rc);
 450 }