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 /*
  37  * must be called with state lock held
  38  */
  39 void lib_md_unlink(nal_cb_t * nal, lib_md_t * md)
  40 {
  41         lib_me_t *me = md->me;
  42
  43         if (md->pending != 0) {
  44                 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
  45                 md->md_flags |= PTL_MD_FLAG_UNLINK;
  46                 return;
  47         }
  48
  49         CDEBUG(D_NET, "Unlinking md %p\n", md);
  50
  51         if ((md->options & PTL_MD_KIOV) != 0) {
  52                 if (nal->cb_unmap_pages != NULL)
  53                         nal->cb_unmap_pages (nal, md->md_niov, md->md_iov.kiov,
  54                                              &md->md_addrkey);
  55         } else if (nal->cb_unmap != NULL)
  56                 nal->cb_unmap (nal, md->md_niov, md->md_iov.iov,
  57                                &md->md_addrkey);
  58
  59         if (me) {
  60                 me->md = NULL;
  61                 if (me->unlink == PTL_UNLINK)
  62                         lib_me_unlink(nal, me);
  63         }
  64
  65         if (md->eq != NULL)
  66         {
  67                 md->eq->eq_refcount--;
  68                 LASSERT (md->eq->eq_refcount >= 0);
  69         }
  70
  71         lib_invalidate_handle (nal, &md->md_lh);
  72         list_del (&md->md_list);
  73         lib_md_free(nal, md);
  74 }
  75
  76 /* must be called with state lock held */
  77 static int lib_md_build(nal_cb_t *nal, lib_md_t *new, void *private,
  78                         ptl_md_t *md, ptl_handle_eq_t *eqh, int unlink)
  79 {
  80         const int     max_size_opts = PTL_MD_AUTO_UNLINK |
  81                                       PTL_MD_MAX_SIZE;
  82         lib_eq_t     *eq = NULL;
  83         int           rc;
  84         int           i;
  85
  86         /* NB we are passes an allocated, but uninitialised/active md.
  87          * if we return success, caller may lib_md_unlink() it.
  88          * otherwise caller may only lib_md_free() it.
  89          */
  90
  91         if (!PtlHandleEqual (*eqh, PTL_EQ_NONE)) {
  92                 eq = ptl_handle2eq(eqh, nal);
  93                 if (eq == NULL)
  94                         return PTL_INV_EQ;
  95         }
  96
  97         if ((md->options & PTL_MD_IOV) != 0 &&  /* discontiguous MD */
  98             md->niov > PTL_MD_MAX_IOV)          /* too many fragments */
  99                 return PTL_IOV_TOO_MANY;
 100
 101         if ((md->options & max_size_opts) != 0 && /* max size used */
 102             (md->max_size < 0 || md->max_size > md->length)) // illegal max_size
 103                 return PTL_INV_MD;
 104
 105         new->me = NULL;
 106         new->start = md->start;
 107         new->length = md->length;
 108         new->offset = 0;
 109         new->max_size = md->max_size;
 110         new->unlink = unlink;
 111         new->options = md->options;
 112         new->user_ptr = md->user_ptr;
 113         new->eq = eq;
 114         new->threshold = md->threshold;
 115         new->pending = 0;
 116         new->md_flags = 0;
 117
 118         if ((md->options & PTL_MD_IOV) != 0) {
 119                 int total_length = 0;
 120
 121                 if ((md->options & PTL_MD_KIOV) != 0) /* Can't specify both */
 122                         return PTL_INV_MD;
 123
 124                 new->md_niov = md->niov;
 125
 126                 if (nal->cb_read (nal, private, new->md_iov.iov, md->start,
 127                                   md->niov * sizeof (new->md_iov.iov[0])))
 128                         return PTL_SEGV;
 129
 130                 for (i = 0; i < new->md_niov; i++) {
 131                         /* We take the base address on trust */
 132                         if (new->md_iov.iov[i].iov_len <= 0) /* invalid length */
 133                                 return PTL_VAL_FAILED;
 134
 135                         total_length += new->md_iov.iov[i].iov_len;
 136                 }
 137
 138                 if (md->length > total_length)
 139                         return PTL_IOV_TOO_SMALL;
 140
 141                 if (nal->cb_map != NULL) {
 142                         rc = nal->cb_map (nal, new->md_niov, new->md_iov.iov,
 143                                           &new->md_addrkey);
 144                         if (rc != PTL_OK)
 145                                 return (rc);
 146                 }
 147         } else if ((md->options & PTL_MD_KIOV) != 0) {
 148 #ifndef __KERNEL__
 149                 return PTL_INV_MD;
 150 #else
 151                 int total_length = 0;
 152
 153                 /* Trap attempt to use paged I/O if unsupported early. */
 154                 if (nal->cb_send_pages == NULL ||
 155                     nal->cb_recv_pages == NULL)
 156                         return PTL_INV_MD;
 157
 158                 new->md_niov = md->niov;
 159
 160                 if (nal->cb_read (nal, private, new->md_iov.kiov, md->start,
 161                                   md->niov * sizeof (new->md_iov.kiov[0])))
 162                         return PTL_SEGV;
 163
 164                 for (i = 0; i < new->md_niov; i++) {
 165                         /* We take the page pointer on trust */
 166                         if (new->md_iov.kiov[i].kiov_offset +
 167                             new->md_iov.kiov[i].kiov_len > PAGE_SIZE )
 168                                 return PTL_VAL_FAILED; /* invalid length */
 169
 170                         total_length += new->md_iov.kiov[i].kiov_len;
 171                 }
 172
 173                 if (md->length > total_length)
 174                         return PTL_IOV_TOO_SMALL;
 175
 176                 if (nal->cb_map_pages != NULL) {
 177                         rc = nal->cb_map_pages (nal, new->md_niov, new->md_iov.kiov,
 178                                                 &new->md_addrkey);
 179                         if (rc != PTL_OK)
 180                                 return (rc);
 181                 }
 182 #endif
 183         } else {   /* contiguous */
 184                 new->md_niov = 1;
 185                 new->md_iov.iov[0].iov_base = md->start;
 186                 new->md_iov.iov[0].iov_len = md->length;
 187
 188                 if (nal->cb_map != NULL) {
 189                         rc = nal->cb_map (nal, new->md_niov, new->md_iov.iov,
 190                                           &new->md_addrkey);
 191                         if (rc != PTL_OK)
 192                                 return (rc);
 193                 }
 194         }
 195
 196         if (eq != NULL)
 197                 eq->eq_refcount++;
 198
 199         /* It's good; let handle2md succeed and add to active mds */
 200         lib_initialise_handle (nal, &new->md_lh, PTL_COOKIE_TYPE_MD);
 201         list_add (&new->md_list, &nal->ni.ni_active_mds);
 202
 203         return PTL_OK;
 204 }
 205
 206 /* must be called with state lock held */
 207 void lib_md_deconstruct(nal_cb_t * nal, lib_md_t * md, ptl_md_t * new)
 208 {
 209         /* NB this doesn't copy out all the iov entries so when a
 210          * discontiguous MD is copied out, the target gets to know the
 211          * original iov pointer (in start) and the number of entries it had
 212          * and that's all.
 213          */
 214         new->start = md->start;
 215         new->length = md->length;
 216         new->threshold = md->threshold;
 217         new->max_size = md->max_size;
 218         new->options = md->options;
 219         new->user_ptr = md->user_ptr;
 220         ptl_eq2handle(&new->eventq, md->eq);
 221         new->niov = ((md->options & (PTL_MD_IOV | PTL_MD_KIOV)) == 0) ? 0 : md->md_niov;
 222 }
 223
 224 int do_PtlMDAttach(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 225 {
 226         /*
 227          * Incoming:
 228          *      ptl_handle_me_t current_in
 229          *      ptl_md_t md_in
 230          *      ptl_unlink_t unlink_in
 231          *
 232          * Outgoing:
 233          *      ptl_handle_md_t         * handle_out
 234          */
 235
 236         PtlMDAttach_in *args = v_args;
 237         PtlMDAttach_out *ret = v_ret;
 238         lib_me_t *me;
 239         lib_md_t *md;
 240         unsigned long flags;
 241
 242         md = lib_md_alloc (nal);
 243         if (md == NULL)
 244                 return (ret->rc = PTL_NOSPACE);
 245
 246         state_lock(nal, &flags);
 247
 248         me = ptl_handle2me(&args->me_in, nal);
 249         if (me == NULL) {
 250                 ret->rc = PTL_INV_ME;
 251         } else if (me->md != NULL) {
 252                 ret->rc = PTL_INUSE;
 253         } else {
 254                 ret->rc = lib_md_build(nal, md, private, &args->md_in,
 255                                        &args->eq_in, args->unlink_in);
 256
 257                 if (ret->rc == PTL_OK) {
 258                         me->md = md;
 259                         md->me = me;
 260
 261                         ptl_md2handle(&ret->handle_out, md);
 262
 263                         state_unlock (nal, &flags);
 264                         return (PTL_OK);
 265                 }
 266         }
 267
 268         lib_md_free (nal, md);
 269
 270         state_unlock (nal, &flags);
 271         return (ret->rc);
 272 }
 273
 274 int do_PtlMDBind(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 275 {
 276         /*
 277          * Incoming:
 278          *      ptl_handle_ni_t ni_in
 279          *      ptl_md_t md_in
 280          *
 281          * Outgoing:
 282          *      ptl_handle_md_t         * handle_out
 283          */
 284
 285         PtlMDBind_in *args = v_args;
 286         PtlMDBind_out *ret = v_ret;
 287         lib_md_t *md;
 288         unsigned long flags;
 289
 290         md = lib_md_alloc (nal);
 291         if (md == NULL)
 292                 return (ret->rc = PTL_NOSPACE);
 293
 294         state_lock(nal, &flags);
 295
 296         ret->rc = lib_md_build(nal, md, private,
 297                                &args->md_in, &args->eq_in, PTL_UNLINK);
 298
 299         if (ret->rc == PTL_OK) {
 300                 ptl_md2handle(&ret->handle_out, md);
 301
 302                 state_unlock(nal, &flags);
 303                 return (PTL_OK);
 304         }
 305
 306         lib_md_free (nal, md);
 307
 308         state_unlock(nal, &flags);
 309         return (ret->rc);
 310 }
 311
 312 int do_PtlMDUnlink(nal_cb_t * nal, void *private, void *v_args, void *v_ret)
 313 {
 314         PtlMDUnlink_in *args = v_args;
 315         PtlMDUnlink_out *ret = v_ret;
 316
 317         lib_md_t *md;
 318         unsigned long flags;
 319
 320         state_lock(nal, &flags);
 321
 322         md = ptl_handle2md(&args->md_in, nal);
 323         if (md == NULL) {
 324                 ret->rc = PTL_INV_MD;
 325         } else if (md->pending != 0) {           /* being filled/spilled */
 326                 ret->rc = PTL_MD_INUSE;
 327         } else {
 328                 /* Callers attempting to unlink a busy MD which will get
 329                  * unlinked once the net op completes should see INUSE,
 330                  * before completion and INV_MD thereafter.  LASSERT we've
 331                  * got that right... */
 332                 LASSERT ((md->md_flags & PTL_MD_FLAG_UNLINK) == 0);
 333
 334                 lib_md_deconstruct(nal, md, &ret->status_out);
 335                 lib_md_unlink(nal, md);
 336                 ret->rc = PTL_OK;
 337         }
 338
 339         state_unlock(nal, &flags);
 340
 341         return (ret->rc);
 342 }
 343
 344 int do_PtlMDUpdate_internal(nal_cb_t * nal, void *private, void *v_args,
 345                             void *v_ret)
 346 {
 347         /*
 348          * Incoming:
 349          *      ptl_handle_md_t md_in
 350          *      ptl_md_t                * old_inout
 351          *      ptl_md_t                * new_inout
 352          *      ptl_handle_eq_t testq_in
 353          *      ptl_seq_t               sequence_in
 354          *
 355          * Outgoing:
 356          *      ptl_md_t                * old_inout
 357          *      ptl_md_t                * new_inout
 358          */
 359         PtlMDUpdate_internal_in *args = v_args;
 360         PtlMDUpdate_internal_out *ret = v_ret;
 361         lib_md_t *md;
 362         lib_eq_t *test_eq = NULL;
 363         ptl_md_t *new = &args->new_inout;
 364         unsigned long flags;
 365
 366         state_lock(nal, &flags);
 367
 368         md = ptl_handle2md(&args->md_in, nal);
 369         if (md == NULL) {
 370                  ret->rc = PTL_INV_MD;
 371                  goto out;
 372         }
 373
 374         if (args->old_inout_valid)
 375                 lib_md_deconstruct(nal, md, &ret->old_inout);
 376
 377         if (!args->new_inout_valid) {
 378                 ret->rc = PTL_OK;
 379                 goto out;
 380         }
 381
 382         if (!PtlHandleEqual (args->testq_in, PTL_EQ_NONE)) {
 383                 test_eq = ptl_handle2eq(&args->testq_in, nal);
 384                 if (test_eq == NULL) {
 385                         ret->rc = PTL_INV_EQ;
 386                         goto out;
 387                 }
 388         }
 389
 390         if (md->pending != 0) {
 391                         ret->rc = PTL_NOUPDATE;
 392                         goto out;
 393         }
 394
 395         if (test_eq == NULL ||
 396             test_eq->sequence == args->sequence_in) {
 397                 lib_me_t *me = md->me;
 398
 399                 // #warning this does not track eq refcounts properly
 400                 ret->rc = lib_md_build(nal, md, private,
 401                                        new, &new->eventq, md->unlink);
 402
 403                 md->me = me;
 404         } else {
 405                 ret->rc = PTL_NOUPDATE;
 406         }
 407
 408  out:
 409         state_unlock(nal, &flags);
 410         return (ret->rc);
 411 }